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 "file.h"
  27 #include "config.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_ALAC,         /* Apple Lossless Audio Codec */
  53     AFMT_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_MOD,          /* Amiga MOD File Format */
  63     AFMT_SAP,          /* Amiga 8Bit SAP Format */
  64     AFMT_COOK,         /* Cook in RM/RA */
  65 #endif
  66
  67     /* add new formats at any index above this line to have a sensible order -
  68        specified array index inits are used */
  69     /* format arrays defined in id3.c */
  70
  71     AFMT_NUM_CODECS,
  72
  73 #if CONFIG_CODEC == SWCODEC && defined(HAVE_RECORDING)
  74     /* masks to decompose parts */
  75     CODEC_AFMT_MASK    = 0x0fff,
  76     CODEC_TYPE_MASK    = 0x7000,
  77
  78     /* switch for specifying codec type when requesting a filename */
  79     CODEC_TYPE_DECODER = (0 << 12), /* default */
  80     CODEC_TYPE_ENCODER = (1 << 12),
  81 #endif /* CONFIG_CODEC == SWCODEC && defined(HAVE_RECORDING) */
  82 };
  83
  84 #if CONFIG_CODEC == SWCODEC
  85 #define CODEC_EXTENSION "codec"
  86
  87 #ifdef HAVE_RECORDING
  88 #define ENCODER_SUFFIX  "_enc"
  89 enum rec_format_indexes
  90 {
  91     __REC_FORMAT_START_INDEX = -1,
  92
  93     /* start formats */
  94
  95     REC_FORMAT_PCM_WAV,
  96     REC_FORMAT_AIFF,
  97     REC_FORMAT_WAVPACK,
  98     REC_FORMAT_MPA_L3,
  99
 100     /* add new formats at any index above this line to have a sensible order -
 101        specified array index inits are used
 102        REC_FORMAT_CFG_NUM_BITS should allocate enough bits to hold the range
 103        REC_FORMAT_CFG_VALUE_LIST should be in same order as indexes
 104     */
 105
 106     REC_NUM_FORMATS,
 107
 108     REC_FORMAT_DEFAULT = REC_FORMAT_PCM_WAV,
 109     REC_FORMAT_CFG_NUM_BITS = 2
 110 };
 111
 112 #define REC_FORMAT_CFG_VAL_LIST "wave,aiff,wvpk,mpa3"
 113
 114 /* get REC_FORMAT_* corresponding AFMT_* */
 115 extern const int rec_format_afmt[REC_NUM_FORMATS];
 116 /* get AFMT_* corresponding REC_FORMAT_* */
 117 extern const int afmt_rec_format[AFMT_NUM_CODECS];
 118
 119 #define AFMT_ENTRY(label, root_fname, enc_root_fname, ext_list) \
 120     { label, root_fname, enc_root_fname, ext_list }
 121 #else /* !HAVE_RECORDING */
 122 #define AFMT_ENTRY(label, root_fname, enc_root_fname, ext_list) \
 123     { label, root_fname, ext_list }
 124 #endif /* HAVE_RECORDING */
 125
 126 #else /* !SWCODEC */
 127
 128 #define AFMT_ENTRY(label, root_fname, enc_root_fname, ext_list) \
 129     { label, ext_list }
 130 #endif /* CONFIG_CODEC == SWCODEC */
 131
 132 /** Database of audio formats **/
 133 /* record describing the audio format */
 134 struct afmt_entry
 135 {
 136     char label[8];      /* format label */
 137 #if CONFIG_CODEC == SWCODEC
 138     char *codec_root_fn; /* root codec filename (sans _enc and .codec) */
 139 #ifdef HAVE_RECORDING
 140     char *codec_enc_root_fn; /* filename of encoder codec */
 141 #endif
 142 #endif
 143     char *ext_list;     /* double NULL terminated extension
 144                            list for type with the first as
 145                            the default for recording */
 146 };
 147
 148 /* database of labels and codecs. add formats per above enum */
 149 extern const struct afmt_entry audio_formats[AFMT_NUM_CODECS];
 150
 151 #if MEMORYSIZE > 2
 152 #define ID3V2_BUF_SIZE 900
 153 #else
 154 #define ID3V2_BUF_SIZE 300
 155 #endif
 156
 157 enum {
 158     ID3_VER_1_0 = 1,
 159     ID3_VER_1_1,
 160     ID3_VER_2_2,
 161     ID3_VER_2_3,
 162     ID3_VER_2_4
 163 };
 164
 165 struct mp3entry {
 166     char path[MAX_PATH];
 167     char* title;
 168     char* artist;
 169     char* album;
 170     char* genre_string;
 171     char* disc_string;
 172     char* track_string;
 173     char* year_string;
 174     char* composer;
 175     char* comment;
 176     char* albumartist;
 177     char* grouping;
 178     int discnum;
 179     int tracknum;
 180     int version;
 181     int layer;
 182     int year;
 183     unsigned char id3version;
 184     unsigned int codectype;
 185     unsigned int bitrate;
 186     unsigned long frequency;
 187     unsigned long id3v2len;
 188     unsigned long id3v1len;
 189     unsigned long first_frame_offset; /* Byte offset to first real MP3 frame.
 190                                          Used for skipping leading garbage to
 191                                          avoid gaps between tracks. */
 192     unsigned long vbr_header_pos;
 193     unsigned long filesize; /* without headers; in bytes */
 194     unsigned long length;   /* song length in ms */
 195     unsigned long elapsed;  /* ms played */
 196
 197     int lead_trim;          /* Number of samples to skip at the beginning */
 198     int tail_trim;          /* Number of samples to remove from the end */
 199
 200     /* Added for Vorbis */
 201     unsigned long samples;  /* number of samples in track */
 202
 203     /* MP3 stream specific info */
 204     unsigned long frame_count; /* number of frames in the file (if VBR) */
 205
 206     /* Used for A52/AC3 */
 207     unsigned long bytesperframe; /* number of bytes per frame (if CBR) */
 208
 209     /* Xing VBR fields */
 210     bool vbr;
 211     bool has_toc;           /* True if there is a VBR header in the file */
 212     unsigned char toc[100]; /* table of contents */
 213
 214     /* these following two fields are used for local buffering */
 215     char id3v2buf[ID3V2_BUF_SIZE];
 216     char id3v1buf[4][92];
 217
 218     /* resume related */
 219     unsigned long offset;  /* bytes played */
 220     int index;             /* playlist index */
 221
 222     /* runtime database fields */
 223     long tagcache_idx;     /* 0=invalid, otherwise idx+1 */
 224     int rating;
 225     int score;
 226     long playcount;
 227     long lastplayed;
 228     long playtime;
 229
 230     /* replaygain support */
 231
 232 #if CONFIG_CODEC == SWCODEC
 233     char* track_gain_string;
 234     char* album_gain_string;
 235     long track_gain;    /* 7.24 signed fixed point. 0 for no gain. */
 236     long album_gain;
 237     long track_peak;    /* 7.24 signed fixed point. 0 for no peak. */
 238     long album_peak;
 239 #endif
 240
 241     /* Cuesheet support */
 242     int cuesheet_type;      /* 0: none, 1: external, 2: embedded */
 243
 244     /* Musicbrainz Track ID */
 245     char* mb_track_id;
 246 };
 247
 248 unsigned int probe_file_format(const char *filename);
 249 bool get_metadata(struct mp3entry* id3, int fd, const char* trackname);
 250 bool mp3info(struct mp3entry *entry, const char *filename);
 251 void adjust_mp3entry(struct mp3entry *entry, void *dest, const void *orig);
 252 void copy_mp3entry(struct mp3entry *dest, const struct mp3entry *orig);
 253 #if CONFIG_CODEC == SWCODEC
 254 void strip_tags(int handle_id);
 255 #endif
 256
 257 #endif
 258
 259