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