2 * Dirac decoder 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 decoder 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 "libavutil/imgutils.h"
32 #include "libdirac_libschro.h"
33 #include "libschroedinger.h"
39 #include <schroedinger/schro.h>
40 #include <schroedinger/schrodebug.h>
41 #include <schroedinger/schrovideoformat.h>
43 /** libschroedinger decoder private data */
44 typedef struct FfmpegSchroDecoderParams {
45 /** Schroedinger video format */
46 SchroVideoFormat *format;
48 /** Schroedinger frame format */
49 SchroFrameFormat frame_format;
52 SchroDecoder* decoder;
54 /** queue storing decoded frames */
55 FfmpegDiracSchroQueue dec_frame_queue;
57 /** end of sequence signalled */
60 /** end of sequence pulled */
63 /** decoded picture */
65 } FfmpegSchroDecoderParams;
67 typedef struct FfmpegSchroParseUnitContext {
70 } FfmpegSchroParseUnitContext;
73 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
76 static void FfmpegSchroParseContextInit(FfmpegSchroParseUnitContext *parse_ctx,
77 const uint8_t *buf, int buf_size)
80 parse_ctx->buf_size = buf_size;
83 static SchroBuffer* FfmpegFindNextSchroParseUnit(FfmpegSchroParseUnitContext *parse_ctx)
85 SchroBuffer *enc_buf = NULL;
86 int next_pu_offset = 0;
87 unsigned char *in_buf;
89 if (parse_ctx->buf_size < 13 ||
90 parse_ctx->buf[0] != 'B' ||
91 parse_ctx->buf[1] != 'B' ||
92 parse_ctx->buf[2] != 'C' ||
93 parse_ctx->buf[3] != 'D')
96 next_pu_offset = (parse_ctx->buf[5] << 24) +
97 (parse_ctx->buf[6] << 16) +
98 (parse_ctx->buf[7] << 8) +
101 if (next_pu_offset == 0 &&
102 SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
105 if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
108 in_buf = av_malloc(next_pu_offset);
109 memcpy(in_buf, parse_ctx->buf, next_pu_offset);
110 enc_buf = schro_buffer_new_with_data(in_buf, next_pu_offset);
111 enc_buf->free = libschroedinger_decode_buffer_free;
112 enc_buf->priv = in_buf;
114 parse_ctx->buf += next_pu_offset;
115 parse_ctx->buf_size -= next_pu_offset;
121 * Returns Libav chroma format.
123 static enum PixelFormat GetFfmpegChromaFormat(SchroChromaFormat schro_pix_fmt)
125 int num_formats = sizeof(ffmpeg_schro_pixel_format_map) /
126 sizeof(ffmpeg_schro_pixel_format_map[0]);
129 for (idx = 0; idx < num_formats; ++idx)
130 if (ffmpeg_schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
131 return ffmpeg_schro_pixel_format_map[idx].ff_pix_fmt;
135 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
138 FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
139 /* First of all, initialize our supporting libraries. */
142 schro_debug_set_level(avccontext->debug);
143 p_schro_params->decoder = schro_decoder_new();
144 schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
146 if (!p_schro_params->decoder)
149 /* Initialize the decoded frame queue. */
150 ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
154 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
160 static void libschroedinger_decode_frame_free(void *frame)
162 schro_frame_unref(frame);
165 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
167 FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
168 SchroDecoder *decoder = p_schro_params->decoder;
170 p_schro_params->format = schro_decoder_get_video_format(decoder);
172 /* Tell Libav about sequence details. */
173 if (av_image_check_size(p_schro_params->format->width, p_schro_params->format->height,
174 0, avccontext) < 0) {
175 av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
176 p_schro_params->format->width, p_schro_params->format->height);
177 avccontext->height = avccontext->width = 0;
180 avccontext->height = p_schro_params->format->height;
181 avccontext->width = p_schro_params->format->width;
182 avccontext->pix_fmt = GetFfmpegChromaFormat(p_schro_params->format->chroma_format);
184 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
185 &p_schro_params->frame_format) == -1) {
186 av_log(avccontext, AV_LOG_ERROR,
187 "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
188 "and 4:4:4 formats.\n");
192 avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
193 avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
195 if (!p_schro_params->dec_pic.data[0])
196 avpicture_alloc(&p_schro_params->dec_pic,
202 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
203 void *data, int *data_size,
206 const uint8_t *buf = avpkt->data;
207 int buf_size = avpkt->size;
209 FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
210 SchroDecoder *decoder = p_schro_params->decoder;
211 AVPicture *picture = data;
212 SchroBuffer *enc_buf;
217 FfmpegSchroParseUnitContext parse_ctx;
221 FfmpegSchroParseContextInit(&parse_ctx, buf, buf_size);
223 if (!p_schro_params->eos_signalled) {
224 state = schro_decoder_push_end_of_stream(decoder);
225 p_schro_params->eos_signalled = 1;
229 /* Loop through all the individual parse units in the input buffer */
231 if ((enc_buf = FfmpegFindNextSchroParseUnit(&parse_ctx))) {
232 /* Push buffer into decoder. */
233 if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
234 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
235 avccontext->has_b_frames = 1;
236 state = schro_decoder_push(decoder, enc_buf);
237 if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
238 libschroedinger_handle_first_access_unit(avccontext);
244 /* Parse data and process result. */
245 state = schro_decoder_wait(decoder);
247 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
248 libschroedinger_handle_first_access_unit(avccontext);
251 case SCHRO_DECODER_NEED_BITS:
252 /* Need more input data - stop iterating over what we have. */
256 case SCHRO_DECODER_NEED_FRAME:
257 /* Decoder needs a frame - create one and push it in. */
258 frame = ff_create_schro_frame(avccontext,
259 p_schro_params->frame_format);
260 schro_decoder_add_output_picture(decoder, frame);
263 case SCHRO_DECODER_OK:
264 /* Pull a frame out of the decoder. */
265 frame = schro_decoder_pull(decoder);
268 ff_dirac_schro_queue_push_back(&p_schro_params->dec_frame_queue,
271 case SCHRO_DECODER_EOS:
273 p_schro_params->eos_pulled = 1;
274 schro_decoder_reset(decoder);
278 case SCHRO_DECODER_ERROR:
285 /* Grab next frame to be returned from the top of the queue. */
286 frame = ff_dirac_schro_queue_pop(&p_schro_params->dec_frame_queue);
289 memcpy(p_schro_params->dec_pic.data[0],
290 frame->components[0].data,
291 frame->components[0].length);
293 memcpy(p_schro_params->dec_pic.data[1],
294 frame->components[1].data,
295 frame->components[1].length);
297 memcpy(p_schro_params->dec_pic.data[2],
298 frame->components[2].data,
299 frame->components[2].length);
301 /* Fill picture with current buffer data from Schroedinger. */
302 avpicture_fill(picture, p_schro_params->dec_pic.data[0],
304 avccontext->width, avccontext->height);
306 *data_size = sizeof(AVPicture);
308 /* Now free the frame resources. */
309 libschroedinger_decode_frame_free(frame);
315 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
317 FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
318 /* Free the decoder. */
319 schro_decoder_free(p_schro_params->decoder);
320 av_freep(&p_schro_params->format);
322 avpicture_free(&p_schro_params->dec_pic);
324 /* Free data in the output frame queue. */
325 ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
326 libschroedinger_decode_frame_free);
331 static void libschroedinger_flush(AVCodecContext *avccontext)
333 /* Got a seek request. Free the decoded frames queue and then reset
335 FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
337 /* Free data in the output frame queue. */
338 ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
339 libschroedinger_decode_frame_free);
341 ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
342 schro_decoder_reset(p_schro_params->decoder);
343 p_schro_params->eos_pulled = 0;
344 p_schro_params->eos_signalled = 0;
347 AVCodec ff_libschroedinger_decoder = {
348 .name = "libschroedinger",
349 .type = AVMEDIA_TYPE_VIDEO,
350 .id = CODEC_ID_DIRAC,
351 .priv_data_size = sizeof(FfmpegSchroDecoderParams),
352 .init = libschroedinger_decode_init,
353 .close = libschroedinger_decode_close,
354 .decode = libschroedinger_decode_frame,
355 .capabilities = CODEC_CAP_DELAY,
356 .flush = libschroedinger_flush,
357 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),