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>
36 #include <vlc_demux.h>
40 #include "playlist_internal.h"
42 /*****************************************************************************
43 * Structures/definitions
44 *****************************************************************************/
45 struct playlist_fetcher_t
47 playlist_t *p_playlist;
54 input_item_t **pp_waiting;
56 DECL_ARRAY(playlist_album_t) albums;
59 static void *Thread( void * );
62 /*****************************************************************************
64 *****************************************************************************/
65 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
67 playlist_fetcher_t *p_fetcher = malloc( sizeof(*p_fetcher) );
71 p_fetcher->p_playlist = p_playlist;
72 vlc_mutex_init( &p_fetcher->lock );
73 vlc_cond_init( &p_fetcher->wait );
74 p_fetcher->b_live = false;
75 p_fetcher->i_waiting = 0;
76 p_fetcher->pp_waiting = NULL;
77 p_fetcher->i_art_policy = var_GetInteger( p_playlist, "album-art" );
78 ARRAY_INIT( p_fetcher->albums );
83 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher,
84 input_item_t *p_item )
86 vlc_gc_incref( p_item );
88 vlc_mutex_lock( &p_fetcher->lock );
89 INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
90 p_fetcher->i_waiting, p_item );
91 if( !p_fetcher->b_live )
95 if( vlc_clone( &th, Thread, p_fetcher, VLC_THREAD_PRIORITY_LOW ) )
96 msg_Err( p_fetcher->p_playlist,
97 "cannot spawn secondary preparse thread" );
101 p_fetcher->b_live = true;
104 vlc_mutex_unlock( &p_fetcher->lock );
107 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
109 vlc_mutex_lock( &p_fetcher->lock );
110 /* Remove any left-over item, the fetcher will exit */
111 while( p_fetcher->i_waiting > 0 )
113 vlc_gc_decref( p_fetcher->pp_waiting[0] );
114 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
117 while( p_fetcher->b_live )
118 vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
119 vlc_mutex_unlock( &p_fetcher->lock );
121 vlc_cond_destroy( &p_fetcher->wait );
122 vlc_mutex_destroy( &p_fetcher->lock );
127 /*****************************************************************************
129 *****************************************************************************/
131 * This function locates the art associated to an input item.
133 * 0 : Art is in cache or is a local file
134 * 1 : Art found, need to download
135 * -X : Error/not found
137 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
141 char *psz_artist = input_item_GetArtist( p_item );
142 char *psz_album = input_item_GetAlbum( p_item );
143 char *psz_title = input_item_GetTitle( p_item );
145 psz_title = input_item_GetName( p_item );
147 if( !psz_title && !psz_artist && !psz_album )
152 /* If we already checked this album in this session, skip */
153 if( psz_artist && psz_album )
155 FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
156 if( !strcmp( album.psz_artist, psz_artist ) &&
157 !strcmp( album.psz_album, psz_album ) )
159 msg_Dbg( p_fetcher->p_playlist,
160 " %s - %s has already been searched",
161 psz_artist, psz_album );
162 /* TODO-fenrir if we cache art filename too, we can go faster */
167 if( !strncmp( album.psz_arturl, "file://", 7 ) )
168 input_item_SetArtURL( p_item, album.psz_arturl );
169 else /* Actually get URL from cache */
170 playlist_FindArtInCache( p_item );
183 playlist_FindArtInCache( p_item );
185 char *psz_arturl = input_item_GetArtURL( p_item );
188 /* We already have an URL */
189 if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
192 return 0; /* Art is in cache, no need to go further */
197 /* Art need to be put in cache */
202 psz_album = input_item_GetAlbum( p_item );
203 psz_artist = input_item_GetArtist( p_item );
204 if( psz_album && psz_artist )
206 msg_Dbg( p_fetcher->p_playlist, "searching art for %s - %s",
207 psz_artist, psz_album );
211 psz_title = input_item_GetTitle( p_item );
213 psz_title = input_item_GetName( p_item );
215 msg_Dbg( p_fetcher->p_playlist, "searching art for %s", psz_title );
219 /* Fetch the art url */
220 i_ret = VLC_EGENERIC;
222 vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
223 art_finder_t *p_finder =
224 vlc_custom_create( p_parent, sizeof( *p_finder ), VLC_OBJECT_GENERIC,
226 if( p_finder != NULL)
230 vlc_object_attach( p_finder, p_parent );
231 p_finder->p_item = p_item;
233 p_module = module_need( p_finder, "art finder", NULL, false );
236 module_unneed( p_finder, p_module );
237 /* Try immediately if found in cache by download URL */
238 if( !playlist_FindArtInCache( p_item ) )
243 vlc_object_release( p_finder );
246 /* Record this album */
247 if( psz_artist && psz_album )
250 a.psz_artist = psz_artist;
251 a.psz_album = psz_album;
252 a.psz_arturl = input_item_GetArtURL( p_item );
253 a.b_found = (i_ret == VLC_EGENERIC ? false : true );
254 ARRAY_APPEND( p_fetcher->albums, a );
266 * Download the art using the URL or an art downloaded
267 * This function should be called only if data is not already in cache
269 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
271 char *psz_arturl = input_item_GetArtURL( p_item );
272 assert( *psz_arturl );
274 if( !strncmp( psz_arturl , "file://", 7 ) )
276 msg_Dbg( p_fetcher->p_playlist,
277 "Album art is local file, no need to cache" );
282 if( !strncmp( psz_arturl , "APIC", 4 ) )
284 msg_Warn( p_fetcher->p_playlist, "APIC fetch not supported yet" );
288 stream_t *p_stream = stream_UrlNew( p_fetcher->p_playlist, psz_arturl );
292 uint8_t *p_data = NULL;
298 if( i_data >= INT_MAX - i_read )
301 p_data = realloc_or_free( p_data, i_data + i_read );
305 i_read = stream_Read( p_stream, &p_data[i_data], i_read );
311 stream_Delete( p_stream );
313 if( p_data && i_data > 0 )
315 char *psz_type = strrchr( psz_arturl, '.' );
316 if( psz_type && strlen( psz_type ) > 5 )
317 psz_type = NULL; /* remove extension if it's > to 4 characters */
319 playlist_SaveArt( p_fetcher->p_playlist, p_item, p_data, i_data, psz_type );
333 * FetchMeta, run the "meta fetcher". They are going to do network
334 * connections, and gather information upon the playing media.
337 static void FetchMeta( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
339 demux_meta_t *p_demux_meta = vlc_custom_create(p_fetcher->p_playlist,
340 sizeof(*p_demux_meta),
341 VLC_OBJECT_GENERIC, "demux meta" );
345 vlc_object_attach( p_demux_meta, p_fetcher->p_playlist );
346 p_demux_meta->p_demux = NULL;
347 p_demux_meta->p_item = p_item;
349 module_t *p_meta_fetcher = module_need( p_demux_meta, "meta fetcher", NULL, false );
351 module_unneed( p_demux_meta, p_meta_fetcher );
352 vlc_object_release( p_demux_meta );
355 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
356 vlc_value_t oldval, vlc_value_t newval, void *p_data )
358 VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
359 vlc_cond_t *p_cond = p_data;
361 if( newval.i_int == INPUT_EVENT_ITEM_META ||
362 newval.i_int == INPUT_EVENT_DEAD )
363 vlc_cond_signal( p_cond );
369 /* Check if it is not yet preparsed and if so wait for it
371 * (This can happen if we fetch art on play)
372 * FIXME this doesn't work if we need to fetch meta before art...
374 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
376 if( input_item_IsPreparsed( p_item ) )
379 input_thread_t *p_input = playlist_CurrentInput( p_fetcher->p_playlist );
383 if( input_GetItem( p_input ) != p_item )
387 vlc_cond_init( &cond );
388 var_AddCallback( p_input, "intf-event", InputEvent, &cond );
390 const mtime_t i_deadline = mdate() + 500*1000;
391 bool b_timeout = false;
393 while( !p_input->b_eof && !p_input->b_error
394 && !input_item_IsPreparsed( p_item ) && !b_timeout )
396 /* A bit weird, but input_item_IsPreparsed holds the protected value */
397 /* FIXME: locking looks wrong here */
398 vlc_mutex_lock( &p_fetcher->lock );
399 if( vlc_cond_timedwait( &cond, &p_fetcher->lock, i_deadline ) )
401 vlc_mutex_unlock( &p_fetcher->lock );
404 var_DelCallback( p_input, "intf-event", InputEvent, &cond );
405 vlc_cond_destroy( &cond );
408 vlc_object_release( p_input );
411 static void *Thread( void *p_data )
413 playlist_fetcher_t *p_fetcher = p_data;
414 playlist_t *p_playlist = p_fetcher->p_playlist;
418 input_item_t *p_item = NULL;
420 vlc_mutex_lock( &p_fetcher->lock );
421 if( p_fetcher->i_waiting != 0 )
423 p_item = p_fetcher->pp_waiting[0];
424 REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
428 p_fetcher->b_live = false;
429 vlc_cond_signal( &p_fetcher->wait );
431 vlc_mutex_unlock( &p_fetcher->lock );
438 /* Wait that the input item is preparsed if it is being played */
439 WaitPreparsed( p_fetcher, p_item );
441 /* Triggers "meta fetcher", eventually fetch meta on the network.
442 * They are identical to "meta reader" expect that may actually
443 * takes time. That's why they are running here.
444 * The result of this fetch is not cached. */
445 FetchMeta( p_fetcher, p_item );
447 /* Find art, and download it if needed */
448 int i_ret = FindArt( p_fetcher, p_item );
450 i_ret = DownloadArt( p_fetcher, p_item );
453 char *psz_name = input_item_GetName( p_item );
454 if( !i_ret ) /* Art is now in cache */
456 PL_DEBUG( "found art for %s in cache", psz_name );
457 input_item_SetArtFetched( p_item, true );
458 var_SetAddress( p_playlist, "item-change", p_item );
462 PL_DEBUG( "art not found for %s", psz_name );
463 input_item_SetArtNotFound( p_item, true );
466 vlc_gc_decref( p_item );