A new GUI for Maemo based on Hildon framework
[vlc.git] / modules / meta_engine / taglib.cpp
1 /*****************************************************************************
2  * taglib.cpp: Taglib tag parser/writer
3  *****************************************************************************
4  * Copyright (C) 2003-2006 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Clément Stenac <zorglub@videolan.org>
8  *          Rafaël Carré <funman@videolanorg>
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 #ifdef HAVE_CONFIG_H
26 # include "config.h"
27 #endif
28
29 #include <vlc_common.h>
30 #include <vlc_plugin.h>
31 #include <vlc_playlist.h>
32 #include <vlc_meta.h>
33 #include <vlc_demux.h>
34 #include <vlc_strings.h>
35 #include <vlc_charset.h>
36
37 #ifdef WIN32
38 # include <io.h>
39 #else
40 # include <unistd.h>
41 #endif
42
43 #include <fileref.h>
44 #include <tag.h>
45 #include <tstring.h>
46 #include <id3v2tag.h>
47 #include <textidentificationframe.h>
48 #include <tbytevector.h>
49 #include <mpegfile.h>
50 #include <attachedpictureframe.h>
51 //#include <oggflacfile.h> /* ogg flac files aren't auto-casted by TagLib */
52 #include <flacfile.h>
53 #include <flacproperties.h>
54 #include <vorbisfile.h>
55 #include <vorbisproperties.h>
56 #include <xiphcomment.h>
57 #include <uniquefileidentifierframe.h>
58 #include <textidentificationframe.h>
59 //#include <relativevolumeframe.h> /* parse the tags without TagLib helpers? */
60
61 static int  ReadMeta    ( vlc_object_t * );
62 static int  DownloadArt ( vlc_object_t * );
63 static int  WriteMeta   ( vlc_object_t * );
64
65 vlc_module_begin ()
66     set_capability( "meta reader", 1000 )
67     set_callbacks( ReadMeta, NULL )
68     add_submodule ()
69         set_capability( "art downloader", 50 )
70         set_callbacks( DownloadArt, NULL )
71     add_submodule ()
72         set_capability( "meta writer", 50 )
73         set_callbacks( WriteMeta, NULL )
74 vlc_module_end ()
75
76 using namespace TagLib;
77
78 /* Try detecting embedded art */
79 static void DetectImage( FileRef f, demux_t *p_demux )
80 {
81     demux_meta_t        *p_demux_meta   = (demux_meta_t *)p_demux->p_private;
82     vlc_meta_t          *p_meta         = p_demux_meta->p_meta;
83     int                 i_score         = -1;
84
85     /* Preferred type of image
86      * The 21 types are defined in id3v2 standard:
87      * http://www.id3.org/id3v2.4.0-frames */
88     static const int pi_cover_score[] = {
89         0,  /* Other */
90         5,  /* 32x32 PNG image that should be used as the file icon */
91         4,  /* File icon of a different size or format. */
92         20, /* Front cover image of the album. */
93         19, /* Back cover image of the album. */
94         13, /* Inside leaflet page of the album. */
95         18, /* Image from the album itself. */
96         17, /* Picture of the lead artist or soloist. */
97         16, /* Picture of the artist or performer. */
98         14, /* Picture of the conductor. */
99         15, /* Picture of the band or orchestra. */
100         9,  /* Picture of the composer. */
101         8,  /* Picture of the lyricist or text writer. */
102         7,  /* Picture of the recording location or studio. */
103         10, /* Picture of the artists during recording. */
104         11, /* Picture of the artists during performance. */
105         6,  /* Picture from a movie or video related to the track. */
106         1,  /* Picture of a large, coloured fish. */
107         12, /* Illustration related to the track. */
108         3,  /* Logo of the band or performer. */
109         2   /* Logo of the publisher (record company). */
110     };
111
112     if( MPEG::File *mpeg = dynamic_cast<MPEG::File *>(f.file() ) )
113     {
114         ID3v2::Tag  *p_tag = mpeg->ID3v2Tag();
115         if( !p_tag )
116             return;
117         ID3v2::FrameList list = p_tag->frameListMap()[ "APIC" ];
118         if( list.isEmpty() )
119             return;
120         ID3v2::AttachedPictureFrame *p_apic;
121
122         TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
123         for( ID3v2::FrameList::Iterator iter = list.begin();
124                 iter != list.end(); iter++ )
125         {
126             p_apic = dynamic_cast<ID3v2::AttachedPictureFrame*>(*iter);
127             input_attachment_t *p_attachment;
128
129             const char *psz_name, *psz_mime, *psz_description;
130             ByteVector p_data_taglib; const char *p_data; int i_data;
131
132             psz_mime = p_apic->mimeType().toCString(true);
133             psz_description = psz_name = p_apic->description().toCString(true);
134
135             /* some old iTunes version not only sets incorrectly the mime type
136              * or the description of the image,
137              * but also embeds incorrectly the image.
138              * Recent versions seem to behave correctly */
139             if( !strncmp( psz_mime, "PNG", 3 ) ||
140                 !strncmp( psz_name, "\xC2\x89PNG", 5 ) )
141             {
142                 msg_Warn( p_demux,
143                     "%s: Invalid picture embedded by broken iTunes version, "
144                     "you really shouldn't use this crappy software.",
145                     (const char *)f.file()->name() );
146                 break;
147             }
148
149             p_data_taglib = p_apic->picture();
150             p_data = p_data_taglib.data();
151             i_data = p_data_taglib.size();
152
153             msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
154                     psz_name, psz_mime, i_data );
155
156             p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
157                     psz_description, p_data, i_data );
158             TAB_APPEND_CAST( (input_attachment_t**),
159                     p_demux_meta->i_attachments, p_demux_meta->attachments,
160                     p_attachment );
161
162             if( pi_cover_score[p_apic->type()] > i_score )
163             {
164                 i_score = pi_cover_score[p_apic->type()];
165                 char *psz_url;
166                 if( asprintf( &psz_url, "attachment://%s",
167                         p_attachment->psz_name ) == -1 )
168                     return;
169                 vlc_meta_SetArtURL( p_meta, psz_url );
170                 free( psz_url );
171             }
172         }
173     }
174     else
175     if( Ogg::Vorbis::File *oggv = dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
176     {
177         Ogg::XiphComment *p_tag = oggv->tag();
178         if( !p_tag )
179             return;
180
181         StringList mime_list = p_tag->fieldListMap()[ "COVERARTMIME" ];
182         StringList art_list = p_tag->fieldListMap()[ "COVERART" ];
183
184         /* we support only one cover in ogg/vorbis */
185         if( mime_list.size() != 1 || art_list.size() != 1 )
186             return;
187
188         input_attachment_t *p_attachment;
189
190         const char *psz_name, *psz_mime, *psz_description;
191         uint8_t *p_data;
192         int i_data;
193
194         psz_name = "cover";
195         psz_mime = mime_list[0].toCString(true);
196         psz_description = "cover";
197
198         i_data = vlc_b64_decode_binary( &p_data, art_list[0].toCString(true) );
199
200         msg_Dbg( p_demux, "Found embedded art: %s (%s) is %i bytes",
201                     psz_name, psz_mime, i_data );
202
203         TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
204         p_attachment = vlc_input_attachment_New( psz_name, psz_mime,
205                 psz_description, p_data, i_data );
206         free( p_data );
207
208         TAB_APPEND_CAST( (input_attachment_t**),
209                 p_demux_meta->i_attachments, p_demux_meta->attachments,
210                 p_attachment );
211
212         vlc_meta_SetArtURL( p_meta, "attachment://cover" );
213     }
214
215 #if 0
216     //flac embedded images are extracted in the flac demuxer
217     else if( FLAC::File *flac =
218              dynamic_cast<FLAC::File *>(f.file() ) )
219     {
220         p_tag = flac->ID3v2Tag();
221         if( p_tag )
222             return;
223         ID3v2::FrameList l = p_tag->frameListMap()[ "APIC" ];
224         if( l.isEmpty() )
225             return;
226             vlc_meta_SetArtURL( p_meta, "APIC" );
227     }
228 #endif
229 #if 0
230 /* TagLib doesn't support MP4 file yet */
231     else if( MP4::File *mp4 =
232                dynamic_cast<MP4::File *>( f.file() ) )
233     {
234         MP4::Tag *mp4tag =
235                 dynamic_cast<MP4::Tag *>( mp4->tag() );
236         if( mp4tag && mp4tag->cover().size() )
237             vlc_meta_SetArtURL( p_meta, "MP4C" );
238     }
239 #endif
240 }
241
242 static int ReadMeta( vlc_object_t *p_this )
243 {
244     demux_t         *p_demux = (demux_t *)p_this;
245     demux_meta_t    *p_demux_meta = (demux_meta_t*)p_demux->p_private;
246     vlc_meta_t      *p_meta;
247     TagLib::FileRef  f;
248
249     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
250     p_demux_meta->p_meta = NULL;
251
252 #if defined(WIN32) || defined (UNDER_CE)
253     if(GetVersion() < 0x80000000)
254     {
255         wchar_t wpath[MAX_PATH + 1];
256         if( !MultiByteToWideChar( CP_UTF8, 0, p_demux->psz_path, -1, wpath, MAX_PATH) )
257             return VLC_EGENERIC;
258
259         wpath[MAX_PATH] = L'0';
260         f = FileRef( wpath );
261     }
262     else return VLC_EGENERIC;
263 #else
264     const char *local_name = ToLocale( p_demux->psz_path );
265
266     if( local_name == NULL )
267         return VLC_EGENERIC;
268
269     f = FileRef( local_name );
270     LocaleFree( local_name );
271 #endif
272
273     if( f.isNull() )
274         return VLC_EGENERIC;
275
276     if ( !f.tag() || f.tag()->isEmpty() )
277         return VLC_EGENERIC;
278
279     p_demux_meta->p_meta = p_meta = vlc_meta_New();
280     Tag *p_tag = f.tag();
281
282     if( MPEG::File *p_mpeg =
283         dynamic_cast<MPEG::File *>(f.file() ) )
284     {
285         if( p_mpeg->ID3v2Tag() )
286         {
287             ID3v2::Tag *p_tag = p_mpeg->ID3v2Tag();
288             ID3v2::FrameList list = p_tag->frameListMap()["UFID"];
289             ID3v2::UniqueFileIdentifierFrame* p_ufid;
290             for( ID3v2::FrameList::Iterator iter = list.begin();
291                     iter != list.end(); iter++ )
292             {
293                 p_ufid = dynamic_cast<ID3v2::UniqueFileIdentifierFrame*>(*iter);
294                 const char *owner = p_ufid->owner().toCString();
295                 if (!strcmp( owner, "http://musicbrainz.org" ))
296                 {
297                     /* ID3v2 UFID contains up to 64 bytes binary data
298                         * but in our case it will be a '\0'
299                         * terminated string */
300                     char *psz_ufid = (char*) malloc( 64 );
301                     int j = 0;
302                     if( psz_ufid )
303                     {
304                         while( ( j < 63 ) &&
305                                ( j < p_ufid->identifier().size() ) )
306                             psz_ufid[j] = p_ufid->identifier()[j++];
307                         psz_ufid[j] = '\0';
308                         vlc_meta_SetTrackID( p_meta, psz_ufid );
309                         free( psz_ufid );
310                     }
311                 }
312             }
313
314             list = p_tag->frameListMap()["TXXX"];
315             ID3v2::UserTextIdentificationFrame* p_txxx;
316             for( ID3v2::FrameList::Iterator iter = list.begin();
317                     iter != list.end(); iter++ )
318             {
319                 p_txxx = dynamic_cast<ID3v2::UserTextIdentificationFrame*>(*iter);
320                 const char *psz_desc= p_txxx->description().toCString();
321                 vlc_meta_AddExtra( p_meta, psz_desc,
322                             p_txxx->fieldList().toString().toCString());
323             }
324 #if 0
325             list = p_tag->frameListMap()["RVA2"];
326             ID3v2::RelativeVolumeFrame* p_rva2;
327             for( ID3v2::FrameList::Iterator iter = list.begin();
328                     iter != list.end(); iter++ )
329             {
330                 p_rva2 = dynamic_cast<ID3v2::RelativeVolumeFrame*>(*iter);
331                 /* TODO: process rva2 frames */
332             }
333 #endif
334             list = p_tag->frameList();
335             ID3v2::Frame* p_t;
336             char psz_tag[4];
337             for( ID3v2::FrameList::Iterator iter = list.begin();
338                     iter != list.end(); iter++ )
339             {
340                 p_t = dynamic_cast<ID3v2::Frame*> (*iter);
341                 memcpy( psz_tag, p_t->frameID().data(), 4);
342
343 #define SET( foo, bar ) if( !strncmp( psz_tag, foo, 4 ) ) \
344 vlc_meta_Set##bar( p_meta, p_t->toString().toCString(true))
345                 SET( "TPUB", Publisher );
346                 SET( "TCOP", Copyright );
347                 SET( "TENC", EncodedBy );
348                 SET( "TLAN", Language );
349                 //SET( "POPM", Rating ); /* rating needs special handling in id3v2 */
350                 //if( !strncmp( psz_tag, "RVA2", 4 ) )
351                     /* TODO */
352 #undef SET
353             }
354         }
355     }
356
357     else if( Ogg::Vorbis::File *p_ogg_v =
358         dynamic_cast<Ogg::Vorbis::File *>(f.file() ) )
359     {
360         int i_ogg_v_length = p_ogg_v->audioProperties()->length();
361
362         input_thread_t *p_input = (input_thread_t *)
363                 vlc_object_find( p_demux,VLC_OBJECT_INPUT, FIND_PARENT );
364         if( p_input )
365         {
366             input_item_t *p_item = input_GetItem( p_input );
367             if( p_item )
368                 input_item_SetDuration( p_item,
369                         (mtime_t) i_ogg_v_length * 1000000 );
370             vlc_object_release( p_input );
371         }
372
373     }
374 #if 0 /* at this moment, taglib is unable to detect ogg/flac files
375 * becauses type detection is based on file extension:
376 * ogg = ogg/vorbis
377 * flac = flac
378 * ø = ogg/flac
379 */
380     else if( Ogg::FLAC::File *p_ogg_f =
381         dynamic_cast<Ogg::FLAC::File *>(f.file() ) )
382     {
383         long i_ogg_f_length = p_ogg_f->streamLength();
384         input_thread_t *p_input = (input_thread_t *)
385                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
386         if( p_input )
387         {
388             input_item_t *p_item = input_GetItem( p_input );
389             if( p_item )
390                 input_item_SetDuration( p_item,
391                         (mtime_t) i_ogg_f_length * 1000000 );
392             vlc_object_release( p_input );
393         }
394     }
395 #endif
396     else if( FLAC::File *p_flac =
397         dynamic_cast<FLAC::File *>(f.file() ) )
398     {
399         long i_flac_length = p_flac->audioProperties()->length();
400         input_thread_t *p_input = (input_thread_t *)
401                 vlc_object_find( p_demux, VLC_OBJECT_INPUT, FIND_PARENT );
402         if( p_input )
403         {
404             input_item_t *p_item = input_GetItem( p_input );
405             if( p_item )
406                 input_item_SetDuration( p_item,
407                         (mtime_t) i_flac_length * 1000000 );
408             vlc_object_release( p_input );
409         }
410     }
411
412 #define SET( foo, bar ) if( !p_tag->bar ().isNull() && !p_tag->bar ().isEmpty() ) \
413         vlc_meta_Set##foo( p_meta, p_tag->bar ().toCString(true))
414 #define SETINT( foo, bar ) { \
415         char psz_tmp[10]; \
416         snprintf( (char*)psz_tmp, 10, "%d", p_tag->bar() ); \
417         vlc_meta_Set##foo( p_meta, (char*)psz_tmp ); \
418     }
419
420     SET( Title, title );
421     SET( Artist, artist );
422     SET( Album, album );
423     SET( Description, comment );
424     SET( Genre, genre );
425     SETINT( Date, year );
426     SETINT( Tracknum , track );
427 #undef SET
428 #undef SETINT
429
430     DetectImage( f, p_demux );
431
432     return VLC_SUCCESS;
433 }
434
435 static int WriteMeta( vlc_object_t *p_this )
436 {
437     playlist_t *p_playlist = (playlist_t *)p_this;
438     meta_export_t *p_export = (meta_export_t *)p_playlist->p_private;
439     input_item_t *p_item = p_export->p_item;
440
441     if( p_item == NULL )
442     {
443         msg_Err( p_this, "Can't save meta data of an empty input" );
444         return VLC_EGENERIC;
445     }
446
447     FileRef f( p_export->psz_file );
448     if( f.isNull() || !f.tag() || f.file()->readOnly() )
449     {
450         msg_Err( p_this, "File %s can't be opened for tag writing\n",
451             p_export->psz_file );
452         return VLC_EGENERIC;
453     }
454
455     msg_Dbg( p_this, "Writing metadata for %s", p_export->psz_file );
456
457     Tag *p_tag = f.tag();
458
459     char *psz_meta;
460
461 #define SET(a,b) \
462         if(b) { \
463             String *psz_##a = new String( b, \
464                 String::UTF8 ); \
465             p_tag->set##a( *psz_##a ); \
466             delete psz_##a; \
467         }
468
469
470     psz_meta = input_item_GetArtist( p_item );
471     SET( Artist, psz_meta );
472     free( psz_meta );
473
474     psz_meta = input_item_GetTitle( p_item );
475     if( !psz_meta ) psz_meta = input_item_GetName( p_item );
476     String *psz_title = new String( psz_meta,
477         String::UTF8 );
478     p_tag->setTitle( *psz_title );
479     delete psz_title;
480     free( psz_meta );
481
482     psz_meta = input_item_GetAlbum( p_item );
483     SET( Album, psz_meta );
484     free( psz_meta );
485
486     psz_meta = input_item_GetGenre( p_item );
487     SET( Genre, psz_meta );
488     free( psz_meta );
489
490 #undef SET
491
492     psz_meta = input_item_GetDate( p_item );
493     if( psz_meta ) p_tag->setYear( atoi( psz_meta ) );
494     free( psz_meta );
495
496     psz_meta = input_item_GetTrackNum( p_item );
497     if( psz_meta ) p_tag->setTrack( atoi( psz_meta ) );
498     free( psz_meta );
499
500     if( ID3v2::Tag *p_id3tag =
501         dynamic_cast<ID3v2::Tag *>(p_tag) )
502     {
503 #define WRITE( foo, bar ) \
504         psz_meta = input_item_Get##foo( p_item ); \
505         if( psz_meta ) \
506         { \
507             ByteVector p_byte( bar, 4 ); \
508             ID3v2::TextIdentificationFrame p_frame( p_byte ); \
509             p_frame.setText( psz_meta ); \
510             p_id3tag->addFrame( &p_frame ); \
511             free( psz_meta ); \
512         } \
513
514         WRITE( Publisher, "TPUB" );
515         WRITE( Copyright, "TCOP" );
516         WRITE( EncodedBy, "TENC" );
517         WRITE( Language, "TLAN" );
518
519 #undef WRITE
520     }
521
522     f.save();
523     return VLC_SUCCESS;
524 }
525
526 static int DownloadArt( vlc_object_t *p_this )
527 {
528     /* We need to be passed the file name
529      * Fetch the thing from the file, save it to the cache folder
530      */
531     return VLC_EGENERIC;
532 }
533