afh_recv: Improve documentation of --begin-chunk.
[paraslash.git] / ogg_afh.c
index 6a17f05..32f8bc1 100644 (file)
--- a/ogg_afh.c
+++ b/ogg_afh.c
@@ -1,13 +1,11 @@
 /*
- * Copyright (C) 2004-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2004 Andre Noll <maan@tuebingen.mpg.de>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
 
-/** \file ogg_afh.c Audio format handler for ogg vorbis files. */
+/** \file ogg_afh.c Audio format handler for ogg/vorbis files. */
 
-#include <inttypes.h>
-#include <ogg/ogg.h>
 #include <vorbis/codec.h>
 #include <regex.h>
 
 #include "afh.h"
 #include "error.h"
 #include "string.h"
+#include "ogg_afh_common.h"
 
-/* Taken from decoder_example.c of libvorbis-1.2.3. */
-static int read_vorbis_comment(ogg_sync_state *oss, ogg_stream_state *stream,
-               vorbis_info *vi, vorbis_comment *vc)
+struct private_vorbis_data {
+       vorbis_info vi;
+       vorbis_comment vc;
+};
+
+/*
+ * Vorbis uses three header packets, all of which are required: the
+ * identification header, the comments header, and the setup header.
+ *
+ * The identification header identifies the bitstream as Vorbis. It contains
+ * the Vorbis version and simple audio characteristics of the stream such as
+ * sample rate and number of channels.
+ *
+ * The comment header includes user text comments (tags) and a vendor string
+ * for the application/library that produced the bitstream.
+ *
+ * The setup header includes extensive CODEC setup information as well as the
+ * complete VQ and Huffman codebooks needed for decoding.
+ */
+static int vorbis_packet_callback(ogg_packet *packet, int packet_num,
+               __a_unused int serial, struct afh_info *afhi, void *private_data)
 {
-       ogg_page page;
-       ogg_packet packet;
-       int i = 0;
-
-       while (i < 2) {
-               while (i < 2) {
-                       int ret = ogg_sync_pageout(oss, &page);
-                       if (ret == 0)
-                               break; /* Need more data */
-                       if (ret != 1)
-                               continue;
-                       /*
-                        * We can ignore any errors here as they'll also become
-                        * apparent at packetout.
-                        */
-                       ogg_stream_pagein(stream, &page);
-                       while (i < 2) {
-                               ret = ogg_stream_packetout(stream, &packet);
-                               if (ret == 0)
-                                       break;
-                               if (ret < 0)
-                                       return -E_STREAM_PACKETOUT;
-                               ret = vorbis_synthesis_headerin(vi, vc,
-                                       &packet);
-                               if (ret < 0)
-                                       return -E_VORBIS;
-                               i++;
-                       }
-               }
+       struct private_vorbis_data *pvd = private_data;
+
+       if (vorbis_synthesis_headerin(&pvd->vi, &pvd->vc, packet) < 0)
+               return -E_VORBIS;
+       if (packet_num == 0) {
+               if (pvd->vi.rate == 0)
+                       return -E_VORBIS;
+               afhi->channels = pvd->vi.channels;
+               afhi->frequency = pvd->vi.rate;
+               afhi->bitrate = pvd->vi.bitrate_nominal / 1000;
+               PARA_DEBUG_LOG("channels: %i, sampling rate: %i, bitrate: %i\n",
+                       afhi->channels, afhi->frequency, afhi->bitrate);
+               return 1;
        }
-       return 1;
+       if (packet_num == 1)
+               return 1; /* we also want to have packet #2 */
+       afhi->tags.artist = para_strdup(vorbis_comment_query(&pvd->vc, "artist", 0));
+       afhi->tags.title = para_strdup(vorbis_comment_query(&pvd->vc, "title", 0));
+       afhi->tags.album = para_strdup(vorbis_comment_query(&pvd->vc, "album", 0));
+       afhi->tags.year = para_strdup(vorbis_comment_query(&pvd->vc, "year", 0));
+       afhi->tags.comment = para_strdup(vorbis_comment_query(&pvd->vc, "comment", 0));
+       return 0;
 }
 
-static int read_vorbis_info(ogg_sync_state *oss, struct afh_info *afhi)
+static int ogg_vorbis_get_file_info(char *map, size_t numbytes, __a_unused int fd,
+               struct afh_info *afhi)
 {
-       vorbis_comment vc;
-       vorbis_info vi;
-       ogg_packet packet;
-       ogg_stream_state stream;
-       ogg_page page;
        int ret;
+       struct private_vorbis_data pvd;
+       struct ogg_afh_callback_info vorbis_callback_info = {
+               .packet_callback = vorbis_packet_callback,
+               .private_data = &pvd,
+       };
+
+       vorbis_info_init(&pvd.vi);
+       vorbis_comment_init(&pvd.vc);
+       ret = ogg_get_file_info(map, numbytes, afhi, &vorbis_callback_info);
+       vorbis_info_clear(&pvd.vi);
+       vorbis_comment_clear(&pvd.vc);
+       return ret;
+}
 
-       vorbis_info_init(&vi);
-       vorbis_comment_init(&vc);
-
-       ret = -E_SYNC_PAGEOUT;
-       if (ogg_sync_pageout(oss, &page) != 1)
-               goto out;
-
-       ret = ogg_page_serialno(&page);
-       ogg_stream_init(&stream, ret);
-
-       ret = -E_STREAM_PAGEIN;
-       if (ogg_stream_pagein(&stream, &page) < 0)
-               goto out;
+struct vorbis_get_header_data {
+       ogg_stream_state os;
+       char *buf;
+       size_t len;
+};
 
-       ret = -E_STREAM_PACKETOUT;
-       if (ogg_stream_packetout(&stream, &packet) != 1)
-               goto out;
+static void add_ogg_page(ogg_page *og, struct vorbis_get_header_data *vghd)
+{
+       size_t old_len = vghd->len;
+       size_t new_len = vghd->len + og->header_len + og->body_len;
+       char *buf = para_realloc(vghd->buf, new_len), *p = buf + old_len;
+
+       memcpy(p, og->header, og->header_len);
+       memcpy(p + og->header_len, og->body, og->body_len);
+       vghd->buf = buf;
+       vghd->len = new_len;
+       PARA_DEBUG_LOG("header/body/old/new: %lu/%lu/%zu/%zu\n",
+               og->header_len, og->body_len, old_len, new_len);
+}
 
-       ret = -E_VORBIS;
-       if (vorbis_synthesis_headerin(&vi, &vc, &packet) < 0)
-               goto out;
-       if (vi.rate == 0)
+static int vorbis_get_header_callback(ogg_packet *packet, int packet_num,
+               int serial, __a_unused struct afh_info *afhi, void *private_data)
+{
+       int ret;
+       struct vorbis_get_header_data *vghd = private_data;
+       ogg_page og;
+       static unsigned char dummy_packet[] = {
+               0x03,
+               'v', 'o', 'r', 'b', 'i', 's',
+               0x06, 0x00, 0x00, 0x00,
+               'd', 'u', 'm', 'm', 'y', '\0',
+               0x00, 0x00, 0x00, 0x00, /* no comment :) */
+               0xff /* framing bit */
+       };
+
+       PARA_DEBUG_LOG("processing ogg packet #%d\n", packet_num);
+       if (packet_num > 2)
+               return 0;
+       if (packet_num == 0) {
+               ogg_stream_init(&vghd->os, serial);
+               ret = ogg_stream_packetin(&vghd->os, packet);
+               if (ret < 0)
+                       goto out;
+               ret = -E_OGG_STREAM_FLUSH;
+               if (ogg_stream_flush(&vghd->os, &og) == 0)
+                       goto out;
+               add_ogg_page(&og, vghd);
+               return 1;
+       }
+       if (packet_num == 1) {
+               ogg_packet replacement = *packet;
+               PARA_INFO_LOG("replacing metadata packet\n");
+               replacement.packet = dummy_packet;
+               replacement.bytes = sizeof(dummy_packet);
+               ret = ogg_stream_packetin(&vghd->os, &replacement);
+               if (ret >= 0)
+                       return 1;
+               ret = -E_OGG_PACKET_IN;
                goto out;
-       afhi->channels = vi.channels;
-       afhi->frequency = vi.rate;
-       afhi->bitrate = vi.bitrate_nominal / 1000;
-       PARA_DEBUG_LOG("channels: %i, sampling rate: %i, bitrate: %i\n",
-               afhi->channels, afhi->frequency, afhi->bitrate);
-       ret = read_vorbis_comment(oss, &stream, &vi, &vc);
-       if (ret < 0)
+       }
+       ret = -E_OGG_PACKET_IN;
+       if (ogg_stream_packetin(&vghd->os, packet) < 0)
                goto out;
-       afhi->tags.artist = para_strdup(vorbis_comment_query(&vc, "artist", 0));
-       afhi->tags.title = para_strdup(vorbis_comment_query(&vc, "title", 0));
-       afhi->tags.album = para_strdup(vorbis_comment_query(&vc, "album", 0));
-       afhi->tags.year = para_strdup(vorbis_comment_query(&vc, "year", 0));
-       afhi->tags.comment = para_strdup(vorbis_comment_query(&vc, "comment", 0));
-
-       afhi->header_offset = 0;
-       afhi->header_len = oss->returned;
-       ret = 1;
+       while (ogg_stream_flush(&vghd->os, &og))
+               add_ogg_page(&og, vghd);
+       ret = 0;
 out:
-       vorbis_info_clear(&vi);
-       vorbis_comment_clear(&vc);
-       //ogg_stream_clear(&stream);
+       ogg_stream_clear(&vghd->os);
        return ret;
 }
 
-static void set_chunk_tv(int num_frames, int num_chunks, int frequency,
-               struct timeval *result)
+static void vorbis_get_header(void *map, size_t mapsize, char **buf,
+               size_t *len)
 {
-       uint64_t x = (uint64_t)num_frames * 1000 * 1000
-               / frequency / num_chunks;
+       int ret;
+       struct vorbis_get_header_data vghd = {.len = 0};
+       struct ogg_afh_callback_info cb = {
+               .packet_callback = vorbis_get_header_callback,
+               .private_data = &vghd,
+       };
 
-       result->tv_sec = x / 1000 / 1000;
-       result->tv_usec = x % (1000 * 1000);
-       PARA_INFO_LOG("%d chunks, chunk time: %lums\n", num_chunks,
-               tv2ms(result));
+       ret = ogg_get_file_info(map, mapsize, NULL, &cb);
+       if (ret < 0)
+               goto fail;
+       *buf = vghd.buf;
+       *len = vghd.len;
+       PARA_INFO_LOG("created %zu byte ogg vorbis header\n", *len);
+       return;
+fail:
+       PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 }
 
-/* Write tech data to given audio format handler struct. */
-static int ogg_get_file_info(char *map, size_t numbytes, __a_unused int fd,
-               struct afh_info *afhi)
+static const char* ogg_suffixes[] = {"ogg", NULL};
+
+static int vorbis_make_meta_packet(struct taginfo *tags, ogg_packet *result)
 {
-       ogg_sync_state oss;
-       ogg_page op;
-       long len = numbytes;
-       char *buf;
-       int ret, i, j, frames_per_chunk, ct_size;
-       long long unsigned num_frames = 0;
+       vorbis_comment vc;
+       int ret;
 
-       ogg_sync_init(&oss);
-       ret = -E_OGG_SYNC;
-       buf = ogg_sync_buffer(&oss, len);
-       if (!buf)
-               goto out;
-       memcpy(buf, map, len);
-       ret = -E_OGG_SYNC;
-       if (ogg_sync_wrote(&oss, len) < 0)
-               goto out;
-       ret = read_vorbis_info(&oss, afhi);
-       if (ret < 0)
-               goto out;
-       oss.returned = 0;
-       oss.fill = numbytes;
-       /* count ogg packages and get duration of the file */
-       for (i = 0; ogg_sync_pageseek(&oss, &op) > 0; i++)
-               num_frames = ogg_page_granulepos(&op);
-       PARA_INFO_LOG("%d pages, %llu frames\n", i, num_frames);
-       ret = -E_OGG_EMPTY;
-       if (i == 0)
-               goto out;
-       afhi->seconds_total = num_frames / afhi->frequency;
-       /* use roughly one page per chunk */
-       frames_per_chunk = num_frames / i;
-       PARA_INFO_LOG("%lu seconds, %d frames/chunk\n",
-               afhi->seconds_total, frames_per_chunk);
-       ct_size = 250;
-       afhi->chunk_table = para_malloc(ct_size * sizeof(uint32_t));
-       afhi->chunk_table[0] = 0;
-       afhi->chunk_table[1] = afhi->header_len;
-       oss.returned = afhi->header_len;
-       oss.fill = numbytes;
-       for (i = 0, j = 1; ogg_sync_pageseek(&oss, &op) > 0; i++) {
-               int granule = ogg_page_granulepos(&op);
-
-               while (granule > j * frames_per_chunk) {
-                       j++;
-                       if (j >= ct_size) {
-                               ct_size *= 2;
-                               afhi->chunk_table = para_realloc(
-                                       afhi->chunk_table,
-                                       ct_size * sizeof(uint32_t));
-                       }
-                       afhi->chunk_table[j] = oss.returned;
-               }
-       }
-       afhi->chunks_total = j;
-       set_chunk_tv(num_frames, j, afhi->frequency, &afhi->chunk_tv);
-       ret = 0;
-out:
-       ogg_sync_clear(&oss);
-       return ret;
+       vorbis_comment_init(&vc);
+       vorbis_comment_add_tag(&vc, "artist", tags->artist);
+       vorbis_comment_add_tag(&vc, "title", tags->title);
+       vorbis_comment_add_tag(&vc, "album", tags->album);
+       vorbis_comment_add_tag(&vc, "year", tags->year);
+       vorbis_comment_add_tag(&vc, "comment", tags->comment);
+       ret = vorbis_commentheader_out(&vc, result);
+       vorbis_comment_clear(&vc);
+       if (ret != 0)
+               return -E_VORBIS_COMMENTHEADER;
+       return 1;
 }
 
-static const char* ogg_suffixes[] = {"ogg", NULL};
+static int vorbis_rewrite_tags(const char *map, size_t mapsize,
+               struct taginfo *tags, int output_fd,
+               __a_unused const char *filename)
+{
+       int ret;
+       ogg_packet packet;
 
+       ret = vorbis_make_meta_packet(tags, &packet);
+       if (ret < 0)
+               return ret;
+       ret = ogg_rewrite_tags(map, mapsize, output_fd, (char *)packet.packet,
+               packet.bytes);
+       free(packet.packet);
+       return ret;
+}
 /**
  * The init function of the ogg vorbis audio format handler.
  *
@@ -195,6 +213,8 @@ static const char* ogg_suffixes[] = {"ogg", NULL};
  */
 void ogg_init(struct audio_format_handler *afh)
 {
-       afh->get_file_info = ogg_get_file_info,
+       afh->get_file_info = ogg_vorbis_get_file_info;
+       afh->get_header = vorbis_get_header;
        afh->suffixes = ogg_suffixes;
+       afh->rewrite_tags = vorbis_rewrite_tags;
 }