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 "libavutil/avstring.h"
24 #include "libavutil/common.h"
25 #include "libavutil/opt.h"
26 #include "avcodec.h"
27 #include "audio_frame_queue.h"
28 #include "internal.h"
29 
31 {
32  const int is_amr_wb = 1 + (avctx->codec_id == AV_CODEC_ID_AMR_WB);
33 
34  if (!avctx->sample_rate)
35  avctx->sample_rate = 8000 * is_amr_wb;
36 
37  if (avctx->channels > 1) {
38  avpriv_report_missing_feature(avctx, "multi-channel AMR");
39  return AVERROR_PATCHWELCOME;
40  }
41 
42  avctx->channels = 1;
45  return 0;
46 }
47 
48 #if CONFIG_LIBOPENCORE_AMRNB
49 
50 #include <opencore-amrnb/interf_dec.h>
51 #include <opencore-amrnb/interf_enc.h>
52 
53 typedef struct AMRContext {
55  void *dec_state;
56  void *enc_state;
57  int enc_bitrate;
58  int enc_mode;
59  int enc_dtx;
60  int enc_last_frame;
61  AudioFrameQueue afq;
62 } AMRContext;
63 
64 #if CONFIG_LIBOPENCORE_AMRNB_DECODER
65 static av_cold int amr_nb_decode_init(AVCodecContext *avctx)
66 {
67  AMRContext *s = avctx->priv_data;
68  int ret;
69 
70  if ((ret = amr_decode_fix_avctx(avctx)) < 0)
71  return ret;
72 
73  s->dec_state = Decoder_Interface_init();
74  if (!s->dec_state) {
75  av_log(avctx, AV_LOG_ERROR, "Decoder_Interface_init error\n");
76  return -1;
77  }
78 
79  return 0;
80 }
81 
82 static av_cold int amr_nb_decode_close(AVCodecContext *avctx)
83 {
84  AMRContext *s = avctx->priv_data;
85 
86  Decoder_Interface_exit(s->dec_state);
87 
88  return 0;
89 }
90 
91 static int amr_nb_decode_frame(AVCodecContext *avctx, void *data,
92  int *got_frame_ptr, AVPacket *avpkt)
93 {
94  AVFrame *frame = data;
95  const uint8_t *buf = avpkt->data;
96  int buf_size = avpkt->size;
97  AMRContext *s = avctx->priv_data;
98  static const uint8_t block_size[16] = { 12, 13, 15, 17, 19, 20, 26, 31, 5, 0, 0, 0, 0, 0, 0, 0 };
99  enum Mode dec_mode;
100  int packet_size, ret;
101 
102  av_dlog(avctx, "amr_decode_frame buf=%p buf_size=%d frame_count=%d!!\n",
103  buf, buf_size, avctx->frame_number);
104 
105  /* get output buffer */
106  frame->nb_samples = 160;
107  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
108  return ret;
109 
110  dec_mode = (buf[0] >> 3) & 0x000F;
111  packet_size = block_size[dec_mode] + 1;
112 
113  if (packet_size > buf_size) {
114  av_log(avctx, AV_LOG_ERROR, "amr frame too short (%u, should be %u)\n",
115  buf_size, packet_size);
116  return AVERROR_INVALIDDATA;
117  }
118 
119  av_dlog(avctx, "packet_size=%d buf= 0x%X %X %X %X\n",
120  packet_size, buf[0], buf[1], buf[2], buf[3]);
121  /* call decoder */
122  Decoder_Interface_Decode(s->dec_state, buf, (short *)frame->data[0], 0);
123 
124  *got_frame_ptr = 1;
125 
126  return packet_size;
127 }
128 
129 AVCodec ff_libopencore_amrnb_decoder = {
130  .name = "libopencore_amrnb",
131  .type = AVMEDIA_TYPE_AUDIO,
132  .id = AV_CODEC_ID_AMR_NB,
133  .priv_data_size = sizeof(AMRContext),
134  .init = amr_nb_decode_init,
135  .close = amr_nb_decode_close,
136  .decode = amr_nb_decode_frame,
137  .capabilities = CODEC_CAP_DR1,
138  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
139 };
140 #endif /* CONFIG_LIBOPENCORE_AMRNB_DECODER */
141 
142 #if CONFIG_LIBOPENCORE_AMRNB_ENCODER
143 /* Common code for fixed and float version*/
144 typedef struct AMR_bitrates {
145  int rate;
146  enum Mode mode;
147 } AMR_bitrates;
148 
149 /* Match desired bitrate */
150 static int get_bitrate_mode(int bitrate, void *log_ctx)
151 {
152  /* make the correspondance between bitrate and mode */
153  static const AMR_bitrates rates[] = {
154  { 4750, MR475 }, { 5150, MR515 }, { 5900, MR59 }, { 6700, MR67 },
155  { 7400, MR74 }, { 7950, MR795 }, { 10200, MR102 }, { 12200, MR122 }
156  };
157  int i, best = -1, min_diff = 0;
158  char log_buf[200];
159 
160  for (i = 0; i < 8; i++) {
161  if (rates[i].rate == bitrate)
162  return rates[i].mode;
163  if (best < 0 || abs(rates[i].rate - bitrate) < min_diff) {
164  best = i;
165  min_diff = abs(rates[i].rate - bitrate);
166  }
167  }
168  /* no bitrate matching exactly, log a warning */
169  snprintf(log_buf, sizeof(log_buf), "bitrate not supported: use one of ");
170  for (i = 0; i < 8; i++)
171  av_strlcatf(log_buf, sizeof(log_buf), "%.2fk, ", rates[i].rate / 1000.f);
172  av_strlcatf(log_buf, sizeof(log_buf), "using %.2fk", rates[best].rate / 1000.f);
173  av_log(log_ctx, AV_LOG_WARNING, "%s\n", log_buf);
174 
175  return best;
176 }
177 
178 static const AVOption options[] = {
179  { "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 },
180  { NULL }
181 };
182 
183 static const AVClass class = {
184  "libopencore_amrnb", av_default_item_name, options, LIBAVUTIL_VERSION_INT
185 };
186 
187 static av_cold int amr_nb_encode_init(AVCodecContext *avctx)
188 {
189  AMRContext *s = avctx->priv_data;
190 
191  if (avctx->sample_rate != 8000 && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
192  av_log(avctx, AV_LOG_ERROR, "Only 8000Hz sample rate supported\n");
193  return AVERROR(ENOSYS);
194  }
195 
196  if (avctx->channels != 1) {
197  av_log(avctx, AV_LOG_ERROR, "Only mono supported\n");
198  return AVERROR(ENOSYS);
199  }
200 
201  avctx->frame_size = 160;
202  avctx->delay = 50;
203  ff_af_queue_init(avctx, &s->afq);
204 
205  s->enc_state = Encoder_Interface_init(s->enc_dtx);
206  if (!s->enc_state) {
207  av_log(avctx, AV_LOG_ERROR, "Encoder_Interface_init error\n");
208  av_freep(&avctx->coded_frame);
209  return -1;
210  }
211 
212  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
213  s->enc_bitrate = avctx->bit_rate;
214 
215  return 0;
216 }
217 
218 static av_cold int amr_nb_encode_close(AVCodecContext *avctx)
219 {
220  AMRContext *s = avctx->priv_data;
221 
222  Encoder_Interface_exit(s->enc_state);
223  ff_af_queue_close(&s->afq);
224  return 0;
225 }
226 
227 static int amr_nb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
228  const AVFrame *frame, int *got_packet_ptr)
229 {
230  AMRContext *s = avctx->priv_data;
231  int written, ret;
232  int16_t *flush_buf = NULL;
233  const int16_t *samples = frame ? (const int16_t *)frame->data[0] : NULL;
234 
235  if (s->enc_bitrate != avctx->bit_rate) {
236  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
237  s->enc_bitrate = avctx->bit_rate;
238  }
239 
240  if ((ret = ff_alloc_packet2(avctx, avpkt, 32)) < 0)
241  return ret;
242 
243  if (frame) {
244  if (frame->nb_samples < avctx->frame_size) {
245  flush_buf = av_mallocz(avctx->frame_size * sizeof(*flush_buf));
246  if (!flush_buf)
247  return AVERROR(ENOMEM);
248  memcpy(flush_buf, samples, frame->nb_samples * sizeof(*flush_buf));
249  samples = flush_buf;
250  if (frame->nb_samples < avctx->frame_size - avctx->delay)
251  s->enc_last_frame = -1;
252  }
253  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0) {
254  av_freep(&flush_buf);
255  return ret;
256  }
257  } else {
258  if (s->enc_last_frame < 0)
259  return 0;
260  flush_buf = av_mallocz(avctx->frame_size * sizeof(*flush_buf));
261  if (!flush_buf)
262  return AVERROR(ENOMEM);
263  samples = flush_buf;
264  s->enc_last_frame = -1;
265  }
266 
267  written = Encoder_Interface_Encode(s->enc_state, s->enc_mode, samples,
268  avpkt->data, 0);
269  av_dlog(avctx, "amr_nb_encode_frame encoded %u bytes, bitrate %u, first byte was %#02x\n",
270  written, s->enc_mode, avpkt->data[0]);
271 
272  /* Get the next frame pts/duration */
273  ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
274  &avpkt->duration);
275 
276  avpkt->size = written;
277  *got_packet_ptr = 1;
278  av_freep(&flush_buf);
279  return 0;
280 }
281 
282 AVCodec ff_libopencore_amrnb_encoder = {
283  .name = "libopencore_amrnb",
284  .type = AVMEDIA_TYPE_AUDIO,
285  .id = AV_CODEC_ID_AMR_NB,
286  .priv_data_size = sizeof(AMRContext),
287  .init = amr_nb_encode_init,
288  .encode2 = amr_nb_encode_frame,
289  .close = amr_nb_encode_close,
291  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
293  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
294  .priv_class = &class,
295 };
296 #endif /* CONFIG_LIBOPENCORE_AMRNB_ENCODER */
297 
298 #endif /* CONFIG_LIBOPENCORE_AMRNB */
299 
300 /* -----------AMR wideband ------------*/
301 #if CONFIG_LIBOPENCORE_AMRWB_DECODER
302 
303 #include <opencore-amrwb/dec_if.h>
304 #include <opencore-amrwb/if_rom.h>
305 
306 typedef struct AMRWBContext {
307  void *state;
308 } AMRWBContext;
309 
310 static av_cold int amr_wb_decode_init(AVCodecContext *avctx)
311 {
312  AMRWBContext *s = avctx->priv_data;
313  int ret;
314 
315  if ((ret = amr_decode_fix_avctx(avctx)) < 0)
316  return ret;
317 
318  s->state = D_IF_init();
319 
320  return 0;
321 }
322 
323 static int amr_wb_decode_frame(AVCodecContext *avctx, void *data,
324  int *got_frame_ptr, AVPacket *avpkt)
325 {
326  AVFrame *frame = data;
327  const uint8_t *buf = avpkt->data;
328  int buf_size = avpkt->size;
329  AMRWBContext *s = avctx->priv_data;
330  int mode, ret;
331  int packet_size;
332  static const uint8_t block_size[16] = {18, 24, 33, 37, 41, 47, 51, 59, 61, 6, 6, 0, 0, 0, 1, 1};
333 
334  /* get output buffer */
335  frame->nb_samples = 320;
336  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
337  return ret;
338 
339  mode = (buf[0] >> 3) & 0x000F;
340  packet_size = block_size[mode];
341 
342  if (packet_size > buf_size) {
343  av_log(avctx, AV_LOG_ERROR, "amr frame too short (%u, should be %u)\n",
344  buf_size, packet_size + 1);
345  return AVERROR_INVALIDDATA;
346  }
347  if (!packet_size) {
348  av_log(avctx, AV_LOG_ERROR, "amr packet_size invalid\n");
349  return AVERROR_INVALIDDATA;
350  }
351 
352  D_IF_decode(s->state, buf, (short *)frame->data[0], _good_frame);
353 
354  *got_frame_ptr = 1;
355 
356  return packet_size;
357 }
358 
359 static int amr_wb_decode_close(AVCodecContext *avctx)
360 {
361  AMRWBContext *s = avctx->priv_data;
362 
363  D_IF_exit(s->state);
364  return 0;
365 }
366 
367 AVCodec ff_libopencore_amrwb_decoder = {
368  .name = "libopencore_amrwb",
369  .type = AVMEDIA_TYPE_AUDIO,
370  .id = AV_CODEC_ID_AMR_WB,
371  .priv_data_size = sizeof(AMRWBContext),
372  .init = amr_wb_decode_init,
373  .close = amr_wb_decode_close,
374  .decode = amr_wb_decode_frame,
375  .capabilities = CODEC_CAP_DR1,
376  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-WB (Adaptive Multi-Rate Wide-Band)"),
377 };
378 
379 #endif /* CONFIG_LIBOPENCORE_AMRWB_DECODER */
void * av_mallocz(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:205
const char * s
Definition: avisynth_c.h:668
#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:76
AVOption.
Definition: opt.h:251
av_default_item_name
AVFrame * coded_frame
the picture in the bitstream
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:154
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:284
Sinusoidal phase f
av_dlog(ac->avr,"%d samples - audio_convert: %s to %s (%s)\n", len, av_get_sample_fmt_name(ac->in_fmt), av_get_sample_fmt_name(ac->out_fmt), use_generic?ac->func_descr_generic:ac->func_descr)
signed 16 bits
Definition: samplefmt.h:52
void av_freep(void *arg)
Free a memory block which has been allocated with av_malloc(z)() or av_realloc() and set the pointer ...
Definition: mem.c:198
initialize output if(nPeaks >3)%at least 3 peaks in spectrum for trying to find f0 nf0peaks
struct AMRWBContext AMRWBContext
enum AVSampleFormat sample_fmt
audio sample format
uint8_t
#define av_cold
Definition: attributes.h:78
mode
Definition: f_perms.c:27
AVOptions.
Mode
Frame type (Table 1a in 3GPP TS 26.101)
Definition: amrnbdata.h:39
#define CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
uint8_t * data
AMRNBFrame frame
decoded AMR parameters (lsf coefficients, codebook indexes, etc)
Definition: amrnbdec.c:101
int duration
Duration of this packet in AVStream->time_base units, 0 if unknown.
const OptionDef options[]
Definition: ffserver.c:4697
#define AV_OPT_FLAG_ENCODING_PARAM
a generic parameter which can be set by the user for muxing or encoding
Definition: opt.h:281
static const int rates[]
static int amr_decode_fix_avctx(AVCodecContext *avctx)
#define CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
#define CODEC_CAP_SMALL_LAST_FRAME
Codec can be fed a final frame with a smaller size.
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Spectrum Plot time data
void av_log(void *avcl, int level, const char *fmt,...)
Definition: log.c:246
const char * name
Name of the codec implementation.
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
external API header
uint64_t channel_layout
Audio channel layout.
int bit_rate
the average bitrate
audio channel layout utility functions
ret
Definition: avfilter.c:821
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
#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.
NULL
Definition: eval.c:55
#define FF_COMPLIANCE_UNOFFICIAL
Allow unofficial extensions.
enum AVCodecID codec_id
int sample_rate
samples per second
main external API structure.
static void close(AVCodecParserContext *s)
Definition: h264_parser.c:375
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:148
void * buf
Definition: avisynth_c.h:594
Describe the class of an AVClass context structure.
Definition: log.h:50
synthesis window for stochastic i
size_t av_strlcatf(char *dst, size_t size, const char *fmt,...)
Definition: avstring.c:100
#define snprintf
Definition: snprintf.h:34
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFilterBuffer 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.Buffer references ownership and permissions
void avpriv_report_missing_feature(void *avc, const char *msg,...) av_printf_format(2
Log a generic warning message about a missing feature.
static uint32_t state
Definition: trasher.c:27
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
Definition: frame.h:87
static const AVClass av_class
Definition: swresample.c:138
common internal api header.
common internal and external API header
AVSampleFormat
Audio Sample Formats.
Definition: samplefmt.h:49
void ff_af_queue_init(AVCodecContext *avctx, AudioFrameQueue *afq)
Initialize AudioFrameQueue.
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int *duration)
Remove frame(s) from the queue.
int channels
number of audio channels
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:700
int frame_number
Frame counter, set by libavcodec.
Filter the word “frame” indicates either a video frame or a group of audio samples
static int decode(AVCodecContext *avctx, void *data, int *got_frame, AVPacket *avpkt)
Definition: crystalhd.c:868
struct AMRContext AMRContext
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
int delay
Codec delay.
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:127
int strict_std_compliance
strictly follow the standard (MPEG4, ...).
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...