vlc_clone_detach: remove thread handle parameter
[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 <assert.h>
29
30 #include <vlc_common.h>
31 #include <vlc_playlist.h>
32 #include <vlc_stream.h>
33 #include <limits.h>
34 #include <vlc_art_finder.h>
35 #include <vlc_memory.h>
36 #include <vlc_demux.h>
37 #include <vlc_modules.h>
38
39 #include "art.h"
40 #include "fetcher.h"
41 #include "playlist_internal.h"
42
43 /*****************************************************************************
44  * Structures/definitions
45  *****************************************************************************/
46 struct playlist_fetcher_t
47 {
48     playlist_t      *p_playlist;
49
50     vlc_mutex_t     lock;
51     vlc_cond_t      wait;
52     bool            b_live;
53     int             i_art_policy;
54     int             i_waiting;
55     input_item_t    **pp_waiting;
56
57     DECL_ARRAY(playlist_album_t) albums;
58 };
59
60 static void *Thread( void * );
61
62
63 /*****************************************************************************
64  * Public functions
65  *****************************************************************************/
66 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
67 {
68     playlist_fetcher_t *p_fetcher = malloc( sizeof(*p_fetcher) );
69     if( !p_fetcher )
70         return NULL;
71
72     p_fetcher->p_playlist = p_playlist;
73     vlc_mutex_init( &p_fetcher->lock );
74     vlc_cond_init( &p_fetcher->wait );
75     p_fetcher->b_live = false;
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     return p_fetcher;
82 }
83
84 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher,
85                             input_item_t *p_item )
86 {
87     vlc_gc_incref( p_item );
88
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     if( !p_fetcher->b_live )
93     {
94         if( vlc_clone_detach( Thread, p_fetcher, VLC_THREAD_PRIORITY_LOW ) )
95             msg_Err( p_fetcher->p_playlist,
96                      "cannot spawn secondary preparse thread" );
97         else
98             p_fetcher->b_live = true;
99     }
100     vlc_mutex_unlock( &p_fetcher->lock );
101 }
102
103 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
104 {
105     vlc_mutex_lock( &p_fetcher->lock );
106     /* Remove any left-over item, the fetcher will exit */
107     while( p_fetcher->i_waiting > 0 )
108     {
109         vlc_gc_decref( p_fetcher->pp_waiting[0] );
110         REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
111     }
112
113     while( p_fetcher->b_live )
114         vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
115     vlc_mutex_unlock( &p_fetcher->lock );
116
117     vlc_cond_destroy( &p_fetcher->wait );
118     vlc_mutex_destroy( &p_fetcher->lock );
119     free( 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
137     char *psz_artist = input_item_GetArtist( p_item );
138     char *psz_album = input_item_GetAlbum( p_item );
139     char *psz_title = input_item_GetTitle( p_item );
140     if( !psz_title )
141         psz_title = input_item_GetName( p_item );
142
143     if( !psz_title && !psz_artist && !psz_album )
144         return VLC_EGENERIC;
145
146     free( psz_title );
147
148     /* If we already checked this album in this session, skip */
149     if( psz_artist && psz_album )
150     {
151         FOREACH_ARRAY( playlist_album_t album, p_fetcher->albums )
152             if( !strcmp( album.psz_artist, psz_artist ) &&
153                 !strcmp( album.psz_album, psz_album ) )
154             {
155                 msg_Dbg( p_fetcher->p_playlist,
156                          " %s - %s has already been searched",
157                          psz_artist, psz_album );
158                 /* TODO-fenrir if we cache art filename too, we can go faster */
159                 free( psz_artist );
160                 free( psz_album );
161                 if( album.b_found )
162                 {
163                     if( !strncmp( album.psz_arturl, "file://", 7 ) )
164                         input_item_SetArtURL( p_item, album.psz_arturl );
165                     else /* Actually get URL from cache */
166                         playlist_FindArtInCache( p_item );
167                     return 0;
168                 }
169                 else
170                 {
171                     return VLC_EGENERIC;
172                 }
173             }
174         FOREACH_END();
175     }
176     free( psz_artist );
177     free( psz_album );
178
179     playlist_FindArtInCache( p_item );
180
181     char *psz_arturl = input_item_GetArtURL( p_item );
182     if( psz_arturl )
183     {
184         /* We already have an URL */
185         if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
186         {
187             free( psz_arturl );
188             return 0; /* Art is in cache, no need to go further */
189         }
190
191         free( psz_arturl );
192
193         /* Art need to be put in cache */
194         return 1;
195     }
196
197     /* */
198     psz_album = input_item_GetAlbum( p_item );
199     psz_artist = input_item_GetArtist( p_item );
200     if( psz_album && psz_artist )
201     {
202         msg_Dbg( p_fetcher->p_playlist, "searching art for %s - %s",
203              psz_artist, psz_album );
204     }
205     else
206     {
207         psz_title = input_item_GetTitle( p_item );
208         if( !psz_title )
209             psz_title = input_item_GetName( p_item );
210
211         msg_Dbg( p_fetcher->p_playlist, "searching art for %s", psz_title );
212         free( psz_title );
213     }
214
215     /* Fetch the art url */
216     i_ret = VLC_EGENERIC;
217
218     vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
219     art_finder_t *p_finder =
220         vlc_custom_create( p_parent, sizeof( *p_finder ), VLC_OBJECT_GENERIC,
221                            "art finder" );
222     if( p_finder != NULL)
223     {
224         module_t *p_module;
225
226         vlc_object_attach( p_finder, p_parent );
227         p_finder->p_item = p_item;
228
229         p_module = module_need( p_finder, "art finder", NULL, false );
230         if( p_module )
231         {
232             module_unneed( p_finder, p_module );
233             /* Try immediately if found in cache by download URL */
234             if( !playlist_FindArtInCache( p_item ) )
235                 i_ret = 0;
236             else
237                 i_ret = 1;
238         }
239         vlc_object_release( p_finder );
240     }
241
242     /* Record this album */
243     if( psz_artist && psz_album )
244     {
245         playlist_album_t a;
246         a.psz_artist = psz_artist;
247         a.psz_album = psz_album;
248         a.psz_arturl = input_item_GetArtURL( p_item );
249         a.b_found = (i_ret == VLC_EGENERIC ? false : true );
250         ARRAY_APPEND( p_fetcher->albums, a );
251     }
252     else
253     {
254         free( psz_artist );
255         free( psz_album );
256     }
257
258     return i_ret;
259 }
260
261 /**
262  * Download the art using the URL or an art downloaded
263  * This function should be called only if data is not already in cache
264  */
265 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
266 {
267     char *psz_arturl = input_item_GetArtURL( p_item );
268     assert( *psz_arturl );
269
270     if( !strncmp( psz_arturl , "file://", 7 ) )
271     {
272         msg_Dbg( p_fetcher->p_playlist,
273                  "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->p_playlist, "APIC fetch not supported yet" );
281         goto error;
282     }
283
284     stream_t *p_stream = stream_UrlNew( p_fetcher->p_playlist, 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_or_free( 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  * FetchMeta, run the "meta fetcher". They are going to do network
330  * connections, and gather information upon the playing media.
331  * (even artwork).
332  */
333 static void FetchMeta( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
334 {
335     demux_meta_t *p_demux_meta = vlc_custom_create(p_fetcher->p_playlist,
336                                        sizeof(*p_demux_meta),
337                                        VLC_OBJECT_GENERIC, "demux meta" );
338     if( !p_demux_meta )
339         return;
340
341     vlc_object_attach( p_demux_meta, p_fetcher->p_playlist );
342     p_demux_meta->p_demux = NULL;
343     p_demux_meta->p_item = p_item;
344
345     module_t *p_meta_fetcher = module_need( p_demux_meta, "meta fetcher", NULL, false );
346     if( p_meta_fetcher )
347         module_unneed( p_demux_meta, p_meta_fetcher );
348     vlc_object_release( p_demux_meta );
349 }
350
351 static int InputEvent( vlc_object_t *p_this, char const *psz_cmd,
352                        vlc_value_t oldval, vlc_value_t newval, void *p_data )
353 {
354     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
355     vlc_cond_t *p_cond = p_data;
356
357     if( newval.i_int == INPUT_EVENT_ITEM_META ||
358         newval.i_int == INPUT_EVENT_DEAD )
359         vlc_cond_signal( p_cond );
360
361     return VLC_SUCCESS;
362 }
363
364
365 /* Check if it is not yet preparsed and if so wait for it
366  * (at most 0.5s)
367  * (This can happen if we fetch art on play)
368  * FIXME this doesn't work if we need to fetch meta before art...
369  */
370 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
371 {
372     if( input_item_IsPreparsed( p_item ) )
373         return;
374
375     input_thread_t *p_input = playlist_CurrentInput( p_fetcher->p_playlist );
376     if( !p_input )
377         return;
378
379     if( input_GetItem( p_input ) != p_item )
380         goto exit;
381
382     vlc_cond_t cond;
383     vlc_cond_init( &cond );
384     var_AddCallback( p_input, "intf-event", InputEvent, &cond );
385
386     const mtime_t i_deadline = mdate() + 500*1000;
387     bool b_timeout = false;
388
389     while( !p_input->b_eof && !p_input->b_error
390         && !input_item_IsPreparsed( p_item ) && !b_timeout )
391     {
392         /* A bit weird, but input_item_IsPreparsed holds the protected value */
393         /* FIXME: locking looks wrong here */
394         vlc_mutex_lock( &p_fetcher->lock );
395         if( vlc_cond_timedwait( &cond, &p_fetcher->lock, i_deadline ) )
396             b_timeout = true;
397         vlc_mutex_unlock( &p_fetcher->lock );
398     }
399
400     var_DelCallback( p_input, "intf-event", InputEvent, &cond );
401     vlc_cond_destroy( &cond );
402
403 exit:
404     vlc_object_release( p_input );
405 }
406
407 static void *Thread( void *p_data )
408 {
409     playlist_fetcher_t *p_fetcher = p_data;
410     playlist_t *p_playlist = p_fetcher->p_playlist;
411
412     for( ;; )
413     {
414         input_item_t *p_item = NULL;
415
416         vlc_mutex_lock( &p_fetcher->lock );
417         if( p_fetcher->i_waiting != 0 )
418         {
419             p_item = p_fetcher->pp_waiting[0];
420             REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
421         }
422         else
423         {
424             p_fetcher->b_live = false;
425             vlc_cond_signal( &p_fetcher->wait );
426         }
427         vlc_mutex_unlock( &p_fetcher->lock );
428
429         if( !p_item )
430             break;
431
432         /* */
433
434         /* Wait that the input item is preparsed if it is being played */
435         WaitPreparsed( p_fetcher, p_item );
436
437         /* Triggers "meta fetcher", eventually fetch meta on the network.
438          * They are identical to "meta reader" expect that may actually
439          * takes time. That's why they are running here.
440          * The result of this fetch is not cached. */
441         FetchMeta( p_fetcher, p_item );
442
443         /* Find art, and download it if needed */
444         int i_ret = FindArt( p_fetcher, p_item );
445         if( i_ret == 1 )
446             i_ret = DownloadArt( p_fetcher, p_item );
447
448         /* */
449         char *psz_name = input_item_GetName( p_item );
450         if( !i_ret ) /* Art is now in cache */
451         {
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 );
455         }
456         else
457         {
458             PL_DEBUG( "art not found for %s", psz_name );
459             input_item_SetArtNotFound( p_item, true );
460         }
461         free( psz_name );
462         vlc_gc_decref( p_item );
463     }
464     return NULL;
465 }