]> git.sesse.net Git - vlc/blobdiff - modules/meta_engine/taglib.cpp
taglib: Fix opening of filenames on non-UTF8 systems.
[vlc] / modules / meta_engine / taglib.cpp
index fe92d411eeb6bf57d97e6ddaec498e6980feef10..1845f6f91afb2ae7ef1d87ad2540c6b4ac7475ac 100644 (file)
  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#include <vlc/vlc.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <vlc_common.h>
+#include <vlc_plugin.h>
 #include <vlc_playlist.h>
 #include <vlc_meta.h>
 #include <vlc_demux.h>
+#include <vlc_strings.h>
+#include <vlc_charset.h>
+
+#ifdef WIN32
+# include <io.h>
+#else
+# include <unistd.h>
+#endif
 
 #include <fileref.h>
 #include <tag.h>
 #include <tbytevector.h>
 #include <mpegfile.h>
 #include <flacfile.h>
-#if 0
-#include <oggflacfile.h>
-#endif
+#include <attachedpictureframe.h>
+//#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
 #include <flacfile.h>
 #include <flacproperties.h>
 #include <vorbisfile.h>
 #include <vorbisproperties.h>
+#include <xiphcomment.h>
 #include <uniquefileidentifierframe.h>
 #include <textidentificationframe.h>
-#if 0 /* parse the tags without taglib helpers? */
-#include <relativevolumeframe.h>
-#endif
+//#include <relativevolumeframe.h> /* parse the tags without TagLib helpers? */
 
 static int  ReadMeta    ( vlc_object_t * );
 static int  DownloadArt ( vlc_object_t * );
@@ -63,34 +74,166 @@ vlc_module_begin();
         set_callbacks( WriteMeta, NULL );
 vlc_module_end();
 
-static bool checkID3Image( const TagLib::ID3v2::Tag *p_tag )
-{
-    TagLib::ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
-    return !l.isEmpty();
-}
+using namespace TagLib;
 
 /* Try detecting embedded art */
