Privatize packetize and interface object types
[vlc.git] / modules / misc / lua / libs / objects.c
1 /*****************************************************************************
2  * objects.c: Generic lua<->vlc object wrapper
3  *****************************************************************************
4  * Copyright (C) 2007-2008 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #ifndef  _GNU_SOURCE
28 #   define  _GNU_SOURCE
29 #endif
30
31 #ifdef HAVE_CONFIG_H
32 # include "config.h"
33 #endif
34
35 #include <vlc_common.h>
36
37 #include <lua.h>        /* Low level lua C API */
38 #include <lauxlib.h>    /* Higher level C API */
39
40 #include "../vlc.h"
41 #include "../libs.h"
42 #include "objects.h"
43 #include "playlist.h"
44 #include "input.h"
45
46 typedef struct
47 {
48     vlc_object_t *p_obj;
49 } vlclua_object_t;
50
51 /*****************************************************************************
52  * Generic vlc_object_t wrapper creation
53  *****************************************************************************/
54 int __vlclua_push_vlc_object( lua_State *L, vlc_object_t *p_obj,
55                               lua_CFunction pf_gc )
56 {
57     vlc_object_t **udata = (vlc_object_t **)
58         lua_newuserdata( L, sizeof( vlc_object_t * ) );
59     *udata = p_obj;
60
61     if( luaL_newmetatable( L, "vlc_object" ) )
62     {
63         /* Hide the metatable */
64         lua_pushstring( L, "none of your business" );
65         lua_setfield( L, -2, "__metatable" );
66         if( pf_gc ) /* FIXME */
67         {
68             /* Set the garbage collector if needed */
69             lua_pushcfunction( L, pf_gc );
70             lua_setfield( L, -2, "__gc" );
71         }
72     }
73     lua_setmetatable( L, -2 );
74     return 1;
75 }
76
77 int vlclua_gc_release( lua_State *L )
78 {
79     vlc_object_t **p_obj = (vlc_object_t **)luaL_checkudata( L, 1, "vlc_object" );
80     lua_pop( L, 1 );
81     vlc_object_release( *p_obj );
82     return 0;
83 }
84
85 static int vlc_object_type_from_string( const char *psz_name )
86 {
87     static const struct
88     {
89         int i_type;
90         const char *psz_name;
91     } pp_objects[] =
92         { { VLC_OBJECT_INPUT, "input" },
93           { VLC_OBJECT_DECODER, "decoder" },
94           { VLC_OBJECT_VOUT, "vout" },
95           { VLC_OBJECT_AOUT, "aout" },
96           { VLC_OBJECT_ENCODER, "encoder" },
97           { VLC_OBJECT_GENERIC, "generic" },
98           { 0, "" } };
99     int i;
100     for( i = 0; pp_objects[i].i_type; i++ )
101     {
102         if( !strcmp( psz_name, pp_objects[i].psz_name ) )
103             return pp_objects[i].i_type;
104     }
105     return 0;
106 }
107
108 static int vlc_object_search_mode_from_string( const char *psz_name )
109 {
110     static const struct
111     {
112         int i_mode;
113         const char *psz_name;
114     } pp_modes[] =
115         { { FIND_PARENT, "parent" },
116           { FIND_CHILD, "child" },
117           { FIND_ANYWHERE, "anywhere" },
118           { 0, "" } };
119     int i;
120     for( i = 0; pp_modes[i].i_mode; i++ )
121     {
122         if( !strcmp( psz_name, pp_modes[i].psz_name ) )
123             return pp_modes[i].i_mode;
124     }
125     return 0;
126 }
127
128 static int vlclua_object_find( lua_State *L )
129 {
130     const char *psz_type = luaL_checkstring( L, 2 );
131     const char *psz_mode = luaL_checkstring( L, 3 );
132
133     vlc_object_t *p_this;
134     int i_type = vlc_object_type_from_string( psz_type );
135     int i_mode = vlc_object_search_mode_from_string( psz_mode );
136     vlc_object_t *p_result;
137
138     if( !i_type )
139         return luaL_error( L, "\"%s\" is not a valid object type.", psz_type );
140     if( !i_mode )
141         return luaL_error( L, "\"%s\" is not a valid search mode.", psz_mode );
142
143     if( lua_type( L, 1 ) == LUA_TNIL )
144         p_this = vlclua_get_this( L );
145     else
146     {
147         vlc_object_t **p_obj = luaL_checkudata( L, 1, "vlc_object" );
148         p_this = *p_obj;
149     }
150
151     p_result = vlc_object_find( p_this, i_type, i_mode );
152     if( !p_result )
153         lua_pushnil( L );
154     else
155         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
156     return 1;
157 }
158
159 static int vlclua_object_find_name( lua_State *L )
160 {
161     const char *psz_name = luaL_checkstring( L, 2 );
162     const char *psz_mode = luaL_checkstring( L, 3 );
163
164     vlc_object_t *p_this;
165     int i_mode = vlc_object_search_mode_from_string( psz_mode );
166     vlc_object_t *p_result;
167
168     if( !i_mode )
169         return luaL_error( L, "\"%s\" is not a valid search mode.",
170                            psz_mode );
171
172     if( lua_type( L, 1 ) == LUA_TNIL )
173         p_this = vlclua_get_this( L );
174     else
175     {
176         vlc_object_t **p_obj = luaL_checkudata( L, 1, "vlc_object" );
177         p_this = *p_obj;
178     }
179
180     p_result = vlc_object_find_name( p_this, psz_name, i_mode );
181     if( !p_result )
182         lua_pushnil( L );
183     else
184         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
185     return 1;
186 }
187
188 static int vlclua_get_libvlc( lua_State *L )
189 {
190     vlclua_push_vlc_object( L, vlclua_get_this( L )->p_libvlc,
191                             NULL );
192     return 1;
193 }
194
195 static int vlclua_get_playlist( lua_State *L )
196 {
197     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
198     if( p_playlist )
199     {
200         vlclua_push_vlc_object( L, p_playlist, vlclua_gc_release );
201     }
202     else lua_pushnil( L );
203     //vlclua_release_playlist_internal( p_playlist );
204     return 1;
205 }
206
207 static int vlclua_get_input( lua_State *L )
208 {
209     input_thread_t *p_input = vlclua_get_input_internal( L );
210     if( p_input )
211     {
212         vlclua_push_vlc_object( L, p_input, vlclua_gc_release );
213     }
214     else lua_pushnil( L );
215     return 1;
216 }
217
218 /*****************************************************************************
219  *
220  *****************************************************************************/
221 static const luaL_Reg vlclua_object_reg[] = {
222     { "input", vlclua_get_input },
223     { "playlist", vlclua_get_playlist },
224     { "libvlc", vlclua_get_libvlc },
225     { "find", vlclua_object_find },
226     { "find_name", vlclua_object_find_name },
227     { NULL, NULL }
228 };
229
230 void luaopen_object( lua_State *L )
231 {
232     lua_newtable( L );
233     luaL_register( L, NULL, vlclua_object_reg );
234     lua_setfield( L, -2, "object" );
235 }