git.sesse.net Git - vlc/blob - 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     if( !p_item->p_meta )
 124         return VLC_EGENERIC;
 125
 126     psz_artist = input_item_GetArtist( p_item );
 127     psz_album = input_item_GetAlbum( p_item );
 128     psz_title = input_item_GetTitle( p_item );
 129     if(!psz_title)
 130         psz_title = input_item_GetName( p_item );
 131
 132     if( !psz_title && !psz_artist && !psz_album )
 133         return VLC_EGENERIC;
 134
 135     free( psz_title );
 136
 137     /* If we already checked this album in this session, skip */
 138     if( psz_artist && psz_album )
 139     {
 140         FOREACH_ARRAY( playlist_album_t album, p_playlist->p_fetcher->albums )
 141             if( !strcmp( album.psz_artist, psz_artist ) &&
 142                 !strcmp( album.psz_album, psz_album ) )
 143             {
 144                 msg_Dbg( p_playlist, " %s - %s has already been searched",
 145                          psz_artist, psz_album );
 146         /* TODO-fenrir if we cache art filename too, we can go faster */
 147                 free( psz_artist );
 148                 free( psz_album );
 149                 if( album.b_found )
 150                 {
 151                     /* Actually get URL from cache */
 152                     input_FindArtInCache( p_playlist, p_item );
 153                     return 0;
 154                 }
 155                 else
 156                 {
 157                     return VLC_EGENERIC;
 158                 }
 159             }
 160         FOREACH_END();
 161     }
 162     free( psz_artist );
 163     free( psz_album );
 164
 165     input_FindArtInCache( p_playlist, p_item );
 166
 167     char *psz_arturl = input_item_GetArtURL( p_item );
 168     if( !EMPTY_STR( psz_arturl ) )
 169     {
 170         free( psz_arturl );
 171         return 0; /* Art is in cache, no need to go further */
 172     }
 173     free( psz_arturl );
 174
 175     PL_LOCK;
 176     p_playlist->p_private = p_item;
 177     psz_album = input_item_GetAlbum( p_item );
 178     psz_artist = input_item_GetArtist( p_item );
 179     psz_title = input_item_GetTitle( p_item );
 180     if( !psz_title )
 181         psz_title = input_item_GetName( p_item );
 182
 183     if( psz_album && psz_artist )
 184     {
 185         msg_Dbg( p_playlist, "searching art for %s - %s",
 186              psz_artist, psz_album );
 187     }
 188     else
 189     {
 190         msg_Dbg( p_playlist, "searching art for %s",
 191              psz_title );
 192     }
 193     free( psz_title );
 194
 195     p_module = module_Need( p_playlist, "art finder", 0, VLC_FALSE );
 196
 197     if( p_module )
 198         i_ret = 1;
 199     else
 200         msg_Dbg( p_playlist, "unable to find art" );
 201
 202     /* Record this album */
 203     if( psz_artist && psz_album )
 204     {
 205         playlist_album_t a;
 206         a.psz_artist = psz_artist;
 207         a.psz_album = psz_album;
 208         a.b_found = (i_ret == VLC_EGENERIC ? VLC_FALSE : VLC_TRUE );
 209         ARRAY_APPEND( p_playlist->p_fetcher->albums, a );
 210     }
 211     else
 212     {
 213         free( psz_artist );
 214         free( psz_album );
 215     }
 216
 217     if( p_module )
 218         module_Unneed( p_playlist, p_module );
 219     p_playlist->p_private = NULL;
 220     PL_UNLOCK;
 221
 222     return i_ret;
 223 }
 224
 225 #ifndef MAX_PATH
 226 #   define MAX_PATH 250
 227 #endif
 228 static void ArtCacheCreateDir( const char *psz_dir )
 229 {
 230     char newdir[MAX_PATH+1];
 231     strcpy( newdir, psz_dir );
 232     char * psz_newdir = newdir;
 233     char * psz = psz_newdir;
 234
 235     while( *psz_newdir )
 236     {
 237         while( *psz && *psz != '/') psz++;
 238         if( !*psz ) break;
 239         *psz = 0;
 240         if( !EMPTY_STR( psz_newdir ) ) utf8_mkdir( psz_newdir );
 241         *psz = '/';
 242         psz_newdir = psz+1;
 243     }
 244 }
 245
 246 static char * ArtCacheGetSanitizedFileName( const char *psz )
 247 {
 248     char *dup = strdup(psz);
 249     int i;
 250
 251     filename_sanitize( dup );
 252
 253     /* Doesn't create a filename with invalid characters
 254      * TODO: several filesystems forbid several characters: list them all
 255      */
 256     for( i = 0; dup[i] != '\0'; i++ )
 257     {
 258         if( dup[i] == '/' )
 259             dup[i] = ' ';
 260     }
 261     return dup;
 262 }
 263
 264 #define ArtCacheGetDirPath(a,b,c,d,e) __ArtCacheGetDirPath(VLC_OBJECT(a),b,c,d,e)
 265 static void __ArtCacheGetDirPath( vlc_object_t *p_obj,
 266                                   char *psz_dir,
 267                                   const char *psz_title,
 268                                   const char *psz_artist, const char *psz_album )
 269 {
 270     if( !EMPTY_STR(psz_artist) && !EMPTY_STR(psz_album) )
 271     {
 272         char * psz_album_sanitized = ArtCacheGetSanitizedFileName( psz_album );
 273         char * psz_artist_sanitized = ArtCacheGetSanitizedFileName( psz_artist );
 274
 275         snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
 276                   "art" DIR_SEP "artistalbum" DIR_SEP "%s" DIR_SEP "%s",
 277                       p_obj->p_libvlc->psz_homedir,
 278                       psz_artist_sanitized, psz_album_sanitized );
 279         free( psz_album_sanitized );
 280         free( psz_artist_sanitized );
 281     }
 282     else
 283     {
 284         char * psz_title_sanitized = ArtCacheGetSanitizedFileName( psz_title );
 285         snprintf( psz_dir, MAX_PATH, "%s" DIR_SEP CONFIG_DIR DIR_SEP
 286                   "art" DIR_SEP "title" DIR_SEP "%s",
 287                   p_obj->p_libvlc->psz_homedir,
 288                   psz_title_sanitized );
 289         free( psz_title_sanitized );
 290     }
 291 }
 292
 293
 294
 295 #define ArtCacheGetFilePath(a,b,c,d,e,f) __ArtCacheGetFilePath(VLC_OBJECT(a),b,c,d,e,f)
 296 static void __ArtCacheGetFilePath( vlc_object_t *p_obj,
 297                                    char * psz_filename,
 298                                    const char *psz_title,
 299                                    const char *psz_artist, const char *psz_album,
 300                                    const char *psz_extension )
 301 {
 302     char psz_dir[MAX_PATH+1];
 303     char * psz_ext;
 304     ArtCacheGetDirPath( p_obj, psz_dir, psz_title, psz_artist, psz_album );
 305
 306     if( psz_extension )
 307     {
 308         psz_ext = strndup( psz_extension, 6 );
 309         filename_sanitize( psz_ext );
 310     }
 311     else psz_ext = strdup( "" );
 312
 313     snprintf( psz_filename, MAX_PATH, "file://%s" DIR_SEP "art%s",
 314               psz_dir, psz_ext );
 315
 316     free( psz_ext );
 317 }
 318
 319 static int __input_FindArtInCache( vlc_object_t *p_obj, input_item_t *p_item )
 320 {
 321     char *psz_artist;
 322     char *psz_album;
 323     char *psz_title;
 324     char psz_dirpath[MAX_PATH+1];
 325     char psz_filepath[MAX_PATH+1];
 326     char * psz_filename;
 327     DIR * p_dir;
 328
 329     psz_artist = input_item_GetArtist( p_item );
 330     psz_album = input_item_GetAlbum( p_item );
 331     psz_title = input_item_GetTitle( p_item );
 332     if( !psz_title ) psz_title = input_item_GetName( p_item );
 333
 334     if( !psz_title && ( !psz_album || !psz_artist ) )
 335     {
 336         free( psz_artist );
 337         free( psz_album );
 338         free( psz_title );
 339         return VLC_EGENERIC;
 340     }
 341
 342     ArtCacheGetDirPath( p_obj, psz_dirpath, psz_title,
 343                            psz_artist, psz_album );
 344
 345     free( psz_artist );
 346     free( psz_album );
 347     free( psz_title );
 348
 349     /* Check if file exists */
 350     p_dir = utf8_opendir( psz_dirpath );
 351     if( !p_dir )
 352         return VLC_EGENERIC;
 353
 354     while( (psz_filename = utf8_readdir( p_dir )) )
 355     {
 356         if( !strncmp( psz_filename, "art", 3 ) )
 357         {
 358             snprintf( psz_filepath, MAX_PATH, "%s" DIR_SEP "%s",
 359                       psz_dirpath, psz_filename );
 360             input_item_SetArtURL( p_item, psz_filepath );
 361             free( psz_filepath );
 362             free( psz_filename );
 363             closedir( p_dir );
 364             return VLC_SUCCESS;
 365         }
 366         free( psz_filename );
 367     }
 368
 369     /* Not found */
 370     closedir( p_dir );
 371     return VLC_EGENERIC;
 372 }
 373
 374 /**
 375  * Download the art using the URL or an art downloaded
 376  * This function should be called only if data is not already in cache
 377  */
 378 int input_DownloadAndCacheArt( playlist_t *p_playlist, input_item_t *p_item )
 379 {
 380     int i_status = VLC_EGENERIC;
 381     stream_t *p_stream;
 382     char psz_filename[MAX_PATH+1];
 383     char *psz_artist = NULL;
 384     char *psz_album = NULL;
 385     char *psz_title = NULL;
 386     char *psz_arturl;
 387     char *psz_type;
 388
 389     psz_artist = input_item_GetArtist( p_item );
 390     psz_album = input_item_GetAlbum( p_item );
 391     psz_title = input_item_GetTitle( p_item );
 392     if( !psz_title )
 393         psz_title = input_item_GetName( p_item );
 394
 395     if( !psz_title && (!psz_artist || !psz_album) )
 396     {
 397         free( psz_title );
 398         free( psz_album );
 399         free( psz_artist );
 400         return VLC_EGENERIC;
 401     }
 402
 403     psz_arturl = input_item_GetArtURL( p_item );
 404     assert( !EMPTY_STR( psz_arturl ) );
 405
 406     if( !strncmp( psz_arturl , "APIC", 4 ) )
 407     {
 408         msg_Warn( p_playlist, "APIC fetch not supported yet" );
 409         free( psz_arturl );
 410         return VLC_EGENERIC;
 411     }
 412
 413     psz_type = strrchr( psz_arturl, '.' );
 414     if( strlen( psz_type ) > 5 )
 415         psz_type = NULL; /* remove extension if it's > to 4 characters */
 416
 417     /* Warning: psz_title, psz_artist, psz_album may change in ArtCache*() */
 418
 419     ArtCacheGetDirPath( p_playlist, psz_filename, psz_title, psz_artist,
 420                         psz_album );
 421     ArtCacheCreateDir( psz_filename );
 422     ArtCacheGetFilePath( p_playlist, psz_filename, psz_title, psz_artist,
 423                          psz_album, psz_type );
 424
 425     free( psz_artist );
 426     free( psz_album );
 427     free( psz_title );
 428
 429     p_stream = stream_UrlNew( p_playlist, psz_arturl );
 430     if( p_stream )
 431     {
 432         uint8_t p_buffer[65536];
 433         long int l_read;
 434         FILE *p_file = utf8_fopen( psz_filename+7, "w" );
 435         if( p_file == NULL ) {
 436             msg_Err( p_playlist, "Unable write album art in %s" );
 437             free( psz_arturl );
 438             return VLC_EGENERIC;
 439         }
 440         int err = 0;
 441         while( ( l_read = stream_Read( p_stream, p_buffer, sizeof (p_buffer) ) ) )
 442         {
 443             if( fwrite( p_buffer, l_read, 1, p_file ) != 1 )
 444             {
 445                 err = errno;
 446                 break;
 447             }
 448         }
 449         if( fclose( p_file ) && !err )
 450             err = errno;
 451         stream_Delete( p_stream );
 452
 453         if( err )
 454             msg_Err( p_playlist, "%s: %s", psz_filename, strerror( err ) );
 455         else
 456             msg_Dbg( p_playlist, "album art saved to %s\n", psz_filename );
 457
 458         input_item_SetArtURL( p_item, psz_filename );
 459         i_status = VLC_SUCCESS;
 460     }
 461     free( psz_arturl );
 462     return i_status;
 463 }
 464
 465 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input )
 466 {
 467     input_item_t *p_item = p_input->p->input.p_item;
 468     char *psz_arturl;
 469     char *psz_artist = NULL;
 470     char *psz_album = NULL;
 471     char *psz_title = NULL;
 472     char *psz_type = NULL;
 473     char psz_filename[MAX_PATH+1];
 474     FILE *f;
 475     input_attachment_t *p_attachment;
 476     struct stat s;
 477     int i_idx;
 478
 479     /* TODO-fenrir merge input_ArtFind with download and make it set the flags FETCH
 480      * and then set it here to to be faster */
 481
 482     psz_arturl = input_item_GetArtURL( p_item );
 483     if( !psz_arturl || strncmp( psz_arturl, "attachment://", strlen("attachment://") ) )
 484     {
 485         free( psz_arturl );
 486         msg_Err( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 487         return;
 488     }
 489     input_item_SetArtURL( p_item, NULL );
 490
 491     if( input_item_IsArtFetched( p_item ) )
 492     {
 493         /* XXX Weird, we should not have end up with attachment:// art url unless there is a race
 494          * condition */
 495         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 496         input_FindArtInCache( p_input, p_item );
 497         free( psz_arturl );
 498         return;
 499     }
 500
 501     /* */
 502     for( i_idx = 0, p_attachment = NULL; i_idx < p_input->p->i_attachment; i_idx++ )
 503     {
 504         if( !strcmp( p_input->p->attachment[i_idx]->psz_name,
 505                      &psz_arturl[strlen("attachment://")] ) )
 506         {
 507             p_attachment = p_input->p->attachment[i_idx];
 508             break;
 509         }
 510     }
 511     if( !p_attachment || p_attachment->i_data <= 0 )
 512     {
 513         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 514         goto end;
 515     }
 516
 517     psz_artist = input_item_GetArtist( p_item );
 518     psz_album = input_item_GetAlbum( p_item );
 519     psz_title = input_item_GetTitle( p_item );
 520     if( !psz_title )
 521         psz_title = input_item_GetName( p_item );
 522
 523     if( (!psz_artist || !psz_album ) && !psz_title )
 524         goto end;
 525
 526     /* */
 527     psz_type = strrchr( psz_arturl, '.' );
 528
 529     ArtCacheGetDirPath( p_input, psz_filename, psz_title, psz_artist, psz_album );
 530     ArtCacheCreateDir( psz_filename );
 531     ArtCacheGetFilePath( p_input, psz_filename, psz_title, psz_artist, psz_album, psz_type );
 532
 533     /* Check if we already dumped it */
 534     if( !utf8_stat( psz_filename+7, &s ) )
 535         goto end;
 536
 537     f = utf8_fopen( psz_filename+7, "w" );
 538     if( f )
 539     {
 540         if( fwrite( p_attachment->p_data, p_attachment->i_data, 1, f ) != 1 )
 541             msg_Err( p_input, "%s: %s", psz_filename, strerror( errno ) );
 542         else
 543             msg_Dbg( p_input, "album art saved to %s\n", psz_filename );
 544         fclose( f );
 545     }
 546
 547 end:
 548     if( psz_artist ) free( psz_artist );
 549     if( psz_album ) free( psz_album );
 550     if( psz_title ) free( psz_title );
 551     if( psz_arturl ) free( psz_arturl );
 552 }
 553
 554
 555 uint32_t input_CurrentMetaFlags( vlc_meta_t *p_meta )
 556 {
 557     uint32_t i_meta = 0;
 558
 559     if( !p_meta )
 560         return 0;
 561
 562 #define CHECK( a, b ) \
 563     if( !EMPTY_STR( vlc_meta_Get( p_meta, vlc_meta_ ## a ) ) ) \
 564         i_meta |= VLC_META_ENGINE_ ## b;
 565
 566     CHECK( Title, TITLE )
 567     CHECK( Artist, ARTIST )
 568     CHECK( Album, COLLECTION )
 569 #if 0
 570     /* As this is not used at the moment, don't uselessly check for it.
 571      * Re-enable this when it is used */
 572     CHECK( Genre, GENRE )
 573     CHECK( Copyright, COPYRIGHT )
 574     CHECK( Tracknum, SEQ_NUM )
 575     CHECK( Description, DESCRIPTION )
 576     CHECK( Rating, RATING )
 577     CHECK( Date, DATE )
 578     CHECK( URL, URL )
 579     CHECK( Language, LANGUAGE )
 580 #endif
 581     CHECK( ArtworkURL, ART_URL )
 582
 583     return i_meta;
 584 }