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 Libav.
7 * Libav 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 * Libav 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 Libav; 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).
30 #include <schroedinger/schro.h>
31 #include <schroedinger/schrodebug.h>
32 #include <schroedinger/schrovideoformat.h>
34 #include "libavutil/attributes.h"
37 #include "libschroedinger.h"
38 #include "bytestream.h"
41 /** libschroedinger encoder private data */
42 typedef struct SchroEncoderParams {
43 /** Schroedinger video format */
44 SchroVideoFormat *format;
46 /** Schroedinger frame format */
47 SchroFrameFormat frame_format;
52 /** Schroedinger encoder handle*/
53 SchroEncoder* encoder;
55 /** buffer to store encoder output before writing it to the frame queue*/
56 unsigned char *enc_buf;
58 /** Size of encoder buffer*/
61 /** queue storing encoded frames */
62 FFSchroQueue enc_frame_queue;
64 /** end of sequence signalled */
67 /** end of sequence pulled */
70 /* counter for frames submitted to encoder, used as dts */
75 * Works out Schro-compatible chroma format.
77 static int set_chroma_format(AVCodecContext *avctx)
79 int num_formats = sizeof(schro_pixel_format_map) /
80 sizeof(schro_pixel_format_map[0]);
83 SchroEncoderParams *p_schro_params = avctx->priv_data;
85 for (idx = 0; idx < num_formats; ++idx) {
86 if (schro_pixel_format_map[idx].ff_pix_fmt == avctx->pix_fmt) {
87 p_schro_params->format->chroma_format =
88 schro_pixel_format_map[idx].schro_pix_fmt;
93 av_log(avctx, AV_LOG_ERROR,
94 "This codec currently only supports planar YUV 4:2:0, 4:2:2"
95 " and 4:4:4 formats.\n");
100 static av_cold int libschroedinger_encode_init(AVCodecContext *avctx)
102 SchroEncoderParams *p_schro_params = avctx->priv_data;
103 SchroVideoFormatEnum preset;
105 /* Initialize the libraries that libschroedinger depends on. */
108 /* Create an encoder object. */
109 p_schro_params->encoder = schro_encoder_new();
111 if (!p_schro_params->encoder) {
112 av_log(avctx, AV_LOG_ERROR,
113 "Unrecoverable Error: schro_encoder_new failed. ");
117 /* Initialize the format. */
118 preset = ff_get_schro_video_format_preset(avctx);
119 p_schro_params->format =
120 schro_encoder_get_video_format(p_schro_params->encoder);
121 schro_video_format_set_std_video_format(p_schro_params->format, preset);
122 p_schro_params->format->width = avctx->width;
123 p_schro_params->format->height = avctx->height;
125 if (set_chroma_format(avctx) == -1)
128 if (avctx->color_primaries == AVCOL_PRI_BT709) {
129 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_HDTV;
130 } else if (avctx->color_primaries == AVCOL_PRI_BT470BG) {
131 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_625;
132 } else if (avctx->color_primaries == AVCOL_PRI_SMPTE170M) {
133 p_schro_params->format->colour_primaries = SCHRO_COLOUR_PRIMARY_SDTV_525;
136 if (avctx->colorspace == AVCOL_SPC_BT709) {
137 p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_HDTV;
138 } else if (avctx->colorspace == AVCOL_SPC_BT470BG) {
139 p_schro_params->format->colour_matrix = SCHRO_COLOUR_MATRIX_SDTV;
142 if (avctx->color_trc == AVCOL_TRC_BT709) {
143 p_schro_params->format->transfer_function = SCHRO_TRANSFER_CHAR_TV_GAMMA;
146 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
147 &p_schro_params->frame_format) == -1) {
148 av_log(avctx, AV_LOG_ERROR,
149 "This codec currently supports only planar YUV 4:2:0, 4:2:2"
150 " and 4:4:4 formats.\n");
154 p_schro_params->format->frame_rate_numerator = avctx->time_base.den;
155 p_schro_params->format->frame_rate_denominator = avctx->time_base.num;
157 p_schro_params->frame_size = avpicture_get_size(avctx->pix_fmt,
161 if (!avctx->gop_size) {
162 schro_encoder_setting_set_double(p_schro_params->encoder,
164 SCHRO_ENCODER_GOP_INTRA_ONLY);
166 if (avctx->coder_type == FF_CODER_TYPE_VLC)
167 schro_encoder_setting_set_double(p_schro_params->encoder,
168 "enable_noarith", 1);
170 schro_encoder_setting_set_double(p_schro_params->encoder,
171 "au_distance", avctx->gop_size);
172 avctx->has_b_frames = 1;
173 p_schro_params->dts = -1;
176 /* FIXME - Need to handle SCHRO_ENCODER_RATE_CONTROL_LOW_DELAY. */
177 if (avctx->flags & AV_CODEC_FLAG_QSCALE) {
178 if (!avctx->global_quality) {
179 /* lossless coding */
180 schro_encoder_setting_set_double(p_schro_params->encoder,
182 SCHRO_ENCODER_RATE_CONTROL_LOSSLESS);
185 schro_encoder_setting_set_double(p_schro_params->encoder,
187 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_QUALITY);
189 quality = avctx->global_quality / FF_QP2LAMBDA;
192 schro_encoder_setting_set_double(p_schro_params->encoder,
196 schro_encoder_setting_set_double(p_schro_params->encoder,
198 SCHRO_ENCODER_RATE_CONTROL_CONSTANT_BITRATE);
200 schro_encoder_setting_set_double(p_schro_params->encoder,
201 "bitrate", avctx->bit_rate);
204 if (avctx->flags & AV_CODEC_FLAG_INTERLACED_ME)
205 /* All material can be coded as interlaced or progressive
206 irrespective of the type of source material. */
207 schro_encoder_setting_set_double(p_schro_params->encoder,
208 "interlaced_coding", 1);
210 schro_encoder_setting_set_double(p_schro_params->encoder, "open_gop",
211 !(avctx->flags & AV_CODEC_FLAG_CLOSED_GOP));
213 /* FIXME: Signal range hardcoded to 8-bit data until both libschroedinger
214 * and libdirac support other bit-depth data. */
215 schro_video_format_set_std_signal_range(p_schro_params->format,
216 SCHRO_SIGNAL_RANGE_8BIT_VIDEO);
218 /* Set the encoder format. */
219 schro_encoder_set_video_format(p_schro_params->encoder,
220 p_schro_params->format);
222 /* Set the debug level. */
223 schro_debug_set_level(avctx->debug);
225 schro_encoder_start(p_schro_params->encoder);
227 /* Initialize the encoded frame queue. */
228 ff_schro_queue_init(&p_schro_params->enc_frame_queue);
232 static SchroFrame *libschroedinger_frame_from_data(AVCodecContext *avctx,
233 const AVFrame *frame)
235 SchroEncoderParams *p_schro_params = avctx->priv_data;
236 SchroFrame *in_frame;
237 /* Input line size may differ from what the codec supports. Especially
238 * when transcoding from one format to another. So use avpicture_layout
239 * to copy the frame. */
240 in_frame = ff_create_schro_frame(avctx, p_schro_params->frame_format);
243 avpicture_layout((const AVPicture *)frame, avctx->pix_fmt,
244 avctx->width, avctx->height,
245 in_frame->components[0].data,
246 p_schro_params->frame_size);
251 static void libschroedinger_free_frame(void *data)
253 FFSchroEncodedFrame *enc_frame = data;
255 av_freep(&enc_frame->p_encbuf);
259 static int libschroedinger_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
260 const AVFrame *frame, int *got_packet)
263 SchroEncoderParams *p_schro_params = avctx->priv_data;
264 SchroEncoder *encoder = p_schro_params->encoder;
265 struct FFSchroEncodedFrame *p_frame_output = NULL;
267 SchroBuffer *enc_buf;
268 int presentation_frame;
270 int last_frame_in_sequence = 0;
274 /* Push end of sequence if not already signalled. */
275 if (!p_schro_params->eos_signalled) {
276 schro_encoder_end_of_stream(encoder);
277 p_schro_params->eos_signalled = 1;
280 /* Allocate frame data to schro input buffer. */
281 SchroFrame *in_frame = libschroedinger_frame_from_data(avctx, frame);
283 return AVERROR(ENOMEM);
284 /* Load next frame. */
285 schro_encoder_push_frame(encoder, in_frame);
288 if (p_schro_params->eos_pulled)
291 /* Now check to see if we have any output from the encoder. */
294 SchroStateEnum state;
295 state = schro_encoder_wait(encoder);
297 case SCHRO_STATE_HAVE_BUFFER:
298 case SCHRO_STATE_END_OF_STREAM:
299 enc_buf = schro_encoder_pull(encoder, &presentation_frame);
300 if (enc_buf->length <= 0)
302 parse_code = enc_buf->data[4];
304 /* All non-frame data is prepended to actual frame data to
305 * be able to set the pts correctly. So we don't write data
306 * to the frame output queue until we actually have a frame
308 if ((err = av_reallocp(&p_schro_params->enc_buf,
309 p_schro_params->enc_buf_size +
310 enc_buf->length)) < 0) {
311 p_schro_params->enc_buf_size = 0;
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(FFSchroEncodedFrame));
333 return AVERROR(ENOMEM);
334 /* Set output data. */
335 p_frame_output->size = p_schro_params->enc_buf_size;
336 p_frame_output->p_encbuf = p_schro_params->enc_buf;
337 if (SCHRO_PARSE_CODE_IS_INTRA(parse_code) &&
338 SCHRO_PARSE_CODE_IS_REFERENCE(parse_code))
339 p_frame_output->key_frame = 1;
341 /* Parse the coded frame number from the bitstream. Bytes 14
342 * through 17 represesent the frame number. */
343 p_frame_output->frame_num = AV_RB32(enc_buf->data + 13);
345 ff_schro_queue_push_back(&p_schro_params->enc_frame_queue,
347 p_schro_params->enc_buf_size = 0;
348 p_schro_params->enc_buf = NULL;
350 schro_buffer_unref(enc_buf);
354 case SCHRO_STATE_NEED_FRAME:
358 case SCHRO_STATE_AGAIN:
362 av_log(avctx, AV_LOG_ERROR, "Unknown Schro Encoder state\n");
367 /* Copy 'next' frame in queue. */
369 if (p_schro_params->enc_frame_queue.size == 1 &&
370 p_schro_params->eos_pulled)
371 last_frame_in_sequence = 1;
373 p_frame_output = ff_schro_queue_pop(&p_schro_params->enc_frame_queue);
378 pkt_size = p_frame_output->size;
379 if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0)
380 pkt_size += p_schro_params->enc_buf_size;
381 if ((ret = ff_alloc_packet(pkt, pkt_size)) < 0) {
382 av_log(avctx, AV_LOG_ERROR, "Error getting output packet of size %d.\n", pkt_size);
386 memcpy(pkt->data, p_frame_output->p_encbuf, p_frame_output->size);
387 #if FF_API_CODED_FRAME
388 FF_DISABLE_DEPRECATION_WARNINGS
389 avctx->coded_frame->key_frame = p_frame_output->key_frame;
390 avctx->coded_frame->pts = p_frame_output->frame_num;
391 FF_ENABLE_DEPRECATION_WARNINGS
393 /* Use the frame number of the encoded frame as the pts. It is OK to
394 * do so since Dirac is a constant frame rate codec. It expects input
395 * to be of constant frame rate. */
396 pkt->pts = p_frame_output->frame_num;
397 pkt->dts = p_schro_params->dts++;
398 enc_size = p_frame_output->size;
400 /* Append the end of sequence information to the last frame in the
402 if (last_frame_in_sequence && p_schro_params->enc_buf_size > 0) {
403 memcpy(pkt->data + enc_size, p_schro_params->enc_buf,
404 p_schro_params->enc_buf_size);
405 enc_size += p_schro_params->enc_buf_size;
406 av_freep(&p_schro_params->enc_buf);
407 p_schro_params->enc_buf_size = 0;
410 if (p_frame_output->key_frame)
411 pkt->flags |= AV_PKT_FLAG_KEY;
416 libschroedinger_free_frame(p_frame_output);
421 static int libschroedinger_encode_close(AVCodecContext *avctx)
423 SchroEncoderParams *p_schro_params = avctx->priv_data;
425 /* Close the encoder. */
426 schro_encoder_free(p_schro_params->encoder);
428 /* Free data in the output frame queue. */
429 ff_schro_queue_free(&p_schro_params->enc_frame_queue,
430 libschroedinger_free_frame);
433 /* Free the encoder buffer. */
434 if (p_schro_params->enc_buf_size)
435 av_freep(&p_schro_params->enc_buf);
437 /* Free the video format structure. */
438 av_freep(&p_schro_params->format);
444 AVCodec ff_libschroedinger_encoder = {
445 .name = "libschroedinger",
446 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
447 .type = AVMEDIA_TYPE_VIDEO,
448 .id = AV_CODEC_ID_DIRAC,
449 .priv_data_size = sizeof(SchroEncoderParams),
450 .init = libschroedinger_encode_init,
451 .encode2 = libschroedinger_encode_frame,
452 .close = libschroedinger_encode_close,
453 .capabilities = AV_CODEC_CAP_DELAY,
454 .pix_fmts = (const enum AVPixelFormat[]){
455 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_NONE