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>
6 * This file is part of FFmpeg.
8 * FFmpeg 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.
13 * FFmpeg 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.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Interface to libgsm for gsm encoding/decoding
28 // The idiosyncrasies of GSM-in-WAV are explained at http://kbs.cs.tu-berlin.de/~jutta/toast.html
33 // gsm.h misses some essential constants
34 #define GSM_BLOCK_SIZE 33
35 #define GSM_MS_BLOCK_SIZE 65
36 #define GSM_FRAME_SIZE 160
38 static av_cold int libgsm_encode_init(AVCodecContext *avctx) {
39 if (avctx->channels > 1) {
40 av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
45 if (avctx->sample_rate != 8000) {
46 av_log(avctx, AV_LOG_ERROR, "Sample rate 8000Hz required for GSM, got %dHz\n",
48 if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
51 if (avctx->bit_rate != 13000 /* Official */ &&
52 avctx->bit_rate != 13200 /* Very common */ &&
53 avctx->bit_rate != 0 /* Unknown; a.o. mov does not set bitrate when decoding */ ) {
54 av_log(avctx, AV_LOG_ERROR, "Bitrate 13000bps required for GSM, got %dbps\n",
56 if (avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL)
60 avctx->priv_data = gsm_create();
62 switch(avctx->codec_id) {
64 avctx->frame_size = GSM_FRAME_SIZE;
65 avctx->block_align = GSM_BLOCK_SIZE;
67 case CODEC_ID_GSM_MS: {
69 gsm_option(avctx->priv_data, GSM_OPT_WAV49, &one);
70 avctx->frame_size = 2*GSM_FRAME_SIZE;
71 avctx->block_align = GSM_MS_BLOCK_SIZE;
75 avctx->coded_frame= avcodec_alloc_frame();
76 avctx->coded_frame->key_frame= 1;
81 static av_cold int libgsm_encode_close(AVCodecContext *avctx) {
82 av_freep(&avctx->coded_frame);
83 gsm_destroy(avctx->priv_data);
84 avctx->priv_data = NULL;
88 static int libgsm_encode_frame(AVCodecContext *avctx,
89 unsigned char *frame, int buf_size, void *data) {
90 // we need a full block
91 if(buf_size < avctx->block_align) return 0;
93 switch(avctx->codec_id) {
95 gsm_encode(avctx->priv_data,data,frame);
98 gsm_encode(avctx->priv_data,data,frame);
99 gsm_encode(avctx->priv_data,((short*)data)+GSM_FRAME_SIZE,frame+32);
101 return avctx->block_align;
105 AVCodec ff_libgsm_encoder = {
107 .type = AVMEDIA_TYPE_AUDIO,
109 .init = libgsm_encode_init,
110 .encode = libgsm_encode_frame,
111 .close = libgsm_encode_close,
112 .sample_fmts = (const enum AVSampleFormat[]){AV_SAMPLE_FMT_S16,AV_SAMPLE_FMT_NONE},
113 .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
116 AVCodec ff_libgsm_ms_encoder = {
118 .type = AVMEDIA_TYPE_AUDIO,
119 .id = CODEC_ID_GSM_MS,
120 .init = libgsm_encode_init,
121 .encode = libgsm_encode_frame,
122 .close = libgsm_encode_close,
123 .sample_fmts = (const enum AVSampleFormat[]){AV_SAMPLE_FMT_S16,AV_SAMPLE_FMT_NONE},
124 .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
127 typedef struct LibGSMDecodeContext {
129 struct gsm_state *state;
130 } LibGSMDecodeContext;
132 static av_cold int libgsm_decode_init(AVCodecContext *avctx) {
133 LibGSMDecodeContext *s = avctx->priv_data;
135 if (avctx->channels > 1) {
136 av_log(avctx, AV_LOG_ERROR, "Mono required for GSM, got %d channels\n",
141 if (!avctx->channels)
144 if (!avctx->sample_rate)
145 avctx->sample_rate = 8000;
147 avctx->sample_fmt = AV_SAMPLE_FMT_S16;
149 s->state = gsm_create();
151 switch(avctx->codec_id) {
153 avctx->frame_size = GSM_FRAME_SIZE;
154 avctx->block_align = GSM_BLOCK_SIZE;
156 case CODEC_ID_GSM_MS: {
158 gsm_option(s->state, GSM_OPT_WAV49, &one);
159 avctx->frame_size = 2 * GSM_FRAME_SIZE;
160 avctx->block_align = GSM_MS_BLOCK_SIZE;
164 avcodec_get_frame_defaults(&s->frame);
165 avctx->coded_frame = &s->frame;
170 static av_cold int libgsm_decode_close(AVCodecContext *avctx) {
171 LibGSMDecodeContext *s = avctx->priv_data;
173 gsm_destroy(s->state);
178 static int libgsm_decode_frame(AVCodecContext *avctx, void *data,
179 int *got_frame_ptr, AVPacket *avpkt)
182 LibGSMDecodeContext *s = avctx->priv_data;
183 uint8_t *buf = avpkt->data;
184 int buf_size = avpkt->size;
187 if (buf_size < avctx->block_align) {
188 av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
189 return AVERROR_INVALIDDATA;
192 /* get output buffer */
193 s->frame.nb_samples = avctx->frame_size;
194 if ((ret = avctx->get_buffer(avctx, &s->frame)) < 0) {
195 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
198 samples = (int16_t *)s->frame.data[0];
200 for (i = 0; i < avctx->frame_size / GSM_FRAME_SIZE; i++) {
201 if ((ret = gsm_decode(s->state, buf, samples)) < 0)
203 buf += GSM_BLOCK_SIZE;
204 samples += GSM_FRAME_SIZE;
208 *(AVFrame *)data = s->frame;
210 return avctx->block_align;
213 static void libgsm_flush(AVCodecContext *avctx) {
214 LibGSMDecodeContext *s = avctx->priv_data;
217 gsm_destroy(s->state);
218 s->state = gsm_create();
219 if (avctx->codec_id == CODEC_ID_GSM_MS)
220 gsm_option(s->state, GSM_OPT_WAV49, &one);
223 AVCodec ff_libgsm_decoder = {
225 .type = AVMEDIA_TYPE_AUDIO,
227 .priv_data_size = sizeof(LibGSMDecodeContext),
228 .init = libgsm_decode_init,
229 .close = libgsm_decode_close,
230 .decode = libgsm_decode_frame,
231 .flush = libgsm_flush,
232 .capabilities = CODEC_CAP_DR1,
233 .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
236 AVCodec ff_libgsm_ms_decoder = {
238 .type = AVMEDIA_TYPE_AUDIO,
239 .id = CODEC_ID_GSM_MS,
240 .priv_data_size = sizeof(LibGSMDecodeContext),
241 .init = libgsm_decode_init,
242 .close = libgsm_decode_close,
243 .decode = libgsm_decode_frame,
244 .flush = libgsm_flush,
245 .capabilities = CODEC_CAP_DR1,
246 .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),