1/*
2 * Dirac decoder support via Schroedinger libraries
3 * Copyright (c) 2008 BBC, Anuradha Suraparaju <asuraparaju at gmail dot com >
4 *
5 * This file is part of FFmpeg.
6 *
7 * FFmpeg 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.
11 *
12 * FFmpeg 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.
16 *
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
20 */
21
22/**
23* @file libavcodec/libschroedingerdec.c
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).
28*/
29
30#include "avcodec.h"
31#include "libdirac_libschro.h"
32#include "libschroedinger.h"
33
34#undef NDEBUG
35#include <assert.h>
36
37
38#include <schroedinger/schro.h>
39#include <schroedinger/schrodebug.h>
40#include <schroedinger/schrovideoformat.h>
41
42/** libschroedinger decoder private data */
43typedef struct FfmpegSchroDecoderParams
44{
45    /** Schroedinger video format */
46    SchroVideoFormat *format;
47
48    /** Schroedinger frame format */
49    SchroFrameFormat frame_format;
50
51    /** decoder handle */
52    SchroDecoder* decoder;
53
54    /** queue storing decoded frames */
55    FfmpegDiracSchroQueue dec_frame_queue;
56
57    /** end of sequence signalled */
58    int eos_signalled;
59
60    /** end of sequence pulled */
61    int eos_pulled;
62
63    /** decoded picture */
64    AVPicture dec_pic;
65} FfmpegSchroDecoderParams;
66
67typedef struct FfmpegSchroParseUnitContext
68{
69    const uint8_t *buf;
70    int           buf_size;
71} FfmpegSchroParseUnitContext;
72
73
74static void libschroedinger_decode_buffer_free (SchroBuffer *schro_buf,
75                                                void *priv);
76
77static void FfmpegSchroParseContextInit (FfmpegSchroParseUnitContext *parse_ctx,
78                                         const uint8_t *buf, int buf_size)
79{
80    parse_ctx->buf           = buf;
81    parse_ctx->buf_size      = buf_size;
82}
83
84static SchroBuffer* FfmpegFindNextSchroParseUnit (FfmpegSchroParseUnitContext *parse_ctx)
85{
86    SchroBuffer *enc_buf = NULL;
87    int next_pu_offset = 0;
88    unsigned char *in_buf;
89
90    if (parse_ctx->buf_size < 13 ||
91        parse_ctx->buf[0] != 'B' ||
92        parse_ctx->buf[1] != 'B' ||
93        parse_ctx->buf[2] != 'C' ||
94        parse_ctx->buf[3] != 'D')
95        return NULL;
96
97    next_pu_offset = (parse_ctx->buf[5] << 24) +
98                     (parse_ctx->buf[6] << 16) +
99                     (parse_ctx->buf[7] <<  8) +
100                      parse_ctx->buf[8];
101
102    if (next_pu_offset == 0 &&
103        SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
104        next_pu_offset = 13;
105
106    if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
107        return NULL;
108
109    in_buf = av_malloc(next_pu_offset);
110    memcpy (in_buf, parse_ctx->buf, next_pu_offset);
111    enc_buf = schro_buffer_new_with_data (in_buf, next_pu_offset);
112    enc_buf->free = libschroedinger_decode_buffer_free;
113    enc_buf->priv = in_buf;
114
115    parse_ctx->buf += next_pu_offset;
116    parse_ctx->buf_size -= next_pu_offset;
117
118    return enc_buf;
119}
120
121/**
122* Returns FFmpeg chroma format.
123*/
124static enum PixelFormat GetFfmpegChromaFormat(SchroChromaFormat schro_pix_fmt)
125{
126    int num_formats = sizeof(ffmpeg_schro_pixel_format_map) /
127                      sizeof(ffmpeg_schro_pixel_format_map[0]);
128    int idx;
129
130    for (idx = 0; idx < num_formats; ++idx) {
131        if (ffmpeg_schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt) {
132            return ffmpeg_schro_pixel_format_map[idx].ff_pix_fmt;
133        }
134    }
135    return PIX_FMT_NONE;
136}
137
138static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
139{
140
141    FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data ;
142    /* First of all, initialize our supporting libraries. */
143    schro_init();
144
145    schro_debug_set_level(avccontext->debug);
146    p_schro_params->decoder =  schro_decoder_new();
147    schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
148
149    if (!p_schro_params->decoder)
150        return -1;
151
152    /* Initialize the decoded frame queue. */
153    ff_dirac_schro_queue_init (&p_schro_params->dec_frame_queue);
154    return 0 ;
155}
156
157static void libschroedinger_decode_buffer_free (SchroBuffer *schro_buf,
158                                                void *priv)
159{
160    av_freep(&priv);
161}
162
163static void libschroedinger_decode_frame_free (void *frame)
164{
165    schro_frame_unref(frame);
166}
167
168static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
169{
170    FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
171    SchroDecoder *decoder = p_schro_params->decoder;
172
173    p_schro_params->format = schro_decoder_get_video_format (decoder);
174
175    /* Tell FFmpeg about sequence details. */
176    if(avcodec_check_dimensions(avccontext, p_schro_params->format->width,
177                                p_schro_params->format->height) < 0) {
178        av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
179               p_schro_params->format->width, p_schro_params->format->height);
180        avccontext->height = avccontext->width = 0;
181        return;
182    }
183    avccontext->height  = p_schro_params->format->height;
184    avccontext->width   = p_schro_params->format->width;
185    avccontext->pix_fmt =
186                   GetFfmpegChromaFormat(p_schro_params->format->chroma_format);
187
188    if (ff_get_schro_frame_format( p_schro_params->format->chroma_format,
189                                   &p_schro_params->frame_format) == -1) {
190        av_log (avccontext, AV_LOG_ERROR,
191                "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
192                "and 4:4:4 formats.\n");
193        return;
194    }
195
196    avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
197    avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
198
199    if (p_schro_params->dec_pic.data[0] == NULL)
200    {
201        avpicture_alloc(&p_schro_params->dec_pic,
202                        avccontext->pix_fmt,
203                        avccontext->width,
204                        avccontext->height);
205    }
206}
207
208static int libschroedinger_decode_frame(AVCodecContext *avccontext,
209                                        void *data, int *data_size,
210                                        const uint8_t *buf, int buf_size)
211{
212
213    FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
214    SchroDecoder *decoder = p_schro_params->decoder;
215    SchroVideoFormat *format;
216    AVPicture *picture = data;
217    SchroBuffer *enc_buf;
218    SchroFrame* frame;
219    int state;
220    int go = 1;
221    int outer = 1;
222    FfmpegSchroParseUnitContext parse_ctx;
223
224    *data_size = 0;
225
226    FfmpegSchroParseContextInit (&parse_ctx, buf, buf_size);
227    if (buf_size == 0) {
228        if (!p_schro_params->eos_signalled) {
229            state = schro_decoder_push_end_of_stream(decoder);
230            p_schro_params->eos_signalled = 1;
231        }
232    }
233
234    /* Loop through all the individual parse units in the input buffer */
235    do {
236        if ((enc_buf = FfmpegFindNextSchroParseUnit(&parse_ctx))) {
237            /* Push buffer into decoder. */
238            if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
239                SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
240                avccontext->has_b_frames = 1;
241            state = schro_decoder_push (decoder, enc_buf);
242            if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
243                  libschroedinger_handle_first_access_unit(avccontext);
244            go = 1;
245        }
246        else
247            outer = 0;
248    format = p_schro_params->format;
249
250    while (go) {
251        /* Parse data and process result. */
252        state = schro_decoder_wait (decoder);
253        switch (state)
254        {
255        case SCHRO_DECODER_FIRST_ACCESS_UNIT:
256            libschroedinger_handle_first_access_unit (avccontext);
257            break;
258
259        case SCHRO_DECODER_NEED_BITS:
260            /* Need more input data - stop iterating over what we have. */
261            go = 0;
262            break;
263
264        case SCHRO_DECODER_NEED_FRAME:
265            /* Decoder needs a frame - create one and push it in. */
266
267            frame = schro_frame_new_and_alloc(NULL,
268                                              p_schro_params->frame_format,
269                                              format->width,
270                                              format->height);
271            schro_decoder_add_output_picture (decoder, frame);
272            break;
273
274        case SCHRO_DECODER_OK:
275            /* Pull a frame out of the decoder. */
276            frame = schro_decoder_pull (decoder);
277
278            if (frame) {
279                ff_dirac_schro_queue_push_back(
280                                             &p_schro_params->dec_frame_queue,
281                                             frame);
282            }
283            break;
284        case SCHRO_DECODER_EOS:
285            go = 0;
286            p_schro_params->eos_pulled = 1;
287            schro_decoder_reset (decoder);
288            outer = 0;
289            break;
290
291        case SCHRO_DECODER_ERROR:
292            return -1;
293            break;
294        }
295    }
296    } while(outer);
297
298    /* Grab next frame to be returned from the top of the queue. */
299    frame = ff_dirac_schro_queue_pop(&p_schro_params->dec_frame_queue);
300
301    if (frame != NULL) {
302        memcpy (p_schro_params->dec_pic.data[0],
303                frame->components[0].data,
304                frame->components[0].length);
305
306        memcpy (p_schro_params->dec_pic.data[1],
307                frame->components[1].data,
308                frame->components[1].length);
309
310        memcpy (p_schro_params->dec_pic.data[2],
311                frame->components[2].data,
312                frame->components[2].length);
313
314        /* Fill picture with current buffer data from Schroedinger. */
315        avpicture_fill(picture, p_schro_params->dec_pic.data[0],
316                       avccontext->pix_fmt,
317                       avccontext->width, avccontext->height);
318
319        *data_size = sizeof(AVPicture);
320
321        /* Now free the frame resources. */
322        libschroedinger_decode_frame_free (frame);
323    }
324    return buf_size;
325}
326
327
328static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
329{
330    FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
331    /* Free the decoder. */
332    schro_decoder_free (p_schro_params->decoder);
333    av_freep(&p_schro_params->format);
334
335    avpicture_free (&p_schro_params->dec_pic);
336
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);
340
341    return 0 ;
342}
343
344static void libschroedinger_flush (AVCodecContext *avccontext)
345{
346    /* Got a seek request. Free the decoded frames queue and then reset
347     * the decoder */
348    FfmpegSchroDecoderParams *p_schro_params = avccontext->priv_data;
349
350    /* Free data in the output frame queue. */
351    ff_dirac_schro_queue_free (&p_schro_params->dec_frame_queue,
352                               libschroedinger_decode_frame_free);
353
354    ff_dirac_schro_queue_init (&p_schro_params->dec_frame_queue);
355    schro_decoder_reset(p_schro_params->decoder);
356    p_schro_params->eos_pulled = 0;
357    p_schro_params->eos_signalled = 0;
358}
359
360AVCodec libschroedinger_decoder = {
361     "libschroedinger",
362    CODEC_TYPE_VIDEO,
363    CODEC_ID_DIRAC,
364    sizeof(FfmpegSchroDecoderParams),
365    libschroedinger_decode_init,
366    NULL,
367    libschroedinger_decode_close,
368    libschroedinger_decode_frame,
369    CODEC_CAP_DELAY,
370    .flush = libschroedinger_flush,
371    .long_name = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
372};
373