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