git.sesse.net Git - ffmpeg/blob - libavcodec/libvorbisenc.c

   1 /*
   2  * Copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg 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  * FFmpeg 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 FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #include <vorbis/vorbisenc.h>
  22
  23 #include "libavutil/fifo.h"
  24 #include "libavutil/opt.h"
  25 #include "avcodec.h"
  26 #include "audio_frame_queue.h"
  27 #include "internal.h"
  28 #include "vorbis.h"
  29 #include "vorbis_parser.h"
  30
  31 #undef NDEBUG
  32 #include <assert.h>
  33
  34 /* Number of samples the user should send in each call.
  35  * This value is used because it is the LCD of all possible frame sizes, so
  36  * an output packet will always start at the same point as one of the input
  37  * packets.
  38  */
  39 #define OGGVORBIS_FRAME_SIZE 64
  40
  41 #define BUFFER_SIZE (1024 * 64)
  42
  43 typedef struct OggVorbisEncContext {
  44     AVClass *av_class;                  /**< class for AVOptions            */
  45     AVFrame frame;
  46     vorbis_info vi;                     /**< vorbis_info used during init   */
  47     vorbis_dsp_state vd;                /**< DSP state used for analysis    */
  48     vorbis_block vb;                    /**< vorbis_block used for analysis */
  49     AVFifoBuffer *pkt_fifo;             /**< output packet buffer           */
  50     int eof;                            /**< end-of-file flag               */
  51     int dsp_initialized;                /**< vd has been initialized        */
  52     vorbis_comment vc;                  /**< VorbisComment info             */
  53     double iblock;                      /**< impulse block bias option      */
  54     VorbisParseContext vp;              /**< parse context to get durations */
  55     AudioFrameQueue afq;                /**< frame queue for timestamps     */
  56 } OggVorbisEncContext;
  57
  58 static const AVOption options[] = {
  59     { "iblock", "Sets the impulse block bias", offsetof(OggVorbisEncContext, iblock), AV_OPT_TYPE_DOUBLE, { .dbl = 0 }, -15, 0, AV_OPT_FLAG_AUDIO_PARAM | AV_OPT_FLAG_ENCODING_PARAM },
  60     { NULL }
  61 };
  62
  63 static const AVCodecDefault defaults[] = {
  64     { "b",  "0" },
  65     { NULL },
  66 };
  67
  68 static const AVClass class = {
  69     .class_name = "libvorbis",
  70     .item_name  = av_default_item_name,
  71     .option     = options,
  72     .version    = LIBAVUTIL_VERSION_INT,
  73 };
  74
  75 static int vorbis_error_to_averror(int ov_err)
  76 {
  77     switch (ov_err) {
  78     case OV_EFAULT: return AVERROR_BUG;
  79     case OV_EINVAL: return AVERROR(EINVAL);
  80     case OV_EIMPL:  return AVERROR(EINVAL);
  81     default:        return AVERROR_UNKNOWN;
  82     }
  83 }
  84
  85 static av_cold int oggvorbis_init_encoder(vorbis_info *vi,
  86                                           AVCodecContext *avctx)
  87 {
  88     OggVorbisEncContext *s = avctx->priv_data;
  89     double cfreq;
  90     int ret;
  91
  92     if (avctx->flags & CODEC_FLAG_QSCALE || !avctx->bit_rate) {
  93         /* variable bitrate
  94          * NOTE: we use the oggenc range of -1 to 10 for global_quality for
  95          *       user convenience, but libvorbis uses -0.1 to 1.0.
  96          */
  97         float q = avctx->global_quality / (float)FF_QP2LAMBDA;
  98         /* default to 3 if the user did not set quality or bitrate */
  99         if (!(avctx->flags & CODEC_FLAG_QSCALE))
 100             q = 3.0;
 101         if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
 102                                            avctx->sample_rate,
 103                                            q / 10.0)))
 104             goto error;
 105     } else {
 106         int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
 107         int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
 108
 109         /* average bitrate */
 110         if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
 111                                                avctx->sample_rate, maxrate,
 112                                                avctx->bit_rate, minrate)))
 113             goto error;
 114
 115         /* variable bitrate by estimate, disable slow rate management */
 116         if (minrate == -1 && maxrate == -1)
 117             if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
 118                 goto error; /* should not happen */
 119     }
 120
 121     /* cutoff frequency */
 122     if (avctx->cutoff > 0) {
 123         cfreq = avctx->cutoff / 1000.0;
 124         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
 125             goto error; /* should not happen */
 126     }
 127
 128     /* impulse block bias */
 129     if (s->iblock) {
 130         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
 131             goto error;
 132     }
 133
 134     if (avctx->channels == 3 &&
 135             avctx->channel_layout != (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) ||
 136         avctx->channels == 4 &&
 137             avctx->channel_layout != AV_CH_LAYOUT_2_2 &&
 138             avctx->channel_layout != AV_CH_LAYOUT_QUAD ||
 139         avctx->channels == 5 &&
 140             avctx->channel_layout != AV_CH_LAYOUT_5POINT0 &&
 141             avctx->channel_layout != AV_CH_LAYOUT_5POINT0_BACK ||
 142         avctx->channels == 6 &&
 143             avctx->channel_layout != AV_CH_LAYOUT_5POINT1 &&
 144             avctx->channel_layout != AV_CH_LAYOUT_5POINT1_BACK ||
 145         avctx->channels == 7 &&
 146             avctx->channel_layout != (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER) ||
 147         avctx->channels == 8 &&
 148             avctx->channel_layout != AV_CH_LAYOUT_7POINT1) {
 149         if (avctx->channel_layout) {
 150             char name[32];
 151             av_get_channel_layout_string(name, sizeof(name), avctx->channels,
 152                                          avctx->channel_layout);
 153             av_log(avctx, AV_LOG_ERROR, "%s not supported by Vorbis: "
 154                                              "output stream will have incorrect "
 155                                              "channel layout.\n", name);
 156         } else {
 157             av_log(avctx, AV_LOG_WARNING, "No channel layout specified. The encoder "
 158                                                "will use Vorbis channel layout for "
 159                                                "%d channels.\n", avctx->channels);
 160         }
 161     }
 162
 163     if ((ret = vorbis_encode_setup_init(vi)))
 164         goto error;
 165
 166     return 0;
 167 error:
 168     return vorbis_error_to_averror(ret);
 169 }
 170
 171 /* How many bytes are needed for a buffer of length 'l' */
 172 static int xiph_len(int l)
 173 {
 174     return 1 + l / 255 + l;
 175 }
 176
 177 static av_cold int oggvorbis_encode_close(AVCodecContext *avctx)
 178 {
 179     OggVorbisEncContext *s = avctx->priv_data;
 180
 181     /* notify vorbisenc this is EOF */
 182     if (s->dsp_initialized)
 183         vorbis_analysis_wrote(&s->vd, 0);
 184
 185     vorbis_block_clear(&s->vb);
 186     vorbis_dsp_clear(&s->vd);
 187     vorbis_info_clear(&s->vi);
 188
 189     av_fifo_free(s->pkt_fifo);
 190     ff_af_queue_close(&s->afq);
 191 #if FF_API_OLD_ENCODE_AUDIO
 192     av_freep(&avctx->coded_frame);
 193 #endif
 194     av_freep(&avctx->extradata);
 195
 196     return 0;
 197 }
 198
 199 static av_cold int oggvorbis_encode_init(AVCodecContext *avctx)
 200 {
 201     OggVorbisEncContext *s = avctx->priv_data;
 202     ogg_packet header, header_comm, header_code;
 203     uint8_t *p;
 204     unsigned int offset;
 205     int ret;
 206
 207     vorbis_info_init(&s->vi);
 208     if ((ret = oggvorbis_init_encoder(&s->vi, avctx))) {
 209         av_log(avctx, AV_LOG_ERROR, "encoder setup failed\n");
 210         goto error;
 211     }
 212     if ((ret = vorbis_analysis_init(&s->vd, &s->vi))) {
 213         av_log(avctx, AV_LOG_ERROR, "analysis init failed\n");
 214         ret = vorbis_error_to_averror(ret);
 215         goto error;
 216     }
 217     s->dsp_initialized = 1;
 218     if ((ret = vorbis_block_init(&s->vd, &s->vb))) {
 219         av_log(avctx, AV_LOG_ERROR, "dsp init failed\n");
 220         ret = vorbis_error_to_averror(ret);
 221         goto error;
 222     }
 223
 224     vorbis_comment_init(&s->vc);
 225     if (!(avctx->flags & CODEC_FLAG_BITEXACT))
 226         vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
 227
 228     if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
 229                                          &header_code))) {
 230         ret = vorbis_error_to_averror(ret);
 231         goto error;
 232     }
 233
 234     avctx->extradata_size = 1 + xiph_len(header.bytes)      +
 235                                 xiph_len(header_comm.bytes) +
 236                                 header_code.bytes;
 237     p = avctx->extradata = av_malloc(avctx->extradata_size +
 238                                      FF_INPUT_BUFFER_PADDING_SIZE);
 239     if (!p) {
 240         ret = AVERROR(ENOMEM);
 241         goto error;
 242     }
 243     p[0]    = 2;
 244     offset  = 1;
 245     offset += av_xiphlacing(&p[offset], header.bytes);
 246     offset += av_xiphlacing(&p[offset], header_comm.bytes);
 247     memcpy(&p[offset], header.packet, header.bytes);
 248     offset += header.bytes;
 249     memcpy(&p[offset], header_comm.packet, header_comm.bytes);
 250     offset += header_comm.bytes;
 251     memcpy(&p[offset], header_code.packet, header_code.bytes);
 252     offset += header_code.bytes;
 253     assert(offset == avctx->extradata_size);
 254
 255     if ((ret = avpriv_vorbis_parse_extradata(avctx, &s->vp)) < 0) {
 256         av_log(avctx, AV_LOG_ERROR, "invalid extradata\n");
 257         return ret;
 258     }
 259
 260     vorbis_comment_clear(&s->vc);
 261
 262     avctx->frame_size = OGGVORBIS_FRAME_SIZE;
 263     ff_af_queue_init(avctx, &s->afq);
 264
 265     s->pkt_fifo = av_fifo_alloc(BUFFER_SIZE);
 266     if (!s->pkt_fifo) {
 267         ret = AVERROR(ENOMEM);
 268         goto error;
 269     }
 270
 271 #if FF_API_OLD_ENCODE_AUDIO
 272     avctx->coded_frame = avcodec_alloc_frame();
 273     if (!avctx->coded_frame) {
 274         ret = AVERROR(ENOMEM);
 275         goto error;
 276     }
 277 #endif
 278
 279     return 0;
 280 error:
 281     oggvorbis_encode_close(avctx);
 282     return ret;
 283 }
 284
 285 static int oggvorbis_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
 286                                   const AVFrame *frame, int *got_packet_ptr)
 287 {
 288     OggVorbisEncContext *s = avctx->priv_data;
 289     ogg_packet op;
 290     int ret, duration;
 291
 292     /* send samples to libvorbis */
 293     if (frame) {
 294         const float *audio = (const float *)frame->data[0];
 295         const int samples = frame->nb_samples;
 296         float **buffer;
 297         int c, channels = s->vi.channels;
 298
 299         buffer = vorbis_analysis_buffer(&s->vd, samples);
 300         for (c = 0; c < channels; c++) {
 301             int i;
 302             int co = (channels > 8) ? c :
 303                      ff_vorbis_encoding_channel_layout_offsets[channels - 1][c];
 304             for (i = 0; i < samples; i++)
 305                 buffer[c][i] = audio[i * channels + co];
 306         }
 307         if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
 308             av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
 309             return vorbis_error_to_averror(ret);
 310         }
 311         if ((ret = ff_af_queue_add(&s->afq, frame) < 0))
 312             return ret;
 313     } else {
 314         if (!s->eof)
 315             if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
 316                 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
 317                 return vorbis_error_to_averror(ret);
 318             }
 319         s->eof = 1;
 320     }
 321
 322     /* retrieve available packets from libvorbis */
 323     while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
 324         if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
 325             break;
 326         if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
 327             break;
 328
 329         /* add any available packets to the output packet buffer */
 330         while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
 331             if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
 332                 av_log(avctx, AV_LOG_ERROR, "packet buffer is too small\n");
 333                 return AVERROR_BUG;
 334             }
 335             av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
 336             av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
 337         }
 338         if (ret < 0) {
 339             av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
 340             break;
 341         }
 342     }
 343     if (ret < 0) {
 344         av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
 345         return vorbis_error_to_averror(ret);
 346     }
 347
 348     /* check for available packets */
 349     if (av_fifo_size(s->pkt_fifo) < sizeof(ogg_packet))
 350         return 0;
 351
 352     av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
 353
 354     if ((ret = ff_alloc_packet2(avctx, avpkt, op.bytes)))
 355         return ret;
 356     av_fifo_generic_read(s->pkt_fifo, avpkt->data, op.bytes, NULL);
 357
 358     avpkt->pts = ff_samples_to_time_base(avctx, op.granulepos);
 359
 360     duration = avpriv_vorbis_parse_frame(&s->vp, avpkt->data, avpkt->size);
 361     if (duration > 0) {
 362         /* we do not know encoder delay until we get the first packet from
 363          * libvorbis, so we have to update the AudioFrameQueue counts */
 364         if (!avctx->delay) {
 365             avctx->delay              = duration;
 366             s->afq.remaining_delay   += duration;
 367             s->afq.remaining_samples += duration;
 368         }
 369         ff_af_queue_remove(&s->afq, duration, &avpkt->pts, &avpkt->duration);
 370     }
 371
 372     *got_packet_ptr = 1;
 373     return 0;
 374 }
 375
 376 AVCodec ff_libvorbis_encoder = {
 377     .name           = "libvorbis",
 378     .type           = AVMEDIA_TYPE_AUDIO,
 379     .id             = CODEC_ID_VORBIS,
 380     .priv_data_size = sizeof(OggVorbisEncContext),
 381     .init           = oggvorbis_encode_init,
 382     .encode2        = oggvorbis_encode_frame,
 383     .close          = oggvorbis_encode_close,
 384     .capabilities   = CODEC_CAP_DELAY,
 385     .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLT,
 386                                                       AV_SAMPLE_FMT_NONE },
 387     .long_name      = NULL_IF_CONFIG_SMALL("libvorbis"),
 388     .priv_class     = &class,
 389     .defaults       = defaults,
 390 };