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 SchroDecoderParams {
45 /** Schroedinger video format */
46 SchroVideoFormat *format;
48 /** Schroedinger frame format */
49 SchroFrameFormat frame_format;
52 SchroDecoder* decoder;
54 /** queue storing decoded frames */
55 DiracSchroQueue dec_frame_queue;
57 /** end of sequence signalled */
60 /** end of sequence pulled */
63 /** decoded picture */
67 typedef struct SchroParseUnitContext {
70 } SchroParseUnitContext;
73 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
79 static void SchroParseContextInit(SchroParseUnitContext *parse_ctx,
80 const uint8_t *buf, int buf_size)
83 parse_ctx->buf_size = buf_size;
86 static SchroBuffer *FindNextSchroParseUnit(SchroParseUnitContext *parse_ctx)
88 SchroBuffer *enc_buf = NULL;
89 int next_pu_offset = 0;
90 unsigned char *in_buf;
92 if (parse_ctx->buf_size < 13 ||
93 parse_ctx->buf[0] != 'B' ||
94 parse_ctx->buf[1] != 'B' ||
95 parse_ctx->buf[2] != 'C' ||
96 parse_ctx->buf[3] != 'D')
99 next_pu_offset = (parse_ctx->buf[5] << 24) +
100 (parse_ctx->buf[6] << 16) +
101 (parse_ctx->buf[7] << 8) +
104 if (next_pu_offset == 0 &&
105 SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
108 if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
111 in_buf = av_malloc(next_pu_offset);
113 av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
117 memcpy(in_buf, parse_ctx->buf, next_pu_offset);
118 enc_buf = schro_buffer_new_with_data(in_buf, next_pu_offset);
119 enc_buf->free = libschroedinger_decode_buffer_free;
120 enc_buf->priv = in_buf;
122 parse_ctx->buf += next_pu_offset;
123 parse_ctx->buf_size -= next_pu_offset;
129 * Returns Libav chroma format.
131 static enum PixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
133 int num_formats = sizeof(schro_pixel_format_map) /
134 sizeof(schro_pixel_format_map[0]);
137 for (idx = 0; idx < num_formats; ++idx)
138 if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
139 return schro_pixel_format_map[idx].ff_pix_fmt;
143 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
146 SchroDecoderParams *p_schro_params = avccontext->priv_data;
147 /* First of all, initialize our supporting libraries. */
150 schro_debug_set_level(avccontext->debug);
151 p_schro_params->decoder = schro_decoder_new();
152 schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
154 if (!p_schro_params->decoder)
157 /* Initialize the decoded frame queue. */
158 ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
162 static void libschroedinger_decode_frame_free(void *frame)
164 schro_frame_unref(frame);
167 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
169 SchroDecoderParams *p_schro_params = avccontext->priv_data;
170 SchroDecoder *decoder = p_schro_params->decoder;
172 p_schro_params->format = schro_decoder_get_video_format(decoder);
174 /* Tell Libav about sequence details. */
175 if (av_image_check_size(p_schro_params->format->width, p_schro_params->format->height,
176 0, avccontext) < 0) {
177 av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
178 p_schro_params->format->width, p_schro_params->format->height);
179 avccontext->height = avccontext->width = 0;
182 avccontext->height = p_schro_params->format->height;
183 avccontext->width = p_schro_params->format->width;
184 avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
186 if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
187 &p_schro_params->frame_format) == -1) {
188 av_log(avccontext, AV_LOG_ERROR,
189 "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
190 "and 4:4:4 formats.\n");
194 avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
195 avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
197 if (!p_schro_params->dec_pic.data[0])
198 avpicture_alloc(&p_schro_params->dec_pic,
204 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
205 void *data, int *data_size,
208 const uint8_t *buf = avpkt->data;
209 int buf_size = avpkt->size;
211 SchroDecoderParams *p_schro_params = avccontext->priv_data;
212 SchroDecoder *decoder = p_schro_params->decoder;
213 AVPicture *picture = data;
214 SchroBuffer *enc_buf;
219 SchroParseUnitContext parse_ctx;
223 SchroParseContextInit(&parse_ctx, buf, buf_size);
225 if (!p_schro_params->eos_signalled) {
226 state = schro_decoder_push_end_of_stream(decoder);
227 p_schro_params->eos_signalled = 1;
231 /* Loop through all the individual parse units in the input buffer */
233 if ((enc_buf = FindNextSchroParseUnit(&parse_ctx))) {
234 /* Push buffer into decoder. */
235 if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
236 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
237 avccontext->has_b_frames = 1;
238 state = schro_decoder_push(decoder, enc_buf);
239 if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
240 libschroedinger_handle_first_access_unit(avccontext);
246 /* Parse data and process result. */
247 state = schro_decoder_wait(decoder);
249 case SCHRO_DECODER_FIRST_ACCESS_UNIT:
250 libschroedinger_handle_first_access_unit(avccontext);
253 case SCHRO_DECODER_NEED_BITS:
254 /* Need more input data - stop iterating over what we have. */
258 case SCHRO_DECODER_NEED_FRAME:
259 /* Decoder needs a frame - create one and push it in. */
260 frame = ff_create_schro_frame(avccontext,
261 p_schro_params->frame_format);
262 schro_decoder_add_output_picture(decoder, frame);
265 case SCHRO_DECODER_OK:
266 /* Pull a frame out of the decoder. */
267 frame = schro_decoder_pull(decoder);
270 ff_dirac_schro_queue_push_back(&p_schro_params->dec_frame_queue,
273 case SCHRO_DECODER_EOS:
275 p_schro_params->eos_pulled = 1;
276 schro_decoder_reset(decoder);
280 case SCHRO_DECODER_ERROR:
287 /* Grab next frame to be returned from the top of the queue. */
288 frame = ff_dirac_schro_queue_pop(&p_schro_params->dec_frame_queue);
291 memcpy(p_schro_params->dec_pic.data[0],
292 frame->components[0].data,
293 frame->components[0].length);
295 memcpy(p_schro_params->dec_pic.data[1],
296 frame->components[1].data,
297 frame->components[1].length);
299 memcpy(p_schro_params->dec_pic.data[2],
300 frame->components[2].data,
301 frame->components[2].length);
303 /* Fill picture with current buffer data from Schroedinger. */
304 avpicture_fill(picture, p_schro_params->dec_pic.data[0],
306 avccontext->width, avccontext->height);
308 *data_size = sizeof(AVPicture);
310 /* Now free the frame resources. */
311 libschroedinger_decode_frame_free(frame);
317 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
319 SchroDecoderParams *p_schro_params = avccontext->priv_data;
320 /* Free the decoder. */
321 schro_decoder_free(p_schro_params->decoder);
322 av_freep(&p_schro_params->format);
324 avpicture_free(&p_schro_params->dec_pic);
326 /* Free data in the output frame queue. */
327 ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
328 libschroedinger_decode_frame_free);
333 static void libschroedinger_flush(AVCodecContext *avccontext)
335 /* Got a seek request. Free the decoded frames queue and then reset
337 SchroDecoderParams *p_schro_params = avccontext->priv_data;
339 /* Free data in the output frame queue. */
340 ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
341 libschroedinger_decode_frame_free);
343 ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
344 schro_decoder_reset(p_schro_params->decoder);
345 p_schro_params->eos_pulled = 0;
346 p_schro_params->eos_signalled = 0;
349 AVCodec ff_libschroedinger_decoder = {
350 .name = "libschroedinger",
351 .type = AVMEDIA_TYPE_VIDEO,
352 .id = CODEC_ID_DIRAC,
353 .priv_data_size = sizeof(SchroDecoderParams),
354 .init = libschroedinger_decode_init,
355 .close = libschroedinger_decode_close,
356 .decode = libschroedinger_decode_frame,
357 .capabilities = CODEC_CAP_DELAY,
358 .flush = libschroedinger_flush,
359 .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),