id3tag.c
上传用户:kjfoods
上传日期:2020-07-06
资源大小:29949k
文件大小:17k
源码类别:

midi

开发平台:

Unix_Linux

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