2 * Copyright (C) 2002-2006 Jean-Marc Valin
3 * Copyright (C) 2010-2011 Andre Noll <maan@systemlinux.org>
5 * Licensed under the GPL v2. For licencing details see COPYING.
8 /** \file spxdec_filter.c Paraslash's ogg/speex decoder. */
10 /* This file is based on speexdec.c, by Jean-Marc Valin, see below. */
12 /* Copyright (C) 2002-2006 Jean-Marc Valin
15 Redistribution and use in source and binary forms, with or without
16 modification, are permitted provided that the following conditions
19 - Redistributions of source code must retain the above copyright
20 notice, this list of conditions and the following disclaimer.
22 - Redistributions in binary form must reproduce the above copyright
23 notice, this list of conditions and the following disclaimer in the
24 documentation and/or other materials provided with the distribution.
26 - Neither the name of the Xiph.org Foundation nor the names of its
27 contributors may be used to endorse or promote products derived from
28 this software without specific prior written permission.
30 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
31 ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
32 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
33 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR
34 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
35 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
36 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
37 PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
38 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
39 NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
40 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
45 #include <speex/speex.h>
47 #include <speex/speex_header.h>
48 #include <speex/speex_stereo.h>
49 #include <speex/speex_callbacks.h>
55 #include "buffer_tree.h"
61 /** Data specific to the speexdec filter. */
62 struct private_spxdec_data {
63 /** Header information obtained from the first ogg packet. */
64 struct spx_header_info shi;
65 /** Read from and written to by the Speex routines. */
67 /* Ogg pages are retrieved from this structure. */
69 /** Extracted from header. */
71 /** Total number of ogg packets retrieved so far. */
73 /** Needed to find out how much to skip. */
74 ogg_int64_t last_granule;
75 /** Also needed for skipping packets. */
77 /** The state information about the current stream. */
79 /** Whether \a os initialized. */
83 static void spxdec_open(struct filter_node *fn)
85 struct private_spxdec_data *psd = para_calloc(sizeof(*psd));
87 fn->private_data = psd;
89 psd->speex_serialno = -1;
92 static void speexdec_close(struct filter_node *fn)
94 struct private_spxdec_data *psd = fn->private_data;
97 /* Destroy the decoder state */
98 speex_decoder_destroy(psd->shi.state);
99 /* Destroy the bit-stream struct */
100 speex_bits_destroy(&psd->bits);
103 fn->private_data = NULL;
106 static int speexdec_execute(struct btr_node *btrn, const char *cmd,
109 struct filter_node *fn = btr_context(btrn);
110 struct private_spxdec_data *psd = fn->private_data;
112 return decoder_execute(cmd, psd->shi.sample_rate, psd->shi.channels,
116 static int speexdec_init(struct filter_node *fn)
118 struct private_spxdec_data *psd = fn->private_data;
120 PARA_INFO_LOG("init\n");
121 ogg_sync_init(&psd->oy);
122 speex_bits_init(&psd->bits);
126 #if !defined(__LITTLE_ENDIAN__) && ( defined(WORDS_BIGENDIAN) || defined(__BIG_ENDIAN__) )
127 #define le_short(s) ((short) ((unsigned short) (s) << 8) | ((unsigned short) (s) >> 8))
129 #define le_short(s) ((short) (s))
132 #define MAX_FRAME_SIZE 2000
133 /* Copy Ogg packet to Speex bitstream */
134 static int speexdec_write_frames(int packet_no,
135 struct private_spxdec_data *psd, int skip_samples,
136 int page_nb_packets, struct btr_node *btrn)
140 for (j = 0; j != psd->shi.nframes; j++) {
141 short output[MAX_FRAME_SIZE], *btr_output;
142 int skip = skip_samples + psd->lookahead, skip_idx = 0;
143 int samples, new_frame_size = psd->shi.frame_size;
145 if (speex_decode_int(psd->shi.state, &psd->bits, output) < 0)
146 return -E_SPX_DECODE;
147 if (speex_bits_remaining(&psd->bits) < 0)
148 return -E_SPX_DECODE_OVERFLOW;
149 if (psd->shi.channels == 2)
150 speex_decode_stereo_int(output, psd->shi.frame_size,
152 if (packet_no == 1 && j == 0 && skip_samples > 0) {
153 new_frame_size -= skip;
154 skip_idx = skip * psd->shi.channels;
156 if (packet_no == page_nb_packets && skip_samples < 0) {
157 new_frame_size = psd->shi.nframes * psd->shi.frame_size
158 + skip - j * psd->shi.frame_size;
159 if (new_frame_size < 0)
161 if (new_frame_size > psd->shi.frame_size)
162 new_frame_size = psd->shi.frame_size;
164 if (new_frame_size <= 0)
166 samples = new_frame_size * psd->shi.channels;
167 btr_output = para_malloc(2 * samples);
168 for (i = 0; i < samples; i++)
169 btr_output[i] = le_short(output[i + skip_idx]);
170 btr_add_output((char *)btr_output, samples * 2, btrn);
175 /* Extract all available packets */
176 static int speexdec_extract_packets(struct private_spxdec_data *psd,
177 ogg_stream_state *os, int skip_samples, int page_nb_packets,
178 struct btr_node *btrn)
183 for (packet_no = 0;; psd->packet_count++) {
186 if (ogg_stream_packetout(os, &op) != 1)
188 if (op.bytes >= 5 && !memcmp(op.packet, "Speex", 5))
189 psd->speex_serialno = os->serialno;
190 if (psd->speex_serialno == -1)
192 if (os->serialno != psd->speex_serialno)
194 /* If first packet, process as Speex header */
195 if (psd->packet_count == 0) {
196 ret = spx_process_header(op.packet, op.bytes, &psd->shi);
199 ret = speex_decoder_ctl(psd->shi.state, SPEEX_GET_LOOKAHEAD,
203 if (!psd->shi.nframes)
204 psd->shi.nframes = 1;
205 PARA_INFO_LOG("frame size: %d\n", psd->shi.frame_size);
208 if (psd->packet_count == 1) /* ignore comments */
210 if (psd->packet_count <= 1 + psd->shi.extra_headers)
211 continue; /* Ignore extra headers */
213 /* check end of stream condition */
214 if (op.e_o_s && os->serialno == psd->speex_serialno)
216 speex_bits_read_from(&psd->bits, (char *)op.packet,
218 ret = speexdec_write_frames(packet_no, psd,
219 skip_samples, page_nb_packets, btrn);
227 static int compute_skip_samples(ogg_page *og, struct private_spxdec_data *psd)
229 int ret, page_granule = ogg_page_granulepos(og);
231 if (page_granule <= 0)
233 if (psd->shi.frame_size == 0)
235 ret = ogg_page_packets(og) * psd->shi.frame_size * psd->shi.nframes
236 - page_granule + psd->last_granule;
237 if (ogg_page_eos(og))
242 static void speexdec_post_select(__a_unused struct sched *s, struct task *t)
244 struct filter_node *fn = container_of(t, struct filter_node, task);
245 struct private_spxdec_data *psd = fn->private_data;
246 struct btr_node *btrn = fn->btrn;
254 ret = ns = btr_node_status(btrn, fn->min_iqs, BTR_NT_INTERNAL);
255 btr_merge(btrn, fn->min_iqs);
256 if (!psd->shi.state) {
259 ret = speexdec_init(fn);
263 nbytes = btr_next_buffer(btrn, &btr_buf);
264 nbytes = PARA_MIN(nbytes, (size_t)200);
266 char *data = ogg_sync_buffer(&psd->oy, nbytes);
267 memcpy(data, btr_buf, nbytes);
268 btr_consume(btrn, nbytes);
269 ogg_sync_wrote(&psd->oy, nbytes);
271 /* Loop for all complete pages we got */
272 while (ogg_sync_pageout(&psd->oy, &og) == 1) {
275 if (psd->stream_init == false) {
276 ogg_stream_init(&psd->os, ogg_page_serialno(&og));
277 psd->stream_init = true;
279 if (ogg_page_serialno(&og) != psd->os.serialno)
280 ogg_stream_reset_serialno(&psd->os, ogg_page_serialno(&og));
281 /* Add page to the bitstream */
282 ogg_stream_pagein(&psd->os, &og);
283 skip_samples = compute_skip_samples(&og, psd);
284 psd->last_granule = ogg_page_granulepos(&og);
285 ret = speexdec_extract_packets(psd, &psd->os, skip_samples,
286 ogg_page_packets(&og), btrn);
296 btr_remove_node(btrn);
301 * The init function of the ogg/speex decoder.
303 * \param f Its fields are filled in by the function.
305 void spxdec_filter_init(struct filter *f)
307 f->open = spxdec_open;
308 f->close = speexdec_close;
309 f->pre_select = generic_filter_pre_select;
310 f->post_select = speexdec_post_select;
311 f->execute = speexdec_execute;