935bebb1cedaf115a6f46a467729c705c20998d6
[ffmpeg.git] / libavcodec / libspeexdec.c
1 /*
2  * Copyright (C) 2008 David Conrad
3  *
4  * This file is part of FFmpeg.
5  *
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.
10  *
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.
15  *
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
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/channel_layout.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     SpeexHeader *header = NULL;
44     int spx_mode;
45
46     avctx->sample_fmt = AV_SAMPLE_FMT_S16;
47     if (avctx->extradata && avctx->extradata_size >= 80) {
48         header = speex_packet_to_header(avctx->extradata,
49                                         avctx->extradata_size);
50         if (!header)
51             av_log(avctx, AV_LOG_WARNING, "Invalid Speex header\n");
52     }
53     if (header) {
54         avctx->sample_rate = header->rate;
55         avctx->channels    = header->nb_channels;
56         spx_mode           = header->mode;
57         speex_header_free(header);
58     } else {
59         switch (avctx->sample_rate) {
60         case 8000:  spx_mode = 0; break;
61         case 16000: spx_mode = 1; break;
62         case 32000: spx_mode = 2; break;
63         default:
64             /* libspeex can handle any mode if initialized as ultra-wideband */
65             av_log(avctx, AV_LOG_WARNING, "Invalid sample rate: %d\n"
66                                           "Decoding as 32kHz ultra-wideband\n",
67                                           avctx->sample_rate);
68             spx_mode = 2;
69         }
70     }
71
72     mode = speex_lib_get_mode(spx_mode);
73     if (!mode) {
74         av_log(avctx, AV_LOG_ERROR, "Unknown Speex mode %d", spx_mode);
75         return AVERROR_INVALIDDATA;
76     }
77     s->frame_size      =  160 << spx_mode;
78     if (!avctx->sample_rate)
79         avctx->sample_rate = 8000 << spx_mode;
80
81     if (avctx->channels < 1 || avctx->channels > 2) {
82         /* libspeex can handle mono or stereo if initialized as stereo */
83         av_log(avctx, AV_LOG_ERROR, "Invalid channel count: %d.\n"
84                                     "Decoding as stereo.\n", avctx->channels);
85         avctx->channels = 2;
86     }
87     avctx->channel_layout = avctx->channels == 2 ? AV_CH_LAYOUT_STEREO :
88                                                    AV_CH_LAYOUT_MONO;
89
90     speex_bits_init(&s->bits);
91     s->dec_state = speex_decoder_init(mode);
92     if (!s->dec_state) {
93         av_log(avctx, AV_LOG_ERROR, "Error initializing libspeex decoder.\n");
94         return -1;
95     }
96
97     if (avctx->channels == 2) {
98         SpeexCallback callback;
99         callback.callback_id = SPEEX_INBAND_STEREO;
100         callback.func = speex_std_stereo_request_handler;
101         callback.data = &s->stereo;
102         s->stereo = (SpeexStereoState)SPEEX_STEREO_STATE_INIT;
103         speex_decoder_ctl(s->dec_state, SPEEX_SET_HANDLER, &callback);
104     }
105
106     avcodec_get_frame_defaults(&s->frame);
107     avctx->coded_frame = &s->frame;
108
109     return 0;
110 }
111
112 static int libspeex_decode_frame(AVCodecContext *avctx, void *data,
113                                  int *got_frame_ptr, AVPacket *avpkt)
114 {
115     uint8_t *buf = avpkt->data;
116     int buf_size = avpkt->size;
117     LibSpeexContext *s = avctx->priv_data;
118     int16_t *output;
119     int ret, consumed = 0;
120
121     /* get output buffer */
122     s->frame.nb_samples = s->frame_size;
123     if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
124         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
125         return ret;
126     }
127     output = (int16_t *)s->frame.data[0];
128
129     /* if there is not enough data left for the smallest possible frame or the
130        next 5 bits are a terminator code, reset the libspeex buffer using the
131        current packet, otherwise ignore the current packet and keep decoding
132        frames from the libspeex buffer. */
133     if (speex_bits_remaining(&s->bits) < 5 ||
134         speex_bits_peek_unsigned(&s->bits, 5) == 0x1F) {
135         /* check for flush packet */
136         if (!buf || !buf_size) {
137             *got_frame_ptr = 0;
138             return buf_size;
139         }
140         /* set new buffer */
141         speex_bits_read_from(&s->bits, buf, buf_size);
142         consumed = buf_size;
143     }
144
145     /* decode a single frame */
146     ret = speex_decode_int(s->dec_state, &s->bits, output);
147     if (ret <= -2) {
148         av_log(avctx, AV_LOG_ERROR, "Error decoding Speex frame.\n");
149         return AVERROR_INVALIDDATA;
150     }
151     if (avctx->channels == 2)
152         speex_decode_stereo_int(output, s->frame_size, &s->stereo);
153
154     *got_frame_ptr   = 1;
155     *(AVFrame *)data = s->frame;
156
157     return consumed;
158 }
159
160 static av_cold int libspeex_decode_close(AVCodecContext *avctx)
161 {
162     LibSpeexContext *s = avctx->priv_data;
163
164     speex_bits_destroy(&s->bits);
165     speex_decoder_destroy(s->dec_state);
166
167     return 0;
168 }
169
170 static av_cold void libspeex_decode_flush(AVCodecContext *avctx)
171 {
172     LibSpeexContext *s = avctx->priv_data;
173     speex_bits_reset(&s->bits);
174 }
175
176 AVCodec ff_libspeex_decoder = {
177     .name           = "libspeex",
178     .type           = AVMEDIA_TYPE_AUDIO,
179     .id             = AV_CODEC_ID_SPEEX,
180     .priv_data_size = sizeof(LibSpeexContext),
181     .init           = libspeex_decode_init,
182     .close          = libspeex_decode_close,
183     .decode         = libspeex_decode_frame,
184     .flush          = libspeex_decode_flush,
185     .capabilities   = CODEC_CAP_SUBFRAMES | CODEC_CAP_DELAY | CODEC_CAP_DR1,
186     .long_name      = NULL_IF_CONFIG_SMALL("libspeex Speex"),
187 };