mace: decode directly to the user-provided AVFrame
[ffmpeg.git] / libavcodec / libgsm.c
1 /*
2  * Interface to libgsm for gsm encoding/decoding
3  * Copyright (c) 2005 Alban Bedel <albeu@free.fr>
4  * Copyright (c) 2006, 2007 Michel Bardiaux <mbardiaux@mediaxim.be>
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * Interface to libgsm for gsm encoding/decoding
26  */
27
28 // The idiosyncrasies of GSM-in-WAV are explained at http://kbs.cs.tu-berlin.de/~jutta/toast.html
29
30 #include "config.h"
31 #if HAVE_GSM_H
32 #include <gsm.h>
33 #else
34 #include <gsm/gsm.h>
35 #endif
36
37 #include "libavutil/channel_layout.h"
38 #include "libavutil/common.h"
39 #include "avcodec.h"
40 #include "internal.h"
41 #include "gsm.h"
42
43 static av_cold int libgsm_encode_init(AVCodecContext *avctx) {
44     if (avctx->channels > 1) {
45         av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
46                avctx->channels);
47         return -1;
48     }
49
50     if (avctx->sample_rate != 8000) {
51         av_log(avctx, AV_LOG_ERROR, "Sample rate 8000Hz required for GSM, got %dHz\n",
52                avctx->sample_rate);
53         if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
54             return -1;
55     }
56     if (avctx->bit_rate != 13000 /* Official */ &&
57         avctx->bit_rate != 13200 /* Very common */ &&
58         avctx->bit_rate != 0 /* Unknown; a.o. mov does not set bitrate when decoding */ ) {
59         av_log(avctx, AV_LOG_ERROR, "Bitrate 13000bps required for GSM, got %dbps\n",
60                avctx->bit_rate);
61         if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
62             return -1;
63     }
64
65     avctx->priv_data = gsm_create();
66
67     switch(avctx->codec_id) {
68     case AV_CODEC_ID_GSM:
69         avctx->frame_size = GSM_FRAME_SIZE;
70         avctx->block_align = GSM_BLOCK_SIZE;
71         break;
72     case AV_CODEC_ID_GSM_MS: {
73         int one = 1;
74         gsm_option(avctx->priv_data, GSM_OPT_WAV49, &one);
75         avctx->frame_size = 2*GSM_FRAME_SIZE;
76         avctx->block_align = GSM_MS_BLOCK_SIZE;
77         }
78     }
79
80 #if FF_API_OLD_ENCODE_AUDIO
81     avctx->coded_frame= avcodec_alloc_frame();
82     if (!avctx->coded_frame) {
83         gsm_destroy(avctx->priv_data);
84         return AVERROR(ENOMEM);
85     }
86 #endif
87
88     return 0;
89 }
90
91 static av_cold int libgsm_encode_close(AVCodecContext *avctx) {
92 #if FF_API_OLD_ENCODE_AUDIO
93     av_freep(&avctx->coded_frame);
94 #endif
95     gsm_destroy(avctx->priv_data);
96     avctx->priv_data = NULL;
97     return 0;
98 }
99
100 static int libgsm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
101                                const AVFrame *frame, int *got_packet_ptr)
102 {
103     int ret;
104     gsm_signal *samples = (gsm_signal *)frame->data[0];
105     struct gsm_state *state = avctx->priv_data;
106
107     if ((ret = ff_alloc_packet(avpkt, avctx->block_align))) {
108         av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
109         return ret;
110     }
111
112     switch(avctx->codec_id) {
113     case AV_CODEC_ID_GSM:
114         gsm_encode(state, samples, avpkt->data);
115         break;
116     case AV_CODEC_ID_GSM_MS:
117         gsm_encode(state, samples,                  avpkt->data);
118         gsm_encode(state, samples + GSM_FRAME_SIZE, avpkt->data + 32);
119     }
120
121     *got_packet_ptr = 1;
122     return 0;
123 }
124
125
126 AVCodec ff_libgsm_encoder = {
127     .name           = "libgsm",
128     .type           = AVMEDIA_TYPE_AUDIO,
129     .id             = AV_CODEC_ID_GSM,
130     .init           = libgsm_encode_init,
131     .encode2        = libgsm_encode_frame,
132     .close          = libgsm_encode_close,
133     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
134                                                      AV_SAMPLE_FMT_NONE },
135     .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM"),
136 };
137
138 AVCodec ff_libgsm_ms_encoder = {
139     .name           = "libgsm_ms",
140     .type           = AVMEDIA_TYPE_AUDIO,
141     .id             = AV_CODEC_ID_GSM_MS,
142     .init           = libgsm_encode_init,
143     .encode2        = libgsm_encode_frame,
144     .close          = libgsm_encode_close,
145     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
146                                                      AV_SAMPLE_FMT_NONE },
147     .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
148 };
149
150 typedef struct LibGSMDecodeContext {
151     struct gsm_state *state;
152 } LibGSMDecodeContext;
153
154 static av_cold int libgsm_decode_init(AVCodecContext *avctx) {
155     LibGSMDecodeContext *s = avctx->priv_data;
156
157     avctx->channels       = 1;
158     avctx->channel_layout = AV_CH_LAYOUT_MONO;
159     avctx->sample_rate    = 8000;
160     avctx->sample_fmt     = AV_SAMPLE_FMT_S16;
161
162     s->state = gsm_create();
163
164     switch(avctx->codec_id) {
165     case AV_CODEC_ID_GSM:
166         avctx->frame_size  = GSM_FRAME_SIZE;
167         avctx->block_align = GSM_BLOCK_SIZE;
168         break;
169     case AV_CODEC_ID_GSM_MS: {
170         int one = 1;
171         gsm_option(s->state, GSM_OPT_WAV49, &one);
172         avctx->frame_size  = 2 * GSM_FRAME_SIZE;
173         avctx->block_align = GSM_MS_BLOCK_SIZE;
174         }
175     }
176
177     return 0;
178 }
179
180 static av_cold int libgsm_decode_close(AVCodecContext *avctx) {
181     LibGSMDecodeContext *s = avctx->priv_data;
182
183     gsm_destroy(s->state);
184     s->state = NULL;
185     return 0;
186 }
187
188 static int libgsm_decode_frame(AVCodecContext *avctx, void *data,
189                                int *got_frame_ptr, AVPacket *avpkt)
190 {
191     int i, ret;
192     LibGSMDecodeContext *s = avctx->priv_data;
193     AVFrame *frame         = data;
194     uint8_t *buf = avpkt->data;
195     int buf_size = avpkt->size;
196     int16_t *samples;
197
198     if (buf_size < avctx->block_align) {
199         av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
200         return AVERROR_INVALIDDATA;
201     }
202
203     /* get output buffer */
204     frame->nb_samples = avctx->frame_size;
205     if ((ret = ff_get_buffer(avctx, frame)) < 0) {
206         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
207         return ret;
208     }
209     samples = (int16_t *)frame->data[0];
210
211     for (i = 0; i < avctx->frame_size / GSM_FRAME_SIZE; i++) {
212         if ((ret = gsm_decode(s->state, buf, samples)) < 0)
213             return -1;
214         buf     += GSM_BLOCK_SIZE;
215         samples += GSM_FRAME_SIZE;
216     }
217
218     *got_frame_ptr = 1;
219
220     return avctx->block_align;
221 }
222
223 static void libgsm_flush(AVCodecContext *avctx) {
224     LibGSMDecodeContext *s = avctx->priv_data;
225     int one = 1;
226
227     gsm_destroy(s->state);
228     s->state = gsm_create();
229     if (avctx->codec_id == AV_CODEC_ID_GSM_MS)
230         gsm_option(s->state, GSM_OPT_WAV49, &one);
231 }
232
233 AVCodec ff_libgsm_decoder = {
234     .name           = "libgsm",
235     .type           = AVMEDIA_TYPE_AUDIO,
236     .id             = AV_CODEC_ID_GSM,
237     .priv_data_size = sizeof(LibGSMDecodeContext),
238     .init           = libgsm_decode_init,
239     .close          = libgsm_decode_close,
240     .decode         = libgsm_decode_frame,
241     .flush          = libgsm_flush,
242     .capabilities   = CODEC_CAP_DR1,
243     .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM"),
244 };
245
246 AVCodec ff_libgsm_ms_decoder = {
247     .name           = "libgsm_ms",
248     .type           = AVMEDIA_TYPE_AUDIO,
249     .id             = AV_CODEC_ID_GSM_MS,
250     .priv_data_size = sizeof(LibGSMDecodeContext),
251     .init           = libgsm_decode_init,
252     .close          = libgsm_decode_close,
253     .decode         = libgsm_decode_frame,
254     .flush          = libgsm_flush,
255     .capabilities   = CODEC_CAP_DR1,
256     .long_name      = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
257 };