Merge remote-tracking branch 'qatar/master'
[ffmpeg.git] / libavcodec / libschroedingerdec.c
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
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 "libavutil/imgutils.h"
31 #include "avcodec.h"
32 #include "libdirac_libschro.h"
33 #include "libschroedinger.h"
34
35 #undef NDEBUG
36 #include <assert.h>
37
38
39 #include <schroedinger/schro.h>
40 #include <schroedinger/schrodebug.h>
41 #include <schroedinger/schrovideoformat.h>
42
43 /** libschroedinger decoder private data */
44 typedef struct SchroDecoderParams {
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     DiracSchroQueue 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 } SchroDecoderParams;
66
67 typedef struct SchroParseUnitContext {
68     const uint8_t *buf;
69     int           buf_size;
70 } SchroParseUnitContext;
71
72
73 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
74                                                void *priv);
75
76 static void SchroParseContextInit(SchroParseUnitContext *parse_ctx,
77                                   const uint8_t *buf, int buf_size)
78 {
79     parse_ctx->buf           = buf;
80     parse_ctx->buf_size      = buf_size;
81 }
82
83 static SchroBuffer *FindNextSchroParseUnit(SchroParseUnitContext *parse_ctx)
84 {
85     SchroBuffer *enc_buf = NULL;
86     int next_pu_offset = 0;
87     unsigned char *in_buf;
88
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')
94         return NULL;
95
96     next_pu_offset = (parse_ctx->buf[5] << 24) +
97                      (parse_ctx->buf[6] << 16) +
98                      (parse_ctx->buf[7] <<  8) +
99                       parse_ctx->buf[8];
100
101     if (next_pu_offset == 0 &&
102         SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
103         next_pu_offset = 13;
104
105     if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
106         return NULL;
107
108     in_buf = av_malloc(next_pu_offset);
109     if (!in_buf) {
110         av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
111         return NULL;
112     }
113
114     memcpy(in_buf, parse_ctx->buf, next_pu_offset);
115     enc_buf       = schro_buffer_new_with_data(in_buf, next_pu_offset);
116     enc_buf->free = libschroedinger_decode_buffer_free;
117     enc_buf->priv = in_buf;
118
119     parse_ctx->buf      += next_pu_offset;
120     parse_ctx->buf_size -= next_pu_offset;
121
122     return enc_buf;
123 }
124
125 /**
126 * Returns FFmpeg chroma format.
127 */
128 static enum PixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
129 {
130     int num_formats = sizeof(schro_pixel_format_map) /
131                       sizeof(schro_pixel_format_map[0]);
132     int idx;
133
134     for (idx = 0; idx < num_formats; ++idx)
135         if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
136             return schro_pixel_format_map[idx].ff_pix_fmt;
137     return PIX_FMT_NONE;
138 }
139
140 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
141 {
142
143     SchroDecoderParams *p_schro_params = avccontext->priv_data;
144     /* First of all, initialize our supporting libraries. */
145     schro_init();
146
147     schro_debug_set_level(avccontext->debug);
148     p_schro_params->decoder = schro_decoder_new();
149     schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
150
151     if (!p_schro_params->decoder)
152         return -1;
153
154     /* Initialize the decoded frame queue. */
155     ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
156     return 0;
157 }
158
159 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
160                                                void *priv)
161 {
162     av_freep(&priv);
163 }
164
165 static void libschroedinger_decode_frame_free(void *frame)
166 {
167     schro_frame_unref(frame);
168 }
169
170 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
171 {
172     SchroDecoderParams *p_schro_params = avccontext->priv_data;
173     SchroDecoder *decoder = p_schro_params->decoder;
174
175     p_schro_params->format = schro_decoder_get_video_format(decoder);
176
177     /* Tell FFmpeg about sequence details. */
178     if (av_image_check_size(p_schro_params->format->width, p_schro_params->format->height,
179                             0, avccontext) < 0) {
180         av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
181                p_schro_params->format->width, p_schro_params->format->height);
182         avccontext->height = avccontext->width = 0;
183         return;
184     }
185     avccontext->height  = p_schro_params->format->height;
186     avccontext->width   = p_schro_params->format->width;
187     avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
188
189     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
190                                   &p_schro_params->frame_format) == -1) {
191         av_log(avccontext, AV_LOG_ERROR,
192                "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
193                "and 4:4:4 formats.\n");
194         return;
195     }
196
197     avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
198     avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
199
200     if (!p_schro_params->dec_pic.data[0])
201         avpicture_alloc(&p_schro_params->dec_pic,
202                         avccontext->pix_fmt,
203                         avccontext->width,
204                         avccontext->height);
205 }
206
207 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
208                                         void *data, int *data_size,
209                                         AVPacket *avpkt)
210 {
211     const uint8_t *buf = avpkt->data;
212     int buf_size = avpkt->size;
213
214     SchroDecoderParams *p_schro_params = avccontext->priv_data;
215     SchroDecoder *decoder = p_schro_params->decoder;
216     AVPicture *picture = data;
217     SchroBuffer *enc_buf;
218     SchroFrame* frame;
219     int state;
220     int go = 1;
221     int outer = 1;
222     SchroParseUnitContext parse_ctx;
223
224     *data_size = 0;
225
226     SchroParseContextInit(&parse_ctx, buf, buf_size);
227     if (!buf_size) {
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 = FindNextSchroParseUnit(&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         } else
246             outer = 0;
247
248         while (go) {
249             /* Parse data and process result. */
250             state = schro_decoder_wait(decoder);
251             switch (state) {
252             case SCHRO_DECODER_FIRST_ACCESS_UNIT:
253                 libschroedinger_handle_first_access_unit(avccontext);
254                 break;
255
256             case SCHRO_DECODER_NEED_BITS:
257                 /* Need more input data - stop iterating over what we have. */
258                 go = 0;
259                 break;
260
261             case SCHRO_DECODER_NEED_FRAME:
262                 /* Decoder needs a frame - create one and push it in. */
263                 frame = ff_create_schro_frame(avccontext,
264                                               p_schro_params->frame_format);
265                 schro_decoder_add_output_picture(decoder, frame);
266                 break;
267
268             case SCHRO_DECODER_OK:
269                 /* Pull a frame out of the decoder. */
270                 frame = schro_decoder_pull(decoder);
271
272                 if (frame)
273                     ff_dirac_schro_queue_push_back(&p_schro_params->dec_frame_queue,
274                                                    frame);
275                 break;
276             case SCHRO_DECODER_EOS:
277                 go = 0;
278                 p_schro_params->eos_pulled = 1;
279                 schro_decoder_reset(decoder);
280                 outer = 0;
281                 break;
282
283             case SCHRO_DECODER_ERROR:
284                 return -1;
285                 break;
286             }
287         }
288     } while (outer);
289
290     /* Grab next frame to be returned from the top of the queue. */
291     frame = ff_dirac_schro_queue_pop(&p_schro_params->dec_frame_queue);
292
293     if (frame) {
294         memcpy(p_schro_params->dec_pic.data[0],
295                frame->components[0].data,
296                frame->components[0].length);
297
298         memcpy(p_schro_params->dec_pic.data[1],
299                frame->components[1].data,
300                frame->components[1].length);
301
302         memcpy(p_schro_params->dec_pic.data[2],
303                frame->components[2].data,
304                frame->components[2].length);
305
306         /* Fill picture with current buffer data from Schroedinger. */
307         avpicture_fill(picture, p_schro_params->dec_pic.data[0],
308                        avccontext->pix_fmt,
309                        avccontext->width, avccontext->height);
310
311         *data_size = sizeof(AVPicture);
312
313         /* Now free the frame resources. */
314         libschroedinger_decode_frame_free(frame);
315     }
316     return buf_size;
317 }
318
319
320 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
321 {
322     SchroDecoderParams *p_schro_params = avccontext->priv_data;
323     /* Free the decoder. */
324     schro_decoder_free(p_schro_params->decoder);
325     av_freep(&p_schro_params->format);
326
327     avpicture_free(&p_schro_params->dec_pic);
328
329     /* Free data in the output frame queue. */
330     ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
331                               libschroedinger_decode_frame_free);
332
333     return 0;
334 }
335
336 static void libschroedinger_flush(AVCodecContext *avccontext)
337 {
338     /* Got a seek request. Free the decoded frames queue and then reset
339      * the decoder */
340     SchroDecoderParams *p_schro_params = avccontext->priv_data;
341
342     /* Free data in the output frame queue. */
343     ff_dirac_schro_queue_free(&p_schro_params->dec_frame_queue,
344                               libschroedinger_decode_frame_free);
345
346     ff_dirac_schro_queue_init(&p_schro_params->dec_frame_queue);
347     schro_decoder_reset(p_schro_params->decoder);
348     p_schro_params->eos_pulled = 0;
349     p_schro_params->eos_signalled = 0;
350 }
351
352 AVCodec ff_libschroedinger_decoder = {
353     .name           = "libschroedinger",
354     .type           = AVMEDIA_TYPE_VIDEO,
355     .id             = CODEC_ID_DIRAC,
356     .priv_data_size = sizeof(SchroDecoderParams),
357     .init           = libschroedinger_decode_init,
358     .close          = libschroedinger_decode_close,
359     .decode         = libschroedinger_decode_frame,
360     .capabilities   = CODEC_CAP_DELAY,
361     .flush          = libschroedinger_flush,
362     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
363 };