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 *****************************************************************************/
34 #include <vlc_common.h>
35 #include <vlc_plugin.h>
36 #include <vlc_interface.h>
37 #include <vlc_demux.h>
38 #include <vlc_playlist.h>
39 #include <vlc_charset.h>
41 #include <sys/types.h>
46 #include "id3genres.h"
48 /*****************************************************************************
50 *****************************************************************************/
51 static int ParseTags ( vlc_object_t * );
53 /*****************************************************************************
55 *****************************************************************************/
57 set_description( N_("ID3v1/2 and APEv1/2 tags parser" ) )
58 set_capability( "meta reader", 70 )
59 set_callbacks( ParseTags, NULL )
62 /*****************************************************************************
63 * ParseID3Tag : parse an id3tag into the info structures
64 *****************************************************************************/
65 static void ParseID3Tag( demux_t *p_demux, const uint8_t *p_data, int i_size )
67 struct id3_tag *p_id3_tag;
68 struct id3_frame *p_frame;
69 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
73 p_id3_tag = id3_tag_parse( p_data, i_size );
77 if( !p_demux_meta->p_meta )
78 p_demux_meta->p_meta = vlc_meta_New();
79 p_meta = p_demux_meta->p_meta;
81 #define ID_IS( a ) (!strcmp( p_frame->id, a ))
82 #define DESCR_IS( a) strstr( (char*)p_frame->description, a )
83 #define GET_STRING(frame,fidx) id3_ucs4_latin1duplicate( id3_field_getstring( &(frame)->fields[fidx] ) )
86 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "UFID", i )) != NULL; i++ )
88 const char *psz_owner = id3_field_getlatin1( &p_frame->fields[0] );
90 if( !strncmp( psz_owner, "http://musicbrainz.org", 22 ) )
92 id3_byte_t const * p_ufid;
93 id3_length_t i_ufidlen;
95 p_ufid = (id3_byte_t const *)
96 id3_field_getbinarydata(
99 char *psz_ufid = strndup( p_ufid, i_ufidlen );
101 vlc_meta_SetTrackID( p_meta, psz_ufid );
106 /* User defined text (TXXX) */
107 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "TXXX", i )) != NULL; i++ )
109 /* 3 fields: 'encoding', 'description', 'value' */
110 char *psz_name = GET_STRING( p_frame, 1 );
111 char *psz_value = GET_STRING( p_frame, 2 );
113 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
115 if( !strncmp( psz_name, "MusicBrainz Artist Id", 21 ) )
116 vlc_meta_SetArtistID( p_meta, psz_value );
117 if( !strncmp( psz_desc, "MusicBrainz Album Id", 20 ) )
118 vlc_meta_SetAlbumID( p_meta, psz_value );
124 /* Relative volume adjustment */
125 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "RVA2", i )) != NULL; i++ )
127 /* 2 fields: 'latin1', 'binary' */
128 const char *psz_type = id3_field_getlatin1( &p_frame->fields[0] );
129 if( !strcasecmp( psz_type, "track" ) || !strcasecmp( psz_type, "album" ) ||
130 !strcasecmp( psz_type, "normalize" ) )
132 id3_byte_t const * p_data;
135 p_data = id3_field_getbinarydata( &p_frame->fields[1], &i_data );
138 const unsigned int i_peak_size = p_data[3];
139 const float f_gain = (float)GetWBE( &p_data[1] ) / 512.0;
142 if( i_data < i_peak_size + 4 )
144 /* only master volume */
145 if( p_data[0] == 0x01 )
147 snprintf( psz_value, sizeof(psz_value), "%f", f_gain );
148 if( !strcasecmp( psz_type, "album" ) )
149 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_ALBUM_GAIN", psz_value );
151 vlc_meta_AddExtra( p_meta, "REPLAYGAIN_TRACK_GAIN", psz_value );
152 /* XXX I have no idea what peak unit is ... */
154 i_data -= 4+i_peak_size;
159 /* TODO 'RGAD' if it is used somewhere */
161 /* T--- Text informations */
162 for( i = 0; (p_frame = id3_tag_findframe( p_id3_tag, "T", i )) != NULL; i++ )
166 /* Special case TXXX is not the same beast */
167 if( ID_IS( "TXXX" ) )
170 i_strings = id3_field_getnstrings( &p_frame->fields[1] );
171 while( i_strings > 0 )
173 char *psz_temp = id3_ucs4_utf8duplicate(
174 id3_field_getstrings( &p_frame->fields[1], --i_strings ) );
176 if( ID_IS( ID3_FRAME_GENRE ) )
179 int i_genre = strtol( psz_temp, &psz_endptr, 10 );
181 if( psz_temp != psz_endptr &&
182 i_genre >= 0 && i_genre < NUM_GENRES )
184 vlc_meta_SetGenre( p_meta, ppsz_genres[atoi(psz_temp)]);
189 vlc_meta_SetGenre( p_meta,psz_temp );
192 else if( ID_IS( ID3_FRAME_TITLE ) )
194 vlc_meta_SetTitle( p_meta, psz_temp );
196 else if( ID_IS( ID3_FRAME_ARTIST ) )
198 vlc_meta_SetArtist( p_meta, psz_temp );
200 else if( ID_IS( ID3_FRAME_YEAR ) )
202 vlc_meta_SetDate( p_meta, psz_temp );
204 else if( ID_IS( ID3_FRAME_COMMENT ) )
206 vlc_meta_SetDescription( p_meta, psz_temp );
208 else if( DESCR_IS( "Copyright" ) )
210 vlc_meta_SetCopyright( p_meta, psz_temp );
212 else if( DESCR_IS( "Publisher" ) )
214 vlc_meta_SetPublisher( p_meta, psz_temp );
216 else if( DESCR_IS( "Track number/position in set" ) )
218 vlc_meta_SetTrackNum( p_meta, psz_temp );
220 else if( DESCR_IS( "Album/movie/show title" ) )
222 vlc_meta_SetAlbum( p_meta, psz_temp );
224 else if( DESCR_IS( "Encoded by" ) )
226 vlc_meta_SetEncodedBy( p_meta, psz_temp );
228 else if( ID_IS ( "APIC" ) )
230 msg_Dbg( p_demux, "** Has APIC **" );
232 else if( p_frame->description )
235 vlc_meta_AddExtra( p_meta, (char*)p_frame->description, psz_temp );
240 id3_tag_delete( p_id3_tag );
245 /*****************************************************************************
247 *****************************************************************************/
248 #define APE_TAG_HEADERSIZE (32)
249 static size_t GetAPEvXSize( const uint8_t *p_data, int i_data )
254 if( i_data < APE_TAG_HEADERSIZE ||
255 ( GetDWLE( &p_data[8] ) != 1000 && GetDWLE( &p_data[8] ) != 2000 ) || /* v1/v2 only */
256 strncmp( (char*)p_data, "APETAGEX", 8 ) ||
257 GetDWLE( &p_data[8+4+4] ) <= 0 )
260 i_body = GetDWLE( &p_data[8+4] );
261 flags = GetDWLE( &p_data[8+4+4] );
263 /* is it the header */
264 if( flags & (1<<29) )
265 return i_body + ( (flags&(1<<30)) ? APE_TAG_HEADERSIZE : 0 );
267 /* it is the footer */
268 return i_body + ( (flags&(1<<31)) ? APE_TAG_HEADERSIZE : 0 );
270 static void ParseAPEvXTag( demux_t *p_demux, const uint8_t *p_data, int i_data )
272 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
276 const uint8_t *p_header = NULL;
279 if( i_data < APE_TAG_HEADERSIZE )
282 b_start = !strncmp( (char*)&p_data[0], "APETAGEX", 8 );
283 b_end = !strncmp( (char*)&p_data[i_data-APE_TAG_HEADERSIZE], "APETAGEX", 8 );
284 if( !b_end && !b_start )
287 if( !p_demux_meta->p_meta )
288 p_demux_meta->p_meta = vlc_meta_New();
289 p_meta = p_demux_meta->p_meta;
293 p_header = &p_data[0];
294 p_data += APE_TAG_HEADERSIZE;
295 i_data -= APE_TAG_HEADERSIZE;
299 p_header = &p_data[i_data-APE_TAG_HEADERSIZE];
300 i_data -= APE_TAG_HEADERSIZE;
305 i_entry = GetDWLE( &p_header[8+4+4] );
309 while( i_entry > 0 && i_data >= 10 )
311 const int i_size = GetDWLE( &p_data[0] );
312 const uint32_t flags = GetDWLE( &p_data[4] );
316 strlcpy( psz_name, (char*)&p_data[8], sizeof(psz_name) );
317 n = strlen( psz_name );
323 if( i_data < i_size )
326 /* Retreive UTF-8 fields only */
327 if( ((flags>>1) & 0x03) == 0x00 )
329 /* FIXME list are separated by '\0' */
330 char *psz_value = strndup( (char*)&p_data[0], i_size );
332 EnsureUTF8( psz_name );
333 EnsureUTF8( psz_value );
334 #define IS(s) (!strcasecmp( psz_name, s ) )
336 vlc_meta_SetTitle( p_meta, psz_value );
337 else if( IS( "Artist" ) )
338 vlc_meta_SetArtist( p_meta, psz_value );
339 else if( IS( "Album" ) )
340 vlc_meta_SetAlbum( p_meta, psz_value );
341 else if( IS( "Publisher" ) )
342 vlc_meta_SetPublisher( p_meta, psz_value );
343 else if( IS( "Track" ) )
345 char *p = strchr( psz_value, '/' );
348 vlc_meta_SetTrackNum( p_meta, psz_value );
350 else if( IS( "Comment" ) )
351 vlc_meta_SetDescription( p_meta, psz_value );
352 else if( IS( "Copyright" ) )
353 vlc_meta_SetCopyright( p_meta, psz_value );
354 else if( IS( "Year" ) )
355 vlc_meta_SetDate( p_meta, psz_value );
356 else if( IS( "Genre" ) )
357 vlc_meta_SetGenre( p_meta, psz_value );
358 else if( IS( "Language" ) )
359 vlc_meta_SetLanguage( p_meta, psz_value );
361 vlc_meta_AddExtra( p_meta, psz_name, psz_value );
372 /*****************************************************************************
373 * CheckFooter: check for ID3/APE at the end of the file
374 * CheckHeader: check for ID3/APE at the begining of the file
375 *****************************************************************************/
376 static void CheckFooter( demux_t *p_demux )
378 const int64_t i_pos = stream_Size( p_demux->s );
379 const size_t i_peek = 128+APE_TAG_HEADERSIZE;
380 const uint8_t *p_peek;
381 const uint8_t *p_peek_id3;
382 int64_t i_id3v2_pos = -1;
383 int64_t i_apevx_pos = -1;
390 if( stream_Seek( p_demux->s, i_pos - i_peek ) )
393 if( stream_Peek( p_demux->s, &p_peek, i_peek ) < i_peek )
395 p_peek_id3 = &p_peek[APE_TAG_HEADERSIZE];
397 /* Check/Parse ID3v1 */
398 i_id3v1_size = id3_tag_query( p_peek_id3, ID3_TAG_QUERYSIZE );
399 if( i_id3v1_size == 128 )
401 msg_Dbg( p_demux, "found ID3v1 tag" );
402 ParseID3Tag( p_demux, p_peek_id3, i_id3v1_size );
405 /* Compute ID3v2 position */
406 i_id3v2_size = -id3_tag_query( &p_peek_id3[128-ID3_TAG_QUERYSIZE], ID3_TAG_QUERYSIZE );
407 if( i_id3v2_size > 0 )
408 i_id3v2_pos = i_pos - i_id3v2_size;
410 /* Compute APE2v2 position */
411 i_apevx_size = GetAPEvXSize( &p_peek[128+0], APE_TAG_HEADERSIZE );
412 if( i_apevx_size > 0 )
414 i_apevx_pos = i_pos - i_apevx_size;
416 else if( i_id3v1_size > 0 )
418 /* it can be before ID3v1 */
419 i_apevx_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
420 if( i_apevx_size > 0 )
421 i_apevx_pos = i_pos - 128 - i_apevx_size;
424 if( i_id3v2_pos > 0 && i_apevx_pos > 0 )
427 "Both ID3v2 and APEv1/2 at the end of file, ignoring APEv1/2" );
432 if( i_id3v2_pos > 0 )
434 if( !stream_Seek( p_demux->s, i_id3v2_pos ) &&
435 stream_Peek( p_demux->s, &p_peek, i_id3v2_size ) == i_id3v2_size )
437 msg_Dbg( p_demux, "found ID3v2 tag at end of file" );
438 ParseID3Tag( p_demux, p_peek, i_id3v2_size );
443 if( i_apevx_pos > 0 )
445 if( !stream_Seek( p_demux->s, i_apevx_pos ) &&
446 stream_Peek( p_demux->s, &p_peek, i_apevx_size ) == i_apevx_size )
448 msg_Dbg( p_demux, "found APEvx tag at end of file" );
449 ParseAPEvXTag( p_demux, p_peek, i_apevx_size );
453 static void CheckHeader( demux_t *p_demux )
455 const uint8_t *p_peek;
458 if( stream_Seek( p_demux->s, 0 ) )
461 /* Test ID3v2 first */
462 if( stream_Peek( p_demux->s, &p_peek, ID3_TAG_QUERYSIZE ) != ID3_TAG_QUERYSIZE )
464 i_size = id3_tag_query( p_peek, ID3_TAG_QUERYSIZE );
466 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
468 msg_Dbg( p_demux, "found ID3v2 tag" );
469 ParseID3Tag( p_demux, p_peek, i_size );
474 if( stream_Peek( p_demux->s, &p_peek, APE_TAG_HEADERSIZE ) != APE_TAG_HEADERSIZE )
476 i_size = GetAPEvXSize( p_peek, APE_TAG_HEADERSIZE );
478 stream_Peek( p_demux->s, &p_peek, i_size ) == i_size )
480 msg_Dbg( p_demux, "found APEv1/2 tag" );
481 ParseAPEvXTag( p_demux, p_peek, i_size );
485 /*****************************************************************************
486 * ParseTags: check if ID3/APE tags at common locations.
487 ****************************************************************************/
488 static int ParseTags( vlc_object_t *p_this )
490 demux_t *p_demux = (demux_t *)p_this;
491 demux_meta_t *p_demux_meta = (demux_meta_t*)p_demux->p_private;
495 msg_Dbg( p_demux, "checking for ID3v1/2 and APEv1/2 tags" );
496 stream_Control( p_demux->s, STREAM_CAN_FASTSEEK, &b_seekable );
500 i_init = stream_Tell( p_demux->s );
502 TAB_INIT( p_demux_meta->i_attachments, p_demux_meta->attachments );
503 p_demux_meta->p_meta = NULL;
506 CheckFooter( p_demux );
509 CheckHeader( p_demux );
512 * Demuxer will not see tags at the start as src/input/demux.c skips it
515 stream_Seek( p_demux->s, i_init );
516 if( !p_demux_meta->p_meta && p_demux_meta->i_attachments <= 0 )