-static void DetectImage( TagLib::FileRef f, vlc_meta_t *p_meta )
+static void DetectImage( FileRef f, demux_t *p_demux )
 {
-    if( TagLib::MPEG::File *mpeg =
-               dynamic_cast<TagLib::MPEG::File *>(f.file() ) )
+    demux_meta_t        *p_demux_meta   = (demux_meta_t *)p_demux->p_private;
+    vlc_meta_t          *p_meta         = p_demux_meta->p_meta;
+    int                 i_score         = -1;
+
+    /* Preferred type of image
+     * The 21 types are defined in id3v2 standard:
+     * http://www.id3.org/id3v2.4.0-frames */
+    static const int pi_cover_score[] = {
+        0,  /* Other */
+        5,  /* 32x32 PNG image that should be used as the file icon */
+        4,  /* File icon of a different size or format. */
+        20, /* Front cover image of the album. */
+        19, /* Back cover image of the album. */
+        13, /* Inside leaflet page of the album. */
+        18, /* Image from the album itself. */
+        17, /* Picture of the lead artist or soloist. */
+        16, /* Picture of the artist or performer. */
+        14, /* Picture of the conductor. */
+        15, /* Picture of the band or orchestra. */
+        9,  /* Picture of the composer. */
+        8,  /* Picture of the lyricist or text writer. */
+        7,  /* Picture of the recording location or studio. */
+        10, /* Picture of the artists during recording. */
+        11, /* Picture of the artists during performance. */
+        6,  /* Picture from a movie or video related to the track. */
+        1,  /* Picture of a large, coloured fish. */
+        12, /* Illustration related to the track. */
+        3,  /* Logo of the band or performer. */
+        2   /* Logo of the publisher (record company). */
+    };
+
+    if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
     {
-        if( mpeg->ID3v2Tag() && checkID3Image( mpeg->ID3v2Tag() ) )
-            vlc_meta_SetArtURL( p_meta, "APIC" );
+        ID3v2::Tag  *p_tag = mpeg->ID3v2Tag();
+        if( !p_tag )
+            return;
+        ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
+        if( list.isEmpty() )
+            return;
+        ID3v2::AttachedPictureFrame *p_apic;
+
+        TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
+        for( ID3v2::FrameList::Iterator iter = list.begin();
+                iter != list.end(); iter++ )
+        {
+            p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
+            input_attachment_t *p_attachment;
+
+            const char *psz_name, *psz_mime, *psz_description;
+            ByteVector p_data_taglib; const char *p_data; int i_data;
+
+            psz_mime = p_apic->mimeType().toCString(true);
+            psz_description = psz_name = p_apic->description().toCString(true);
+
+            /* some old iTunes version not only sets incorrectly the mime type
+             * or the description of the image,
+             * but also embeds incorrectly the image.
+             * Recent versions seem to behave correctly */
+            if( !strncmp( psz_mime, "PNG", 3 ) ||
+                !strncmp( psz_name, "\xC2\x89PNG", 5 ) )
+            {
+                msg_Warn( p_demux,
+                    "%s: Invalid picture embedded by broken iTunes version, "
+                    "you really shouldn't use this crappy software.",
+                    (const char *)f.file()->name() );
+                break;
+            }
+
+            p_data_taglib = p_apic->picture();
+            p_data = p_data_taglib.data();
+            i_data = p_data_taglib.size();
+
+            msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
+                    psz_name, psz_mime, i_data );
+
+            p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
+                    psz_description, p_data, i_data );
+            TAB_APPEND_CAST( (input_attachment_t**),
+                    p_demux_meta->i_attachments, p_demux_meta->attachments,
+                    p_attachment );
+
+            if( pi_cover_score[p_apic->type()] > i_score )
+            {
+                i_score = pi_cover_score[p_apic->type()];
+                char *psz_url;
+                if( asprintf( &psz_url, "attachment://%s",
+                        p_attachment->psz_name ) == -1 )
+                    return;
+                vlc_meta_SetArtURL( p_meta, psz_url );
+                free( psz_url );
+            }
+        }
+    }
+    else
+    if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
+    {
+        Ogg::XiphComment *p_tag = oggv->tag();
+        if( !p_tag )
+            return;
+
+        StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
+        StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
+
+        /* we support only one cover in ogg/vorbis */
+        if( mime_list.size() != 1 || art_list.size() != 1 )
+            return;
+
+        input_attachment_t *p_attachment;
+
+        const char *psz_name, *psz_mime, *psz_description;
+        uint8_t *p_data;
+        int i_data;
+
+        psz_name = "cover";
+        psz_mime = mime_list[0].toCString(true);
+        psz_description = "cover";
+
+        i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
+
+        msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
+                    psz_name, psz_mime, i_data );
+
+        TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
+        p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
+                psz_description, p_data, i_data );
+        free( p_data );
+
+        TAB_APPEND_CAST( (input_attachment_t**),
+                p_demux_meta->i_attachments, p_demux_meta->attachments,
+                p_attachment );
+
+        vlc_meta_SetArtURL( p_meta, "attachment://cover" );
     }
-    else if( TagLib::FLAC::File *flac =
-             dynamic_cast<TagLib::FLAC::File *>(f.file() ) )
+
+#if 0
+    //flac embedded images are extracted in the flac demuxer
+    else if( FLAC::File *flac =
+             dynamic_cast<FLAC::File *>(f.file() ) )
     {
-        if( flac->ID3v2Tag() && checkID3Image( flac->ID3v2Tag() ) )
+        p_tag = flac->ID3v2Tag();
+        if( p_tag )
+            return;
+        ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
+        if( l.isEmpty() )
+            return;
             vlc_meta_SetArtURL( p_meta, "APIC" );
     }
+#endif
 #if 0
