FFmpeg
libopencore-amr.c
Go to the documentation of this file.
1 /*
2  * AMR Audio decoder stub
3  * Copyright (c) 2003 The FFmpeg project
4  *
5  * This file is part of FFmpeg.
6  *
7  * FFmpeg is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Lesser General Public
9  * License as published by the Free Software Foundation; either
10  * version 2.1 of the License, or (at your option) any later version.
11  *
12  * FFmpeg is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15  * Lesser General Public License for more details.
16  *
17  * You should have received a copy of the GNU Lesser General Public
18  * License along with FFmpeg; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20  */
21 
22 #include <inttypes.h>
23 
24 #include "libavutil/avstring.h"
26 #include "libavutil/common.h"
27 #include "libavutil/opt.h"
28 #include "avcodec.h"
29 #include "audio_frame_queue.h"
30 #include "internal.h"
31 
33 {
34  const int is_amr_wb = 1 + (avctx->codec_id == AV_CODEC_ID_AMR_WB);
35 
36  if (!avctx->sample_rate)
37  avctx->sample_rate = 8000 * is_amr_wb;
38 
39  if (avctx->channels > 1) {
40  avpriv_report_missing_feature(avctx, "multi-channel AMR");
41  return AVERROR_PATCHWELCOME;
42  }
43 
44  avctx->channels = 1;
47  return 0;
48 }
49 
50 #if CONFIG_LIBOPENCORE_AMRNB
51 
52 #include <opencore-amrnb/interf_dec.h>
53 #include <opencore-amrnb/interf_enc.h>
54 
55 typedef struct AMRContext {
57  void *dec_state;
58  void *enc_state;
59  int enc_bitrate;
60  int enc_mode;
61  int enc_dtx;
62  int enc_last_frame;
63  AudioFrameQueue afq;
64 } AMRContext;
65 
66 #if CONFIG_LIBOPENCORE_AMRNB_DECODER
67 static av_cold int amr_nb_decode_init(AVCodecContext *avctx)
68 {
69  AMRContext *s = avctx->priv_data;
70  int ret;
71 
72  if ((ret = amr_decode_fix_avctx(avctx)) < 0)
73  return ret;
74 
75  s->dec_state = Decoder_Interface_init();
76  if (!s->dec_state) {
77  av_log(avctx, AV_LOG_ERROR, "Decoder_Interface_init error\n");
78  return -1;
79  }
80 
81  return 0;
82 }
83 
84 static av_cold int amr_nb_decode_close(AVCodecContext *avctx)
85 {
86  AMRContext *s = avctx->priv_data;
87 
88  Decoder_Interface_exit(s->dec_state);
89 
90  return 0;
91 }
92 
93 static int amr_nb_decode_frame(AVCodecContext *avctx, void *data,
94  int *got_frame_ptr, AVPacket *avpkt)
95 {
96  AVFrame *frame = data;
97  const uint8_t *buf = avpkt->data;
98  int buf_size = avpkt->size;
99  AMRContext *s = avctx->priv_data;
100  static const uint8_t block_size[16] = { 12, 13, 15, 17, 19, 20, 26, 31, 5, 0, 0, 0, 0, 0, 0, 0 };
101  enum Mode dec_mode;
102  int packet_size, ret;
103 
104  ff_dlog(avctx, "amr_decode_frame buf=%p buf_size=%d frame_count=%d!!\n",
105  buf, buf_size, avctx->frame_number);
106 
107  /* get output buffer */
108  frame->nb_samples = 160;
109  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
110  return ret;
111 
112  dec_mode = (buf[0] >> 3) & 0x000F;
113  packet_size = block_size[dec_mode] + 1;
114 
115  if (packet_size > buf_size) {
116  av_log(avctx, AV_LOG_ERROR, "AMR frame too short (%d, should be %d)\n",
117  buf_size, packet_size);
118  return AVERROR_INVALIDDATA;
119  }
120 
121  ff_dlog(avctx, "packet_size=%d buf= 0x%"PRIx8" %"PRIx8" %"PRIx8" %"PRIx8"\n",
122  packet_size, buf[0], buf[1], buf[2], buf[3]);
123  /* call decoder */
124  Decoder_Interface_Decode(s->dec_state, buf, (short *)frame->data[0], 0);
125 
126  *got_frame_ptr = 1;
127 
128  return packet_size;
129 }
130 
132  .name = "libopencore_amrnb",
133  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
134  .type = AVMEDIA_TYPE_AUDIO,
135  .id = AV_CODEC_ID_AMR_NB,
136  .priv_data_size = sizeof(AMRContext),
137  .init = amr_nb_decode_init,
138  .close = amr_nb_decode_close,
139  .decode = amr_nb_decode_frame,
140  .capabilities = AV_CODEC_CAP_DR1,
141 };
142 #endif /* CONFIG_LIBOPENCORE_AMRNB_DECODER */
143 
144 #if CONFIG_LIBOPENCORE_AMRNB_ENCODER
145 /* Common code for fixed and float version*/
146 typedef struct AMR_bitrates {
147  int rate;
148  enum Mode mode;
149 } AMR_bitrates;
150 
151 /* Match desired bitrate */
152 static int get_bitrate_mode(int bitrate, void *log_ctx)
153 {
154  /* make the correspondence between bitrate and mode */
155  static const AMR_bitrates rates[] = {
156  { 4750, MR475 }, { 5150, MR515 }, { 5900, MR59 }, { 6700, MR67 },
157  { 7400, MR74 }, { 7950, MR795 }, { 10200, MR102 }, { 12200, MR122 }
158  };
159  int i, best = -1, min_diff = 0;
160  char log_buf[200];
161 
162  for (i = 0; i < 8; i++) {
163  if (rates[i].rate == bitrate)
164  return rates[i].mode;
165  if (best < 0 || abs(rates[i].rate - bitrate) < min_diff) {
166  best = i;
167  min_diff = abs(rates[i].rate - bitrate);
168  }
169  }
170  /* no bitrate matching exactly, log a warning */
171  snprintf(log_buf, sizeof(log_buf), "bitrate not supported: use one of ");
172  for (i = 0; i < 8; i++)
173  av_strlcatf(log_buf, sizeof(log_buf), "%.2fk, ", rates[i].rate / 1000.f);
174  av_strlcatf(log_buf, sizeof(log_buf), "using %.2fk", rates[best].rate / 1000.f);
175  av_log(log_ctx, AV_LOG_WARNING, "%s\n", log_buf);
176 
177  return best;
178 }
179 
180 static const AVOption options[] = {
181  { "dtx", "Allow DTX (generate comfort noise)", offsetof(AMRContext, enc_dtx), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
182  { NULL }
183 };
184 
185 static const AVClass amrnb_class = {
186  .class_name = "libopencore_amrnb",
187  .item_name = av_default_item_name,
188  .option = options,
189  .version = LIBAVUTIL_VERSION_INT,
190 };
191 
192 static av_cold int amr_nb_encode_init(AVCodecContext *avctx)
193 {
194  AMRContext *s = avctx->priv_data;
195 
196  if (avctx->sample_rate != 8000 && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
197  av_log(avctx, AV_LOG_ERROR, "Only 8000Hz sample rate supported\n");
198  return AVERROR(ENOSYS);
199  }
200 
201  if (avctx->channels != 1) {
202  av_log(avctx, AV_LOG_ERROR, "Only mono supported\n");
203  return AVERROR(ENOSYS);
204  }
205 
206  avctx->frame_size = 160;
207  avctx->initial_padding = 50;
208  ff_af_queue_init(avctx, &s->afq);
209 
210  s->enc_state = Encoder_Interface_init(s->enc_dtx);
211  if (!s->enc_state) {
212  av_log(avctx, AV_LOG_ERROR, "Encoder_Interface_init error\n");
213  return -1;
214  }
215 
216  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
217  s->enc_bitrate = avctx->bit_rate;
218 
219  return 0;
220 }
221 
222 static av_cold int amr_nb_encode_close(AVCodecContext *avctx)
223 {
224  AMRContext *s = avctx->priv_data;
225 
226  Encoder_Interface_exit(s->enc_state);
227  ff_af_queue_close(&s->afq);
228  return 0;
229 }
230 
231 static int amr_nb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
232  const AVFrame *frame, int *got_packet_ptr)
233 {
234  AMRContext *s = avctx->priv_data;
235  int written, ret;
236  int16_t *flush_buf = NULL;
237  const int16_t *samples = frame ? (const int16_t *)frame->data[0] : NULL;
238 
239  if (s->enc_bitrate != avctx->bit_rate) {
240  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
241  s->enc_bitrate = avctx->bit_rate;
242  }
243 
244  if ((ret = ff_alloc_packet2(avctx, avpkt, 32, 0)) < 0)
245  return ret;
246 
247  if (frame) {
248  if (frame->nb_samples < avctx->frame_size) {
249  flush_buf = av_mallocz_array(avctx->frame_size, sizeof(*flush_buf));
250  if (!flush_buf)
251  return AVERROR(ENOMEM);
252  memcpy(flush_buf, samples, frame->nb_samples * sizeof(*flush_buf));
253  samples = flush_buf;
254  if (frame->nb_samples < avctx->frame_size - avctx->initial_padding)
255  s->enc_last_frame = -1;
256  }
257  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0) {
258  av_freep(&flush_buf);
259  return ret;
260  }
261  } else {
262  if (s->enc_last_frame < 0)
263  return 0;
264  flush_buf = av_mallocz_array(avctx->frame_size, sizeof(*flush_buf));
265  if (!flush_buf)
266  return AVERROR(ENOMEM);
267  samples = flush_buf;
268  s->enc_last_frame = -1;
269  }
270 
271  written = Encoder_Interface_Encode(s->enc_state, s->enc_mode, samples,
272  avpkt->data, 0);
273  ff_dlog(avctx, "amr_nb_encode_frame encoded %u bytes, bitrate %u, first byte was %#02x\n",
274  written, s->enc_mode, avpkt->data[0]);
275 
276  /* Get the next frame pts/duration */
277  ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
278  &avpkt->duration);
279 
280  avpkt->size = written;
281  *got_packet_ptr = 1;
282  av_freep(&flush_buf);
283  return 0;
284 }
285 
287  .name = "libopencore_amrnb",
288  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
289  .type = AVMEDIA_TYPE_AUDIO,
290  .id = AV_CODEC_ID_AMR_NB,
291  .priv_data_size = sizeof(AMRContext),
292  .init = amr_nb_encode_init,
293  .encode2 = amr_nb_encode_frame,
294  .close = amr_nb_encode_close,
296  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
298  .priv_class = &amrnb_class,
299 };
300 #endif /* CONFIG_LIBOPENCORE_AMRNB_ENCODER */
301 
302 #endif /* CONFIG_LIBOPENCORE_AMRNB */
303 
304 /* -----------AMR wideband ------------*/
305 #if CONFIG_LIBOPENCORE_AMRWB_DECODER
306 
307 #include <opencore-amrwb/dec_if.h>
308 #include <opencore-amrwb/if_rom.h>
309 
310 typedef struct AMRWBContext {
311  void *state;
312 } AMRWBContext;
313 
314 static av_cold int amr_wb_decode_init(AVCodecContext *avctx)
315 {
316  AMRWBContext *s = avctx->priv_data;
317  int ret;
318 
319  if ((ret = amr_decode_fix_avctx(avctx)) < 0)
320  return ret;
321 
322  s->state = D_IF_init();
323 
324  return 0;
325 }
326 
327 static int amr_wb_decode_frame(AVCodecContext *avctx, void *data,
328  int *got_frame_ptr, AVPacket *avpkt)
329 {
330  AVFrame *frame = data;
331  const uint8_t *buf = avpkt->data;
332  int buf_size = avpkt->size;
333  AMRWBContext *s = avctx->priv_data;
334  int mode, ret;
335  int packet_size;
336  static const uint8_t block_size[16] = {18, 24, 33, 37, 41, 47, 51, 59, 61, 6, 6, 0, 0, 0, 1, 1};
337 
338  /* get output buffer */
339  frame->nb_samples = 320;
340  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
341  return ret;
342 
343  mode = (buf[0] >> 3) & 0x000F;
344  packet_size = block_size[mode];
345 
346  if (packet_size > buf_size) {
347  av_log(avctx, AV_LOG_ERROR, "AMR frame too short (%d, should be %d)\n",
348  buf_size, packet_size + 1);
349  return AVERROR_INVALIDDATA;
350  }
351  if (!packet_size) {
352  av_log(avctx, AV_LOG_ERROR, "amr packet_size invalid\n");
353  return AVERROR_INVALIDDATA;
354  }
355 
356  D_IF_decode(s->state, buf, (short *)frame->data[0], _good_frame);
357 
358  *got_frame_ptr = 1;
359 
360  return packet_size;
361 }
362 
363 static int amr_wb_decode_close(AVCodecContext *avctx)
364 {
365  AMRWBContext *s = avctx->priv_data;
366 
367  D_IF_exit(s->state);
368  return 0;
369 }
370 
372  .name = "libopencore_amrwb",
373  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-WB (Adaptive Multi-Rate Wide-Band)"),
374  .type = AVMEDIA_TYPE_AUDIO,
375  .id = AV_CODEC_ID_AMR_WB,
376  .priv_data_size = sizeof(AMRWBContext),
377  .init = amr_wb_decode_init,
378  .close = amr_wb_decode_close,
379  .decode = amr_wb_decode_frame,
380  .capabilities = AV_CODEC_CAP_DR1,
381  .wrapper_name = "libopencore_amrwb",
382 };
383 
384 #endif /* CONFIG_LIBOPENCORE_AMRWB_DECODER */
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int64_t *duration)
Remove frame(s) from the queue.
#define NULL
Definition: coverity.c:32
#define AVERROR_INVALIDDATA
Invalid data found when processing input.
Definition: error.h:59
This structure describes decoded (raw) audio or video data.
Definition: frame.h:268
AVOption.
Definition: opt.h:246
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:100
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int64_t bit_rate
the average bitrate
Definition: avcodec.h:1615
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:278
int size
Definition: avcodec.h:1478
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:191
AVCodec.
Definition: avcodec.h:3477
static void decode(AVCodecContext *dec_ctx, AVPacket *pkt, AVFrame *frame, FILE *outfile)
Definition: decode_audio.c:42
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
Definition: log.h:72
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
Definition: avcodec.h:1006
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: encode.c:32
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:2229
uint8_t
#define av_cold
Definition: attributes.h:82
AVOptions.
#define f(width, name)
Definition: cbs_vp9.c:255
av_cold void ff_af_queue_init(AVCodecContext *avctx, AudioFrameQueue *afq)
Initialize AudioFrameQueue.
int64_t duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
Definition: avcodec.h:1495
Mode
Frame type (Table 1a in 3GPP TS 26.101)
Definition: amrnbdata.h:39
uint8_t * data
Definition: avcodec.h:1477
AMRNBFrame frame
decoded AMR parameters (lsf coefficients, codebook indexes, etc)
Definition: amrnbdec.c:101
#define ff_dlog(a,...)
#define av_log(a,...)
#define AV_OPT_FLAG_ENCODING_PARAM
a generic parameter which can be set by the user for muxing or encoding
Definition: opt.h:276
#define FF_COMPLIANCE_UNOFFICIAL
Allow unofficial extensions.
Definition: avcodec.h:2628
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:260
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
static int amr_decode_fix_avctx(AVCodecContext *avctx)
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:186
int initial_padding
Audio only.
Definition: avcodec.h:3092
const char * name
Name of the codec implementation.
Definition: avcodec.h:3484
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
uint64_t channel_layout
Audio channel layout.
Definition: avcodec.h:2272
audio channel layout utility functions
#define AV_CODEC_CAP_SMALL_LAST_FRAME
Codec can be fed a final frame with a smaller size.
Definition: avcodec.h:1011
#define s(width, name)
Definition: cbs_vp9.c:257
AVCodec ff_libopencore_amrnb_decoder
AVCodec ff_libopencore_amrnb_encoder
if(ret)
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
Definition: error.h:62
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:2241
Libavcodec external API header.
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
enum AVCodecID codec_id
Definition: avcodec.h:1575
int sample_rate
samples per second
Definition: avcodec.h:2221
main external API structure.
Definition: avcodec.h:1565
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: decode.c:1964
void * buf
Definition: avisynth_c.h:766
static const AVClass av_class
Definition: options.c:134
Describe the class of an AVClass context structure.
Definition: log.h:67
size_t av_strlcatf(char *dst, size_t size, const char *fmt,...)
Definition: avstring.c:101
#define snprintf
Definition: snprintf.h:34
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:282
int64_t bitrate
Definition: h264_levels.c:131
const OptionDef options[]
Definition: ffmpeg_opt.c:3362
AVCodec ff_libopencore_amrwb_decoder
common internal api header.
common internal and external API header
signed 16 bits
Definition: samplefmt.h:61
void * priv_data
Definition: avcodec.h:1592
int channels
number of audio channels
Definition: avcodec.h:2222
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:701
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:2252
Filter the word “frame” indicates either a video frame or a group of audio samples
#define av_freep(p)
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later.That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another.Frame references ownership and permissions
static const int rates[]
Definition: avresample.c:176
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
Definition: avcodec.h:1454
mode
Use these values in ebur128_init (or&#39;ed).
Definition: ebur128.h:83
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:334
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:2624
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:981
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1470
static struct @308 state
void * av_mallocz_array(size_t nmemb, size_t size)
Definition: mem.c:191