vlc.c
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:18k
源码类别:

midi

开发平台:

Unix_Linux

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