FFmpeg
libvo-amrwbenc.c
Go to the documentation of this file.
1 /*
2  * AMR Audio encoder 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 <vo-amrwbenc/enc_if.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 
26 #include "libavutil/avstring.h"
27 #include "libavutil/internal.h"
28 #include "libavutil/opt.h"
29 #include "avcodec.h"
30 #include "codec_internal.h"
31 #include "encode.h"
32 
33 #define MAX_PACKET_SIZE (1 + (477 + 7) / 8)
34 
35 typedef struct AMRWBContext {
37  void *state;
38  int mode;
40  int allow_dtx;
41 } AMRWBContext;
42 
43 static const AVOption options[] = {
44  { "dtx", "Allow DTX (generate comfort noise)", offsetof(AMRWBContext, allow_dtx), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, 1, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
45  { NULL }
46 };
47 
48 static const AVClass amrwb_class = {
49  .class_name = "libvo_amrwbenc",
50  .item_name = av_default_item_name,
51  .option = options,
52  .version = LIBAVUTIL_VERSION_INT,
53 };
54 
55 static int get_wb_bitrate_mode(int bitrate, void *log_ctx)
56 {
57  /* make the correspondence between bitrate and mode */
58  static const int rates[] = { 6600, 8850, 12650, 14250, 15850, 18250,
59  19850, 23050, 23850 };
60  int i, best = -1, min_diff = 0;
61  char log_buf[200];
62 
63  for (i = 0; i < 9; i++) {
64  if (rates[i] == bitrate)
65  return i;
66  if (best < 0 || abs(rates[i] - bitrate) < min_diff) {
67  best = i;
68  min_diff = abs(rates[i] - bitrate);
69  }
70  }
71  /* no bitrate matching exactly, log a warning */
72  snprintf(log_buf, sizeof(log_buf), "bitrate not supported: use one of ");
73  for (i = 0; i < 9; i++)
74  av_strlcatf(log_buf, sizeof(log_buf), "%.2fk, ", rates[i] / 1000.f);
75  av_strlcatf(log_buf, sizeof(log_buf), "using %.2fk", rates[best] / 1000.f);
76  av_log(log_ctx, AV_LOG_WARNING, "%s\n", log_buf);
77 
78  return best;
79 }
80 
82 {
83  AMRWBContext *s = avctx->priv_data;
84 
85  if (avctx->sample_rate != 16000 && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
86  av_log(avctx, AV_LOG_ERROR, "Only 16000Hz sample rate supported\n");
87  return AVERROR(ENOSYS);
88  }
89 
90  if (avctx->ch_layout.nb_channels != 1) {
91  av_log(avctx, AV_LOG_ERROR, "Only mono supported\n");
92  return AVERROR(ENOSYS);
93  }
94 
95  s->mode = get_wb_bitrate_mode(avctx->bit_rate, avctx);
96  s->last_bitrate = avctx->bit_rate;
97 
98  avctx->frame_size = 320;
99  avctx->initial_padding = 80;
100 
101  s->state = E_IF_init();
102 
103  return 0;
104 }
105 
107 {
108  AMRWBContext *s = avctx->priv_data;
109 
110  E_IF_exit(s->state);
111  return 0;
112 }
113 
114 static int amr_wb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
115  const AVFrame *frame, int *got_packet_ptr)
116 {
117  AMRWBContext *s = avctx->priv_data;
118  const int16_t *samples = (const int16_t *)frame->data[0];
119  int size, ret;
120 
121  if ((ret = ff_alloc_packet(avctx, avpkt, MAX_PACKET_SIZE)) < 0)
122  return ret;
123 
124  if (s->last_bitrate != avctx->bit_rate) {
125  s->mode = get_wb_bitrate_mode(avctx->bit_rate, avctx);
126  s->last_bitrate = avctx->bit_rate;
127  }
128  size = E_IF_encode(s->state, s->mode, samples, avpkt->data, s->allow_dtx);
129  if (size <= 0 || size > MAX_PACKET_SIZE) {
130  av_log(avctx, AV_LOG_ERROR, "Error encoding frame\n");
131  return AVERROR(EINVAL);
132  }
133 
134  if (frame->pts != AV_NOPTS_VALUE)
135  avpkt->pts = frame->pts - ff_samples_to_time_base(avctx, avctx->initial_padding);
136 
137  avpkt->size = size;
138  *got_packet_ptr = 1;
139  return 0;
140 }
141 
143  .p.name = "libvo_amrwbenc",
144  CODEC_LONG_NAME("Android VisualOn AMR-WB (Adaptive Multi-Rate Wide-Band)"),
145  .p.type = AVMEDIA_TYPE_AUDIO,
146  .p.id = AV_CODEC_ID_AMR_WB,
147  .p.capabilities = AV_CODEC_CAP_DR1 |
149  .p.priv_class = &amrwb_class,
150  .p.wrapper_name = "libvo_amrwbenc",
151  .caps_internal = FF_CODEC_CAP_NOT_INIT_THREADSAFE,
152  .priv_data_size = sizeof(AMRWBContext),
155  .close = amr_wb_encode_close,
156  .p.sample_fmts = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
158 };
AVCodecContext::frame_size
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:1083
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:215
AVERROR
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
opt.h
amr_wb_encode_init
static av_cold int amr_wb_encode_init(AVCodecContext *avctx)
Definition: libvo-amrwbenc.c:81
AVCodecContext::sample_rate
int sample_rate
samples per second
Definition: avcodec.h:1056
AVFrame
This structure describes decoded (raw) audio or video data.
Definition: frame.h:389
AVPacket::data
uint8_t * data
Definition: packet.h:539
AVOption
AVOption.
Definition: opt.h:429
encode.h
FF_CODEC_CAP_NOT_INIT_THREADSAFE
#define FF_CODEC_CAP_NOT_INIT_THREADSAFE
The codec is not known to be init-threadsafe (i.e.
Definition: codec_internal.h:35
FFCodec
Definition: codec_internal.h:127
AMRWBContext::mode
int mode
Definition: libvo-amrwbenc.c:38
AVChannelLayout::nb_channels
int nb_channels
Number of channels in this layout.
Definition: channel_layout.h:321
av_strlcatf
size_t av_strlcatf(char *dst, size_t size, const char *fmt,...)
Definition: avstring.c:103
AV_CODEC_ID_AMR_WB
@ AV_CODEC_ID_AMR_WB
Definition: codec_id.h:422
get_wb_bitrate_mode
static int get_wb_bitrate_mode(int bitrate, void *log_ctx)
Definition: libvo-amrwbenc.c:55
FFCodec::p
AVCodec p
The public AVCodec.
Definition: codec_internal.h:131
AVCodecContext::ch_layout
AVChannelLayout ch_layout
Audio channel layout.
Definition: avcodec.h:1071
AVCodecContext::initial_padding
int initial_padding
Audio only.
Definition: avcodec.h:1128
FF_CODEC_ENCODE_CB
#define FF_CODEC_ENCODE_CB(func)
Definition: codec_internal.h:320
AV_OPT_FLAG_AUDIO_PARAM
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:357
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:209
av_cold
#define av_cold
Definition: attributes.h:90
s
#define s(width, name)
Definition: cbs_vp9.c:198
bitrate
int64_t bitrate
Definition: av1_levels.c:47
amr_wb_encode_close
static int amr_wb_encode_close(AVCodecContext *avctx)
Definition: libvo-amrwbenc.c:106
AVMEDIA_TYPE_AUDIO
@ AVMEDIA_TYPE_AUDIO
Definition: avutil.h:202
AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
#define AV_CODEC_CAP_ENCODER_REORDERED_OPAQUE
This encoder can reorder user opaque values from input AVFrames and return them with corresponding ou...
Definition: codec.h:159
AMRWBContext::state
void * state
Definition: libvo-amrwbenc.c:37
AMRWBContext::av_class
AVClass * av_class
Definition: libvo-amrwbenc.c:36
CODEC_LONG_NAME
#define CODEC_LONG_NAME(str)
Definition: codec_internal.h:296
if
if(ret)
Definition: filter_design.txt:179
LIBAVUTIL_VERSION_INT
#define LIBAVUTIL_VERSION_INT
Definition: version.h:85
AVClass
Describe the class of an AVClass context structure.
Definition: log.h:75
NULL
#define NULL
Definition: coverity.c:32
amrwb_class
static const AVClass amrwb_class
Definition: libvo-amrwbenc.c:48
ff_samples_to_time_base
static av_always_inline int64_t ff_samples_to_time_base(const AVCodecContext *avctx, int64_t samples)
Rescale from sample rate to AVCodecContext.time_base.
Definition: encode.h:90
AVCodecContext::bit_rate
int64_t bit_rate
the average bitrate
Definition: avcodec.h:501
av_default_item_name
const char * av_default_item_name(void *ptr)
Return the context name.
Definition: log.c:237
abs
#define abs(x)
Definition: cuda_runtime.h:35
AMRWBContext::allow_dtx
int allow_dtx
Definition: libvo-amrwbenc.c:40
AV_OPT_FLAG_ENCODING_PARAM
#define AV_OPT_FLAG_ENCODING_PARAM
A generic parameter which can be set by the user for muxing or encoding.
Definition: opt.h:352
f
f
Definition: af_crystalizer.c:122
init
int(* init)(AVBSFContext *ctx)
Definition: dts2pts.c:368
AV_CODEC_CAP_DR1
#define AV_CODEC_CAP_DR1
Codec uses get_buffer() or get_encode_buffer() for allocating buffers and supports custom allocators.
Definition: codec.h:52
AVPacket::size
int size
Definition: packet.h:540
codec_internal.h
AV_SAMPLE_FMT_NONE
@ AV_SAMPLE_FMT_NONE
Definition: samplefmt.h:56
size
int size
Definition: twinvq_data.h:10344
AV_NOPTS_VALUE
#define AV_NOPTS_VALUE
Undefined timestamp value.
Definition: avutil.h:248
MAX_PACKET_SIZE
#define MAX_PACKET_SIZE
Definition: libvo-amrwbenc.c:33
FF_COMPLIANCE_UNOFFICIAL
#define FF_COMPLIANCE_UNOFFICIAL
Allow unofficial extensions.
Definition: defs.h:61
ff_libvo_amrwbenc_encoder
const FFCodec ff_libvo_amrwbenc_encoder
Definition: libvo-amrwbenc.c:142
i
#define i(width, name, range_min, range_max)
Definition: cbs_h2645.c:256
AVPacket::pts
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: packet.h:532
internal.h
AVSampleFormat
AVSampleFormat
Audio sample formats.
Definition: samplefmt.h:55
AV_SAMPLE_FMT_S16
@ AV_SAMPLE_FMT_S16
signed 16 bits
Definition: samplefmt.h:58
AVCodec::name
const char * name
Name of the codec implementation.
Definition: codec.h:194
avcodec.h
ret
ret
Definition: filter_design.txt:187
AVClass::class_name
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:80
frame
these buffered frames must be flushed immediately if a new input produces new the filter must not call request_frame to get more It must just process the frame or queue it The task of requesting more frames is left to the filter s request_frame method or the application If a filter has several the filter must be ready for frames arriving randomly on any input any filter with several inputs will most likely require some kind of queuing mechanism It is perfectly acceptable to have a limited queue and to drop frames when the inputs are too unbalanced request_frame For filters that do not use the this method is called when a frame is wanted on an output For a it should directly call filter_frame on the corresponding output For a if there are queued frames already one of these frames should be pushed If the filter should request a frame on one of its repeatedly until at least one frame has been pushed Return or at least make progress towards producing a frame
Definition: filter_design.txt:264
AVCodecContext::strict_std_compliance
int strict_std_compliance
strictly follow the standard (MPEG-4, ...).
Definition: avcodec.h:1389
AVCodecContext
main external API structure.
Definition: avcodec.h:451
AMRWBContext
Definition: amrwbdec.c:52
rates
static const int rates[]
Definition: swresample.c:103
AV_OPT_TYPE_INT
@ AV_OPT_TYPE_INT
Underlying C type is int.
Definition: opt.h:259
AMRWBContext::last_bitrate
int last_bitrate
Definition: libvo-amrwbenc.c:39
amr_wb_encode_frame
static int amr_wb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libvo-amrwbenc.c:114
samples
Filter the word “frame” indicates either a video frame or a group of audio samples
Definition: filter_design.txt:8
options
static const AVOption options[]
Definition: libvo-amrwbenc.c:43
AVPacket
This structure stores compressed data.
Definition: packet.h:516
AVCodecContext::priv_data
void * priv_data
Definition: avcodec.h:478
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
avstring.h
snprintf
#define snprintf
Definition: snprintf.h:34
ff_alloc_packet
int ff_alloc_packet(AVCodecContext *avctx, AVPacket *avpkt, int64_t size)
Check AVPacket size and allocate data.
Definition: encode.c:62