Libav
libvorbis.c
Go to the documentation of this file.
1 /*
2  * copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
3  *
4  * This file is part of Libav.
5  *
6  * Libav is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * Libav is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with Libav; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20 
27 #include <vorbis/vorbisenc.h>
28 
29 #include "libavutil/fifo.h"
30 #include "libavutil/opt.h"
31 #include "avcodec.h"
32 #include "audio_frame_queue.h"
33 #include "bytestream.h"
34 #include "internal.h"
35 #include "vorbis.h"
36 #include "vorbis_parser.h"
37 
38 #undef NDEBUG
39 #include <assert.h>
40 
41 /* Number of samples the user should send in each call.
42  * This value is used because it is the LCD of all possible frame sizes, so
43  * an output packet will always start at the same point as one of the input
44  * packets.
45  */
46 #define LIBVORBIS_FRAME_SIZE 64
47 
48 #define BUFFER_SIZE (1024 * 64)
49 
50 typedef struct LibvorbisContext {
52  vorbis_info vi;
53  vorbis_dsp_state vd;
54  vorbis_block vb;
56  int eof;
58  vorbis_comment vc;
60  double iblock;
64 
65 static const AVOption options[] = {
66  { "iblock", "Sets the impulse block bias", offsetof(LibvorbisContext, iblock), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -15, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
67  { NULL }
68 };
69 
70 static const AVCodecDefault defaults[] = {
71  { "b", "0" },
72  { NULL },
73 };
74 
75 static const AVClass class = { "libvorbis", av_default_item_name, options, LIBAVUTIL_VERSION_INT };
76 
77 
78 static int vorbis_error_to_averror(int ov_err)
79 {
80  switch (ov_err) {
81  case OV_EFAULT: return AVERROR_BUG;
82  case OV_EINVAL: return AVERROR(EINVAL);
83  case OV_EIMPL: return AVERROR(EINVAL);
84  default: return AVERROR_UNKNOWN;
85  }
86 }
87 
88 static av_cold int libvorbis_setup(vorbis_info *vi, AVCodecContext *avctx)
89 {
90  LibvorbisContext *s = avctx->priv_data;
91  double cfreq;
92  int ret;
93 
94  if (avctx->flags & AV_CODEC_FLAG_QSCALE || !avctx->bit_rate) {
95  /* variable bitrate
96  * NOTE: we use the oggenc range of -1 to 10 for global_quality for
97  * user convenience, but libvorbis uses -0.1 to 1.0.
98  */
99  float q = avctx->global_quality / (float)FF_QP2LAMBDA;
100  /* default to 3 if the user did not set quality or bitrate */
101  if (!(avctx->flags & AV_CODEC_FLAG_QSCALE))
102  q = 3.0;
103  if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
104  avctx->sample_rate,
105  q / 10.0)))
106  goto error;
107  } else {
108  int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
109  int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
110 
111  /* average bitrate */
112  if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
113  avctx->sample_rate, maxrate,
114  avctx->bit_rate, minrate)))
115  goto error;
116 
117  /* variable bitrate by estimate, disable slow rate management */
118  if (minrate == -1 && maxrate == -1)
119  if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
120  goto error;
121  }
122 
123  /* cutoff frequency */
124  if (avctx->cutoff > 0) {
125  cfreq = avctx->cutoff / 1000.0;
126  if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
127  goto error;
128  }
129 
130  /* impulse block bias */
131  if (s->iblock) {
132  if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
133  goto error;
134  }
135 
136  if ((ret = vorbis_encode_setup_init(vi)))
137  goto error;
138 
139  return 0;
140 error:
141  return vorbis_error_to_averror(ret);
142 }
143 
144 /* How many bytes are needed for a buffer of length 'l' */
145 static int xiph_len(int l)
146 {
147  return 1 + l / 255 + l;
148 }
149 
151 {
152  LibvorbisContext *s = avctx->priv_data;
153 
154  /* notify vorbisenc this is EOF */
155  if (s->dsp_initialized)
156  vorbis_analysis_wrote(&s->vd, 0);
157 
158  vorbis_block_clear(&s->vb);
159  vorbis_dsp_clear(&s->vd);
160  vorbis_info_clear(&s->vi);
161 
163  ff_af_queue_close(&s->afq);
164  av_freep(&avctx->extradata);
165 
167 
168  return 0;
169 }
170 
172 {
173  LibvorbisContext *s = avctx->priv_data;
174  ogg_packet header, header_comm, header_code;
175  uint8_t *p;
176  unsigned int offset;
177  int ret;
178 
179  vorbis_info_init(&s->vi);
180  if ((ret = libvorbis_setup(&s->vi, avctx))) {
181  av_log(avctx, AV_LOG_ERROR, "encoder setup failed\n");
182  goto error;
183  }
184  if ((ret = vorbis_analysis_init(&s->vd, &s->vi))) {
185  av_log(avctx, AV_LOG_ERROR, "analysis init failed\n");
186  ret = vorbis_error_to_averror(ret);
187  goto error;
188  }
189  s->dsp_initialized = 1;
190  if ((ret = vorbis_block_init(&s->vd, &s->vb))) {
191  av_log(avctx, AV_LOG_ERROR, "dsp init failed\n");
192  ret = vorbis_error_to_averror(ret);
193  goto error;
194  }
195 
196  vorbis_comment_init(&s->vc);
197  vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
198 
199  if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
200  &header_code))) {
201  ret = vorbis_error_to_averror(ret);
202  goto error;
203  }
204 
205  avctx->extradata_size = 1 + xiph_len(header.bytes) +
206  xiph_len(header_comm.bytes) +
207  header_code.bytes;
208  p = avctx->extradata = av_malloc(avctx->extradata_size +
210  if (!p) {
211  ret = AVERROR(ENOMEM);
212  goto error;
213  }
214  p[0] = 2;
215  offset = 1;
216  offset += av_xiphlacing(&p[offset], header.bytes);
217  offset += av_xiphlacing(&p[offset], header_comm.bytes);
218  memcpy(&p[offset], header.packet, header.bytes);
219  offset += header.bytes;
220  memcpy(&p[offset], header_comm.packet, header_comm.bytes);
221  offset += header_comm.bytes;
222  memcpy(&p[offset], header_code.packet, header_code.bytes);
223  offset += header_code.bytes;
224  assert(offset == avctx->extradata_size);
225 
226  s->vp = av_vorbis_parse_init(avctx->extradata, avctx->extradata_size);
227  if (!s->vp) {
228  av_log(avctx, AV_LOG_ERROR, "invalid extradata\n");
229  return ret;
230  }
231 
232  vorbis_comment_clear(&s->vc);
233 
235  ff_af_queue_init(avctx, &s->afq);
236 
238  if (!s->pkt_fifo) {
239  ret = AVERROR(ENOMEM);
240  goto error;
241  }
242 
243  return 0;
244 error:
245  libvorbis_encode_close(avctx);
246  return ret;
247 }
248 
250  const AVFrame *frame, int *got_packet_ptr)
251 {
252  LibvorbisContext *s = avctx->priv_data;
253  ogg_packet op;
254  int ret, duration;
255 
256  /* send samples to libvorbis */
257  if (frame) {
258  const int samples = frame->nb_samples;
259  float **buffer;
260  int c, channels = s->vi.channels;
261 
262  buffer = vorbis_analysis_buffer(&s->vd, samples);
263  for (c = 0; c < channels; c++) {
264  int co = (channels > 8) ? c :
266  memcpy(buffer[c], frame->extended_data[co],
267  samples * sizeof(*buffer[c]));
268  }
269  if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
270  av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
271  return vorbis_error_to_averror(ret);
272  }
273  if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
274  return ret;
275  } else {
276  if (!s->eof)
277  if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
278  av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
279  return vorbis_error_to_averror(ret);
280  }
281  s->eof = 1;
282  }
283 
284  /* retrieve available packets from libvorbis */
285  while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
286  if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
287  break;
288  if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
289  break;
290 
291  /* add any available packets to the output packet buffer */
292  while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
293  if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
294  av_log(avctx, AV_LOG_ERROR, "packet buffer is too small");
295  return AVERROR_BUG;
296  }
297  av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
298  av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
299  }
300  if (ret < 0) {
301  av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
302  break;
303  }
304  }
305  if (ret < 0) {
306  av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
307  return vorbis_error_to_averror(ret);
308  }
309 
310  /* check for available packets */
311  if (av_fifo_size(s->pkt_fifo) < sizeof(ogg_packet))
312  return 0;
313 
314  av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
315 
316  if ((ret = ff_alloc_packet(avpkt, op.bytes))) {
317  av_log(avctx, AV_LOG_ERROR, "Error getting output packet\n");
318  return ret;
319  }
320  av_fifo_generic_read(s->pkt_fifo, avpkt->data, op.bytes, NULL);
321 
322  avpkt->pts = ff_samples_to_time_base(avctx, op.granulepos);
323 
324  duration = av_vorbis_parse_frame(s->vp, avpkt->data, avpkt->size);
325  if (duration > 0) {
326  /* we do not know encoder delay until we get the first packet from
327  * libvorbis, so we have to update the AudioFrameQueue counts */
328  if (!avctx->initial_padding) {
329  avctx->initial_padding = duration;
332  }
333  ff_af_queue_remove(&s->afq, duration, &avpkt->pts, &avpkt->duration);
334  }
335 
336  *got_packet_ptr = 1;
337  return 0;
338 }
339 
341  .name = "libvorbis",
342  .long_name = NULL_IF_CONFIG_SMALL("libvorbis Vorbis"),
343  .type = AVMEDIA_TYPE_AUDIO,
344  .id = AV_CODEC_ID_VORBIS,
345  .priv_data_size = sizeof(LibvorbisContext),
347  .encode2 = libvorbis_encode_frame,
348  .close = libvorbis_encode_close,
349  .capabilities = AV_CODEC_CAP_DELAY,
350  .sample_fmts = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLTP,
352  .priv_class = &class,
353  .defaults = defaults,
354 };
static const AVCodecDefault defaults[]
Definition: libvorbis.c:70
float, planar
Definition: samplefmt.h:71
void ff_af_queue_remove(AudioFrameQueue *afq, int nb_samples, int64_t *pts, int64_t *duration)
Remove frame(s) from the queue.
void * av_malloc(size_t size)
Allocate a block of size bytes with alignment suitable for all memory accesses (including vectors if ...
Definition: mem.c:62
This structure describes decoded (raw) audio or video data.
Definition: frame.h:140
int dsp_initialized
vd has been initialized
Definition: libvorbis.c:57
AVOption.
Definition: opt.h:234
#define LIBVORBIS_FRAME_SIZE
Definition: libvorbis.c:46
#define AV_OPT_FLAG_AUDIO_PARAM
Definition: opt.h:269
AVVorbisParseContext * av_vorbis_parse_init(const uint8_t *extradata, int extradata_size)
Allocate and initialize the Vorbis parser using headers in the extradata.
int size
Definition: avcodec.h:1347
av_log(ac->avr, AV_LOG_TRACE, "%d samples - audio_convert: %s to %s (%s)\, 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)
AVFifoBuffer * pkt_fifo
output packet buffer
Definition: libvorbis.c:55
AudioFrameQueue afq
frame queue for timestamps
Definition: libvorbis.c:62
AVCodec.
Definition: avcodec.h:3120
double iblock
impulse block bias option
Definition: libvorbis.c:60
int av_fifo_generic_write(AVFifoBuffer *f, void *src, int size, int(*func)(void *, void *, int))
Feed data from a user-supplied callback to an AVFifoBuffer.
Definition: fifo.c:84
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:202
#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:863
static char buffer[20]
Definition: seek.c:32
uint8_t
#define av_cold
Definition: attributes.h:66
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:1364
static av_cold int libvorbis_encode_close(AVCodecContext *avctx)
Definition: libvorbis.c:150
uint8_t * extradata
some codecs need / can use extradata like Huffman tables.
Definition: avcodec.h:1523
vorbis_info vi
vorbis_info used during init
Definition: libvorbis.c:52
int64_t duration
Definition: movenc.c:63
ogg_packet op
ogg packet
Definition: libvorbis.c:59
static const AVOption options[]
Definition: libvorbis.c:65
static av_cold int libvorbis_encode_init(AVCodecContext *avctx)
Definition: libvorbis.c:171
uint8_t * data
Definition: avcodec.h:1346
A public API for Vorbis parsing.
void av_fifo_free(AVFifoBuffer *f)
Free an AVFifoBuffer.
Definition: fifo.c:38
vorbis_block vb
vorbis_block used for analysis
Definition: libvorbis.c:54
#define AV_OPT_FLAG_ENCODING_PARAM
a generic parameter which can be set by the user for muxing or encoding
Definition: opt.h:264
AVCodec ff_libvorbis_encoder
Definition: libvorbis.c:340
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:124
void av_vorbis_parse_free(AVVorbisParseContext **s)
Free the parser and everything associated with it.
#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:148
static int vorbis_error_to_averror(int ov_err)
Definition: libvorbis.c:78
int initial_padding
Audio only.
Definition: avcodec.h:3054
int av_fifo_generic_read(AVFifoBuffer *f, void *dest, int buf_size, void(*func)(void *, void *, int))
Feed data from an AVFifoBuffer to a user-supplied callback.
Definition: fifo.c:107
int flags
AV_CODEC_FLAG_*.
Definition: avcodec.h:1503
int rc_max_rate
maximum bitrate
Definition: avcodec.h:2387
const char * name
Name of the codec implementation.
Definition: avcodec.h:3127
static av_cold int libvorbis_setup(vorbis_info *vi, AVCodecContext *avctx)
Definition: libvorbis.c:88
int ff_af_queue_add(AudioFrameQueue *afq, const AVFrame *f)
Add a frame to the queue.
int bit_rate
the average bitrate
Definition: avcodec.h:1473
#define AV_CODEC_FLAG_QSCALE
Use fixed qscale.
Definition: avcodec.h:735
AVVorbisParseContext * vp
parse context to get durations
Definition: libvorbis.c:61
static int libvorbis_encode_frame(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame, int *got_packet_ptr)
Definition: libvorbis.c:249
int ff_alloc_packet(AVPacket *avpkt, int size)
Check AVPacket size and/or allocate data.
Definition: utils.c:1211
LIBAVUTIL_VERSION_INT
Definition: eval.c:55
int frame_size
Number of samples per channel in an audio frame.
Definition: avcodec.h:2172
const uint8_t ff_vorbis_encoding_channel_layout_offsets[8][8]
Definition: vorbis_data.c:36
NULL
Definition: eval.c:55
int av_fifo_space(AVFifoBuffer *f)
Return the amount of space in bytes in the AVFifoBuffer, that is the amount of data you can write int...
Definition: fifo.c:57
av_default_item_name
Definition: libvorbis.c:75
Libavcodec external API header.
AVSampleFormat
Audio Sample Formats.
Definition: samplefmt.h:60
int sample_rate
samples per second
Definition: avcodec.h:2152
main external API structure.
Definition: avcodec.h:1409
a very simple circular buffer FIFO implementation
int extradata_size
Definition: avcodec.h:1524
#define AVERROR_BUG
Bug detected, please report the issue.
Definition: error.h:60
unsigned int av_xiphlacing(unsigned char *s, unsigned int v)
Encode extradata length to a buffer.
Definition: utils.c:2531
Describe the class of an AVClass context structure.
Definition: log.h:34
#define BUFFER_SIZE
Definition: libvorbis.c:48
int global_quality
Global quality for codecs which cannot change it per frame.
Definition: avcodec.h:1489
vorbis_dsp_state vd
DSP state used for analysis.
Definition: libvorbis.c:53
vorbis_comment vc
VorbisComment info.
Definition: libvorbis.c:58
int av_fifo_size(AVFifoBuffer *f)
Return the amount of data in bytes in the AVFifoBuffer, that is the amount of data you can read from ...
Definition: fifo.c:52
common internal api header.
int eof
end-of-file flag
Definition: libvorbis.c:56
int av_vorbis_parse_frame(AVVorbisParseContext *s, const uint8_t *buf, int buf_size)
Get the duration for a Vorbis packet.
#define AVERROR_UNKNOWN
Unknown error, typically from an external library.
Definition: error.h:61
static av_cold int init(AVCodecParserContext *s)
Definition: h264_parser.c:582
#define AV_INPUT_BUFFER_PADDING_SIZE
Required number of additionally allocated bytes at the end of the input bitstream for decoding...
Definition: avcodec.h:638
void * priv_data
Definition: avcodec.h:1451
int cutoff
Audio cutoff bandwidth (0 means "automatic")
Definition: avcodec.h:2196
AVClass * av_class
class for AVOptions
Definition: libvorbis.c:51
static int ogg_packet(AVFormatContext *s, int *str, int *dstart, int *dsize, int64_t *fpos)
Definition: oggdec.c:341
AVFifoBuffer * av_fifo_alloc(unsigned int size)
Initialize an AVFifoBuffer.
Definition: fifo.c:25
int channels
number of audio channels
Definition: avcodec.h:2153
#define FF_QP2LAMBDA
factor to convert from H.263 QP to lambda
Definition: avutil.h:214
void ff_af_queue_close(AudioFrameQueue *afq)
Close AudioFrameQueue.
#define LIBAVCODEC_IDENT
Definition: version.h:42
static enum AVSampleFormat sample_fmts[]
Definition: adpcmenc.c:700
static av_always_inline int64_t ff_samples_to_time_base(AVCodecContext *avctx, int64_t samples)
Rescale from sample rate to AVCodecContext.time_base.
Definition: internal.h:202
int rc_min_rate
minimum bitrate
Definition: avcodec.h:2394
uint8_t ** extended_data
pointers to the data planes/channels.
Definition: frame.h:174
This structure stores compressed data.
Definition: avcodec.h:1323
int nb_samples
number of audio samples (per channel) described by this frame
Definition: frame.h:184
int64_t pts
Presentation timestamp in AVStream->time_base units; the time at which the decompressed packet will b...
Definition: avcodec.h:1339
static int xiph_len(int l)
Definition: libvorbis.c:145