yading@10: /*
yading@10:  * Copyright (c) 2002 Mark Hills <mark@pogo.org.uk>
yading@10:  *
yading@10:  * This file is part of FFmpeg.
yading@10:  *
yading@10:  * FFmpeg is free software; you can redistribute it and/or
yading@10:  * modify it under the terms of the GNU Lesser General Public
yading@10:  * License as published by the Free Software Foundation; either
yading@10:  * version 2.1 of the License, or (at your option) any later version.
yading@10:  *
yading@10:  * FFmpeg is distributed in the hope that it will be useful,
yading@10:  * but WITHOUT ANY WARRANTY; without even the implied warranty of
yading@10:  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
yading@10:  * Lesser General Public License for more details.
yading@10:  *
yading@10:  * You should have received a copy of the GNU Lesser General Public
yading@10:  * License along with FFmpeg; if not, write to the Free Software
yading@10:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
yading@10:  */
yading@10: 
yading@10: #include <vorbis/vorbisenc.h>
yading@10: 
yading@10: #include "libavutil/avassert.h"
yading@10: #include "libavutil/fifo.h"
yading@10: #include "libavutil/opt.h"
yading@10: #include "avcodec.h"
yading@10: #include "audio_frame_queue.h"
yading@10: #include "internal.h"
yading@10: #include "vorbis.h"
yading@10: #include "vorbis_parser.h"
yading@10: 
yading@10: 
yading@10: /* Number of samples the user should send in each call.
yading@10:  * This value is used because it is the LCD of all possible frame sizes, so
yading@10:  * an output packet will always start at the same point as one of the input
yading@10:  * packets.
yading@10:  */
yading@10: #define OGGVORBIS_FRAME_SIZE 64
yading@10: 
yading@10: #define BUFFER_SIZE (1024 * 64)
yading@10: 
yading@10: typedef struct OggVorbisEncContext {
yading@10:     AVClass *av_class;                  /**< class for AVOptions            */
yading@10:     AVFrame frame;
yading@10:     vorbis_info vi;                     /**< vorbis_info used during init   */
yading@10:     vorbis_dsp_state vd;                /**< DSP state used for analysis    */
yading@10:     vorbis_block vb;                    /**< vorbis_block used for analysis */
yading@10:     AVFifoBuffer *pkt_fifo;             /**< output packet buffer           */
yading@10:     int eof;                            /**< end-of-file flag               */
yading@10:     int dsp_initialized;                /**< vd has been initialized        */
yading@10:     vorbis_comment vc;                  /**< VorbisComment info             */
yading@10:     double iblock;                      /**< impulse block bias option      */
yading@10:     VorbisParseContext vp;              /**< parse context to get durations */
yading@10:     AudioFrameQueue afq;                /**< frame queue for timestamps     */
yading@10: } OggVorbisEncContext;
yading@10: 
yading@10: static const AVOption options[] = {
yading@10:     { "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 },
yading@10:     { NULL }
yading@10: };
yading@10: 
yading@10: static const AVCodecDefault defaults[] = {
yading@10:     { "b",  "0" },
yading@10:     { NULL },
yading@10: };
yading@10: 
yading@10: static const AVClass class = {
yading@10:     .class_name = "libvorbis",
yading@10:     .item_name  = av_default_item_name,
yading@10:     .option     = options,
yading@10:     .version    = LIBAVUTIL_VERSION_INT,
yading@10: };
yading@10: 
yading@10: static int vorbis_error_to_averror(int ov_err)
yading@10: {
yading@10:     switch (ov_err) {
yading@10:     case OV_EFAULT: return AVERROR_BUG;
yading@10:     case OV_EINVAL: return AVERROR(EINVAL);
yading@10:     case OV_EIMPL:  return AVERROR(EINVAL);
yading@10:     default:        return AVERROR_UNKNOWN;
yading@10:     }
yading@10: }
yading@10: 
yading@10: static av_cold int oggvorbis_init_encoder(vorbis_info *vi,
yading@10:                                           AVCodecContext *avctx)
yading@10: {
yading@10:     OggVorbisEncContext *s = avctx->priv_data;
yading@10:     double cfreq;
yading@10:     int ret;
yading@10: 
yading@10:     if (avctx->flags & CODEC_FLAG_QSCALE || !avctx->bit_rate) {
yading@10:         /* variable bitrate
yading@10:          * NOTE: we use the oggenc range of -1 to 10 for global_quality for
yading@10:          *       user convenience, but libvorbis uses -0.1 to 1.0.
yading@10:          */
yading@10:         float q = avctx->global_quality / (float)FF_QP2LAMBDA;
yading@10:         /* default to 3 if the user did not set quality or bitrate */
yading@10:         if (!(avctx->flags & CODEC_FLAG_QSCALE))
yading@10:             q = 3.0;
yading@10:         if ((ret = vorbis_encode_setup_vbr(vi, avctx->channels,
yading@10:                                            avctx->sample_rate,
yading@10:                                            q / 10.0)))
yading@10:             goto error;
yading@10:     } else {
yading@10:         int minrate = avctx->rc_min_rate > 0 ? avctx->rc_min_rate : -1;
yading@10:         int maxrate = avctx->rc_max_rate > 0 ? avctx->rc_max_rate : -1;
yading@10: 
yading@10:         /* average bitrate */
yading@10:         if ((ret = vorbis_encode_setup_managed(vi, avctx->channels,
yading@10:                                                avctx->sample_rate, maxrate,
yading@10:                                                avctx->bit_rate, minrate)))
yading@10:             goto error;
yading@10: 
yading@10:         /* variable bitrate by estimate, disable slow rate management */
yading@10:         if (minrate == -1 && maxrate == -1)
yading@10:             if ((ret = vorbis_encode_ctl(vi, OV_ECTL_RATEMANAGE2_SET, NULL)))
yading@10:                 goto error; /* should not happen */
yading@10:     }
yading@10: 
yading@10:     /* cutoff frequency */
yading@10:     if (avctx->cutoff > 0) {
yading@10:         cfreq = avctx->cutoff / 1000.0;
yading@10:         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_LOWPASS_SET, &cfreq)))
yading@10:             goto error; /* should not happen */
yading@10:     }
yading@10: 
yading@10:     /* impulse block bias */
yading@10:     if (s->iblock) {
yading@10:         if ((ret = vorbis_encode_ctl(vi, OV_ECTL_IBLOCK_SET, &s->iblock)))
yading@10:             goto error;
yading@10:     }
yading@10: 
yading@10:     if (avctx->channels == 3 &&
yading@10:             avctx->channel_layout != (AV_CH_LAYOUT_STEREO|AV_CH_FRONT_CENTER) ||
yading@10:         avctx->channels == 4 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_2_2 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_QUAD ||
yading@10:         avctx->channels == 5 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_5POINT0 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_5POINT0_BACK ||
yading@10:         avctx->channels == 6 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_5POINT1 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_5POINT1_BACK ||
yading@10:         avctx->channels == 7 &&
yading@10:             avctx->channel_layout != (AV_CH_LAYOUT_5POINT1|AV_CH_BACK_CENTER) ||
yading@10:         avctx->channels == 8 &&
yading@10:             avctx->channel_layout != AV_CH_LAYOUT_7POINT1) {
yading@10:         if (avctx->channel_layout) {
yading@10:             char name[32];
yading@10:             av_get_channel_layout_string(name, sizeof(name), avctx->channels,
yading@10:                                          avctx->channel_layout);
yading@10:             av_log(avctx, AV_LOG_ERROR, "%s not supported by Vorbis: "
yading@10:                                              "output stream will have incorrect "
yading@10:                                              "channel layout.\n", name);
yading@10:         } else {
yading@10:             av_log(avctx, AV_LOG_WARNING, "No channel layout specified. The encoder "
yading@10:                                                "will use Vorbis channel layout for "
yading@10:                                                "%d channels.\n", avctx->channels);
yading@10:         }
yading@10:     }
yading@10: 
yading@10:     if ((ret = vorbis_encode_setup_init(vi)))
yading@10:         goto error;
yading@10: 
yading@10:     return 0;
yading@10: error:
yading@10:     return vorbis_error_to_averror(ret);
yading@10: }
yading@10: 
yading@10: /* How many bytes are needed for a buffer of length 'l' */
yading@10: static int xiph_len(int l)
yading@10: {
yading@10:     return 1 + l / 255 + l;
yading@10: }
yading@10: 
yading@10: static av_cold int oggvorbis_encode_close(AVCodecContext *avctx)
yading@10: {
yading@10:     OggVorbisEncContext *s = avctx->priv_data;
yading@10: 
yading@10:     /* notify vorbisenc this is EOF */
yading@10:     if (s->dsp_initialized)
yading@10:         vorbis_analysis_wrote(&s->vd, 0);
yading@10: 
yading@10:     vorbis_block_clear(&s->vb);
yading@10:     vorbis_dsp_clear(&s->vd);
yading@10:     vorbis_info_clear(&s->vi);
yading@10: 
yading@10:     av_fifo_free(s->pkt_fifo);
yading@10:     ff_af_queue_close(&s->afq);
yading@10:     av_freep(&avctx->extradata);
yading@10: 
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: static av_cold int oggvorbis_encode_init(AVCodecContext *avctx)
yading@10: {
yading@10:     OggVorbisEncContext *s = avctx->priv_data;
yading@10:     ogg_packet header, header_comm, header_code;
yading@10:     uint8_t *p;
yading@10:     unsigned int offset;
yading@10:     int ret;
yading@10: 
yading@10:     vorbis_info_init(&s->vi);
yading@10:     if ((ret = oggvorbis_init_encoder(&s->vi, avctx))) {
yading@10:         av_log(avctx, AV_LOG_ERROR, "encoder setup failed\n");
yading@10:         goto error;
yading@10:     }
yading@10:     if ((ret = vorbis_analysis_init(&s->vd, &s->vi))) {
yading@10:         av_log(avctx, AV_LOG_ERROR, "analysis init failed\n");
yading@10:         ret = vorbis_error_to_averror(ret);
yading@10:         goto error;
yading@10:     }
yading@10:     s->dsp_initialized = 1;
yading@10:     if ((ret = vorbis_block_init(&s->vd, &s->vb))) {
yading@10:         av_log(avctx, AV_LOG_ERROR, "dsp init failed\n");
yading@10:         ret = vorbis_error_to_averror(ret);
yading@10:         goto error;
yading@10:     }
yading@10: 
yading@10:     vorbis_comment_init(&s->vc);
yading@10:     if (!(avctx->flags & CODEC_FLAG_BITEXACT))
yading@10:         vorbis_comment_add_tag(&s->vc, "encoder", LIBAVCODEC_IDENT);
yading@10: 
yading@10:     if ((ret = vorbis_analysis_headerout(&s->vd, &s->vc, &header, &header_comm,
yading@10:                                          &header_code))) {
yading@10:         ret = vorbis_error_to_averror(ret);
yading@10:         goto error;
yading@10:     }
yading@10: 
yading@10:     avctx->extradata_size = 1 + xiph_len(header.bytes)      +
yading@10:                                 xiph_len(header_comm.bytes) +
yading@10:                                 header_code.bytes;
yading@10:     p = avctx->extradata = av_malloc(avctx->extradata_size +
yading@10:                                      FF_INPUT_BUFFER_PADDING_SIZE);
yading@10:     if (!p) {
yading@10:         ret = AVERROR(ENOMEM);
yading@10:         goto error;
yading@10:     }
yading@10:     p[0]    = 2;
yading@10:     offset  = 1;
yading@10:     offset += av_xiphlacing(&p[offset], header.bytes);
yading@10:     offset += av_xiphlacing(&p[offset], header_comm.bytes);
yading@10:     memcpy(&p[offset], header.packet, header.bytes);
yading@10:     offset += header.bytes;
yading@10:     memcpy(&p[offset], header_comm.packet, header_comm.bytes);
yading@10:     offset += header_comm.bytes;
yading@10:     memcpy(&p[offset], header_code.packet, header_code.bytes);
yading@10:     offset += header_code.bytes;
yading@10:     av_assert0(offset == avctx->extradata_size);
yading@10: 
yading@10:     if ((ret = avpriv_vorbis_parse_extradata(avctx, &s->vp)) < 0) {
yading@10:         av_log(avctx, AV_LOG_ERROR, "invalid extradata\n");
yading@10:         return ret;
yading@10:     }
yading@10: 
yading@10:     vorbis_comment_clear(&s->vc);
yading@10: 
yading@10:     avctx->frame_size = OGGVORBIS_FRAME_SIZE;
yading@10:     ff_af_queue_init(avctx, &s->afq);
yading@10: 
yading@10:     s->pkt_fifo = av_fifo_alloc(BUFFER_SIZE);
yading@10:     if (!s->pkt_fifo) {
yading@10:         ret = AVERROR(ENOMEM);
yading@10:         goto error;
yading@10:     }
yading@10: 
yading@10:     return 0;
yading@10: error:
yading@10:     oggvorbis_encode_close(avctx);
yading@10:     return ret;
yading@10: }
yading@10: 
yading@10: static int oggvorbis_encode_frame(AVCodecContext *avctx, AVPacket *avpkt,
yading@10:                                   const AVFrame *frame, int *got_packet_ptr)
yading@10: {
yading@10:     OggVorbisEncContext *s = avctx->priv_data;
yading@10:     ogg_packet op;
yading@10:     int ret, duration;
yading@10: 
yading@10:     /* send samples to libvorbis */
yading@10:     if (frame) {
yading@10:         const int samples = frame->nb_samples;
yading@10:         float **buffer;
yading@10:         int c, channels = s->vi.channels;
yading@10: 
yading@10:         buffer = vorbis_analysis_buffer(&s->vd, samples);
yading@10:         for (c = 0; c < channels; c++) {
yading@10:             int co = (channels > 8) ? c :
yading@10:                      ff_vorbis_encoding_channel_layout_offsets[channels - 1][c];
yading@10:             memcpy(buffer[c], frame->extended_data[co],
yading@10:                    samples * sizeof(*buffer[c]));
yading@10:         }
yading@10:         if ((ret = vorbis_analysis_wrote(&s->vd, samples)) < 0) {
yading@10:             av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
yading@10:             return vorbis_error_to_averror(ret);
yading@10:         }
yading@10:         if ((ret = ff_af_queue_add(&s->afq, frame)) < 0)
yading@10:             return ret;
yading@10:     } else {
yading@10:         if (!s->eof)
yading@10:             if ((ret = vorbis_analysis_wrote(&s->vd, 0)) < 0) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "error in vorbis_analysis_wrote()\n");
yading@10:                 return vorbis_error_to_averror(ret);
yading@10:             }
yading@10:         s->eof = 1;
yading@10:     }
yading@10: 
yading@10:     /* retrieve available packets from libvorbis */
yading@10:     while ((ret = vorbis_analysis_blockout(&s->vd, &s->vb)) == 1) {
yading@10:         if ((ret = vorbis_analysis(&s->vb, NULL)) < 0)
yading@10:             break;
yading@10:         if ((ret = vorbis_bitrate_addblock(&s->vb)) < 0)
yading@10:             break;
yading@10: 
yading@10:         /* add any available packets to the output packet buffer */
yading@10:         while ((ret = vorbis_bitrate_flushpacket(&s->vd, &op)) == 1) {
yading@10:             if (av_fifo_space(s->pkt_fifo) < sizeof(ogg_packet) + op.bytes) {
yading@10:                 av_log(avctx, AV_LOG_ERROR, "packet buffer is too small\n");
yading@10:                 return AVERROR_BUG;
yading@10:             }
yading@10:             av_fifo_generic_write(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
yading@10:             av_fifo_generic_write(s->pkt_fifo, op.packet, op.bytes, NULL);
yading@10:         }
yading@10:         if (ret < 0) {
yading@10:             av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
yading@10:             break;
yading@10:         }
yading@10:     }
yading@10:     if (ret < 0) {
yading@10:         av_log(avctx, AV_LOG_ERROR, "error getting available packets\n");
yading@10:         return vorbis_error_to_averror(ret);
yading@10:     }
yading@10: 
yading@10:     /* check for available packets */
yading@10:     if (av_fifo_size(s->pkt_fifo) < sizeof(ogg_packet))
yading@10:         return 0;
yading@10: 
yading@10:     av_fifo_generic_read(s->pkt_fifo, &op, sizeof(ogg_packet), NULL);
yading@10: 
yading@10:     if ((ret = ff_alloc_packet2(avctx, avpkt, op.bytes)) < 0)
yading@10:         return ret;
yading@10:     av_fifo_generic_read(s->pkt_fifo, avpkt->data, op.bytes, NULL);
yading@10: 
yading@10:     avpkt->pts = ff_samples_to_time_base(avctx, op.granulepos);
yading@10: 
yading@10:     duration = avpriv_vorbis_parse_frame(&s->vp, avpkt->data, avpkt->size);
yading@10:     if (duration > 0) {
yading@10:         /* we do not know encoder delay until we get the first packet from
yading@10:          * libvorbis, so we have to update the AudioFrameQueue counts */
yading@10:         if (!avctx->delay && s->afq.frames) {
yading@10:             avctx->delay              = duration;
yading@10:             av_assert0(!s->afq.remaining_delay);
yading@10:             s->afq.frames->duration  += duration;
yading@10:             s->afq.frames->pts       -= duration;
yading@10:             s->afq.remaining_samples += duration;
yading@10:         }
yading@10:         ff_af_queue_remove(&s->afq, duration, &avpkt->pts, &avpkt->duration);
yading@10:     }
yading@10: 
yading@10:     *got_packet_ptr = 1;
yading@10:     return 0;
yading@10: }
yading@10: 
yading@10: AVCodec ff_libvorbis_encoder = {
yading@10:     .name           = "libvorbis",
yading@10:     .type           = AVMEDIA_TYPE_AUDIO,
yading@10:     .id             = AV_CODEC_ID_VORBIS,
yading@10:     .priv_data_size = sizeof(OggVorbisEncContext),
yading@10:     .init           = oggvorbis_encode_init,
yading@10:     .encode2        = oggvorbis_encode_frame,
yading@10:     .close          = oggvorbis_encode_close,
yading@10:     .capabilities   = CODEC_CAP_DELAY,
yading@10:     .sample_fmts    = (const enum AVSampleFormat[]) { AV_SAMPLE_FMT_FLTP,
yading@10:                                                       AV_SAMPLE_FMT_NONE },
yading@10:     .long_name      = NULL_IF_CONFIG_SMALL("libvorbis"),
yading@10:     .priv_class     = &class,
yading@10:     .defaults       = defaults,
yading@10: };