1 /*
2 * Opus encoder using libopus
3 * Copyright (c) 2012 Nathan Caldwell
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
23 #include <opus_multistream.h>
24
32
42
51
53 0, 1, 1, 2, 2, 2, 2, 3
54 };
55
56 /* Opus internal to Vorbis channel order mapping written in the header */
58 { 0 },
59 { 0, 1 },
60 { 0, 2, 1 },
61 { 0, 1, 2, 3 },
62 { 0, 4, 1, 2, 3 },
63 { 0, 4, 1, 2, 3, 5 },
64 { 0, 4, 1, 2, 3, 5, 6 },
65 { 0, 6, 1, 2, 3, 4, 5, 7 },
66 };
67
68 /* libavcodec to libopus channel order mapping, passed to libopus */
70 { 0 },
71 { 0, 1 },
72 { 0, 1, 2 },
73 { 0, 1, 2, 3 },
74 { 0, 1, 3, 4, 2 },
75 { 0, 1, 4, 5, 2, 3 },
76 { 0, 1, 5, 6, 2, 4, 3 },
77 { 0, 1, 6, 7, 4, 5, 2, 3 },
78 };
79
81 int coupled_stream_count,
83 {
86
88 bytestream_put_byte(&p, 1); /* Version */
89 bytestream_put_byte(&p, channels);
90 bytestream_put_le16(&p, avctx->
initial_padding);
/* Lookahead samples at 48kHz */
91 bytestream_put_le32(&p, avctx->
sample_rate);
/* Original sample rate */
92 bytestream_put_le16(&p, 0); /* Gain of 0dB is recommended. */
93
94 /* Channel mapping */
95 if (channels > 2) {
96 bytestream_put_byte(&p, channels <= 8 ? 1 : 255);
97 bytestream_put_byte(&p, stream_count);
98 bytestream_put_byte(&p, coupled_stream_count);
100 } else {
101 bytestream_put_byte(&p, 0);
102 }
103 }
104
107 {
108 int ret;
109
112 "Quality-based encoding not supported, "
113 "please specify a bitrate and VBR setting.\n");
115 }
116
117 ret = opus_multistream_encoder_ctl(enc, OPUS_SET_BITRATE(avctx->
bit_rate));
118 if (ret != OPUS_OK) {
120 "Failed to set bitrate: %s\n", opus_strerror(ret));
121 return ret;
122 }
123
124 ret = opus_multistream_encoder_ctl(enc,
126 if (ret != OPUS_OK)
128 "Unable to set complexity: %s\n", opus_strerror(ret));
129
130 ret = opus_multistream_encoder_ctl(enc, OPUS_SET_VBR(!!opts->
vbr));
131 if (ret != OPUS_OK)
133 "Unable to set VBR: %s\n", opus_strerror(ret));
134
135 ret = opus_multistream_encoder_ctl(enc,
136 OPUS_SET_VBR_CONSTRAINT(opts->
vbr == 2));
137 if (ret != OPUS_OK)
139 "Unable to set constrained VBR: %s\n", opus_strerror(ret));
140
141 ret = opus_multistream_encoder_ctl(enc,
143 if (ret != OPUS_OK)
145 "Unable to set expected packet loss percentage: %s\n",
146 opus_strerror(ret));
147
149 ret = opus_multistream_encoder_ctl(enc,
151 if (ret != OPUS_OK)
153 "Unable to set maximum bandwidth: %s\n", opus_strerror(ret));
154 }
155
156 return OPUS_OK;
157 }
158
160 {
162 const uint8_t *channel_mapping;
163 OpusMSEncoder *enc;
164 int ret = OPUS_OK;
165 int coupled_stream_count, header_size,
frame_size;
166
170
171 /* FIXME: Opus can handle up to 255 channels. However, the mapping for
172 * anything greater than 8 is undefined. */
175 "Channel layout undefined for %d channels.\n", avctx->
channels);
177 }
179 /* Sane default copied from opusenc */
181 32000 * coupled_stream_count;
183 "No bit rate set. Defaulting to %"PRId64
" bps.\n", (int64_t)avctx->
bit_rate);
184 }
185
188 "Please choose a value between 500 and %d.\n", (int64_t)avctx->
bit_rate,
191 }
192
194 switch (frame_size) {
195 case 120:
196 case 240:
199 "LPC mode cannot be used with a frame duration of less "
200 "than 10ms. Enabling restricted low-delay mode.\n"
201 "Use a longer frame duration if this is not what you want.\n");
202 /* Frame sizes less than 10 ms can only use MDCT mode, so switching to
203 * RESTRICTED_LOWDELAY avoids an unnecessary extra 2.5ms lookahead. */
205 case 480:
206 case 960:
207 case 1920:
208 case 2880:
211 break;
212 default:
214 "Frame duration must be exactly one of: 2.5, 5, 10, 20, 40 or 60.\n",
217 }
218
221 "Compression level must be in the range 0 to 10. "
222 "Defaulting to 10.\n");
224 } else {
226 }
227
230 case 4000:
232 break;
233 case 6000:
235 break;
236 case 8000:
238 break;
239 case 12000:
241 break;
242 case 20000:
244 break;
245 default:
247 "Invalid frequency cutoff: %d. Using default maximum bandwidth.\n"
248 "Cutoff frequency must be exactly one of: 4000, 6000, 8000, 12000 or 20000.\n",
251 }
252 }
253
256 coupled_stream_count,
257 channel_mapping,
259 if (ret != OPUS_OK) {
261 "Failed to create encoder: %s\n", opus_strerror(ret));
263 }
264
266 if (ret != OPUS_OK) {
269 }
270
277 }
279
286 }
287
288 ret = opus_multistream_encoder_ctl(enc, OPUS_GET_LOOKAHEAD(&avctx->
initial_padding));
289 if (ret != OPUS_OK)
291 "Unable to get number of lookahead samples: %s\n",
292 opus_strerror(ret));
293
296
298
300
301 return 0;
302
304 opus_multistream_encoder_destroy(enc);
306 return ret;
307 }
308
311 {
313 const int sample_size = avctx->
channels *
316 int ret;
317 int discard_padding;
318
319 if (frame) {
321 if (ret < 0)
322 return ret;
326 } else
327 audio = frame->
data[0];
328 } else {
330 return 0;
333 }
334
335 /* Maximum packet size taken from opusenc in opus-tools. 60ms packets
336 * consist of 3 frames in one packet. The maximum frame size is 1275
337 * bytes along with the largest possible packet header of 7 bytes. */
339 return ret;
340
342 ret = opus_multistream_encode_float(opus->
enc, (
float *)audio,
345 else
346 ret = opus_multistream_encode(opus->
enc, (opus_int16 *)audio,
349
350 if (ret < 0) {
352 "Error encoding frame: %s\n", opus_strerror(ret));
354 }
355
357
360
362 // Check if subtraction resulted in an overflow
363 if ((discard_padding < opus->
opts.packet_size) != (avpkt->
duration > 0)) {
367 }
368 if (discard_padding > 0) {
371 10);
372 if(!side_data) {
376 }
377 AV_WL32(side_data + 4, discard_padding);
378 }
379
380 *got_packet_ptr = 1;
381
382 return 0;
383 }
384
386 {
388
389 opus_multistream_encoder_destroy(opus->
enc);
390
392
395
396 return 0;
397 }
398
399 #define OFFSET(x) offsetof(LibopusEncContext, opts.x)
400 #define FLAGS AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
402 {
"application",
"Intended application type",
OFFSET(application),
AV_OPT_TYPE_INT, { .i64 = OPUS_APPLICATION_AUDIO }, OPUS_APPLICATION_VOIP, OPUS_APPLICATION_RESTRICTED_LOWDELAY,
FLAGS,
"application" },
403 {
"voip",
"Favor improved speech intelligibility", 0,
AV_OPT_TYPE_CONST, { .i64 = OPUS_APPLICATION_VOIP }, 0, 0,
FLAGS,
"application" },
404 {
"audio",
"Favor faithfulness to the input", 0,
AV_OPT_TYPE_CONST, { .i64 = OPUS_APPLICATION_AUDIO }, 0, 0,
FLAGS,
"application" },
405 {
"lowdelay",
"Restrict to only the lowest delay modes", 0,
AV_OPT_TYPE_CONST, { .i64 = OPUS_APPLICATION_RESTRICTED_LOWDELAY }, 0, 0,
FLAGS,
"application" },
406 {
"frame_duration",
"Duration of a frame in milliseconds",
OFFSET(frame_duration),
AV_OPT_TYPE_FLOAT, { .dbl = 20.0 }, 2.5, 60.0,
FLAGS },
413 };
414
420 };
421
423 { "b", "0" },
424 { "compression_level", "10" },
426 };
427
429 48000, 24000, 16000, 12000, 8000, 0,
430 };
431
449 };
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int64_t *duration)
Remove frame(s) from the queue.
This structure describes decoded (raw) audio or video data.
static int libopus_configure_encoder(AVCodecContext *avctx, OpusMSEncoder *enc, LibopusEncOpts *opts)
#define AV_LOG_WARNING
Something somehow does not look correct.
int64_t bit_rate
the average bitrate
#define LIBAVUTIL_VERSION_INT
void av_shrink_packet(AVPacket *pkt, int size)
Reduce packet size, correctly zeroing padding.
static av_cold int init(AVCodecContext *avctx)
const char * class_name
The name of the class; usually it is the same name as the context structure type to which the AVClass...
#define AV_CODEC_CAP_DELAY
Encoder or decoder requires flushing with NULL input at the end in order to give the complete and cor...
int ff_opus_error_to_averror(int err)
enum AVSampleFormat sample_fmt
audio sample format
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.
static const AVClass libopus_class
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
#define NULL_IF_CONFIG_SMALL(x)
Return NULL if CONFIG_SMALL is true, otherwise the argument without modification. ...
static const uint8_t libavcodec_libopus_channel_map[8][8]
int initial_padding
Audio only.
const char * name
Name of the codec implementation.
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
static const uint8_t opus_coupled_streams[8]
#define AV_CODEC_CAP_SMALL_LAST_FRAME
Codec can be fed a final frame with a smaller size.
static const int libopus_sample_rates[]
#define AVERROR_PATCHWELCOME
Not yet implemented in FFmpeg, patches welcome.
int frame_size
Number of samples per channel in an audio frame.
static av_cold int libopus_encode_init(AVCodecContext *avctx)
Libavcodec external API header.
AVSampleFormat
Audio sample formats.
int sample_rate
samples per second
main external API structure.
static int libopus_encode(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
void av_packet_unref(AVPacket *pkt)
Wipe the packet.
const uint64_t ff_vorbis_channel_layouts[9]
AVCodec ff_libopus_encoder
Describe the class of an AVClass context structure.
Recommmends skipping the specified number of samples.
static av_cold int libopus_encode_close(AVCodecContext *avctx)
int ff_alloc_packet2(AVCodecContext *avctx, AVPacket *avpkt, int64_t size, int64_t min_size)
Check AVPacket size and/or allocate data.
int global_quality
Global quality for codecs which cannot change it per frame.
uint8_t * data[AV_NUM_DATA_POINTERS]
pointer to the picture/channel planes.
int av_get_bytes_per_sample(enum AVSampleFormat sample_fmt)
Return number of bytes per sample.
static const uint8_t opus_vorbis_channel_map[8][8]
common internal api header.
static const AVCodecDefault libopus_defaults[]
static av_always_inline void bytestream_put_buffer(uint8_t **b, const uint8_t *src, unsigned int size)
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
int cutoff
Audio cutoff bandwidth (0 means "automatic")
int channels
number of audio channels
static const AVOption libopus_options[]
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
static void * av_mallocz_array(size_t nmemb, size_t size)
static enum AVSampleFormat sample_fmts[]
uint8_t * av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type, int size)
Allocate new information of a packet.
This structure stores compressed data.
int nb_samples
number of audio samples (per channel) described by this frame
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
static void libopus_write_header(AVCodecContext *avctx, int stream_count, int coupled_stream_count, const uint8_t *channel_mapping)