2 * Copyright (c) 2006 Paul Richards <paul.richards@gmail.com>
4 * This file is part of Libav.
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.
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.
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
23 * @brief Theora encoder using libtheora.
24 * @author Paul Richards <paul.richards@gmail.com>
26 * A lot of this is copy / paste from other output codecs in
27 * libavcodec or pure guesswork (or both).
29 * I have used t_ prefixes on variables which are libtheora types
30 * and o_ prefixes on variables which are libogg types.
34 #include "libavutil/common.h"
35 #include "libavutil/intreadwrite.h"
36 #include "libavutil/pixdesc.h"
37 #include "libavutil/log.h"
38 #include "libavutil/base64.h"
42 /* libtheora includes */
43 #include <theora/theoraenc.h>
45 typedef struct TheoraContext {
55 /** Concatenate an ogg_packet into the extradata. */
56 static int concatenate_packet(unsigned int* offset,
57 AVCodecContext* avc_context,
58 const ogg_packet* packet)
60 const char* message = NULL;
61 uint8_t* newdata = NULL;
62 int newsize = avc_context->extradata_size + 2 + packet->bytes;
64 if (packet->bytes < 0) {
65 message = "ogg_packet has negative size";
66 } else if (packet->bytes > 0xffff) {
67 message = "ogg_packet is larger than 65535 bytes";
68 } else if (newsize < avc_context->extradata_size) {
69 message = "extradata_size would overflow";
71 newdata = av_realloc(avc_context->extradata, newsize);
73 message = "av_realloc failed";
76 av_log(avc_context, AV_LOG_ERROR, "concatenate_packet failed: %s\n", message);
80 avc_context->extradata = newdata;
81 avc_context->extradata_size = newsize;
82 AV_WB16(avc_context->extradata + (*offset), packet->bytes);
84 memcpy(avc_context->extradata + (*offset), packet->packet, packet->bytes);
85 (*offset) += packet->bytes;
89 static int get_stats(AVCodecContext *avctx, int eos)
91 #ifdef TH_ENCCTL_2PASS_OUT
92 TheoraContext *h = avctx->priv_data;
96 bytes = th_encode_ctl(h->t_state, TH_ENCCTL_2PASS_OUT, &buf, sizeof(buf));
98 av_log(avctx, AV_LOG_ERROR, "Error getting first pass stats\n");
102 h->stats = av_fast_realloc(h->stats, &h->stats_size,
103 h->stats_offset + bytes);
104 memcpy(h->stats + h->stats_offset, buf, bytes);
105 h->stats_offset += bytes;
107 int b64_size = AV_BASE64_SIZE(h->stats_offset);
108 // libtheora generates a summary header at the end
109 memcpy(h->stats, buf, bytes);
110 avctx->stats_out = av_malloc(b64_size);
111 av_base64_encode(avctx->stats_out, b64_size, h->stats, h->stats_offset);
115 av_log(avctx, AV_LOG_ERROR, "libtheora too old to support 2pass\n");
120 // libtheora won't read the entire buffer we give it at once, so we have to
121 // repeatedly submit it...
122 static int submit_stats(AVCodecContext *avctx)
124 #ifdef TH_ENCCTL_2PASS_IN
125 TheoraContext *h = avctx->priv_data;
128 if (!avctx->stats_in) {
129 av_log(avctx, AV_LOG_ERROR, "No statsfile for second pass\n");
132 h->stats_size = strlen(avctx->stats_in) * 3/4;
133 h->stats = av_malloc(h->stats_size);
134 h->stats_size = av_base64_decode(h->stats, avctx->stats_in, h->stats_size);
136 while (h->stats_size - h->stats_offset > 0) {
137 bytes = th_encode_ctl(h->t_state, TH_ENCCTL_2PASS_IN,
138 h->stats + h->stats_offset,
139 h->stats_size - h->stats_offset);
141 av_log(avctx, AV_LOG_ERROR, "Error submitting stats\n");
146 h->stats_offset += bytes;
150 av_log(avctx, AV_LOG_ERROR, "libtheora too old to support 2pass\n");
155 static av_cold int encode_init(AVCodecContext* avc_context)
158 th_comment t_comment;
161 TheoraContext *h = avc_context->priv_data;
162 uint32_t gop_size = avc_context->gop_size;
164 /* Set up the theora_info struct */
165 th_info_init(&t_info);
166 t_info.frame_width = FFALIGN(avc_context->width, 16);
167 t_info.frame_height = FFALIGN(avc_context->height, 16);
168 t_info.pic_width = avc_context->width;
169 t_info.pic_height = avc_context->height;
172 /* Swap numerator and denominator as time_base in AVCodecContext gives the
173 * time period between frames, but theora_info needs the framerate. */
174 t_info.fps_numerator = avc_context->time_base.den;
175 t_info.fps_denominator = avc_context->time_base.num;
176 if (avc_context->sample_aspect_ratio.num) {
177 t_info.aspect_numerator = avc_context->sample_aspect_ratio.num;
178 t_info.aspect_denominator = avc_context->sample_aspect_ratio.den;
180 t_info.aspect_numerator = 1;
181 t_info.aspect_denominator = 1;
184 if (avc_context->color_primaries == AVCOL_PRI_BT470M)
185 t_info.colorspace = TH_CS_ITU_REC_470M;
186 else if (avc_context->color_primaries == AVCOL_PRI_BT470BG)
187 t_info.colorspace = TH_CS_ITU_REC_470BG;
189 t_info.colorspace = TH_CS_UNSPECIFIED;
191 if (avc_context->pix_fmt == AV_PIX_FMT_YUV420P)
192 t_info.pixel_fmt = TH_PF_420;
193 else if (avc_context->pix_fmt == AV_PIX_FMT_YUV422P)
194 t_info.pixel_fmt = TH_PF_422;
195 else if (avc_context->pix_fmt == AV_PIX_FMT_YUV444P)
196 t_info.pixel_fmt = TH_PF_444;
198 av_log(avc_context, AV_LOG_ERROR, "Unsupported pix_fmt\n");
201 av_pix_fmt_get_chroma_sub_sample(avc_context->pix_fmt,
202 &h->uv_hshift, &h->uv_vshift);
204 if (avc_context->flags & CODEC_FLAG_QSCALE) {
205 /* to be constant with the libvorbis implementation, clip global_quality to 0 - 10
206 Theora accepts a quality parameter p, which is:
210 t_info.quality = av_clipf(avc_context->global_quality / (float)FF_QP2LAMBDA, 0, 10) * 6.3;
211 t_info.target_bitrate = 0;
213 t_info.target_bitrate = avc_context->bit_rate;
217 /* Now initialise libtheora */
218 h->t_state = th_encode_alloc(&t_info);
220 av_log(avc_context, AV_LOG_ERROR, "theora_encode_init failed\n");
224 h->keyframe_mask = (1 << t_info.keyframe_granule_shift) - 1;
225 /* Clear up theora_info struct */
226 th_info_clear(&t_info);
228 if (th_encode_ctl(h->t_state, TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE,
229 &gop_size, sizeof(gop_size))) {
230 av_log(avc_context, AV_LOG_ERROR, "Error setting GOP size\n");
234 // need to enable 2 pass (via TH_ENCCTL_2PASS_) before encoding headers
235 if (avc_context->flags & CODEC_FLAG_PASS1) {
236 if (get_stats(avc_context, 0))
238 } else if (avc_context->flags & CODEC_FLAG_PASS2) {
239 if (submit_stats(avc_context))
244 Output first header packet consisting of theora
245 header, comment, and tables.
247 Each one is prefixed with a 16bit size, then they
248 are concatenated together into libavcodec's extradata.
253 th_comment_init(&t_comment);
255 while (th_encode_flushheader(h->t_state, &t_comment, &o_packet))
256 if (concatenate_packet(&offset, avc_context, &o_packet))
259 th_comment_clear(&t_comment);
261 /* Set up the output AVFrame */
262 avc_context->coded_frame = av_frame_alloc();
267 static int encode_frame(AVCodecContext* avc_context, AVPacket *pkt,
268 const AVFrame *frame, int *got_packet)
270 th_ycbcr_buffer t_yuv_buffer;
271 TheoraContext *h = avc_context->priv_data;
275 // EOS, finish and get 1st pass stats if applicable
277 th_encode_packetout(h->t_state, 1, &o_packet);
278 if (avc_context->flags & CODEC_FLAG_PASS1)
279 if (get_stats(avc_context, 1))
284 /* Copy planes to the theora yuv_buffer */
285 for (i = 0; i < 3; i++) {
286 t_yuv_buffer[i].width = FFALIGN(avc_context->width, 16) >> (i && h->uv_hshift);
287 t_yuv_buffer[i].height = FFALIGN(avc_context->height, 16) >> (i && h->uv_vshift);
288 t_yuv_buffer[i].stride = frame->linesize[i];
289 t_yuv_buffer[i].data = frame->data[i];
292 if (avc_context->flags & CODEC_FLAG_PASS2)
293 if (submit_stats(avc_context))
296 /* Now call into theora_encode_YUVin */
297 result = th_encode_ycbcr_in(h->t_state, t_yuv_buffer);
302 message = "differing frame sizes";
305 message = "encoder is not ready or is finished";
308 message = "unknown reason";
311 av_log(avc_context, AV_LOG_ERROR, "theora_encode_YUVin failed (%s) [%d]\n", message, result);
315 if (avc_context->flags & CODEC_FLAG_PASS1)
316 if (get_stats(avc_context, 0))
319 /* Pick up returned ogg_packet */
320 result = th_encode_packetout(h->t_state, 0, &o_packet);
323 /* No packet is ready */
326 /* Success, we have a packet */
329 av_log(avc_context, AV_LOG_ERROR, "theora_encode_packetout failed [%d]\n", result);
333 /* Copy ogg_packet content out to buffer */
334 if ((ret = ff_alloc_packet(pkt, o_packet.bytes)) < 0) {
335 av_log(avc_context, AV_LOG_ERROR, "Error getting output packet of size %ld.\n", o_packet.bytes);
338 memcpy(pkt->data, o_packet.packet, o_packet.bytes);
340 // HACK: assumes no encoder delay, this is true until libtheora becomes
341 // multithreaded (which will be disabled unless explicitly requested)
342 pkt->pts = pkt->dts = frame->pts;
343 avc_context->coded_frame->key_frame = !(o_packet.granulepos & h->keyframe_mask);
344 if (avc_context->coded_frame->key_frame)
345 pkt->flags |= AV_PKT_FLAG_KEY;
351 static av_cold int encode_close(AVCodecContext* avc_context)
353 TheoraContext *h = avc_context->priv_data;
355 th_encode_free(h->t_state);
357 av_freep(&avc_context->coded_frame);
358 av_freep(&avc_context->stats_out);
359 av_freep(&avc_context->extradata);
360 avc_context->extradata_size = 0;
365 /** AVCodec struct exposed to libavcodec */
366 AVCodec ff_libtheora_encoder = {
368 .long_name = NULL_IF_CONFIG_SMALL("libtheora Theora"),
369 .type = AVMEDIA_TYPE_VIDEO,
370 .id = AV_CODEC_ID_THEORA,
371 .priv_data_size = sizeof(TheoraContext),
373 .close = encode_close,
374 .encode2 = encode_frame,
375 .capabilities = CODEC_CAP_DELAY, // needed to get the statsfile summary
376 .pix_fmts = (const enum AVPixelFormat[]){
377 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE