apps/metadata.h

   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
  22 #ifndef _METADATA_H
  23 #define _METADATA_H
  24
  25 #include <stdbool.h>
  26 #include "config.h"
  27 #include "file.h"
  28
  29
  30 /* Audio file types. */
  31 /* NOTE: The values of the AFMT_* items are used for the %fc tag in the WPS
  32          - so new entries MUST be added to the end to maintain compatibility.
  33  */
  34 enum
  35 {
  36     AFMT_UNKNOWN = 0,  /* Unknown file format */
  37
  38     /* start formats */
  39
  40     AFMT_MPA_L1,       /* MPEG Audio layer 1 */
  41     AFMT_MPA_L2,       /* MPEG Audio layer 2 */
  42     AFMT_MPA_L3,       /* MPEG Audio layer 3 */
  43
  44 #if CONFIG_CODEC == SWCODEC
  45     AFMT_AIFF,         /* Audio Interchange File Format */
  46     AFMT_PCM_WAV,      /* Uncompressed PCM in a WAV file */
  47     AFMT_OGG_VORBIS,   /* Ogg Vorbis */
  48     AFMT_FLAC,         /* FLAC */
  49     AFMT_MPC,          /* Musepack */
  50     AFMT_A52,          /* A/52 (aka AC3) audio */
  51     AFMT_WAVPACK,      /* WavPack */
  52     AFMT_MP4_ALAC,     /* Apple Lossless Audio Codec */
  53     AFMT_MP4_AAC,      /* Advanced Audio Coding (AAC) in M4A container */
  54     AFMT_SHN,          /* Shorten */
  55     AFMT_SID,          /* SID File Format */
  56     AFMT_ADX,          /* ADX File Format */
  57     AFMT_NSF,          /* NESM (NES Sound Format) */
  58     AFMT_SPEEX,        /* Ogg Speex speech */
  59     AFMT_SPC,          /* SPC700 save state */
  60     AFMT_APE,          /* Monkey's Audio (APE) */
  61     AFMT_WMA,          /* WMAV1/V2 in ASF */
  62     AFMT_WMAPRO,       /* WMA Professional in ASF */
  63     AFMT_MOD,          /* Amiga MOD File Format */
  64     AFMT_SAP,          /* Atari 8Bit SAP Format */
  65     AFMT_RM_COOK,      /* Cook in RM/RA */
  66     AFMT_RM_AAC,       /* AAC in RM/RA */
  67     AFMT_RM_AC3,       /* AC3 in RM/RA */
  68     AFMT_RM_ATRAC3,    /* ATRAC3 in RM/RA */
  69     AFMT_CMC,          /* Atari 8bit cmc format */
  70     AFMT_CM3,          /* Atari 8bit cm3 format */
  71     AFMT_CMR,          /* Atari 8bit cmr format */
  72     AFMT_CMS,          /* Atari 8bit cms format */
  73     AFMT_DMC,          /* Atari 8bit dmc format */
  74     AFMT_DLT,          /* Atari 8bit dlt format */
  75     AFMT_MPT,          /* Atari 8bit mpt format */
  76     AFMT_MPD,          /* Atari 8bit mpd format */
  77     AFMT_RMT,          /* Atari 8bit rmt format */
  78     AFMT_TMC,          /* Atari 8bit tmc format */
  79     AFMT_TM8,          /* Atari 8bit tm8 format */
  80     AFMT_TM2,          /* Atari 8bit tm2 format */
  81     AFMT_OMA_ATRAC3,   /* Atrac3 in Sony OMA container */
  82     AFMT_SMAF,         /* SMAF */
  83     AFMT_AU,           /* Sun Audio file */
  84     AFMT_VOX,          /* VOX */
  85     AFMT_WAVE64,       /* Wave64 */
  86     AFMT_TTA,          /* True Audio */
  87     AFMT_WMAVOICE,     /* WMA Voice in ASF */
  88 #endif
  89
  90     /* add new formats at any index above this line to have a sensible order -
  91        specified array index inits are used */
  92     /* format arrays defined in id3.c */
  93
  94     AFMT_NUM_CODECS,
  95
  96 #if CONFIG_CODEC == SWCODEC && defined(HAVE_RECORDING)
  97     /* masks to decompose parts */
  98     CODEC_AFMT_MASK    = 0x0fff,
  99     CODEC_TYPE_MASK    = 0x7000,
 100
 101     /* switch for specifying codec type when requesting a filename */
 102     CODEC_TYPE_DECODER = (0 << 12), /* default */
 103     CODEC_TYPE_ENCODER = (1 << 12),
 104 #endif /* CONFIG_CODEC == SWCODEC && defined(HAVE_RECORDING) */
 105 };
 106
 107 #if CONFIG_CODEC == SWCODEC
 108 #define CODEC_EXTENSION "codec"
 109
 110 #ifdef HAVE_RECORDING
 111 enum rec_format_indexes
 112 {
 113     __REC_FORMAT_START_INDEX = -1,
 114
 115     /* start formats */
 116
 117     REC_FORMAT_PCM_WAV,
 118     REC_FORMAT_AIFF,
 119     REC_FORMAT_WAVPACK,
 120     REC_FORMAT_MPA_L3,
 121
 122     /* add new formats at any index above this line to have a sensible order -
 123        specified array index inits are used
 124        REC_FORMAT_CFG_NUM_BITS should allocate enough bits to hold the range
 125        REC_FORMAT_CFG_VALUE_LIST should be in same order as indexes
 126     */
 127
 128     REC_NUM_FORMATS,
 129
 130     REC_FORMAT_DEFAULT = REC_FORMAT_PCM_WAV,
 131     REC_FORMAT_CFG_NUM_BITS = 2
 132 };
 133
 134 #define REC_FORMAT_CFG_VAL_LIST "wave,aiff,wvpk,mpa3"
 135
 136 /* get REC_FORMAT_* corresponding AFMT_* */
 137 extern const int rec_format_afmt[REC_NUM_FORMATS];
 138 /* get AFMT_* corresponding REC_FORMAT_* */
 139 extern const int afmt_rec_format[AFMT_NUM_CODECS];
 140
 141 #define AFMT_ENTRY(label, root_fname, enc_root_fname, func, ext_list) \
 142     { label, root_fname, enc_root_fname, func, ext_list }
 143 #else /* !HAVE_RECORDING */
 144 #define AFMT_ENTRY(label, root_fname, enc_root_fname, func, ext_list) \
 145     { label, root_fname, func, ext_list }
 146 #endif /* HAVE_RECORDING */
 147
 148 #else /* !SWCODEC */
 149
 150 #define AFMT_ENTRY(label, root_fname, enc_root_fname, func, ext_list) \
 151     { label, func, ext_list }
 152 #endif /* CONFIG_CODEC == SWCODEC */
 153
 154 /** Database of audio formats **/
 155 /* record describing the audio format */
 156 struct mp3entry;
 157 struct afmt_entry
 158 {
 159     const char *label;      /* format label */
 160 #if CONFIG_CODEC == SWCODEC
 161     const char *codec_root_fn; /* root codec filename (sans _enc and .codec) */
 162 #ifdef HAVE_RECORDING
 163     const char *codec_enc_root_fn; /* filename of encoder codec */
 164 #endif
 165 #endif
 166     bool (*parse_func)(int fd, struct mp3entry *id3); /* return true on success */
 167     const char *ext_list;    /* NULL terminated extension
 168                                list for type with the first as
 169                                the default for recording */
 170 };
 171
 172 /* database of labels and codecs. add formats per above enum */
 173 extern const struct afmt_entry audio_formats[AFMT_NUM_CODECS];
 174
 175 #if MEMORYSIZE > 2
 176 #define ID3V2_BUF_SIZE 900
 177 #else
 178 #define ID3V2_BUF_SIZE 300
 179 #endif
 180
 181 enum {
 182     ID3_VER_1_0 = 1,
 183     ID3_VER_1_1,
 184     ID3_VER_2_2,
 185     ID3_VER_2_3,
 186     ID3_VER_2_4
 187 };
 188
 189 struct mp3entry {
 190     char path[MAX_PATH];
 191     char* title;
 192     char* artist;
 193     char* album;
 194     char* genre_string;
 195     char* disc_string;
 196     char* track_string;
 197     char* year_string;
 198     char* composer;
 199     char* comment;
 200     char* albumartist;
 201     char* grouping;
 202     int discnum;
 203     int tracknum;
 204     int version;
 205     int layer;
 206     int year;
 207     unsigned char id3version;
 208     unsigned int codectype;
 209     unsigned int bitrate;
 210     unsigned long frequency;
 211     unsigned long id3v2len;
 212     unsigned long id3v1len;
 213     unsigned long first_frame_offset; /* Byte offset to first real MP3 frame.
 214                                          Used for skipping leading garbage to
 215                                          avoid gaps between tracks. */
 216     unsigned long vbr_header_pos;
 217     unsigned long filesize; /* without headers; in bytes */
 218     unsigned long length;   /* song length in ms */
 219     unsigned long elapsed;  /* ms played */
 220
 221     int lead_trim;          /* Number of samples to skip at the beginning */
 222     int tail_trim;          /* Number of samples to remove from the end */
 223
 224     /* Added for Vorbis */
 225     unsigned long samples;  /* number of samples in track */
 226
 227     /* MP3 stream specific info */
 228     unsigned long frame_count; /* number of frames in the file (if VBR) */
 229
 230     /* Used for A52/AC3 */
 231     unsigned long bytesperframe; /* number of bytes per frame (if CBR) */
 232
 233     /* Xing VBR fields */
 234     bool vbr;
 235     bool has_toc;           /* True if there is a VBR header in the file */
 236     unsigned char toc[100]; /* table of contents */
 237
 238     /* Added for ATRAC3 */
 239     unsigned int channels;       /* Number of channels in the stream */
 240     unsigned int extradata_size; /* Size (in bytes) of the codec's extradata from the container */
 241     /* these following two fields are used for local buffering */
 242     char id3v2buf[ID3V2_BUF_SIZE];
 243     char id3v1buf[4][92];
 244
 245     /* resume related */
 246     unsigned long offset;  /* bytes played */
 247     int index;             /* playlist index */
 248
 249 #ifdef HAVE_TAGCACHE
 250     /* runtime database fields */
 251     long tagcache_idx;     /* 0=invalid, otherwise idx+1 */
 252     int rating;
 253     int score;
 254     long playcount;
 255     long lastplayed;
 256     long playtime;
 257 #endif
 258
 259     /* replaygain support */
 260
 261 #if CONFIG_CODEC == SWCODEC
 262     char* track_gain_string;
 263     char* album_gain_string;
 264     long track_gain;    /* 7.24 signed fixed point. 0 for no gain. */
 265     long album_gain;
 266     long track_peak;    /* 7.24 signed fixed point. 0 for no peak. */
 267     long album_peak;
 268 #endif
 269
 270     /* Cuesheet support */
 271     struct cuesheet *cuesheet;
 272
 273     /* Musicbrainz Track ID */
 274     char* mb_track_id;
 275 };
 276
 277 unsigned int probe_file_format(const char *filename);
 278 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname);
 279 bool mp3info(struct mp3entry *entry, const char *filename);
 280 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig);
 281 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig);
 282 #if CONFIG_CODEC == SWCODEC
 283 void strip_tags(int handle_id);
 284 #endif
 285
 286 #endif
 287
 288