988406d4f2a67bd175173b90e470e1bb1b7c2f96
[vlc.git] / src / input / meta.c
1 /*****************************************************************************
2  * meta.c : Metadata handling
3  *****************************************************************************
4  * Copyright (C) 1998-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Antoine Cellerier <dionoea@videolan.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
25 #include <vlc/vlc.h>
26 #include <vlc_input.h>
27 #include <vlc_stream.h>
28 #include <vlc_meta.h>
29 #include <vlc_playlist.h>
30 #include <vlc_charset.h>
31 #include <vlc_strings.h>
32 #include "../playlist/playlist_internal.h"
33 #include <errno.h>
34
35 #ifdef HAVE_SYS_STAT_H
36 #   include <sys/stat.h>
37 #endif
38
39 static const char * meta_type_to_string[VLC_META_TYPE_COUNT] =
40 {
41     [vlc_meta_Title]            = N_("Title"),
42     [vlc_meta_Artist]           = N_("Artist"),
43     [vlc_meta_Genre]            = N_("Genre"),
44     [vlc_meta_Copyright]        = N_("Copyright"),
45     [vlc_meta_Album]            = N_("Album"),
46     [vlc_meta_TrackNumber]      = N_("Track number"),
47     [vlc_meta_Description]      = N_("Description"),
48     [vlc_meta_Rating]           = N_("Rating"),
49     [vlc_meta_Date]             = N_("Date"),
50     [vlc_meta_Setting]          = N_("Setting"),
51     [vlc_meta_URL]              = N_("URL"),
52     [vlc_meta_Language]         = N_("Language"),
53     [vlc_meta_NowPlaying]       = N_("Now Playing"),
54     [vlc_meta_Publisher]        = N_("Publisher"),
55     [vlc_meta_EncodedBy]        = N_("Encoded by"),
56     [vlc_meta_ArtworkURL]       = N_("Artwork URL"),
57     [vlc_meta_TrackID]          = N_("Track ID"),
58 };
59
60 const char *
61 input_MetaTypeToLocalizedString( vlc_meta_type_t meta_type )
62 {
63     return _(meta_type_to_string[meta_type]);
64 }
65
66 #define input_FindArtInCache(a,b) __input_FindArtInCache(VLC_OBJECT(a),b)
67 static int __input_FindArtInCache( vlc_object_t *, input_item_t *p_item );
68
69 vlc_bool_t input_MetaSatisfied( playlist_t *p_playlist, input_item_t *p_item,
70                                 uint32_t *pi_mandatory, uint32_t *pi_optional )
71 {
72     (void)p_playlist;
73     *pi_mandatory = VLC_META_ENGINE_TITLE | VLC_META_ENGINE_ARTIST;
74
75     uint32_t i_meta = input_CurrentMetaFlags( p_item->p_meta );
76     *pi_mandatory &= ~i_meta;
77     *pi_optional = 0; /// Todo
78     return *pi_mandatory ? VLC_FALSE:VLC_TRUE;
79 }
80
81 int input_MetaFetch( playlist_t *p_playlist, input_item_t *p_item )
82 {
83     struct meta_engine_t *p_me;
84     uint32_t i_mandatory, i_optional;
85
86     input_MetaSatisfied( p_playlist, p_item, &i_mandatory, &i_optional );
87     // Meta shouldn't magically appear
88     assert( i_mandatory );
89
90     /* FIXME: object creation is overkill, use p_private */
91     p_me = vlc_object_create( p_playlist, VLC_OBJECT_META_ENGINE );
92     p_me->i_flags |= OBJECT_FLAGS_NOINTERACT;
93     p_me->i_flags |= OBJECT_FLAGS_QUIET;
94     p_me->i_mandatory = i_mandatory;
95     p_me->i_optional = i_optional;
96
97     p_me->p_item = p_item;
98     p_me->p_module = module_Need( p_me, "meta fetcher", 0, VLC_FALSE );
99     if( !p_me->p_module )
100     {
101         vlc_object_destroy( p_me );
102         return VLC_EGENERIC;
103     }
104     module_Unneed( p_me, p_me->p_module );
105     vlc_object_destroy( p_me );
106
107     input_item_SetMetaFetched( p_item, VLC_TRUE );
108
109     return VLC_SUCCESS;
110 }
111
112 /* Return codes:
113  *   0 : Art is in cache
114  *   1 : Art found, need to download
115  *  -X : Error/not found
116  */
117 int input_ArtFind( playlist_t *p_playlist, input_item_t *p_item )
118 {
119     int i_ret = VLC_EGENERIC;
120     module_t *p_module;
121     char *psz_title, *psz_artist, *psz_album;
122
123     psz_artist = input_item_GetArtist( p_item );
124     psz_album = input_item_GetAlbum( p_item );
125     psz_title = input_item_GetTitle( p_item );
126     if(!psz_title)
127         psz_title = input_item_GetName( p_item );
128
129     if( !psz_title && !psz_artist && !psz_album )
130         return VLC_EGENERIC;
131
132     free( psz_title );
133
134     /* If we already checked this album in this session, skip */
135     if( psz_artist && psz_album )
136     {
137         FOREACH_ARRAY( playlist_album_t album, p_playlist->p_fetcher->albums )
138             if( !strcmp( album.psz_artist, psz_artist ) &&
139                 !strcmp( album.psz_album, psz_album ) )
140             {
141                 msg_Dbg( p_playlist, " %s - %s has already been searched",
142                          psz_artist, psz_album );
143         /* TODO-fenrir if we cache art filename too, we can go faster */
144                 free( psz_artist );
145                 free( psz_album );
146                 if( album.b_found )
147                 {
148                     /* Actually get URL from cache */
149                     input_FindArtInCache( p_playlist, p_item );
150                     return 0;
151                 }
152                 else
153                 {
154                     return VLC_EGENERIC;
155                 }
156             }
157         FOREACH_END();
158     }
159     free( psz_artist );
160     free( psz_album );
161
162     input_FindArtInCache( p_playlist, p_item );
163
164     char *psz_arturl = input_item_GetArtURL( p_item );
165     if( !EMPTY_STR( psz_arturl ) )
166     {
167         free( psz_arturl );
168         return 0; /* Art is in cache, no need to go further */
169     }
170     free( psz_arturl );
171
172     PL_LOCK;
173     p_playlist->p_private = p_item;
174     psz_album = input_item_GetAlbum( p_item );
175     psz_artist = input_item_GetArtist( p_item );
176     psz_title = input_item_GetTitle( p_item );
177     if( !psz_title )
178         psz_title = input_item_GetName( p_item );
179
180     if( psz_album && psz_artist )
181     {
182         msg_Dbg( p_playlist, "searching art for %s - %s",
183              psz_artist, psz_album );
184     }
185     else
186     {
187         msg_Dbg( p_playlist, "searching art for %s",
188              psz_title );
189     }
190     free( psz_title );
191
192     p_module = module_Need( p_playlist, "art finder", 0, VLC_FALSE );
193
194     if( p_module )
195         i_ret = 1;
196     else
197         msg_Dbg( p_playlist, "unable to find art" );
198
199     /* Record this album */
200     if( psz_artist && psz_album )
201     {
202         playlist_album_t a;
203         a.psz_artist = psz_artist;
204         a.psz_album = psz_album;
205         a.b_found = (i_ret == VLC_EGENERIC ? VLC_FALSE : VLC_TRUE );
206         ARRAY_APPEND( p_playlist->p_fetcher->albums, a );
207     }
208     else
209     {
210         free( psz_artist );
211         free( psz_album );
212     }
213
214     if( p_module )
215         module_Unneed( p_playlist, p_module );
216     p_playlist->p_private = NULL;
217     PL_UNLOCK;
218
219     return i_ret;
220 }
221
222 #ifndef MAX_PATH
223 #   define MAX_PATH 250
224 #endif
225 static void ArtCacheCreateDir( const char *psz_dir )
226 {
227     char newdir[MAX_PATH+1];
228     strcpy( newdir, psz_dir );
229     char * psz_newdir = newdir;
230     char * psz = psz_newdir;
231
232     while( *psz )
233     {
234         while( *psz && *psz != DIR_SEP_CHAR) psz++;
235         if( !*psz ) break;
236         *psz = 0;        
237         if( !EMPTY_STR( psz_newdir ) ) utf8_mkdir( psz_newdir );
238         *psz = DIR_SEP_CHAR;
239         psz++;   
240     }
241     utf8_mkdir( psz_dir );
242 }
243
244 static char * ArtCacheGetSanitizedFileName( const char *psz )
245 {
246     char *dup = strdup(psz);
247     int i;
248
249     filename_sanitize( dup );
250
251     /* Doesn't create a filename with invalid characters
252      * TODO: several filesystems forbid several characters: list them all
253      */
254     for( i = 0; dup[i] != '\0'; i++ )
255     {
256         if( dup[i] == DIR_SEP_CHAR )
257             dup[i] = ' ';
258     }
259     return dup;
260 }
261
262 #define ArtCacheGetDirPath(a,b,c,d,e) __ArtCacheGetDirPath(VLC_OBJECT(a),b,c,d,e)
263 static void __ArtCacheGetDirPath( vlc_object_t *p_obj,
264                                   char *psz_dir,
265                                   const char *psz_title,
266                                   const char *psz_artist, const char *psz_album )
267 {
268     if( !EMPTY_STR(psz_artist) && !EMPTY_STR(psz_album) )
269     {
270         char * psz_album_sanitized = ArtCacheGetSanitizedFileName( psz_album );
271         char * psz_artist_sanitized = ArtCacheGetSanitizedFileName( psz_artist );
272
273         snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
274                   "art" DIR_SEP "artistalbum" DIR_SEP "%s" DIR_SEP "%s",
275                       p_obj->p_libvlc->psz_homedir,
276                       psz_artist_sanitized, psz_album_sanitized );
277         free( psz_album_sanitized );
278         free( psz_artist_sanitized );
279     }
280     else
281     {
282         char * psz_title_sanitized = ArtCacheGetSanitizedFileName( psz_title );
283         snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
284                   "art" DIR_SEP "title" DIR_SEP "%s",
285                   p_obj->p_libvlc->psz_homedir,
286                   psz_title_sanitized );
287         free( psz_title_sanitized );
288     }
289 }
290
291
292
293 #define ArtCacheGetFilePath(a,b,c,d,e,f) __ArtCacheGetFilePath(VLC_OBJECT(a),b,c,d,e,f)
294 static void __ArtCacheGetFilePath( vlc_object_t *p_obj,
295                                    char * psz_filename,
296                                    const char *psz_title,
297                                    const char *psz_artist, const char *psz_album,
298                                    const char *psz_extension )
299 {
300     char psz_dir[MAX_PATH+1];
301     char * psz_ext;
302     ArtCacheGetDirPath( p_obj, psz_dir, psz_title, psz_artist, psz_album );
303
304     if( psz_extension )
305     {
306         psz_ext = strndup( psz_extension, 6 );
307         filename_sanitize( psz_ext );
308     }
309     else psz_ext = strdup( "" );
310
311     snprintf( psz_filename, MAX_PATH, "file://%s" DIR_SEP "art%s",
312               psz_dir, psz_ext );
313
314     free( psz_ext );
315 }
316
317 static int __input_FindArtInCache( vlc_object_t *p_obj, input_item_t *p_item )
318 {
319     char *psz_artist;
320     char *psz_album;
321     char *psz_title;
322     char psz_dirpath[MAX_PATH+1];
323     char psz_filepath[MAX_PATH+1];
324     char * psz_filename;
325     DIR * p_dir;
326
327     psz_artist = input_item_GetArtist( p_item );
328     psz_album = input_item_GetAlbum( p_item );
329     psz_title = input_item_GetTitle( p_item );
330     if( !psz_title ) psz_title = input_item_GetName( p_item );
331
332     if( !psz_title && ( !psz_album || !psz_artist ) )
333     {
334         free( psz_artist );
335         free( psz_album );
336         free( psz_title );
337         return VLC_EGENERIC;
338     }
339
340     ArtCacheGetDirPath( p_obj, psz_dirpath, psz_title,
341                            psz_artist, psz_album );
342
343     free( psz_artist );
344     free( psz_album );
345     free( psz_title );
346
347     /* Check if file exists */
348     p_dir = utf8_opendir( psz_dirpath );
349     if( !p_dir )
350         return VLC_EGENERIC;
351
352     while( (psz_filename = utf8_readdir( p_dir )) )
353     {
354         if( !strncmp( psz_filename, "art", 3 ) )
355         {
356             snprintf( psz_filepath, MAX_PATH, "file://%s" DIR_SEP "%s",
357                       psz_dirpath, psz_filename );
358             input_item_SetArtURL( p_item, psz_filepath );
359             free( psz_filename );
360             closedir( p_dir );
361             return VLC_SUCCESS;
362         }
363         free( psz_filename );
364     }
365
366     /* Not found */
367     closedir( p_dir );
368     return VLC_EGENERIC;
369 }
370
371 /**
372  * Download the art using the URL or an art downloaded
373  * This function should be called only if data is not already in cache
374  */
375 int input_DownloadAndCacheArt( playlist_t *p_playlist, input_item_t *p_item )
376 {
377     int i_status = VLC_EGENERIC;
378     stream_t *p_stream;
379     char psz_filename[MAX_PATH+1];
380     char *psz_artist = NULL;
381     char *psz_album = NULL;
382     char *psz_title = NULL;
383     char *psz_arturl;
384     char *psz_type;
385
386     psz_artist = input_item_GetArtist( p_item );
387     psz_album = input_item_GetAlbum( p_item );
388     psz_title = input_item_GetTitle( p_item );
389     if( !psz_title )
390         psz_title = input_item_GetName( p_item );
391
392     if( !psz_title && (!psz_artist || !psz_album) )
393     {
394         free( psz_title );
395         free( psz_album );
396         free( psz_artist );
397         return VLC_EGENERIC;
398     }
399
400     psz_arturl = input_item_GetArtURL( p_item );
401     assert( !EMPTY_STR( psz_arturl ) );
402
403     if( !strncmp( psz_arturl , "file://", 7 ) )
404     {
405         msg_Dbg( p_playlist, "Album art is local file, no need to cache" );
406         free( psz_arturl );
407         return VLC_SUCCESS;
408     }
409     else if( !strncmp( psz_arturl , "APIC", 4 ) )
410     {
411         msg_Warn( p_playlist, "APIC fetch not supported yet" );
412         free( psz_arturl );
413         return VLC_EGENERIC;
414     }
415
416     psz_type = strrchr( psz_arturl, '.' );
417     if( strlen( psz_type ) > 5 ) 
418         psz_type = NULL; /* remove extension if it's > to 4 characters */
419
420     /* Warning: psz_title, psz_artist, psz_album may change in ArtCache*() */
421
422     ArtCacheGetDirPath( p_playlist, psz_filename, psz_title, psz_artist,
423                         psz_album );
424     ArtCacheCreateDir( psz_filename );
425     ArtCacheGetFilePath( p_playlist, psz_filename, psz_title, psz_artist,
426                          psz_album, psz_type );
427
428     free( psz_artist );
429     free( psz_album );
430     free( psz_title );
431
432     p_stream = stream_UrlNew( p_playlist, psz_arturl );
433     if( p_stream )
434     {
435         uint8_t p_buffer[65536];
436         long int l_read;
437         FILE *p_file = utf8_fopen( psz_filename+7, "w" );
438         if( p_file == NULL ) {
439             msg_Err( p_playlist, "Unable write album art in %s" );
440             free( psz_arturl );
441             return VLC_EGENERIC;
442         }
443         int err = 0;
444         while( ( l_read = stream_Read( p_stream, p_buffer, sizeof (p_buffer) ) ) )
445         {
446             if( fwrite( p_buffer, l_read, 1, p_file ) != 1 )
447             {
448                 err = errno;
449                 break;
450             }
451         }
452         if( fclose( p_file ) && !err )
453             err = errno;
454         stream_Delete( p_stream );
455
456         if( err )
457             msg_Err( p_playlist, "%s: %s", psz_filename, strerror( err ) );
458         else
459             msg_Dbg( p_playlist, "album art saved to %s\n", psz_filename );
460
461         input_item_SetArtURL( p_item, psz_filename );
462         i_status = VLC_SUCCESS;
463     }
464     free( psz_arturl );
465     return i_status;
466 }
467
468 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input )
469 {
470     input_item_t *p_item = p_input->p->input.p_item;
471     char *psz_arturl;
472     char *psz_artist = NULL;
473     char *psz_album = NULL;
474     char *psz_title = NULL;
475     char *psz_type = NULL;
476     char psz_filename[MAX_PATH+1];
477     FILE *f;
478     input_attachment_t *p_attachment;
479     struct stat s;
480     int i_idx;
481
482     /* TODO-fenrir merge input_ArtFind with download and make it set the flags FETCH
483      * and then set it here to to be faster */
484
485     psz_arturl = input_item_GetArtURL( p_item );
486     if( !psz_arturl || strncmp( psz_arturl, "attachment://", strlen("attachment://") ) )
487     {
488         free( psz_arturl );
489         msg_Err( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
490         return;
491     }
492     input_item_SetArtURL( p_item, NULL );
493
494     if( input_item_IsArtFetched( p_item ) )
495     {
496         /* XXX Weird, we should not have end up with attachment:// art url unless there is a race
497          * condition */
498         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
499         input_FindArtInCache( p_input, p_item );
500         free( psz_arturl );
501         return;
502     }
503
504     /* */
505     for( i_idx = 0, p_attachment = NULL; i_idx < p_input->p->i_attachment; i_idx++ )
506     {
507         if( !strcmp( p_input->p->attachment[i_idx]->psz_name,
508                      &psz_arturl[strlen("attachment://")] ) )
509         {
510             p_attachment = p_input->p->attachment[i_idx];
511             break;
512         }
513     }
514     if( !p_attachment || p_attachment->i_data <= 0 )
515     {
516         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
517         goto end;
518     }
519
520     psz_artist = input_item_GetArtist( p_item );
521     psz_album = input_item_GetAlbum( p_item );
522     psz_title = input_item_GetTitle( p_item );
523     if( !psz_title )
524         psz_title = input_item_GetName( p_item );
525
526     if( (!psz_artist || !psz_album ) && !psz_title )
527         goto end;
528
529     /* */
530     psz_type = strrchr( psz_arturl, '.' );
531
532     ArtCacheGetDirPath( p_input, psz_filename, psz_title, psz_artist, psz_album );
533     ArtCacheCreateDir( psz_filename );
534     ArtCacheGetFilePath( p_input, psz_filename, psz_title, psz_artist, psz_album, psz_type );
535
536     /* Check if we already dumped it */
537     if( !utf8_stat( psz_filename+7, &s ) )
538         goto end;
539
540     f = utf8_fopen( psz_filename+7, "w" );
541     if( f )
542     {
543         if( fwrite( p_attachment->p_data, p_attachment->i_data, 1, f ) != 1 )
544             msg_Err( p_input, "%s: %s", psz_filename, strerror( errno ) );
545         else
546             msg_Dbg( p_input, "album art saved to %s\n", psz_filename );
547         fclose( f );
548     }
549
550 end:
551     if( psz_artist ) free( psz_artist );
552     if( psz_album ) free( psz_album );
553     if( psz_title ) free( psz_title );
554     if( psz_arturl ) free( psz_arturl );
555 }
556
557
558 uint32_t input_CurrentMetaFlags( vlc_meta_t *p_meta )
559 {
560     uint32_t i_meta = 0;
561
562     if( !p_meta )
563         return 0;
564
565 #define CHECK( a, b ) \
566     if( !EMPTY_STR( vlc_meta_Get( p_meta, vlc_meta_ ## a ) ) ) \
567         i_meta |= VLC_META_ENGINE_ ## b;
568
569     CHECK( Title, TITLE )
570     CHECK( Artist, ARTIST )
571     CHECK( Album, COLLECTION )
572 #if 0
573     /* As this is not used at the moment, don't uselessly check for it.
574      * Re-enable this when it is used */
575     CHECK( Genre, GENRE )
576     CHECK( Copyright, COPYRIGHT )
577     CHECK( Tracknum, SEQ_NUM )
578     CHECK( Description, DESCRIPTION )
579     CHECK( Rating, RATING )
580     CHECK( Date, DATE )
581     CHECK( URL, URL )
582     CHECK( Language, LANGUAGE )
583 #endif
584     CHECK( ArtworkURL, ART_URL )
585
586     return i_meta;
587 }