cbf5c374067ab8eadf6c9103e50ff7584f29b4e1
[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_PACKETIZER, "packetizer" },
97           { VLC_OBJECT_ENCODER, "encoder" },
98           { VLC_OBJECT_GENERIC, "generic" },
99           { 0, "" } };
100     int i;
101     for( i = 0; pp_objects[i].i_type; i++ )
102     {
103         if( !strcmp( psz_name, pp_objects[i].psz_name ) )
104             return pp_objects[i].i_type;
105     }
106     return 0;
107 }
108
109 static int vlc_object_search_mode_from_string( const char *psz_name )
110 {
111     static const struct
112     {
113         int i_mode;
114         const char *psz_name;
115     } pp_modes[] =
116         { { FIND_PARENT, "parent" },
117           { FIND_CHILD, "child" },
118           { FIND_ANYWHERE, "anywhere" },
119           { 0, "" } };
120     int i;
121     for( i = 0; pp_modes[i].i_mode; i++ )
122     {
123         if( !strcmp( psz_name, pp_modes[i].psz_name ) )
124             return pp_modes[i].i_mode;
125     }
126     return 0;
127 }
128
129 static int vlclua_object_find( lua_State *L )
130 {
131     const char *psz_type = luaL_checkstring( L, 2 );
132     const char *psz_mode = luaL_checkstring( L, 3 );
133
134     vlc_object_t *p_this;
135     int i_type = vlc_object_type_from_string( psz_type );
136     int i_mode = vlc_object_search_mode_from_string( psz_mode );
137     vlc_object_t *p_result;
138
139     if( !i_type )
140         return luaL_error( L, "\"%s\" is not a valid object type.", psz_type );
141     if( !i_mode )
142         return luaL_error( L, "\"%s\" is not a valid search mode.", psz_mode );
143
144     if( lua_type( L, 1 ) == LUA_TNIL )
145         p_this = vlclua_get_this( L );
146     else
147     {
148         vlc_object_t **p_obj = luaL_checkudata( L, 1, "vlc_object" );
149         p_this = *p_obj;
150     }
151
152     p_result = vlc_object_find( p_this, i_type, i_mode );
153     if( !p_result )
154         lua_pushnil( L );
155     else
156         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
157     return 1;
158 }
159
160 static int vlclua_object_find_name( lua_State *L )
161 {
162     const char *psz_name = luaL_checkstring( L, 2 );
163     const char *psz_mode = luaL_checkstring( L, 3 );
164
165     vlc_object_t *p_this;
166     int i_mode = vlc_object_search_mode_from_string( psz_mode );
167     vlc_object_t *p_result;
168
169     if( !i_mode )
170         return luaL_error( L, "\"%s\" is not a valid search mode.",
171                            psz_mode );
172
173     if( lua_type( L, 1 ) == LUA_TNIL )
174         p_this = vlclua_get_this( L );
175     else
176     {
177         vlc_object_t **p_obj = luaL_checkudata( L, 1, "vlc_object" );
178         p_this = *p_obj;
179     }
180
181     p_result = vlc_object_find_name( p_this, psz_name, i_mode );
182     if( !p_result )
183         lua_pushnil( L );
184     else
185         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
186     return 1;
187 }
188
189 static int vlclua_get_libvlc( lua_State *L )
190 {
191     vlclua_push_vlc_object( L, vlclua_get_this( L )->p_libvlc,
192                             NULL );
193     return 1;
194 }
195
196 static int vlclua_get_playlist( lua_State *L )
197 {
198     playlist_t *p_playlist = vlclua_get_playlist_internal( L );
199     if( p_playlist )
200     {
201         vlclua_push_vlc_object( L, p_playlist, vlclua_gc_release );
202     }
203     else lua_pushnil( L );
204     //vlclua_release_playlist_internal( p_playlist );
205     return 1;
206 }
207
208 static int vlclua_get_input( lua_State *L )
209 {
210     input_thread_t *p_input = vlclua_get_input_internal( L );
211     if( p_input )
212     {
213         vlclua_push_vlc_object( L, p_input, vlclua_gc_release );
214     }
215     else lua_pushnil( L );
216     return 1;
217 }
218
219 /*****************************************************************************
220  *
221  *****************************************************************************/
222 static const luaL_Reg vlclua_object_reg[] = {
223     { "input", vlclua_get_input },
224     { "playlist", vlclua_get_playlist },
225     { "libvlc", vlclua_get_libvlc },
226     { "find", vlclua_object_find },
227     { "find_name", vlclua_object_find_name },
228     { NULL, NULL }
229 };
230
231 void luaopen_object( lua_State *L )
232 {
233     lua_newtable( L );
234     luaL_register( L, NULL, vlclua_object_reg );
235     lua_setfield( L, -2, "object" );
236 }