fix doxygen comment of the init functions of all audio format handlers.
[paraslash.git] / mp3_afh.c
index 4bd8888..3630075 100644 (file)
--- a/mp3_afh.c
+++ b/mp3_afh.c
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2003-2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2003-2007 Andre Noll <maan@systemlinux.org>
  *
  *     This program is free software; you can redistribute it and/or modify
  *     it under the terms of the GNU General Public License as published by
@@ -16,7 +16,7 @@
  *     Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111, USA.
  */
 
-/** \file mp3.c para_server's mp3 audio format handler */
+/** \file mp3_afh.c para_server's mp3 audio format handler */
 
 /*
  * This file is based in part on mp3tech.c and mp3tech.h, Copyright (C)
 
 #include "server.cmdline.h"
 #include "server.h"
-#include "afs.h"
-#include "afh.h"
+#include "vss.h"
 #include "error.h"
 #include "fd.h"
+#include "string.h"
 
 /** \cond some defines and structs which are only used in this file */
 
@@ -41,8 +41,7 @@
  * MIN_CONSEC_GOOD_FRAMES defines how many consecutive valid MP3 frames we need
  * to see before we decide we are looking at a real MP3 file
  */
-#define MIN_CONSEC_GOOD_FRAMES 3
-
+#define MIN_CONSEC_GOOD_FRAMES 4
 #define FRAME_HEADER_SIZE 4
 #define MIN_FRAME_SIZE 21
 
@@ -69,26 +68,22 @@ struct id3tag {
 };
 
 struct mp3info {
-       char *filename;
-       FILE *file;
        struct mp3header header;
        int id3_isvalid;
        struct id3tag id3;
        int vbr;
        long unsigned br_average;
-       long unsigned seconds;
-       int frames;
        int freq;
 };
 
 /** \endcond */
