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