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