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 )
  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_input_item( L, p_item );
  75
  76     lua_pushlightuserdata( L, p_this );
  77     lua_setfield( L, -2, "private" );
  78
  79     return L;
  80 }
  81
  82 /*****************************************************************************
  83  * Run a lua entry point function
  84  *****************************************************************************/
  85 static int run( vlc_object_t *p_this, const char * psz_filename,
  86                 lua_State * L, const char *luafunction )
  87 {
  88     /* Ugly hack to delete previous versions of the fetchart()
  89      * functions. */
  90     lua_pushnil( L );
  91     lua_setglobal( L, luafunction );
  92
  93     /* Load and run the script(s) */
  94     if( luaL_dofile( L, psz_filename ) )
  95     {
  96         msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
  97                  lua_tostring( L, lua_gettop( L ) ) );
  98         goto error;
  99     }
 100
 101     lua_getglobal( L, luafunction );
 102
 103     if( !lua_isfunction( L, lua_gettop( L ) ) )
 104     {
 105         msg_Warn( p_this, "Error while runing script %s, "
 106                  "function %s() not found", psz_filename, luafunction );
 107         goto error;
 108     }
 109
 110     if( lua_pcall( L, 0, 1, 0 ) )
 111     {
 112         msg_Warn( p_this, "Error while runing script %s, "
 113                  "function %s(): %s", psz_filename, luafunction,
 114                  lua_tostring( L, lua_gettop( L ) ) );
 115         goto error;
 116     }
 117     return VLC_SUCCESS;
 118
 119 error:
 120     lua_pop( L, 1 );
 121     return VLC_EGENERIC;
 122 }
 123
 124 /*****************************************************************************
 125  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
 126  * pointed by psz_filename.
 127  *****************************************************************************/
 128 static int fetch_art( vlc_object_t *p_this, const char * psz_filename,
 129                       lua_State * L, void * user_data )
 130 {
 131     input_item_t * p_input = user_data;
 132     int s;
 133
 134     int i_ret = run(p_this, psz_filename, L, "fetch_art");
 135     if(i_ret != VLC_SUCCESS)
 136         return i_ret;
 137
 138     if((s = lua_gettop( L )))
 139     {
 140         const char * psz_value;
 141
 142         if( lua_isstring( L, s ) )
 143         {
 144             psz_value = lua_tostring( L, s );
 145             if( psz_value && *psz_value != 0 )
 146             {
 147                 lua_Dbg( p_this, "setting arturl: %s", psz_value );
 148                 input_item_SetArtURL ( p_input, psz_value );
 149                 return VLC_SUCCESS;
 150             }
 151         }
 152         else if( !lua_isnil( L, s ) )
 153         {
 154             msg_Err( p_this, "Lua art fetcher script %s: "
 155                  "didn't return a string", psz_filename );
 156         }
 157     }
 158     else
 159     {
 160         msg_Err( p_this, "Script went completely foobar" );
 161     }
 162
 163     return VLC_EGENERIC;
 164 }
 165
 166 /*****************************************************************************
 167  * Called through lua_scripts_batch_execute to call 'fetch_art' on the script
 168  * pointed by psz_filename.
 169  *****************************************************************************/
 170 static int read_meta( vlc_object_t *p_this, const char * psz_filename,
 171                      lua_State * L, void * user_data )
 172 {
 173     VLC_UNUSED(user_data);
 174
 175     int i_ret = run(p_this, psz_filename, L, "read_meta");
 176     if(i_ret != VLC_SUCCESS)
 177         return i_ret;
 178
 179     // Continue, all "meta reader" are always run.
 180     return 1;
 181 }
 182
 183
 184 /*****************************************************************************
 185  * Called through lua_scripts_batch_execute to call 'fetch_meta' on the script
 186  * pointed by psz_filename.
 187  *****************************************************************************/
 188 static int fetch_meta( vlc_object_t *p_this, const char * psz_filename,
 189                      lua_State * L, void * user_data )
 190 {
 191     VLC_UNUSED(user_data);
 192
 193     return run(p_this, psz_filename, L, "fetch_meta");
 194 }
 195
 196 /*****************************************************************************
 197  * Read meta.
 198  *****************************************************************************/
 199
 200 int ReadMeta( vlc_object_t *p_this )
 201 {
 202     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 203     input_item_t *p_item = p_demux_meta->p_item;
 204
 205     lua_State *L = init( p_this, p_item );
 206     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/reader", &read_meta, L, NULL );
 207     lua_close( L );
 208
 209     return i_ret;
 210 }
 211
 212
 213 /*****************************************************************************
 214  * Read meta.
 215  *****************************************************************************/
 216
 217 int FetchMeta( vlc_object_t *p_this )
 218 {
 219     demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
 220     input_item_t *p_item = p_demux_meta->p_item;
 221
 222     lua_State *L = init( p_this, p_item );
 223     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/fetcher", &fetch_meta, L, NULL );
 224     lua_close( L );
 225
 226     return i_ret;
 227 }
 228
 229
 230 /*****************************************************************************
 231  * Module entry point for art.
 232  *****************************************************************************/
 233 int FindArt( vlc_object_t *p_this )
 234 {
 235     art_finder_t *p_finder = (art_finder_t *)p_this;
 236     input_item_t *p_item = p_finder->p_item;
 237
 238     lua_State *L = init( p_this, p_item );
 239     int i_ret = vlclua_scripts_batch_execute( p_this, "meta/art", &fetch_art, L, p_item );
 240     lua_close( L );
 241
 242     return i_ret;
 243 }
 244