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 "libschroedinger.h"
38 #include <schroedinger/schro.h>
39 #include <schroedinger/schrodebug.h>
40 #include <schroedinger/schrovideoformat.h>
42 /** libschroedinger decoder private data */
43 typedef struct SchroDecoderParams {
44 /** Schroedinger video format */
45 SchroVideoFormat *format;
47 /** Schroedinger frame format */
48 SchroFrameFormat frame_format;
51 SchroDecoder* decoder;
53 /** queue storing decoded frames */
54 FFSchroQueue dec_frame_queue;
56 /** end of sequence signalled */
59 /** end of sequence pulled */
62 /** decoded picture */
66 typedef struct SchroParseUnitContext {
69 } SchroParseUnitContext;
72 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
78 static void parse_context_init(SchroParseUnitContext *parse_ctx,
79 const uint8_t *buf, int buf_size)
82 parse_ctx->buf_size = buf_size;
85 static SchroBuffer *find_next_parse_unit(SchroParseUnitContext *parse_ctx)
87 SchroBuffer *enc_buf = NULL;
88 int next_pu_offset = 0;
89 unsigned char *in_buf;
91 if (parse_ctx->buf_size < 13 ||
92 parse_ctx->buf[0] != 'B' ||
93 parse_ctx->buf[1] != 'B' ||
94 parse_ctx->buf[2] != 'C' ||
95 parse_ctx->buf[3] != 'D')
98 next_pu_offset = (parse_ctx->buf[5] << 24) +
99 (parse_ctx->buf[6] << 16) +
100 (parse_ctx->buf[7] << 8) +
103 if (next_pu_offset == 0 &&
104 SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
107 if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
110 in_buf = av_malloc(next_pu_offset);
112 av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
116 memcpy(in_buf, parse_ctx->buf, next_pu_offset);
117 enc_buf = schro_buffer_new_with_data(in_buf, next_pu_offset);
118 enc_buf->free = libschroedinger_decode_buffer_free;
119 enc_buf->priv = in_buf;
121 parse_ctx->buf += next_pu_offset;
122 parse_ctx->buf_size -= next_pu_offset;
128 * Returns Libav chroma format.
130 static enum PixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
132 int num_formats = sizeof(schro_pixel_format_map) /
133 sizeof(schro_pixel_format_map[0]);
136 for (idx = 0; idx < num_formats; ++idx)
137 if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
138 return schro_pixel_format_map[idx].ff_pix_fmt;
142 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
145 SchroDecoderParams *p_schro_params = avccontext->priv_data;
146 /* First of all, initialize our supporting libraries. */
149 schro_debug_set_level(avccontext->debug);
150 p_schro_params->decoder = schro_decoder_new();
151 schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
153 if (!p_schro_params->decoder)
156 /* Initialize the decoded frame queue. */
157 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
161 static void libschroedinger_decode_frame_free(void *frame)
163 schro_frame_unref(frame);
166 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
168 SchroDecoderParams *p_schro_params = avccontext->priv_data;
169 SchroDecoder *decoder = p_schro_params->decoder;
171 p_schro_params->format = schro_decoder_get_video_format(decoder);
173 /* Tell Libav about sequence details. */
174 if (av_image_check_size(p_schro_params->format->width, p_schro_params->format->height,
175 0, avccontext) < 0) {
176 av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
177 p_schro_params->format->width, p_schro_params->format->height);
178 avccontext->height = avccontext->width = 0;
181 avccontext->height = p_schro_params->format->height;
182 avccontext->width = p_schro_params->format->width;
183 avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
185 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
186 &p_schro_params->frame_format) == -1) {
187 av_log(avccontext, AV_LOG_ERROR,
188 "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
189 "and 4:4:4 formats.\n");
193 avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
194 avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
196 if (!p_schro_params->dec_pic.data[0])
197 avpicture_alloc(&p_schro_params->dec_pic,
203 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
204 void *data, int *data_size,
207 const uint8_t *buf = avpkt->data;
208 int buf_size = avpkt->size;
210 SchroDecoderParams *p_schro_params = avccontext->priv_data;
211 SchroDecoder *decoder = p_schro_params->decoder;
212 AVPicture *picture = data;
213 SchroBuffer *enc_buf;
218 SchroParseUnitContext parse_ctx;
222 parse_context_init(&parse_ctx, buf, buf_size);
224 if (!p_schro_params->eos_signalled) {
225 state = schro_decoder_push_end_of_stream(decoder);
226 p_schro_params->eos_signalled = 1;
230 /* Loop through all the individual parse units in the input buffer */
232 if ((enc_buf = find_next_parse_unit(&parse_ctx))) {
233 /* Push buffer into decoder. */
234 if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
235 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
236 avccontext->has_b_frames = 1;
237 state = schro_decoder_push(decoder, enc_buf);
238 if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
239 libschroedinger_handle_first_access_unit(avccontext);
245 /* Parse data and process result. */
246 state = schro_decoder_wait(decoder);
248 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
249 libschroedinger_handle_first_access_unit(avccontext);
252 case SCHRO_DECODER_NEED_BITS:
253 /* Need more input data - stop iterating over what we have. */
257 case SCHRO_DECODER_NEED_FRAME:
258 /* Decoder needs a frame - create one and push it in. */
259 frame = ff_create_schro_frame(avccontext,
260 p_schro_params->frame_format);
261 schro_decoder_add_output_picture(decoder, frame);
264 case SCHRO_DECODER_OK:
265 /* Pull a frame out of the decoder. */
266 frame = schro_decoder_pull(decoder);
269 ff_schro_queue_push_back(&p_schro_params->dec_frame_queue,
272 case SCHRO_DECODER_EOS:
274 p_schro_params->eos_pulled = 1;
275 schro_decoder_reset(decoder);
279 case SCHRO_DECODER_ERROR:
286 /* Grab next frame to be returned from the top of the queue. */
287 frame = ff_schro_queue_pop(&p_schro_params->dec_frame_queue);
290 memcpy(p_schro_params->dec_pic.data[0],
291 frame->components[0].data,
292 frame->components[0].length);
294 memcpy(p_schro_params->dec_pic.data[1],
295 frame->components[1].data,
296 frame->components[1].length);
298 memcpy(p_schro_params->dec_pic.data[2],
299 frame->components[2].data,
300 frame->components[2].length);
302 /* Fill picture with current buffer data from Schroedinger. */
303 avpicture_fill(picture, p_schro_params->dec_pic.data[0],
305 avccontext->width, avccontext->height);
307 *data_size = sizeof(AVPicture);
309 /* Now free the frame resources. */
310 libschroedinger_decode_frame_free(frame);
316 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
318 SchroDecoderParams *p_schro_params = avccontext->priv_data;
319 /* Free the decoder. */
320 schro_decoder_free(p_schro_params->decoder);
321 av_freep(&p_schro_params->format);
323 avpicture_free(&p_schro_params->dec_pic);
325 /* Free data in the output frame queue. */
326 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
327 libschroedinger_decode_frame_free);
332 static void libschroedinger_flush(AVCodecContext *avccontext)
334 /* Got a seek request. Free the decoded frames queue and then reset
336 SchroDecoderParams *p_schro_params = avccontext->priv_data;
338 /* Free data in the output frame queue. */
339 ff_schro_queue_free(&p_schro_params->dec_frame_queue,
340 libschroedinger_decode_frame_free);
342 ff_schro_queue_init(&p_schro_params->dec_frame_queue);
343 schro_decoder_reset(p_schro_params->decoder);
344 p_schro_params->eos_pulled = 0;
345 p_schro_params->eos_signalled = 0;
348 AVCodec ff_libschroedinger_decoder = {
349 .name = "libschroedinger",
350 .type = AVMEDIA_TYPE_VIDEO,
351 .id = CODEC_ID_DIRAC,
352 .priv_data_size = sizeof(SchroDecoderParams),
353 .init = libschroedinger_decode_init,
354 .close = libschroedinger_decode_close,
355 .decode = libschroedinger_decode_frame,
356 .capabilities = CODEC_CAP_DELAY,
357 .flush = libschroedinger_flush,
358 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),