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 #endif
 128 };
 129
 130 #if CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING)
 131 /* get REC_FORMAT_* corresponding AFMT_* */
 132 const int rec_format_afmt[REC_NUM_FORMATS] =
 133 {
 134     /* give AFMT_UNKNOWN by default */
 135     [0 ... REC_NUM_FORMATS-1] = AFMT_UNKNOWN,
 136     /* add new entries below this line */
 137     [REC_FORMAT_AIFF]    = AFMT_AIFF,
 138     [REC_FORMAT_MPA_L3]  = AFMT_MPA_L3,
 139     [REC_FORMAT_WAVPACK] = AFMT_WAVPACK,
 140     [REC_FORMAT_PCM_WAV] = AFMT_PCM_WAV,
 141 };
 142
 143 /* get AFMT_* corresponding REC_FORMAT_* */
 144 const int afmt_rec_format[AFMT_NUM_CODECS] =
 145 {
 146     /* give -1 by default */
 147     [0 ... AFMT_NUM_CODECS-1] = -1,
 148     /* add new entries below this line */
 149     [AFMT_AIFF]    = REC_FORMAT_AIFF,
 150     [AFMT_MPA_L3]  = REC_FORMAT_MPA_L3,
 151     [AFMT_WAVPACK] = REC_FORMAT_WAVPACK,
 152     [AFMT_PCM_WAV] = REC_FORMAT_PCM_WAV,
 153 };
 154 #endif /* CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING) */
 155
 156
 157 /* Simple file type probing by looking at the filename extension. */
 158 unsigned int probe_file_format(const char *filename)
 159 {
 160     char *suffix;
 161     unsigned int i;
 162
 163     suffix = strrchr(filename, '.');
 164
 165     if (suffix == NULL)
 166     {
 167         return AFMT_UNKNOWN;
 168     }
 169
 170     /* skip '.' */
 171     suffix++;
 172
 173     for (i = 1; i < AFMT_NUM_CODECS; i++)
 174     {
 175         /* search extension list for type */
 176         const char *ext = audio_formats[i].ext_list;
 177
 178         do
 179         {
 180             if (strcasecmp(suffix, ext) == 0)
 181             {
 182                 return i;
 183             }
 184
 185             ext += strlen(ext) + 1;
 186         }
 187         while (*ext != '\0');
 188     }
 189
 190     return AFMT_UNKNOWN;
 191 }
 192
 193 /* Note, that this returns false for successful, true for error! */
 194 bool mp3info(struct mp3entry *entry, const char *filename)
 195 {
 196     int fd;
 197     bool result;
 198
 199     fd = open(filename, O_RDONLY);
 200     if (fd < 0)
 201         return true;
 202
 203     result = !get_mp3_metadata(fd, entry, filename);
 204
 205     close(fd);
 206
 207     return result;
 208 }
 209
 210 /* Get metadata for track - return false if parsing showed problems with the
 211  * file that would prevent playback.
 212  */
 213 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
 214 {
 215 #if CONFIG_CODEC == SWCODEC
 216     unsigned char* buf;
 217 #endif
 218
 219     /* Clear the mp3entry to avoid having bogus pointers appear */
 220     memset(id3, 0, sizeof(struct mp3entry));
 221
 222     /* Take our best guess at the codec type based on file extension */
 223     id3->codectype = probe_file_format(trackname);
 224
 225     /* Load codec specific track tag information and confirm the codec type. */
 226     switch (id3->codectype)
 227     {
 228     case AFMT_MPA_L1:
 229     case AFMT_MPA_L2:
 230     case AFMT_MPA_L3:
 231         if (!get_mp3_metadata(fd, id3, trackname))
 232         {
 233             return false;
 234         }
 235
 236         break;
 237
 238 #if CONFIG_CODEC == SWCODEC
 239     case AFMT_FLAC:
 240         if (!get_flac_metadata(fd, id3))
 241         {
 242             return false;
 243         }
 244
 245         break;
 246
 247     case AFMT_WMA:
 248         if (!get_asf_metadata(fd, id3))
 249         {
 250             return false;
 251         }
 252         break;
 253
 254     case AFMT_APE:
 255         if (!get_monkeys_metadata(fd, id3))
 256         {
 257             return false;
 258         }
 259         read_ape_tags(fd, id3);
 260         break;
 261
 262     case AFMT_MPC:
 263         if (!get_musepack_metadata(fd, id3))
 264             return false;
 265         read_ape_tags(fd, id3);
 266         break;
 267
 268     case AFMT_OGG_VORBIS:
 269     case AFMT_SPEEX:
 270         if (!get_ogg_metadata(fd, id3))/*detects and handles Ogg/Speex files*/
 271         {
 272             return false;
 273         }
 274
 275         break;
 276
 277     case AFMT_PCM_WAV:
 278         if (!get_wave_metadata(fd, id3))
 279         {
 280             return false;
 281         }
 282
 283         break;
 284
 285     case AFMT_WAVPACK:
 286         if (!get_wavpack_metadata(fd, id3))
 287         {
 288             return false;
 289         }
 290
 291         read_ape_tags(fd, id3);     /* use any apetag info we find */
 292         break;
 293
 294     case AFMT_A52:
 295         if (!get_a52_metadata(fd, id3))
 296         {
 297             return false;
 298         }
 299
 300         break;
 301
 302     case AFMT_MP4_ALAC:
 303     case AFMT_MP4_AAC:
 304         if (!get_mp4_metadata(fd, id3))
 305         {
 306             return false;
 307         }
 308
 309         break;
 310
 311     case AFMT_MOD:
 312         if (!get_mod_metadata(fd, id3))
 313         {
 314             return false;
 315         }
 316
 317         break;
 318
 319     case AFMT_SHN:
 320         id3->vbr = true;
 321         id3->filesize = filesize(fd);
 322         if (!skip_id3v2(fd, id3))
 323         {
 324             return false;
 325         }
 326         /* TODO: read the id3v2 header if it exists */
 327         break;
 328
 329     case AFMT_SID:
 330         if (!get_sid_metadata(fd, id3))
 331         {
 332             return false;
 333         }
 334         break;
 335
 336     case AFMT_SPC:
 337         if (!get_spc_metadata(fd, id3))
 338         {
 339             DEBUGF("get_spc_metadata error\n");
 340             return false;
 341         }
 342         id3->filesize = filesize(fd);
 343         id3->genre_string = id3_get_num_genre(36);
 344         break;
 345
 346     case AFMT_ADX:
 347         if (!get_adx_metadata(fd, id3))
 348         {
 349             DEBUGF("get_adx_metadata error\n");
 350             return false;
 351         }
 352
 353         break;
 354
 355     case AFMT_NSF:
 356         buf = (unsigned char *)id3->path;
 357         if ((lseek(fd, 0, SEEK_SET) < 0) || ((read(fd, buf, 8)) < 8))
 358         {
 359             DEBUGF("lseek or read failed\n");
 360             return false;
 361         }
 362         id3->vbr = false;
 363         id3->filesize = filesize(fd);
 364         if (memcmp(buf,"NESM",4) && memcmp(buf,"NSFE",4)) return false;
 365         break;
 366
 367     case AFMT_AIFF:
 368         if (!get_aiff_metadata(fd, id3))
 369         {
 370             return false;
 371         }
 372
 373         break;
 374
 375     case AFMT_SAP:
 376         if (!get_asap_metadata(fd, id3))
 377         {
 378             DEBUGF("get_sap_metadata error\n");
 379             return false;
 380         }
 381         id3->filesize = filesize(fd);
 382         id3->genre_string = id3_get_num_genre(36);
 383         break;
 384
 385     case AFMT_RM_COOK:
 386         if (!get_rm_metadata(fd, id3))
 387         {
 388             DEBUGF("get_rm_metadata error\n");
 389             return false;
 390         }
 391         break;
 392
 393 #endif /* CONFIG_CODEC == SWCODEC */
 394
 395     default:
 396         /* If we don't know how to read the metadata, assume we can't play
 397            the file */
 398         return false;
 399         break;
 400     }
 401
 402     /* We have successfully read the metadata from the file */
 403
 404     lseek(fd, 0, SEEK_SET);
 405     strlcpy(id3->path, trackname, sizeof(id3->path));
 406
 407     return true;
 408 }
 409
 410 #ifndef __PCTOOL__
 411 #if CONFIG_CODEC == SWCODEC
 412 void strip_tags(int handle_id)
 413 {
 414     static const unsigned char tag[] = "TAG";
 415     static const unsigned char apetag[] = "APETAGEX";
 416     size_t len, version;
 417     void *tail;
 418
 419     if (bufgettail(handle_id, 128, &tail) != 128)
 420         return;
 421
 422     if (memcmp(tail, tag, 3) == 0)
 423     {
 424         /* Skip id3v1 tag */
 425         logf("Cutting off ID3v1 tag");
 426         bufcuttail(handle_id, 128);
 427     }
 428
 429     /* Get a new tail, as the old one may have been cut */
 430     if (bufgettail(handle_id, 32, &tail) != 32)
 431         return;
 432
 433     /* Check for APE tag (look for the APE tag footer) */
 434     if (memcmp(tail, apetag, 8) != 0)
 435         return;
 436
 437     /* Read the version and length from the footer */
 438     version = get_long_le(&((unsigned char *)tail)[8]);
 439     len = get_long_le(&((unsigned char *)tail)[12]);
 440     if (version == 2000)
 441         len += 32; /* APEv2 has a 32 byte header */
 442
 443     /* Skip APE tag */
 444     logf("Cutting off APE tag (%ldB)", len);
 445     bufcuttail(handle_id, len);
 446 }
 447 #endif /* CONFIG_CODEC == SWCODEC */
 448 #endif /* ! __PCTOOL__ */
 449
 450 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig)
 451 {
 452     long offset;
 453     if (orig > dest)
 454         offset = - ((size_t)orig - (size_t)dest);
 455     else
 456         offset = (size_t)dest - (size_t)orig;
 457
 458     if (entry->title)
 459         entry->title += offset;
 460     if (entry->artist)
 461         entry->artist += offset;
 462     if (entry->album)
 463         entry->album += offset;
 464     if (entry->genre_string > (char*)orig
 465          && entry->genre_string < (char*)orig + sizeof(struct mp3entry))
 466         /* Don't adjust that if it points to an entry of the "genres" array */
 467         entry->genre_string += offset;
 468     if (entry->track_string)
 469         entry->track_string += offset;
 470     if (entry->disc_string)
 471         entry->disc_string += offset;
 472     if (entry->year_string)
 473         entry->year_string += offset;
 474     if (entry->composer)
 475         entry->composer += offset;
 476     if (entry->comment)
 477         entry->comment += offset;
 478     if (entry->albumartist)
 479         entry->albumartist += offset;
 480     if (entry->grouping)
 481         entry->grouping += offset;
 482 #if CONFIG_CODEC == SWCODEC
 483     if (entry->track_gain_string)
 484         entry->track_gain_string += offset;
 485     if (entry->album_gain_string)
 486         entry->album_gain_string += offset;
 487 #endif
 488     if (entry->mb_track_id)
 489         entry->mb_track_id += offset;
 490 }
 491
 492 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig)
 493 {
 494     memcpy(dest, orig, sizeof(struct mp3entry));
 495     adjust_mp3entry(dest, dest, orig);
 496 }