tmp
[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_decrapifier.h>
37
38 #include "art.h"
39 #include "fetcher.h"
40 #include "playlist_internal.h"
41
42 /*****************************************************************************
43  * Structures/definitions
44  *****************************************************************************/
45 struct playlist_fetcher_t
46 {
47     playlist_t      *p_playlist;
48
49     vlc_mutex_t     lock;
50     vlc_cond_t      wait;
51     bool            b_live;
52     int             i_art_policy;
53     int             i_waiting;
54     input_item_t    **pp_waiting;
55
56     DECL_ARRAY(playlist_album_t) albums;
57 };
58
59 static void *Thread( void * );
60
61
62 /*****************************************************************************
63  * Public functions
64  *****************************************************************************/
65 playlist_fetcher_t *playlist_fetcher_New( playlist_t *p_playlist )
66 {
67     playlist_fetcher_t *p_fetcher = malloc( sizeof(*p_fetcher) );
68     if( !p_fetcher )
69         return NULL;
70
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 );
79
80     return p_fetcher;
81 }
82
83 void playlist_fetcher_Push( playlist_fetcher_t *p_fetcher,
84                             input_item_t *p_item )
85 {
86     vlc_gc_incref( p_item );
87
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 )
92     {
93         vlc_thread_t th;
94
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" );
98         else
99         {
100             vlc_detach( th );
101             p_fetcher->b_live = true;
102         }
103     }
104     vlc_mutex_unlock( &p_fetcher->lock );
105 }
106
107 void playlist_fetcher_Delete( playlist_fetcher_t *p_fetcher )
108 {
109     vlc_mutex_lock( &p_fetcher->lock );
110     /* Remove any left-over item, the fetcher will exit */
111     while( p_fetcher->i_waiting > 0 )
112     {
113         vlc_gc_decref( p_fetcher->pp_waiting[0] );
114         REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
115     }
116
117     while( p_fetcher->b_live )
118         vlc_cond_wait( &p_fetcher->wait, &p_fetcher->lock );
119     vlc_mutex_unlock( &p_fetcher->lock );
120
121     vlc_cond_destroy( &p_fetcher->wait );
122     vlc_mutex_destroy( &p_fetcher->lock );
123     free( p_fetcher );
124 }
125
126 /*****************************************************************************
127  * Privates functions
128  *****************************************************************************/
129
130 /**
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.
134  */
135
136 static void Decrapify( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
137 {
138     vlc_object_t *p_parent = VLC_OBJECT(p_fetcher->p_playlist);
139
140     decrapifier_t *p_decrapifier =
141     vlc_custom_create( p_parent, sizeof(*p_decrapifier), VLC_OBJECT_GENERIC,
142                       "movie name decrapifier" );
143     if(!p_decrapifier)
144         return;
145
146     vlc_object_attach( p_decrapifier, p_parent );
147     p_decrapifier->p_item = p_item;
148     
149     module_t *p_module = module_need( p_decrapifier,
150                                      "movie name decrapifier", NULL, false );
151     if( p_module )
152         module_unneed( p_decrapifier, p_module );
153     vlc_object_release( p_decrapifier );
154 }
155
156 /**
157  * This function locates the art associated to an input item.
158  * Return codes:
159  *   0 : Art is in cache or is a local file
160  *   1 : Art found, need to download
161  *  -X : Error/not found
162  */
163 static int FindArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
164 {
165     int i_ret;
166
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 );
170     if( !psz_title )
171         psz_title = input_item_GetName( p_item );
172
173     if( !psz_title && !psz_artist && !psz_album )
174         return VLC_EGENERIC;
175
176     free( psz_title );
177
178     /* If we already checked this album in this session, skip */
179     if( psz_artist && psz_album )
180     {
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 ) )
184             {
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 */
189                 free( psz_artist );
190                 free( psz_album );
191                 if( album.b_found )
192                 {
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 );
197                     return 0;
198                 }
199                 else
200                 {
201                     return VLC_EGENERIC;
202                 }
203             }
204         FOREACH_END();
205     }
206     free( psz_artist );
207     free( psz_album );
208
209     playlist_FindArtInCache( p_item );
210
211     char *psz_arturl = input_item_GetArtURL( p_item );
212     if( psz_arturl )
213     {
214         /* We already have an URL */
215         if( !strncmp( psz_arturl, "file://", strlen( "file://" ) ) )
216         {
217             free( psz_arturl );
218             return 0; /* Art is in cache, no need to go further */
219         }
220
221         free( psz_arturl );
222
223         /* Art need to be put in cache */
224         return 1;
225     }
226
227     /* */
228     psz_album = input_item_GetAlbum( p_item );
229     psz_artist = input_item_GetArtist( p_item );
230     if( psz_album && psz_artist )
231     {
232         msg_Dbg( p_fetcher->p_playlist, "searching art for %s - %s",
233              psz_artist, psz_album );
234     }
235     else
236     {
237         psz_title = input_item_GetTitle( p_item );
238         if( !psz_title )
239             psz_title = input_item_GetName( p_item );
240
241         msg_Dbg( p_fetcher->p_playlist, "searching art for %s", psz_title );
242         free( psz_title );
243     }
244
245     /* Fetch the art url */
246     i_ret = VLC_EGENERIC;
247
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,
251                            "art finder" );
252     if( p_finder != NULL)
253     {
254         module_t *p_module;
255
256         vlc_object_attach( p_finder, p_parent );
257         p_finder->p_item = p_item;
258
259         p_module = module_need( p_finder, "art finder", NULL, false );
260         if( p_module )
261         {
262             module_unneed( p_finder, p_module );
263             i_ret = 1;
264         }
265         vlc_object_release( p_finder );
266     }
267
268     /* Record this album */
269     if( psz_artist && psz_album )
270     {
271         playlist_album_t a;
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 );
277     }
278     else
279     {
280         free( psz_artist );
281         free( psz_album );
282     }
283
284     return i_ret;
285 }
286
287 /**
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
290  */
291 static int DownloadArt( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
292 {
293     char *psz_arturl = input_item_GetArtURL( p_item );
294     assert( *psz_arturl );
295
296     if( !strncmp( psz_arturl , "file://", 7 ) )
297     {
298         msg_Dbg( p_fetcher->p_playlist,
299                  "Album art is local file, no need to cache" );
300         free( psz_arturl );
301         return VLC_SUCCESS;
302     }
303
304     if( !strncmp( psz_arturl , "APIC", 4 ) )
305     {
306         msg_Warn( p_fetcher->p_playlist, "APIC fetch not supported yet" );
307         goto error;
308     }
309
310     stream_t *p_stream = stream_UrlNew( p_fetcher->p_playlist, psz_arturl );
311     if( !p_stream )
312         goto error;
313
314     uint8_t *p_data = NULL;
315     int i_data = 0;
316     for( ;; )
317     {
318         int i_read = 65536;
319
320         if( i_data >= INT_MAX - i_read )
321             break;
322
323         p_data = realloc_or_free( p_data, i_data + i_read );
324         if( !p_data )
325             break;
326
327         i_read = stream_Read( p_stream, &p_data[i_data], i_read );
328         if( i_read <= 0 )
329             break;
330
331         i_data += i_read;
332     }
333     stream_Delete( p_stream );
334
335     if( p_data && i_data > 0 )
336     {
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 */
340
341         playlist_SaveArt( p_fetcher->p_playlist, p_item, p_data, i_data, psz_type );
342     }
343
344     free( p_data );
345
346     free( psz_arturl );
347     return VLC_SUCCESS;
348
349 error:
350     free( psz_arturl );
351     return VLC_EGENERIC;
352 }
353
354
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 )
357 {
358     VLC_UNUSED(p_this); VLC_UNUSED(psz_cmd); VLC_UNUSED(oldval);
359     vlc_cond_t *p_cond = p_data;
360
361     if( newval.i_int == INPUT_EVENT_ITEM_META ||
362         newval.i_int == INPUT_EVENT_DEAD )
363         vlc_cond_signal( p_cond );
364
365     return VLC_SUCCESS;
366 }
367
368
369 /* Check if it is not yet preparsed and if so wait for it
370  * (at most 0.5s)
371  * (This can happen if we fetch art on play)
372  * FIXME this doesn't work if we need to fetch meta before art...
373  */
374 static void WaitPreparsed( playlist_fetcher_t *p_fetcher, input_item_t *p_item )
375 {
376     if( input_item_IsPreparsed( p_item ) )
377         return;
378
379     input_thread_t *p_input = playlist_CurrentInput( p_fetcher->p_playlist );
380     if( !p_input )
381         return;
382
383     if( input_GetItem( p_input ) != p_item )
384         goto exit;
385
386     vlc_cond_t cond;
387     vlc_cond_init( &cond );
388     var_AddCallback( p_input, "intf-event", InputEvent, &cond );
389
390     const mtime_t i_deadline = mdate() + 500*1000;
391     bool b_timeout = false;
392
393     while( !p_input->b_eof && !p_input->b_error
394         && !input_item_IsPreparsed( p_item ) && !b_timeout )
395     {
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 ) )
400             b_timeout = true;
401         vlc_mutex_unlock( &p_fetcher->lock );
402     }
403
404     var_DelCallback( p_input, "intf-event", InputEvent, &cond );
405     vlc_cond_destroy( &cond );
406
407 exit:
408     vlc_object_release( p_input );
409 }
410
411 static void *Thread( void *p_data )
412 {
413     playlist_fetcher_t *p_fetcher = p_data;
414     playlist_t *p_playlist = p_fetcher->p_playlist;
415
416     for( ;; )
417     {
418         input_item_t *p_item = NULL;
419
420         vlc_mutex_lock( &p_fetcher->lock );
421         if( p_fetcher->i_waiting != 0 )
422         {
423             p_item = p_fetcher->pp_waiting[0];
424             REMOVE_ELEM( p_fetcher->pp_waiting, p_fetcher->i_waiting, 0 );
425         }
426         else
427         {
428             p_fetcher->b_live = false;
429             vlc_cond_signal( &p_fetcher->wait );
430         }
431         vlc_mutex_unlock( &p_fetcher->lock );
432
433         if( !p_item )
434             break;
435
436         /* */
437
438         /* Wait that the input item is preparsed if it is being played */
439         WaitPreparsed( p_fetcher, p_item );
440
441         Decrapify( 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 }