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