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