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 <stdlib.h>
  23 #include <ctype.h>
  24 #include "string-extra.h"
  25
  26 #include "debug.h"
  27 #include "logf.h"
  28 #include "cuesheet.h"
  29 #include "metadata.h"
  30
  31 #include "metadata/metadata_parsers.h"
  32
  33 #if CONFIG_CODEC == SWCODEC
  34
  35 /* For trailing tag stripping */
  36 #include "buffering.h"
  37
  38 #include "metadata/metadata_common.h"
  39
  40 static bool get_shn_metadata(int fd, struct mp3entry *id3)
  41 {
  42     /* TODO: read the id3v2 header if it exists */
  43     id3->vbr = true;
  44     id3->filesize = filesize(fd);
  45     return skip_id3v2(fd, id3);
  46 }
  47
  48 static bool get_other_asap_metadata(int fd, struct mp3entry *id3)
  49 {
  50     id3->bitrate = 706;
  51     id3->frequency = 44100;
  52     id3->vbr = false;
  53     id3->filesize = filesize(fd);
  54     id3->genre_string = id3_get_num_genre(36);
  55     return true;
  56 }
  57 #endif /* CONFIG_CODEC == SWCODEC */
  58 bool write_metadata_log = false;
  59
  60 const struct afmt_entry audio_formats[AFMT_NUM_CODECS] =
  61 {
  62     /* Unknown file format */
  63     [AFMT_UNKNOWN] =
  64         AFMT_ENTRY("???", NULL,    NULL,        NULL, NULL  ),
  65
  66     /* MPEG Audio layer 1 */
  67     [AFMT_MPA_L1] =
  68         AFMT_ENTRY("MP1",   "mpa",  NULL,       get_mp3_metadata,   "mp1\0"),
  69     /* MPEG Audio layer 2 */
  70     [AFMT_MPA_L2] =
  71         AFMT_ENTRY("MP2",   "mpa",  NULL,       get_mp3_metadata,   "mpa\0mp2\0"),
  72     /* MPEG Audio layer 3 */
  73     [AFMT_MPA_L3] =
  74         AFMT_ENTRY("MP3",   "mpa",  "mp3_enc",  get_mp3_metadata,   "mp3\0"),
  75
  76 #if CONFIG_CODEC == SWCODEC
  77     /* Audio Interchange File Format */
  78     [AFMT_AIFF] =
  79         AFMT_ENTRY("AIFF",  "aiff", "aiff_enc", get_aiff_metadata,  "aiff\0aif\0"),
  80     /* Uncompressed PCM in a WAV file OR ATRAC3 stream in WAV file (.at3) */
  81     [AFMT_PCM_WAV] =
  82         AFMT_ENTRY("WAV",   "wav",  "wav_enc",  get_wave_metadata,  "wav\0at3\0"),
  83     /* Ogg Vorbis */
  84     [AFMT_OGG_VORBIS] =
  85         AFMT_ENTRY("Ogg", "vorbis", NULL,       get_ogg_metadata,   "ogg\0oga\0"),
  86     /* FLAC */
  87     [AFMT_FLAC] =
  88         AFMT_ENTRY("FLAC",  "flac", NULL,       get_flac_metadata,  "flac\0"),
  89     /* Musepack */
  90     [AFMT_MPC] =
  91         AFMT_ENTRY("MPC",   "mpc",  NULL,       get_musepack_metadata,"mpc\0"),
  92     /* A/52 (aka AC3) audio */
  93     [AFMT_A52] =
  94         AFMT_ENTRY("AC3",   "a52",  NULL,       get_a52_metadata,   "a52\0ac3\0"),
  95     /* WavPack */
  96     [AFMT_WAVPACK] =
  97         AFMT_ENTRY("WV","wavpack","wavpack_enc",get_wavpack_metadata,"wv\0"),
  98     /* Apple Lossless Audio Codec */
  99     [AFMT_MP4_ALAC] =
 100         AFMT_ENTRY("ALAC",  "alac", NULL,       get_mp4_metadata,   "m4a\0m4b\0"),
 101     /* Advanced Audio Coding in M4A container */
 102     [AFMT_MP4_AAC] =
 103         AFMT_ENTRY("AAC",   "aac",  NULL,       get_mp4_metadata,   "mp4\0"),
 104     /* Shorten */
 105     [AFMT_SHN] =
 106         AFMT_ENTRY("SHN","shorten", NULL,       get_shn_metadata,   "shn\0"),
 107     /* SID File Format */
 108     [AFMT_SID] =
 109         AFMT_ENTRY("SID",   "sid",  NULL,       get_sid_metadata,   "sid\0"),
 110     /* ADX File Format */
 111     [AFMT_ADX] =
 112         AFMT_ENTRY("ADX",   "adx",  NULL,       get_adx_metadata,   "adx\0"),
 113     /* NESM (NES Sound Format) */
 114     [AFMT_NSF] =
 115         AFMT_ENTRY("NSF",   "nsf",  NULL,       get_nsf_metadata,   "nsf\0nsfe\0"),
 116     /* Speex File Format */
 117     [AFMT_SPEEX] =
 118         AFMT_ENTRY("Speex", "speex",NULL,       get_ogg_metadata,   "spx\0"),
 119     /* SPC700 Save State */
 120     [AFMT_SPC] =
 121         AFMT_ENTRY("SPC",   "spc",  NULL,       get_spc_metadata,   "spc\0"),
 122     /* APE (Monkey's Audio) */
 123     [AFMT_APE] =
 124         AFMT_ENTRY("APE",   "ape",  NULL,       get_monkeys_metadata,"ape\0mac\0"),
 125     /* WMA (WMAV1/V2 in ASF) */
 126     [AFMT_WMA] =
 127         AFMT_ENTRY("WMA",   "wma",  NULL,       get_asf_metadata,"wma\0wmv\0asf\0"),
 128     /* WMA Professional in ASF */
 129     [AFMT_WMAPRO] =
 130         AFMT_ENTRY("WMAPro","wmapro",NULL,      NULL,            "wma\0wmv\0asf\0"),
 131     /* Amiga MOD File */
 132     [AFMT_MOD] =
 133         AFMT_ENTRY("MOD",   "mod",  NULL,       get_mod_metadata,   "mod\0"),
 134     /* Atari SAP File */
 135     [AFMT_SAP] =
 136         AFMT_ENTRY("SAP",   "asap", NULL,       get_asap_metadata,  "sap\0"),
 137     /* Cook in RM/RA */
 138     [AFMT_RM_COOK] =
 139         AFMT_ENTRY("Cook",  "cook", NULL,       get_rm_metadata,"rm\0ra\0rmvb\0"),
 140     /* AAC in RM/RA */
 141     [AFMT_RM_AAC] =
 142         AFMT_ENTRY("RAAC",  "raac", NULL,       NULL,           "rm\0ra\0rmvb\0"),
 143     /* AC3 in RM/RA */
 144     [AFMT_RM_AC3] =
 145         AFMT_ENTRY("AC3", "a52_rm", NULL,       NULL,           "rm\0ra\0rmvb\0"),
 146     /* ATRAC3 in RM/RA */
 147     [AFMT_RM_ATRAC3] =
 148         AFMT_ENTRY("ATRAC3","atrac3_rm",NULL,   NULL,           "rm\0ra\0rmvb\0"),
 149     /* Atari CMC File */
 150     [AFMT_CMC] =
 151         AFMT_ENTRY("CMC",   "asap", NULL,       get_other_asap_metadata,"cmc\0"),
 152     /* Atari CM3 File */
 153     [AFMT_CM3] =
 154         AFMT_ENTRY("CM3",   "asap", NULL,       get_other_asap_metadata,"cm3\0"),
 155     /* Atari CMR File */
 156     [AFMT_CMR] =
 157         AFMT_ENTRY("CMR",   "asap", NULL,       get_other_asap_metadata,"cmr\0"),
 158     /* Atari CMS File */
 159     [AFMT_CMS] =
 160         AFMT_ENTRY("CMS",   "asap", NULL,       get_other_asap_metadata,"cms\0"),
 161     /* Atari DMC File */
 162     [AFMT_DMC] =
 163         AFMT_ENTRY("DMC",   "asap", NULL,       get_other_asap_metadata,"dmc\0"),
 164     /* Atari DLT File */
 165     [AFMT_DLT] =
 166         AFMT_ENTRY("DLT",   "asap", NULL,       get_other_asap_metadata,"dlt\0"),
 167     /* Atari MPT File */
 168     [AFMT_MPT] =
 169         AFMT_ENTRY("MPT",   "asap", NULL,       get_other_asap_metadata,"mpt\0"),
 170     /* Atari MPD File */
 171     [AFMT_MPD] =
 172         AFMT_ENTRY("MPD",   "asap", NULL,       get_other_asap_metadata,"mpd\0"),
 173     /* Atari RMT File */
 174     [AFMT_RMT] =
 175         AFMT_ENTRY("RMT",   "asap", NULL,       get_other_asap_metadata,"rmt\0"),
 176     /* Atari TMC File */
 177     [AFMT_TMC] =
 178         AFMT_ENTRY("TMC",   "asap", NULL,       get_other_asap_metadata,"tmc\0"),
 179     /* Atari TM8 File */
 180     [AFMT_TM8] =
 181         AFMT_ENTRY("TM8",   "asap", NULL,       get_other_asap_metadata,"tm8\0"),
 182     /* Atari TM2 File */
 183     [AFMT_TM2] =
 184         AFMT_ENTRY("TM2",   "asap", NULL,       get_other_asap_metadata,"tm2\0"),
 185     /* Atrac3 in Sony OMA Container */
 186     [AFMT_OMA_ATRAC3] =
 187         AFMT_ENTRY("ATRAC3","atrac3_oma",NULL,  get_oma_metadata,   "oma\0aa3\0"),
 188     /* SMAF (Synthetic music Mobile Application Format) */
 189     [AFMT_SMAF] =
 190         AFMT_ENTRY("SMAF",  "smaf", NULL,       get_smaf_metadata,  "mmf\0"),
 191     /* Sun Audio file */
 192     [AFMT_AU] =
 193         AFMT_ENTRY("AU",    "au",   NULL,       get_au_metadata,    "au\0snd\0"),
 194     /* VOX (Dialogic telephony file formats) */
 195     [AFMT_VOX] =
 196         AFMT_ENTRY("VOX",   "vox",  NULL,       get_vox_metadata,   "vox\0"),
 197     /* Wave64 */
 198     [AFMT_WAVE64] =
 199         AFMT_ENTRY("WAVE64","wav64",NULL,       get_wave64_metadata,"w64\0"),
 200     /* True Audio */
 201     [AFMT_TTA] =
 202         AFMT_ENTRY("TTA",   "tta",  NULL,       get_tta_metadata,   "tta\0"),
 203     /* WMA Voice in ASF */
 204     [AFMT_WMAVOICE] =
 205         AFMT_ENTRY("WMAVoice","wmavoice",NULL,  NULL,               "wma\0wmv\0"),
 206 #endif
 207 };
 208
 209 #if CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING)
 210 /* get REC_FORMAT_* corresponding AFMT_* */
 211 const int rec_format_afmt[REC_NUM_FORMATS] =
 212 {
 213     /* give AFMT_UNKNOWN by default */
 214     [0 ... REC_NUM_FORMATS-1] = AFMT_UNKNOWN,
 215     /* add new entries below this line */
 216     [REC_FORMAT_AIFF]    = AFMT_AIFF,
 217     [REC_FORMAT_MPA_L3]  = AFMT_MPA_L3,
 218     [REC_FORMAT_WAVPACK] = AFMT_WAVPACK,
 219     [REC_FORMAT_PCM_WAV] = AFMT_PCM_WAV,
 220 };
 221
 222 /* get AFMT_* corresponding REC_FORMAT_* */
 223 const int afmt_rec_format[AFMT_NUM_CODECS] =
 224 {
 225     /* give -1 by default */
 226     [0 ... AFMT_NUM_CODECS-1] = -1,
 227     /* add new entries below this line */
 228     [AFMT_AIFF]    = REC_FORMAT_AIFF,
 229     [AFMT_MPA_L3]  = REC_FORMAT_MPA_L3,
 230     [AFMT_WAVPACK] = REC_FORMAT_WAVPACK,
 231     [AFMT_PCM_WAV] = REC_FORMAT_PCM_WAV,
 232 };
 233 #endif /* CONFIG_CODEC == SWCODEC && defined (HAVE_RECORDING) */
 234
 235
 236 /* Simple file type probing by looking at the filename extension. */
 237 unsigned int probe_file_format(const char *filename)
 238 {
 239     char *suffix;
 240     unsigned int i;
 241
 242     suffix = strrchr(filename, '.');
 243
 244     if (suffix == NULL)
 245     {
 246         return AFMT_UNKNOWN;
 247     }
 248
 249     /* skip '.' */
 250     suffix++;
 251
 252     for (i = 1; i < AFMT_NUM_CODECS; i++)
 253     {
 254         /* search extension list for type */
 255         const char *ext = audio_formats[i].ext_list;
 256
 257         do
 258         {
 259             if (strcasecmp(suffix, ext) == 0)
 260             {
 261                 return i;
 262             }
 263
 264             ext += strlen(ext) + 1;
 265         }
 266         while (*ext != '\0');
 267     }
 268
 269     return AFMT_UNKNOWN;
 270 }
 271
 272 /* Note, that this returns false for successful, true for error! */
 273 bool mp3info(struct mp3entry *entry, const char *filename)
 274 {
 275     int fd;
 276     bool result;
 277
 278     fd = open(filename, O_RDONLY);
 279     if (fd < 0)
 280         return true;
 281
 282     result = !get_mp3_metadata(fd, entry);
 283
 284     close(fd);
 285
 286     return result;
 287 }
 288
 289 /* Get metadata for track - return false if parsing showed problems with the
 290  * file that would prevent playback.
 291  */
 292 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname)
 293 {
 294     const struct afmt_entry *entry;
 295     int logfd = 0;
 296     DEBUGF("Read metadata for %s\n", trackname);
 297     if (write_metadata_log)
 298     {
 299         logfd = open("/metadata.log", O_WRONLY | O_APPEND | O_CREAT, 0666);
 300         if (logfd >= 0)
 301         {
 302             write(logfd, trackname, strlen(trackname));
 303             write(logfd, "\n", 1);
 304             close(logfd);
 305         }
 306     }
 307
 308     /* Clear the mp3entry to avoid having bogus pointers appear */
 309     memset(id3, 0, sizeof(struct mp3entry));
 310
 311     /* Take our best guess at the codec type based on file extension */
 312     id3->codectype = probe_file_format(trackname);
 313
 314     entry = &audio_formats[id3->codectype];
 315
 316     /* Load codec specific track tag information and confirm the codec type. */
 317     if (!entry->parse_func)
 318     {
 319         DEBUGF("nothing to parse for %s (format %s)", trackname, entry->label);
 320         return false;
 321     }
 322
 323     if (!entry->parse_func(fd, id3))
 324     {
 325         DEBUGF("parsing %s failed (format: %s)", trackname, entry->label);
 326         return false;
 327     }
 328
 329     lseek(fd, 0, SEEK_SET);
 330     strlcpy(id3->path, trackname, sizeof(id3->path));
 331     /* We have successfully read the metadata from the file */
 332     return true;
 333 }
 334
 335 #ifndef __PCTOOL__
 336 #if CONFIG_CODEC == SWCODEC
 337 void strip_tags(int handle_id)
 338 {
 339     static const unsigned char tag[] = "TAG";
 340     static const unsigned char apetag[] = "APETAGEX";
 341     size_t len, version;
 342     void *tail;
 343
 344     if (bufgettail(handle_id, 128, &tail) != 128)
 345         return;
 346
 347     if (memcmp(tail, tag, 3) == 0)
 348     {
 349         /* Skip id3v1 tag */
 350         logf("Cutting off ID3v1 tag");
 351         bufcuttail(handle_id, 128);
 352     }
 353
 354     /* Get a new tail, as the old one may have been cut */
 355     if (bufgettail(handle_id, 32, &tail) != 32)
 356         return;
 357
 358     /* Check for APE tag (look for the APE tag footer) */
 359     if (memcmp(tail, apetag, 8) != 0)
 360         return;
 361
 362     /* Read the version and length from the footer */
 363     version = get_long_le(&((unsigned char *)tail)[8]);
 364     len = get_long_le(&((unsigned char *)tail)[12]);
 365     if (version == 2000)
 366         len += 32; /* APEv2 has a 32 byte header */
 367
 368     /* Skip APE tag */
 369     logf("Cutting off APE tag (%ldB)", len);
 370     bufcuttail(handle_id, len);
 371 }
 372 #endif /* CONFIG_CODEC == SWCODEC */
 373 #endif /* ! __PCTOOL__ */
 374
 375 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig)
 376 {
 377     long offset;
 378     if (orig > dest)
 379         offset = - ((size_t)orig - (size_t)dest);
 380     else
 381         offset = (size_t)dest - (size_t)orig;
 382
 383     if (entry->title)
 384         entry->title += offset;
 385     if (entry->artist)
 386         entry->artist += offset;
 387     if (entry->album)
 388         entry->album += offset;
 389     if (entry->genre_string > (char*)orig
 390          && entry->genre_string < (char*)orig + sizeof(struct mp3entry))
 391         /* Don't adjust that if it points to an entry of the "genres" array */
 392         entry->genre_string += offset;
 393     if (entry->track_string)
 394         entry->track_string += offset;
 395     if (entry->disc_string)
 396         entry->disc_string += offset;
 397     if (entry->year_string)
 398         entry->year_string += offset;
 399     if (entry->composer)
 400         entry->composer += offset;
 401     if (entry->comment)
 402         entry->comment += offset;
 403     if (entry->albumartist)
 404         entry->albumartist += offset;
 405     if (entry->grouping)
 406         entry->grouping += offset;
 407 #if CONFIG_CODEC == SWCODEC
 408     if (entry->track_gain_string)
 409         entry->track_gain_string += offset;
 410     if (entry->album_gain_string)
 411         entry->album_gain_string += offset;
 412 #endif
 413     if (entry->mb_track_id)
 414         entry->mb_track_id += offset;
 415 }
 416
 417 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig)
 418 {
 419     memcpy(dest, orig, sizeof(struct mp3entry));
 420     adjust_mp3entry(dest, dest, orig);
 421 }