1 /*****************************************************************************
2 * taglib.cpp: Taglib tag parser/writer
3 *****************************************************************************
4 * Copyright (C) 2003-2008 the VideoLAN team
7 * Authors: Clément Stenac <zorglub@videolan.org>
8 * Rafaël Carré <funman@videolanorg>
9 * Rémi Duraffort <ivoire@videolan.org>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
24 *****************************************************************************/
30 #include <vlc_common.h>
31 #include <vlc_plugin.h>
32 #include <vlc_playlist.h>
34 #include <vlc_demux.h>
35 #include <vlc_strings.h>
36 #include <vlc_charset.h>
48 #include <tbytevector.h>
52 #include <xiphcomment.h>
58 #include <oggflacfile.h>
59 #include <speexfile.h>
60 #include <trueaudiofile.h>
61 #include <vorbisfile.h>
62 #include <wavpackfile.h>
64 #include <attachedpictureframe.h>
65 #include <textidentificationframe.h>
66 #include <uniquefileidentifierframe.h>
70 static int ReadMeta ( vlc_object_t * );
71 static int DownloadArt ( vlc_object_t * );
72 static int WriteMeta ( vlc_object_t * );
75 set_capability( "meta reader", 1000 )
76 set_callbacks( ReadMeta, NULL )
78 set_capability( "art downloader", 50 )
79 set_callbacks( DownloadArt, NULL )
81 set_capability( "meta writer", 50 )
82 set_callbacks( WriteMeta, NULL )
85 using namespace TagLib;
89 * Read meta informations from APE tags
90 * @param tag: the APE tag
91 * @param p_demux; the demux object
92 * @param p_demux_meta: the demuxer meta
93 * @param p_meta: the meta
95 static void ReadMetaFromAPE( APE::Tag* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
98 #define SET( keyName, metaName ) \
99 item = tag->itemListMap()[keyName]; \
100 vlc_meta_Set##metaName( p_meta, item.toString().toCString( true ) );\
102 SET( "COPYRIGHT", Copyright );
103 SET( "LANGUAGE", Language );
104 SET( "PUBLISHER", Publisher );
112 * Read meta information from id3v2 tags
113 * @param tag: the id3v2 tag
114 * @param p_demux; the demux object
115 * @param p_demux_meta: the demuxer meta
116 * @param p_meta: the meta
118 static void ReadMetaFromId3v2( ID3v2::Tag* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
120 // Get the unique file identifier
121 ID3v2::FrameList list = tag->frameListMap()["UFID"];
122 ID3v2::FrameList::Iterator iter;
123 for( iter = list.begin(); iter != list.end(); iter++ )
125 ID3v2::UniqueFileIdentifierFrame* p_ufid =
126 dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
127 const char *owner = p_ufid->owner().toCString();
128 if (!strcmp( owner, "http://musicbrainz.org" ))
130 /* ID3v2 UFID contains up to 64 bytes binary data
131 * but in our case it will be a '\0'
132 * terminated string */
134 int max_size = __MIN( p_ufid->identifier().size(), 63);
135 strncpy( psz_ufid, p_ufid->identifier().data(), max_size );
136 psz_ufid[max_size] = '\0';
137 vlc_meta_SetTrackID( p_meta, psz_ufid );
142 list = tag->frameListMap()["TXXX"];
143 for( iter = list.begin(); iter != list.end(); iter++ )
145 ID3v2::UserTextIdentificationFrame* p_txxx =
146 dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
147 vlc_meta_AddExtra( p_meta, p_txxx->description().toCString( true ),
148 p_txxx->fieldList().toString().toCString( true ) );
151 // Get some more informations
152 #define SET( tagName, metaName ) \
153 list = tag->frameListMap()[tagName]; \
154 if( !list.isEmpty() ) \
155 vlc_meta_Set##metaName( p_meta, \
156 (*list.begin())->toString().toCString( true ) );
158 SET( "TCOP", Copyright );
159 SET( "TENC", EncodedBy );
160 SET( "TLAN", Language );
161 SET( "TPUB", Publisher );
165 /* Preferred type of image
166 * The 21 types are defined in id3v2 standard:
167 * http://www.id3.org/id3v2.4.0-frames */
168 static const int pi_cover_score[] = {
170 5, /* 32x32 PNG image that should be used as the file icon */
171 4, /* File icon of a different size or format. */
172 20, /* Front cover image of the album. */
173 19, /* Back cover image of the album. */
174 13, /* Inside leaflet page of the album. */
175 18, /* Image from the album itself. */
176 17, /* Picture of the lead artist or soloist. */
177 16, /* Picture of the artist or performer. */
178 14, /* Picture of the conductor. */
179 15, /* Picture of the band or orchestra. */
180 9, /* Picture of the composer. */
181 8, /* Picture of the lyricist or text writer. */
182 7, /* Picture of the recording location or studio. */
183 10, /* Picture of the artists during recording. */
184 11, /* Picture of the artists during performance. */
185 6, /* Picture from a movie or video related to the track. */
186 1, /* Picture of a large, coloured fish. */
187 12, /* Illustration related to the track. */
188 3, /* Logo of the band or performer. */
189 2 /* Logo of the publisher (record company). */
193 // Try now to get embedded art
194 list = tag->frameListMap()[ "APIC" ];
198 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
199 for( iter = list.begin(); iter != list.end(); iter++ )
201 ID3v2::AttachedPictureFrame* p_apic =
202 dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
203 input_attachment_t *p_attachment;
205 const char *psz_mime;
206 char *psz_name, *psz_description;
208 // Get the mime and description of the image.
209 // If the description is empty, take the type as a description
210 psz_mime = p_apic->mimeType().toCString( true );
211 if( p_apic->description().size() > 0 )
212 psz_description = strdup( p_apic->description().toCString( true ) );
215 if( asprintf( &psz_description, "%i", p_apic->type() ) == -1 )
216 psz_description = NULL;
219 if( !psz_description )
221 psz_name = psz_description;
223 /* some old iTunes version not only sets incorrectly the mime type
224 * or the description of the image,
225 * but also embeds incorrectly the image.
226 * Recent versions seem to behave correctly */
227 if( !strncmp( psz_mime, "PNG", 3 ) ||
228 !strncmp( psz_name, "\xC2\x89PNG", 5 ) )
230 msg_Warn( p_demux, "Invalid picture embedded by broken iTunes version" );
231 free( psz_description );
235 const ByteVector picture = p_apic->picture();
236 const char *p_data = picture.data();
237 const unsigned i_data = picture.size();
239 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %u bytes",
240 psz_name, psz_mime, i_data );
242 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
243 psz_description, p_data, i_data );
245 TAB_APPEND_CAST( (input_attachment_t**),
246 p_demux_meta->i_attachments, p_demux_meta->attachments,
248 free( psz_description );
250 if( pi_cover_score[p_apic->type()] > i_score )
252 i_score = pi_cover_score[p_apic->type()];
254 if( asprintf( &psz_url, "attachment://%s",
255 p_attachment->psz_name ) == -1 )
257 vlc_meta_SetArtURL( p_meta, psz_url );
266 * Read the meta informations from XiphComments
267 * @param tag: the Xiph Comment
268 * @param p_demux; the demux object
269 * @param p_demux_meta: the demuxer meta
270 * @param p_meta: the meta
272 static void ReadMetaFromXiph( Ogg::XiphComment* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
274 #define SET( keyName, metaName ) \
275 StringList list = tag->fieldListMap()[keyName]; \
276 if( !list.isEmpty() ) \
277 vlc_meta_Set##metaName( p_meta, (*list.begin()).toCString( true ) );
279 SET( "COPYRIGHT", Copyright );
282 // Try now to get embedded art
283 StringList mime_list = tag->fieldListMap()[ "COVERARTMIME" ];
284 StringList art_list = tag->fieldListMap()[ "COVERART" ];
286 // We get only the first covert art
287 if( mime_list.size() > 1 || art_list.size() > 1 )
288 msg_Warn( p_demux, "Found %i embedded arts, so using only the first one",
290 else if( mime_list.size() == 0 || art_list.size() == 0 )
293 input_attachment_t *p_attachment;
295 const char* psz_name = "cover";
296 const char* psz_mime = mime_list[0].toCString(true);
297 const char* psz_description = "cover";
300 int i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
302 msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
303 psz_name, psz_mime, i_data );
305 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
306 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
307 psz_description, p_data, i_data );
310 TAB_APPEND_CAST( (input_attachment_t**),
311 p_demux_meta->i_attachments, p_demux_meta->attachments,
314 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
320 * Get the tags from the file using TagLib
321 * @param p_this: the demux object
322 * @return VLC_SUCCESS if the operation success
324 static int ReadMeta( vlc_object_t* p_this)
326 demux_t* p_demux = (demux_t*)p_this;
327 demux_meta_t* p_demux_meta = (demux_meta_t*)p_demux->p_private;
331 p_demux_meta->p_meta = NULL;
334 #if defined(WIN32) || defined (UNDER_CE)
335 if(GetVersion() < 0x80000000)
337 wchar_t wpath[MAX_PATH + 1];
338 if( !MultiByteToWideChar( CP_UTF8, 0, p_demux->psz_path, -1, wpath, MAX_PATH) )
340 wpath[MAX_PATH] = L'\0';
341 f = FileRef( wpath );
346 const char* local_name = ToLocale( p_demux->psz_path );
349 f = FileRef( local_name );
350 LocaleFree( local_name );
355 if( !f.tag() || f.tag()->isEmpty() )
358 p_demux_meta->p_meta = p_meta = vlc_meta_New();
363 // Read the tags from the file
364 Tag* p_tag = f.tag();
366 #define SET( tag, meta ) \
367 if( !p_tag->tag().isNull() && !p_tag->tag().isEmpty() ) \
368 vlc_meta_Set##meta( p_meta, p_tag->tag().toCString(true) )
369 #define SETINT( tag, meta ) \
373 snprintf( psz_tmp, 10, "%d", p_tag->tag() ); \
374 vlc_meta_Set##meta( p_meta, psz_tmp ); \
378 SET( artist, Artist );
380 SET( comment, Description );
382 SETINT( year, Date );
383 SETINT( track, TrackNum );
389 // Try now to read special tags
390 if( FLAC::File* flac = dynamic_cast<FLAC::File*>(f.file()) )
392 if( flac->ID3v2Tag() )
393 ReadMetaFromId3v2( flac->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
394 else if( flac->xiphComment() )
395 ReadMetaFromXiph( flac->xiphComment(), p_demux, p_demux_meta, p_meta );
397 else if( MPC::File* mpc = dynamic_cast<MPC::File*>(f.file()) )
400 ReadMetaFromAPE( mpc->APETag(), p_demux, p_demux_meta, p_meta );
402 else if( MPEG::File* mpeg = dynamic_cast<MPEG::File*>(f.file()) )
404 if( mpeg->ID3v2Tag() )
405 ReadMetaFromId3v2( mpeg->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
406 else if( mpeg->APETag() )
407 ReadMetaFromAPE( mpeg->APETag(), p_demux, p_demux_meta, p_meta );
409 else if( Ogg::File* ogg = dynamic_cast<Ogg::File*>(f.file()) )
411 if( Ogg::FLAC::File* ogg_flac = dynamic_cast<Ogg::FLAC::File*>(f.file()))
412 ReadMetaFromXiph( ogg_flac->tag(), p_demux, p_demux_meta, p_meta );
413 else if( Ogg::Speex::File* ogg_speex = dynamic_cast<Ogg::Speex::File*>(f.file()) )
414 ReadMetaFromXiph( ogg_speex->tag(), p_demux, p_demux_meta, p_meta );
415 else if( Ogg::Vorbis::File* ogg_vorbis = dynamic_cast<Ogg::Vorbis::File*>(f.file()) )
416 ReadMetaFromXiph( ogg_vorbis->tag(), p_demux, p_demux_meta, p_meta );
418 else if( TrueAudio::File* trueaudio = dynamic_cast<TrueAudio::File*>(f.file()) )
420 if( trueaudio->ID3v2Tag() )
421 ReadMetaFromId3v2( trueaudio->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
423 else if( WavPack::File* wavpack = dynamic_cast<WavPack::File*>(f.file()) )
425 if( wavpack->APETag() )
426 ReadMetaFromAPE( wavpack->APETag(), p_demux, p_demux_meta, p_meta );
435 * Write meta informations to APE tags
436 * @param tag: the APE tag
437 * @param p_item: the input item
439 static void WriteMetaToAPE( APE::Tag* tag, input_item_t* p_item )
442 #define WRITE( metaName, keyName ) \
443 psz_meta = input_item_Get##metaName( p_item ); \
446 String key( keyName, String::UTF8 ); \
447 String value( psz_meta, String::UTF8 ); \
448 tag->addValue( key, value, true ); \
452 WRITE( Copyright, "COPYRIGHT" );
453 WRITE( Language, "LANGUAGE" );
454 WRITE( Publisher, "PUBLISHER" );
462 * Write meta information to id3v2 tags
463 * @param tag: the id3v2 tag
464 * @param p_input: the input item
466 static void WriteMetaToId3v2( ID3v2::Tag* tag, input_item_t* p_item )
469 #define WRITE( metaName, tagName ) \
470 psz_meta = input_item_Get##metaName( p_item ); \
473 ByteVector p_byte( tagName, 4 ); \
474 tag->removeFrames( p_byte ); \
475 ID3v2::TextIdentificationFrame* p_frame = \
476 new ID3v2::TextIdentificationFrame( p_byte, String::UTF8 ); \
477 p_frame->setText( psz_meta ); \
478 tag->addFrame( p_frame ); \
482 WRITE( Copyright, "TCOP" );
483 WRITE( EncodedBy, "TENC" );
484 WRITE( Language, "TLAN" );
485 WRITE( Publisher, "TPUB" );
493 * Write the meta informations to XiphComments
494 * @param tag: the Xiph Comment
495 * @param p_input: the input item
497 static void WriteMetaToXiph( Ogg::XiphComment* tag, input_item_t* p_item )
500 #define WRITE( metaName, keyName ) \
501 psz_meta = input_item_Get##metaName( p_item ); \
504 String key( keyName, String::UTF8 ); \
505 String value( psz_meta, String::UTF8 ); \
506 tag->addField( key, value, true ); \
510 WRITE( Copyright, "COPYRIGHT" );
518 * Set the tags to the file using TagLib
519 * @param p_this: the demux object
520 * @return VLC_SUCCESS if the operation success
523 static int WriteMeta( vlc_object_t *p_this )
525 playlist_t *p_playlist = (playlist_t *)p_this;
526 meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
527 input_item_t *p_item = p_export->p_item;
532 msg_Err( p_this, "Can't save meta data of an empty input" );
536 #if defined(WIN32) || defined (UNDER_CE)
537 if(GetVersion() < 0x80000000)
539 wchar_t wpath[MAX_PATH + 1];
540 if( !MultiByteToWideChar( CP_UTF8, 0, p_export->psz_file, -1, wpath, MAX_PATH) )
542 wpath[MAX_PATH] = L'\0';
543 f = FileRef( wpath );
548 const char* local_name = ToLocale( p_export->psz_file );
551 f = FileRef( local_name );
552 LocaleFree( local_name );
555 if( f.isNull() || !f.tag() || f.file()->readOnly() )
557 msg_Err( p_this, "File %s can't be opened for tag writing\n",
558 p_export->psz_file );
562 msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
564 Tag *p_tag = f.tag();
568 #define SET( a, b ) \
571 String* psz_tmp = new String( b, String::UTF8 ); \
572 p_tag->set##a( *psz_tmp ); \
576 // Saving all common fields
577 // If the title is empty, use the name
578 psz_meta = input_item_GetTitle( p_item );
579 if( !psz_meta ) psz_meta = input_item_GetName( p_item );
580 SET( Title, psz_meta );
583 psz_meta = input_item_GetArtist( p_item );
584 SET( Artist, psz_meta );
587 psz_meta = input_item_GetAlbum( p_item );
588 SET( Album, psz_meta );
591 psz_meta = input_item_GetDescription( p_item );
592 SET( Comment, psz_meta );
595 psz_meta = input_item_GetGenre( p_item );
596 SET( Genre, psz_meta );
601 psz_meta = input_item_GetDate( p_item );
602 if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
605 psz_meta = input_item_GetTrackNum( p_item );
606 if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
610 // Try now to write special tags
611 if( FLAC::File* flac = dynamic_cast<FLAC::File*>(f.file()) )
613 if( flac->ID3v2Tag() )
614 WriteMetaToId3v2( flac->ID3v2Tag(), p_item );
615 else if( flac->xiphComment() )
616 WriteMetaToXiph( flac->xiphComment(), p_item );
618 else if( MPC::File* mpc = dynamic_cast<MPC::File*>(f.file()) )
621 WriteMetaToAPE( mpc->APETag(), p_item );
623 else if( MPEG::File* mpeg = dynamic_cast<MPEG::File*>(f.file()) )
625 if( mpeg->ID3v2Tag() )
626 WriteMetaToId3v2( mpeg->ID3v2Tag(), p_item );
627 else if( mpeg->APETag() )
628 WriteMetaToAPE( mpeg->APETag(), p_item );
630 else if( Ogg::File* ogg = dynamic_cast<Ogg::File*>(f.file()) )
632 if( Ogg::FLAC::File* ogg_flac = dynamic_cast<Ogg::FLAC::File*>(f.file()))
633 WriteMetaToXiph( ogg_flac->tag(), p_item );
634 else if( Ogg::Speex::File* ogg_speex = dynamic_cast<Ogg::Speex::File*>(f.file()) )
635 WriteMetaToXiph( ogg_speex->tag(), p_item );
636 else if( Ogg::Vorbis::File* ogg_vorbis = dynamic_cast<Ogg::Vorbis::File*>(f.file()) )
637 WriteMetaToXiph( ogg_vorbis->tag(), p_item );
639 else if( TrueAudio::File* trueaudio = dynamic_cast<TrueAudio::File*>(f.file()) )
641 if( trueaudio->ID3v2Tag() )
642 WriteMetaToId3v2( trueaudio->ID3v2Tag(), p_item );
644 else if( WavPack::File* wavpack = dynamic_cast<WavPack::File*>(f.file()) )
646 if( wavpack->APETag() )
647 WriteMetaToAPE( wavpack->APETag(), p_item );
650 // Save the meta data
658 static int DownloadArt( vlc_object_t *p_this )
660 /* We need to be passed the file name
661 * Fetch the thing from the file, save it to the cache folder