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