2 * Dirac encoder support via Schroedinger libraries
3 * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 * Dirac encoder support via libschroedinger-1.0 libraries. More details about
25 * the Schroedinger project can be found at http://www.diracvideo.org/.
26 * The library implements Dirac Specification Version 2.2
27 * (http://dirac.sourceforge.net/specification.html).
33 #include <schroedinger/schro.h>
34 #include <schroedinger/schrodebug.h>
35 #include <schroedinger/schrovideoformat.h>
38 #include "libdirac_libschro.h"
39 #include "libschroedinger.h"
42 /** libschroedinger encoder private data */
43 typedef struct FfmpegSchroEncoderParams {
44 /** Schroedinger video format */
45 SchroVideoFormat *format;
47 /** Schroedinger frame format */
48 SchroFrameFormat frame_format;
50 /** frame being encoded */
56 /** Schroedinger encoder handle*/
57 SchroEncoder* encoder;
59 /** buffer to store encoder output before writing it to the frame queue*/
60 unsigned char *enc_buf;
62 /** Size of encoder buffer*/
65 /** queue storing encoded frames */
66 FfmpegDiracSchroQueue enc_frame_queue;
68 /** end of sequence signalled */
71 /** end of sequence pulled */
73 } FfmpegSchroEncoderParams;
76 * Works out Schro-compatible chroma format.
78 static int SetSchroChromaFormat(AVCodecContext *avccontext)
80 int num_formats = sizeof(ffmpeg_schro_pixel_format_map) /
81 sizeof(ffmpeg_schro_pixel_format_map[0]);
84 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
86 for (idx = 0; idx < num_formats; ++idx) {
87 if (ffmpeg_schro_pixel_format_map[idx].ff_pix_fmt ==
88 avccontext->pix_fmt) {
89 p_schro_params->format->chroma_format =
90 ffmpeg_schro_pixel_format_map[idx].schro_pix_fmt;
95 av_log(avccontext, AV_LOG_ERROR,
96 "This codec currently only supports planar YUV 4:2:0, 4:2:2"
97 " and 4:4:4 formats.\n");
102 static int libschroedinger_encode_init(AVCodecContext *avccontext)
104 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
105 SchroVideoFormatEnum preset;
107 /* Initialize the libraries that libschroedinger depends on. */
110 /* Create an encoder object. */
111 p_schro_params->encoder = schro_encoder_new();
113 if (!p_schro_params->encoder) {
114 av_log(avccontext, AV_LOG_ERROR,
115 "Unrecoverable Error: schro_encoder_new failed. ");
119 /* Initialize the format. */
120 preset = ff_get_schro_video_format_preset(avccontext);
121 p_schro_params->format =
122 schro_encoder_get_video_format(p_schro_params->encoder);
123 schro_video_format_set_std_video_format(p_schro_params->format, preset);
124 p_schro_params->format->width = avccontext->width;
125 p_schro_params->format->height = avccontext->height;
127 if (SetSchroChromaFormat(avccontext) == -1)
130 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
131 &p_schro_params->frame_format) == -1) {
132 av_log(avccontext, AV_LOG_ERROR,
133 "This codec currently supports only planar YUV 4:2:0, 4:2:2"
134 " and 4:4:4 formats.\n");
138 p_schro_params->format->frame_rate_numerator = avccontext->time_base.den;
139 p_schro_params->format->frame_rate_denominator = avccontext->time_base.num;
141 p_schro_params->frame_size = avpicture_get_size(avccontext->pix_fmt,
145 avccontext->coded_frame = &p_schro_params->picture;
147 if (!avccontext->gop_size) {
148 schro_encoder_setting_set_double(p_schro_params->encoder,
150 SCHRO_ENCODER_GOP_INTRA_ONLY);
152 if (avccontext->coder_type == FF_CODER_TYPE_VLC)
153 schro_encoder_setting_set_double(p_schro_params->encoder,
154 "enable_noarith", 1);
156 avccontext->has_b_frames = 1;
159 /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
160 if (avccontext->flags & CODEC_FLAG_QSCALE) {
161 if (!avccontext->global_quality) {
162 /* lossless coding */
163 schro_encoder_setting_set_double(p_schro_params->encoder,
165 SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
168 schro_encoder_setting_set_double(p_schro_params->encoder,
170 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
172 quality = avccontext->global_quality / FF_QP2LAMBDA;
175 schro_encoder_setting_set_double(p_schro_params->encoder,
179 schro_encoder_setting_set_double(p_schro_params->encoder,
181 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
183 schro_encoder_setting_set_double(p_schro_params->encoder,
185 avccontext->bit_rate);
189 if (avccontext->flags & CODEC_FLAG_INTERLACED_ME)
190 /* All material can be coded as interlaced or progressive
191 irrespective of the type of source material. */
192 schro_encoder_setting_set_double(p_schro_params->encoder,
193 "interlaced_coding", 1);
195 /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
196 * and libdirac support other bit-depth data. */
197 schro_video_format_set_std_signal_range(p_schro_params->format,
198 SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
200 /* Set the encoder format. */
201 schro_encoder_set_video_format(p_schro_params->encoder,
202 p_schro_params->format);
204 /* Set the debug level. */
205 schro_debug_set_level(avccontext->debug);
207 schro_encoder_start(p_schro_params->encoder);
209 /* Initialize the encoded frame queue. */
210 ff_dirac_schro_queue_init(&p_schro_params->enc_frame_queue);
214 static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avccontext,
217 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
218 SchroFrame *in_frame;
219 /* Input line size may differ from what the codec supports. Especially
220 * when transcoding from one format to another. So use avpicture_layout
221 * to copy the frame. */
222 in_frame = ff_create_schro_frame(avccontext, p_schro_params->frame_format);
225 avpicture_layout((AVPicture *)in_data, avccontext->pix_fmt,
226 avccontext->width, avccontext->height,
227 in_frame->components[0].data,
228 p_schro_params->frame_size);
233 static void SchroedingerFreeFrame(void *data)
235 FfmpegDiracSchroEncodedFrame *enc_frame = data;
237 av_freep(&(enc_frame->p_encbuf));
241 static int libschroedinger_encode_frame(AVCodecContext *avccontext,
242 unsigned char *frame,
243 int buf_size, void *data)
246 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
247 SchroEncoder *encoder = p_schro_params->encoder;
248 struct FfmpegDiracSchroEncodedFrame* p_frame_output = NULL;
250 SchroBuffer *enc_buf;
251 int presentation_frame;
253 int last_frame_in_sequence = 0;
256 /* Push end of sequence if not already signalled. */
257 if (!p_schro_params->eos_signalled) {
258 schro_encoder_end_of_stream(encoder);
259 p_schro_params->eos_signalled = 1;
262 /* Allocate frame data to schro input buffer. */
263 SchroFrame *in_frame = libschroedinger_frame_from_data(avccontext,
265 /* Load next frame. */
266 schro_encoder_push_frame(encoder, in_frame);
269 if (p_schro_params->eos_pulled)
272 /* Now check to see if we have any output from the encoder. */
274 SchroStateEnum state;
275 state = schro_encoder_wait(encoder);
277 case SCHRO_STATE_HAVE_BUFFER:
278 case SCHRO_STATE_END_OF_STREAM:
279 enc_buf = schro_encoder_pull(encoder, &presentation_frame);
280 assert(enc_buf->length > 0);
281 assert(enc_buf->length <= buf_size);
282 parse_code = enc_buf->data[4];
284 /* All non-frame data is prepended to actual frame data to
285 * be able to set the pts correctly. So we don't write data
286 * to the frame output queue until we actually have a frame
288 p_schro_params->enc_buf = av_realloc(p_schro_params->enc_buf,
289 p_schro_params->enc_buf_size + enc_buf->length);
291 memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
292 enc_buf->data, enc_buf->length);
293 p_schro_params->enc_buf_size += enc_buf->length;
296 if (state == SCHRO_STATE_END_OF_STREAM) {
297 p_schro_params->eos_pulled = 1;
301 if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
302 schro_buffer_unref(enc_buf);
306 /* Create output frame. */
307 p_frame_output = av_mallocz(sizeof(FfmpegDiracSchroEncodedFrame));
308 /* Set output data. */
309 p_frame_output->size = p_schro_params->enc_buf_size;
310 p_frame_output->p_encbuf = p_schro_params->enc_buf;
311 if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
312 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
313 p_frame_output->key_frame = 1;
315 /* Parse the coded frame number from the bitstream. Bytes 14
316 * through 17 represesent the frame number. */
317 p_frame_output->frame_num = (enc_buf->data[13] << 24) +
318 (enc_buf->data[14] << 16) +
319 (enc_buf->data[15] << 8) +
322 ff_dirac_schro_queue_push_back(&p_schro_params->enc_frame_queue,
324 p_schro_params->enc_buf_size = 0;
325 p_schro_params->enc_buf = NULL;
327 schro_buffer_unref(enc_buf);
331 case SCHRO_STATE_NEED_FRAME:
335 case SCHRO_STATE_AGAIN:
339 av_log(avccontext, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
344 /* Copy 'next' frame in queue. */
346 if (p_schro_params->enc_frame_queue.size == 1 &&
347 p_schro_params->eos_pulled)
348 last_frame_in_sequence = 1;
350 p_frame_output = ff_dirac_schro_queue_pop(&p_schro_params->enc_frame_queue);
355 memcpy(frame, p_frame_output->p_encbuf, p_frame_output->size);
356 avccontext->coded_frame->key_frame = p_frame_output->key_frame;
357 /* Use the frame number of the encoded frame as the pts. It is OK to
358 * do so since Dirac is a constant frame rate codec. It expects input
359 * to be of constant frame rate. */
360 avccontext->coded_frame->pts = p_frame_output->frame_num;
361 enc_size = p_frame_output->size;
363 /* Append the end of sequence information to the last frame in the
365 if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
366 memcpy(frame + enc_size, p_schro_params->enc_buf,
367 p_schro_params->enc_buf_size);
368 enc_size += p_schro_params->enc_buf_size;
369 av_freep(&p_schro_params->enc_buf);
370 p_schro_params->enc_buf_size = 0;
374 SchroedingerFreeFrame(p_frame_output);
380 static int libschroedinger_encode_close(AVCodecContext *avccontext)
383 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
385 /* Close the encoder. */
386 schro_encoder_free(p_schro_params->encoder);
388 /* Free data in the output frame queue. */
389 ff_dirac_schro_queue_free(&p_schro_params->enc_frame_queue,
390 SchroedingerFreeFrame);
393 /* Free the encoder buffer. */
394 if (p_schro_params->enc_buf_size)
395 av_freep(&p_schro_params->enc_buf);
397 /* Free the video format structure. */
398 av_freep(&p_schro_params->format);
404 AVCodec libschroedinger_encoder = {
408 sizeof(FfmpegSchroEncoderParams),
409 libschroedinger_encode_init,
410 libschroedinger_encode_frame,
411 libschroedinger_encode_close,
412 .capabilities = CODEC_CAP_DELAY,
413 .pix_fmts = (const enum PixelFormat[]){PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P, PIX_FMT_NONE},
414 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),