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