apps/metadata.c

   1 /***************************************************************************
   2  *             __________               __   ___.
   3  *   Open      \______   \ ____   ____ |  | _\_ |__   _______  ___
   4  *   Source     |       _//  _ \_/ ___\|  |/ /| __ \ /  _ \  \/  /
   5  *   Jukebox    |    |   (  <_> )  \___|    < | \_\ (  <_> > <  <
   6  *   Firmware   |____|_  /\____/ \___  >__|_ \|___  /\____/__/\_ \
   7  *                     \/            \/     \/    \/            \/
   8  * $Id$
   9  *
  10  * Copyright (C) 2005 Dave Chapman
  11  *
  12  * This program is free software; you can redistribute it and/or
  13  * modify it under the terms of the GNU General Public License
  14  * as published by the Free Software Foundation; either version 2
  15  * of the License, or (at your option) any later version.
  16  *
  17  * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
  18  * KIND, either express or implied.
  19  *
  20  ****************************************************************************/
  21 #include <stdio.h>
  22 #include <string.h>
  23 #include <stdlib.h>
  24 #include <ctype.h>
  25 #include <inttypes.h>
  26
  27 #include "playback.h"
  28 #include "debug.h"
  29 #include "logf.h"
  30 #include "cuesheet.h"
  31 #include "metadata.h"
  32
  33 #include "metadata/metadata_parsers.h"
  34
  35 #if CONFIG_CODEC == SWCODEC
  36
  37 /* For trailing tag stripping */
  38 #include "buffering.h"
  39
  40 #include "metadata/metadata_common.h"
  41
  42 #endif /* CONFIG_CODEC == SWCODEC */
  43
  44 const struct afmt_entry audio_formats[AFMT_NUM_CODECS] =
  45 {
  46     /* Unknown file format */
  47     [AFMT_UNKNOWN] =
  48         AFMT_ENTRY("???", NULL,       NULL,          NULL         ),
  49
  50     /* MPEG Audio layer 1 */
  51     [AFMT_MPA_L1] =
  52         AFMT_ENTRY("MP1", "mpa",      NULL,          "mp1\0"      ),
  53     /* MPEG Audio layer 2 */
  54     [AFMT_MPA_L2] =
  55         AFMT_ENTRY("MP2", "mpa",      NULL,          "mpa\0mp2\0" ),
  56     /* MPEG Audio layer 3 */
  57     [AFMT_MPA_L3] =
  58         AFMT_ENTRY("MP3", "mpa",      "mp3_enc",     "mp3\0"      ),
  59
  60 #if CONFIG_CODEC == SWCODEC
  61     /* Audio Interchange File Format */
  62     [AFMT_AIFF] =
  63         AFMT_ENTRY("AIFF", "aiff",    "aiff_enc",    "aiff\0aif\0"),
  64     /* Uncompressed PCM in a WAV file */
  65     [AFMT_PCM_WAV] =
  66         AFMT_ENTRY("WAV",  "wav",     "wav_enc",     "wav\0"      ),
  67     /* Ogg Vorbis */
  68     [AFMT_OGG_VORBIS] =
  69         AFMT_ENTRY("Ogg",  "vorbis",  NULL,          "ogg\0oga\0" ),
  70     /* FLAC */
  71     [AFMT_FLAC] =
  72         AFMT_ENTRY("FLAC", "flac",    NULL,          "flac\0"     ),
  73     /* Musepack */
  74     [AFMT_MPC] =
  75         AFMT_ENTRY("MPC",  "mpc",     NULL,          "mpc\0"      ),
  76     /* A/52 (aka AC3) audio */
  77     [AFMT_A52] =
  78         AFMT_ENTRY("AC3",  "a52",     NULL,          "a52\0ac3\0" ),
  79     /* WavPack */
  80     [AFMT_WAVPACK] =
  81         AFMT_ENTRY("WV",   "wavpack", "wavpack_enc", "wv\0"       ),
  82     /* Apple Lossless Audio Codec */
  83     [AFMT_MP4_ALAC] =
  84         AFMT_ENTRY("ALAC", "alac",    NULL,          "m4a\0m4b\0" ),
  85     /* Advanced Audio Coding in M4A container */
  86     [AFMT_MP4_AAC] =
  87         AFMT_ENTRY("AAC",  "aac",     NULL,          "mp4\0"      ),
  88     /* Shorten */
  89     [AFMT_SHN] =
  90         AFMT_ENTRY("SHN",  "shorten", NULL,          "shn\0"      ),
  91     /* SID File Format */
  92     [AFMT_SID] =
  93         AFMT_ENTRY("SID",  "sid",     NULL,          "sid\0"      ),
  94     /* ADX File Format */
  95     [AFMT_ADX] =
  96         AFMT_ENTRY("ADX",  "adx",     NULL,          "adx\0"      ),
  97     /* NESM (NES Sound Format) */
  98     [AFMT_NSF] =
  99         AFMT_ENTRY("NSF",  "nsf",     NULL,          "nsf\0nsfe\0"      ),
 100     /* Speex File Format */
 101     [AFMT_SPEEX] =
 102         AFMT_ENTRY("Speex","speex",   NULL,          "spx\0"      ),
 103     /* SPC700 Save State */
 104     [AFMT_SPC] =
 105         AFMT_ENTRY("SPC",  "spc",     NULL,          "spc\0"      ),
 106     /* APE (Monkey's Audio) */
 107     [AFMT_APE] =
 108         AFMT_ENTRY("APE",  "ape",     NULL,          "ape\0mac\0"      ),
 109     /* WMA (WMAV1/V2 in ASF) */
 110     [AFMT_WMA] =
 111         AFMT_ENTRY("WMA",  "wma",     NULL,          "wma\0wmv\0asf\0"   ),
 112     /* Amiga MOD File */
 113     [AFMT_MOD] =
 114         AFMT_ENTRY("MOD",  "mod",     NULL,          "mod\0"      ),
 115     /* Amiga SAP File */
 116     [AFMT_SAP] =
 117         AFMT_ENTRY("SAP",  "asap",     NULL,          "sap\0"      ),
 118     /* Cook in RM/RA */
 119     [AFMT_RM_COOK] =
 120         AFMT_ENTRY("Cook",  "cook",   NULL,          "rm\0ra\0rmvb\0"      ),
 121     /* AAC in RM/RA */
 122     [AFMT_RM_AAC] =
 123         AFMT_ENTRY("RAAC",  "raac",     NULL,        "rm\0ra\0rmvb\0"      ),
 124     /* AC3 in RM/RA */
 125     [AFMT_RM_AC3] =
 126         AFMT_ENTRY("AC3",   "a52_rm",     NULL,        "rm\0ra\0rmvb\0"      ),
 127     /* ATRAC3 in RM/RA */
 128     [AFMT_RM_ATRAC3] =
 129         AFMT_ENTRY("ATRAC3","atrac3_rm",  NULL,        "rm\0ra\0rmvb\0"      ),
 130 #endif
 131 };
 132
 133 #if CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING)
 134 /* get REC_FORMAT_* corresponding AFMT_* */
 135 const int rec_format_afmt[REC_NUM_FORMATS] =
 136 {
 137     /* give AFMT_UNKNOWN by default */
 138     [0 ... REC_NUM_FORMATS-1] = AFMT_UNKNOWN,
 139     /* add new entries below this line */
 140     [REC_FORMAT_AIFF]    = AFMT_AIFF,
 141     [REC_FORMAT_MPA_L3]  = AFMT_MPA_L3,
 142     [REC_FORMAT_WAVPACK] = AFMT_WAVPACK,
 143     [REC_FORMAT_PCM_WAV] = AFMT_PCM_WAV,
 144 };
 145
 146 /* get AFMT_* corresponding REC_FORMAT_* */
 147 const int afmt_rec_format[AFMT_NUM_CODECS] =
 148 {
 149     /* give -1 by default */
 150     [0 ... AFMT_NUM_CODECS-1] = -1,
 151     /* add new entries below this line */
 152     [AFMT_AIFF]    = REC_FORMAT_AIFF,
 153     [AFMT_MPA_L3]  = REC_FORMAT_MPA_L3,
 154     [AFMT_WAVPACK] = REC_FORMAT_WAVPACK,
 155     [AFMT_PCM_WAV] = REC_FORMAT_PCM_WAV,
 156 };
 157 #endif /* CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING) */
 158
 159
 160 /* Simple file type probing by looking at the filename extension. */
 161 unsigned int probe_file_format(const char *filename)
 162 {
 163     char *suffix;
 164     unsigned int i;
 165
 166     suffix = strrchr(filename, '.');
 167
 168     if (suffix == NULL)
 169     {
 170         return AFMT_UNKNOWN;
 171     }
 172
 173     /* skip '.' */
 174     suffix++;
 175
 176     for (i = 1; i < AFMT_NUM_CODECS; i++)
 177     {
 178         /* search extension list for type */
 179         const char *ext = audio_formats[i].ext_list;
 180
 181         do
 182         {
 183             if (strcasecmp(suffix, ext) == 0)
 184             {
 185                 return i;
 186             }
 187
 188             ext += strlen(ext) + 1;
 189         }
 190         while (*ext != '\0');
 191     }
 192
 193     return AFMT_UNKNOWN;
 194 }
 195
 196 /* Note, that this returns false for successful, true for error! */
 197 bool mp3info(struct mp3entry *entry, const char *filename)
 198 {
 199     int fd;
 200     bool result;
 201
 202     fd = open(filename, O_RDONLY);
 203     if (fd < 0)
 204         return true;
 205
 206     result = !get_mp3_metadata(fd, entry, filename);
 207
 208     close(fd);
 209
 210     return result;
 211 }
 212
 213 /* Get metadata for track - return false if parsing showed problems with the
 214  * file that would prevent playback.
 215  */
 216 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
 217 {
 218     /* Clear the mp3entry to avoid having bogus pointers appear */
 219     memset(id3, 0, sizeof(struct mp3entry));
 220
 221     /* Take our best guess at the codec type based on file extension */
 222     id3->codectype = probe_file_format(trackname);
 223
 224     /* Load codec specific track tag information and confirm the codec type. */
 225     switch (id3->codectype)
 226     {
 227     case AFMT_MPA_L1:
 228     case AFMT_MPA_L2:
 229     case AFMT_MPA_L3:
 230         if (!get_mp3_metadata(fd, id3, trackname))
 231         {
 232             return false;
 233         }
 234
 235         break;
 236
 237 #if CONFIG_CODEC == SWCODEC
 238     case AFMT_FLAC:
 239         if (!get_flac_metadata(fd, id3))
 240         {
 241             return false;
 242         }
 243
 244         break;
 245
 246     case AFMT_WMA:
 247         if (!get_asf_metadata(fd, id3))
 248         {
 249             return false;
 250         }
 251         break;
 252
 253     case AFMT_APE:
 254         if (!get_monkeys_metadata(fd, id3))
 255         {
 256             return false;
 257         }
 258         read_ape_tags(fd, id3);
 259         break;
 260
 261     case AFMT_MPC:
 262         if (!get_musepack_metadata(fd, id3))
 263             return false;
 264         read_ape_tags(fd, id3);
 265         break;
 266
 267     case AFMT_OGG_VORBIS:
 268     case AFMT_SPEEX:
 269         if (!get_ogg_metadata(fd, id3))/*detects and handles Ogg/Speex files*/
 270         {
 271             return false;
 272         }
 273
 274         break;
 275
 276     case AFMT_PCM_WAV:
 277         if (!get_wave_metadata(fd, id3))
 278         {
 279             return false;
 280         }
 281
 282         break;
 283
 284     case AFMT_WAVPACK:
 285         if (!get_wavpack_metadata(fd, id3))
 286         {
 287             return false;
 288         }
 289
 290         read_ape_tags(fd, id3);     /* use any apetag info we find */
 291         break;
 292
 293     case AFMT_A52:
 294         if (!get_a52_metadata(fd, id3))
 295         {
 296             return false;
 297         }
 298
 299         break;
 300
 301     case AFMT_MP4_ALAC:
 302     case AFMT_MP4_AAC:
 303         if (!get_mp4_metadata(fd, id3))
 304         {
 305             return false;
 306         }
 307
 308         break;
 309
 310     case AFMT_MOD:
 311         if (!get_mod_metadata(fd, id3))
 312         {
 313             return false;
 314         }
 315
 316         break;
 317
 318     case AFMT_SHN:
 319         id3->vbr = true;
 320         id3->filesize = filesize(fd);
 321         if (!skip_id3v2(fd, id3))
 322         {
 323             return false;
 324         }
 325         /* TODO: read the id3v2 header if it exists */
 326         break;
 327
 328     case AFMT_SID:
 329         if (!get_sid_metadata(fd, id3))
 330         {
 331             return false;
 332         }
 333         break;
 334
 335     case AFMT_SPC:
 336         if (!get_spc_metadata(fd, id3))
 337         {
 338             DEBUGF("get_spc_metadata error\n");
 339             return false;
 340         }
 341         id3->filesize = filesize(fd);
 342         id3->genre_string = id3_get_num_genre(36);
 343         break;
 344
 345     case AFMT_ADX:
 346         if (!get_adx_metadata(fd, id3))
 347         {
 348             DEBUGF("get_adx_metadata error\n");
 349             return false;
 350         }
 351
 352         break;
 353
 354     case AFMT_NSF:
 355         if (!get_nsf_metadata(fd, id3))
 356         {
 357             DEBUGF("get_nsf_metadata error\n");
 358             return false;
 359         }
 360         break;
 361
 362     case AFMT_AIFF:
 363         if (!get_aiff_metadata(fd, id3))
 364         {
 365             return false;
 366         }
 367
 368         break;
 369
 370     case AFMT_SAP:
 371         if (!get_asap_metadata(fd, id3))
 372         {
 373             DEBUGF("get_sap_metadata error\n");
 374             return false;
 375         }
 376         id3->filesize = filesize(fd);
 377         id3->genre_string = id3_get_num_genre(36);
 378         break;
 379
 380     case AFMT_RM_COOK:
 381         if (!get_rm_metadata(fd, id3))
 382         {
 383             DEBUGF("get_rm_metadata error\n");
 384             return false;
 385         }
 386         break;
 387
 388 #endif /* CONFIG_CODEC == SWCODEC */
 389
 390     default:
 391         /* If we don't know how to read the metadata, assume we can't play
 392            the file */
 393         return false;
 394         break;
 395     }
 396
 397     /* We have successfully read the metadata from the file */
 398
 399     lseek(fd, 0, SEEK_SET);
 400     strlcpy(id3->path, trackname, sizeof(id3->path));
 401
 402     return true;
 403 }
 404
 405 #ifndef __PCTOOL__
 406 #if CONFIG_CODEC == SWCODEC
 407 void strip_tags(int handle_id)
 408 {
 409     static const unsigned char tag[] = "TAG";
 410     static const unsigned char apetag[] = "APETAGEX";
 411     size_t len, version;
 412     void *tail;
 413
 414     if (bufgettail(handle_id, 128, &tail) != 128)
 415         return;
 416
 417     if (memcmp(tail, tag, 3) == 0)
 418     {
 419         /* Skip id3v1 tag */
 420         logf("Cutting off ID3v1 tag");
 421         bufcuttail(handle_id, 128);
 422     }
 423
 424     /* Get a new tail, as the old one may have been cut */
 425     if (bufgettail(handle_id, 32, &tail) != 32)
 426         return;
 427
 428     /* Check for APE tag (look for the APE tag footer) */
 429     if (memcmp(tail, apetag, 8) != 0)
 430         return;
 431
 432     /* Read the version and length from the footer */
 433     version = get_long_le(&((unsigned char *)tail)[8]);
 434     len = get_long_le(&((unsigned char *)tail)[12]);
 435     if (version == 2000)
 436         len += 32; /* APEv2 has a 32 byte header */
 437
 438     /* Skip APE tag */
 439     logf("Cutting off APE tag (%ldB)", len);
 440     bufcuttail(handle_id, len);
 441 }
 442 #endif /* CONFIG_CODEC == SWCODEC */
 443 #endif /* ! __PCTOOL__ */
 444
 445 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig)
 446 {
 447     long offset;
 448     if (orig > dest)
 449         offset = - ((size_t)orig - (size_t)dest);
 450     else
 451         offset = (size_t)dest - (size_t)orig;
 452
 453     if (entry->title)
 454         entry->title += offset;
 455     if (entry->artist)
 456         entry->artist += offset;
 457     if (entry->album)
 458         entry->album += offset;
 459     if (entry->genre_string > (char*)orig
 460          && entry->genre_string < (char*)orig + sizeof(struct mp3entry))
 461         /* Don't adjust that if it points to an entry of the "genres" array */
 462         entry->genre_string += offset;
 463     if (entry->track_string)
 464         entry->track_string += offset;
 465     if (entry->disc_string)
 466         entry->disc_string += offset;
 467     if (entry->year_string)
 468         entry->year_string += offset;
 469     if (entry->composer)
 470         entry->composer += offset;
 471     if (entry->comment)
 472         entry->comment += offset;
 473     if (entry->albumartist)
 474         entry->albumartist += offset;
 475     if (entry->grouping)
 476         entry->grouping += offset;
 477 #if CONFIG_CODEC == SWCODEC
 478     if (entry->track_gain_string)
 479         entry->track_gain_string += offset;
 480     if (entry->album_gain_string)
 481         entry->album_gain_string += offset;
 482 #endif
 483     if (entry->mb_track_id)
 484         entry->mb_track_id += offset;
 485 }
 486
 487 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig)
 488 {
 489     memcpy(dest, orig, sizeof(struct mp3entry));
 490     adjust_mp3entry(dest, dest, orig);
 491 }