git.sesse.net Git - vlc/blob - modules/misc/lua/objects.c

   1 /*****************************************************************************
   2  * objects.c: Generic lua<->vlc object wrapper
   3  *****************************************************************************
   4  * Copyright (C) 2007 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/vlc.h>
  36
  37 #include <lua.h>        /* Low level lua C API */
  38 #include <lauxlib.h>    /* Higher level C API */
  39 #include <lualib.h>     /* Lua libs */
  40
  41 #include "vlc.h"
  42
  43 typedef struct
  44 {
  45     vlc_object_t *p_obj;
  46 } vlclua_object_t;
  47
  48 /*****************************************************************************
  49  * Generic vlc_object_t wrapper creation
  50  *****************************************************************************/
  51 int __vlclua_push_vlc_object( lua_State *L, vlc_object_t *p_obj,
  52                               lua_CFunction pf_gc )
  53 {
  54     vlclua_object_t *p_ud = (vlclua_object_t *)
  55         lua_newuserdata( L, sizeof( vlclua_object_t ) );
  56     p_ud->p_obj = p_obj;
  57     lua_newtable( L );
  58     /* Hide the metatable */
  59     lua_pushstring( L, "__metatable" );
  60     lua_pushstring( L, "none of your business" );
  61     lua_settable( L, -3 );
  62     if( pf_gc )
  63     {
  64         /* Set the garbage collector if needed */
  65         lua_pushstring( L, "__gc" );
  66         lua_pushcfunction( L, pf_gc );
  67         lua_settable( L, -3 );
  68     }
  69     lua_setmetatable( L, -2 );
  70     return 1;
  71 }
  72
  73 int vlclua_gc_release( lua_State *L )
  74 {
  75     vlclua_object_t *p_ud = (vlclua_object_t *)lua_touserdata( L, -1 );
  76     lua_pop( L, 1 );
  77     vlc_object_release( p_ud->p_obj );
  78     return 0;
  79 }
  80
  81 vlc_object_t *vlclua_checkobject( lua_State *L, int narg, int i_type )
  82 {
  83     vlclua_object_t *p_obj = (vlclua_object_t *)luaL_checkuserdata( L, narg, sizeof( vlclua_object_t ) );
  84     /* TODO: add some metatable based method to check that this isn't
  85      * any userdata, but really some vlc object */
  86     if( i_type )
  87     {
  88         if( p_obj->p_obj->i_object_type == i_type )
  89             return p_obj->p_obj;
  90         else
  91         {
  92             luaL_error( L, "VLC object type doesn't match requirements." );
  93             return NULL; /* luaL_error alread longjmp-ed out of here.
  94                           * This is to make gcc happy */
  95         }
  96     }
  97     else
  98     {
  99         return p_obj->p_obj;
 100     }
 101 }
 102
 103 static int vlc_object_type_from_string( const char *psz_name )
 104 {
 105     static const struct
 106     {
 107         int i_type;
 108         const char *psz_name;
 109     } pp_objects[] =
 110         { { VLC_OBJECT_GLOBAL, "global" },
 111           { VLC_OBJECT_LIBVLC, "libvlc" },
 112           { VLC_OBJECT_MODULE, "module" },
 113           { VLC_OBJECT_INTF, "intf" },
 114           { VLC_OBJECT_PLAYLIST, "playlist" },
 115           { VLC_OBJECT_INPUT, "input" },
 116           { VLC_OBJECT_DECODER, "decoder" },
 117           { VLC_OBJECT_VOUT, "vout" },
 118           { VLC_OBJECT_AOUT, "aout" },
 119           { VLC_OBJECT_SOUT, "sout" },
 120           { VLC_OBJECT_HTTPD, "httpd" },
 121           { VLC_OBJECT_PACKETIZER, "packetizer" },
 122           { VLC_OBJECT_ENCODER, "encoder" },
 123           { VLC_OBJECT_DIALOGS, "dialogs" },
 124           { VLC_OBJECT_VLM, "vlm" },
 125           { VLC_OBJECT_ANNOUNCE, "announce" },
 126           { VLC_OBJECT_DEMUX, "demux" },
 127           { VLC_OBJECT_ACCESS, "access" },
 128           { VLC_OBJECT_STREAM, "stream" },
 129           { VLC_OBJECT_OPENGL, "opengl" },
 130           { VLC_OBJECT_FILTER, "filter" },
 131           { VLC_OBJECT_SPU, "spu" },
 132           { VLC_OBJECT_SD, "sd" },
 133           { VLC_OBJECT_XML, "xml" },
 134           { VLC_OBJECT_OSDMENU, "osdmenu" },
 135           { VLC_OBJECT_HTTPD_HOST, "httpd_host" },
 136           { VLC_OBJECT_META_ENGINE, "meta_engine" },
 137           { VLC_OBJECT_GENERIC, "generic" },
 138           { 0, "" } };
 139     int i;
 140     for( i = 0; pp_objects[i].i_type; i++ )
 141     {
 142         if( !strcmp( psz_name, pp_objects[i].psz_name ) )
 143             return pp_objects[i].i_type;
 144     }
 145     return 0;
 146 }
 147
 148 static int vlc_object_search_mode_from_string( const char *psz_name )
 149 {
 150     static const struct
 151     {
 152         int i_mode;
 153         const char *psz_name;
 154     } pp_modes[] =
 155         { { FIND_PARENT, "parent" },
 156           { FIND_CHILD, "child" },
 157           { FIND_ANYWHERE, "anywhere" },
 158           { 0, "" } };
 159     int i;
 160     for( i = 0; pp_modes[i].i_mode; i++ )
 161     {
 162         if( !strcmp( psz_name, pp_modes[i].psz_name ) )
 163             return pp_modes[i].i_mode;
 164     }
 165     return 0;
 166 }
 167
 168 int vlclua_object_find( lua_State *L )
 169 {
 170     const char *psz_type = luaL_checkstring( L, 2 );
 171     const char *psz_mode = luaL_checkstring( L, 3 );
 172
 173     vlc_object_t *p_this;
 174     int i_type = vlc_object_type_from_string( psz_type );
 175     int i_mode = vlc_object_search_mode_from_string( psz_mode );
 176     vlc_object_t *p_result;
 177
 178     if( !i_type )
 179         return luaL_error( L, "\"%s\" is not a valid object type.", psz_type );
 180     if( !i_mode )
 181         return luaL_error( L, "\"%s\" is not a valid search mode.", psz_mode );
 182
 183     if( lua_type( L, 1 ) == LUA_TNIL )
 184         p_this = vlclua_get_this( L );
 185     else
 186         p_this = vlclua_checkobject( L, 1, 0 );
 187
 188     p_result = vlc_object_find( p_this, i_type, i_mode );
 189     if( !p_result )
 190         lua_pushnil( L );
 191     else
 192         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
 193     return 1;
 194 }
 195
 196 int vlclua_object_find_name( lua_State *L )
 197 {
 198     const char *psz_name = luaL_checkstring( L, 2 );
 199     const char *psz_mode = luaL_checkstring( L, 3 );
 200
 201     vlc_object_t *p_this;
 202     int i_mode = vlc_object_search_mode_from_string( psz_mode );
 203     vlc_object_t *p_result;
 204
 205     if( !i_mode )
 206         return luaL_error( L, "\"%s\" is not a valid search mode.",
 207                            psz_mode );
 208
 209     if( lua_type( L, 1 ) == LUA_TNIL )
 210         p_this = vlclua_get_this( L );
 211     else
 212         p_this = vlclua_checkobject( L, 1, 0 );
 213
 214     p_result = vlc_object_find_name( p_this, psz_name, i_mode );
 215     if( !p_result )
 216         lua_pushnil( L );
 217     else
 218         vlclua_push_vlc_object( L, p_result, vlclua_gc_release );
 219     return 1;
 220 }