1 /*
2 * Copyright (c) 2006 Paul Richards <paul.richards@gmail.com>
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 * @brief Theora encoder using libtheora.
24 * @author Paul Richards <paul.richards@gmail.com>
25 *
26 * A lot of this is copy / paste from other output codecs in
27 * libavcodec or pure guesswork (or both).
28 *
29 * I have used t_ prefixes on variables which are libtheora types
30 * and o_ prefixes on variables which are libogg types.
31 */
32
33 /* FFmpeg includes */
41
42 /* libtheora includes */
43 #include <theora/theoraenc.h>
44
54
55 /** Concatenate an ogg_packet into the extradata. */
59 {
60 const char* message =
NULL;
63
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";
70 } else {
73 message = "av_realloc failed";
74 }
75 }
76 if (message) {
78 return err;
79 }
80
83 *offset += 2;
84 memcpy(avc_context->
extradata + (*offset), packet->packet, packet->bytes);
85 (*offset) += packet->bytes;
86 return 0;
87 }
88
90 {
91 #ifdef TH_ENCCTL_2PASS_OUT
94 int bytes;
95
96 bytes = th_encode_ctl(h->
t_state, TH_ENCCTL_2PASS_OUT, &buf,
sizeof(buf));
97 if (bytes < 0) {
100 }
101 if (!eos) {
104 if (!tmp)
109 } else {
111 // libtheora generates a summary header at the end
112 memcpy(h->
stats, buf, bytes);
115 }
116 return 0;
117 #else
120 #endif
121 }
122
123 // libtheora won't read the entire buffer we give it at once, so we have to
124 // repeatedly submit it...
126 {
127 #ifdef TH_ENCCTL_2PASS_IN
129 int bytes;
134 }
140 }
142 }
144 bytes = th_encode_ctl(h->
t_state, TH_ENCCTL_2PASS_IN,
147 if (bytes < 0) {
150 }
151 if (!bytes)
152 return 0;
154 }
155 return 0;
156 #else
159 #endif
160 }
161
163 {
164 th_info t_info;
165 th_comment t_comment;
169 uint32_t gop_size = avc_context->
gop_size;
171
172 /* Set up the theora_info struct */
173 th_info_init(&t_info);
176 t_info.pic_width = avc_context->
width;
177 t_info.pic_height = avc_context->
height;
178 t_info.pic_x = 0;
179 t_info.pic_y = 0;
180 /* Swap numerator and denominator as time_base in AVCodecContext gives the
181 * time period between frames, but theora_info needs the framerate. */
187 } else {
188 t_info.aspect_numerator = 1;
189 t_info.aspect_denominator = 1;
190 }
191
193 t_info.colorspace = TH_CS_ITU_REC_470M;
195 t_info.colorspace = TH_CS_ITU_REC_470BG;
196 else
197 t_info.colorspace = TH_CS_UNSPECIFIED;
198
200 t_info.pixel_fmt = TH_PF_420;
202 t_info.pixel_fmt = TH_PF_422;
204 t_info.pixel_fmt = TH_PF_444;
205 else {
208 }
210
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
215 the [0 - 63] range.
216 */
218 t_info.target_bitrate = 0;
219 } else {
220 t_info.target_bitrate = avc_context->
bit_rate;
221 t_info.quality = 0;
222 }
223
224 /* Now initialise libtheora */
225 h->
t_state = th_encode_alloc(&t_info);
229 }
230
232 /* Clear up theora_info struct */
233 th_info_clear(&t_info);
234
235 if (th_encode_ctl(h->
t_state, TH_ENCCTL_SET_KEYFRAME_FREQUENCY_FORCE,
236 &gop_size, sizeof(gop_size))) {
239 }
240
241 // need to enable 2 pass (via TH_ENCCTL_2PASS_) before encoding headers
243 if ((ret =
get_stats(avc_context, 0)) < 0)
248 }
249
250 /*
251 Output first header packet consisting of theora
252 header, comment, and tables.
253
254 Each one is prefixed with a 16bit size, then they
255 are concatenated together into libavcodec's extradata.
256 */
257 offset = 0;
258
259 /* Headers */
260 th_comment_init(&t_comment);
261
262 while (th_encode_flushheader(h->
t_state, &t_comment, &o_packet))
265
266 th_comment_clear(&t_comment);
267
268 /* Set up the output AVFrame */
270
271 return 0;
272 }
273
276 {
277 th_ycbcr_buffer t_yuv_buffer;
281
282 // EOS, finish and get 1st pass stats if applicable
283 if (!frame) {
284 th_encode_packetout(h->
t_state, 1, &o_packet);
286 if ((ret =
get_stats(avc_context, 1)) < 0)
288 return 0;
289 }
290
291 /* Copy planes to the theora yuv_buffer */
292 for (i = 0; i < 3; i++) {
295 t_yuv_buffer[i].stride = frame->
linesize[i];
296 t_yuv_buffer[i].data = frame->
data[i];
297 }
298
301 return ret;
302
303 /* Now call into theora_encode_YUVin */
304 result = th_encode_ycbcr_in(h->
t_state, t_yuv_buffer);
305 if (result) {
306 const char* message;
307 switch (result) {
308 case -1:
309 message = "differing frame sizes";
310 break;
311 case TH_EINVAL:
312 message = "encoder is not ready or is finished";
313 break;
314 default:
315 message = "unknown reason";
316 break;
317 }
318 av_log(avc_context,
AV_LOG_ERROR,
"theora_encode_YUVin failed (%s) [%d]\n", message, result);
320 }
321
323 if ((ret =
get_stats(avc_context, 0)) < 0)
325
326 /* Pick up returned ogg_packet */
327 result = th_encode_packetout(h->
t_state, 0, &o_packet);
328 switch (result) {
329 case 0:
330 /* No packet is ready */
331 return 0;
332 case 1:
333 /* Success, we have a packet */
334 break;
335 default:
338 }
339
340 /* Copy ogg_packet content out to buffer */
343 memcpy(pkt->
data, o_packet.packet, o_packet.bytes);
344
345 // HACK: assumes no encoder delay, this is true until libtheora becomes
346 // multithreaded (which will be disabled unless explicitly requested)
351 *got_packet = 1;
352
353 return 0;
354 }
355
357 {
359
366
367 return 0;
368 }
369
370 /** AVCodec struct exposed to libavcodec */
380 .capabilities =
CODEC_CAP_DELAY,
// needed to get the statsfile summary
383 },
384 };