-/*
- * Copyright (C) 2004-2009 Andre Noll <maan@systemlinux.org>
- *
- * Licensed under the GPL v2. For licencing details see COPYING.
- */
-/** \file ogg_afh.c para_server's ogg vorbis audio format handler */
+/* Copyright (C) 2004 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
+
+/** \file ogg_afh.c Audio format handler for ogg/vorbis files. */
-#include <regex.h>
-#include <inttypes.h>
-#include <ogg/ogg.h>
#include <vorbis/codec.h>
-#include <vorbis/vorbisfile.h>
-#include <osl.h>
+#include <regex.h>
#include "para.h"
-#include "error.h"
#include "afh.h"
+#include "error.h"
#include "string.h"
+#include "ogg_afh_common.h"
-/** must be big enough to hold header */
-#define CHUNK_SIZE 32768
-static double chunk_time = 0.25;
-
-/** describes a memory-mapped ogg vorbis file */
-struct ogg_datasource {
- /** the memory mapping */
- char *map;
- /** this size of the mapping */
- off_t numbytes;
- /** the current position in the mapping */
- off_t fpos;
+struct private_vorbis_data {
+ vorbis_info vi;
+ vorbis_comment vc;
};
-static size_t cb_read(void *buf, size_t size, size_t nmemb, void *datasource)
+/*
+ * 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)
{
- struct ogg_datasource *ods = datasource;
- size_t copy, ret;
-
- if (!size)
- return 0;
+ struct private_vorbis_data *pvd = private_data;
- assert(ods->numbytes >= ods->fpos);
- ret = ods->numbytes - ods->fpos;
- copy = PARA_MIN(ret, size * nmemb);
- ret = copy / size;
- if (!ret)
- return 0;
- memcpy(buf, ods->map + ods->fpos, copy);
-// PARA_INFO_LOG("size: %zd, nmemb: %zd, ret: %zd\n", size, nmemb, ret);
- ods->fpos += ret * size;
- return ret;
-}
-
-static int cb_seek(void *datasource, ogg_int64_t offset,
- int whence)
-{
- struct ogg_datasource *ods = datasource;
- switch (whence) {
- case SEEK_SET:
- if (offset >= 0 && offset <= ods->numbytes) {
- ods->fpos = offset;
- return 0;
- }
- errno = EINVAL;
- return -1;
- break;
- case SEEK_END:
- if (offset <= 0 && -offset <= ods->numbytes) {
- ods->fpos = ods->numbytes + offset;
- return 0;
- }
- errno = EINVAL;
- return -1;
- break;
- case SEEK_CUR:
- if ((offset >= 0 && offset + ods->fpos > ods->numbytes) ||
- (offset < 0 && offset + ods->fpos < 0)) {
- errno = EINVAL;
- return -1;
- }
- ods->fpos += offset;
- return 0;
+ 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;
}
- errno = EINVAL;
- return -1;
-}
-
-/* don't do anything as vss still needs the open filehandle */
-static int cb_close(__a_unused void *datasource)
-{
+ 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 long cb_tell(void *datasource)
-{
- struct ogg_datasource *ods = datasource;
- return (unsigned long)ods->fpos;
-}
-
-static int ogg_open_callbacks(void *datasource, OggVorbis_File *vf, ov_callbacks c)
+static int ogg_vorbis_get_file_info(char *map, size_t numbytes, __a_unused int fd,
+ struct afh_info *afhi)
{
- int ret = ov_open_callbacks(datasource, vf,
- NULL, /* no initial buffer */
- 0, /* no initial bytes */
- c); /* the ov_open_callbacks */
-
- if (ret == OV_EREAD)
- return -E_OGG_READ;
- if (ret == OV_ENOTVORBIS)
- return -E_VORBIS;
- if (ret == OV_EVERSION)
- return -E_OGG_VERSION;
- if (ret == OV_EBADHEADER)
- return -E_OGG_BAD_HEADER;
- if (ret < 0)
- return -E_OGG_UNKNOWN_ERROR;
- return 1;
+ int ret;
+ struct private_vorbis_data pvd;
+ struct oac_callback_info vorbis_callback_info = {
+ .packet_callback = vorbis_packet_callback,
+ .private_data = &pvd,
+ };
+ vorbis_info_init(&pvd.vi);
+ vorbis_comment_init(&pvd.vc);
+ ret = oac_get_file_info(map, numbytes, afhi, &vorbis_callback_info);
+ vorbis_info_clear(&pvd.vi);
+ vorbis_comment_clear(&pvd.vc);
+ return ret;
}
-static int ogg_compute_header_len(char *map, size_t numbytes,
- struct afh_info *afhi)
+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;
- size_t len = PARA_MIN(numbytes, (size_t)CHUNK_SIZE);
- int serial;
- char *buf;
-
- ogg_page page;
- ogg_packet packet;
- vorbis_comment vc;
- vorbis_info vi;
- ogg_stream_state *stream_in = para_malloc(sizeof(ogg_stream_state));
- ogg_stream_state *stream_out = para_malloc(sizeof(ogg_stream_state));
- ogg_sync_state *sync_in = para_malloc(sizeof(ogg_sync_state));
+ struct oac_custom_header *h = private_data;
+ 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 */
+ };
- ogg_sync_init(sync_in);
- vorbis_info_init(&vi);
- vorbis_comment_init(&vc);
- buf = ogg_sync_buffer(sync_in, (long)len);
- memcpy(buf, map, len);
- ogg_sync_wrote(sync_in, (long)len);
- ret = -E_SYNC_PAGEOUT;
- if (ogg_sync_pageout(sync_in, &page) <= 0) {
- free(stream_in);
- free(stream_out);
- goto err1;
- }
- serial = ogg_page_serialno(&page);
- ogg_stream_init(stream_in, serial);
- ogg_stream_init(stream_out, serial);
- ret = ogg_stream_pagein(stream_in, &page);
- if (ret < 0) {
- ret = -E_STREAM_PAGEIN;
- goto err2;
+ PARA_DEBUG_LOG("processing ogg packet #%d\n", packet_num);
+ if (packet_num == 0) {
+ oac_custom_header_init(serial, h);
+ ret = oac_custom_header_append(packet, h);
+ if (ret < 0)
+ return ret;
+ oac_custom_header_flush(h);
+ return 1;
}
- ret = ogg_stream_packetout(stream_in, &packet);
- if (ret != 1) {
- ret = -E_STREAM_PACKETOUT;
- goto err2;
+ 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 = oac_custom_header_append(&replacement, h);
+ return ret < 0? ret : 1;
}
- ret = -E_VORBIS;
- if (vorbis_synthesis_headerin(&vi, &vc, &packet) < 0)
- goto err2;
- PARA_DEBUG_LOG("channels: %i, rate: %li\n", vi.channels, vi.rate);
- ogg_stream_packetin(stream_out, &packet);
- ret = ogg_sync_pageout(sync_in, &page);
- if (ret <= 0) {
- ret = -E_SYNC_PAGEOUT;
- goto err2;
- }
- ogg_stream_pagein(stream_in, &page);
- ogg_stream_packetout(stream_in, &packet);
- ogg_stream_packetin(stream_out, &packet);
-
- ret = ogg_sync_pageout(sync_in, &page);
- if (ret <= 0) {
- ret = -E_SYNC_PAGEOUT;
- goto err2;
- }
- ogg_stream_pagein(stream_in, &page);
- ogg_stream_packetout(stream_in, &packet);
- ogg_stream_packetin(stream_out, &packet);
-
- afhi->header_len = 0;
- while (ogg_stream_flush(stream_out, &page))
- afhi->header_len += page.body_len + page.header_len;
- PARA_DEBUG_LOG("header_len = %d\n", afhi->header_len);
- afhi->header_offset = 0;
- ret = 1;
-err2:
- ogg_stream_destroy(stream_in);
- ogg_stream_destroy(stream_out);
-err1:
- ogg_sync_destroy(sync_in);
- vorbis_info_clear(&vi);
- vorbis_comment_clear(&vc);
- return ret;
+ assert(packet_num == 2);
+ ret = oac_custom_header_append(packet, h);
+ if (ret < 0)
+ return ret;
+ oac_custom_header_flush(h);
+ return 0;
}
-/*
- * Alloc and fill array table of byte offsets. chunk_table[i] is the
- * offset in the current input file at which the sample containing time i *
- * CHUNK_TIME begins. Always successful.
- */
-static long unsigned ogg_compute_chunk_table(OggVorbis_File *of,
- struct afh_info *afhi, long unsigned time_total)
+static void vorbis_get_header(void *map, size_t mapsize, char **buf,
+ size_t *len)
{
- int i, ret, num;
- long unsigned num_chunks;
- ogg_int64_t max = 0, min = 0, old_pos = 0;
+ int ret;
+ struct oac_custom_header *h = oac_custom_header_new();
+ struct oac_callback_info cb = {
+ .packet_callback = vorbis_get_header_callback,
+ .private_data = h,
+ };
- num = time_total / chunk_time + 3;
- PARA_DEBUG_LOG("chunk time: %g allocating %d chunk pointers\n",
- chunk_time, num);
- afhi->chunk_table = para_malloc((num + 1) * sizeof(size_t));
- afhi->chunk_table[0] = 0;
- for (i = 1; i <= num; i++) {
- ogg_int64_t diff, pos;
- ret = ov_time_seek(of, i * chunk_time);
- if (ret)
- break;
- pos = ov_raw_tell(of);
- diff = pos - old_pos;
- max = PARA_MAX(max, diff);
- min = (i == 1)? diff : PARA_MIN(min, diff);
- afhi->chunk_table[i] = pos;
- old_pos = pos;
- }
- num_chunks = i - 1;
- PARA_DEBUG_LOG("%lu chunks (%fs), max chunk: %lld, min chunk: %lld\n",
- num_chunks, chunk_time, (long long)max, (long long)min);
- return num_chunks;
+ ret = oac_get_file_info(map, mapsize, NULL, &cb);
+ *len = oac_custom_header_get(buf, h);
+ if (ret < 0) {
+ PARA_ERROR_LOG("could not create ogg/vorbis header: %s\n",
+ para_strerror(-ret));
+ free(*buf);
+ *buf = NULL;
+ *len = 0;
+ } else
+ PARA_INFO_LOG("created %zu byte ogg vorbis header\n", *len);
}
-static void ogg_get_vorbis_comments(OggVorbis_File *vf, struct afh_info *afhi)
+static int vorbis_make_meta_packet(struct taginfo *tags, ogg_packet *result)
{
- vorbis_comment *vc = ov_comment(vf,-1);
+ vorbis_comment vc;
+ int ret;
- if (!vc)
- return;
- 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));
+ 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;
}
-/*
- * Init oggvorbis file and write some tech data to given pointers.
- */
-static int ogg_get_file_info(char *map, size_t numbytes, __a_unused int fd,
- struct afh_info *afhi)
+static int vorbis_rewrite_tags(const char *map, size_t mapsize,
+ struct taginfo *tags, int output_fd,
+ __a_unused const char *filename)
{
int ret;
- vorbis_info *vi;
- OggVorbis_File of;
- const ov_callbacks ovc = {
- .read_func = cb_read,
- .seek_func = cb_seek,
- .close_func = cb_close,
- .tell_func = cb_tell
- };
- struct ogg_datasource ods = {.map = map, .numbytes = numbytes, .fpos = 0};
+ ogg_packet packet;
- ret = ogg_compute_header_len(map, numbytes, afhi);
+ ret = vorbis_make_meta_packet(tags, &packet);
if (ret < 0)
return ret;
- ret = ogg_open_callbacks(&ods, &of, ovc);
- if (ret < 0)
- goto err;
- ret = -E_OGG_INFO;
- vi = ov_info(&of, 0);
- if (!vi)
- goto err;
- afhi->seconds_total = ov_time_total(&of, -1);
- afhi->frequency = vi->rate;
- afhi->bitrate = ov_bitrate(&of, 0) / 1000;
- afhi->channels = vi->channels;
- afhi->chunks_total = ogg_compute_chunk_table(&of, afhi, afhi->seconds_total);
- afhi->chunk_tv.tv_sec = 0;
- afhi->chunk_tv.tv_usec = 250 * 1000;
- ogg_get_vorbis_comments(&of, afhi);
- ret = 1;
-err:
- ov_clear(&of); /* keeps the file open */
+ ret = oac_rewrite_tags(map, mapsize, output_fd, (char *)packet.packet,
+ packet.bytes);
+ free(packet.packet);
return ret;
}
-static const char* ogg_suffixes[] = {"ogg", NULL};
+static const char * const ogg_suffixes[] = {"ogg", NULL};
/**
- * the init function of the ogg vorbis audio format handler
+ * The ogg vorbis audio format handler.
*
- * \param afh pointer to the struct to initialize
+ * It should actually be called vorbis because the ogg container format is also
+ * employed for the speex and flac codecs. Both the ogg and the vorbis
+ * libraries must be installed to get this audio format handler.
*/
-void ogg_init(struct audio_format_handler *afh)
-{
- afh->get_file_info = ogg_get_file_info,
- afh->suffixes = ogg_suffixes;
-}
+const struct audio_format_handler ogg_afh = {
+ .get_file_info = ogg_vorbis_get_file_info,
+ .get_header = vorbis_get_header,
+ .suffixes = ogg_suffixes,
+ .rewrite_tags = vorbis_rewrite_tags
+};