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_decrapifier.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 );
126 /*****************************************************************************
128 *****************************************************************************/
131 * This function's job is to call the movie name decrapifier
132 * Those plugins goal are to fill in information from the file itself.
133 * Without network connection.
136 static void Decrapify( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
138 vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
140 decrapifier_t *p_decrapifier =
141 vlc_custom_create( p_parent, sizeof(*p_decrapifier), VLC_OBJECT_GENERIC,
142 "movie name decrapifier" );
146 vlc_object_attach( p_decrapifier, p_parent );
147 p_decrapifier->p_item = p_item;
149 module_t *p_module = module_need( p_decrapifier,
150 "movie name decrapifier", NULL, false );
152 module_unneed( p_decrapifier, p_module );
153 vlc_object_release( p_decrapifier );
157 * This function locates the art associated to an input item.
159 * 0 : Art is in cache or is a local file
160 * 1 : Art found, need to download
161 * -X : Error/not found
163 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
167 char *psz_artist = input_item_GetArtist( p_item );
168 char *psz_album = input_item_GetAlbum( p_item );
169 char *psz_title = input_item_GetTitle( p_item );
171 psz_title = input_item_GetName( p_item );
173 if( !psz_title && !psz_artist && !psz_album )
178 /* If we already checked this album in this session, skip */
179 if( psz_artist && psz_album )
181 FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
182 if( !strcmp( album.psz_artist, psz_artist ) &&
183 !strcmp( album.psz_album, psz_album ) )
185 msg_Dbg( p_fetcher->p_playlist,
186 " %s - %s has already been searched",
187 psz_artist, psz_album );
188 /* TODO-fenrir if we cache art filename too, we can go faster */
193 if( !strncmp( album.psz_arturl, "file://", 7 ) )
194 input_item_SetArtURL( p_item, album.psz_arturl );
195 else /* Actually get URL from cache */
196 playlist_FindArtInCache( p_item );
209 playlist_FindArtInCache( p_item );
211 char *psz_arturl = input_item_GetArtURL( p_item );
214 /* We already have an URL */
215 if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
218 return 0; /* Art is in cache, no need to go further */
223 /* Art need to be put in cache */
228 psz_album = input_item_GetAlbum( p_item );
229 psz_artist = input_item_GetArtist( p_item );
230 if( psz_album && psz_artist )
232 msg_Dbg( p_fetcher->p_playlist, "searching art for %s - %s",
233 psz_artist, psz_album );
237 psz_title = input_item_GetTitle( p_item );
239 psz_title = input_item_GetName( p_item );
241 msg_Dbg( p_fetcher->p_playlist, "searching art for %s", psz_title );
245 /* Fetch the art url */
246 i_ret = VLC_EGENERIC;
248 vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
249 art_finder_t *p_finder =
250 vlc_custom_create( p_parent, sizeof( *p_finder ), VLC_OBJECT_GENERIC,
252 if( p_finder != NULL)
256 vlc_object_attach( p_finder, p_parent );
257 p_finder->p_item = p_item;
259 p_module = module_need( p_finder, "art finder", NULL, false );
262 module_unneed( p_finder, p_module );
265 vlc_object_release( p_finder );
268 /* Record this album */
269 if( psz_artist && psz_album )
272 a.psz_artist = psz_artist;
273 a.psz_album = psz_album;
274 a.psz_arturl = input_item_GetArtURL( p_item );
275 a.b_found = (i_ret == VLC_EGENERIC ? false : true );
276 ARRAY_APPEND( p_fetcher->albums, a );
288 * Download the art using the URL or an art downloaded
289 * This function should be called only if data is not already in cache
291 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
293 char *psz_arturl = input_item_GetArtURL( p_item );
294 assert( *psz_arturl );
296 if( !strncmp( psz_arturl , "file://", 7 ) )
298 msg_Dbg( p_fetcher->p_playlist,
299 "Album art is local file, no need to cache" );
304 if( !strncmp( psz_arturl , "APIC", 4 ) )
306 msg_Warn( p_fetcher->p_playlist, "APIC fetch not supported yet" );
310 stream_t *p_stream = stream_UrlNew( p_fetcher->p_playlist, psz_arturl );
314 uint8_t *p_data = NULL;
320 if( i_data >= INT_MAX - i_read )
323 p_data = realloc_or_free( p_data, i_data + i_read );
327 i_read = stream_Read( p_stream, &p_data[i_data], i_read );
333 stream_Delete( p_stream );
335 if( p_data && i_data > 0 )
337 char *psz_type = strrchr( psz_arturl, '.' );
338 if( psz_type && strlen( psz_type ) > 5 )
339 psz_type = NULL; /* remove extension if it's > to 4 characters */
341 playlist_SaveArt( p_fetcher->p_playlist, p_item, p_data, i_data, psz_type );
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 Decrapify( p_fetcher, p_item );
443 /* Find art, and download it if needed */
444 int i_ret = FindArt( p_fetcher, p_item );
446 i_ret = DownloadArt( p_fetcher, p_item );
449 char *psz_name = input_item_GetName( p_item );
450 if( !i_ret ) /* Art is now in cache */
452 PL_DEBUG( "found art for %s in cache", psz_name );
453 input_item_SetArtFetched( p_item, true );
454 var_SetAddress( p_playlist, "item-change", p_item );
458 PL_DEBUG( "art not found for %s", psz_name );
459 input_item_SetArtNotFound( p_item, true );
462 vlc_gc_decref( p_item );