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"
40 #include "bytestream.h"
43 /** libschroedinger encoder private data */
44 typedef struct FfmpegSchroEncoderParams {
45 /** Schroedinger video format */
46 SchroVideoFormat *format;
48 /** Schroedinger frame format */
49 SchroFrameFormat frame_format;
51 /** frame being encoded */
57 /** Schroedinger encoder handle*/
58 SchroEncoder* encoder;
60 /** buffer to store encoder output before writing it to the frame queue*/
61 unsigned char *enc_buf;
63 /** Size of encoder buffer*/
66 /** queue storing encoded frames */
67 FfmpegDiracSchroQueue enc_frame_queue;
69 /** end of sequence signalled */
72 /** end of sequence pulled */
74 } FfmpegSchroEncoderParams;
77 * Works out Schro-compatible chroma format.
79 static int SetSchroChromaFormat(AVCodecContext *avccontext)
81 int num_formats = sizeof(ffmpeg_schro_pixel_format_map) /
82 sizeof(ffmpeg_schro_pixel_format_map[0]);
85 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
87 for (idx = 0; idx < num_formats; ++idx) {
88 if (ffmpeg_schro_pixel_format_map[idx].ff_pix_fmt ==
89 avccontext->pix_fmt) {
90 p_schro_params->format->chroma_format =
91 ffmpeg_schro_pixel_format_map[idx].schro_pix_fmt;
96 av_log(avccontext, AV_LOG_ERROR,
97 "This codec currently only supports planar YUV 4:2:0, 4:2:2"
98 " and 4:4:4 formats.\n");
103 static int libschroedinger_encode_init(AVCodecContext *avccontext)
105 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
106 SchroVideoFormatEnum preset;
108 /* Initialize the libraries that libschroedinger depends on. */
111 /* Create an encoder object. */
112 p_schro_params->encoder = schro_encoder_new();
114 if (!p_schro_params->encoder) {
115 av_log(avccontext, AV_LOG_ERROR,
116 "Unrecoverable Error: schro_encoder_new failed. ");
120 /* Initialize the format. */
121 preset = ff_get_schro_video_format_preset(avccontext);
122 p_schro_params->format =
123 schro_encoder_get_video_format(p_schro_params->encoder);
124 schro_video_format_set_std_video_format(p_schro_params->format, preset);
125 p_schro_params->format->width = avccontext->width;
126 p_schro_params->format->height = avccontext->height;
128 if (SetSchroChromaFormat(avccontext) == -1)
131 if (avccontext->color_primaries == AVCOL_PRI_BT709) {
132 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
133 } else if (avccontext->color_primaries == AVCOL_PRI_BT470BG) {
134 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
135 } else if (avccontext->color_primaries == AVCOL_PRI_SMPTE170M) {
136 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
139 if (avccontext->colorspace == AVCOL_SPC_BT709) {
140 p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
141 } else if (avccontext->colorspace == AVCOL_SPC_BT470BG) {
142 p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
145 if (avccontext->color_trc == AVCOL_TRC_BT709) {
146 p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
149 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
150 &p_schro_params->frame_format) == -1) {
151 av_log(avccontext, AV_LOG_ERROR,
152 "This codec currently supports only planar YUV 4:2:0, 4:2:2"
153 " and 4:4:4 formats.\n");
157 p_schro_params->format->frame_rate_numerator = avccontext->time_base.den;
158 p_schro_params->format->frame_rate_denominator = avccontext->time_base.num;
160 p_schro_params->frame_size = avpicture_get_size(avccontext->pix_fmt,
164 avccontext->coded_frame = &p_schro_params->picture;
166 if (!avccontext->gop_size) {
167 schro_encoder_setting_set_double(p_schro_params->encoder,
169 SCHRO_ENCODER_GOP_INTRA_ONLY);
171 if (avccontext->coder_type == FF_CODER_TYPE_VLC)
172 schro_encoder_setting_set_double(p_schro_params->encoder,
173 "enable_noarith", 1);
175 schro_encoder_setting_set_double(p_schro_params->encoder,
176 "au_distance", avccontext->gop_size);
177 avccontext->has_b_frames = 1;
180 /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
181 if (avccontext->flags & CODEC_FLAG_QSCALE) {
182 if (!avccontext->global_quality) {
183 /* lossless coding */
184 schro_encoder_setting_set_double(p_schro_params->encoder,
186 SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
189 schro_encoder_setting_set_double(p_schro_params->encoder,
191 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
193 quality = avccontext->global_quality / FF_QP2LAMBDA;
196 schro_encoder_setting_set_double(p_schro_params->encoder,
200 schro_encoder_setting_set_double(p_schro_params->encoder,
202 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
204 schro_encoder_setting_set_double(p_schro_params->encoder,
206 avccontext->bit_rate);
210 if (avccontext->flags & CODEC_FLAG_INTERLACED_ME)
211 /* All material can be coded as interlaced or progressive
212 irrespective of the type of source material. */
213 schro_encoder_setting_set_double(p_schro_params->encoder,
214 "interlaced_coding", 1);
216 schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
217 !(avccontext->flags & CODEC_FLAG_CLOSED_GOP));
219 /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
220 * and libdirac support other bit-depth data. */
221 schro_video_format_set_std_signal_range(p_schro_params->format,
222 SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
224 /* Set the encoder format. */
225 schro_encoder_set_video_format(p_schro_params->encoder,
226 p_schro_params->format);
228 /* Set the debug level. */
229 schro_debug_set_level(avccontext->debug);
231 schro_encoder_start(p_schro_params->encoder);
233 /* Initialize the encoded frame queue. */
234 ff_dirac_schro_queue_init(&p_schro_params->enc_frame_queue);
238 static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avccontext,
241 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
242 SchroFrame *in_frame;
243 /* Input line size may differ from what the codec supports. Especially
244 * when transcoding from one format to another. So use avpicture_layout
245 * to copy the frame. */
246 in_frame = ff_create_schro_frame(avccontext, p_schro_params->frame_format);
249 avpicture_layout((AVPicture *)in_data, avccontext->pix_fmt,
250 avccontext->width, avccontext->height,
251 in_frame->components[0].data,
252 p_schro_params->frame_size);
257 static void SchroedingerFreeFrame(void *data)
259 FfmpegDiracSchroEncodedFrame *enc_frame = data;
261 av_freep(&(enc_frame->p_encbuf));
265 static int libschroedinger_encode_frame(AVCodecContext *avccontext,
266 unsigned char *frame,
267 int buf_size, void *data)
270 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
271 SchroEncoder *encoder = p_schro_params->encoder;
272 struct FfmpegDiracSchroEncodedFrame* p_frame_output = NULL;
274 SchroBuffer *enc_buf;
275 int presentation_frame;
277 int last_frame_in_sequence = 0;
280 /* Push end of sequence if not already signalled. */
281 if (!p_schro_params->eos_signalled) {
282 schro_encoder_end_of_stream(encoder);
283 p_schro_params->eos_signalled = 1;
286 /* Allocate frame data to schro input buffer. */
287 SchroFrame *in_frame = libschroedinger_frame_from_data(avccontext,
289 /* Load next frame. */
290 schro_encoder_push_frame(encoder, in_frame);
293 if (p_schro_params->eos_pulled)
296 /* Now check to see if we have any output from the encoder. */
298 SchroStateEnum state;
299 state = schro_encoder_wait(encoder);
301 case SCHRO_STATE_HAVE_BUFFER:
302 case SCHRO_STATE_END_OF_STREAM:
303 enc_buf = schro_encoder_pull(encoder, &presentation_frame);
304 assert(enc_buf->length > 0);
305 assert(enc_buf->length <= buf_size);
306 parse_code = enc_buf->data[4];
308 /* All non-frame data is prepended to actual frame data to
309 * be able to set the pts correctly. So we don't write data
310 * to the frame output queue until we actually have a frame
312 p_schro_params->enc_buf = av_realloc(p_schro_params->enc_buf,
313 p_schro_params->enc_buf_size + enc_buf->length);
315 memcpy(p_schro_params->enc_buf + p_schro_params->enc_buf_size,
316 enc_buf->data, enc_buf->length);
317 p_schro_params->enc_buf_size += enc_buf->length;
320 if (state == SCHRO_STATE_END_OF_STREAM) {
321 p_schro_params->eos_pulled = 1;
325 if (!SCHRO_PARSE_CODE_IS_PICTURE(parse_code)) {
326 schro_buffer_unref(enc_buf);
330 /* Create output frame. */
331 p_frame_output = av_mallocz(sizeof(FfmpegDiracSchroEncodedFrame));
332 /* Set output data. */
333 p_frame_output->size = p_schro_params->enc_buf_size;
334 p_frame_output->p_encbuf = p_schro_params->enc_buf;
335 if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
336 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
337 p_frame_output->key_frame = 1;
339 /* Parse the coded frame number from the bitstream. Bytes 14
340 * through 17 represesent the frame number. */
341 p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
343 ff_dirac_schro_queue_push_back(&p_schro_params->enc_frame_queue,
345 p_schro_params->enc_buf_size = 0;
346 p_schro_params->enc_buf = NULL;
348 schro_buffer_unref(enc_buf);
352 case SCHRO_STATE_NEED_FRAME:
356 case SCHRO_STATE_AGAIN:
360 av_log(avccontext, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
365 /* Copy 'next' frame in queue. */
367 if (p_schro_params->enc_frame_queue.size == 1 &&
368 p_schro_params->eos_pulled)
369 last_frame_in_sequence = 1;
371 p_frame_output = ff_dirac_schro_queue_pop(&p_schro_params->enc_frame_queue);
376 memcpy(frame, p_frame_output->p_encbuf, p_frame_output->size);
377 avccontext->coded_frame->key_frame = p_frame_output->key_frame;
378 /* Use the frame number of the encoded frame as the pts. It is OK to
379 * do so since Dirac is a constant frame rate codec. It expects input
380 * to be of constant frame rate. */
381 avccontext->coded_frame->pts = p_frame_output->frame_num;
382 enc_size = p_frame_output->size;
384 /* Append the end of sequence information to the last frame in the
386 if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
387 memcpy(frame + enc_size, p_schro_params->enc_buf,
388 p_schro_params->enc_buf_size);
389 enc_size += p_schro_params->enc_buf_size;
390 av_freep(&p_schro_params->enc_buf);
391 p_schro_params->enc_buf_size = 0;
395 SchroedingerFreeFrame(p_frame_output);
401 static int libschroedinger_encode_close(AVCodecContext *avccontext)
404 FfmpegSchroEncoderParams* p_schro_params = avccontext->priv_data;
406 /* Close the encoder. */
407 schro_encoder_free(p_schro_params->encoder);
409 /* Free data in the output frame queue. */
410 ff_dirac_schro_queue_free(&p_schro_params->enc_frame_queue,
411 SchroedingerFreeFrame);
414 /* Free the encoder buffer. */
415 if (p_schro_params->enc_buf_size)
416 av_freep(&p_schro_params->enc_buf);
418 /* Free the video format structure. */
419 av_freep(&p_schro_params->format);
425 AVCodec libschroedinger_encoder = {
429 sizeof(FfmpegSchroEncoderParams),
430 libschroedinger_encode_init,
431 libschroedinger_encode_frame,
432 libschroedinger_encode_close,
433 .capabilities = CODEC_CAP_DELAY,
434 .pix_fmts = (const enum PixelFormat[]){PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P, PIX_FMT_NONE},
435 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),