2 * Copyright (C) 2008 David Conrad
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #include <speex/speex.h>
22 #include <speex/speex_header.h>
23 #include <speex/speex_stereo.h>
24 #include <speex/speex_callbacks.h>
26 #include "libavutil/channel_layout.h"
27 #include "libavutil/common.h"
34 SpeexStereoState stereo;
40 static av_cold int libspeex_decode_init(AVCodecContext *avctx)
42 LibSpeexContext *s = avctx->priv_data;
43 const SpeexMode *mode;
44 SpeexHeader *header = NULL;
47 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
48 if (avctx->extradata && avctx->extradata_size >= 80) {
49 header = speex_packet_to_header(avctx->extradata,
50 avctx->extradata_size);
52 av_log(avctx, AV_LOG_WARNING, "Invalid Speex header\n");
55 avctx->sample_rate = header->rate;
56 avctx->channels = header->nb_channels;
57 spx_mode = header->mode;
58 speex_header_free(header);
60 switch (avctx->sample_rate) {
61 case 8000: spx_mode = 0; break;
62 case 16000: spx_mode = 1; break;
63 case 32000: spx_mode = 2; break;
65 /* libspeex can handle any mode if initialized as ultra-wideband */
66 av_log(avctx, AV_LOG_WARNING, "Invalid sample rate: %d\n"
67 "Decoding as 32kHz ultra-wideband\n",
73 mode = speex_lib_get_mode(spx_mode);
75 av_log(avctx, AV_LOG_ERROR, "Unknown Speex mode %d", spx_mode);
76 return AVERROR_INVALIDDATA;
78 s->frame_size = 160 << spx_mode;
79 if (!avctx->sample_rate)
80 avctx->sample_rate = 8000 << spx_mode;
82 if (avctx->channels < 1 || avctx->channels > 2) {
83 /* libspeex can handle mono or stereo if initialized as stereo */
84 av_log(avctx, AV_LOG_ERROR, "Invalid channel count: %d.\n"
85 "Decoding as stereo.\n", avctx->channels);
88 avctx->channel_layout = avctx->channels == 2 ? AV_CH_LAYOUT_STEREO :
91 speex_bits_init(&s->bits);
92 s->dec_state = speex_decoder_init(mode);
94 av_log(avctx, AV_LOG_ERROR, "Error initializing libspeex decoder.\n");
98 if (avctx->channels == 2) {
99 SpeexCallback callback;
100 callback.callback_id = SPEEX_INBAND_STEREO;
101 callback.func = speex_std_stereo_request_handler;
102 callback.data = &s->stereo;
103 s->stereo = (SpeexStereoState)SPEEX_STEREO_STATE_INIT;
104 speex_decoder_ctl(s->dec_state, SPEEX_SET_HANDLER, &callback);
107 avcodec_get_frame_defaults(&s->frame);
108 avctx->coded_frame = &s->frame;
113 static int libspeex_decode_frame(AVCodecContext *avctx, void *data,
114 int *got_frame_ptr, AVPacket *avpkt)
116 uint8_t *buf = avpkt->data;
117 int buf_size = avpkt->size;
118 LibSpeexContext *s = avctx->priv_data;
120 int ret, consumed = 0;
122 /* get output buffer */
123 s->frame.nb_samples = s->frame_size;
124 if ((ret = ff_get_buffer(avctx, &s->frame)) < 0) {
125 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
128 output = (int16_t *)s->frame.data[0];
130 /* if there is not enough data left for the smallest possible frame or the
131 next 5 bits are a terminator code, reset the libspeex buffer using the
132 current packet, otherwise ignore the current packet and keep decoding
133 frames from the libspeex buffer. */
134 if (speex_bits_remaining(&s->bits) < 5 ||
135 speex_bits_peek_unsigned(&s->bits, 5) == 0x1F) {
136 /* check for flush packet */
137 if (!buf || !buf_size) {
142 speex_bits_read_from(&s->bits, buf, buf_size);
146 /* decode a single frame */
147 ret = speex_decode_int(s->dec_state, &s->bits, output);
149 av_log(avctx, AV_LOG_ERROR, "Error decoding Speex frame.\n");
150 return AVERROR_INVALIDDATA;
152 if (avctx->channels == 2)
153 speex_decode_stereo_int(output, s->frame_size, &s->stereo);
156 *(AVFrame *)data = s->frame;
161 static av_cold int libspeex_decode_close(AVCodecContext *avctx)
163 LibSpeexContext *s = avctx->priv_data;
165 speex_bits_destroy(&s->bits);
166 speex_decoder_destroy(s->dec_state);
171 static av_cold void libspeex_decode_flush(AVCodecContext *avctx)
173 LibSpeexContext *s = avctx->priv_data;
174 speex_bits_reset(&s->bits);
177 AVCodec ff_libspeex_decoder = {
179 .type = AVMEDIA_TYPE_AUDIO,
180 .id = AV_CODEC_ID_SPEEX,
181 .priv_data_size = sizeof(LibSpeexContext),
182 .init = libspeex_decode_init,
183 .close = libspeex_decode_close,
184 .decode = libspeex_decode_frame,
185 .flush = libspeex_decode_flush,
186 .capabilities = CODEC_CAP_SUBFRAMES | CODEC_CAP_DELAY | CODEC_CAP_DR1,
187 .long_name = NULL_IF_CONFIG_SMALL("libspeex Speex"),