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 OR ATRAC3 stream in WAV file (.at3) */
  64     [AFMT_PCM_WAV] =
  65         AFMT_ENTRY("WAV",  "wav",     "wav_enc",     "wav\0at3\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     /* Atrac3 in Sony OMA Container */
 166     [AFMT_OMA_ATRAC3] =
 167         AFMT_ENTRY("ATRAC3",  "atrac3_oma",     NULL,          "oma\0aa3\0"      ),
 168     /* SMAF (Synthetic music Mobile Application Format) */
 169     [AFMT_SMAF] =
 170         AFMT_ENTRY("SMAF",  "smaf",   NULL,          "mmf\0"      ),
 171     /* Sun Audio file */
 172     [AFMT_AU] =
 173         AFMT_ENTRY("AU",  "au",     NULL,          "au\0snd\0"      ),
 174     /* VOX (Dialogic telephony file formats) */
 175     [AFMT_VOX] =
 176         AFMT_ENTRY("VOX",  "vox",   NULL,          "vox\0"      ),
 177 #endif
 178 };
 179
 180 #if CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING)
 181 /* get REC_FORMAT_* corresponding AFMT_* */
 182 const int rec_format_afmt[REC_NUM_FORMATS] =
 183 {
 184     /* give AFMT_UNKNOWN by default */
 185     [0 ... REC_NUM_FORMATS-1] = AFMT_UNKNOWN,
 186     /* add new entries below this line */
 187     [REC_FORMAT_AIFF]    = AFMT_AIFF,
 188     [REC_FORMAT_MPA_L3]  = AFMT_MPA_L3,
 189     [REC_FORMAT_WAVPACK] = AFMT_WAVPACK,
 190     [REC_FORMAT_PCM_WAV] = AFMT_PCM_WAV,
 191 };
 192
 193 /* get AFMT_* corresponding REC_FORMAT_* */
 194 const int afmt_rec_format[AFMT_NUM_CODECS] =
 195 {
 196     /* give -1 by default */
 197     [0 ... AFMT_NUM_CODECS-1] = -1,
 198     /* add new entries below this line */
 199     [AFMT_AIFF]    = REC_FORMAT_AIFF,
 200     [AFMT_MPA_L3]  = REC_FORMAT_MPA_L3,
 201     [AFMT_WAVPACK] = REC_FORMAT_WAVPACK,
 202     [AFMT_PCM_WAV] = REC_FORMAT_PCM_WAV,
 203 };
 204 #endif /* CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING) */
 205
 206
 207 /* Simple file type probing by looking at the filename extension. */
 208 unsigned int probe_file_format(const char *filename)
 209 {
 210     char *suffix;
 211     unsigned int i;
 212
 213     suffix = strrchr(filename, '.');
 214
 215     if (suffix == NULL)
 216     {
 217         return AFMT_UNKNOWN;
 218     }
 219
 220     /* skip '.' */
 221     suffix++;
 222
 223     for (i = 1; i < AFMT_NUM_CODECS; i++)
 224     {
 225         /* search extension list for type */
 226         const char *ext = audio_formats[i].ext_list;
 227
 228         do
 229         {
 230             if (strcasecmp(suffix, ext) == 0)
 231             {
 232                 return i;
 233             }
 234
 235             ext += strlen(ext) + 1;
 236         }
 237         while (*ext != '\0');
 238     }
 239
 240     return AFMT_UNKNOWN;
 241 }
 242
 243 /* Note, that this returns false for successful, true for error! */
 244 bool mp3info(struct mp3entry *entry, const char *filename)
 245 {
 246     int fd;
 247     bool result;
 248
 249     fd = open(filename, O_RDONLY);
 250     if (fd < 0)
 251         return true;
 252
 253     result = !get_mp3_metadata(fd, entry, filename);
 254
 255     close(fd);
 256
 257     return result;
 258 }
 259
 260 /* Get metadata for track - return false if parsing showed problems with the
 261  * file that would prevent playback.
 262  */
 263 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
 264 {
 265     /* Clear the mp3entry to avoid having bogus pointers appear */
 266     memset(id3, 0, sizeof(struct mp3entry));
 267
 268     /* Take our best guess at the codec type based on file extension */
 269     id3->codectype = probe_file_format(trackname);
 270
 271     /* Load codec specific track tag information and confirm the codec type. */
 272     switch (id3->codectype)
 273     {
 274     case AFMT_MPA_L1:
 275     case AFMT_MPA_L2:
 276     case AFMT_MPA_L3:
 277         if (!get_mp3_metadata(fd, id3, trackname))
 278         {
 279             return false;
 280         }
 281
 282         break;
 283
 284 #if CONFIG_CODEC == SWCODEC
 285     case AFMT_FLAC:
 286         if (!get_flac_metadata(fd, id3))
 287         {
 288             return false;
 289         }
 290
 291         break;
 292
 293     case AFMT_WMA:
 294         if (!get_asf_metadata(fd, id3))
 295         {
 296             return false;
 297         }
 298         break;
 299
 300     case AFMT_APE:
 301         if (!get_monkeys_metadata(fd, id3))
 302         {
 303             return false;
 304         }
 305         read_ape_tags(fd, id3);
 306         break;
 307
 308     case AFMT_MPC:
 309         if (!get_musepack_metadata(fd, id3))
 310             return false;
 311         read_ape_tags(fd, id3);
 312         break;
 313
 314     case AFMT_OGG_VORBIS:
 315     case AFMT_SPEEX:
 316         if (!get_ogg_metadata(fd, id3))/*detects and handles Ogg/Speex files*/
 317         {
 318             return false;
 319         }
 320
 321         break;
 322
 323     case AFMT_PCM_WAV:
 324         if (!get_wave_metadata(fd, id3))
 325         {
 326             return false;
 327         }
 328
 329         break;
 330
 331     case AFMT_WAVPACK:
 332         if (!get_wavpack_metadata(fd, id3))
 333         {
 334             return false;
 335         }
 336
 337         read_ape_tags(fd, id3);     /* use any apetag info we find */
 338         break;
 339
 340     case AFMT_A52:
 341         if (!get_a52_metadata(fd, id3))
 342         {
 343             return false;
 344         }
 345
 346         break;
 347
 348     case AFMT_MP4_ALAC:
 349     case AFMT_MP4_AAC:
 350         if (!get_mp4_metadata(fd, id3))
 351         {
 352             return false;
 353         }
 354
 355         break;
 356
 357     case AFMT_MOD:
 358         if (!get_mod_metadata(fd, id3))
 359         {
 360             return false;
 361         }
 362
 363         break;
 364
 365     case AFMT_SHN:
 366         id3->vbr = true;
 367         id3->filesize = filesize(fd);
 368         if (!skip_id3v2(fd, id3))
 369         {
 370             return false;
 371         }
 372         /* TODO: read the id3v2 header if it exists */
 373         break;
 374
 375     case AFMT_SID:
 376         if (!get_sid_metadata(fd, id3))
 377         {
 378             return false;
 379         }
 380         break;
 381
 382     case AFMT_SPC:
 383         if (!get_spc_metadata(fd, id3))
 384         {
 385             DEBUGF("get_spc_metadata error\n");
 386             return false;
 387         }
 388         id3->filesize = filesize(fd);
 389         id3->genre_string = id3_get_num_genre(36);
 390         break;
 391
 392     case AFMT_ADX:
 393         if (!get_adx_metadata(fd, id3))
 394         {
 395             DEBUGF("get_adx_metadata error\n");
 396             return false;
 397         }
 398
 399         break;
 400
 401     case AFMT_NSF:
 402         if (!get_nsf_metadata(fd, id3))
 403         {
 404             DEBUGF("get_nsf_metadata error\n");
 405             return false;
 406         }
 407         break;
 408
 409     case AFMT_AIFF:
 410         if (!get_aiff_metadata(fd, id3))
 411         {
 412             return false;
 413         }
 414
 415         break;
 416
 417     case AFMT_SAP:
 418         if (!get_asap_metadata(fd, id3))
 419         {
 420             DEBUGF("get_sap_metadata error\n");
 421             return false;
 422         }
 423         id3->filesize = filesize(fd);
 424         id3->genre_string = id3_get_num_genre(36);
 425         break;
 426
 427     case AFMT_CMC:
 428     case AFMT_CM3:
 429     case AFMT_CMR:
 430     case AFMT_CMS:
 431     case AFMT_DMC:
 432     case AFMT_DLT:
 433     case AFMT_MPT:
 434     case AFMT_MPD:
 435     case AFMT_RMT:
 436     case AFMT_TMC:
 437     case AFMT_TM8:
 438     case AFMT_TM2:
 439         id3->bitrate = 706;
 440         id3->frequency = 44100;
 441         id3->vbr = false;
 442         id3->filesize = filesize(fd);
 443         id3->genre_string = id3_get_num_genre(36);
 444         break;
 445     case AFMT_RM_COOK:
 446         if (!get_rm_metadata(fd, id3))
 447         {
 448             DEBUGF("get_rm_metadata error\n");
 449             return false;
 450         }
 451         break;
 452     case AFMT_OMA_ATRAC3:
 453         if (!get_oma_metadata(fd, id3))
 454         {
 455             DEBUGF("get_oma_metadata error\n");
 456             return false;
 457         }
 458         break;
 459
 460     case AFMT_SMAF:
 461         if (!get_smaf_metadata(fd, id3))
 462         {
 463             DEBUGF("get_smaf_metadata error\n");
 464             return false;
 465         }
 466         break;
 467
 468     case AFMT_AU:
 469         if (!get_au_metadata(fd, id3))
 470         {
 471             DEBUGF("get_au_metadata error\n");
 472             return false;
 473         }
 474         break;
 475
 476     case AFMT_VOX:
 477         if (!get_vox_metadata(fd, id3))
 478         {
 479             DEBUGF("get_vox_metadata error\n");
 480             return false;
 481         }
 482         break;
 483
 484 #endif /* CONFIG_CODEC == SWCODEC */
 485
 486     default:
 487         /* If we don't know how to read the metadata, assume we can't play
 488            the file */
 489         return false;
 490         break;
 491     }
 492
 493     /* We have successfully read the metadata from the file */
 494
 495     lseek(fd, 0, SEEK_SET);
 496     strlcpy(id3->path, trackname, sizeof(id3->path));
 497
 498     return true;
 499 }
 500
 501 #ifndef __PCTOOL__
 502 #if CONFIG_CODEC == SWCODEC
 503 void strip_tags(int handle_id)
 504 {
 505     static const unsigned char tag[] = "TAG";
 506     static const unsigned char apetag[] = "APETAGEX";
 507     size_t len, version;
 508     void *tail;
 509
 510     if (bufgettail(handle_id, 128, &tail) != 128)
 511         return;
 512
 513     if (memcmp(tail, tag, 3) == 0)
 514     {
 515         /* Skip id3v1 tag */
 516         logf("Cutting off ID3v1 tag");
 517         bufcuttail(handle_id, 128);
 518     }
 519
 520     /* Get a new tail, as the old one may have been cut */
 521     if (bufgettail(handle_id, 32, &tail) != 32)
 522         return;
 523
 524     /* Check for APE tag (look for the APE tag footer) */
 525     if (memcmp(tail, apetag, 8) != 0)
 526         return;
 527
 528     /* Read the version and length from the footer */
 529     version = get_long_le(&((unsigned char *)tail)[8]);
 530     len = get_long_le(&((unsigned char *)tail)[12]);
 531     if (version == 2000)
 532         len += 32; /* APEv2 has a 32 byte header */
 533
 534     /* Skip APE tag */
 535     logf("Cutting off APE tag (%ldB)", len);
 536     bufcuttail(handle_id, len);
 537 }
 538 #endif /* CONFIG_CODEC == SWCODEC */
 539 #endif /* ! __PCTOOL__ */
 540
 541 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig)
 542 {
 543     long offset;
 544     if (orig > dest)
 545         offset = - ((size_t)orig - (size_t)dest);
 546     else
 547         offset = (size_t)dest - (size_t)orig;
 548
 549     if (entry->title)
 550         entry->title += offset;
 551     if (entry->artist)
 552         entry->artist += offset;
 553     if (entry->album)
 554         entry->album += offset;
 555     if (entry->genre_string > (char*)orig
 556          && entry->genre_string < (char*)orig + sizeof(struct mp3entry))
 557         /* Don't adjust that if it points to an entry of the "genres" array */
 558         entry->genre_string += offset;
 559     if (entry->track_string)
 560         entry->track_string += offset;
 561     if (entry->disc_string)
 562         entry->disc_string += offset;
 563     if (entry->year_string)
 564         entry->year_string += offset;
 565     if (entry->composer)
 566         entry->composer += offset;
 567     if (entry->comment)
 568         entry->comment += offset;
 569     if (entry->albumartist)
 570         entry->albumartist += offset;
 571     if (entry->grouping)
 572         entry->grouping += offset;
 573 #if CONFIG_CODEC == SWCODEC
 574     if (entry->track_gain_string)
 575         entry->track_gain_string += offset;
 576     if (entry->album_gain_string)
 577         entry->album_gain_string += offset;
 578 #endif
 579     if (entry->mb_track_id)
 580         entry->mb_track_id += offset;
 581 }
 582
 583 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig)
 584 {
 585     memcpy(dest, orig, sizeof(struct mp3entry));
 586     adjust_mp3entry(dest, dest, orig);
 587 }