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

   1 /*****************************************************************************
   2  * meta.c: Get meta/artwork using lua scripts
   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 <vlc_common.h>
  37 #include <vlc_input.h>
  38 #include <vlc_playlist.h>
  39 #include <vlc_meta.h>
  40 #include <vlc_demux.h>
  41 #include <vlc_art_finder.h>
  42 #include <vlc_url.h>
  43 #include <vlc_strings.h>
  44 #include <vlc_stream.h>
  45
  46 #include "vlc.h"
  47 #include "libs.h"
  48
  49 /*****************************************************************************
  50  * Init lua
  51  *****************************************************************************/
  52 static const luaL_Reg p_reg[] = { { NULL, NULL } };
  53
  54 static lua_State * init( vlc_object_t *p_this, input_item_t * p_item, const char *psz_filename )
  55 {
  56     lua_State * L = luaL_newstate();
  57     if( !L )
  58     {
  59         msg_Err( p_this, "Could not create new Lua State" );
  60         return NULL;
  61     }
  62
  63     /* Load Lua libraries */
  64     luaL_openlibs( L ); /* XXX: Don't open all the libs? */
  65
  66     luaL_register( L, "vlc", p_reg );
  67
  68     luaopen_msg( L );
  69     luaopen_stream( L );
  70     luaopen_strings( L );
  71     luaopen_variables( L );
  72     luaopen_object( L );
  73     luaopen_misc( L );
  74     luaopen_xml( L );
  75     luaopen_input_item( L, p_item );
  76
  77     lua_pushlightuserdata( L, p_this );
  78     lua_setfield( L, -2, "private" );
  79
  80     if( vlclua_add_modules_path( p_this, L, psz_filename ) )
  81     {
  82         msg_Warn( p_this, "Error while setting the module search path for %s",
  83                   psz_filename );
  84         lua_close( L );
  85         return NULL;
  86     }
  87
  88     return L;
  89 }
  90
  91 /*****************************************************************************
  92  * Run a lua entry point function
  93  *****************************************************************************/
  94 static int run( vlc_object_t *p_this, const char * psz_filename,
  95                 lua_State * L, const char *luafunction )
  96 {
  97     /* Ugly hack to delete previous versions of the fetchart()
  98      * functions. */
  99     lua_pushnil( L );
 100     lua_setglobal( L, luafunction );
 101
 102     /* Load and run the script(s) */
 103     if( luaL_dofile( L, psz_filename ) )
 104     {
 105         msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
 106                  lua_tostring( L, lua_gettop( L ) ) );
 107         goto error;
 108     }
 109
 110     lua_getglobal( L, luafunction );
 111
 112     if( !lua_isfunction( L, lua_gettop( L ) ) )
 113     {
 114         msg_Warn( p_this, "Error while runing script %s, "
 115                  "function %s() not found", psz_filename, luafunction );
 116         goto error;
 117     }
 118
 119     if( lua_pcall( L, 0, 1, 0 ) )
 120     {
 121         msg_Warn( p_this, "Error while runing script %s, "
 122                  "function %s(): %s", psz_filename, luafunction,
 123                  lua_tostring( L, lua_gettop( L ) ) );
 124         goto error;
 125     }
 126     return VLC_SUCCESS;
 127
 128 error:
 129     lua_pop( L, 1 );
 130     return VLC_EGENERIC;
 131 }
 132
 133 /*****************************************************************************
 134  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
 135  * pointed by psz_filename.
 136  *****************************************************************************/
 137 static int fetch_art( vlc_object_t *p_this, const char * psz_filename,
 138                       void * user_data )
 139 {
 140     input_item_t * p_item = user_data;
 141     int s;
 142
 143     lua_State *L = init( p_this, p_item, psz_filename );
 144     if( !L )
 145         return VLC_EGENERIC;
 146
 147     int i_ret = run(p_this, psz_filename, L, "fetch_art");
 148     if(i_ret != VLC_SUCCESS)
 149     {
 150         lua_close( L );
 151         return i_ret;
 152     }
 153
 154     if((s = lua_gettop( L )))
 155     {
 156         const char * psz_value;
 157
 158         if( lua_isstring( L, s ) )
 159         {
 160             psz_value = lua_tostring( L, s );
 161             if( psz_value && *psz_value != 0 )
 162             {
 163                 lua_Dbg( p_this, "setting arturl: %s", psz_value );
 164                 input_item_SetArtURL ( p_item, psz_value );
 165                 lua_close( L );
 166                 return VLC_SUCCESS;
 167             }
 168         }
 169         else if( !lua_isnil( L, s ) )
 170         {
 171             msg_Err( p_this, "Lua art fetcher script %s: "
 172                  "didn't return a string", psz_filename );
 173         }
 174     }
 175     else
 176     {
 177         msg_Err( p_this, "Script went completely foobar" );
 178     }
 179
 180     lua_close( L );
 181     return VLC_EGENERIC;
 182 }
 183
 184 /*****************************************************************************
 185  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
 186  * pointed by psz_filename.
 187  *****************************************************************************/
 188 static int read_meta( vlc_object_t *p_this, const char * psz_filename,
 189                       void * user_data )
 190 {
 191     input_item_t * p_item = user_data;
 192     lua_State *L = init( p_this, p_item, psz_filename );
 193     if( !L )
 194         return VLC_EGENERIC;
 195
 196     int i_ret = run(p_this, psz_filename, L, "read_meta");
 197     if(i_ret != VLC_SUCCESS)
 198     {
 199         lua_close( L );
 200         return i_ret;
 201     }
 202
 203     // Continue, all "meta reader" are always run.
 204     lua_close( L );
 205     return 1;
 206 }
 207
 208
 209 /*****************************************************************************
 210  * Called through lua_scripts_batch_execute to call 'fetch_meta' on the script
 211  * pointed by psz_filename.
 212  *****************************************************************************/
 213 static int fetch_meta( vlc_object_t *p_this, const char * psz_filename,
 214                        void * user_data )
 215 {
 216     input_item_t * p_item = user_data;
 217     lua_State *L = init( p_this, p_item, psz_filename );
 218     if( !L )
 219         return VLC_EGENERIC;
 220
 221     int ret = run(p_this, psz_filename, L, "fetch_meta");
 222     lua_close( L );
 223
 224     return ret;
 225 }
 226
 227 /*****************************************************************************
 228  * Read meta.
 229  *****************************************************************************/
 230
 231 int ReadMeta( vlc_object_t *p_this )
 232 {
 233     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 234     input_item_t *p_item = p_demux_meta->p_item;
 235
 236     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/reader", &read_meta, p_item );
 237
 238     return i_ret;
 239 }
 240
 241
 242 /*****************************************************************************
 243  * Read meta.
 244  *****************************************************************************/
 245
 246 int FetchMeta( vlc_object_t *p_this )
 247 {
 248     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 249     input_item_t *p_item = p_demux_meta->p_item;
 250
 251     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/fetcher", &fetch_meta, p_item );
 252
 253     return i_ret;
 254 }
 255
 256
 257 /*****************************************************************************
 258  * Module entry point for art.
 259  *****************************************************************************/
 260 int FindArt( vlc_object_t *p_this )
 261 {
 262     art_finder_t *p_finder = (art_finder_t *)p_this;
 263     input_item_t *p_item = p_finder->p_item;
 264
 265     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/art", &fetch_art, p_item );
 266
 267     return i_ret;
 268 }
 269