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 *****************************************************************************/
28 #include <vlc_common.h>
29 #include <vlc_playlist.h>
30 #include <vlc_stream.h>
34 #include "playlist_internal.h"
37 /*****************************************************************************
38 * Structures/definitions
39 *****************************************************************************/
40 struct playlist_fetcher_t
42 playlist_t *p_playlist;
49 input_item_t **pp_waiting;
51 DECL_ARRAY(playlist_album_t) albums;
54 static void *Thread( void * );
57 /*****************************************************************************
59 *****************************************************************************/
60 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
62 playlist_fetcher_t *p_fetcher = malloc( sizeof(*p_fetcher) );
66 p_fetcher->p_playlist = p_playlist;
67 vlc_mutex_init( &p_fetcher->lock );
68 vlc_cond_init( &p_fetcher->wait );
69 p_fetcher->i_waiting = 0;
70 p_fetcher->pp_waiting = NULL;
71 p_fetcher->i_art_policy = var_GetInteger( p_playlist, "album-art" );
72 ARRAY_INIT( p_fetcher->albums );
74 if( vlc_clone( &p_fetcher->thread, Thread, p_fetcher,
75 VLC_THREAD_PRIORITY_LOW ) )
77 msg_Err( p_playlist, "cannot spawn secondary preparse thread" );
85 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
87 vlc_gc_incref( p_item );
89 vlc_mutex_lock( &p_fetcher->lock );
90 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
91 p_fetcher->i_waiting, p_item );
92 vlc_cond_signal( &p_fetcher->wait );
93 vlc_mutex_unlock( &p_fetcher->lock );
96 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
98 /* Destroy the item meta-infos fetcher */
99 vlc_cancel( p_fetcher->thread );
100 vlc_join( p_fetcher->thread, NULL );
102 while( p_fetcher->i_waiting > 0 )
103 { /* Any left-over unparsed item? */
104 vlc_gc_decref( p_fetcher->pp_waiting[0] );
105 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
107 vlc_cond_destroy( &p_fetcher->wait );
108 vlc_mutex_destroy( &p_fetcher->lock );
113 /*****************************************************************************
115 *****************************************************************************/
117 * This function locates the art associated to an input item.
119 * 0 : Art is in cache or is a local file
120 * 1 : Art found, need to download
121 * -X : Error/not found
123 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
125 playlist_t *p_playlist = p_fetcher->p_playlist;
126 int i_ret = VLC_EGENERIC;
128 char *psz_title, *psz_artist, *psz_album;
130 psz_artist = input_item_GetArtist( p_item );
131 psz_album = input_item_GetAlbum( p_item );
132 psz_title = input_item_GetTitle( p_item );
134 psz_title = input_item_GetName( p_item );
136 if( !psz_title && !psz_artist && !psz_album )
141 /* If we already checked this album in this session, skip */
142 if( psz_artist && psz_album )
144 FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
145 if( !strcmp( album.psz_artist, psz_artist ) &&
146 !strcmp( album.psz_album, psz_album ) )
148 msg_Dbg( p_playlist, " %s - %s has already been searched",
149 psz_artist, psz_album );
150 /* TODO-fenrir if we cache art filename too, we can go faster */
155 if( !strncmp( album.psz_arturl, "file://", 7 ) )
156 input_item_SetArtURL( p_item, album.psz_arturl );
157 else /* Actually get URL from cache */
158 playlist_FindArtInCache( p_item );
171 playlist_FindArtInCache( p_item );
173 char *psz_arturl = input_item_GetArtURL( p_item );
176 /* We already have an URL */
177 if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
180 return 0; /* Art is in cache, no need to go further */
185 /* Art need to be put in cache */
190 p_playlist->p_private = p_item;
191 psz_album = input_item_GetAlbum( p_item );
192 psz_artist = input_item_GetArtist( p_item );
193 psz_title = input_item_GetTitle( p_item );
195 psz_title = input_item_GetName( p_item );
197 if( psz_album && psz_artist )
199 msg_Dbg( p_playlist, "searching art for %s - %s",
200 psz_artist, psz_album );
204 msg_Dbg( p_playlist, "searching art for %s",
209 p_module = module_need( p_playlist, "art finder", NULL, false );
214 msg_Dbg( p_playlist, "unable to find art" );
216 /* Record this album */
217 if( psz_artist && psz_album )
220 a.psz_artist = psz_artist;
221 a.psz_album = psz_album;
222 a.psz_arturl = input_item_GetArtURL( p_item );
223 a.b_found = (i_ret == VLC_EGENERIC ? false : true );
224 ARRAY_APPEND( p_fetcher->albums, a );
233 module_unneed( p_playlist, p_module );
234 p_playlist->p_private = NULL;
241 * Download the art using the URL or an art downloaded
242 * This function should be called only if data is not already in cache
244 static int DownloadArt( playlist_t *p_playlist, input_item_t *p_item )
246 char *psz_arturl = input_item_GetArtURL( p_item );
247 assert( *psz_arturl );
249 if( !strncmp( psz_arturl , "file://", 7 ) )
251 msg_Dbg( p_playlist, "Album art is local file, no need to cache" );
256 if( !strncmp( psz_arturl , "APIC", 4 ) )
258 msg_Warn( p_playlist, "APIC fetch not supported yet" );
262 stream_t *p_stream = stream_UrlNew( p_playlist, psz_arturl );
266 uint8_t *p_data = NULL;
272 if( i_data + i_read <= i_data ) /* Protect gainst overflow */
275 p_data = realloc( p_data, i_data + i_read );
279 i_read = stream_Read( p_stream, &p_data[i_data], i_read );
285 stream_Delete( p_stream );
287 if( p_data && i_data > 0 )
289 char *psz_type = strrchr( psz_arturl, '.' );
290 if( psz_type && strlen( psz_type ) > 5 )
291 psz_type = NULL; /* remove extension if it's > to 4 characters */
293 playlist_SaveArt( p_playlist, p_item, p_data, i_data, psz_type );
307 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
308 vlc_value_t oldval, vlc_value_t newval, void *p_data )
310 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
311 playlist_fetcher_t *p_fetcher = p_data;
313 if( newval.i_int == INPUT_EVENT_ITEM_META )
314 vlc_cond_signal( &p_fetcher->wait );
320 /* Check if it is not yet preparsed and if so wait for it
322 * (This can happen if we fetch art on play)
323 * FIXME this doesn't work if we need to fetch meta before art...
325 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
327 playlist_t *p_playlist = p_fetcher->p_playlist;
329 if( input_item_IsPreparsed( p_item ) )
332 input_thread_t *p_input = playlist_CurrentInput( p_playlist );
336 if( input_GetItem( p_input ) != p_item )
339 var_AddCallback( p_input, "intf-event", InputEvent, p_fetcher );
341 const mtime_t i_deadline = mdate() + 500*1000;
343 while( !p_input->b_eof && !p_input->b_error && !input_item_IsPreparsed( p_item ) )
345 /* A bit weird, but input_item_IsPreparsed does held the protected value */
346 vlc_mutex_lock( &p_fetcher->lock );
347 vlc_cond_timedwait( &p_fetcher->wait, &p_fetcher->lock, i_deadline );
348 vlc_mutex_unlock( &p_fetcher->lock );
350 if( i_deadline <= mdate() )
354 var_DelCallback( p_input, "intf-event", InputEvent, p_fetcher );
357 vlc_object_release( p_input );
360 static void *Thread( void *p_data )
362 playlist_fetcher_t *p_fetcher = p_data;
363 playlist_t *p_playlist = p_fetcher->p_playlist;
367 input_item_t *p_item;
369 /* Be sure to be cancellable before our queue is empty */
373 vlc_mutex_lock( &p_fetcher->lock );
374 mutex_cleanup_push( &p_fetcher->lock );
376 while( p_fetcher->i_waiting == 0 )
377 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
379 p_item = p_fetcher->pp_waiting[0];
380 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
387 int canc = vlc_savecancel();
389 /* Wait that the input item is preparsed if it is being played */
390 WaitPreparsed( p_fetcher, p_item );
392 /* Find art, and download it if needed */
393 int i_ret = FindArt( p_fetcher, p_item );
395 i_ret = DownloadArt( p_playlist, p_item );
398 char *psz_name = input_item_GetName( p_item );
399 if( !i_ret ) /* Art is now in cache */
401 PL_DEBUG( "found art for %s in cache", psz_name );
402 input_item_SetArtFetched( p_item, true );
403 var_SetInteger( p_playlist, "item-change", p_item->i_id );
407 PL_DEBUG( "art not found for %s", psz_name );
408 input_item_SetArtNotFound( p_item, true );
411 vlc_gc_decref( p_item );
413 vlc_restorecancel( canc );
415 int i_activity = var_GetInteger( p_playlist, "activity" );
416 if( i_activity < 0 ) i_activity = 0;
417 /* Sleep at least 1ms */
418 msleep( (i_activity+1) * 1000 );