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 static void ArtCacheCreateDir( const char *psz_dir )
 226 {
 227     char newdir[strlen( psz_dir ) + 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 ) )
 238             utf8_mkdir( psz_newdir, 0700 );
 239         *psz = DIR_SEP_CHAR;
 240         psz++;
 241     }
 242     utf8_mkdir( psz_dir, 0700 );
 243 }
 244
 245 static char * ArtCacheGetSanitizedFileName( const char *psz )
 246 {
 247     char *dup = strdup(psz);
 248     int i;
 249
 250     filename_sanitize( dup );
 251
 252     /* Doesn't create a filename with invalid characters
 253      * TODO: several filesystems forbid several characters: list them all
 254      */
 255     for( i = 0; dup[i] != '\0'; i++ )
 256     {
 257         if( dup[i] == DIR_SEP_CHAR )
 258             dup[i] = ' ';
 259     }
 260     return dup;
 261 }
 262
 263 #define ArtCacheGetDirPath(a,b,c,d,e) __ArtCacheGetDirPath(VLC_OBJECT(a),b,c,d,e)
 264 static void __ArtCacheGetDirPath( vlc_object_t *p_obj,
 265                                   char *psz_dir,
 266                                   const char *psz_title,
 267                                   const char *psz_artist, const char *psz_album )
 268 {
 269     if( !EMPTY_STR(psz_artist) && !EMPTY_STR(psz_album) )
 270     {
 271         char * psz_album_sanitized = ArtCacheGetSanitizedFileName( psz_album );
 272         char * psz_artist_sanitized = ArtCacheGetSanitizedFileName( psz_artist );
 273
 274         snprintf( psz_dir, PATH_MAX, "%s" DIR_SEP
 275                   "art" DIR_SEP "artistalbum" DIR_SEP "%s" DIR_SEP "%s",
 276                       p_obj->p_libvlc->psz_cachedir,
 277                       psz_artist_sanitized, psz_album_sanitized );
 278         free( psz_album_sanitized );
 279         free( psz_artist_sanitized );
 280     }
 281     else
 282     {
 283         char * psz_title_sanitized = ArtCacheGetSanitizedFileName( psz_title );
 284         snprintf( psz_dir, PATH_MAX, "%s" DIR_SEP
 285                   "art" DIR_SEP "title" DIR_SEP "%s",
 286                   p_obj->p_libvlc->psz_cachedir,
 287                   psz_title_sanitized );
 288         free( psz_title_sanitized );
 289     }
 290 }
 291
 292
 293
 294 #define ArtCacheGetFilePath(a,b,c,d,e,f) __ArtCacheGetFilePath(VLC_OBJECT(a),b,c,d,e,f)
 295 static void __ArtCacheGetFilePath( vlc_object_t *p_obj,
 296                                    char * psz_filename,
 297                                    const char *psz_title,
 298                                    const char *psz_artist, const char *psz_album,
 299                                    const char *psz_extension )
 300 {
 301     char psz_dir[PATH_MAX+1];
 302     char * psz_ext;
 303     ArtCacheGetDirPath( p_obj, psz_dir, psz_title, psz_artist, psz_album );
 304
 305     if( psz_extension )
 306     {
 307         psz_ext = strndup( psz_extension, 6 );
 308         filename_sanitize( psz_ext );
 309     }
 310     else psz_ext = strdup( "" );
 311
 312     snprintf( psz_filename, PATH_MAX, "file://%s" DIR_SEP "art%s",
 313               psz_dir, psz_ext );
 314
 315     free( psz_ext );
 316 }
 317
 318 static int __input_FindArtInCache( vlc_object_t *p_obj, input_item_t *p_item )
 319 {
 320     char *psz_artist;
 321     char *psz_album;
 322     char *psz_title;
 323     char psz_dirpath[PATH_MAX+1];
 324     char psz_filepath[PATH_MAX+1];
 325     char * psz_filename;
 326     DIR * p_dir;
 327
 328     psz_artist = input_item_GetArtist( p_item );
 329     psz_album = input_item_GetAlbum( p_item );
 330     psz_title = input_item_GetTitle( p_item );
 331     if( !psz_title ) psz_title = input_item_GetName( p_item );
 332
 333     if( !psz_title && ( !psz_album || !psz_artist ) )
 334     {
 335         free( psz_artist );
 336         free( psz_album );
 337         free( psz_title );
 338         return VLC_EGENERIC;
 339     }
 340
 341     ArtCacheGetDirPath( p_obj, psz_dirpath, psz_title,
 342                            psz_artist, psz_album );
 343
 344     free( psz_artist );
 345     free( psz_album );
 346     free( psz_title );
 347
 348     /* Check if file exists */
 349     p_dir = utf8_opendir( psz_dirpath );
 350     if( !p_dir )
 351         return VLC_EGENERIC;
 352
 353     while( (psz_filename = utf8_readdir( p_dir )) )
 354     {
 355         if( !strncmp( psz_filename, "art", 3 ) )
 356         {
 357             snprintf( psz_filepath, PATH_MAX, "file://%s" DIR_SEP "%s",
 358                       psz_dirpath, psz_filename );
 359             input_item_SetArtURL( p_item, psz_filepath );
 360             free( psz_filename );
 361             closedir( p_dir );
 362             return VLC_SUCCESS;
 363         }
 364         free( psz_filename );
 365     }
 366
 367     /* Not found */
 368     closedir( p_dir );
 369     return VLC_EGENERIC;
 370 }
 371
 372 /**
 373  * Download the art using the URL or an art downloaded
 374  * This function should be called only if data is not already in cache
 375  */
 376 int input_DownloadAndCacheArt( playlist_t *p_playlist, input_item_t *p_item )
 377 {
 378     int i_status = VLC_EGENERIC;
 379     stream_t *p_stream;
 380     char psz_filename[PATH_MAX+1];
 381     char *psz_artist = NULL;
 382     char *psz_album = NULL;
 383     char *psz_title = NULL;
 384     char *psz_arturl;
 385     char *psz_type;
 386
 387     psz_artist = input_item_GetArtist( p_item );
 388     psz_album = input_item_GetAlbum( p_item );
 389     psz_title = input_item_GetTitle( p_item );
 390     if( !psz_title )
 391         psz_title = input_item_GetName( p_item );
 392
 393     if( !psz_title && (!psz_artist || !psz_album) )
 394     {
 395         free( psz_title );
 396         free( psz_album );
 397         free( psz_artist );
 398         return VLC_EGENERIC;
 399     }
 400
 401     psz_arturl = input_item_GetArtURL( p_item );
 402     assert( !EMPTY_STR( psz_arturl ) );
 403
 404     if( !strncmp( psz_arturl , "file://", 7 ) )
 405     {
 406         msg_Dbg( p_playlist, "Album art is local file, no need to cache" );
 407         free( psz_arturl );
 408         return VLC_SUCCESS;
 409     }
 410     else if( !strncmp( psz_arturl , "APIC", 4 ) )
 411     {
 412         msg_Warn( p_playlist, "APIC fetch not supported yet" );
 413         free( psz_arturl );
 414         return VLC_EGENERIC;
 415     }
 416
 417     psz_type = strrchr( psz_arturl, '.' );
 418     if( strlen( psz_type ) > 5 )
 419         psz_type = NULL; /* remove extension if it's > to 4 characters */
 420
 421     /* Warning: psz_title, psz_artist, psz_album may change in ArtCache*() */
 422
 423     ArtCacheGetDirPath( p_playlist, psz_filename, psz_title, psz_artist,
 424                         psz_album );
 425     ArtCacheCreateDir( psz_filename );
 426     ArtCacheGetFilePath( p_playlist, psz_filename, psz_title, psz_artist,
 427                          psz_album, psz_type );
 428
 429     free( psz_artist );
 430     free( psz_album );
 431     free( psz_title );
 432
 433     p_stream = stream_UrlNew( p_playlist, psz_arturl );
 434     if( p_stream )
 435     {
 436         uint8_t p_buffer[65536];
 437         long int l_read;
 438         FILE *p_file = utf8_fopen( psz_filename+7, "w" );
 439         if( p_file == NULL ) {
 440             msg_Err( p_playlist, "Unable write album art in %s",
 441                      psz_filename + 7 );
 442             free( psz_arturl );
 443             return VLC_EGENERIC;
 444         }
 445         int err = 0;
 446         while( ( l_read = stream_Read( p_stream, p_buffer, sizeof (p_buffer) ) ) )
 447         {
 448             if( fwrite( p_buffer, l_read, 1, p_file ) != 1 )
 449             {
 450                 err = errno;
 451                 break;
 452             }
 453         }
 454         if( fclose( p_file ) && !err )
 455             err = errno;
 456         stream_Delete( p_stream );
 457
 458         if( err )
 459         {
 460             errno = err;
 461             msg_Err( p_playlist, "%s: %m", psz_filename );
 462         }
 463         else
 464             msg_Dbg( p_playlist, "album art saved to %s\n", psz_filename );
 465
 466         input_item_SetArtURL( p_item, psz_filename );
 467         i_status = VLC_SUCCESS;
 468     }
 469     free( psz_arturl );
 470     return i_status;
 471 }
 472
 473 void input_ExtractAttachmentAndCacheArt( input_thread_t *p_input )
 474 {
 475     input_item_t *p_item = p_input->p->input.p_item;
 476     char *psz_arturl;
 477     char *psz_artist = NULL;
 478     char *psz_album = NULL;
 479     char *psz_title = NULL;
 480     char *psz_type = NULL;
 481     char psz_filename[PATH_MAX+1];
 482     FILE *f;
 483     input_attachment_t *p_attachment;
 484     struct stat s;
 485     int i_idx;
 486
 487     /* TODO-fenrir merge input_ArtFind with download and make it set the flags FETCH
 488      * and then set it here to to be faster */
 489
 490     psz_arturl = input_item_GetArtURL( p_item );
 491     if( !psz_arturl || strncmp( psz_arturl, "attachment://", strlen("attachment://") ) )
 492     {
 493         free( psz_arturl );
 494         msg_Err( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 495         return;
 496     }
 497     input_item_SetArtURL( p_item, NULL );
 498
 499     if( input_item_IsArtFetched( p_item ) )
 500     {
 501         /* XXX Weird, we should not have end up with attachment:// art url unless there is a race
 502          * condition */
 503         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 504         input_FindArtInCache( p_input, p_item );
 505         free( psz_arturl );
 506         return;
 507     }
 508
 509     /* */
 510     for( i_idx = 0, p_attachment = NULL; i_idx < p_input->p->i_attachment; i_idx++ )
 511     {
 512         if( !strcmp( p_input->p->attachment[i_idx]->psz_name,
 513                      &psz_arturl[strlen("attachment://")] ) )
 514         {
 515             p_attachment = p_input->p->attachment[i_idx];
 516             break;
 517         }
 518     }
 519     if( !p_attachment || p_attachment->i_data <= 0 )
 520     {
 521         msg_Warn( p_input, "internal input error with input_ExtractAttachmentAndCacheArt" );
 522         goto end;
 523     }
 524
 525     psz_artist = input_item_GetArtist( p_item );
 526     psz_album = input_item_GetAlbum( p_item );
 527     psz_title = input_item_GetTitle( p_item );
 528     if( !psz_title )
 529         psz_title = input_item_GetName( p_item );
 530
 531     if( (!psz_artist || !psz_album ) && !psz_title )
 532         goto end;
 533
 534     /* */
 535     psz_type = strrchr( psz_arturl, '.' );
 536
 537     ArtCacheGetDirPath( p_input, psz_filename, psz_title, psz_artist, psz_album );
 538     ArtCacheCreateDir( psz_filename );
 539     ArtCacheGetFilePath( p_input, psz_filename, psz_title, psz_artist, psz_album, psz_type );
 540
 541     /* Check if we already dumped it */
 542     if( !utf8_stat( psz_filename+7, &s ) )
 543         goto end;
 544
 545     f = utf8_fopen( psz_filename+7, "w" );
 546     if( f )
 547     {
 548         if( fwrite( p_attachment->p_data, p_attachment->i_data, 1, f ) != 1 )
 549             msg_Err( p_input, "%s: %m", psz_filename );
 550         else
 551             msg_Dbg( p_input, "album art saved to %s\n", psz_filename );
 552         fclose( f );
 553     }
 554
 555 end:
 556     if( psz_artist ) free( psz_artist );
 557     if( psz_album ) free( psz_album );
 558     if( psz_title ) free( psz_title );
 559     if( psz_arturl ) free( psz_arturl );
 560 }
 561
 562
 563 uint32_t input_CurrentMetaFlags( vlc_meta_t *p_meta )
 564 {
 565     uint32_t i_meta = 0;
 566
 567     if( !p_meta )
 568         return 0;
 569
 570 #define CHECK( a, b ) \
 571     if( !EMPTY_STR( vlc_meta_Get( p_meta, vlc_meta_ ## a ) ) ) \
 572         i_meta |= VLC_META_ENGINE_ ## b;
 573
 574     CHECK( Title, TITLE )
 575     CHECK( Artist, ARTIST )
 576     CHECK( Album, COLLECTION )
 577 #if 0
 578     /* As this is not used at the moment, don't uselessly check for it.
 579      * Re-enable this when it is used */
 580     CHECK( Genre, GENRE )
 581     CHECK( Copyright, COPYRIGHT )
 582     CHECK( Tracknum, SEQ_NUM )
 583     CHECK( Description, DESCRIPTION )
 584     CHECK( Rating, RATING )
 585     CHECK( Date, DATE )
 586     CHECK( URL, URL )
 587     CHECK( Language, LANGUAGE )
 588 #endif
 589     CHECK( ArtworkURL, ART_URL )
 590
 591     return i_meta;
 592 }