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