Build VLC aliases cleanly (don't need to parse argv[0])
[vlc.git] / modules / meta_engine / id3tag.c
1 /*****************************************************************************
2  * id3tag.c: id3/ape tag parser/skipper based on libid3tag
3  *****************************************************************************
4  * Copyright (C) 2002-2004 the VideoLAN team
5  * $Id$
6  *
7  * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
8  *
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22  *****************************************************************************/
23
24 /*****************************************************************************
25  * Preamble
26  *****************************************************************************/
27 #include <config.h>
28
29
30 #include <vlc/vlc.h>
31 #include <vlc_interface.h>
32 #include <vlc_demux.h>
33 #include <vlc_playlist.h>
34 #include <vlc_charset.h>
35
36 #include <sys/types.h>
37
38 #include <vlc_meta.h>
39
40 #include <id3tag.h>
41 #include "id3genres.h"
42
43 /*****************************************************************************
44  * Local prototypes
45  *****************************************************************************/
46 static int  ParseTags ( vlc_object_t * );
47
48 /*****************************************************************************
49  * Module descriptor
50  *****************************************************************************/
51 vlc_module_begin();
52     set_description( _("ID3v1/2 and APEv1/2 tags parser" ) );
53     set_capability( "meta reader", 70 );
54     set_callbacks( ParseTags, NULL );
55 vlc_module_end();
56
57 /*****************************************************************************
58  * ParseID3Tag : parse an id3tag into the info structures
59  *****************************************************************************/
60 static void ParseID3Tag( demux_t *p_demux, const uint8_t *p_data, int i_size )
61 {
62     struct id3_tag   *p_id3_tag;
63     struct id3_frame *p_frame;
64     demux_meta_t     *p_demux_meta = (demux_meta_t*)p_demux->p_private;
65     vlc_meta_t       *p_meta;
66     int i;
67
68     p_id3_tag = id3_tag_parse( p_data, i_size );
69     if( !p_id3_tag )
70         return;
71
72     if( !p_demux_meta->p_meta )
73         p_demux_meta->p_meta = vlc_meta_New();
74     p_meta = p_demux_meta->p_meta;
75
76 #define ID_IS( a ) (!strcmp(  p_frame->id, a ))
77 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
78 #define GET_STRING(frame,fidx) id3_ucs4_latin1duplicate( id3_field_getstring( &(frame)->fields[fidx] ) )
79
80     /* */
81     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "UFID", i )) != NULL; i++ )
82     {
83         const char *psz_owner = id3_field_getlatin1( &p_frame->fields[0] );
84
85         if( !strncmp( psz_owner, "http://musicbrainz.org", 22 ) )
86         {
87             id3_byte_t const * p_ufid;
88             id3_length_t i_ufidlen;
89
90             p_ufid = (id3_byte_t const *)
91                         id3_field_getbinarydata(
92                                 &p_frame->fields[1],
93                                 &i_ufidlen );
94             char *psz_ufid = strndup( p_ufid, i_ufidlen );
95
96             vlc_meta_SetTrackID( p_meta, psz_ufid );
97             free( psz_ufid );
98         }
99     }
100
101     /* User defined text (TXXX) */
102     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "TXXX", i )) != NULL; i++ )
103     {
104         /* 3 fields: 'encoding', 'description', 'value' */
105         char *psz_name = GET_STRING( p_frame, 1 );
106         char *psz_value = GET_STRING( p_frame, 2 );
107
108         vlc_meta_AddExtra( p_meta, psz_name, psz_value );
109 #if 0
110         if( !strncmp( psz_name, "MusicBrainz Artist Id", 21 ) )
111             vlc_meta_SetArtistID( p_meta, psz_value );
112         if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
113             vlc_meta_SetAlbumID( p_meta, psz_value );
114 #endif
115         free( psz_name );
116         free( psz_value );
117     }
118
119     /* Relative volume adjustment */
120     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "RVA2", i )) != NULL; i++ )
121     {
122         /* 2 fields: 'latin1', 'binary' */
123         const char *psz_type = id3_field_getlatin1( &p_frame->fields[0] );
124         if( !strcasecmp( psz_type, "track" ) || !strcasecmp( psz_type, "album" ) ||
125             !strcasecmp( psz_type, "normalize" ) )
126         {
127             id3_byte_t const * p_data;
128             id3_length_t i_data;
129
130             p_data = id3_field_getbinarydata( &p_frame->fields[1], &i_data );
131             while( i_data >= 4 )
132             {
133                 const unsigned int i_peak_size = p_data[3];
134                 const float f_gain = (float)GetWBE( &p_data[1] ) / 512.0;
135                 char psz_value[32];
136
137                 if( i_data < i_peak_size + 4 )
138                     break;
139                 /* only master volume */
140                 if( p_data[0] == 0x01 )
141                 {
142                     snprintf( psz_value, sizeof(psz_value), "%f", f_gain );
143                     if( !strcasecmp( psz_type, "album" ) )
144                         vlc_meta_AddExtra( p_meta, "REPLAYGAIN_ALBUM_GAIN", psz_value );
145                     else
146                         vlc_meta_AddExtra( p_meta, "REPLAYGAIN_TRACK_GAIN", psz_value );
147                     /* XXX I have no idea what peak unit is ... */
148                 }
149                 i_data -= 4+i_peak_size;
150             }
151         }
152     }
153
154     /* TODO 'RGAD' if it is used somewhere */
155
156     /* T--- Text informations */
157     for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "T", i )) != NULL; i++ )
158     {
159         int i_strings;
160  
161         /* Special case TXXX is not the same beast */
162         if( ID_IS( "TXXX" ) )
163             continue;
164
165         i_strings = id3_field_getnstrings( &p_frame->fields[1] );
166         while( i_strings > 0 )
167         {
168             char *psz_temp = id3_ucs4_utf8duplicate(
169                 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
170
171             if( ID_IS( ID3_FRAME_GENRE ) )
172             {
173                 char *psz_endptr;
174                 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
175
176                 if( psz_temp != psz_endptr &&
177                     i_genre >= 0 && i_genre < NUM_GENRES )
178                 {
179                     vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
180                 }
181                 else
182                 {
183                     /* Unknown genre */
184                     vlc_meta_SetGenre( p_meta,psz_temp );
185                 }
186             }
187             else if( ID_IS( ID3_FRAME_TITLE ) )
188             {
189                 vlc_meta_SetTitle( p_meta, psz_temp );
190             }
191             else if( ID_IS( ID3_FRAME_ARTIST ) )
192             {
193                 vlc_meta_SetArtist( p_meta, psz_temp );
194             }
195             else if( ID_IS( ID3_FRAME_YEAR ) )
196             {
197                 vlc_meta_SetDate( p_meta, psz_temp );
198             }
199             else if( ID_IS( ID3_FRAME_COMMENT ) )
200             {
201                 vlc_meta_SetDescription( p_meta, psz_temp );
202             }
203             else if( DESCR_IS( "Copyright" ) )
204             {
205                 vlc_meta_SetCopyright( p_meta, psz_temp );
206             }
207             else if( DESCR_IS( "Publisher" ) )
208             {
209                 vlc_meta_SetPublisher( p_meta, psz_temp );
210             }
211             else if( DESCR_IS( "Track number/position in set" ) )
212             {
213                 vlc_meta_SetTracknum( p_meta, psz_temp );
214             }
215             else if( DESCR_IS( "Album/movie/show title" ) )
216             {
217                 vlc_meta_SetAlbum( p_meta, psz_temp );
218             }
219             else if( DESCR_IS( "Encoded by" ) )
220             {
221                 vlc_meta_SetEncodedBy( p_meta, psz_temp );
222             }
223             else if( ID_IS ( "APIC" ) )
224             {
225                 msg_Dbg( p_demux, "** Has APIC **" );
226             }
227             else if( p_frame->description )
228             {
229                 /* Unhandled meta */
230                 vlc_meta_AddExtra( p_meta, (char*)p_frame->description, psz_temp );
231             }
232             free( psz_temp );
233         }
234     }
235     id3_tag_delete( p_id3_tag );
236 #undef GET_STRING
237 #undef DESCR_IS
238 #undef ID_IS
239 }
240 /*****************************************************************************
241  * APEv1/2
242  *****************************************************************************/
243 #define APE_TAG_HEADERSIZE (32)
244 static int GetAPEvXSize( const uint8_t *p_data, int i_data )
245 {
246     uint32_t flags;
247     int i_body;
248
249     if( i_data < APE_TAG_HEADERSIZE ||
250         ( GetDWLE( &p_data[8] ) != 1000 && GetDWLE( &p_data[8] ) != 2000 ) || /* v1/v2 only */
251         strncmp( (char*)p_data, "APETAGEX", 8 ) ||
252         GetDWLE( &p_data[8+4+4] ) <= 0 )
253         return 0;
254
255     i_body = GetDWLE( &p_data[8+4] );
256     flags = GetDWLE( &p_data[8+4+4] );
257
258     /* is it the header */
259     if( flags & (1<<29) )
260         return i_body + ( (flags&(1<<30)) ? APE_TAG_HEADERSIZE : 0 );
261
262     /* it is the footer */
263     return i_body + ( (flags&(1<<31)) ? APE_TAG_HEADERSIZE : 0 );
264 }
265 static void ParseAPEvXTag( demux_t *p_demux, const uint8_t *p_data, int i_data )
266 {
267     demux_meta_t     *p_demux_meta = (demux_meta_t*)p_demux->p_private;
268     vlc_meta_t       *p_meta;
269     vlc_bool_t b_start;
270     vlc_bool_t b_end;
271     const uint8_t *p_header = NULL;
272     int i_entry;
273
274     if( i_data < APE_TAG_HEADERSIZE )
275         return;
276
277     b_start = !strncmp( (char*)&p_data[0], "APETAGEX", 8 );
278     b_end = !strncmp( (char*)&p_data[i_data-APE_TAG_HEADERSIZE], "APETAGEX", 8 );
279     if( !b_end && !b_start )
280         return;
281
282     if( !p_demux_meta->p_meta )
283         p_demux_meta->p_meta = vlc_meta_New();
284     p_meta = p_demux_meta->p_meta;
285
286     if( b_start )
287     {
288         p_header = &p_data[0];
289         p_data += APE_TAG_HEADERSIZE;
290         i_data -= APE_TAG_HEADERSIZE;
291     }
292     if( b_end )
293     {
294         p_header = &p_data[i_data-APE_TAG_HEADERSIZE];
295         i_data -= APE_TAG_HEADERSIZE;
296     }
297     if( i_data <= 0 )
298         return;
299
300     i_entry = GetDWLE( &p_header[8+4+4] );
301     if( i_entry <= 0 )
302         return;
303
304     while( i_entry > 0 && i_data >= 10 )
305     {
306         const int i_size = GetDWLE( &p_data[0] );
307         const uint32_t flags = GetDWLE( &p_data[4] );
308         char psz_name[256];
309         int n;
310
311         strlcpy( psz_name, (char*)&p_data[8], sizeof(psz_name) );
312         n = strlen( psz_name );
313         if( n <= 0 )
314             break;
315
316         p_data += 8+n+1;
317         i_data -= 8+n+1;
318         if( i_data < i_size )
319             break;
320
321         /* Retreive UTF-8 fields only */
322         if( ((flags>>1) & 0x03) == 0x00 )
323         {
324             /* FIXME list are separated by '\0' */
325             char *psz_value = strndup( (char*)&p_data[0], i_size );
326
327             EnsureUTF8( psz_name );
328             EnsureUTF8( psz_value );
329 #define IS(s) (!strcasecmp( psz_name, s ) )
330             if( IS( "Title" ) )
331                 vlc_meta_SetTitle( p_meta, psz_value );
332             else  if( IS( "Artist" ) )
333                 vlc_meta_SetArtist( p_meta, psz_value );
334             else  if( IS( "Album" ) )
335                 vlc_meta_SetAlbum( p_meta, psz_value );
336             else  if( IS( "Publisher" ) )
337                 vlc_meta_SetPublisher( p_meta, psz_value );
338             else  if( IS( "Track" ) )
339             {
340                 char *p = strchr( psz_value, '/' );
341                 if( p )
342                     *p++ = '\0';
343                 vlc_meta_SetTracknum( p_meta, psz_value );
344             }
345             else  if( IS( "Comment" ) )
346                 vlc_meta_SetDescription( p_meta, psz_value );
347             else  if( IS( "Copyright" ) )
348                 vlc_meta_SetCopyright( p_meta, psz_value );
349             else  if( IS( "Year" ) )
350                 vlc_meta_SetDate( p_meta, psz_value );
351             else  if( IS( "Genre" ) )
352                 vlc_meta_SetGenre( p_meta, psz_value );
353             else  if( IS( "Language" ) )
354                 vlc_meta_SetLanguage( p_meta, psz_value );
355             else
356                 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
357 #undef IS
358             free( psz_value );
359         }
360
361         p_data += i_size;
362         i_data -= i_size;
363         i_entry--;
364     }
365 }
366
367 /*****************************************************************************
368  * CheckFooter: check for ID3/APE at the end of the file
369  * CheckHeader: check for ID3/APE at the begining of the file
370  *****************************************************************************/
371 static void CheckFooter( demux_t *p_demux )
372 {
373     const int64_t i_pos = stream_Size( p_demux->s );
374     const int i_peek = 128+APE_TAG_HEADERSIZE;
375     const uint8_t *p_peek;
376     const uint8_t *p_peek_id3;
377     int64_t i_id3v2_pos = -1;
378     int64_t i_apevx_pos = -1;
379     int i_id3v2_size;
380     int i_apevx_size;
381     int i_id3v1_size;
382
383     if( i_pos < i_peek )
384         return;
385     if( stream_Seek( p_demux->s, i_pos - i_peek ) )
386         return;
387
388     if( stream_Peek( p_demux->s, &p_peek, i_peek ) < i_peek )
389         return;
390     p_peek_id3 = &p_peek[APE_TAG_HEADERSIZE];
391
392     /* Check/Parse ID3v1 */
393     i_id3v1_size = id3_tag_query( p_peek_id3, ID3_TAG_QUERYSIZE );
394     if( i_id3v1_size == 128 )
395     {
396         msg_Dbg( p_demux, "found ID3v1 tag" );
397         ParseID3Tag( p_demux, p_peek_id3, i_id3v1_size );
398     }
399
400     /* Compute ID3v2 position */
401     i_id3v2_size = -id3_tag_query( &p_peek_id3[128-ID3_TAG_QUERYSIZE], ID3_TAG_QUERYSIZE );
402     if( i_id3v2_size > 0 )
403         i_id3v2_pos = i_pos - i_id3v2_size;
404
405     /* Compute APE2v2 position */
406     i_apevx_size = GetAPEvXSize( &p_peek[128+0], APE_TAG_HEADERSIZE );
407     if( i_apevx_size > 0 )
408     {
409         i_apevx_pos = i_pos - i_apevx_size;
410     }
411     else if( i_id3v1_size > 0 )
412     {
413         /* it can be before ID3v1 */
414         i_apevx_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
415         if( i_apevx_size > 0 )
416             i_apevx_pos = i_pos - 128 - i_apevx_size;
417     }
418
419     if( i_id3v2_pos > 0 && i_apevx_pos > 0 )
420     {
421         msg_Warn( p_demux,
422                   "Both ID3v2 and APEv1/2 at the end of file, ignoring APEv1/2" );
423         i_apevx_pos = -1;
424     }
425
426     /* Parse ID3v2.4 */
427     if( i_id3v2_pos > 0 )
428     {
429         if( !stream_Seek( p_demux->s, i_id3v2_pos ) &&
430             stream_Peek( p_demux->s, &p_peek, i_id3v2_size ) == i_id3v2_size )
431         {
432             msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
433             ParseID3Tag( p_demux, p_peek, i_id3v2_size );
434         }
435     }
436
437     /* Parse APEv1/2 */
438     if( i_apevx_pos > 0 )
439     {
440         if( !stream_Seek( p_demux->s, i_apevx_pos ) &&
441             stream_Peek( p_demux->s, &p_peek, i_apevx_size ) == i_apevx_size )
442         {
443             msg_Dbg( p_demux, "found APEvx tag at end of file" );
444             ParseAPEvXTag( p_demux, p_peek, i_apevx_size );
445         }
446     }
447 }
448 static void CheckHeader( demux_t *p_demux )
449 {
450     const uint8_t *p_peek;
451     int i_size;
452
453     if( stream_Seek( p_demux->s, 0 ) )
454         return;
455
456     /* Test ID3v2 first */
457     if( stream_Peek( p_demux->s, &p_peek, ID3_TAG_QUERYSIZE ) != ID3_TAG_QUERYSIZE )
458         return;
459     i_size = id3_tag_query( p_peek, ID3_TAG_QUERYSIZE );
460     if( i_size > 0 &&
461         stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
462     {
463         msg_Dbg( p_demux, "found ID3v2 tag" );
464         ParseID3Tag( p_demux, p_peek, i_size );
465         return;
466     }
467
468     /* Test APEv1 */
469     if( stream_Peek( p_demux->s, &p_peek, APE_TAG_HEADERSIZE ) != APE_TAG_HEADERSIZE )
470         return;
471     i_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
472     if( i_size > 0 &&
473         stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
474     {
475         msg_Dbg( p_demux, "found APEv1/2 tag" );
476         ParseAPEvXTag( p_demux, p_peek, i_size );
477     }
478 }
479
480 /*****************************************************************************
481  * ParseTags: check if ID3/APE tags at common locations.
482  ****************************************************************************/
483 static int ParseTags( vlc_object_t *p_this )
484 {
485     demux_t      *p_demux = (demux_t *)p_this;
486     demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
487     vlc_bool_t    b_seekable;
488     int64_t       i_init;
489
490     msg_Dbg( p_demux, "checking for ID3v1/2 and APEv1/2 tags" );
491     stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
492     if( !b_seekable )
493         return VLC_EGENERIC;
494
495     i_init = stream_Tell( p_demux->s );
496
497     TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
498     p_demux_meta->p_meta = NULL;
499
500     /* */
501     CheckFooter( p_demux );
502
503     /* */
504     CheckHeader( p_demux );
505
506     /* Restore position
507      *  Demuxer will not see tags at the start as src/input/demux.c skips it
508      *  for them
509      */
510     stream_Seek( p_demux->s, i_init );
511     if( !p_demux_meta->p_meta && p_demux_meta->i_attachments <= 0 )
512         return VLC_EGENERIC;
513     return VLC_SUCCESS;
514 }
515