mp3_afh.c

   1 /*
   2  * Copyright (C) 2003-2007 Andre Noll <maan@systemlinux.org>
   3  *
   4  *     This program is free software; you can redistribute it and/or modify
   5  *     it under the terms of the GNU General Public License as published by
   6  *     the Free Software Foundation; either version 2 of the License, or
   7  *     (at your option) any later version.
   8  *
   9  *     This program is distributed in the hope that it will be useful,
  10  *     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *     GNU General Public License for more details.
  13  *
  14  *     You should have received a copy of the GNU General Public License
  15  *     along with this program; if not, write to the Free Software
  16  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  17  */
  18
  19 /** \file mp3_afh.c para_server's mp3 audio format handler */
  20
  21 /*
  22  * This file is based in part on mp3tech.c and mp3tech.h, Copyright (C)
  23  * 2000-2001 Cedric Tefft <cedric@earthling.net>, which in turn is based
  24  * in part on
  25  *
  26  *      * MP3Info 0.5 by Ricardo Cerqueira <rmc@rccn.net>
  27  *      * MP3Stat 0.9 by Ed Sweetman <safemode@voicenet.com> and
  28  *                       Johannes Overmann <overmann@iname.com>
  29  */
  30
  31 #include "server.cmdline.h"
  32 #include "server.h"
  33 #include "vss.h"
  34 #include "error.h"
  35 #include "fd.h"
  36 #include "string.h"
  37
  38 /** \cond some defines and structs which are only used in this file */
  39
  40 /*
  41  * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
  42  * to see before we decide we are looking at a real MP3 file
  43  */
  44 #define MIN_CONSEC_GOOD_FRAMES 4
  45 #define FRAME_HEADER_SIZE 4
  46 #define MIN_FRAME_SIZE 21
  47
  48 struct mp3header {
  49         unsigned long sync;
  50         unsigned int version;
  51         unsigned int layer;
  52         unsigned int crc;
  53         unsigned int bitrate;
  54         unsigned int freq;
  55         unsigned int padding;
  56         unsigned int mode;
  57         unsigned int copyright;
  58         unsigned int original;
  59         unsigned int emphasis;
  60 };
  61
  62 struct id3tag {
  63         char title[31];
  64         char artist[31];
  65         char album[31];
  66         char year[5];
  67         char comment[31];
  68 };
  69
  70 struct mp3info {
  71         struct mp3header header;
  72         int id3_isvalid;
  73         struct id3tag id3;
  74         int vbr;
  75         long unsigned br_average;
  76         int freq;
  77 };
  78
  79 /** \endcond */
  80 static const int frequencies[3][4] = {
  81         {22050,24000,16000,50000}, /* MPEG 2.0 */
  82         {44100,48000,32000,50000}, /* MPEG 1.0 */
  83         {11025,12000,8000,50000} /* MPEG 2.5 */
  84 };
  85
  86 static const int mp3info_bitrate[2][3][14] = {
  87 { /* MPEG 2.0 */
  88         {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
  89         {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
  90         {8,16,24,32,40,48,56,64,80,96,112,128,144,160} /* layer 3 */
  91 },
  92
  93 { /* MPEG 1.0 */
  94         {32,64,96,128,160,192,224,256,288,320,352,384,416,448}, /* layer 1 */
  95         {32,48,56,64,80,96,112,128,160,192,224,256,320,384}, /* layer 2 */
  96         {32,40,48,56,64,80,96,112,128,160,192,224,256,320} /* layer 3 */
  97 }
  98 };
  99
 100 static const int frame_size_index[] = {24000, 72000, 72000};
 101 static const char *mode_text[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
 102
 103 static struct mp3info mp3;
 104
 105 static int header_frequency(struct mp3header *h)
 106 {
 107         if (h->version > 2 || h->freq > 3)
 108                 return -E_HEADER_FREQ;
 109         return frequencies[h->version][h->freq];
 110 }
 111
 112 static const char *header_mode(struct mp3header *h)
 113 {
 114         if (h->mode > 4)
 115                 h->mode = 4; /* invalid */
 116         return mode_text[h->mode];
 117 }
 118 static int header_bitrate(struct mp3header *h)
 119 {
 120         if (h->layer > 3 || h->bitrate > 14)
 121                 return -E_HEADER_BITRATE;
 122         return mp3info_bitrate[h->version & 1][3 - h->layer][h->bitrate - 1];
 123 }
 124
 125 static int frame_length(struct mp3header *header)
 126 {
 127         int hb, hf = header_frequency(header);
 128
 129         if (hf < 0)
 130                 return hf;
 131         hb = header_bitrate(header);
 132         if (hb < 0)
 133                 return hb;
 134         if (header->sync != 0xFFE || header->layer > 3)
 135                 return -E_FRAME;
 136         return frame_size_index[3 - header->layer] *
 137                 ((header->version & 1) + 1) * hb / hf
 138                 + header->padding;
 139 }
 140
 141 static void write_info_str(struct audio_format_info *afi)
 142 {
 143         int v = mp3.id3_isvalid;
 144
 145         snprintf(afi->info_string, MMD_INFO_SIZE,
 146                 "audio_file_info1:%lu x %lums, %lu kbit/s (%cbr) %i KHz %s\n"
 147                 "audio_file_info2:%s, by %s\n"
 148                 "audio_file_info3:A: %s, Y: %s, C: %s\n",
 149                 afi->chunks_total,
 150                 tv2ms(&afi->chunk_tv),
 151                 mp3.br_average,
 152                 mp3.vbr? 'v' : 'c',
 153                 mp3.freq / 1000,
 154                 header_mode(&mp3.header),
 155                 v && *mp3.id3.title? mp3.id3.title : "(title tag not set)",
 156                 v && *mp3.id3.artist? mp3.id3.artist : "(artist tag not set)",
 157                 v && *mp3.id3.album? mp3.id3.album : "(album tag not set)",
 158                 v && *mp3.id3.year? mp3.id3.year : "????",
 159                 v && *mp3.id3.comment? mp3.id3.comment : "(comment tag not set)"
 160         );
 161 }
 162
 163 /*
 164  * Remove trailing whitespace from the end of a string
 165  */
 166 static char *unpad(char *string)
 167 {
 168         char *pos = string + strlen(string) - 1;
 169         while (isspace(pos[0]))
 170                 (pos--)[0] = 0;
 171         return string;
 172 }
 173
 174 static int compare_headers(struct mp3header *h1,struct mp3header *h2)
 175 {
 176         if ((*(uint*)h1) == (*(uint*)h2))
 177                 return 1;
 178         if ((h1->version == h2->version) &&
 179                         (h1->layer == h2->layer) &&
 180                         (h1->crc == h2->crc) &&
 181                         (h1->freq == h2->freq) &&
 182                         (h1->mode == h2->mode) &&
 183                         (h1->copyright == h2->copyright) &&
 184                         (h1->original == h2->original) &&
 185                         (h1->emphasis == h2->emphasis))
 186                 return 1;
 187         return 0;
 188 }
 189
 190 /**
 191  * get next MP3 frame header.
 192  *
 193  * \param stream to read the header from
 194  * \param header structure that gets filled in by get_header()
 195  *
 196  * \return On success, the header frame length is returned.  A return value of
 197  * zero means that we did not retrieve a valid frame header, and a negative
 198  * return value indicates an error.
 199  */
 200 static int get_header(unsigned char *map, off_t numbytes, off_t *fpos,
 201         struct mp3header *header)
 202 {
 203         int fl, ret;
 204
 205         if (*fpos + FRAME_HEADER_SIZE > numbytes) {
 206                 *fpos = numbytes - 1;
 207                 header->sync = 0;
 208                 return 0;
 209         }
 210         header->layer = (map[*fpos + 1] >> 1) & 3;
 211         header->sync = (((int)map[*fpos]<<4) | ((int)(map[*fpos + 1]&0xE0)>>4));
 212         if (map[*fpos + 1] & 0x10)
 213                 header->version = (map[*fpos + 1] >> 3) & 1;
 214         else
 215                 header->version = 2;
 216         if ((header->sync != 0xFFE) || (header->layer != 1)) {
 217                 ret = 0;
 218                 header->sync = 0;
 219                 goto out;
 220         }
 221         header->crc = map[*fpos + 1] & 1;
 222         header->bitrate = (map[*fpos + 2] >> 4) & 0x0F;
 223         header->freq = (map[*fpos + 2] >> 2) & 0x3;
 224         header->padding = (map[*fpos + 2] >>1) & 0x1;
 225         header->mode = (map[*fpos + 3] >> 6) & 0x3;
 226         fl = frame_length(header);
 227         ret = (fl >= MIN_FRAME_SIZE)? fl : -E_FRAME_LENGTH;
 228 out:
 229         *fpos += FRAME_HEADER_SIZE;
 230         return ret;
 231 }
 232
 233 /**
 234  * find the next mp3 header
 235  *
 236  * \return On success, the length of the next frame header. If the end of the
 237  * file was reached, the function returns zero. On errors, a negative value is
 238  * returned.
 239  *
 240  */
 241 static int mp3_seek_next_header(unsigned char *map, off_t numbytes, off_t *fpos)
 242 {
 243         int k, l = 0, first_len;
 244         struct mp3header h, h2;
 245         long valid_start = 0;
 246
 247         while (1) {
 248                 while ((*fpos)++ < numbytes && map[*fpos] != 0xff)
 249                         ;
 250                 if (*fpos >= numbytes)
 251                         return 0;
 252                 valid_start = *fpos;
 253                 first_len = get_header(map, numbytes, fpos, &h);
 254                 if (first_len <= 0)
 255                         continue;
 256                 *fpos += first_len - FRAME_HEADER_SIZE;
 257                 for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
 258                         if ((l = get_header(map, numbytes, fpos, &h2)) <= 0)
 259                                 break;
 260                         if (!compare_headers(&h, &h2))
 261                                 break;
 262                         *fpos += l - FRAME_HEADER_SIZE;
 263                 }
 264                 if (k == MIN_CONSEC_GOOD_FRAMES) {
 265                         *fpos = valid_start;
 266                         memcpy(&(mp3.header), &h2, sizeof(struct mp3header));
 267                         return first_len;
 268                 }
 269         }
 270 }
 271
 272 static void mp3_get_id3(unsigned char *map, off_t numbytes, off_t *fpos)
 273 {
 274         mp3.id3_isvalid = 0;
 275         mp3.id3.title[0] = '\0';
 276         mp3.id3.artist[0] = '\0';
 277         mp3.id3.album[0] = '\0';
 278         mp3.id3.comment[0] = '\0';
 279         mp3.id3.year[0] = '\0';
 280         if (numbytes < 128)
 281                 return;
 282         *fpos = numbytes - 128;
 283         if (strncmp("TAG", map + *fpos, 3)) {
 284                 PARA_INFO_LOG("%s", "no id3 tag\n");
 285                 return;
 286         }
 287         *fpos = numbytes - 125;
 288         memcpy(mp3.id3.title, map + *fpos, 30);
 289         *fpos += 30;
 290         mp3.id3.title[30] = '\0';
 291         memcpy(mp3.id3.artist, map + *fpos, 30);
 292         *fpos += 30;
 293         mp3.id3.artist[30] = '\0';
 294         memcpy(mp3.id3.album, map + *fpos, 30);
 295         *fpos += 30;
 296         mp3.id3.album[30] = '\0';
 297         memcpy(mp3.id3.year, map + *fpos, 4);
 298         *fpos += 4;
 299         mp3.id3.year[4] = '\0';
 300         memcpy(mp3.id3.comment, map + *fpos, 30);
 301         mp3.id3.comment[30] = '\0';
 302         mp3.id3_isvalid = 1;
 303         unpad(mp3.id3.title);
 304         unpad(mp3.id3.artist);
 305         unpad(mp3.id3.album);
 306         unpad(mp3.id3.year);
 307         unpad(mp3.id3.comment);
 308 }
 309
 310 static int find_valid_start(unsigned char *map, off_t numbytes, off_t *fpos)
 311 {
 312         int frame_len;
 313
 314         frame_len = get_header(map, numbytes, fpos, &mp3.header);
 315         if (frame_len < 0)
 316                 return frame_len;
 317         if (!frame_len) {
 318                 frame_len = mp3_seek_next_header(map, numbytes, fpos);
 319                 if (frame_len <= 0)
 320                         return frame_len;
 321         } else
 322                 *fpos -= FRAME_HEADER_SIZE;
 323         if (frame_len <= 1)
 324                 return -E_FRAME_LENGTH;
 325         return frame_len;
 326 }
 327
 328 static int mp3_read_info(unsigned char *map, off_t numbytes,
 329                 struct audio_format_info *afi)
 330 {
 331         long fl_avg = 0, freq_avg = 0, br_avg = 0;
 332         int ret, len = 0, old_br = -1;
 333         struct timeval total_time = {0, 0};
 334         unsigned chunk_table_size = 1000; /* gets increased on demand */
 335         off_t fpos = 0;
 336
 337         afi->chunks_total = 0;
 338         afi->chunk_table = para_malloc(chunk_table_size * sizeof(size_t));
 339         mp3_get_id3(map, numbytes, &fpos);
 340         fpos = 0;
 341         mp3.vbr = 0;
 342         mp3.freq = 0;
 343         while (1) {
 344                 int freq, br, fl;
 345                 struct timeval tmp, cct; /* current chunk time */
 346                 fpos += len;
 347                 len = find_valid_start(map, numbytes, &fpos);
 348                 if (len <= 0)
 349                         break;
 350                 freq = header_frequency(&mp3.header);
 351                 br = header_bitrate(&mp3.header);
 352                 fl = frame_length(&mp3.header);
 353                 if (freq < 0 || br < 0 || fl < 0)
 354                         continue;
 355                 tmp.tv_sec = fl;
 356                 tmp.tv_usec = 0;
 357                 tv_divide(br * 125, &tmp, &cct);
 358                 tv_add(&cct, &total_time, &tmp);
 359                 total_time = tmp;
 360                 //PARA_DEBUG_LOG("%s: br: %d, freq: %d, fl: %d, cct: %lu\n", __func__, br, freq, fl, cct.tv_usec);
 361                 if (afi->chunks_total >= chunk_table_size) {
 362                         chunk_table_size *= 2;
 363                         afi->chunk_table = para_realloc(afi->chunk_table,
 364                                 chunk_table_size * sizeof(size_t));
 365                 }
 366                 afi->chunk_table[afi->chunks_total] = fpos;
 367 //              if (afi->chunks_total < 10 || !(afi->chunks_total % 1000))
 368 //                      PARA_INFO_LOG("chunk #%lu: %zd\n", afi->chunks_total,
 369 //                              afi->chunk_table[afi->chunks_total]);
 370                 afi->chunks_total++;
 371                 if (afi->chunks_total == 1) {
 372                         freq_avg = freq;
 373                         br_avg = br;
 374                         old_br = br;
 375                         fl_avg = fl;
 376                         continue;
 377                 }
 378                 freq_avg += (freq - freq_avg) / (afi->chunks_total + 1);
 379                 fl_avg += (fl - fl_avg) / (afi->chunks_total + 1);
 380                 br_avg += (br - br_avg) / ((long)afi->chunks_total + 1);
 381                 if (old_br != br)
 382                         mp3.vbr = 1;
 383                 old_br = br;
 384         }
 385         ret = -E_MP3_INFO;
 386         if (!afi->chunks_total || !freq_avg || !br_avg)
 387                 goto err_out;
 388         afi->chunk_table[afi->chunks_total] = numbytes - 1;
 389         mp3.br_average = br_avg;
 390         mp3.freq = freq_avg;
 391         afi->seconds_total = (tv2ms(&total_time) + 500) / 1000;
 392         tv_divide(afi->chunks_total, &total_time, &afi->chunk_tv);
 393         PARA_DEBUG_LOG("%lu chunks, each %lums\n", afi->chunks_total,
 394                 tv2ms(&afi->chunk_tv));
 395         tv_scale(3, &afi->chunk_tv, &afi->eof_tv);
 396         PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&afi->eof_tv));
 397         return 1;
 398 err_out:
 399         PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
 400         free(afi->chunk_table);
 401         return ret;
 402 }
 403
 404 /*
 405  * Read mp3 information from audio file
 406  */
 407 static int mp3_get_file_info(char *map, off_t numbytes,
 408                 struct audio_format_info *afi)
 409 {
 410         int ret;
 411
 412         ret = mp3_read_info((unsigned char *)map, numbytes, afi);
 413         if (ret < 0)
 414                 return ret;
 415         write_info_str(afi);
 416         if (afi->seconds_total < 2 || !afi->chunks_total)
 417                 return -E_MP3_INFO;
 418         return 1;
 419 }
 420
 421 static const char* mp3_suffixes[] = {"mp3", NULL};
 422
 423 /**
 424  * the init function of the mp3 audio format handler
 425  *
 426  * \param afh pointer to the struct to initialize
 427  */
 428 void mp3_init(struct audio_format_handler *afh)
 429 {
 430         afh->get_file_info = mp3_get_file_info;
 431         afh->suffixes = mp3_suffixes;
 432 }