From 063328d833daa7e06589645e05d4d2e02f55e911 Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Tue, 22 Jun 2010 23:14:03 +0200 Subject: [PATCH 1/1] ogg: Separate ogg from vorbis code. This moves vorbis-independent code from ogg_afh.c to the new file ogg_afh_common.c so that it can be used also for the speex audio format handler that is added by subsequent patches. The patch introduces a generic callback structure which contains a function pointer used to call back into the vorbis code once for each of the three ogg packets of the audio file header. --- Makefile.in | 4 + configure.ac | 6 +- error.h | 15 ++-- ogg_afh.c | 207 ++++++++++------------------------------------- ogg_afh_common.c | 187 ++++++++++++++++++++++++++++++++++++++++++ ogg_afh_common.h | 33 ++++++++ 6 files changed, 278 insertions(+), 174 deletions(-) create mode 100644 ogg_afh_common.c create mode 100644 ogg_afh_common.h diff --git a/Makefile.in b/Makefile.in index 639464aa..e457e490 100644 --- a/Makefile.in +++ b/Makefile.in @@ -161,6 +161,10 @@ $(object_dir)/ogg_afh.o: ogg_afh.c | $(object_dir) @[ -z "$(Q)" ] || echo 'CC $<' $(Q) $(CC) -c -o $@ $(CPPFLAGS) $(DEBUG_CPPFLAGS) @oggvorbis_cppflags@ $< +$(object_dir)/ogg_afh_common.o: ogg_afh_common.c | $(object_dir) + @[ -z "$(Q)" ] || echo 'CC $<' + $(Q) $(CC) -c -o $@ $(CPPFLAGS) $(DEBUG_CPPFLAGS) @oggvorbis_cppflags@ $< + $(object_dir)/mp3dec_filter.o: mp3dec_filter.c | $(object_dir) @[ -z "$(Q)" ] || echo 'CC $<' $(Q) $(CC) -c -o $@ $(CPPFLAGS) $(DEBUG_CPPFLAGS) @mad_cppflags@ $< diff --git a/configure.ac b/configure.ac index be370c71..49fb0987 100644 --- a/configure.ac +++ b/configure.ac @@ -445,7 +445,7 @@ AC_CHECK_LIB([ogg], [ogg_stream_init], [], [ have_ogg="no" ]) AC_CHECK_LIB([vorbis], [vorbis_info_init], [], [ have_ogg="no" ]) AC_CHECK_HEADERS([ogg/ogg.h vorbis/codec.h], [], [ have_ogg="no" ]) if test "$have_ogg" = "yes"; then - all_errlist_objs="$all_errlist_objs oggdec_filter ogg_afh" + all_errlist_objs="$all_errlist_objs oggdec_filter ogg_afh ogg_afh_common" AC_DEFINE(HAVE_OGGVORBIS, 1, define to 1 to turn on ogg vorbis support) filters="$filters oggdec" if test "$OSTYPE" = "Darwin"; then @@ -456,10 +456,10 @@ if test "$have_ogg" = "yes"; then audiod_ldflags="$audiod_ldflags $oggvorbis_libs -lvorbis -lvorbisfile" afh_ldflags="$afh_ldflags $oggvorbis_libs -logg -lvorbis -lvorbisfile" - server_errlist_objs="$server_errlist_objs ogg_afh" + server_errlist_objs="$server_errlist_objs ogg_afh ogg_afh_common" filter_errlist_objs="$filter_errlist_objs oggdec_filter" audiod_errlist_objs="$audiod_errlist_objs oggdec_filter" - afh_errlist_objs="$afh_errlist_objs ogg_afh" + afh_errlist_objs="$afh_errlist_objs ogg_afh ogg_afh_common" audiod_audio_formats="$audiod_audio_formats ogg" server_audio_formats="$server_audio_formats ogg" diff --git a/error.h b/error.h index a24bf20c..5b1ce077 100644 --- a/error.h +++ b/error.h @@ -36,16 +36,22 @@ DEFINE_ERRLIST_OBJECT_ENUM; #define FILE_WRITE_ERRORS #define STDIN_ERRORS - extern const char **para_errlist[]; +#define OGG_AFH_COMMON_ERRORS \ + PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \ + PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \ + PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \ + PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \ + PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \ + + #define BUFFER_TREE_ERRORS \ PARA_ERROR(BTR_EOF, "buffer tree: end of file"), \ PARA_ERROR(BTR_NO_CHILD, "btr node has no children"), \ PARA_ERROR(BTR_NAVAIL, "btr node: value currently unavailable"), \ - #define BITSTREAM_ERRORS \ PARA_ERROR(VLC, "invalid vlc code"), \ @@ -326,12 +332,7 @@ extern const char **para_errlist[]; #define OGG_AFH_ERRORS \ - PARA_ERROR(SYNC_PAGEOUT, "ogg sync page-out error (no ogg file?)"), \ - PARA_ERROR(STREAM_PAGEIN, "ogg stream page-in error (first page)"), \ - PARA_ERROR(STREAM_PACKETOUT, "ogg stream packet-out error (first packet)"), \ PARA_ERROR(VORBIS, "vorbis synthesis header-in error (not vorbis?)"), \ - PARA_ERROR(OGG_SYNC, "internal ogg storage overflow"), \ - PARA_ERROR(OGG_EMPTY, "no ogg pages found"), \ #define VSS_ERRORS \ diff --git a/ogg_afh.c b/ogg_afh.c index 4b44ea16..744a1331 100644 --- a/ogg_afh.c +++ b/ogg_afh.c @@ -4,10 +4,8 @@ * 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 -#include #include #include @@ -15,174 +13,55 @@ #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) -{ - 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++; - } - } - } - return 1; -} - -static int read_vorbis_info(ogg_sync_state *oss, struct afh_info *afhi) -{ - vorbis_comment vc; +struct private_vorbis_data { vorbis_info vi; - ogg_packet packet; - ogg_stream_state stream; - ogg_page page; - int 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; - - ret = -E_STREAM_PACKETOUT; - if (ogg_stream_packetout(&stream, &packet) != 1) - goto out; - - ret = -E_VORBIS; - if (vorbis_synthesis_headerin(&vi, &vc, &packet) < 0) - goto out; - if (vi.rate == 0) - 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) - 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; -out: - vorbis_info_clear(&vi); - vorbis_comment_clear(&vc); - //ogg_stream_clear(&stream); - return ret; -} + vorbis_comment vc; +}; -static void set_chunk_tv(int num_frames, int num_chunks, int frequency, - struct timeval *result) +static int vorbis_packet_callback(ogg_packet *packet, int packet_num, + struct afh_info *afhi, void *private_data) { - uint64_t x = (uint64_t)num_frames * 1000 * 1000 - / frequency / num_chunks; - - 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)); + 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; + } + 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; } -/* Write tech data to given audio format handler struct. */ -static int ogg_get_file_info(char *map, size_t numbytes, __a_unused int fd, +static int ogg_vorbis_get_file_info(char *map, size_t numbytes, __a_unused int fd, struct afh_info *afhi) { - 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; - - 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); + 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; } @@ -195,6 +74,6 @@ 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->suffixes = ogg_suffixes; } diff --git a/ogg_afh_common.c b/ogg_afh_common.c new file mode 100644 index 00000000..353bc9bb --- /dev/null +++ b/ogg_afh_common.c @@ -0,0 +1,187 @@ +/* + * Copyright (C) 2004-2010 Andre Noll + * + * Licensed under the GPL v2. For licencing details see COPYING. + */ + +/** \file ogg_afh_common.c Functions common to ogg/vorbis and ogg/speex. */ + +#include +#include + +#include "para.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 process_packets_2_and_3(ogg_sync_state *oss, + ogg_stream_state *stream, struct afh_info *afhi, + struct ogg_afh_callback_info *ci) +{ + 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 = ci->packet_callback(&packet, i + 1, afhi, + ci->private_data); + if (ret < 0) + return ret; + if (ret == 0) /* header complete */ + return 1; + i++; + } + } + } + return 1; +} + +static int process_ogg_packets(ogg_sync_state *oss, struct afh_info *afhi, + struct ogg_afh_callback_info *ci) +{ + ogg_packet packet; + ogg_stream_state stream; + ogg_page page; + int ret; + + 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; + + ret = -E_STREAM_PACKETOUT; + if (ogg_stream_packetout(&stream, &packet) != 1) + goto out; + ret = ci->packet_callback(&packet, 0, afhi, ci->private_data); + if (ret < 0) + goto out; + ret = process_packets_2_and_3(oss, &stream, afhi, ci); + if (ret < 0) + goto out; + afhi->header_offset = 0; + afhi->header_len = oss->returned; + ret = 1; +out: + ogg_stream_clear(&stream); + return ret; +} + +static void set_chunk_tv(int num_frames, int num_chunks, int frequency, + struct timeval *result) +{ + uint64_t x = (uint64_t)num_frames * 1000 * 1000 + / frequency / num_chunks; + + 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)); +} + +/** + * Pass first three ogg packets to callback and build the chunk table. + * + * This function extracts the first three ogg packets of the audio data + * given by \a map and \a numbytes and passes each packet to the callback + * defined by \a ci. + * + * If the packet callback indicates success, the chunk table is built. Chunk + * zero contains the first three ogg packets while all other chunks consist of + * exactly one ogg page. + * + * \param map Audio file data. + * \param numbytes The length of \a map. + * \param afhi Passed to the packet callback, contains chunk table. + * \param ci The callback structure. + * + * \return Standard. + */ +int ogg_get_file_info(char *map, size_t numbytes, struct afh_info *afhi, + struct ogg_afh_callback_info *ci) +{ + 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; + + 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 = process_ogg_packets(&oss, afhi, ci); + 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; +} diff --git a/ogg_afh_common.h b/ogg_afh_common.h new file mode 100644 index 00000000..c7eb167e --- /dev/null +++ b/ogg_afh_common.h @@ -0,0 +1,33 @@ +/* + * Copyright (C) 2010 Andre Noll + * + * Licensed under the GPL v2. For licencing details see COPYING. + */ + +/** + * \file ogg_afh_common.h Structures and prototypes common to audio format + * handlers that use the ogg container format. + */ + +/** + * Callback structure provided by vorbis/speex audio format handlers. + * + * Both audio formats utilize the ogg container format. Meta info about + * the audio file is contained in the first three ogg packets. + */ +struct ogg_afh_callback_info { + /** + * ogg_get_file_info() calls this function for each of the three + * header packets. If this callback returns a negative value, the + * audio file is considered invalid and the chunk table is not + * created. If it returns zero, the end of the header has been + * reached and no further ogg packets should be processed. + */ + int (*packet_callback)(ogg_packet *packet, int packet_num, + struct afh_info *afhi, void *private_data); + /** Vorbis/speex specific data. */ + void *private_data; +}; + +int ogg_get_file_info(char *map, size_t numbytes, struct afh_info *afhi, + struct ogg_afh_callback_info *ci); -- 2.39.2