1 /*****************************************************************************
2 * id3tag.c: id3/ape tag parser/skipper based on libid3tag
3 *****************************************************************************
4 * Copyright (C) 2002-2004 the VideoLAN team
7 * Authors: Sigmund Augdal Helberg <dnumgis@videolan.org>
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.
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.
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 *****************************************************************************/
24 /*****************************************************************************
26 *****************************************************************************/
31 #include <vlc_interface.h>
32 #include <vlc_demux.h>
33 #include <vlc_playlist.h>
34 #include <vlc_charset.h>
36 #include <sys/types.h>
41 #include "id3genres.h"
43 /*****************************************************************************
45 *****************************************************************************/
46 static int ParseTags ( vlc_object_t * );
48 /*****************************************************************************
50 *****************************************************************************/
52 set_description( _("ID3v1/2 and APEv1/2 tags parser" ) );
53 set_capability( "meta reader", 70 );
54 set_callbacks( ParseTags, NULL );
57 /*****************************************************************************
58 * ParseID3Tag : parse an id3tag into the info structures
59 *****************************************************************************/
60 static void ParseID3Tag( demux_t *p_demux, uint8_t *p_data, int i_size )
62 struct id3_tag *p_id3_tag;
63 struct id3_frame *p_frame;
64 vlc_meta_t *p_meta = (vlc_meta_t *)p_demux->p_private;
67 p_id3_tag = id3_tag_parse( p_data, i_size );
72 p_demux->p_private = p_meta = vlc_meta_New();
74 #define ID_IS( a ) (!strcmp( p_frame->id, a ))
75 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
76 #define GET_STRING(frame,fidx) id3_ucs4_latin1duplicate( id3_field_getstring( &(frame)->fields[fidx] ) )
79 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "UFID", i )) != NULL; i++ )
81 const char *psz_owner = id3_field_getlatin1( &p_frame->fields[0] );
83 if( !strncmp( psz_owner, "http://musicbrainz.org", 22 ) )
85 id3_byte_t const * p_ufid;
86 id3_length_t i_ufidlen;
88 p_ufid = (id3_byte_t const *)
89 id3_field_getbinarydata(
92 char *psz_ufid = strndup( p_ufid, i_ufidlen );
94 vlc_meta_SetTrackID( p_meta, psz_ufid );
99 /* User defined text (TXXX) */
100 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "TXXX", i )) != NULL; i++ )
102 /* 3 fields: 'encoding', 'description', 'value' */
103 char *psz_name = GET_STRING( p_frame, 1 );
104 char *psz_value = GET_STRING( p_frame, 2 );
106 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
108 if( !strncmp( psz_name, "MusicBrainz Artist Id", 21 ) )
109 vlc_meta_SetArtistID( p_meta, psz_value );
110 if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
111 vlc_meta_SetAlbumID( p_meta, psz_value );
117 /* Relative volume adjustment */
118 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "RVA2", i )) != NULL; i++ )
120 /* 2 fields: 'latin1', 'binary' */
121 const char *psz_type = id3_field_getlatin1( &p_frame->fields[0] );
122 if( !strcasecmp( psz_type, "track" ) || !strcasecmp( psz_type, "album" ) ||
123 !strcasecmp( psz_type, "normalize" ) )
125 id3_byte_t const * p_data;
128 p_data = id3_field_getbinarydata( &p_frame->fields[1], &i_data );
131 const unsigned int i_peak_size = p_data[3];
132 const float f_gain = (float)GetWBE( &p_data[1] ) / 512.0;
135 if( i_data < i_peak_size + 4 )
137 /* only master volume */
138 if( p_data[0] == 0x01 )
140 snprintf( psz_value, sizeof(psz_value), "%f", f_gain );
141 if( !strcasecmp( psz_type, "album" ) )
142 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_ALBUM_GAIN", psz_value );
144 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_TRACK_GAIN", psz_value );
145 /* XXX I have no idea what peak unit is ... */
147 i_data -= 4+i_peak_size;
152 /* TODO 'RGAD' if it is used somewhere */
154 /* T--- Text informations */
155 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "T", i )) != NULL; i++ )
159 /* Special case TXXX is not the same beast */
160 if( ID_IS( "TXXX" ) )
163 i_strings = id3_field_getnstrings( &p_frame->fields[1] );
164 while( i_strings > 0 )
166 char *psz_temp = id3_ucs4_utf8duplicate(
167 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
169 if( ID_IS( ID3_FRAME_GENRE ) )
172 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
174 if( psz_temp != psz_endptr &&
175 i_genre >= 0 && i_genre < NUM_GENRES )
177 vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
182 vlc_meta_SetGenre( p_meta,psz_temp );
185 else if( ID_IS( ID3_FRAME_TITLE ) )
187 vlc_meta_SetTitle( p_meta, psz_temp );
189 else if( ID_IS( ID3_FRAME_ARTIST ) )
191 vlc_meta_SetArtist( p_meta, psz_temp );
193 else if( ID_IS( ID3_FRAME_YEAR ) )
195 vlc_meta_SetDate( p_meta, psz_temp );
197 else if( ID_IS( ID3_FRAME_COMMENT ) )
199 vlc_meta_SetDescription( p_meta, psz_temp );
201 else if( DESCR_IS( "Copyright" ) )
203 vlc_meta_SetCopyright( p_meta, psz_temp );
205 else if( DESCR_IS( "Publisher" ) )
207 vlc_meta_SetPublisher( p_meta, psz_temp );
209 else if( DESCR_IS( "Track number/position in set" ) )
211 vlc_meta_SetTracknum( p_meta, psz_temp );
213 else if( DESCR_IS( "Album/movie/show title" ) )
215 vlc_meta_SetAlbum( p_meta, psz_temp );
217 else if( DESCR_IS( "Encoded by" ) )
219 vlc_meta_SetEncodedBy( p_meta, psz_temp );
221 else if( ID_IS ( "APIC" ) )
223 msg_Dbg( p_demux, "** Has APIC **" );
225 else if( p_frame->description )
228 vlc_meta_AddExtra( p_meta, (char*)p_frame->description, psz_temp );
233 id3_tag_delete( p_id3_tag );
238 /*****************************************************************************
240 *****************************************************************************/
241 #define APE_TAG_HEADERSIZE (32)
242 static int GetAPEvXSize( const uint8_t *p_data, int i_data )
247 if( i_data < APE_TAG_HEADERSIZE ||
248 ( GetDWLE( &p_data[8] ) != 1000 && GetDWLE( &p_data[8] ) != 2000 ) || /* v1/v2 only */
249 strncmp( (char*)p_data, "APETAGEX", 8 ) ||
250 GetDWLE( &p_data[8+4+4] ) <= 0 )
253 i_body = GetDWLE( &p_data[8+4] );
254 flags = GetDWLE( &p_data[8+4+4] );
256 /* is it the header */
257 if( flags & (1<<29) )
258 return i_body + ( (flags&(1<<30)) ? APE_TAG_HEADERSIZE : 0 );
260 /* it is the footer */
261 return i_body + ( (flags&(1<<31)) ? APE_TAG_HEADERSIZE : 0 );
263 static void ParseAPEvXTag( demux_t *p_demux, uint8_t *p_data, int i_data )
265 vlc_meta_t *p_meta = (vlc_meta_t *)p_demux->p_private;
268 uint8_t *p_header = NULL;
271 if( i_data < APE_TAG_HEADERSIZE )
274 b_start = !strncmp( (char*)&p_data[0], "APETAGEX", 8 );
275 b_end = !strncmp( (char*)&p_data[i_data-APE_TAG_HEADERSIZE], "APETAGEX", 8 );
276 if( !b_end && !b_start )
281 p_header = &p_data[0];
282 p_data += APE_TAG_HEADERSIZE;
283 i_data -= APE_TAG_HEADERSIZE;
287 p_header = &p_data[i_data-APE_TAG_HEADERSIZE];
288 i_data -= APE_TAG_HEADERSIZE;
293 i_entry = GetDWLE( &p_header[8+4+4] );
298 p_demux->p_private = p_meta = vlc_meta_New();
300 while( i_entry > 0 && i_data >= 10 )
302 const int i_size = GetDWLE( &p_data[0] );
303 const uint32_t flags = GetDWLE( &p_data[4] );
307 strlcpy( psz_name, (char*)&p_data[8], sizeof(psz_name) );
308 n = strlen( psz_name );
314 if( i_data < i_size )
317 /* Retreive UTF-8 fields only */
318 if( ((flags>>1) & 0x03) == 0x00 )
320 /* FIXME list are separated by '\0' */
321 char *psz_value = strndup( (char*)&p_data[0], i_size );
323 EnsureUTF8( psz_name );
324 EnsureUTF8( psz_value );
325 #define IS(s) (!strcasecmp( psz_name, s ) )
327 vlc_meta_SetTitle( p_meta, psz_value );
328 else if( IS( "Artist" ) )
329 vlc_meta_SetArtist( p_meta, psz_value );
330 else if( IS( "Album" ) )
331 vlc_meta_SetAlbum( p_meta, psz_value );
332 else if( IS( "Publisher" ) )
333 vlc_meta_SetPublisher( p_meta, psz_value );
334 else if( IS( "Track" ) )
336 char *p = strchr( psz_value, '/' );
339 vlc_meta_SetTracknum( p_meta, psz_value );
341 else if( IS( "Comment" ) )
342 vlc_meta_SetDescription( p_meta, psz_value );
343 else if( IS( "Copyright" ) )
344 vlc_meta_SetCopyright( p_meta, psz_value );
345 else if( IS( "Year" ) )
346 vlc_meta_SetDate( p_meta, psz_value );
347 else if( IS( "Genre" ) )
348 vlc_meta_SetGenre( p_meta, psz_value );
349 else if( IS( "Language" ) )
350 vlc_meta_SetLanguage( p_meta, psz_value );
352 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
363 /*****************************************************************************
364 * CheckFooter: check for ID3/APE at the end of the file
365 * CheckHeader: check for ID3/APE at the begining of the file
366 *****************************************************************************/
367 static void CheckFooter( demux_t *p_demux )
369 const int64_t i_pos = stream_Size( p_demux->s );
370 const int i_peek = 128+APE_TAG_HEADERSIZE;
373 int64_t i_id3v2_pos = -1;
374 int64_t i_apevx_pos = -1;
381 if( stream_Seek( p_demux->s, i_pos - i_peek ) )
384 if( stream_Peek( p_demux->s, &p_peek, i_peek ) < i_peek )
386 p_peek_id3 = &p_peek[APE_TAG_HEADERSIZE];
388 /* Check/Parse ID3v1 */
389 i_id3v1_size = id3_tag_query( p_peek_id3, ID3_TAG_QUERYSIZE );
390 if( i_id3v1_size == 128 )
392 msg_Dbg( p_demux, "found ID3v1 tag" );
393 ParseID3Tag( p_demux, p_peek_id3, i_id3v1_size );
396 /* Compute ID3v2 position */
397 i_id3v2_size = -id3_tag_query( &p_peek_id3[128-ID3_TAG_QUERYSIZE], ID3_TAG_QUERYSIZE );
398 if( i_id3v2_size > 0 )
399 i_id3v2_pos = i_pos - i_id3v2_size;
401 /* Compute APE2v2 position */
402 i_apevx_size = GetAPEvXSize( &p_peek[128+0], APE_TAG_HEADERSIZE );
403 if( i_apevx_size > 0 )
405 i_apevx_pos = i_pos - i_apevx_size;
407 else if( i_id3v1_size > 0 )
409 /* it can be before ID3v1 */
410 i_apevx_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
411 if( i_apevx_size > 0 )
412 i_apevx_pos = i_pos - 128 - i_apevx_size;
415 if( i_id3v2_pos > 0 && i_apevx_pos > 0 )
418 "Both ID3v2 and APEv1/2 at the end of file, ignoring APEv1/2" );
423 if( i_id3v2_pos > 0 )
425 if( !stream_Seek( p_demux->s, i_id3v2_pos ) &&
426 stream_Peek( p_demux->s, &p_peek, i_id3v2_size ) == i_id3v2_size )
428 msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
429 ParseID3Tag( p_demux, p_peek, i_id3v2_size );
434 if( i_apevx_pos > 0 )
436 if( !stream_Seek( p_demux->s, i_apevx_pos ) &&
437 stream_Peek( p_demux->s, &p_peek, i_apevx_size ) == i_apevx_size )
439 msg_Dbg( p_demux, "found APEvx tag at end of file" );
440 ParseAPEvXTag( p_demux, p_peek, i_apevx_size );
444 static void CheckHeader( demux_t *p_demux )
449 if( stream_Seek( p_demux->s, 0 ) )
452 /* Test ID3v2 first */
453 if( stream_Peek( p_demux->s, &p_peek, ID3_TAG_QUERYSIZE ) != ID3_TAG_QUERYSIZE )
455 i_size = id3_tag_query( p_peek, ID3_TAG_QUERYSIZE );
457 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
459 msg_Dbg( p_demux, "found ID3v2 tag" );
460 ParseID3Tag( p_demux, p_peek, i_size );
465 if( stream_Peek( p_demux->s, &p_peek, APE_TAG_HEADERSIZE ) != APE_TAG_HEADERSIZE )
467 i_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
469 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
471 msg_Dbg( p_demux, "found APEv1/2 tag" );
472 ParseAPEvXTag( p_demux, p_peek, i_size );
476 /*****************************************************************************
477 * ParseTags: check if ID3/APE tags at common locations.
478 ****************************************************************************/
479 static int ParseTags( vlc_object_t *p_this )
481 demux_t *p_demux = (demux_t *)p_this;
482 vlc_bool_t b_seekable;
485 p_demux->p_private = NULL;
487 msg_Dbg( p_demux, "checking for ID3v1/2 and APEv1/2 tags" );
489 stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
493 i_init = stream_Tell( p_demux->s );
496 CheckFooter( p_demux );
499 CheckHeader( p_demux );
502 * Demuxer will not see tags at the start as src/input/demux.c skips it
505 stream_Seek( p_demux->s, i_init );