-static int frequencies[3][4] = {
+static const int frequencies[3][4] = {
        {22050,24000,16000,50000}, /* MPEG 2.0 */
        {44100,48000,32000,50000}, /* MPEG 1.0 */
        {11025,12000,8000,50000} /* MPEG 2.5 */
 };
 
-static int mp3info_bitrate[2][3][14] = {
+static const int mp3info_bitrate[2][3][14] = {
 { /* MPEG 2.0 */
        {32,48,56,64,80,96,112,128,144,160,176,192,224,256}, /* layer 1 */
        {8,16,24,32,40,48,56,64,80,96,112,128,144,160}, /* layer 2 */
@@ -102,13 +97,10 @@ static int mp3info_bitrate[2][3][14] = {
 }
 };
 
-static int frame_size_index[] = {24000, 72000, 72000};
+static const int frame_size_index[] = {24000, 72000, 72000};
 static const char *mode_text[] = {"stereo", "joint stereo", "dual channel", "mono", "invalid"};
 
 static struct mp3info mp3;
-static char mp3buf[8192];
-static int chunk_size;
-static struct audio_format_handler *af;
 
 static int header_frequency(struct mp3header *h)
 {
@@ -146,16 +138,16 @@ static int frame_length(struct mp3header *header)
                + header->padding;
 }
 
-static void write_info_str(char *info_str)
+static void write_info_str(struct audio_format_info *afi)
 {
        int v = mp3.id3_isvalid;
 
-       snprintf(info_str, MMD_INFO_SIZE,
-               "audio_file_info1:%d x %lums, %lu kbit/s (%cbr) %i KHz %s\n"
+       snprintf(afi->info_string, MMD_INFO_SIZE,
+               "audio_file_info1:%lu x %lums, %lu kbit/s (%cbr) %i KHz %s\n"
                "audio_file_info2:%s, by %s\n"
                "audio_file_info3:A: %s, Y: %s, C: %s\n",
-               mp3.frames,
-               tv2ms(&af->chunk_tv),
+               afi->chunks_total,
+               tv2ms(&afi->chunk_tv),
                mp3.br_average,
                mp3.vbr? 'v' : 'c',
                mp3.freq / 1000,
@@ -192,8 +184,7 @@ static int compare_headers(struct mp3header *h1,struct mp3header *h2)
                        (h1->original == h2->original) &&
                        (h1->emphasis == h2->emphasis))
                return 1;
-       else
-               return 0;
+       return 0;
 }
 
 /**
@@ -248,42 +239,48 @@ static int get_header(FILE *file, struct mp3header *header)
  * returned.
  *
  */
-static int mp3_seek_next_header(void)
+static int mp3_seek_next_header(FILE *file)
 {
-       int k, l = 0, c, first_len;
+       int k, l = 0, c, first_len, ret;
        struct mp3header h, h2;
        long valid_start = 0;
 
        while (1) {
-               while ((c = fgetc(mp3.file)) != 255 && (c != EOF))
+               while ((c = fgetc(file)) != 255 && (c != EOF))
                        ; /* nothing */
                if (c != 255)
                        return 0;
-               ungetc(c, mp3.file);
-               valid_start = ftell(mp3.file);
-               first_len = get_header(mp3.file, &h);
+               ungetc(c, file);
+               valid_start = ftell(file);
+               first_len = get_header(file, &h);
                if (first_len <= 0)
                        continue;
-               if (fseek(mp3.file, first_len - FRAME_HEADER_SIZE, SEEK_CUR) < 0)
-                       return -E_FSEEK;
+               ret = para_fseek(file, first_len - FRAME_HEADER_SIZE, SEEK_CUR);
+               if (ret < 0)
+                       return ret;
                for (k = 1; k < MIN_CONSEC_GOOD_FRAMES; k++) {
-                       if ((l = get_header(mp3.file, &h2)) <= 0)
+                       if ((l = get_header(file, &h2)) <= 0)
                                break;
                        if (!compare_headers(&h, &h2))
                                break;
-                       fseek(mp3.file, l - FRAME_HEADER_SIZE, SEEK_CUR);
+                       ret = para_fseek(file, l - FRAME_HEADER_SIZE, SEEK_CUR);
+                       if (ret < 0)
+                               return ret;
                }
                if (k == MIN_CONSEC_GOOD_FRAMES) {
-                       fseek(mp3.file, valid_start, SEEK_SET);
+                       ret = para_fseek(file, valid_start, SEEK_SET);
+                       if (ret < 0)
+                               return ret;
                        memcpy(&(mp3.header), &h2, sizeof(struct mp3header));
                        return first_len;
                }
        }
 }
 
-static int mp3_get_id3(void)
+static int mp3_get_id3(FILE *file)
 {
        char fbuf[4];
+       int ret;
 
        mp3.id3_isvalid = 0;
        mp3.id3.title[0] = '\0';
@@ -291,30 +288,32 @@ static int mp3_get_id3(void)
        mp3.id3.album[0] = '\0';
        mp3.id3.comment[0] = '\0';
        mp3.id3.year[0] = '\0';
-       if (fseek(mp3.file, -128, SEEK_END))
-               return -E_FSEEK;
-       if (para_fread(fbuf, 1, 3, mp3.file) < 0)
+       ret = para_fseek(file, -128, SEEK_END);
+       if (ret < 0 )
+               return ret;
+       if (para_fread(fbuf, 1, 3, file) < 0)
                return -E_FREAD;
        fbuf[3] = '\0';
        if (strcmp("TAG", fbuf)) {
                PARA_INFO_LOG("%s", "no id3 tag\n");
                return 0;
        }
-       if (fseek(mp3.file, -125, SEEK_END) < 0)
-               return -E_FSEEK;
-       if (para_fread(mp3.id3.title, 1, 30, mp3.file) != 30)
+       ret = para_fseek(file, -125, SEEK_END);
+       if (ret < 0)
+               return ret;
+       if (para_fread(mp3.id3.title, 1, 30, file) != 30)
                return -E_FREAD;
        mp3.id3.title[30] = '\0';
-       if (para_fread(mp3.id3.artist, 1, 30, mp3.file) != 30)
+       if (para_fread(mp3.id3.artist, 1, 30, file) != 30)
                return -E_FREAD;
        mp3.id3.artist[30] = '\0';
-       if (para_fread(mp3.id3.album, 1, 30, mp3.file) != 30)
+       if (para_fread(mp3.id3.album, 1, 30, file) != 30)
                return -E_FREAD;
        mp3.id3.album[30] = '\0';
-       if (para_fread(mp3.id3.year, 1, 4, mp3.file) != 4)
+       if (para_fread(mp3.id3.year, 1, 4, file) != 4)
                return -E_FREAD;
        mp3.id3.year[4] = '\0';
-       if (para_fread(mp3.id3.comment, 1, 30, mp3.file) != 30)
+       if (para_fread(mp3.id3.comment, 1, 30, file) != 30)
                return -E_FREAD;
        mp3.id3.comment[30] = '\0';
        mp3.id3_isvalid = 1;
@@ -326,46 +325,51 @@ static int mp3_get_id3(void)
        return 1;
 }
 
-static int find_valid_start(void)
+static int find_valid_start(FILE *file)
 {
-       int frame_len;
+       int ret, frame_len;
 
-       if (!mp3.file)
-               return -E_MP3_NO_FILE;
-       frame_len = get_header(mp3.file, &mp3.header);
+       frame_len = get_header(file, &mp3.header);
        if (frame_len < 0)
                return frame_len;
        if (!frame_len) {
-               frame_len = mp3_seek_next_header();
+               frame_len = mp3_seek_next_header(file);
                if (frame_len <= 0)
                        return frame_len;
-       } else
-               if (fseek(mp3.file, -FRAME_HEADER_SIZE, SEEK_CUR) < 0)
-                       return -E_FSEEK;
-       if (frame_len <= 1) /* FRAME_HEADER_SIZE? */
+       } else {
+               ret = para_fseek(file, -FRAME_HEADER_SIZE, SEEK_CUR);
+               if (ret < 0)
+                       return ret;
+       }
+       if (frame_len <= 1)
                return -E_FRAME_LENGTH;
        return frame_len;
 }
 
-static int mp3_read_info(void)
+static int mp3_read_info(FILE *file, struct audio_format_info *afi)
 {
-       long fl_avg = 0, freq_avg = 0, br_avg = 0, fcount = 0;
+       long fl_avg = 0, freq_avg = 0, br_avg = 0;
        int ret, len = 0, old_br = -1;
        struct timeval total_time = {0, 0};
+       unsigned chunk_table_size = 1000; /* gets increased on demand */
 
-       ret = mp3_get_id3();
+       afi->chunks_total = 0;
+       afi->chunk_table = para_malloc(chunk_table_size * sizeof(size_t));
+       ret = mp3_get_id3(file);
        if (ret < 0)
-               return ret;
-       rewind(mp3.file);
+               goto err_out;
+       rewind(file);
        mp3.vbr = 0;
        mp3.freq = 0;
        while (1) {
                int freq, br, fl;
                struct timeval tmp, cct; /* current chunk time */
-               if (len > 0)
-                       if (fseek(mp3.file, len, SEEK_CUR) < 0)
-                               return -E_FSEEK;
-               len = find_valid_start();
+               if (len > 0) {
+                       ret = para_fseek(file, len, SEEK_CUR);
+                       if (ret < 0)
+                               goto err_out;
+               }
+               len = find_valid_start(file);
                if (len <= 0)
                        break;
                freq = header_frequency(&mp3.header);
@@ -378,121 +382,79 @@ static int mp3_read_info(void)
                tv_divide(br * 125, &tmp, &cct);
                tv_add(&cct, &total_time, &tmp);
                total_time = tmp;
-//             PARA_DEBUG_LOG("%s: br: %d, freq: %d, fl: %d, cct: %lu\n", __func__, br, freq, fl, cct.tv_usec);
-               fcount++;
-               if (fcount == 1) {
+               //PARA_DEBUG_LOG("%s: br: %d, freq: %d, fl: %d, cct: %lu\n", __func__, br, freq, fl, cct.tv_usec);
+               if (afi->chunks_total >= chunk_table_size) {
+                       chunk_table_size *= 2;
+                       afi->chunk_table = para_realloc(afi->chunk_table,
+                               chunk_table_size * sizeof(size_t));
+               }
+               afi->chunk_table[afi->chunks_total] = ftell(file);
+               if (afi->chunks_total < 10 || !(afi->chunks_total % 1000))
+                       PARA_INFO_LOG("chunk #%lu: %zd\n", afi->chunks_total,
+                               afi->chunk_table[afi->chunks_total]);
+               afi->chunks_total++;
+               if (afi->chunks_total == 1) {
                        freq_avg = freq;
                        br_avg = br;
                        old_br = br;
                        fl_avg = fl;
                        continue;
                }
-               freq_avg += (freq - freq_avg) / (fcount + 1);
-               fl_avg += (fl - fl_avg) / (fcount + 1);
-               br_avg += (br - br_avg) / (fcount + 1);
+               freq_avg += (freq - freq_avg) / (afi->chunks_total + 1);
+               fl_avg += (fl - fl_avg) / (afi->chunks_total + 1);
+               br_avg += (br - br_avg) / (afi->chunks_total + 1);
                if (old_br != br)
                        mp3.vbr = 1;
                old_br = br;
        }
-       if (!fcount || !freq_avg || !br_avg)
-               return -E_MP3_INFO;
+       ret = -E_MP3_INFO;
+       if (!afi->chunks_total || !freq_avg || !br_avg)
+               goto err_out;
+       ret= para_fseek(file, 0, SEEK_END);
+       if (ret < 0)
+               goto err_out;
+       afi->chunk_table[afi->chunks_total] = ftell(file);
        mp3.br_average = br_avg;
        mp3.freq = freq_avg;
-       mp3.frames = fcount;
-       mp3.seconds = (tv2ms(&total_time) + 500) / 1000;
-       tv_divide(fcount, &total_time, &af->chunk_tv);
-       rewind(mp3.file);
-       PARA_DEBUG_LOG("chunk_time: %lums\n", tv2ms(&af->chunk_tv));
-       tv_scale(30, &af->chunk_tv, &af->eof_tv);
-       PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&af->eof_tv));
+       afi->seconds_total = (tv2ms(&total_time) + 500) / 1000;
+       tv_divide(afi->chunks_total, &total_time, &afi->chunk_tv);
+       rewind(file);
+       PARA_DEBUG_LOG("%lu chunks, each %lums\n", afi->chunks_total,
+               tv2ms(&afi->chunk_tv));
+       tv_scale(3, &afi->chunk_tv, &afi->eof_tv);
+       PARA_DEBUG_LOG("eof timeout: %lu\n", tv2ms(&afi->eof_tv));
        return 1;
+err_out:
+       PARA_ERROR_LOG("%s\n", PARA_STRERROR(-ret));
+       free(afi->chunk_table);
+       return ret;
 }
 
 /*
  * Read mp3 information from audio file
  */
-static int mp3_get_file_info(FILE *audio_file, char *info_str,
-       long unsigned *frames, int *seconds)
+static int mp3_get_file_info(FILE *file, struct audio_format_info *afi)
 {
        int ret;
 
-       if (!audio_file)
-               return -E_MP3_NO_FILE;
-       mp3.file = audio_file;
-       ret = mp3_read_info();
-       if (ret < 0) {
-               mp3.file = NULL;
+       ret = mp3_read_info(file, afi);
+       if (ret < 0)
                return ret;
-       }
-       write_info_str(info_str);
-       *frames = mp3.frames;
-       *seconds = mp3.seconds;
-       if (*seconds < 2 || !*frames)
+       write_info_str(afi);
+       if (afi->seconds_total < 2 || !afi->chunks_total)
                return -E_MP3_INFO;
        return 1;
 }
 
-static int mp3_reposition_stream(long unsigned new_frame)
-{
-       int count = 0, len;
-
-       PARA_DEBUG_LOG("jmp to frame %lu/%i\n", new_frame, mp3.frames);
-       rewind(mp3.file);
-       while (count < new_frame && (len = find_valid_start()) > 0) {
-//             PARA_DEBUG_LOG("%s: jmp to frame %d\n", __func__, count);
-               if (fseek(mp3.file, len, SEEK_CUR) < 0)
-                       return -E_FSEEK;
-               count++;
-       }
-       if (count != new_frame) {
-               rewind(mp3.file);
-               return -E_MP3_REPOS;
-       }
-       return 1;
-}
-
-static int mp3_read_next_chunk(void)
-{
-       int len = find_valid_start();
-
-       if (len <= 0) {
-               if (len < 0)
-                       PARA_ERROR_LOG("invalid frame len (%d)\n", len);
-               return len;
-       }
-       chunk_size = para_fread(mp3buf, len, 1, mp3.file);
-       if (len != chunk_size)
-               PARA_DEBUG_LOG("short read (%d/%d)\n", chunk_size, len);
-       return chunk_size;
-}
-
-static char *mp3_read_chunk(__a_unused long unsigned chunk_num, ssize_t *len)
-{
-       *len = mp3_read_next_chunk();
-       if (*len <= 0)
-               return NULL;
-       return mp3buf;
-}
-
-static void mp3_close_audio_file(void)
-{
-       if (!mp3.file)
-               return;
-       fclose(mp3.file);
-       mp3.file = NULL;
-}
-
 static const char* mp3_suffixes[] = {"mp3", NULL};
-void mp3_init(struct audio_format_handler *p)
+
+/**
+ * the init function of the mp3 audio format handler
+ *
+ * \param afh pointer to the struct to initialize
+ */
+void mp3_init(struct audio_format_handler *afh)
 {
-       af = p;
-       af->get_file_info = mp3_get_file_info;
-       af->reposition_stream = mp3_reposition_stream;
-       af->read_chunk = mp3_read_chunk;
-       af->close_audio_file = mp3_close_audio_file;
-       af->get_header_info = NULL;
-       /* eof_tv gets overwritten in mp3_get_file_info() */
-       af->eof_tv.tv_sec = 0;
-       af->eof_tv.tv_usec = 100 * 1000;
-       af->suffixes = mp3_suffixes;
+       afh->get_file_info = mp3_get_file_info;
+       afh->suffixes = mp3_suffixes;
 }