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