2 * Dirac encoding support via libdirac library
3 * Copyright (c) 2005 BBC, Andrew Kennedy <dirac at rd dot bbc dot co dot uk>
4 * Copyright (c) 2006-2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
6 * This file is part of FFmpeg.
8 * FFmpeg is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
13 * FFmpeg is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with FFmpeg; if not, write to the Free Software
20 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
25 * Dirac encoding support via libdirac library; more details about the
26 * Dirac project can be found at http://dirac.sourceforge.net/.
27 * The libdirac_encoder library implements Dirac specification version 2.2
28 * (http://dirac.sourceforge.net/specification.html).
31 #include "libdirac_libschro.h"
38 #include <libdirac_encoder/dirac_encoder.h>
40 /** Dirac encoder private data */
41 typedef struct FfmpegDiracEncoderParams
43 /** Dirac encoder context */
44 dirac_encoder_context_t enc_ctx;
46 /** frame being encoded */
52 /** Dirac encoder handle */
53 dirac_encoder_t* p_encoder;
55 /** input frame buffer */
56 unsigned char *p_in_frame_buf;
58 /** buffer to store encoder output before writing it to the frame queue */
59 unsigned char *enc_buf;
61 /** size of encoder buffer */
64 /** queue storing encoded frames */
65 FfmpegDiracSchroQueue enc_frame_queue;
67 /** end of sequence signalled by user, 0 - false, 1 - true */
70 /** end of sequence returned by encoder, 0 - false, 1 - true */
72 } FfmpegDiracEncoderParams;
75 * Works out Dirac-compatible chroma format.
77 static dirac_chroma_t GetDiracChromaFormat(enum PixelFormat ff_pix_fmt)
79 int num_formats = sizeof(ffmpeg_dirac_pixel_format_map) /
80 sizeof(ffmpeg_dirac_pixel_format_map[0]);
83 for (idx = 0; idx < num_formats; ++idx) {
84 if (ffmpeg_dirac_pixel_format_map[idx].ff_pix_fmt == ff_pix_fmt) {
85 return ffmpeg_dirac_pixel_format_map[idx].dirac_pix_fmt;
92 * Dirac video preset table. Ensure that this tables matches up correctly
93 * with the ff_dirac_schro_video_format_info table in libdirac_libschro.c.
95 static const VideoFormat ff_dirac_video_formats[]={
97 VIDEO_FORMAT_QSIF525 ,
101 VIDEO_FORMAT_4SIF525 ,
103 VIDEO_FORMAT_SD_480I60 ,
104 VIDEO_FORMAT_SD_576I50 ,
105 VIDEO_FORMAT_HD_720P60 ,
106 VIDEO_FORMAT_HD_720P50 ,
107 VIDEO_FORMAT_HD_1080I60 ,
108 VIDEO_FORMAT_HD_1080I50 ,
109 VIDEO_FORMAT_HD_1080P60 ,
110 VIDEO_FORMAT_HD_1080P50 ,
111 VIDEO_FORMAT_DIGI_CINEMA_2K24 ,
112 VIDEO_FORMAT_DIGI_CINEMA_4K24 ,
116 * Returns the video format preset matching the input video dimensions and
119 static VideoFormat GetDiracVideoFormatPreset (AVCodecContext *avccontext)
121 unsigned int num_formats = sizeof(ff_dirac_video_formats) /
122 sizeof(ff_dirac_video_formats[0]);
124 unsigned int idx = ff_dirac_schro_get_video_format_idx (avccontext);
126 return (idx < num_formats) ?
127 ff_dirac_video_formats[idx] : VIDEO_FORMAT_CUSTOM;
130 static int libdirac_encode_init(AVCodecContext *avccontext)
133 FfmpegDiracEncoderParams* p_dirac_params = avccontext->priv_data;
135 int verbose = avccontext->debug;
138 /* get Dirac preset */
139 preset = GetDiracVideoFormatPreset(avccontext);
141 /* initialize the encoder context */
142 dirac_encoder_context_init (&(p_dirac_params->enc_ctx), preset);
144 p_dirac_params->enc_ctx.src_params.chroma =
145 GetDiracChromaFormat(avccontext->pix_fmt);
147 if (p_dirac_params->enc_ctx.src_params.chroma == formatNK) {
148 av_log (avccontext, AV_LOG_ERROR,
149 "Unsupported pixel format %d. This codec supports only "
150 "Planar YUV formats (yuv420p, yuv422p, yuv444p\n",
151 avccontext->pix_fmt);
155 p_dirac_params->enc_ctx.src_params.frame_rate.numerator =
156 avccontext->time_base.den;
157 p_dirac_params->enc_ctx.src_params.frame_rate.denominator =
158 avccontext->time_base.num;
160 p_dirac_params->enc_ctx.src_params.width = avccontext->width;
161 p_dirac_params->enc_ctx.src_params.height = avccontext->height;
163 p_dirac_params->frame_size = avpicture_get_size(avccontext->pix_fmt,
167 avccontext->coded_frame = &p_dirac_params->picture;
170 p_dirac_params->enc_ctx.decode_flag = 0;
171 p_dirac_params->enc_ctx.instr_flag = 0;
173 p_dirac_params->enc_ctx.decode_flag = 1;
174 p_dirac_params->enc_ctx.instr_flag = 1;
177 /* Intra-only sequence */
178 if (avccontext->gop_size == 0 )
179 p_dirac_params->enc_ctx.enc_params.num_L1 = 0;
181 avccontext->has_b_frames = 1;
183 if (avccontext->flags & CODEC_FLAG_QSCALE) {
184 if (avccontext->global_quality != 0) {
185 p_dirac_params->enc_ctx.enc_params.qf =
186 avccontext->global_quality / (FF_QP2LAMBDA*10.0);
187 /* if it is not default bitrate then send target rate. */
188 if (avccontext->bit_rate >= 1000 &&
189 avccontext->bit_rate != 200000) {
190 p_dirac_params->enc_ctx.enc_params.trate =
191 avccontext->bit_rate / 1000;
194 p_dirac_params->enc_ctx.enc_params.lossless = 1;
195 } else if (avccontext->bit_rate >= 1000)
196 p_dirac_params->enc_ctx.enc_params.trate = avccontext->bit_rate / 1000;
198 if ((preset > VIDEO_FORMAT_QCIF || preset < VIDEO_FORMAT_QSIF525) &&
199 avccontext->bit_rate == 200000) {
200 p_dirac_params->enc_ctx.enc_params.trate = 0;
203 if (avccontext->flags & CODEC_FLAG_INTERLACED_ME) {
204 /* all material can be coded as interlaced or progressive
205 * irrespective of the type of source material */
206 p_dirac_params->enc_ctx.enc_params.picture_coding_mode = 1;
209 p_dirac_params->p_encoder = dirac_encoder_init (&(p_dirac_params->enc_ctx),
212 if (!p_dirac_params->p_encoder) {
213 av_log(avccontext, AV_LOG_ERROR,
214 "Unrecoverable Error: dirac_encoder_init failed. ");
218 /* allocate enough memory for the incoming data */
219 p_dirac_params->p_in_frame_buf = av_malloc(p_dirac_params->frame_size);
221 /* initialize the encoded frame queue */
222 ff_dirac_schro_queue_init(&p_dirac_params->enc_frame_queue);
227 static void DiracFreeFrame (void *data)
229 FfmpegDiracSchroEncodedFrame *enc_frame = data;
231 av_freep (&(enc_frame->p_encbuf));
235 static int libdirac_encode_frame(AVCodecContext *avccontext,
236 unsigned char *frame,
237 int buf_size, void *data)
240 dirac_encoder_state_t state;
241 FfmpegDiracEncoderParams* p_dirac_params = avccontext->priv_data;
242 FfmpegDiracSchroEncodedFrame* p_frame_output = NULL;
243 FfmpegDiracSchroEncodedFrame* p_next_output_frame = NULL;
245 int last_frame_in_sequence = 0;
248 /* push end of sequence if not already signalled */
249 if (!p_dirac_params->eos_signalled) {
250 dirac_encoder_end_sequence( p_dirac_params->p_encoder );
251 p_dirac_params->eos_signalled = 1;
255 /* Allocate frame data to Dirac input buffer.
256 * Input line size may differ from what the codec supports,
257 * especially when transcoding from one format to another.
258 * So use avpicture_layout to copy the frame. */
259 avpicture_layout ((AVPicture *)data, avccontext->pix_fmt,
260 avccontext->width, avccontext->height,
261 p_dirac_params->p_in_frame_buf,
262 p_dirac_params->frame_size);
264 /* load next frame */
265 if (dirac_encoder_load (p_dirac_params->p_encoder,
266 p_dirac_params->p_in_frame_buf,
267 p_dirac_params->frame_size ) < 0) {
268 av_log(avccontext, AV_LOG_ERROR, "Unrecoverable Encoder Error."
269 " dirac_encoder_load failed...\n");
274 if (p_dirac_params->eos_pulled)
278 p_dirac_params->p_encoder->enc_buf.buffer = frame;
279 p_dirac_params->p_encoder->enc_buf.size = buf_size;
281 state = dirac_encoder_output ( p_dirac_params->p_encoder );
285 case ENC_STATE_AVAIL:
287 assert (p_dirac_params->p_encoder->enc_buf.size > 0);
289 /* All non-frame data is prepended to actual frame data to
290 * be able to set the pts correctly. So we don't write data
291 * to the frame output queue until we actually have a frame
294 p_dirac_params->enc_buf = av_realloc (
295 p_dirac_params->enc_buf,
296 p_dirac_params->enc_buf_size +
297 p_dirac_params->p_encoder->enc_buf.size
299 memcpy(p_dirac_params->enc_buf + p_dirac_params->enc_buf_size,
300 p_dirac_params->p_encoder->enc_buf.buffer,
301 p_dirac_params->p_encoder->enc_buf.size);
303 p_dirac_params->enc_buf_size +=
304 p_dirac_params->p_encoder->enc_buf.size;
306 if (state == ENC_STATE_EOS) {
307 p_dirac_params->eos_pulled = 1;
311 /* If non-frame data, don't output it until it we get an
312 * encoded frame back from the encoder. */
313 if (p_dirac_params->p_encoder->enc_pparams.pnum == -1)
316 /* create output frame */
317 p_frame_output = av_mallocz(sizeof(FfmpegDiracSchroEncodedFrame));
318 /* set output data */
319 p_frame_output->size = p_dirac_params->enc_buf_size;
320 p_frame_output->p_encbuf = p_dirac_params->enc_buf;
321 p_frame_output->frame_num =
322 p_dirac_params->p_encoder->enc_pparams.pnum;
324 if (p_dirac_params->p_encoder->enc_pparams.ptype == INTRA_PICTURE &&
325 p_dirac_params->p_encoder->enc_pparams.rtype == REFERENCE_PICTURE)
326 p_frame_output->key_frame = 1;
328 ff_dirac_schro_queue_push_back (&p_dirac_params->enc_frame_queue,
331 p_dirac_params->enc_buf_size = 0;
332 p_dirac_params->enc_buf = NULL;
335 case ENC_STATE_BUFFER:
339 case ENC_STATE_INVALID:
340 av_log(avccontext, AV_LOG_ERROR,
341 "Unrecoverable Dirac Encoder Error. Quitting...\n");
345 av_log(avccontext, AV_LOG_ERROR, "Unknown Dirac Encoder state\n");
350 /* copy 'next' frame in queue */
352 if (p_dirac_params->enc_frame_queue.size == 1 &&
353 p_dirac_params->eos_pulled)
354 last_frame_in_sequence = 1;
356 p_next_output_frame =
357 ff_dirac_schro_queue_pop(&p_dirac_params->enc_frame_queue);
359 if (p_next_output_frame == NULL)
362 memcpy(frame, p_next_output_frame->p_encbuf, p_next_output_frame->size);
363 avccontext->coded_frame->key_frame = p_next_output_frame->key_frame;
364 /* Use the frame number of the encoded frame as the pts. It is OK to do
365 * so since Dirac is a constant framerate codec. It expects input to be
366 * of constant framerate. */
367 avccontext->coded_frame->pts = p_next_output_frame->frame_num;
368 enc_size = p_next_output_frame->size;
370 /* Append the end of sequence information to the last frame in the
372 if (last_frame_in_sequence && p_dirac_params->enc_buf_size > 0)
374 memcpy (frame + enc_size, p_dirac_params->enc_buf,
375 p_dirac_params->enc_buf_size);
376 enc_size += p_dirac_params->enc_buf_size;
377 av_freep (&p_dirac_params->enc_buf);
378 p_dirac_params->enc_buf_size = 0;
382 DiracFreeFrame(p_next_output_frame);
387 static int libdirac_encode_close(AVCodecContext *avccontext)
389 FfmpegDiracEncoderParams* p_dirac_params = avccontext->priv_data;
391 /* close the encoder */
392 dirac_encoder_close(p_dirac_params->p_encoder );
394 /* free data in the output frame queue */
395 ff_dirac_schro_queue_free(&p_dirac_params->enc_frame_queue,
398 /* free the encoder buffer */
399 if (p_dirac_params->enc_buf_size)
400 av_freep(&p_dirac_params->enc_buf);
402 /* free the input frame buffer */
403 av_freep(&p_dirac_params->p_in_frame_buf);
409 AVCodec libdirac_encoder = {
413 sizeof(FfmpegDiracEncoderParams),
414 libdirac_encode_init,
415 libdirac_encode_frame,
416 libdirac_encode_close,
417 .capabilities= CODEC_CAP_DELAY,
418 .pix_fmts= (enum PixelFormat[]){PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUV444P, -1},
419 .long_name= NULL_IF_CONFIG_SMALL("libdirac Dirac 2.2"),