fetcher: fix a typo (thanks to fenrir).
[vlc.git] / src / playlist / fetcher.c
1 /*****************************************************************************
2  * fetcher.c: Art fetcher thread.
3  *****************************************************************************
4  * Copyright © 1999-2009 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Samuel Hocevar <sam@zoy.org>
8  *          Clément Stenac <zorglub@videolan.org>
9  *
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.
14  *
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.
19  *
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  *****************************************************************************/
24 #ifdef HAVE_CONFIG_H
25 # include "config.h"
26 #endif
27
28 #include <vlc_common.h>
29 #include <vlc_playlist.h>
30 #include <vlc_stream.h>
31 #include <limits.h>
32
33 #include "art.h"
34 #include "fetcher.h"
35 #include "playlist_internal.h"
36
37
38 /*****************************************************************************
39  * Structures/definitions
40  *****************************************************************************/
41 struct playlist_fetcher_t
42 {
43     VLC_COMMON_MEMBERS;
44
45     playlist_t      *p_playlist;
46
47     vlc_thread_t    thread;
48     vlc_mutex_t     lock;
49     bool            b_live, b_zombie;
50     int             i_art_policy;
51     int             i_waiting;
52     input_item_t    **pp_waiting;
53
54     DECL_ARRAY(playlist_album_t) albums;
55 };
56
57 static void *Thread( void * );
58
59
60 /*****************************************************************************
61  * Public functions
62  *****************************************************************************/
63 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
64 {
65     playlist_fetcher_t *p_fetcher =
66         vlc_custom_create( p_playlist, sizeof(*p_fetcher),
67                            VLC_OBJECT_GENERIC, "playlist fetcher" );
68
69     if( !p_fetcher )
70         return NULL;
71
72     vlc_object_attach( p_fetcher, p_playlist );
73     p_fetcher->p_playlist = p_playlist;
74     vlc_mutex_init( &p_fetcher->lock );
75     p_fetcher->b_live = false;
76     p_fetcher->b_zombie = false;
77     p_fetcher->i_waiting = 0;
78     p_fetcher->pp_waiting = NULL;
79     p_fetcher->i_art_policy = var_GetInteger( p_playlist, "album-art" );
80     ARRAY_INIT( p_fetcher->albums );
81
82     return p_fetcher;
83 }
84
85 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
86 {
87     vlc_gc_incref( p_item );
88
89     vlc_mutex_lock( &p_fetcher->lock );
90     if( p_fetcher->b_zombie ) /* FIXME: detach the thread */
91     {
92         vlc_join( p_fetcher->thread, NULL );
93         p_fetcher->b_zombie = false;
94     }
95
96     INSERT_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting,
97                  p_fetcher->i_waiting, p_item );
98     if( !p_fetcher->b_live )
99     {
100         if( vlc_clone( &p_fetcher->thread, Thread, p_fetcher,
101                        VLC_THREAD_PRIORITY_LOW ) )
102             msg_Err( p_fetcher, "cannot spawn secondary preparse thread" );
103         else
104             p_fetcher->b_live = true;
105     }
106     vlc_mutex_unlock( &p_fetcher->lock );
107 }
108
109 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
110 {
111     bool b_join;
112     /* Destroy the item meta-infos fetcher */
113     vlc_mutex_lock( &p_fetcher->lock );
114     if( p_fetcher->b_live )
115     {
116         vlc_object_kill( p_fetcher );
117         vlc_cancel( p_fetcher->thread );
118     }
119     b_join = p_fetcher->b_live || p_fetcher->b_zombie;
120     vlc_mutex_unlock( &p_fetcher->lock );
121     if( b_join )
122         vlc_join( p_fetcher->thread, NULL );
123
124     while( p_fetcher->i_waiting > 0 )
125     {   /* Any left-over unparsed item? */
126         vlc_gc_decref( p_fetcher->pp_waiting[0] );
127         REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
128     }
129     vlc_mutex_destroy( &p_fetcher->lock );
130     vlc_object_release( p_fetcher );
131 }
132
133
134 /*****************************************************************************
135  * Privates functions
136  *****************************************************************************/
137 /**
138  * This function locates the art associated to an input item.
139  * Return codes:
140  *   0 : Art is in cache or is a local file
141  *   1 : Art found, need to download
142  *  -X : Error/not found
143  */
144 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
145 {
146     int i_ret;
147     module_t *p_module;
148     char *psz_title, *psz_artist, *psz_album;
149
150     psz_artist = input_item_GetArtist( p_item );
151     psz_album = input_item_GetAlbum( p_item );
152     psz_title = input_item_GetTitle( p_item );
153     if( !psz_title )
154         psz_title = input_item_GetName( p_item );
155
156     if( !psz_title && !psz_artist && !psz_album )
157         return VLC_EGENERIC;
158
159     free( psz_title );
160
161     /* If we already checked this album in this session, skip */
162     if( psz_artist && psz_album )
163     {
164         FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
165             if( !strcmp( album.psz_artist, psz_artist ) &&
166                 !strcmp( album.psz_album, psz_album ) )
167             {
168                 msg_Dbg( p_fetcher, " %s - %s has already been searched",
169                          psz_artist, psz_album );
170                 /* TODO-fenrir if we cache art filename too, we can go faster */
171                 free( psz_artist );
172                 free( psz_album );
173                 if( album.b_found )
174                 {
175                     if( !strncmp( album.psz_arturl, "file://", 7 ) )
176                         input_item_SetArtURL( p_item, album.psz_arturl );
177                     else /* Actually get URL from cache */
178                         playlist_FindArtInCache( p_item );
179                     return 0;
180                 }
181                 else
182                 {
183                     return VLC_EGENERIC;
184                 }
185             }
186         FOREACH_END();
187     }
188     free( psz_artist );
189     free( psz_album );
190
191     playlist_FindArtInCache( p_item );
192
193     char *psz_arturl = input_item_GetArtURL( p_item );
194     if( psz_arturl )
195     {
196         /* We already have an URL */
197         if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
198         {
199             free( psz_arturl );
200             return 0; /* Art is in cache, no need to go further */
201         }
202
203         free( psz_arturl );
204
205         /* Art need to be put in cache */
206         return 1;
207     }
208
209     /* */
210     psz_album = input_item_GetAlbum( p_item );
211     psz_artist = input_item_GetArtist( p_item );
212     if( psz_album && psz_artist )
213     {
214         msg_Dbg( p_fetcher, "searching art for %s - %s",
215              psz_artist, psz_album );
216     }
217     else
218     {
219         psz_title = input_item_GetTitle( p_item );
220         if( !psz_title )
221             psz_title = input_item_GetName( p_item );
222
223         msg_Dbg( p_fetcher, "searching art for %s", psz_title );
224         free( psz_title );
225     }
226
227     /* Fetch the art url */
228     p_fetcher->p_private = p_item;
229
230     p_module = module_need( p_fetcher, "art finder", NULL, false );
231
232     if( p_module )
233     {
234         module_unneed( p_fetcher, p_module );
235         i_ret = 1;
236     }
237     else
238     {
239         msg_Dbg( p_fetcher, "unable to find art" );
240         i_ret = VLC_EGENERIC;
241     }
242
243     /* Record this album */
244     if( psz_artist && psz_album )
245     {
246         playlist_album_t a;
247         a.psz_artist = psz_artist;
248         a.psz_album = psz_album;
249         a.psz_arturl = input_item_GetArtURL( p_item );
250         a.b_found = (i_ret == VLC_EGENERIC ? false : true );
251         ARRAY_APPEND( p_fetcher->albums, a );
252     }
253     else
254     {
255         free( psz_artist );
256         free( psz_album );
257     }
258
259     return i_ret;
260 }
261
262 /**
263  * Download the art using the URL or an art downloaded
264  * This function should be called only if data is not already in cache
265  */
266 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
267 {
268     char *psz_arturl = input_item_GetArtURL( p_item );
269     assert( *psz_arturl );
270
271     if( !strncmp( psz_arturl , "file://", 7 ) )
272     {
273         msg_Dbg( p_fetcher, "Album art is local file, no need to cache" );
274         free( psz_arturl );
275         return VLC_SUCCESS;
276     }
277
278     if( !strncmp( psz_arturl , "APIC", 4 ) )
279     {
280         msg_Warn( p_fetcher, "APIC fetch not supported yet" );
281         goto error;
282     }
283
284     stream_t *p_stream = stream_UrlNew( p_fetcher, psz_arturl );
285     if( !p_stream )
286         goto error;
287
288     uint8_t *p_data = NULL;
289     int i_data = 0;
290     for( ;; )
291     {
292         int i_read = 65536;
293
294         if( i_data >= INT_MAX - i_read )
295             break;
296
297         p_data = realloc( p_data, i_data + i_read );
298         if( !p_data )
299             break;
300
301         i_read = stream_Read( p_stream, &p_data[i_data], i_read );
302         if( i_read <= 0 )
303             break;
304
305         i_data += i_read;
306     }
307     stream_Delete( p_stream );
308
309     if( p_data && i_data > 0 )
310     {
311         char *psz_type = strrchr( psz_arturl, '.' );
312         if( psz_type && strlen( psz_type ) > 5 )
313             psz_type = NULL; /* remove extension if it's > to 4 characters */
314
315         playlist_SaveArt( p_fetcher->p_playlist, p_item, p_data, i_data, psz_type );
316     }
317
318     free( p_data );
319
320     free( psz_arturl );
321     return VLC_SUCCESS;
322
323 error:
324     free( psz_arturl );
325     return VLC_EGENERIC;
326 }
327
328
329 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
330                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
331 {
332     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
333     vlc_cond_t *p_cond = p_data;
334
335     if( newval.i_int == INPUT_EVENT_ITEM_META ||
336         newval.i_int == INPUT_EVENT_DEAD )
337         vlc_cond_signal( p_cond );
338
339     return VLC_SUCCESS;
340 }
341
342
343 /* Check if it is not yet preparsed and if so wait for it
344  * (at most 0.5s)
345  * (This can happen if we fetch art on play)
346  * FIXME this doesn't work if we need to fetch meta before art...
347  */
348 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
349 {
350     if( input_item_IsPreparsed( p_item ) )
351         return;
352
353     input_thread_t *p_input = playlist_CurrentInput( p_fetcher->p_playlist );
354     if( !p_input )
355         return;
356
357     if( input_GetItem( p_input ) != p_item )
358         goto exit;
359
360     vlc_cond_t cond;
361     vlc_cond_init( &cond );
362     var_AddCallback( p_input, "intf-event", InputEvent, &cond );
363
364     const mtime_t i_deadline = mdate() + 500*1000;
365     bool b_timeout = false;
366
367     while( !p_input->b_eof && !p_input->b_error
368         && !input_item_IsPreparsed( p_item ) && !b_timeout )
369     {
370         /* A bit weird, but input_item_IsPreparsed holds the protected value */
371         /* FIXME: locking looks wrong here */
372         vlc_mutex_lock( &p_fetcher->lock );
373         if( vlc_cond_timedwait( &cond, &p_fetcher->lock, i_deadline ) )
374             b_timeout = true;
375         vlc_mutex_unlock( &p_fetcher->lock );
376     }
377
378     var_DelCallback( p_input, "intf-event", InputEvent, &cond );
379     vlc_cond_destroy( &cond );
380
381 exit:
382     vlc_object_release( p_input );
383 }
384
385 static void *Thread( void *p_data )
386 {
387     playlist_fetcher_t *p_fetcher = p_data;
388     playlist_t *p_playlist = p_fetcher->p_playlist;
389
390     for( ;; )
391     {
392         input_item_t *p_item = NULL;
393
394         vlc_mutex_lock( &p_fetcher->lock );
395         if( p_fetcher->i_waiting != 0 )
396         {
397             p_item = p_fetcher->pp_waiting[0];
398             REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
399         }
400         else
401         {
402             p_fetcher->b_live = false;
403             p_fetcher->b_zombie = true;
404         }
405         vlc_mutex_unlock( &p_fetcher->lock );
406
407         if( !p_item )
408             break;
409
410         /* */
411         int canc = vlc_savecancel();
412
413         /* Wait that the input item is preparsed if it is being played */
414         WaitPreparsed( p_fetcher, p_item );
415
416         /* */
417         if( !vlc_object_alive( p_fetcher ) )
418             goto end;
419
420         /* Find art, and download it if needed */
421         int i_ret = FindArt( p_fetcher, p_item );
422
423         /* */
424         if( !vlc_object_alive( p_fetcher ) )
425             goto end;
426
427         if( i_ret == 1 )
428             i_ret = DownloadArt( p_fetcher, p_item );
429
430         /* */
431         char *psz_name = input_item_GetName( p_item );
432         if( !i_ret ) /* Art is now in cache */
433         {
434             PL_DEBUG( "found art for %s in cache", psz_name );
435             input_item_SetArtFetched( p_item, true );
436             var_SetAddress( p_playlist, "item-change", p_item );
437         }
438         else
439         {
440             PL_DEBUG( "art not found for %s", psz_name );
441             input_item_SetArtNotFound( p_item, true );
442         }
443         free( psz_name );
444
445     end:
446         vlc_gc_decref( p_item );
447
448         vlc_restorecancel( canc );
449
450         int i_activity = var_GetInteger( p_playlist, "activity" );
451         if( i_activity < 0 ) i_activity = 0;
452         /* Sleep at least 1ms and handle potential thread cancellation */
453         msleep( (i_activity+1) * 1000 );
454     }
455     return NULL;
456 }