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

   1 /*****************************************************************************
   2  * vlc.c: Generic lua interface functions
   3  *****************************************************************************
   4  * Copyright (C) 2007-2008 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: Antoine Cellerier <dionoea at videolan tod org>
   8  *          Pierre d'Herbemont <pdherbemont # videolan.org>
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  23  *****************************************************************************/
  24
  25 /*****************************************************************************
  26  * Preamble
  27  *****************************************************************************/
  28 #ifndef  _GNU_SOURCE
  29 #   define  _GNU_SOURCE
  30 #endif
  31
  32 #ifdef HAVE_CONFIG_H
  33 # include "config.h"
  34 #endif
  35
  36 #include <assert.h>
  37
  38 #include <vlc_common.h>
  39 #include <vlc_plugin.h>
  40 #include <vlc_meta.h>
  41 #include <vlc_charset.h>
  42 #include <vlc_aout.h>
  43
  44 #include <lua.h>        /* Low level lua C API */
  45 #include <lauxlib.h>    /* Higher level C API */
  46 #include <lualib.h>     /* Lua libs */
  47
  48 #include "vlc.h"
  49
  50 /*****************************************************************************
  51  * Module descriptor
  52  *****************************************************************************/
  53
  54 #define INTF_TEXT N_("Lua interface")
  55 #define INTF_LONGTEXT N_("Lua interface module to load")
  56
  57 #define CONFIG_TEXT N_("Lua interface configuration")
  58 #define CONFIG_LONGTEXT N_("Lua interface configuration string. Format is: '[\"<interface module name>\"] = { <option> = <value>, ...}, ...'.")
  59
  60 vlc_module_begin();
  61         set_shortname( N_( "Lua Art" ) );
  62         set_description( N_("Fetch artwork using lua scripts") );
  63         set_capability( "art finder", 10 );
  64         set_callbacks( FindArt, NULL );
  65
  66     add_submodule();
  67         add_shortcut( "luaplaylist" );
  68         set_category( CAT_INPUT );
  69         set_subcategory( SUBCAT_INPUT_DEMUX );
  70         set_shortname( N_("Lua Playlist") );
  71         set_description( N_("Lua Playlist Parser Interface") );
  72         set_capability( "demux", 2 );
  73         set_callbacks( Import_LuaPlaylist, Close_LuaPlaylist );
  74
  75     add_submodule();
  76         add_shortcut( "luaintf" );
  77         add_shortcut( "luarc" );
  78         /* add_shortcut( "rc" ); */
  79         add_shortcut( "luahotkeys" );
  80         /* add_shortcut( "hotkeys" ); */
  81         add_shortcut( "luatelnet" );
  82         /* add_shortcut( "telnet" ); */
  83         add_shortcut( "luahttp" );
  84         /* add_shortcut( "http" ); */
  85         set_description( N_("Lua Interface Module") );
  86         set_capability( "interface", 0 );
  87         add_string( "lua-intf", "dummy", NULL,
  88                     INTF_TEXT, INTF_LONGTEXT, false );
  89         add_string( "lua-config", "", NULL,
  90                     CONFIG_TEXT, CONFIG_LONGTEXT, false );
  91         set_callbacks( Open_LuaIntf, Close_LuaIntf );
  92 vlc_module_end();
  93
  94 /*****************************************************************************
  95  *
  96  *****************************************************************************/
  97 static int file_select( const char *file )
  98 {
  99     int i = strlen( file );
 100     return i > 4 && !strcmp( file+i-4, ".lua" );
 101 }
 102
 103 static int file_compare( const char **a, const char **b )
 104 {
 105     return strcmp( *a, *b );
 106 }
 107
 108 int vlclua_dir_list( const char *luadirname, char **ppsz_dir_list )
 109 {
 110     int i = 0;
 111     char *datadir = config_GetUserDataDir();
 112     if( datadir == NULL )
 113         return VLC_ENOMEM;
 114
 115     if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
 116                    datadir, luadirname ) < 0 )
 117     {
 118         free( datadir );
 119         return VLC_ENOMEM;
 120     }
 121     free( datadir );
 122     i++;
 123
 124 #   if defined(__APPLE__) || defined(SYS_BEOS) || defined(WIN32)
 125     {
 126         const char *psz_vlcpath = config_GetDataDir();
 127         if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
 128                       psz_vlcpath, luadirname )  < 0 )
 129             return VLC_ENOMEM;
 130         i++;
 131         if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "share" DIR_SEP "lua" DIR_SEP "%s",
 132                       psz_vlcpath, luadirname )  < 0 )
 133             return VLC_ENOMEM;
 134         i++;
 135
 136     }
 137 #   else
 138     if( asprintf( &ppsz_dir_list[i], "%s" DIR_SEP "lua" DIR_SEP "%s",
 139                   config_GetDataDir (), luadirname ) < 0 )
 140         return VLC_ENOMEM;
 141     i++;
 142 #   endif
 143     return VLC_SUCCESS;
 144 }
 145
 146 void vlclua_dir_list_free( char **ppsz_dir_list )
 147 {
 148     char **ppsz_dir;
 149     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
 150         free( *ppsz_dir );
 151 }
 152
 153 /*****************************************************************************
 154  * Will execute func on all scripts in luadirname, and stop if func returns
 155  * success.
 156  *****************************************************************************/
 157 int vlclua_scripts_batch_execute( vlc_object_t *p_this,
 158                                   const char * luadirname,
 159                                   int (*func)(vlc_object_t *, const char *, lua_State *, void *),
 160                                   lua_State * L,
 161                                   void * user_data)
 162 {
 163     int i_ret = VLC_EGENERIC;
 164
 165     char **ppsz_filelist = NULL;
 166     char **ppsz_fileend  = NULL;
 167     char **ppsz_file;
 168
 169     char  *ppsz_dir_list[] = { NULL, NULL, NULL, NULL };
 170     char **ppsz_dir;
 171
 172     i_ret = vlclua_dir_list( luadirname, ppsz_dir_list );
 173     if( i_ret != VLC_SUCCESS )
 174         return i_ret;
 175     i_ret = VLC_EGENERIC;
 176
 177
 178     for( ppsz_dir = ppsz_dir_list; *ppsz_dir; ppsz_dir++ )
 179     {
 180         int i_files;
 181
 182         if( ppsz_filelist )
 183         {
 184             for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
 185                  ppsz_file++ )
 186                 free( *ppsz_file );
 187             free( ppsz_filelist );
 188             ppsz_filelist = NULL;
 189         }
 190
 191         msg_Dbg( p_this, "Trying Lua scripts in %s", *ppsz_dir );
 192         i_files = utf8_scandir( *ppsz_dir, &ppsz_filelist, file_select,
 193                                 file_compare );
 194         if( i_files < 1 ) continue;
 195         ppsz_fileend = ppsz_filelist + i_files;
 196
 197         for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend; ppsz_file++ )
 198         {
 199             char  *psz_filename;
 200             if( asprintf( &psz_filename,
 201                           "%s" DIR_SEP "%s", *ppsz_dir, *ppsz_file ) < 0)
 202             {
 203                 vlclua_dir_list_free( ppsz_dir_list );
 204                 return VLC_ENOMEM;
 205             }
 206             msg_Dbg( p_this, "Trying Lua playlist script %s", psz_filename );
 207
 208             i_ret = func( p_this, psz_filename, L, user_data );
 209
 210             free( psz_filename );
 211
 212             if( i_ret == VLC_SUCCESS ) break;
 213         }
 214         if( i_ret == VLC_SUCCESS ) break;
 215     }
 216
 217     if( ppsz_filelist )
 218     {
 219         for( ppsz_file = ppsz_filelist; ppsz_file < ppsz_fileend;
 220              ppsz_file++ )
 221             free( *ppsz_file );
 222         free( ppsz_filelist );
 223     }
 224     vlclua_dir_list_free( ppsz_dir_list );
 225
 226     return i_ret;
 227 }
 228
 229
 230 /*****************************************************************************
 231  * Meta data setters utility.
 232  * Playlist item table should be on top of the stack when these are called
 233  *****************************************************************************/
 234 void __vlclua_read_meta_data( vlc_object_t *p_this, lua_State *L,
 235                               input_item_t *p_input )
 236 {
 237 #define TRY_META( a, b )                                        \
 238     lua_getfield( L, -1, a );                                   \
 239     if( lua_isstring( L, -1 ) )                                 \
 240     {                                                           \
 241         char *psz_value = strdup( lua_tostring( L, -1 ) );      \
 242         EnsureUTF8( psz_value );                                \
 243         msg_Dbg( p_this, #b ": %s", psz_value );                \
 244         input_item_Set ## b ( p_input, psz_value );             \
 245         free( psz_value );                                      \
 246     }                                                           \
 247     lua_pop( L, 1 ); /* pop a */
 248     TRY_META( "title", Title );
 249     TRY_META( "artist", Artist );
 250     TRY_META( "genre", Genre );
 251     TRY_META( "copyright", Copyright );
 252     TRY_META( "album", Album );
 253     TRY_META( "tracknum", TrackNum );
 254     TRY_META( "description", Description );
 255     TRY_META( "rating", Rating );
 256     TRY_META( "date", Date );
 257     TRY_META( "setting", Setting );
 258     TRY_META( "url", URL );
 259     TRY_META( "language", Language );
 260     TRY_META( "nowplaying", NowPlaying );
 261     TRY_META( "publisher", Publisher );
 262     TRY_META( "encodedby", EncodedBy );
 263     TRY_META( "arturl", ArtURL );
 264     TRY_META( "trackid", TrackID );
 265 }
 266
 267 void __vlclua_read_custom_meta_data( vlc_object_t *p_this, lua_State *L,
 268                                      input_item_t *p_input )
 269 {
 270     /* ... item */
 271     lua_getfield( L, -1, "meta" );
 272     /* ... item meta */
 273     if( lua_istable( L, -1 ) )
 274     {
 275         lua_pushnil( L );
 276         /* ... item meta nil */
 277         while( lua_next( L, -2 ) )
 278         {
 279             /* ... item meta key value */
 280             if( !lua_isstring( L, -2 ) )
 281             {
 282                 msg_Warn( p_this, "Custom meta data category name must be "
 283                                    "a string" );
 284             }
 285             else if( !lua_istable( L, -1 ) )
 286             {
 287                 msg_Warn( p_this, "Custom meta data category contents "
 288                                    "must be a table" );
 289             }
 290             else
 291             {
 292                 const char *psz_meta_category = lua_tostring( L, -2 );
 293                 msg_Dbg( p_this, "Found custom meta data category: %s",
 294                          psz_meta_category );
 295                 lua_pushnil( L );
 296                 /* ... item meta key value nil */
 297                 while( lua_next( L, -2 ) )
 298                 {
 299                     /* ... item meta key value key2 value2 */
 300                     if( !lua_isstring( L, -2 ) )
 301                     {
 302                         msg_Warn( p_this, "Custom meta category item name "
 303                                            "must be a string." );
 304                     }
 305                     else if( !lua_isstring( L, -1 ) )
 306                     {
 307                         msg_Warn( p_this, "Custom meta category item value "
 308                                            "must be a string." );
 309                     }
 310                     else
 311                     {
 312                         const char *psz_meta_name =
 313                             lua_tostring( L, -2 );
 314                         const char *psz_meta_value =
 315                             lua_tostring( L, -1 );
 316                         msg_Dbg( p_this, "Custom meta %s, %s: %s",
 317                                  psz_meta_category, psz_meta_name,
 318                                  psz_meta_value );
 319                         input_ItemAddInfo( p_input, psz_meta_category,
 320                                            psz_meta_name, psz_meta_value );
 321                     }
 322                     lua_pop( L, 1 ); /* pop item */
 323                     /* ... item meta key value key2 */
 324                 }
 325                 /* ... item meta key value */
 326             }
 327             lua_pop( L, 1 ); /* pop category */
 328             /* ... item meta key */
 329         }
 330         /* ... item meta */
 331     }
 332     lua_pop( L, 1 ); /* pop "meta" */
 333     /* ... item -> back to original stack */
 334 }
 335
 336 /*****************************************************************************
 337  * Playlist utilities
 338  ****************************************************************************/
 339 /**
 340  * Playlist item table should be on top of the stack when this is called
 341  */
 342 void __vlclua_read_options( vlc_object_t *p_this, lua_State *L,
 343                             int *pi_options, char ***pppsz_options )
 344 {
 345     lua_getfield( L, -1, "options" );
 346     if( lua_istable( L, -1 ) )
 347     {
 348         lua_pushnil( L );
 349         while( lua_next( L, -2 ) )
 350         {
 351             if( lua_isstring( L, -1 ) )
 352             {
 353                 char *psz_option = strdup( lua_tostring( L, -1 ) );
 354                 msg_Dbg( p_this, "Option: %s", psz_option );
 355                 INSERT_ELEM( *pppsz_options, *pi_options, *pi_options,
 356                              psz_option );
 357             }
 358             else
 359             {
 360                 msg_Warn( p_this, "Option should be a string" );
 361             }
 362             lua_pop( L, 1 ); /* pop option */
 363         }
 364     }
 365     lua_pop( L, 1 ); /* pop "options" */
 366 }
 367
 368 int __vlclua_playlist_add_internal( vlc_object_t *p_this, lua_State *L,
 369                                     playlist_t *p_playlist,
 370                                     input_item_t *p_parent, bool b_play )
 371 {
 372     int i_count = 0;
 373
 374     assert( p_parent || p_playlist );
 375
 376     /* playlist */
 377     if( lua_istable( L, -1 ) )
 378     {
 379         lua_pushnil( L );
 380         /* playlist nil */
 381         while( lua_next( L, -2 ) )
 382         {
 383             /* playlist key item */
 384             /* <Parse playlist item> */
 385             if( lua_istable( L, -1 ) )
 386             {
 387                 lua_getfield( L, -1, "path" );
 388                 /* playlist key item path */
 389                 if( lua_isstring( L, -1 ) )
 390                 {
 391                     const char   *psz_path     = NULL;
 392                     const char   *psz_name     = NULL;
 393                     char        **ppsz_options = NULL;
 394                     int           i_options    = 0;
 395                     mtime_t       i_duration   = -1;
 396                     input_item_t *p_input;
 397
 398                     /* Read path and name */
 399                     psz_path = lua_tostring( L, -1 );
 400                     msg_Dbg( p_this, "Path: %s", psz_path );
 401                     lua_getfield( L, -2, "name" );
 402                     /* playlist key item path name */
 403                     if( lua_isstring( L, -1 ) )
 404                     {
 405                         psz_name = lua_tostring( L, -1 );
 406                         msg_Dbg( p_this, "Name: %s", psz_name );
 407                     }
 408                     else
 409                     {
 410                         if( !lua_isnil( L, -1 ) )
 411                             msg_Warn( p_this, "Playlist item name should be a string." );
 412                         psz_name = psz_path;
 413                     }
 414
 415                     /* Read duration */
 416                     lua_getfield( L, -3, "duration" );
 417                     /* playlist key item path name duration */
 418                     if( lua_isnumber( L, -1 ) )
 419                     {
 420                         i_duration = (mtime_t)(lua_tonumber( L, -1 )*1e6);
 421                     }
 422                     else if( !lua_isnil( L, -1 ) )
 423                     {
 424                         msg_Warn( p_this, "Playlist item duration should be a number (in seconds)." );
 425                     }
 426                     lua_pop( L, 1 ); /* pop "duration" */
 427
 428                     /* playlist key item path name */
 429
 430                     /* Read options: item must be on top of stack */
 431                     lua_pushvalue( L, -3 );
 432                     /* playlist key item path name item */
 433                     vlclua_read_options( p_this, L, &i_options, &ppsz_options );
 434
 435                     /* Create input item */
 436                     p_input = input_ItemNewExt( p_playlist, psz_path,
 437                                                 psz_name, i_options,
 438                                                 (const char **)ppsz_options,
 439                                                 i_duration );
 440                     lua_pop( L, 3 ); /* pop "path name item" */
 441                     /* playlist key item */
 442
 443                     /* Read meta data: item must be on top of stack */
 444                     vlclua_read_meta_data( p_this, L, p_input );
 445
 446                     /* Read custom meta data: item must be on top of stack*/
 447                     vlclua_read_custom_meta_data( p_this, L, p_input );
 448
 449                     /* Append item to playlist */
 450                     if( p_parent ) /* Add to node */
 451                         input_ItemAddSubItem( p_parent, p_input );
 452                     else /* Play or Enqueue (preparse) */
 453                         /* FIXME: playlist_AddInput() can fail */
 454                         playlist_AddInput( p_playlist, p_input,
 455                                PLAYLIST_APPEND |
 456                                ( b_play ? PLAYLIST_GO : PLAYLIST_PREPARSE ),
 457                                PLAYLIST_END, true, false );
 458                     i_count ++; /* increment counter */
 459                     vlc_gc_decref( p_input );
 460                     while( i_options > 0 )
 461                         free( ppsz_options[--i_options] );
 462                     free( ppsz_options );
 463                 }
 464                 else
 465                 {
 466                     lua_pop( L, 1 ); /* pop "path" */
 467                     msg_Warn( p_this,
 468                              "Playlist item's path should be a string" );
 469                 }
 470                 /* playlist key item */
 471             }
 472             else
 473             {
 474                 msg_Warn( p_this, "Playlist item should be a table" );
 475             }
 476             /* <Parse playlist item> */
 477             lua_pop( L, 1 ); /* pop the value, keep the key for
 478                               * the next lua_next() call */
 479             /* playlist key */
 480         }
 481         /* playlist */
 482     }
 483     else
 484     {
 485         msg_Warn( p_this, "Playlist should be a table." );
 486     }
 487     return i_count;
 488 }