1 /*****************************************************************************
2 * meta.c: Get meta/artwork using lua scripts
3 *****************************************************************************
4 * Copyright (C) 2007-2008 the VideoLAN team
7 * Authors: Antoine Cellerier <dionoea at videolan tod org>
8 * Pierre d'Herbemont <pdherbemont # videolan.org>
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.
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.
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 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
36 #include <vlc_common.h>
37 #include <vlc_input.h>
39 #include <vlc_demux.h>
40 #include <vlc_art_finder.h>
42 #include <vlc_strings.h>
43 #include <vlc_stream.h>
48 /*****************************************************************************
50 *****************************************************************************/
51 static const luaL_Reg p_reg[] = { { NULL, NULL } };
53 static lua_State * init( vlc_object_t *p_this, input_item_t * p_item, const char *psz_filename )
55 lua_State * L = luaL_newstate();
58 msg_Err( p_this, "Could not create new Lua State" );
62 vlclua_set_this( L, p_this );
64 /* Load Lua libraries */
65 luaL_openlibs( L ); /* XXX: Don't open all the libs? */
67 luaL_register( L, "vlc", p_reg );
72 luaopen_variables( L );
75 luaopen_input_item( L, p_item );
77 if( vlclua_add_modules_path( p_this, L, psz_filename ) )
79 msg_Warn( p_this, "Error while setting the module search path for %s",
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 )
94 /* Ugly hack to delete previous versions of the fetchart()
97 lua_setglobal( L, luafunction );
99 /* Load and run the script(s) */
100 if( luaL_dofile( L, psz_filename ) )
102 msg_Warn( p_this, "Error loading script %s: %s", psz_filename,
103 lua_tostring( L, lua_gettop( L ) ) );
107 lua_getglobal( L, luafunction );
109 if( !lua_isfunction( L, lua_gettop( L ) ) )
111 msg_Warn( p_this, "Error while running script %s, "
112 "function %s() not found", psz_filename, luafunction );
116 if( lua_pcall( L, 0, 1, 0 ) )
118 msg_Warn( p_this, "Error while running script %s, "
119 "function %s(): %s", psz_filename, luafunction,
120 lua_tostring( L, lua_gettop( L ) ) );
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,
137 input_item_t * p_item = user_data;
139 lua_State *L = init( p_this, p_item, psz_filename );
143 int i_ret = run(p_this, psz_filename, L, "fetch_art");
144 if(i_ret != VLC_SUCCESS)
152 const char * psz_value;
154 if( lua_isstring( L, -1 ) )
156 psz_value = lua_tostring( L, -1 );
157 if( psz_value && *psz_value != 0 )
159 lua_Dbg( p_this, "setting arturl: %s", psz_value );
160 input_item_SetArtURL ( p_item, psz_value );
165 else if( !lua_isnoneornil( L, -1 ) )
167 msg_Err( p_this, "Lua art fetcher script %s: "
168 "didn't return a string", psz_filename );
173 msg_Err( p_this, "Script went completely foobar" );
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,
187 input_item_t * p_item = user_data;
188 lua_State *L = init( p_this, p_item, psz_filename );
192 int i_ret = run(p_this, psz_filename, L, "read_meta");
195 // Continue even if an error occurred: all "meta reader" are always run.
196 return i_ret == VLC_SUCCESS ? VLC_EGENERIC : i_ret;
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,
207 input_item_t * p_item = user_data;
208 lua_State *L = init( p_this, p_item, psz_filename );
212 int ret = run(p_this, psz_filename, L, "fetch_meta");
218 /*****************************************************************************
220 *****************************************************************************/
222 int ReadMeta( vlc_object_t *p_this )
224 demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
225 input_item_t *p_item = p_demux_meta->p_item;
227 return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"reader",
228 &read_meta, p_item );
232 /*****************************************************************************
234 *****************************************************************************/
236 int FetchMeta( vlc_object_t *p_this )
238 demux_meta_t *p_demux_meta = (demux_meta_t *)p_this;
239 input_item_t *p_item = p_demux_meta->p_item;
241 return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"fetcher",
242 &fetch_meta, p_item );
246 /*****************************************************************************
247 * Module entry point for art.
248 *****************************************************************************/
249 int FindArt( vlc_object_t *p_this )
251 art_finder_t *p_finder = (art_finder_t *)p_this;
252 input_item_t *p_item = p_finder->p_item;
254 return vlclua_scripts_batch_execute( p_this, "meta"DIR_SEP"art",
255 &fetch_art, p_item );