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