-/* This needs special additions to taglib */
* else if( TagLib::MP4::File *mp4 =
-               dynamic_cast<TagLib::MP4::File *>( f.file() ) )
+/* TagLib doesn't support MP4 file yet */
   else if( MP4::File *mp4 =
+               dynamic_cast<MP4::File *>( f.file() ) )
     {
-        TagLib::MP4::Tag *mp4tag =
-                dynamic_cast<TagLib::MP4::Tag *>( mp4->tag() );
+        MP4::Tag *mp4tag =
+                dynamic_cast<MP4::Tag *>( mp4->tag() );
         if( mp4tag && mp4tag->cover().size() )
             vlc_meta_SetArtURL( p_meta, "MP4C" );
     }
@@ -99,40 +242,63 @@ static void DetectImage( TagLib::FileRef f, vlc_meta_t *p_meta )
 
 static int ReadMeta( vlc_object_t *p_this )
 {
-    demux_t *p_demux = (demux_t *)p_this;
+    demux_t         *p_demux = (demux_t *)p_this;
+    demux_meta_t    *p_demux_meta = (demux_meta_t*)p_demux->p_private;
+    vlc_meta_t      *p_meta;
+
+    TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
+    p_demux_meta->p_meta = NULL;
+
+#if defined(WIN32) || defined (UNDER_CE)
+    if(GetVersion() < 0x80000000)
+    {
+        wchar_t wpath[MAX_PATH + 1];
+        if( !MultiByteToWideChar( CP_UTF8, 0, p_demux->psz_path, -1, wpath, MAX_PATH) )
+        {
+            errno = ENOENT;
+            return VLC_EGENERIC;
+        }
+        wpath[MAX_PATH] = L'0';
+        FileRef f( wpath );
+    }
+    else return VLC_EGENERIC;
+#else
+    const char *local_name = ToLocale( p_demux->psz_path );
 
-    if( strncmp( p_demux->psz_access, "file", 4 ) )
+    if( local_name == NULL )
+    {
         return VLC_EGENERIC;
+    }
+    FileRef f( local_name );
+    LocaleFree( local_name );
+#endif
 
-    TagLib::FileRef f( p_demux->psz_path );
     if( f.isNull() )
         return VLC_EGENERIC;
 
     if ( !f.tag() || f.tag()->isEmpty() )
         return VLC_EGENERIC;
 
-    if( !p_demux->p_private )
-        p_demux->p_private = (void*)vlc_meta_New();
-    vlc_meta_t *p_meta = (vlc_meta_t *)(p_demux->p_private );
-    TagLib::Tag *p_tag = f.tag();
+    p_demux_meta->p_meta = p_meta = vlc_meta_New();
+    Tag *p_tag = f.tag();
 
-    if( TagLib::MPEG::File *p_mpeg =
-        dynamic_cast<TagLib::MPEG::File *>(f.file() ) )
+    if( MPEG::File *p_mpeg =
+        dynamic_cast<MPEG::File *>(f.file() ) )
     {
         if( p_mpeg->ID3v2Tag() )
         {
-            TagLib::ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
-            TagLib::ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
-            TagLib::ID3v2::UniqueFileIdentifierFrame* p_ufid;
-            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
+            ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
+            ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
+            ID3v2::UniqueFileIdentifierFrame* p_ufid;
+            for( ID3v2::FrameList::Iterator iter = list.begin();
                     iter != list.end(); iter++ )
             {
-                p_ufid = dynamic_cast<TagLib::ID3v2::UniqueFileIdentifierFrame*>(*iter);
+                p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
                 const char *owner = p_ufid->owner().toCString();
                 if (!strcmp( owner, "http://musicbrainz.org" ))
                 {
                     /* ID3v2 UFID contains up to 64 bytes binary data
-                        * but in our case it will be a '\0' 
+                        * but in our case it will be a '\0'
                         * terminated string */
                     char *psz_ufid = (char*) malloc( 64 );
                     int j = 0;
@@ -146,32 +312,32 @@ static int ReadMeta( vlc_object_t *p_this )
             }
 
             list = p_tag->frameListMap()["TXXX"];
-            TagLib::ID3v2::UserTextIdentificationFrame* p_txxx;
-            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
+            ID3v2::UserTextIdentificationFrame* p_txxx;
+            for( ID3v2::FrameList::Iterator iter = list.begin();
                     iter != list.end(); iter++ )
             {
-                p_txxx = dynamic_cast<TagLib::ID3v2::UserTextIdentificationFrame*>(*iter);
+                p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
                 const char *psz_desc= p_txxx->description().toCString();
-                vlc_meta_AddExtra( p_meta, psz_desc, 
+                vlc_meta_AddExtra( p_meta, psz_desc,
                             p_txxx->fieldList().toString().toCString());
             }
 #if 0
             list = p_tag->frameListMap()["RVA2"];
-            TagLib::ID3v2::RelativeVolumeFrame* p_rva2;
-            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
+            ID3v2::RelativeVolumeFrame* p_rva2;
+            for( ID3v2::FrameList::Iterator iter = list.begin();
                     iter != list.end(); iter++ )
             {
-                p_rva2 = dynamic_cast<TagLib::ID3v2::RelativeVolumeFrame*>(*iter);
+                p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
                 /* TODO: process rva2 frames */
             }
 #endif
             list = p_tag->frameList();
-            TagLib::ID3v2::Frame* p_t;
+            ID3v2::Frame* p_t;
             char psz_tag[4];
-            for( TagLib::ID3v2::FrameList::Iterator iter = list.begin();
+            for( ID3v2::FrameList::Iterator iter = list.begin();
                     iter != list.end(); iter++ )
             {
-                p_t = dynamic_cast<TagLib::ID3v2::Frame*> (*iter);
+                p_t = dynamic_cast<ID3v2::Frame*> (*iter);
                 memcpy( psz_tag, p_t->frameID().data(), 4);
 
 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
@@ -188,8 +354,8 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
         }
     }
 
-    else if( TagLib::Ogg::Vorbis::File *p_ogg_v =
-        dynamic_cast<TagLib::Ogg::Vorbis::File *>(f.file() ) )
+    else if( Ogg::Vorbis::File *p_ogg_v =
+        dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
     {
         int i_ogg_v_length = p_ogg_v->audioProperties()->length();
 
@@ -199,14 +365,11 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
         {
             input_item_t *p_item = input_GetItem( p_input );
             if( p_item )
-            {
-                vlc_mutex_lock( &p_item->lock );
-                p_item->i_duration = i_ogg_v_length * 1000000;
-                vlc_mutex_unlock( &p_item->lock );
-            }
+                input_item_SetDuration( p_item,
+                        (mtime_t) i_ogg_v_length * 1000000 );
             vlc_object_release( p_input );
         }
-        
+
     }
 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
 * becauses type detection is based on file extension:
@@ -214,8 +377,8 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
 * flac = flac
 * ΓΈ = ogg/flac
 */
-    else if( TagLib::Ogg::FLAC::File *p_ogg_f =
-        dynamic_cast<TagLib::Ogg::FLAC::File *>(f.file() ) )
+    else if( Ogg::FLAC::File *p_ogg_f =
+        dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
     {
         long i_ogg_f_length = p_ogg_f->streamLength();
         input_thread_t *p_input = (input_thread_t *)
@@ -224,17 +387,14 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
         {
             input_item_t *p_item = input_GetItem( p_input );
             if( p_item )
-            {
-                vlc_mutex_lock( &p_item->lock );
-                p_item->i_duration = i_ogg_f_length * 1000000;
-                vlc_mutex_unlock( &p_item->lock );
-            }
+                input_item_SetDuration( p_item,
+                        (mtime_t) i_ogg_f_length * 1000000 );
             vlc_object_release( p_input );
         }
     }
 #endif
-    else if( TagLib::FLAC::File *p_flac =
-        dynamic_cast<TagLib::FLAC::File *>(f.file() ) )
+    else if( FLAC::File *p_flac =
+        dynamic_cast<FLAC::File *>(f.file() ) )
     {
         long i_flac_length = p_flac->audioProperties()->length();
         input_thread_t *p_input = (input_thread_t *)
@@ -243,11 +403,8 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
         {
             input_item_t *p_item = input_GetItem( p_input );
             if( p_item )
-            {
-                vlc_mutex_lock( &p_item->lock );
-                p_item->i_duration = i_flac_length * 1000000;
-                vlc_mutex_unlock( &p_item->lock );
-            }
+                input_item_SetDuration( p_item,
+                        (mtime_t) i_flac_length * 1000000 );
             vlc_object_release( p_input );
         }
     }
@@ -269,7 +426,7 @@ vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
 #undef SET
 #undef SETINT
 
-    DetectImage( f, p_meta );
+    DetectImage( f, p_demux );
 
     return VLC_SUCCESS;
 }
@@ -279,14 +436,14 @@ static int WriteMeta( vlc_object_t *p_this )
     playlist_t *p_playlist = (playlist_t *)p_this;
     meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
     input_item_t *p_item = p_export->p_item;
-    
+
     if( p_item == NULL )
     {
         msg_Err( p_this, "Can't save meta data of an empty input" );
         return VLC_EGENERIC;
     }
 
-    TagLib::FileRef f( p_export->psz_file );
+    FileRef f( p_export->psz_file );
     if( f.isNull() || !f.tag() || f.file()->readOnly() )
     {
         msg_Err( p_this, "File %s can't be opened for tag writing\n",
@@ -296,14 +453,14 @@ static int WriteMeta( vlc_object_t *p_this )
 
     msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
 
-    TagLib::Tag *p_tag = f.tag();
+    Tag *p_tag = f.tag();
 
     char *psz_meta;
 
 #define SET(a,b) \
         if(b) { \
-            TagLib::String *psz_##a = new TagLib::String( b, \
-                TagLib::String::UTF8 ); \
+            String *psz_##a = new String( b, \
+                String::UTF8 ); \
             p_tag->set##a( *psz_##a ); \
             delete psz_##a; \
         }
@@ -315,8 +472,8 @@ static int WriteMeta( vlc_object_t *p_this )
 
     psz_meta = input_item_GetTitle( p_item );
     if( !psz_meta ) psz_meta = input_item_GetName( p_item );
-    TagLib::String *psz_title = new TagLib::String( psz_meta,
-        TagLib::String::UTF8 );
+    String *psz_title = new String( psz_meta,
+        String::UTF8 );
     p_tag->setTitle( *psz_title );
     delete psz_title;
     free( psz_meta );
@@ -339,25 +496,25 @@ static int WriteMeta( vlc_object_t *p_this )
     if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
     free( psz_meta );
 
-    if( TagLib::ID3v2::Tag *p_id3tag =
-        dynamic_cast<TagLib::ID3v2::Tag *>(p_tag) )
+    if( ID3v2::Tag *p_id3tag =
+        dynamic_cast<ID3v2::Tag *>(p_tag) )
     {
 #define WRITE( foo, bar ) \
         psz_meta = input_item_Get##foo( p_item ); \
         if( psz_meta ) \
         { \
-            TagLib::ByteVector p_byte( bar, 4 ); \
-            TagLib::ID3v2::TextIdentificationFrame p_frame( p_byte ); \
+            ByteVector p_byte( bar, 4 ); \
+            ID3v2::TextIdentificationFrame p_frame( p_byte ); \
             p_frame.setText( psz_meta ); \
             p_id3tag->addFrame( &p_frame ); \
+            free( psz_meta ); \
         } \
-        else free( psz_meta );
 
         WRITE( Publisher, "TPUB" );
         WRITE( Copyright, "TCOP" );
         WRITE( EncodedBy, "TENC" );
         WRITE( Language, "TLAN" );
-        
+
 #undef WRITE
     }