Libav
libgsm.c
Go to the documentation of this file.
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 
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 
38 #include "libavutil/common.h"
39 #include "avcodec.h"
40 #include "internal.h"
41 #include "gsm.h"
42 
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);
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);
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;
77  }
78  }
79 
80  return 0;
81 }
82 
84  gsm_destroy(avctx->priv_data);
85  avctx->priv_data = NULL;
86  return 0;
87 }
88 
89 static int libgsm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
90  const AVFrame *frame, int *got_packet_ptr)
91 {
92  int ret;
93  gsm_signal *samples = (gsm_signal *)frame->data[0];
94  struct gsm_state *state = avctx->priv_data;
95 
96  if ((ret = ff_alloc_packet(avpkt, avctx->block_align))) {
97  av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
98  return ret;
99  }
100 
101  switch(avctx->codec_id) {
102  case AV_CODEC_ID_GSM:
103  gsm_encode(state, samples, avpkt->data);
104  break;
105  case AV_CODEC_ID_GSM_MS:
106  gsm_encode(state, samples, avpkt->data);
107  gsm_encode(state, samples + GSM_FRAME_SIZE, avpkt->data + 32);
108  }
109 
110  *got_packet_ptr = 1;
111  return 0;
112 }
113 
114 
116  .name = "libgsm",
117  .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
118  .type = AVMEDIA_TYPE_AUDIO,
119  .id = AV_CODEC_ID_GSM,
120  .init = libgsm_encode_init,
121  .encode2 = libgsm_encode_frame,
122  .close = libgsm_encode_close,
123  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
125 };
126 
128  .name = "libgsm_ms",
129  .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
130  .type = AVMEDIA_TYPE_AUDIO,
131  .id = AV_CODEC_ID_GSM_MS,
132  .init = libgsm_encode_init,
133  .encode2 = libgsm_encode_frame,
134  .close = libgsm_encode_close,
135  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
137 };
138 
139 typedef struct LibGSMDecodeContext {
140  struct gsm_state *state;
142 
144  LibGSMDecodeContext *s = avctx->priv_data;
145 
146  avctx->channels = 1;
148  avctx->sample_rate = 8000;
149  avctx->sample_fmt = AV_SAMPLE_FMT_S16;
150 
151  s->state = gsm_create();
152 
153  switch(avctx->codec_id) {
154  case AV_CODEC_ID_GSM:
155  avctx->frame_size = GSM_FRAME_SIZE;
156  avctx->block_align = GSM_BLOCK_SIZE;
157  break;
158  case AV_CODEC_ID_GSM_MS: {
159  int one = 1;
160  gsm_option(s->state, GSM_OPT_WAV49, &one);
161  avctx->frame_size = 2 * GSM_FRAME_SIZE;
163  }
164  }
165 
166  return 0;
167 }
168 
170  LibGSMDecodeContext *s = avctx->priv_data;
171 
172  gsm_destroy(s->state);
173  s->state = NULL;
174  return 0;
175 }
176 
177 static int libgsm_decode_frame(AVCodecContext *avctx, void *data,
178  int *got_frame_ptr, AVPacket *avpkt)
179 {
180  int i, ret;
181  LibGSMDecodeContext *s = avctx->priv_data;
182  AVFrame *frame = data;
183  uint8_t *buf = avpkt->data;
184  int buf_size = avpkt->size;
185  int16_t *samples;
186 
187  if (buf_size < avctx->block_align) {
188  av_log(avctx, AV_LOG_ERROR, "Packet is too small\n");
189  return AVERROR_INVALIDDATA;
190  }
191 
192  /* get output buffer */
193  frame->nb_samples = avctx->frame_size;
194  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0) {
195  av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
196  return ret;
197  }
198  samples = (int16_t *)frame->data[0];
199 
200  for (i = 0; i < avctx->frame_size / GSM_FRAME_SIZE; i++) {
201  if ((ret = gsm_decode(s->state, buf, samples)) < 0)
202  return -1;
203  buf += GSM_BLOCK_SIZE;
204  samples += GSM_FRAME_SIZE;
205  }
206 
207  *got_frame_ptr = 1;
208 
209  return avctx->block_align;
210 }
211 
212 static void libgsm_flush(AVCodecContext *avctx) {
213  LibGSMDecodeContext *s = avctx->priv_data;
214  int one = 1;
215 
216  gsm_destroy(s->state);
217  s->state = gsm_create();
218  if (avctx->codec_id == AV_CODEC_ID_GSM_MS)
219  gsm_option(s->state, GSM_OPT_WAV49, &one);
220 }
221 
223  .name = "libgsm",
224  .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM"),
225  .type = AVMEDIA_TYPE_AUDIO,
226  .id = AV_CODEC_ID_GSM,
227  .priv_data_size = sizeof(LibGSMDecodeContext),
231  .flush = libgsm_flush,
232  .capabilities = CODEC_CAP_DR1,
233 };
234 
236  .name = "libgsm_ms",
237  .long_name = NULL_IF_CONFIG_SMALL("libgsm GSM Microsoft variant"),
238  .type = AVMEDIA_TYPE_AUDIO,
239  .id = AV_CODEC_ID_GSM_MS,
240  .priv_data_size = sizeof(LibGSMDecodeContext),
244  .flush = libgsm_flush,
245  .capabilities = CODEC_CAP_DR1,
246 };
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:54
#define GSM_FRAME_SIZE
Definition: gsm.h:30
This structure describes decoded (raw) audio or video data.
Definition: frame.h:107
int size
Definition: avcodec.h:974
static int16_t * samples
Definition: output.c:53
signed 16 bits
Definition: samplefmt.h:52
AVCodec.
Definition: avcodec.h:2755
int block_align
number of bytes per packet if constant and known or 0 Used by some WAV based audio codecs...
Definition: avcodec.h:1816
static int decode(MimicContext *ctx, int quality, int num_coeffs, int is_iframe)
Definition: mimic.c:269
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:1787
uint8_t
#define av_cold
Definition: attributes.h:66
#define GSM_MS_BLOCK_SIZE
Definition: gsm.h:26
#define CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:711
#define GSM_BLOCK_SIZE
Definition: gsm.h:25
const char data[16]
Definition: mxf.c:66
uint8_t * data
Definition: avcodec.h:973
#define FF_COMPLIANCE_UNOFFICIAL
Allow unofficial extensions.
Definition: avcodec.h:2331
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:123
AVCodec ff_libgsm_ms_encoder
Definition: libgsm.c:127
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:142
AVCodec ff_libgsm_encoder
Definition: libgsm.c:115
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:148
const char * name
Name of the codec implementation.
Definition: avcodec.h:2762
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:1840
static av_cold int libgsm_encode_close(AVCodecContext *avctx)
Definition: libgsm.c:83
int bit_rate
the average bitrate
Definition: avcodec.h:1112
audio channel layout utility functions
AVCodec ff_libgsm_ms_decoder
Definition: libgsm.c:235
int ff_alloc_packet(AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1125
static av_cold int libgsm_decode_close(AVCodecContext *avctx)
Definition: libgsm.c:169
struct gsm_state * state
Definition: libgsm.c:140
if(ac->has_optimized_func)
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1799
NULL
Definition: eval.c:55
Libavcodec external API header.
enum AVCodecID codec_id
Definition: avcodec.h:1065
AV_SAMPLE_FMT_NONE
Definition: avconv_filter.c:68
int sample_rate
samples per second
Definition: avcodec.h:1779
main external API structure.
Definition: avcodec.h:1054
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:489
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: utils.c:575
static uint32_t state
Definition: trasher.c:27
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:113
static void libgsm_flush(AVCodecContext *avctx)
Definition: libgsm.c:212
common internal api header.
common internal and external API header
static av_cold int libgsm_encode_init(AVCodecContext *avctx)
Definition: libgsm.c:43
static av_cold void flush(AVCodecContext *avctx)
Flush (reset) the frame ID after seeking.
Definition: alsdec.c:1792
static int libgsm_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libgsm.c:89
AVSampleFormat
Audio Sample Formats.
Definition: samplefmt.h:49
static av_cold int init(AVCodecParserContext *s)
Definition: h264_parser.c:498
void * priv_data
Definition: avcodec.h:1090
static av_cold int libgsm_decode_init(AVCodecContext *avctx)
Definition: libgsm.c:143
static int libgsm_decode_frame(AVCodecContext *avctx, void *data, int *got_frame_ptr, AVPacket *avpkt)
Definition: libgsm.c:177
as in Berlin toast format
Definition: avcodec.h:386
int channels
number of audio channels
Definition: avcodec.h:1780
#define AV_CH_LAYOUT_MONO
AVCodec ff_libgsm_decoder
Definition: libgsm.c:222
This structure stores compressed data.
Definition: avcodec.h:950
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:151
int strict_std_compliance
strictly follow the standard (MPEG4, ...).
Definition: avcodec.h:2327
for(j=16;j >0;--j)