FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
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 
131 AVCodec ff_libopencore_amrnb_decoder = {
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  "libopencore_amrnb", av_default_item_name, options, LIBAVUTIL_VERSION_INT
187 };
188 
189 static av_cold int amr_nb_encode_init(AVCodecContext *avctx)
190 {
191  AMRContext *s = avctx->priv_data;
192 
193  if (avctx->sample_rate != 8000 && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
194  av_log(avctx, AV_LOG_ERROR, "Only 8000Hz sample rate supported\n");
195  return AVERROR(ENOSYS);
196  }
197 
198  if (avctx->channels != 1) {
199  av_log(avctx, AV_LOG_ERROR, "Only mono supported\n");
200  return AVERROR(ENOSYS);
201  }
202 
203  avctx->frame_size = 160;
204  avctx->initial_padding = 50;
205  ff_af_queue_init(avctx, &s->afq);
206 
207  s->enc_state = Encoder_Interface_init(s->enc_dtx);
208  if (!s->enc_state) {
209  av_log(avctx, AV_LOG_ERROR, "Encoder_Interface_init error\n");
210  return -1;
211  }
212 
213  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
214  s->enc_bitrate = avctx->bit_rate;
215 
216  return 0;
217 }
218 
219 static av_cold int amr_nb_encode_close(AVCodecContext *avctx)
220 {
221  AMRContext *s = avctx->priv_data;
222 
223  Encoder_Interface_exit(s->enc_state);
224  ff_af_queue_close(&s->afq);
225  return 0;
226 }
227 
228 static int amr_nb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
229  const AVFrame *frame, int *got_packet_ptr)
230 {
231  AMRContext *s = avctx->priv_data;
232  int written, ret;
233  int16_t *flush_buf = NULL;
234  const int16_t *samples = frame ? (const int16_t *)frame->data[0] : NULL;
235 
236  if (s->enc_bitrate != avctx->bit_rate) {
237  s->enc_mode = get_bitrate_mode(avctx->bit_rate, avctx);
238  s->enc_bitrate = avctx->bit_rate;
239  }
240 
241  if ((ret = ff_alloc_packet2(avctx, avpkt, 32, 0)) < 0)
242  return ret;
243 
244  if (frame) {
245  if (frame->nb_samples < avctx->frame_size) {
246  flush_buf = av_mallocz_array(avctx->frame_size, sizeof(*flush_buf));
247  if (!flush_buf)
248  return AVERROR(ENOMEM);
249  memcpy(flush_buf, samples, frame->nb_samples * sizeof(*flush_buf));
250  samples = flush_buf;
251  if (frame->nb_samples < avctx->frame_size - avctx->initial_padding)
252  s->enc_last_frame = -1;
253  }
254  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0) {
255  av_freep(&flush_buf);
256  return ret;
257  }
258  } else {
259  if (s->enc_last_frame < 0)
260  return 0;
261  flush_buf = av_mallocz_array(avctx->frame_size, sizeof(*flush_buf));
262  if (!flush_buf)
263  return AVERROR(ENOMEM);
264  samples = flush_buf;
265  s->enc_last_frame = -1;
266  }
267 
268  written = Encoder_Interface_Encode(s->enc_state, s->enc_mode, samples,
269  avpkt->data, 0);
270  ff_dlog(avctx, "amr_nb_encode_frame encoded %u bytes, bitrate %u, first byte was %#02x\n",
271  written, s->enc_mode, avpkt->data[0]);
272 
273  /* Get the next frame pts/duration */
274  ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
275  &avpkt->duration);
276 
277  avpkt->size = written;
278  *got_packet_ptr = 1;
279  av_freep(&flush_buf);
280  return 0;
281 }
282 
283 AVCodec ff_libopencore_amrnb_encoder = {
284  .name = "libopencore_amrnb",
285  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
286  .type = AVMEDIA_TYPE_AUDIO,
287  .id = AV_CODEC_ID_AMR_NB,
288  .priv_data_size = sizeof(AMRContext),
289  .init = amr_nb_encode_init,
290  .encode2 = amr_nb_encode_frame,
291  .close = amr_nb_encode_close,
293  .sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
295  .priv_class = &amrnb_class,
296 };
297 #endif /* CONFIG_LIBOPENCORE_AMRNB_ENCODER */
298 
299 #endif /* CONFIG_LIBOPENCORE_AMRNB */
300 
301 /* -----------AMR wideband ------------*/
302 #if CONFIG_LIBOPENCORE_AMRWB_DECODER
303 
304 #include <opencore-amrwb/dec_if.h>
305 #include <opencore-amrwb/if_rom.h>
306 
307 typedef struct AMRWBContext {
308  void *state;
309 } AMRWBContext;
310 
311 static av_cold int amr_wb_decode_init(AVCodecContext *avctx)
312 {
313  AMRWBContext *s = avctx->priv_data;
314  int ret;
315 
316  if ((ret = amr_decode_fix_avctx(avctx)) < 0)
317  return ret;
318 
319  s->state = D_IF_init();
320 
321  return 0;
322 }
323 
324 static int amr_wb_decode_frame(AVCodecContext *avctx, void *data,
325  int *got_frame_ptr, AVPacket *avpkt)
326 {
327  AVFrame *frame = data;
328  const uint8_t *buf = avpkt->data;
329  int buf_size = avpkt->size;
330  AMRWBContext *s = avctx->priv_data;
331  int mode, ret;
332  int packet_size;
333  static const uint8_t block_size[16] = {18, 24, 33, 37, 41, 47, 51, 59, 61, 6, 6, 0, 0, 0, 1, 1};
334 
335  /* get output buffer */
336  frame->nb_samples = 320;
337  if ((ret = ff_get_buffer(avctx, frame, 0)) < 0)
338  return ret;
339 
340  mode = (buf[0] >> 3) & 0x000F;
341  packet_size = block_size[mode];
342 
343  if (packet_size > buf_size) {
344  av_log(avctx, AV_LOG_ERROR, "AMR frame too short (%d, should be %d)\n",
345  buf_size, packet_size + 1);
346  return AVERROR_INVALIDDATA;
347  }
348  if (!packet_size) {
349  av_log(avctx, AV_LOG_ERROR, "amr packet_size invalid\n");
350  return AVERROR_INVALIDDATA;
351  }
352 
353  D_IF_decode(s->state, buf, (short *)frame->data[0], _good_frame);
354 
355  *got_frame_ptr = 1;
356 
357  return packet_size;
358 }
359 
360 static int amr_wb_decode_close(AVCodecContext *avctx)
361 {
362  AMRWBContext *s = avctx->priv_data;
363 
364  D_IF_exit(s->state);
365  return 0;
366 }
367 
368 AVCodec ff_libopencore_amrwb_decoder = {
369  .name = "libopencore_amrwb",
370  .long_name = NULL_IF_CONFIG_SMALL("OpenCORE AMR-WB (Adaptive Multi-Rate Wide-Band)"),
371  .type = AVMEDIA_TYPE_AUDIO,
372  .id = AV_CODEC_ID_AMR_WB,
373  .priv_data_size = sizeof(AMRWBContext),
374  .init = amr_wb_decode_init,
375  .close = amr_wb_decode_close,
376  .decode = amr_wb_decode_frame,
377  .capabilities = AV_CODEC_CAP_DR1,
378 };
379 
380 #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
const char * s
Definition: avisynth_c.h:631
#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:184
AVOption.
Definition: opt.h:245
ptrdiff_t const GLvoid * data
Definition: opengl_enc.c:101
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:182
int64_t bit_rate
the average bitrate
Definition: avcodec.h:1722
#define LIBAVUTIL_VERSION_INT
Definition: version.h:70
static av_cold int init(AVCodecContext *avctx)
Definition: avrndec.c:35
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:280
int size
Definition: avcodec.h:1589
AVCodec.
Definition: avcodec.h:3559
#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:981
enum AVSampleFormat sample_fmt
audio sample format
Definition: avcodec.h:2426
uint8_t
#define av_cold
Definition: attributes.h:82
mode
Definition: f_perms.c:27
AVOptions.
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:1606
Mode
Frame type (Table 1a in 3GPP TS 26.101)
Definition: amrnbdata.h:39
static AVFrame * frame
uint8_t * data
Definition: avcodec.h:1588
#define ff_dlog(a,...)
const OptionDef options[]
Definition: ffserver.c:3969
#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:275
static const int rates[]
#define FF_COMPLIANCE_UNOFFICIAL
Allow unofficial extensions.
Definition: avcodec.h:2878
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:176
static int amr_decode_fix_avctx(AVCodecContext *avctx)
av_default_item_name
#define AVERROR(e)
Definition: error.h:43
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
Definition: internal.h:176
int initial_padding
Audio only.
Definition: avcodec.h:3346
const char * name
Name of the codec implementation.
Definition: avcodec.h:3566
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:2469
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:986
#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:2438
Libavcodec external API header.
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:58
enum AVCodecID codec_id
Definition: avcodec.h:1674
int sample_rate
samples per second
Definition: avcodec.h:2418
main external API structure.
Definition: avcodec.h:1657
int ff_get_buffer(AVCodecContext *avctx, AVFrame *frame, int flags)
Get a buffer for a frame.
Definition: utils.c:928
void * buf
Definition: avisynth_c.h:553
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
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1690
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:198
static int decode(AVCodecContext *avctx, void *data, int *got_sub, AVPacket *avpkt)
Definition: ccaption_dec.c:752
common internal api header.
common internal and external API header
if(ret< 0)
Definition: vf_mcdeint.c:282
signed 16 bits
Definition: samplefmt.h:61
void * priv_data
Definition: avcodec.h:1699
int channels
number of audio channels
Definition: avcodec.h:2419
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
static void * av_mallocz_array(size_t nmemb, size_t size)
Definition: mem.h:229
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:701
int frame_number
Frame counter, set by libavcodec.
Definition: avcodec.h:2449
#define av_freep(p)
#define AV_CH_LAYOUT_MONO
This structure stores compressed data.
Definition: avcodec.h:1565
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:241
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:2874
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() for allocating buffers and supports custom allocators.
Definition: avcodec.h:956
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1581