libspeexdec: properly handle DTX for multiple frames-per-packet
[ffmpeg.git] / libavcodec / libspeexdec.c
1 /*
2  * Copyright (C) 2008 David Conrad
3  *
4  * This file is part of Libav.
5  *
6  * Libav 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.
10  *
11  * Libav 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.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #include <speex/speex.h>
22 #include <speex/speex_header.h>
23 #include <speex/speex_stereo.h>
24 #include <speex/speex_callbacks.h>
25
26 #include "libavutil/audioconvert.h"
27 #include "libavutil/common.h"
28 #include "avcodec.h"
29
30 typedef struct {
31     AVFrame frame;
32     SpeexBits bits;
33     SpeexStereoState stereo;
34     void *dec_state;
35     int frame_size;
36 } LibSpeexContext;
37
38
39 static av_cold int libspeex_decode_init(AVCodecContext *avctx)
40 {
41     LibSpeexContext *s = avctx->priv_data;
42     const SpeexMode *mode;
43     int spx_mode;
44
45     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
46     if (avctx->extradata && avctx->extradata_size >= 80) {
47         SpeexHeader *header = speex_packet_to_header(avctx->extradata,
48                                                      avctx->extradata_size);
49         avctx->channels    = header->nb_channels;
50         spx_mode           = header->mode;
51         speex_header_free(header);
52     } else {
53         switch (avctx->sample_rate) {
54         case 8000:  spx_mode = 0; break;
55         case 16000: spx_mode = 1; break;
56         case 32000: spx_mode = 2; break;
57         default:
58             /* libspeex can handle any mode if initialized as ultra-wideband */
59             av_log(avctx, AV_LOG_WARNING, "Invalid sample rate: %d\n"
60                                           "Decoding as 32kHz ultra-wideband\n",
61                                           avctx->sample_rate);
62             spx_mode = 2;
63         }
64     }
65
66     mode = speex_lib_get_mode(spx_mode);
67     if (!mode) {
68         av_log(avctx, AV_LOG_ERROR, "Unknown Speex mode %d", spx_mode);
69         return AVERROR_INVALIDDATA;
70     }
71     avctx->sample_rate = 8000 << spx_mode;
72     s->frame_size      =  160 << spx_mode;
73
74     if (avctx->channels < 1 || avctx->channels > 2) {
75         /* libspeex can handle mono or stereo if initialized as stereo */
76         av_log(avctx, AV_LOG_ERROR, "Invalid channel count: %d.\n"
77                                     "Decoding as stereo.\n", avctx->channels);
78         avctx->channels = 2;
79     }
80     avctx->channel_layout = avctx->channels == 2 ? AV_CH_LAYOUT_STEREO :
81                                                    AV_CH_LAYOUT_MONO;
82
83     speex_bits_init(&s->bits);
84     s->dec_state = speex_decoder_init(mode);
85     if (!s->dec_state) {
86         av_log(avctx, AV_LOG_ERROR, "Error initializing libspeex decoder.\n");
87         return -1;
88     }
89
90     if (avctx->channels == 2) {
91         SpeexCallback callback;
92         callback.callback_id = SPEEX_INBAND_STEREO;
93         callback.func = speex_std_stereo_request_handler;
94         callback.data = &s->stereo;
95         s->stereo = (SpeexStereoState)SPEEX_STEREO_STATE_INIT;
96         speex_decoder_ctl(s->dec_state, SPEEX_SET_HANDLER, &callback);
97     }
98
99     avcodec_get_frame_defaults(&s->frame);
100     avctx->coded_frame = &s->frame;
101
102     return 0;
103 }
104
105 static int libspeex_decode_frame(AVCodecContext *avctx, void *data,
106                                  int *got_frame_ptr, AVPacket *avpkt)
107 {
108     uint8_t *buf = avpkt->data;
109     int buf_size = avpkt->size;
110     LibSpeexContext *s = avctx->priv_data;
111     int16_t *output;
112     int ret, consumed = 0;
113
114     /* get output buffer */
115     s->frame.nb_samples = s->frame_size;
116     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
117         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
118         return ret;
119     }
120     output = (int16_t *)s->frame.data[0];
121
122     /* if there is not enough data left for the smallest possible frame or the
123        next 5 bits are a terminator code, reset the libspeex buffer using the
124        current packet, otherwise ignore the current packet and keep decoding
125        frames from the libspeex buffer. */
126     if (speex_bits_remaining(&s->bits) < 5 ||
127         speex_bits_peek_unsigned(&s->bits, 5) == 0x1F) {
128         /* check for flush packet */
129         if (!buf || !buf_size) {
130             *got_frame_ptr = 0;
131             return buf_size;
132         }
133         /* set new buffer */
134         speex_bits_read_from(&s->bits, buf, buf_size);
135         consumed = buf_size;
136     }
137
138     /* decode a single frame */
139     ret = speex_decode_int(s->dec_state, &s->bits, output);
140     if (ret <= -2) {
141         av_log(avctx, AV_LOG_ERROR, "Error decoding Speex frame.\n");
142         return AVERROR_INVALIDDATA;
143     }
144     if (avctx->channels == 2)
145         speex_decode_stereo_int(output, s->frame_size, &s->stereo);
146
147     *got_frame_ptr   = 1;
148     *(AVFrame *)data = s->frame;
149
150     return consumed;
151 }
152
153 static av_cold int libspeex_decode_close(AVCodecContext *avctx)
154 {
155     LibSpeexContext *s = avctx->priv_data;
156
157     speex_bits_destroy(&s->bits);
158     speex_decoder_destroy(s->dec_state);
159
160     return 0;
161 }
162
163 static av_cold void libspeex_decode_flush(AVCodecContext *avctx)
164 {
165     LibSpeexContext *s = avctx->priv_data;
166     speex_bits_reset(&s->bits);
167 }
168
169 AVCodec ff_libspeex_decoder = {
170     .name           = "libspeex",
171     .type           = AVMEDIA_TYPE_AUDIO,
172     .id             = AV_CODEC_ID_SPEEX,
173     .priv_data_size = sizeof(LibSpeexContext),
174     .init           = libspeex_decode_init,
175     .close          = libspeex_decode_close,
176     .decode         = libspeex_decode_frame,
177     .flush          = libspeex_decode_flush,
178     .capabilities   = CODEC_CAP_SUBFRAMES | CODEC_CAP_DELAY | CODEC_CAP_DR1,
179     .long_name      = NULL_IF_CONFIG_SMALL("libspeex Speex"),
180 };