1 /*****************************************************************************
2 * fetcher.c: Art fetcher thread.
3 *****************************************************************************
4 * Copyright © 1999-2009 the VideoLAN team
7 * Authors: Samuel Hocevar <sam@zoy.org>
8 * Clément Stenac <zorglub@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 *****************************************************************************/
30 #include <vlc_common.h>
31 #include <vlc_playlist.h>
32 #include <vlc_stream.h>
34 #include <vlc_art_finder.h>
35 #include <vlc_memory.h>
39 #include "playlist_internal.h"
41 /*****************************************************************************
42 * Structures/definitions
43 *****************************************************************************/
44 struct playlist_fetcher_t
46 playlist_t *p_playlist;
53 input_item_t **pp_waiting;
55 DECL_ARRAY(playlist_album_t) albums;
58 static void *Thread( void * );
61 /*****************************************************************************
63 *****************************************************************************/
64 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
66 playlist_fetcher_t *p_fetcher = malloc( sizeof(*p_fetcher) );
70 p_fetcher->p_playlist = p_playlist;
71 vlc_mutex_init( &p_fetcher->lock );
72 vlc_cond_init( &p_fetcher->wait );
73 p_fetcher->b_live = false;
74 p_fetcher->i_waiting = 0;
75 p_fetcher->pp_waiting = NULL;
76 p_fetcher->i_art_policy = var_GetInteger( p_playlist, "album-art" );
77 ARRAY_INIT( p_fetcher->albums );
82 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher,
83 input_item_t *p_item )
85 vlc_gc_incref( p_item );
87 vlc_mutex_lock( &p_fetcher->lock );
88 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
89 p_fetcher->i_waiting, p_item );
90 if( !p_fetcher->b_live )
94 if( vlc_clone( &th, Thread, p_fetcher, VLC_THREAD_PRIORITY_LOW ) )
95 msg_Err( p_fetcher->p_playlist,
96 "cannot spawn secondary preparse thread" );
100 p_fetcher->b_live = true;
103 vlc_mutex_unlock( &p_fetcher->lock );
106 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
108 vlc_mutex_lock( &p_fetcher->lock );
109 /* Remove any left-over item, the fetcher will exit */
110 while( p_fetcher->i_waiting > 0 )
112 vlc_gc_decref( p_fetcher->pp_waiting[0] );
113 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
116 while( p_fetcher->b_live )
117 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
118 vlc_mutex_unlock( &p_fetcher->lock );
120 vlc_cond_destroy( &p_fetcher->wait );
121 vlc_mutex_destroy( &p_fetcher->lock );
126 /*****************************************************************************
128 *****************************************************************************/
130 * This function locates the art associated to an input item.
132 * 0 : Art is in cache or is a local file
133 * 1 : Art found, need to download
134 * -X : Error/not found
136 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
140 char *psz_artist = input_item_GetArtist( p_item );
141 char *psz_album = input_item_GetAlbum( p_item );
142 char *psz_title = input_item_GetTitle( p_item );
144 psz_title = input_item_GetName( p_item );
146 if( !psz_title && !psz_artist && !psz_album )
151 /* If we already checked this album in this session, skip */
152 if( psz_artist && psz_album )
154 FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
155 if( !strcmp( album.psz_artist, psz_artist ) &&
156 !strcmp( album.psz_album, psz_album ) )
158 msg_Dbg( p_fetcher->p_playlist,
159 " %s - %s has already been searched",
160 psz_artist, psz_album );
161 /* TODO-fenrir if we cache art filename too, we can go faster */
166 if( !strncmp( album.psz_arturl, "file://", 7 ) )
167 input_item_SetArtURL( p_item, album.psz_arturl );
168 else /* Actually get URL from cache */
169 playlist_FindArtInCache( p_item );
182 playlist_FindArtInCache( p_item );
184 char *psz_arturl = input_item_GetArtURL( p_item );
187 /* We already have an URL */
188 if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
191 return 0; /* Art is in cache, no need to go further */
196 /* Art need to be put in cache */
201 psz_album = input_item_GetAlbum( p_item );
202 psz_artist = input_item_GetArtist( p_item );
203 if( psz_album && psz_artist )
205 msg_Dbg( p_fetcher->p_playlist, "searching art for %s - %s",
206 psz_artist, psz_album );
210 psz_title = input_item_GetTitle( p_item );
212 psz_title = input_item_GetName( p_item );
214 msg_Dbg( p_fetcher->p_playlist, "searching art for %s", psz_title );
218 /* Fetch the art url */
219 i_ret = VLC_EGENERIC;
221 vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
222 art_finder_t *p_finder =
223 vlc_custom_create( p_parent, sizeof( *p_finder ), VLC_OBJECT_GENERIC,
225 if( p_finder != NULL)
229 vlc_object_attach( p_finder, p_parent );
230 p_finder->p_item = p_item;
232 p_module = module_need( p_finder, "art finder", NULL, false );
235 module_unneed( p_finder, p_module );
238 vlc_object_release( p_finder );
241 /* Record this album */
242 if( psz_artist && psz_album )
245 a.psz_artist = psz_artist;
246 a.psz_album = psz_album;
247 a.psz_arturl = input_item_GetArtURL( p_item );
248 a.b_found = (i_ret == VLC_EGENERIC ? false : true );
249 ARRAY_APPEND( p_fetcher->albums, a );
261 * Download the art using the URL or an art downloaded
262 * This function should be called only if data is not already in cache
264 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
266 char *psz_arturl = input_item_GetArtURL( p_item );
267 assert( *psz_arturl );
269 if( !strncmp( psz_arturl , "file://", 7 ) )
271 msg_Dbg( p_fetcher->p_playlist,
272 "Album art is local file, no need to cache" );
277 if( !strncmp( psz_arturl , "APIC", 4 ) )
279 msg_Warn( p_fetcher->p_playlist, "APIC fetch not supported yet" );
283 stream_t *p_stream = stream_UrlNew( p_fetcher->p_playlist, psz_arturl );
287 uint8_t *p_data = NULL;
293 if( i_data >= INT_MAX - i_read )
296 p_data = realloc_or_free( p_data, i_data + i_read );
300 i_read = stream_Read( p_stream, &p_data[i_data], i_read );
306 stream_Delete( p_stream );
308 if( p_data && i_data > 0 )
310 char *psz_type = strrchr( psz_arturl, '.' );
311 if( psz_type && strlen( psz_type ) > 5 )
312 psz_type = NULL; /* remove extension if it's > to 4 characters */
314 playlist_SaveArt( p_fetcher->p_playlist, p_item, p_data, i_data, psz_type );
328 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
329 vlc_value_t oldval, vlc_value_t newval, void *p_data )
331 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
332 vlc_cond_t *p_cond = p_data;
334 if( newval.i_int == INPUT_EVENT_ITEM_META ||
335 newval.i_int == INPUT_EVENT_DEAD )
336 vlc_cond_signal( p_cond );
342 /* Check if it is not yet preparsed and if so wait for it
344 * (This can happen if we fetch art on play)
345 * FIXME this doesn't work if we need to fetch meta before art...
347 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
349 if( input_item_IsPreparsed( p_item ) )
352 input_thread_t *p_input = playlist_CurrentInput( p_fetcher->p_playlist );
356 if( input_GetItem( p_input ) != p_item )
360 vlc_cond_init( &cond );
361 var_AddCallback( p_input, "intf-event", InputEvent, &cond );
363 const mtime_t i_deadline = mdate() + 500*1000;
364 bool b_timeout = false;
366 while( !p_input->b_eof && !p_input->b_error
367 && !input_item_IsPreparsed( p_item ) && !b_timeout )
369 /* A bit weird, but input_item_IsPreparsed holds the protected value */
370 /* FIXME: locking looks wrong here */
371 vlc_mutex_lock( &p_fetcher->lock );
372 if( vlc_cond_timedwait( &cond, &p_fetcher->lock, i_deadline ) )
374 vlc_mutex_unlock( &p_fetcher->lock );
377 var_DelCallback( p_input, "intf-event", InputEvent, &cond );
378 vlc_cond_destroy( &cond );
381 vlc_object_release( p_input );
384 static void *Thread( void *p_data )
386 playlist_fetcher_t *p_fetcher = p_data;
387 playlist_t *p_playlist = p_fetcher->p_playlist;
391 input_item_t *p_item = NULL;
393 vlc_mutex_lock( &p_fetcher->lock );
394 if( p_fetcher->i_waiting != 0 )
396 p_item = p_fetcher->pp_waiting[0];
397 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
401 p_fetcher->b_live = false;
402 vlc_cond_signal( &p_fetcher->wait );
404 vlc_mutex_unlock( &p_fetcher->lock );
411 /* Wait that the input item is preparsed if it is being played */
412 WaitPreparsed( p_fetcher, p_item );
414 /* Find art, and download it if needed */
415 int i_ret = FindArt( p_fetcher, p_item );
417 i_ret = DownloadArt( p_fetcher, p_item );
420 char *psz_name = input_item_GetName( p_item );
421 if( !i_ret ) /* Art is now in cache */
423 PL_DEBUG( "found art for %s in cache", psz_name );
424 input_item_SetArtFetched( p_item, true );
425 var_SetAddress( p_playlist, "item-change", p_item );
429 PL_DEBUG( "art not found for %s", psz_name );
430 input_item_SetArtNotFound( p_item, true );
433 vlc_gc_decref( p_item );