lavfi: make AVFilterPad opaque after two major bumps.
[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 Libav.
6  *
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.
11  *
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.
16  *
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
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 "libavutil/intreadwrite.h"
32 #include "avcodec.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 /** SchroFrame and Pts relation */
44 typedef struct LibSchroFrameContext {
45      SchroFrame *frame;
46      int64_t pts;
47 } LibSchroFrameContext;
48
49 /** libschroedinger decoder private data */
50 typedef struct SchroDecoderParams {
51     /** Schroedinger video format */
52     SchroVideoFormat *format;
53
54     /** Schroedinger frame format */
55     SchroFrameFormat frame_format;
56
57     /** decoder handle */
58     SchroDecoder* decoder;
59
60     /** queue storing decoded frames */
61     FFSchroQueue dec_frame_queue;
62
63     /** end of sequence signalled */
64     int eos_signalled;
65
66     /** end of sequence pulled */
67     int eos_pulled;
68
69     /** decoded picture */
70     AVFrame dec_frame;
71 } SchroDecoderParams;
72
73 typedef struct SchroParseUnitContext {
74     const uint8_t *buf;
75     int           buf_size;
76 } SchroParseUnitContext;
77
78
79 static void libschroedinger_decode_buffer_free(SchroBuffer *schro_buf,
80                                                void *priv)
81 {
82     av_freep(&priv);
83 }
84
85 static void parse_context_init(SchroParseUnitContext *parse_ctx,
86                                const uint8_t *buf, int buf_size)
87 {
88     parse_ctx->buf           = buf;
89     parse_ctx->buf_size      = buf_size;
90 }
91
92 static SchroBuffer *find_next_parse_unit(SchroParseUnitContext *parse_ctx)
93 {
94     SchroBuffer *enc_buf = NULL;
95     int next_pu_offset = 0;
96     unsigned char *in_buf;
97
98     if (parse_ctx->buf_size < 13 ||
99         parse_ctx->buf[0] != 'B' ||
100         parse_ctx->buf[1] != 'B' ||
101         parse_ctx->buf[2] != 'C' ||
102         parse_ctx->buf[3] != 'D')
103         return NULL;
104
105     next_pu_offset = (parse_ctx->buf[5] << 24) +
106                      (parse_ctx->buf[6] << 16) +
107                      (parse_ctx->buf[7] <<  8) +
108                       parse_ctx->buf[8];
109
110     if (next_pu_offset == 0 &&
111         SCHRO_PARSE_CODE_IS_END_OF_SEQUENCE(parse_ctx->buf[4]))
112         next_pu_offset = 13;
113
114     if (next_pu_offset <= 0 || parse_ctx->buf_size < next_pu_offset)
115         return NULL;
116
117     in_buf = av_malloc(next_pu_offset);
118     if (!in_buf) {
119         av_log(parse_ctx, AV_LOG_ERROR, "Unable to allocate input buffer\n");
120         return NULL;
121     }
122
123     memcpy(in_buf, parse_ctx->buf, next_pu_offset);
124     enc_buf       = schro_buffer_new_with_data(in_buf, next_pu_offset);
125     enc_buf->free = libschroedinger_decode_buffer_free;
126     enc_buf->priv = in_buf;
127
128     parse_ctx->buf      += next_pu_offset;
129     parse_ctx->buf_size -= next_pu_offset;
130
131     return enc_buf;
132 }
133
134 /**
135 * Returns Libav chroma format.
136 */
137 static enum PixelFormat get_chroma_format(SchroChromaFormat schro_pix_fmt)
138 {
139     int num_formats = sizeof(schro_pixel_format_map) /
140                       sizeof(schro_pixel_format_map[0]);
141     int idx;
142
143     for (idx = 0; idx < num_formats; ++idx)
144         if (schro_pixel_format_map[idx].schro_pix_fmt == schro_pix_fmt)
145             return schro_pixel_format_map[idx].ff_pix_fmt;
146     return PIX_FMT_NONE;
147 }
148
149 static av_cold int libschroedinger_decode_init(AVCodecContext *avccontext)
150 {
151
152     SchroDecoderParams *p_schro_params = avccontext->priv_data;
153     /* First of all, initialize our supporting libraries. */
154     schro_init();
155
156     schro_debug_set_level(avccontext->debug);
157     p_schro_params->decoder = schro_decoder_new();
158     schro_decoder_set_skip_ratio(p_schro_params->decoder, 1);
159
160     if (!p_schro_params->decoder)
161         return -1;
162
163     /* Initialize the decoded frame queue. */
164     ff_schro_queue_init(&p_schro_params->dec_frame_queue);
165     return 0;
166 }
167
168 static void libschroedinger_decode_frame_free(void *frame)
169 {
170     schro_frame_unref(frame);
171 }
172
173 static void libschroedinger_handle_first_access_unit(AVCodecContext *avccontext)
174 {
175     SchroDecoderParams *p_schro_params = avccontext->priv_data;
176     SchroDecoder *decoder = p_schro_params->decoder;
177
178     p_schro_params->format = schro_decoder_get_video_format(decoder);
179
180     /* Tell Libav about sequence details. */
181     if (av_image_check_size(p_schro_params->format->width,
182                             p_schro_params->format->height, 0, avccontext) < 0) {
183         av_log(avccontext, AV_LOG_ERROR, "invalid dimensions (%dx%d)\n",
184                p_schro_params->format->width, p_schro_params->format->height);
185         avccontext->height = avccontext->width = 0;
186         return;
187     }
188     avccontext->height  = p_schro_params->format->height;
189     avccontext->width   = p_schro_params->format->width;
190     avccontext->pix_fmt = get_chroma_format(p_schro_params->format->chroma_format);
191
192     if (ff_get_schro_frame_format(p_schro_params->format->chroma_format,
193                                   &p_schro_params->frame_format) == -1) {
194         av_log(avccontext, AV_LOG_ERROR,
195                "This codec currently only supports planar YUV 4:2:0, 4:2:2 "
196                "and 4:4:4 formats.\n");
197         return;
198     }
199
200     avccontext->time_base.den = p_schro_params->format->frame_rate_numerator;
201     avccontext->time_base.num = p_schro_params->format->frame_rate_denominator;
202 }
203
204 static int libschroedinger_decode_frame(AVCodecContext *avccontext,
205                                         void *data, int *data_size,
206                                         AVPacket *avpkt)
207 {
208     const uint8_t *buf = avpkt->data;
209     int buf_size = avpkt->size;
210     int64_t pts  = avpkt->pts;
211     SchroTag *tag;
212
213     SchroDecoderParams *p_schro_params = avccontext->priv_data;
214     SchroDecoder *decoder = p_schro_params->decoder;
215     SchroBuffer *enc_buf;
216     SchroFrame* frame;
217     int state;
218     int go = 1;
219     int outer = 1;
220     SchroParseUnitContext parse_ctx;
221     LibSchroFrameContext *framewithpts = NULL;
222
223     *data_size = 0;
224
225     parse_context_init(&parse_ctx, buf, buf_size);
226     if (!buf_size) {
227         if (!p_schro_params->eos_signalled) {
228             state = schro_decoder_push_end_of_stream(decoder);
229             p_schro_params->eos_signalled = 1;
230         }
231     }
232
233     /* Loop through all the individual parse units in the input buffer */
234     do {
235         if ((enc_buf = find_next_parse_unit(&parse_ctx))) {
236             /* Set Schrotag with the pts to be recovered after decoding*/
237             enc_buf->tag = schro_tag_new(av_malloc(sizeof(int64_t)), av_free);
238             if (!enc_buf->tag->value) {
239                 av_log(avccontext, AV_LOG_ERROR, "Unable to allocate SchroTag\n");
240                 return AVERROR(ENOMEM);
241             }
242             AV_WN(64, enc_buf->tag->value, pts);
243             /* Push buffer into decoder. */
244             if (SCHRO_PARSE_CODE_IS_PICTURE(enc_buf->data[4]) &&
245                 SCHRO_PARSE_CODE_NUM_REFS(enc_buf->data[4]) > 0)
246                 avccontext->has_b_frames = 1;
247             state = schro_decoder_push(decoder, enc_buf);
248             if (state == SCHRO_DECODER_FIRST_ACCESS_UNIT)
249                 libschroedinger_handle_first_access_unit(avccontext);
250             go = 1;
251         } else
252             outer = 0;
253
254         while (go) {
255             /* Parse data and process result. */
256             state = schro_decoder_wait(decoder);
257             switch (state) {
258             case SCHRO_DECODER_FIRST_ACCESS_UNIT:
259                 libschroedinger_handle_first_access_unit(avccontext);
260                 break;
261
262             case SCHRO_DECODER_NEED_BITS:
263                 /* Need more input data - stop iterating over what we have. */
264                 go = 0;
265                 break;
266
267             case SCHRO_DECODER_NEED_FRAME:
268                 /* Decoder needs a frame - create one and push it in. */
269                 frame = ff_create_schro_frame(avccontext,
270                                               p_schro_params->frame_format);
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                 tag   = schro_decoder_get_picture_tag(decoder);
277                 frame = schro_decoder_pull(decoder);
278
279                 if (frame) {
280                     /* Add relation between schroframe and pts. */
281                     framewithpts = av_malloc(sizeof(LibSchroFrameContext));
282                     if (!framewithpts) {
283                         av_log(avccontext, AV_LOG_ERROR, "Unable to allocate FrameWithPts\n");
284                         return AVERROR(ENOMEM);
285                     }
286                     framewithpts->frame = frame;
287                     framewithpts->pts   = AV_RN64(tag->value);
288                     ff_schro_queue_push_back(&p_schro_params->dec_frame_queue,
289                                              framewithpts);
290                 }
291                 break;
292             case SCHRO_DECODER_EOS:
293                 go = 0;
294                 p_schro_params->eos_pulled = 1;
295                 schro_decoder_reset(decoder);
296                 outer = 0;
297                 break;
298
299             case SCHRO_DECODER_ERROR:
300                 return -1;
301                 break;
302             }
303         }
304     } while (outer);
305
306     /* Grab next frame to be returned from the top of the queue. */
307     framewithpts = ff_schro_queue_pop(&p_schro_params->dec_frame_queue);
308
309     if (framewithpts && framewithpts->frame) {
310         if (p_schro_params->dec_frame.data[0])
311             avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
312         if (avccontext->get_buffer(avccontext, &p_schro_params->dec_frame) < 0) {
313             av_log(avccontext, AV_LOG_ERROR, "Unable to allocate buffer\n");
314             return AVERROR(ENOMEM);
315         }
316
317         memcpy(p_schro_params->dec_frame.data[0],
318                framewithpts->frame->components[0].data,
319                framewithpts->frame->components[0].length);
320
321         memcpy(p_schro_params->dec_frame.data[1],
322                framewithpts->frame->components[1].data,
323                framewithpts->frame->components[1].length);
324
325         memcpy(p_schro_params->dec_frame.data[2],
326                framewithpts->frame->components[2].data,
327                framewithpts->frame->components[2].length);
328
329         /* Fill frame with current buffer data from Schroedinger. */
330         p_schro_params->dec_frame.format  = -1; /* Unknown -1 */
331         p_schro_params->dec_frame.width   = framewithpts->frame->width;
332         p_schro_params->dec_frame.height  = framewithpts->frame->height;
333         p_schro_params->dec_frame.pkt_pts = framewithpts->pts;
334         p_schro_params->dec_frame.linesize[0] = framewithpts->frame->components[0].stride;
335         p_schro_params->dec_frame.linesize[1] = framewithpts->frame->components[1].stride;
336         p_schro_params->dec_frame.linesize[2] = framewithpts->frame->components[2].stride;
337
338         *(AVFrame*)data = p_schro_params->dec_frame;
339         *data_size      = sizeof(AVFrame);
340
341         /* Now free the frame resources. */
342         libschroedinger_decode_frame_free(framewithpts->frame);
343         av_free(framewithpts);
344     } else {
345         data       = NULL;
346         *data_size = 0;
347     }
348     return buf_size;
349 }
350
351
352 static av_cold int libschroedinger_decode_close(AVCodecContext *avccontext)
353 {
354     SchroDecoderParams *p_schro_params = avccontext->priv_data;
355     /* Free the decoder. */
356     schro_decoder_free(p_schro_params->decoder);
357     av_freep(&p_schro_params->format);
358
359     if (p_schro_params->dec_frame.data[0])
360         avccontext->release_buffer(avccontext, &p_schro_params->dec_frame);
361
362     /* Free data in the output frame queue. */
363     ff_schro_queue_free(&p_schro_params->dec_frame_queue,
364                         libschroedinger_decode_frame_free);
365
366     return 0;
367 }
368
369 static void libschroedinger_flush(AVCodecContext *avccontext)
370 {
371     /* Got a seek request. Free the decoded frames queue and then reset
372      * the decoder */
373     SchroDecoderParams *p_schro_params = avccontext->priv_data;
374
375     /* Free data in the output frame queue. */
376     ff_schro_queue_free(&p_schro_params->dec_frame_queue,
377                         libschroedinger_decode_frame_free);
378
379     ff_schro_queue_init(&p_schro_params->dec_frame_queue);
380     schro_decoder_reset(p_schro_params->decoder);
381     p_schro_params->eos_pulled = 0;
382     p_schro_params->eos_signalled = 0;
383 }
384
385 AVCodec ff_libschroedinger_decoder = {
386     .name           = "libschroedinger",
387     .type           = AVMEDIA_TYPE_VIDEO,
388     .id             = CODEC_ID_DIRAC,
389     .priv_data_size = sizeof(SchroDecoderParams),
390     .init           = libschroedinger_decode_init,
391     .close          = libschroedinger_decode_close,
392     .decode         = libschroedinger_decode_frame,
393     .capabilities   = CODEC_CAP_DELAY,
394     .flush          = libschroedinger_flush,
395     .long_name      = NULL_IF_CONFIG_SMALL("libschroedinger Dirac 2.2"),
396 };