2 * Copyright (c) 2006 Paul Richards <paul.richards@gmail.com>
4 * This file is part of FFmpeg.
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.
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.
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
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 int newsize = avc_context->extradata_size + 2 + packet->bytes;
62 int err = AVERROR_INVALIDDATA;
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 if ((err = av_reallocp(&avc_context->extradata, newsize)) < 0) {
72 avc_context->extradata_size = 0;
73 message = "av_realloc failed";
77 av_log(avc_context, AV_LOG_ERROR, "concatenate_packet failed: %s\n", message);
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");
99 return AVERROR_EXTERNAL;
102 void *tmp = av_fast_realloc(h->stats, &h->stats_size,
103 h->stats_offset + bytes);
105 return AVERROR(ENOMEM);
107 memcpy(h->stats + h->stats_offset, buf, bytes);
108 h->stats_offset += bytes;
110 int b64_size = AV_BASE64_SIZE(h->stats_offset);
111 // libtheora generates a summary header at the end
112 memcpy(h->stats, buf, bytes);
113 avctx->stats_out = av_malloc(b64_size);
114 av_base64_encode(avctx->stats_out, b64_size, h->stats, h->stats_offset);
118 av_log(avctx, AV_LOG_ERROR, "libtheora too old to support 2pass\n");
119 return AVERROR(ENOSUP);
123 // libtheora won't read the entire buffer we give it at once, so we have to
124 // repeatedly submit it...
125 static int submit_stats(AVCodecContext *avctx)
127 #ifdef TH_ENCCTL_2PASS_IN
128 TheoraContext *h = avctx->priv_data;
131 if (!avctx->stats_in) {
132 av_log(avctx, AV_LOG_ERROR, "No statsfile for second pass\n");
133 return AVERROR(EINVAL);
135 h->stats_size = strlen(avctx->stats_in) * 3/4;
136 h->stats = av_malloc(h->stats_size);
139 return AVERROR(ENOMEM);
141 h->stats_size = av_base64_decode(h->stats, avctx->stats_in, h->stats_size);
143 while (h->stats_size - h->stats_offset > 0) {
144 bytes = th_encode_ctl(h->t_state, TH_ENCCTL_2PASS_IN,
145 h->stats + h->stats_offset,
146 h->stats_size - h->stats_offset);
148 av_log(avctx, AV_LOG_ERROR, "Error submitting stats\n");
149 return AVERROR_EXTERNAL;
153 h->stats_offset += bytes;
157 av_log(avctx, AV_LOG_ERROR, "libtheora too old to support 2pass\n");
158 return AVERROR(ENOSUP);
162 static av_cold int encode_init(AVCodecContext* avc_context)
165 th_comment t_comment;
168 TheoraContext *h = avc_context->priv_data;
169 uint32_t gop_size = avc_context->gop_size;
172 /* Set up the theora_info struct */
173 th_info_init(&t_info);
174 t_info.frame_width = FFALIGN(avc_context->width, 16);
175 t_info.frame_height = FFALIGN(avc_context->height, 16);
176 t_info.pic_width = avc_context->width;
177 t_info.pic_height = avc_context->height;
180 /* Swap numerator and denominator as time_base in AVCodecContext gives the
181 * time period between frames, but theora_info needs the framerate. */
182 t_info.fps_numerator = avc_context->time_base.den;
183 t_info.fps_denominator = avc_context->time_base.num;
184 if (avc_context->sample_aspect_ratio.num) {
185 t_info.aspect_numerator = avc_context->sample_aspect_ratio.num;
186 t_info.aspect_denominator = avc_context->sample_aspect_ratio.den;
188 t_info.aspect_numerator = 1;
189 t_info.aspect_denominator = 1;
192 if (avc_context->color_primaries == AVCOL_PRI_BT470M)
193 t_info.colorspace = TH_CS_ITU_REC_470M;
194 else if (avc_context->color_primaries == AVCOL_PRI_BT470BG)
195 t_info.colorspace = TH_CS_ITU_REC_470BG;
197 t_info.colorspace = TH_CS_UNSPECIFIED;
199 if (avc_context->pix_fmt == AV_PIX_FMT_YUV420P)
200 t_info.pixel_fmt = TH_PF_420;
201 else if (avc_context->pix_fmt == AV_PIX_FMT_YUV422P)
202 t_info.pixel_fmt = TH_PF_422;
203 else if (avc_context->pix_fmt == AV_PIX_FMT_YUV444P)
204 t_info.pixel_fmt = TH_PF_444;
206 av_log(avc_context, AV_LOG_ERROR, "Unsupported pix_fmt\n");
207 return AVERROR(EINVAL);
209 avcodec_get_chroma_sub_sample(avc_context->pix_fmt, &h->uv_hshift, &h->uv_vshift);
211 if (avc_context->flags & CODEC_FLAG_QSCALE) {
212 /* Clip global_quality in QP units to the [0 - 10] range
213 to be consistent with the libvorbis implementation.
214 Theora accepts a quality parameter which is an int value in
217 t_info.quality = av_clipf(avc_context->global_quality / (float)FF_QP2LAMBDA, 0, 10) * 6.3;
218 t_info.target_bitrate = 0;
220 t_info.target_bitrate = avc_context->bit_rate;
224 /* Now initialise libtheora */
225 h->t_state = th_encode_alloc(&t_info);
227 av_log(avc_context, AV_LOG_ERROR, "theora_encode_init failed\n");
228 return AVERROR_EXTERNAL;
231 h->keyframe_mask = (1 << t_info.keyframe_granule_shift) - 1;
232 /* Clear up theora_info struct */
233 th_info_clear(&t_info);
235 if (th_encode_ctl(h->t_state, TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE,
236 &gop_size, sizeof(gop_size))) {
237 av_log(avc_context, AV_LOG_ERROR, "Error setting GOP size\n");
238 return AVERROR_EXTERNAL;
241 // need to enable 2 pass (via TH_ENCCTL_2PASS_) before encoding headers
242 if (avc_context->flags & CODEC_FLAG_PASS1) {
243 if ((ret = get_stats(avc_context, 0)) < 0)
245 } else if (avc_context->flags & CODEC_FLAG_PASS2) {
246 if ((ret = submit_stats(avc_context)) < 0)
251 Output first header packet consisting of theora
252 header, comment, and tables.
254 Each one is prefixed with a 16bit size, then they
255 are concatenated together into libavcodec's extradata.
260 th_comment_init(&t_comment);
262 while (th_encode_flushheader(h->t_state, &t_comment, &o_packet))
263 if ((ret = concatenate_packet(&offset, avc_context, &o_packet)) < 0)
266 th_comment_clear(&t_comment);
268 /* Set up the output AVFrame */
269 avc_context->coded_frame = av_frame_alloc();
270 if (!avc_context->coded_frame)
271 return AVERROR(ENOMEM);
276 static int encode_frame(AVCodecContext* avc_context, AVPacket *pkt,
277 const AVFrame *frame, int *got_packet)
279 th_ycbcr_buffer t_yuv_buffer;
280 TheoraContext *h = avc_context->priv_data;
284 // EOS, finish and get 1st pass stats if applicable
286 th_encode_packetout(h->t_state, 1, &o_packet);
287 if (avc_context->flags & CODEC_FLAG_PASS1)
288 if ((ret = get_stats(avc_context, 1)) < 0)
293 /* Copy planes to the theora yuv_buffer */
294 for (i = 0; i < 3; i++) {
295 t_yuv_buffer[i].width = FFALIGN(avc_context->width, 16) >> (i && h->uv_hshift);
296 t_yuv_buffer[i].height = FFALIGN(avc_context->height, 16) >> (i && h->uv_vshift);
297 t_yuv_buffer[i].stride = frame->linesize[i];
298 t_yuv_buffer[i].data = frame->data[i];
301 if (avc_context->flags & CODEC_FLAG_PASS2)
302 if ((ret = submit_stats(avc_context)) < 0)
305 /* Now call into theora_encode_YUVin */
306 result = th_encode_ycbcr_in(h->t_state, t_yuv_buffer);
311 message = "differing frame sizes";
314 message = "encoder is not ready or is finished";
317 message = "unknown reason";
320 av_log(avc_context, AV_LOG_ERROR, "theora_encode_YUVin failed (%s) [%d]\n", message, result);
321 return AVERROR_EXTERNAL;
324 if (avc_context->flags & CODEC_FLAG_PASS1)
325 if ((ret = get_stats(avc_context, 0)) < 0)
328 /* Pick up returned ogg_packet */
329 result = th_encode_packetout(h->t_state, 0, &o_packet);
332 /* No packet is ready */
335 /* Success, we have a packet */
338 av_log(avc_context, AV_LOG_ERROR, "theora_encode_packetout failed [%d]\n", result);
339 return AVERROR_EXTERNAL;
342 /* Copy ogg_packet content out to buffer */
343 if ((ret = ff_alloc_packet2(avc_context, pkt, o_packet.bytes)) < 0)
345 memcpy(pkt->data, o_packet.packet, o_packet.bytes);
347 // HACK: assumes no encoder delay, this is true until libtheora becomes
348 // multithreaded (which will be disabled unless explicitly requested)
349 pkt->pts = pkt->dts = frame->pts;
350 avc_context->coded_frame->key_frame = !(o_packet.granulepos & h->keyframe_mask);
351 if (avc_context->coded_frame->key_frame)
352 pkt->flags |= AV_PKT_FLAG_KEY;
358 static av_cold int encode_close(AVCodecContext* avc_context)
360 TheoraContext *h = avc_context->priv_data;
362 th_encode_free(h->t_state);
364 av_frame_free(&avc_context->coded_frame);
365 av_freep(&avc_context->stats_out);
366 av_freep(&avc_context->extradata);
367 avc_context->extradata_size = 0;
372 /** AVCodec struct exposed to libavcodec */
373 AVCodec ff_libtheora_encoder = {
375 .long_name = NULL_IF_CONFIG_SMALL("libtheora Theora"),
376 .type = AVMEDIA_TYPE_VIDEO,
377 .id = AV_CODEC_ID_THEORA,
378 .priv_data_size = sizeof(TheoraContext),
380 .close = encode_close,
381 .encode2 = encode_frame,
382 .capabilities = CODEC_CAP_DELAY, // needed to get the statsfile summary
383 .pix_fmts = (const enum AVPixelFormat[]){
384 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE