1 /*****************************************************************************
2 * taglib.cpp: Taglib tag parser/writer
3 *****************************************************************************
4 * Copyright (C) 2003-2009 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>
33 #include <vlc_demux.h>
34 #include <vlc_strings.h>
35 #include <vlc_charset.h>
37 #include <vlc_input_item.h>
38 #include <vlc_input.h> /* for attachment_new */
50 #include <tbytevector.h>
54 #include <xiphcomment.h>
60 #include <oggflacfile.h>
62 #ifdef TAGLIB_WITH_ASF
63 # include <aifffile.h>
67 #ifdef TAGLIB_WITH_MP4
71 #include <speexfile.h>
72 #include <trueaudiofile.h>
73 #include <vorbisfile.h>
74 #include <wavpackfile.h>
76 #include <attachedpictureframe.h>
77 #include <textidentificationframe.h>
78 #include <uniquefileidentifierframe.h>
82 static int ReadMeta ( vlc_object_t * );
83 static int WriteMeta ( vlc_object_t * );
86 set_capability( "meta reader", 1000 )
87 set_callbacks( ReadMeta, NULL )
89 set_capability( "meta writer", 50 )
90 set_callbacks( WriteMeta, NULL )
93 using namespace TagLib;
97 * Read meta information from APE tags
98 * @param tag: the APE tag
99 * @param p_demux; the demux object
100 * @param p_demux_meta: the demuxer meta
101 * @param p_meta: the meta
103 static void ReadMetaFromAPE( APE::Tag* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
106 #define SET( keyName, metaName ) \
107 item = tag->itemListMap()[keyName]; \
108 vlc_meta_Set##metaName( p_meta, item.toString().toCString( true ) );\
110 SET( "COPYRIGHT", Copyright );
111 SET( "LANGUAGE", Language );
112 SET( "PUBLISHER", Publisher );
120 * Read meta information from id3v2 tags
121 * @param tag: the id3v2 tag
122 * @param p_demux; the demux object
123 * @param p_demux_meta: the demuxer meta
124 * @param p_meta: the meta
126 static void ReadMetaFromId3v2( ID3v2::Tag* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
128 // Get the unique file identifier
129 ID3v2::FrameList list = tag->frameListMap()["UFID"];
130 ID3v2::FrameList::Iterator iter;
131 for( iter = list.begin(); iter != list.end(); iter++ )
133 ID3v2::UniqueFileIdentifierFrame* p_ufid =
134 dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
137 const char *owner = p_ufid->owner().toCString();
138 if (!strcmp( owner, "http://musicbrainz.org" ))
140 /* ID3v2 UFID contains up to 64 bytes binary data
141 * but in our case it will be a '\0'
142 * terminated string */
144 int max_size = __MIN( p_ufid->identifier().size(), 63);
145 strncpy( psz_ufid, p_ufid->identifier().data(), max_size );
146 psz_ufid[max_size] = '\0';
147 vlc_meta_SetTrackID( p_meta, psz_ufid );
152 list = tag->frameListMap()["TXXX"];
153 for( iter = list.begin(); iter != list.end(); iter++ )
155 ID3v2::UserTextIdentificationFrame* p_txxx =
156 dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
159 vlc_meta_AddExtra( p_meta, p_txxx->description().toCString( true ),
160 p_txxx->fieldList().toString().toCString( true ) );
163 // Get some more information
164 #define SET( tagName, metaName ) \
165 list = tag->frameListMap()[tagName]; \
166 if( !list.isEmpty() ) \
167 vlc_meta_Set##metaName( p_meta, \
168 (*list.begin())->toString().toCString( true ) );
170 SET( "TCOP", Copyright );
171 SET( "TENC", EncodedBy );
172 SET( "TLAN", Language );
173 SET( "TPUB", Publisher );
177 /* Preferred type of image
178 * The 21 types are defined in id3v2 standard:
179 * http://www.id3.org/id3v2.4.0-frames */
180 static const int pi_cover_score[] = {
182 5, /* 32x32 PNG image that should be used as the file icon */
183 4, /* File icon of a different size or format. */
184 20, /* Front cover image of the album. */
185 19, /* Back cover image of the album. */
186 13, /* Inside leaflet page of the album. */
187 18, /* Image from the album itself. */
188 17, /* Picture of the lead artist or soloist. */
189 16, /* Picture of the artist or performer. */
190 14, /* Picture of the conductor. */
191 15, /* Picture of the band or orchestra. */
192 9, /* Picture of the composer. */
193 8, /* Picture of the lyricist or text writer. */
194 7, /* Picture of the recording location or studio. */
195 10, /* Picture of the artists during recording. */
196 11, /* Picture of the artists during performance. */
197 6, /* Picture from a movie or video related to the track. */
198 1, /* Picture of a large, coloured fish. */
199 12, /* Illustration related to the track. */
200 3, /* Logo of the band or performer. */
201 2 /* Logo of the publisher (record company). */
203 #define PI_COVER_SCORE_SIZE (sizeof (pi_cover_score) / sizeof (pi_cover_score[0]))
206 // Try now to get embedded art
207 list = tag->frameListMap()[ "APIC" ];
211 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
212 for( iter = list.begin(); iter != list.end(); iter++ )
214 ID3v2::AttachedPictureFrame* p_apic =
215 dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
218 input_attachment_t *p_attachment;
220 const char *psz_mime;
221 char *psz_name, *psz_description;
223 // Get the mime and description of the image.
224 // If the description is empty, take the type as a description
225 psz_mime = p_apic->mimeType().toCString( true );
226 if( p_apic->description().size() > 0 )
227 psz_description = strdup( p_apic->description().toCString( true ) );
230 if( asprintf( &psz_description, "%i", p_apic->type() ) == -1 )
231 psz_description = NULL;
234 if( !psz_description )
236 psz_name = psz_description;
238 /* some old iTunes version not only sets incorrectly the mime type
239 * or the description of the image,
240 * but also embeds incorrectly the image.
241 * Recent versions seem to behave correctly */
242 if( !strncmp( psz_mime, "PNG", 3 ) ||
243 !strncmp( psz_name, "\xC2\x89PNG", 5 ) )
245 msg_Warn( p_demux_meta, "Invalid picture embedded by broken iTunes version" );
246 free( psz_description );
250 const ByteVector picture = p_apic->picture();
251 const char *p_data = picture.data();
252 const unsigned i_data = picture.size();
254 msg_Dbg( p_demux_meta, "Found embedded art: %s (%s) is %u bytes",
255 psz_name, psz_mime, i_data );
257 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
258 psz_description, p_data, i_data );
260 TAB_APPEND_CAST( (input_attachment_t**),
261 p_demux_meta->i_attachments, p_demux_meta->attachments,
263 free( psz_description );
265 unsigned i_pic_type = p_apic->type();
266 if( i_pic_type >= PI_COVER_SCORE_SIZE )
267 i_pic_type = 0; // Defaults to "Other"
269 if( pi_cover_score[i_pic_type] > i_score )
271 i_score = pi_cover_score[i_pic_type];
273 if( asprintf( &psz_url, "attachment://%s",
274 p_attachment->psz_name ) == -1 )
276 vlc_meta_SetArtURL( p_meta, psz_url );
285 * Read the meta information from XiphComments
286 * @param tag: the Xiph Comment
287 * @param p_demux; the demux object
288 * @param p_demux_meta: the demuxer meta
289 * @param p_meta: the meta
291 static void ReadMetaFromXiph( Ogg::XiphComment* tag, demux_t* p_demux, demux_meta_t* p_demux_meta, vlc_meta_t* p_meta )
293 #define SET( keyName, metaName ) \
294 StringList list = tag->fieldListMap()[keyName]; \
295 if( !list.isEmpty() ) \
296 vlc_meta_Set##metaName( p_meta, (*list.begin()).toCString( true ) );
298 SET( "COPYRIGHT", Copyright );
301 // Try now to get embedded art
302 StringList mime_list = tag->fieldListMap()[ "COVERARTMIME" ];
303 StringList art_list = tag->fieldListMap()[ "COVERART" ];
305 // We get only the first covert art
306 if( mime_list.size() > 1 || art_list.size() > 1 )
307 msg_Warn( p_demux_meta, "Found %i embedded arts, so using only the first one",
309 else if( mime_list.size() == 0 || art_list.size() == 0 )
312 input_attachment_t *p_attachment;
314 const char* psz_name = "cover";
315 const char* psz_mime = mime_list[0].toCString(true);
316 const char* psz_description = "cover";
319 int i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
321 msg_Dbg( p_demux_meta, "Found embedded art: %s (%s) is %i bytes",
322 psz_name, psz_mime, i_data );
324 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
325 p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
326 psz_description, p_data, i_data );
329 TAB_APPEND_CAST( (input_attachment_t**),
330 p_demux_meta->i_attachments, p_demux_meta->attachments,
333 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
336 #if defined(TAGLIB_WITH_MP4) && defined(HAVE_TAGLIB_MP4COVERART_H)
337 static void ReadMetaFromMP4( MP4::Tag* tag, demux_t *p_demux, demux_meta_t *p_demux_meta, vlc_meta_t* p_meta )
339 if( tag->itemListMap().contains("covr") )
341 MP4::CoverArtList list = tag->itemListMap()["covr"].toCoverArtList();
342 const char *psz_format = list[0].format() == MP4::CoverArt::PNG ? "image/png" : "image/jpeg";
344 msg_Dbg( p_demux_meta, "Found embedded art (%s) is %i bytes",
345 psz_format, list[0].data().size() );
347 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
348 input_attachment_t *p_attachment =
349 vlc_input_attachment_New( "cover", psz_format, "cover",
350 list[0].data().data(), list[0].data().size() );
351 TAB_APPEND_CAST( (input_attachment_t**),
352 p_demux_meta->i_attachments, p_demux_meta->attachments,
354 vlc_meta_SetArtURL( p_meta, "attachment://cover" );
360 * Get the tags from the file using TagLib
361 * @param p_this: the demux object
362 * @return VLC_SUCCESS if the operation success
364 static int ReadMeta( vlc_object_t* p_this)
366 demux_meta_t* p_demux_meta = (demux_meta_t *)p_this;
367 demux_t* p_demux = p_demux_meta->p_demux;
371 p_demux_meta->p_meta = NULL;
372 if( strcmp( p_demux->psz_access, "file" ) )
375 char *psz_path = strdup( p_demux->psz_file );
379 #if defined(WIN32) || defined (UNDER_CE)
380 wchar_t wpath[MAX_PATH + 1];
381 if( !MultiByteToWideChar( CP_UTF8, 0, psz_path, -1, wpath, MAX_PATH) )
386 wpath[MAX_PATH] = L'\0';
387 f = FileRef( wpath );
389 const char* local_name = ToLocale( psz_path );
395 f = FileRef( local_name );
396 LocaleFree( local_name );
402 if( !f.tag() || f.tag()->isEmpty() )
405 p_demux_meta->p_meta = p_meta = vlc_meta_New();
410 // Read the tags from the file
411 Tag* p_tag = f.tag();
413 #define SET( tag, meta ) \
414 if( !p_tag->tag().isNull() && !p_tag->tag().isEmpty() ) \
415 vlc_meta_Set##meta( p_meta, p_tag->tag().toCString(true) )
416 #define SETINT( tag, meta ) \
420 snprintf( psz_tmp, 10, "%d", p_tag->tag() ); \
421 vlc_meta_Set##meta( p_meta, psz_tmp ); \
425 SET( artist, Artist );
427 SET( comment, Description );
429 SETINT( year, Date );
430 SETINT( track, TrackNum );
436 // Try now to read special tags
437 if( FLAC::File* flac = dynamic_cast<FLAC::File*>(f.file()) )
439 if( flac->ID3v2Tag() )
440 ReadMetaFromId3v2( flac->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
441 else if( flac->xiphComment() )
442 ReadMetaFromXiph( flac->xiphComment(), p_demux, p_demux_meta, p_meta );
444 #if defined(TAGLIB_WITH_MP4) && defined(HAVE_TAGLIB_MP4COVERART_H)
445 else if( MP4::File *mp4 = dynamic_cast<MP4::File*>(f.file()) )
448 ReadMetaFromMP4( mp4->tag(), p_demux, p_demux_meta, p_meta );
451 else if( MPC::File* mpc = dynamic_cast<MPC::File*>(f.file()) )
454 ReadMetaFromAPE( mpc->APETag(), p_demux, p_demux_meta, p_meta );
456 else if( MPEG::File* mpeg = dynamic_cast<MPEG::File*>(f.file()) )
458 if( mpeg->ID3v2Tag() )
459 ReadMetaFromId3v2( mpeg->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
460 else if( mpeg->APETag() )
461 ReadMetaFromAPE( mpeg->APETag(), p_demux, p_demux_meta, p_meta );
463 else if( Ogg::File* ogg = dynamic_cast<Ogg::File*>(f.file()) )
465 if( Ogg::FLAC::File* ogg_flac = dynamic_cast<Ogg::FLAC::File*>(f.file()))
466 ReadMetaFromXiph( ogg_flac->tag(), p_demux, p_demux_meta, p_meta );
467 else if( Ogg::Speex::File* ogg_speex = dynamic_cast<Ogg::Speex::File*>(f.file()) )
468 ReadMetaFromXiph( ogg_speex->tag(), p_demux, p_demux_meta, p_meta );
469 else if( Ogg::Vorbis::File* ogg_vorbis = dynamic_cast<Ogg::Vorbis::File*>(f.file()) )
470 ReadMetaFromXiph( ogg_vorbis->tag(), p_demux, p_demux_meta, p_meta );
472 #ifdef TAGLIB_WITH_ASF
473 else if( RIFF::File* riff = dynamic_cast<RIFF::File*>(f.file()) )
475 if( RIFF::AIFF::File* riff_aiff = dynamic_cast<RIFF::AIFF::File*>(f.file()) )
476 ReadMetaFromId3v2( riff_aiff->tag(), p_demux, p_demux_meta, p_meta );
477 else if( RIFF::WAV::File* riff_wav = dynamic_cast<RIFF::WAV::File*>(f.file()) )
478 ReadMetaFromId3v2( riff_wav->tag(), p_demux, p_demux_meta, p_meta );
481 else if( TrueAudio::File* trueaudio = dynamic_cast<TrueAudio::File*>(f.file()) )
483 if( trueaudio->ID3v2Tag() )
484 ReadMetaFromId3v2( trueaudio->ID3v2Tag(), p_demux, p_demux_meta, p_meta );
486 else if( WavPack::File* wavpack = dynamic_cast<WavPack::File*>(f.file()) )
488 if( wavpack->APETag() )
489 ReadMetaFromAPE( wavpack->APETag(), p_demux, p_demux_meta, p_meta );
498 * Write meta information to APE tags
499 * @param tag: the APE tag
500 * @param p_item: the input item
502 static void WriteMetaToAPE( APE::Tag* tag, input_item_t* p_item )
505 #define WRITE( metaName, keyName ) \
506 psz_meta = input_item_Get##metaName( p_item ); \
509 String key( keyName, String::UTF8 ); \
510 String value( psz_meta, String::UTF8 ); \
511 tag->addValue( key, value, true ); \
515 WRITE( Copyright, "COPYRIGHT" );
516 WRITE( Language, "LANGUAGE" );
517 WRITE( Publisher, "PUBLISHER" );
525 * Write meta information to id3v2 tags
526 * @param tag: the id3v2 tag
527 * @param p_input: the input item
529 static void WriteMetaToId3v2( ID3v2::Tag* tag, input_item_t* p_item )
532 #define WRITE( metaName, tagName ) \
533 psz_meta = input_item_Get##metaName( p_item ); \
536 ByteVector p_byte( tagName, 4 ); \
537 tag->removeFrames( p_byte ); \
538 ID3v2::TextIdentificationFrame* p_frame = \
539 new ID3v2::TextIdentificationFrame( p_byte, String::UTF8 ); \
540 p_frame->setText( psz_meta ); \
541 tag->addFrame( p_frame ); \
545 WRITE( Copyright, "TCOP" );
546 WRITE( EncodedBy, "TENC" );
547 WRITE( Language, "TLAN" );
548 WRITE( Publisher, "TPUB" );
556 * Write the meta information to XiphComments
557 * @param tag: the Xiph Comment
558 * @param p_input: the input item
560 static void WriteMetaToXiph( Ogg::XiphComment* tag, input_item_t* p_item )
563 #define WRITE( metaName, keyName ) \
564 psz_meta = input_item_Get##metaName( p_item ); \
567 String key( keyName, String::UTF8 ); \
568 String value( psz_meta, String::UTF8 ); \
569 tag->addField( key, value, true ); \
573 WRITE( Copyright, "COPYRIGHT" );
581 * Set the tags to the file using TagLib
582 * @param p_this: the demux object
583 * @return VLC_SUCCESS if the operation success
586 static int WriteMeta( vlc_object_t *p_this )
588 meta_export_t *p_export = (meta_export_t *)p_this;
589 input_item_t *p_item = p_export->p_item;
594 msg_Err( p_this, "Can't save meta data of an empty input" );
598 #if defined(WIN32) || defined (UNDER_CE)
599 wchar_t wpath[MAX_PATH + 1];
600 if( !MultiByteToWideChar( CP_UTF8, 0, p_export->psz_file, -1, wpath, MAX_PATH) )
602 wpath[MAX_PATH] = L'\0';
603 f = FileRef( wpath );
605 const char* local_name = ToLocale( p_export->psz_file );
608 f = FileRef( local_name );
609 LocaleFree( local_name );
612 if( f.isNull() || !f.tag() || f.file()->readOnly() )
614 msg_Err( p_this, "File %s can't be opened for tag writing",
615 p_export->psz_file );
619 msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
621 Tag *p_tag = f.tag();
625 #define SET( a, b ) \
626 psz_meta = input_item_Get ## a( p_item ); \
629 String tmp( psz_meta, String::UTF8 ); \
630 p_tag->set##b( tmp ); \
634 // Saving all common fields
635 // If the title is empty, use the name
636 SET( TitleFbName, Title );
637 SET( Artist, Artist );
639 SET( Description, Comment );
644 psz_meta = input_item_GetDate( p_item );
645 if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
648 psz_meta = input_item_GetTrackNum( p_item );
649 if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
653 // Try now to write special tags
654 if( FLAC::File* flac = dynamic_cast<FLAC::File*>(f.file()) )
656 if( flac->ID3v2Tag() )
657 WriteMetaToId3v2( flac->ID3v2Tag(), p_item );
658 else if( flac->xiphComment() )
659 WriteMetaToXiph( flac->xiphComment(), p_item );
661 else if( MPC::File* mpc = dynamic_cast<MPC::File*>(f.file()) )
664 WriteMetaToAPE( mpc->APETag(), p_item );
666 else if( MPEG::File* mpeg = dynamic_cast<MPEG::File*>(f.file()) )
668 if( mpeg->ID3v2Tag() )
669 WriteMetaToId3v2( mpeg->ID3v2Tag(), p_item );
670 else if( mpeg->APETag() )
671 WriteMetaToAPE( mpeg->APETag(), p_item );
673 else if( Ogg::File* ogg = dynamic_cast<Ogg::File*>(f.file()) )
675 if( Ogg::FLAC::File* ogg_flac = dynamic_cast<Ogg::FLAC::File*>(f.file()))
676 WriteMetaToXiph( ogg_flac->tag(), p_item );
677 else if( Ogg::Speex::File* ogg_speex = dynamic_cast<Ogg::Speex::File*>(f.file()) )
678 WriteMetaToXiph( ogg_speex->tag(), p_item );
679 else if( Ogg::Vorbis::File* ogg_vorbis = dynamic_cast<Ogg::Vorbis::File*>(f.file()) )
680 WriteMetaToXiph( ogg_vorbis->tag(), p_item );
682 #ifdef TAGLIB_WITH_ASF
683 else if( RIFF::File* riff = dynamic_cast<RIFF::File*>(f.file()) )
685 if( RIFF::AIFF::File* riff_aiff = dynamic_cast<RIFF::AIFF::File*>(f.file()) )
686 WriteMetaToId3v2( riff_aiff->tag(), p_item );
687 else if( RIFF::WAV::File* riff_wav = dynamic_cast<RIFF::WAV::File*>(f.file()) )
688 WriteMetaToId3v2( riff_wav->tag(), p_item );
691 else if( TrueAudio::File* trueaudio = dynamic_cast<TrueAudio::File*>(f.file()) )
693 if( trueaudio->ID3v2Tag() )
694 WriteMetaToId3v2( trueaudio->ID3v2Tag(), p_item );
696 else if( WavPack::File* wavpack = dynamic_cast<WavPack::File*>(f.file()) )
698 if( wavpack->APETag() )
699 WriteMetaToAPE( wavpack->APETag(), p_item );
702 // Save the meta data