doc/filters: itemize unsharp examples
[ffmpeg.git] / libavcodec / libopencore-amr.c
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"
23 #include "libavutil/channel_layout.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
30 static int amr_decode_fix_avctx(AVCodecContext *avctx)
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         av_log_missing_feature(avctx, "multi-channel AMR", 0);
39         return AVERROR_PATCHWELCOME;
40     }
41
42     avctx->channels       = 1;
43     avctx->channel_layout = AV_CH_LAYOUT_MONO;
44     avctx->sample_fmt     = AV_SAMPLE_FMT_S16;
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 /* Common code for fixed and float version*/
54 typedef struct AMR_bitrates {
55     int       rate;
56     enum Mode mode;
57 } AMR_bitrates;
58
59 /* Match desired bitrate */
60 static int get_bitrate_mode(int bitrate, void *log_ctx)
61 {
62     /* make the correspondance between bitrate and mode */
63     static const AMR_bitrates rates[] = {
64         { 4750, MR475 }, { 5150, MR515 }, {  5900, MR59  }, {  6700, MR67  },
65         { 7400, MR74 },  { 7950, MR795 }, { 10200, MR102 }, { 12200, MR122 }
66     };
67     int i, best = -1, min_diff = 0;
68     char log_buf[200];
69
70     for (i = 0; i < 8; i++) {
71         if (rates[i].rate == bitrate)
72             return rates[i].mode;
73         if (best < 0 || abs(rates[i].rate - bitrate) < min_diff) {
74             best     = i;
75             min_diff = abs(rates[i].rate - bitrate);
76         }
77     }
78     /* no bitrate matching exactly, log a warning */
79     snprintf(log_buf, sizeof(log_buf), "bitrate not supported: use one of ");
80     for (i = 0; i < 8; i++)
81         av_strlcatf(log_buf, sizeof(log_buf), "%.2fk, ", rates[i].rate    / 1000.f);
82     av_strlcatf(log_buf, sizeof(log_buf), "using %.2fk", rates[best].rate / 1000.f);
83     av_log(log_ctx, AV_LOG_WARNING, "%s\n", log_buf);
84
85     return best;
86 }
87
88 typedef struct AMRContext {
89     AVClass *av_class;
90     void *dec_state;
91     void *enc_state;
92     int   enc_bitrate;
93     int   enc_mode;
94     int   enc_dtx;
95     int   enc_last_frame;
96     AudioFrameQueue afq;
97 } AMRContext;
98
99 static const AVOption options[] = {
100     { "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 },
101     { NULL }
102 };
103
104 static const AVClass class = {
105     "libopencore_amrnb", av_default_item_name, options, LIBAVUTIL_VERSION_INT
106 };
107
108 static av_cold int amr_nb_decode_init(AVCodecContext *avctx)
109 {
110     AMRContext *s  = avctx->priv_data;
111     int ret;
112
113     if ((ret = amr_decode_fix_avctx(avctx)) < 0)
114         return ret;
115
116     s->dec_state   = Decoder_Interface_init();
117     if (!s->dec_state) {
118         av_log(avctx, AV_LOG_ERROR, "Decoder_Interface_init error\n");
119         return -1;
120     }
121
122     return 0;
123 }
124
125 static av_cold int amr_nb_decode_close(AVCodecContext *avctx)
126 {
127     AMRContext *s = avctx->priv_data;
128
129     Decoder_Interface_exit(s->dec_state);
130
131     return 0;
132 }
133
134 static int amr_nb_decode_frame(AVCodecContext *avctx, void *data,
135                                int *got_frame_ptr, AVPacket *avpkt)
136 {
137     AVFrame *frame     = data;
138     const uint8_t *buf = avpkt->data;
139     int buf_size       = avpkt->size;
140     AMRContext *s      = avctx->priv_data;
141     static const uint8_t block_size[16] = { 12, 13, 15, 17, 19, 20, 26, 31, 5, 0, 0, 0, 0, 0, 0, 0 };
142     enum Mode dec_mode;
143     int packet_size, ret;
144
145     av_dlog(avctx, "amr_decode_frame buf=%p buf_size=%d frame_count=%d!!\n",
146             buf, buf_size, avctx->frame_number);
147
148     /* get output buffer */
149     frame->nb_samples = 160;
150     if ((ret = ff_get_buffer(avctx, frame)) < 0) {
151         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
152         return ret;
153     }
154
155     dec_mode    = (buf[0] >> 3) & 0x000F;
156     packet_size = block_size[dec_mode] + 1;
157
158     if (packet_size > buf_size) {
159         av_log(avctx, AV_LOG_ERROR, "amr frame too short (%u, should be %u)\n",
160                buf_size, packet_size);
161         return AVERROR_INVALIDDATA;
162     }
163
164     av_dlog(avctx, "packet_size=%d buf= 0x%X %X %X %X\n",
165               packet_size, buf[0], buf[1], buf[2], buf[3]);
166     /* call decoder */
167     Decoder_Interface_Decode(s->dec_state, buf, (short *)frame->data[0], 0);
168
169     *got_frame_ptr = 1;
170
171     return packet_size;
172 }
173
174 AVCodec ff_libopencore_amrnb_decoder = {
175     .name           = "libopencore_amrnb",
176     .type           = AVMEDIA_TYPE_AUDIO,
177     .id             = AV_CODEC_ID_AMR_NB,
178     .priv_data_size = sizeof(AMRContext),
179     .init           = amr_nb_decode_init,
180     .close          = amr_nb_decode_close,
181     .decode         = amr_nb_decode_frame,
182     .capabilities   = CODEC_CAP_DR1,
183     .long_name      = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
184 };
185
186 static av_cold int amr_nb_encode_init(AVCodecContext *avctx)
187 {
188     AMRContext *s = avctx->priv_data;
189
190     if (avctx->sample_rate != 8000 && avctx->strict_std_compliance > FF_COMPLIANCE_UNOFFICIAL) {
191         av_log(avctx, AV_LOG_ERROR, "Only 8000Hz sample rate supported\n");
192         return AVERROR(ENOSYS);
193     }
194
195     if (avctx->channels != 1) {
196         av_log(avctx, AV_LOG_ERROR, "Only mono supported\n");
197         return AVERROR(ENOSYS);
198     }
199
200     avctx->frame_size  = 160;
201     avctx->delay       =  50;
202     ff_af_queue_init(avctx, &s->afq);
203 #if FF_API_OLD_ENCODE_AUDIO
204     avctx->coded_frame = avcodec_alloc_frame();
205     if (!avctx->coded_frame)
206         return AVERROR(ENOMEM);
207 #endif
208
209     s->enc_state = Encoder_Interface_init(s->enc_dtx);
210     if (!s->enc_state) {
211         av_log(avctx, AV_LOG_ERROR, "Encoder_Interface_init error\n");
212         av_freep(&avctx->coded_frame);
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 #if FF_API_OLD_ENCODE_AUDIO
229     av_freep(&avctx->coded_frame);
230 #endif
231     return 0;
232 }
233
234 static int amr_nb_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
235                                const AVFrame *frame, int *got_packet_ptr)
236 {
237     AMRContext *s = avctx->priv_data;
238     int written, ret;
239     int16_t *flush_buf = NULL;
240     const int16_t *samples = frame ? (const int16_t *)frame->data[0] : NULL;
241
242     if (s->enc_bitrate != avctx->bit_rate) {
243         s->enc_mode    = get_bitrate_mode(avctx->bit_rate, avctx);
244         s->enc_bitrate = avctx->bit_rate;
245     }
246
247     if ((ret = ff_alloc_packet2(avctx, avpkt, 32)))
248         return ret;
249
250     if (frame) {
251         if (frame->nb_samples < avctx->frame_size) {
252             flush_buf = av_mallocz(avctx->frame_size * sizeof(*flush_buf));
253             if (!flush_buf)
254                 return AVERROR(ENOMEM);
255             memcpy(flush_buf, samples, frame->nb_samples * sizeof(*flush_buf));
256             samples = flush_buf;
257             if (frame->nb_samples < avctx->frame_size - avctx->delay)
258                 s->enc_last_frame = -1;
259         }
260         if ((ret = ff_af_queue_add(&s->afq, frame)) < 0) {
261             av_freep(&flush_buf);
262             return ret;
263         }
264     } else {
265         if (s->enc_last_frame < 0)
266             return 0;
267         flush_buf = av_mallocz(avctx->frame_size * sizeof(*flush_buf));
268         if (!flush_buf)
269             return AVERROR(ENOMEM);
270         samples = flush_buf;
271         s->enc_last_frame = -1;
272     }
273
274     written = Encoder_Interface_Encode(s->enc_state, s->enc_mode, samples,
275                                        avpkt->data, 0);
276     av_dlog(avctx, "amr_nb_encode_frame encoded %u bytes, bitrate %u, first byte was %#02x\n",
277             written, s->enc_mode, avpkt->data[0]);
278
279     /* Get the next frame pts/duration */
280     ff_af_queue_remove(&s->afq, avctx->frame_size, &avpkt->pts,
281                        &avpkt->duration);
282
283     avpkt->size = written;
284     *got_packet_ptr = 1;
285     av_freep(&flush_buf);
286     return 0;
287 }
288
289 AVCodec ff_libopencore_amrnb_encoder = {
290     .name           = "libopencore_amrnb",
291     .type           = AVMEDIA_TYPE_AUDIO,
292     .id             = AV_CODEC_ID_AMR_NB,
293     .priv_data_size = sizeof(AMRContext),
294     .init           = amr_nb_encode_init,
295     .encode2        = amr_nb_encode_frame,
296     .close          = amr_nb_encode_close,
297     .capabilities   = CODEC_CAP_DELAY | CODEC_CAP_SMALL_LAST_FRAME,
298     .sample_fmts    = (const enum AVSampleFormat[]){ AV_SAMPLE_FMT_S16,
299                                                      AV_SAMPLE_FMT_NONE },
300     .long_name      = NULL_IF_CONFIG_SMALL("OpenCORE AMR-NB (Adaptive Multi-Rate Narrow-Band)"),
301     .priv_class     = &class,
302 };
303
304 #endif
305
306 /* -----------AMR wideband ------------*/
307 #if CONFIG_LIBOPENCORE_AMRWB
308
309 #include <opencore-amrwb/dec_if.h>
310 #include <opencore-amrwb/if_rom.h>
311
312 typedef struct AMRWBContext {
313     void  *state;
314 } AMRWBContext;
315
316 static av_cold int amr_wb_decode_init(AVCodecContext *avctx)
317 {
318     AMRWBContext *s = avctx->priv_data;
319     int ret;
320
321     if ((ret = amr_decode_fix_avctx(avctx)) < 0)
322         return ret;
323
324     s->state        = D_IF_init();
325
326     return 0;
327 }
328
329 static int amr_wb_decode_frame(AVCodecContext *avctx, void *data,
330                                int *got_frame_ptr, AVPacket *avpkt)
331 {
332     AVFrame *frame     = data;
333     const uint8_t *buf = avpkt->data;
334     int buf_size       = avpkt->size;
335     AMRWBContext *s    = avctx->priv_data;
336     int mode, ret;
337     int packet_size;
338     static const uint8_t block_size[16] = {18, 24, 33, 37, 41, 47, 51, 59, 61, 6, 6, 0, 0, 0, 1, 1};
339
340     /* get output buffer */
341     frame->nb_samples = 320;
342     if ((ret = ff_get_buffer(avctx, frame)) < 0) {
343         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
344         return ret;
345     }
346
347     mode        = (buf[0] >> 3) & 0x000F;
348     packet_size = block_size[mode];
349
350     if (packet_size > buf_size) {
351         av_log(avctx, AV_LOG_ERROR, "amr frame too short (%u, should be %u)\n",
352                buf_size, packet_size + 1);
353         return AVERROR_INVALIDDATA;
354     }
355     if (!packet_size) {
356         av_log(avctx, AV_LOG_ERROR, "amr packet_size invalid\n");
357         return AVERROR_INVALIDDATA;
358     }
359
360     D_IF_decode(s->state, buf, (short *)frame->data[0], _good_frame);
361
362     *got_frame_ptr = 1;
363
364     return packet_size;
365 }
366
367 static int amr_wb_decode_close(AVCodecContext *avctx)
368 {
369     AMRWBContext *s = avctx->priv_data;
370
371     D_IF_exit(s->state);
372     return 0;
373 }
374
375 AVCodec ff_libopencore_amrwb_decoder = {
376     .name           = "libopencore_amrwb",
377     .type           = AVMEDIA_TYPE_AUDIO,
378     .id             = AV_CODEC_ID_AMR_WB,
379     .priv_data_size = sizeof(AMRWBContext),
380     .init           = amr_wb_decode_init,
381     .close          = amr_wb_decode_close,
382     .decode         = amr_wb_decode_frame,
383     .capabilities   = CODEC_CAP_DR1,
384     .long_name      = NULL_IF_CONFIG_SMALL("OpenCORE AMR-WB (Adaptive Multi-Rate Wide-Band)"),
385 };
386
387 #endif /* CONFIG_LIBOPENCORE_AMRWB */