avcodec/idctdsp: Clear idct/idct_add for studio profile
[ffmpeg.git] / libavcodec / libopenjpegdec.c
1 /*
2  * JPEG 2000 decoding support via OpenJPEG
3  * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
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  * JPEG 2000 decoder using libopenjpeg
25  */
26
27 #include "libavutil/common.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/intreadwrite.h"
30 #include "libavutil/opt.h"
31 #include "libavutil/pixfmt.h"
32
33 #include "avcodec.h"
34 #include "internal.h"
35 #include "thread.h"
36
37 #include <openjpeg.h>
38
39 #define JP2_SIG_TYPE    0x6A502020
40 #define JP2_SIG_VALUE   0x0D0A870A
41
42 // pix_fmts with lower bpp have to be listed before
43 // similar pix_fmts with higher bpp.
44 #define RGB_PIXEL_FORMATS  AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA,                 \
45                            AV_PIX_FMT_RGB48, AV_PIX_FMT_RGBA64
46
47 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8,                  \
48                            AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16
49
50 #define YUV_PIXEL_FORMATS  AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
51                            AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
52                            AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
53                            AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
54                            AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
55                            AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
56                            AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
57                            AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
58                            AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
59                            AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
60                            AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
61
62 #define XYZ_PIXEL_FORMATS  AV_PIX_FMT_XYZ12
63
64 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[]  = {
65     RGB_PIXEL_FORMATS
66 };
67 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
68     GRAY_PIXEL_FORMATS
69 };
70 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[]  = {
71     YUV_PIXEL_FORMATS
72 };
73 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[]  = {
74     RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
75 };
76
77 typedef struct LibOpenJPEGContext {
78     AVClass *class;
79     opj_dparameters_t dec_params;
80     int lowqual;
81 } LibOpenJPEGContext;
82
83 static void error_callback(const char *msg, void *data)
84 {
85     av_log(data, AV_LOG_ERROR, "%s", msg);
86 }
87
88 static void warning_callback(const char *msg, void *data)
89 {
90     av_log(data, AV_LOG_WARNING, "%s", msg);
91 }
92
93 static void info_callback(const char *msg, void *data)
94 {
95     av_log(data, AV_LOG_DEBUG, "%s", msg);
96 }
97
98 typedef struct BufferReader {
99     int pos;
100     int size;
101     const uint8_t *buffer;
102 } BufferReader;
103
104 static OPJ_SIZE_T stream_read(void *out_buffer, OPJ_SIZE_T nb_bytes, void *user_data)
105 {
106     BufferReader *reader = user_data;
107     int remaining;
108
109     if (reader->pos == reader->size) {
110         return (OPJ_SIZE_T)-1;
111     }
112     remaining = reader->size - reader->pos;
113     if (nb_bytes > remaining) {
114         nb_bytes = remaining;
115     }
116     memcpy(out_buffer, reader->buffer + reader->pos, nb_bytes);
117     reader->pos += (int)nb_bytes;
118     return nb_bytes;
119 }
120
121 static OPJ_OFF_T stream_skip(OPJ_OFF_T nb_bytes, void *user_data)
122 {
123     BufferReader *reader = user_data;
124     if (nb_bytes < 0) {
125         if (reader->pos == 0) {
126             return (OPJ_SIZE_T)-1;
127         }
128         if (nb_bytes + reader->pos < 0) {
129             nb_bytes = -reader->pos;
130         }
131     } else {
132         int remaining;
133
134         if (reader->pos == reader->size) {
135             return (OPJ_SIZE_T)-1;
136         }
137         remaining = reader->size - reader->pos;
138         if (nb_bytes > remaining) {
139             nb_bytes = remaining;
140         }
141     }
142     reader->pos += (int)nb_bytes;
143     return nb_bytes;
144 }
145
146 static OPJ_BOOL stream_seek(OPJ_OFF_T nb_bytes, void *user_data)
147 {
148     BufferReader *reader = user_data;
149     if (nb_bytes < 0 || nb_bytes > reader->size) {
150         return OPJ_FALSE;
151     }
152     reader->pos = (int)nb_bytes;
153     return OPJ_TRUE;
154 }
155
156 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
157 {
158     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
159     int match = 1;
160
161     if (desc->nb_components != image->numcomps) {
162         return 0;
163     }
164
165     switch (desc->nb_components) {
166     case 4:
167         match = match &&
168                 desc->comp[3].depth >= image->comps[3].prec &&
169                 1 == image->comps[3].dx &&
170                 1 == image->comps[3].dy;
171     case 3:
172         match = match &&
173                 desc->comp[2].depth >= image->comps[2].prec &&
174                 1 << desc->log2_chroma_w == image->comps[2].dx &&
175                 1 << desc->log2_chroma_h == image->comps[2].dy;
176     case 2:
177         match = match &&
178                 desc->comp[1].depth >= image->comps[1].prec &&
179                 1 << desc->log2_chroma_w == image->comps[1].dx &&
180                 1 << desc->log2_chroma_h == image->comps[1].dy;
181     case 1:
182         match = match &&
183                 desc->comp[0].depth >= image->comps[0].prec &&
184                 1 == image->comps[0].dx &&
185                 1 == image->comps[0].dy;
186     default:
187         break;
188     }
189
190     return match;
191 }
192
193 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
194     int index;
195     const enum AVPixelFormat *possible_fmts = NULL;
196     int possible_fmts_nb = 0;
197
198     switch (image->color_space) {
199     case OPJ_CLRSPC_SRGB:
200         possible_fmts    = libopenjpeg_rgb_pix_fmts;
201         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
202         break;
203     case OPJ_CLRSPC_GRAY:
204         possible_fmts    = libopenjpeg_gray_pix_fmts;
205         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
206         break;
207     case OPJ_CLRSPC_SYCC:
208         possible_fmts    = libopenjpeg_yuv_pix_fmts;
209         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
210         break;
211     default:
212         possible_fmts    = libopenjpeg_all_pix_fmts;
213         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
214         break;
215     }
216
217     for (index = 0; index < possible_fmts_nb; ++index)
218         if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
219             return possible_fmts[index];
220         }
221
222     return AV_PIX_FMT_NONE;
223 }
224
225 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
226 {
227     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
228     int i, component_plane;
229
230     if (pix_fmt == AV_PIX_FMT_GRAY16)
231         return 0;
232
233     component_plane = desc->comp[0].plane;
234     for (i = 1; i < desc->nb_components; i++)
235         if (component_plane != desc->comp[i].plane)
236             return 0;
237     return 1;
238 }
239
240 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
241     uint8_t *img_ptr;
242     int index, x, y, c;
243     for (y = 0; y < picture->height; y++) {
244         index   = y * picture->width;
245         img_ptr = picture->data[0] + y * picture->linesize[0];
246         for (x = 0; x < picture->width; x++, index++)
247             for (c = 0; c < image->numcomps; c++)
248                 *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
249     }
250 }
251
252 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
253     uint16_t *img_ptr;
254     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
255     int index, x, y, c;
256     int adjust[4];
257     for (x = 0; x < image->numcomps; x++)
258         adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
259
260     for (y = 0; y < picture->height; y++) {
261         index   = y * picture->width;
262         img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
263         for (x = 0; x < picture->width; x++, index++)
264             for (c = 0; c < image->numcomps; c++)
265                 *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
266                              (unsigned)image->comps[c].data[index] << adjust[c];
267     }
268 }
269
270 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
271     int *comp_data;
272     uint8_t *img_ptr;
273     int index, x, y;
274
275     for (index = 0; index < image->numcomps; index++) {
276         comp_data = image->comps[index].data;
277         for (y = 0; y < image->comps[index].h; y++) {
278             img_ptr = picture->data[index] + y * picture->linesize[index];
279             for (x = 0; x < image->comps[index].w; x++) {
280                 *img_ptr = 0x80 * image->comps[index].sgnd + *comp_data;
281                 img_ptr++;
282                 comp_data++;
283             }
284         }
285     }
286 }
287
288 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
289     int *comp_data;
290     uint16_t *img_ptr;
291     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
292     int index, x, y;
293     int adjust[4];
294     for (x = 0; x < image->numcomps; x++)
295         adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
296
297     for (index = 0; index < image->numcomps; index++) {
298         comp_data = image->comps[index].data;
299         for (y = 0; y < image->comps[index].h; y++) {
300             img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
301             for (x = 0; x < image->comps[index].w; x++) {
302                 *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
303                            (unsigned)*comp_data << adjust[index];
304                 img_ptr++;
305                 comp_data++;
306             }
307         }
308     }
309 }
310
311 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
312 {
313     LibOpenJPEGContext *ctx = avctx->priv_data;
314
315     opj_set_default_decoder_parameters(&ctx->dec_params);
316     return 0;
317 }
318
319 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
320                                     void *data, int *got_frame,
321                                     AVPacket *avpkt)
322 {
323     uint8_t *buf            = avpkt->data;
324     int buf_size            = avpkt->size;
325     LibOpenJPEGContext *ctx = avctx->priv_data;
326     ThreadFrame frame       = { .f = data };
327     AVFrame *picture        = data;
328     const AVPixFmtDescriptor *desc;
329     int width, height, ret;
330     int pixel_size = 0;
331     int ispacked   = 0;
332     int i;
333     opj_image_t *image = NULL;
334     BufferReader reader = {0, avpkt->size, avpkt->data};
335     opj_codec_t *dec = NULL;
336     opj_stream_t *stream = NULL;
337
338     *got_frame = 0;
339
340     // Check if input is a raw jpeg2k codestream or in jp2 wrapping
341     if ((AV_RB32(buf) == 12) &&
342         (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
343         (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
344         dec = opj_create_decompress(OPJ_CODEC_JP2);
345     } else {
346         /* If the AVPacket contains a jp2c box, then skip to
347          * the starting byte of the codestream. */
348         if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
349             buf += 8;
350         dec = opj_create_decompress(OPJ_CODEC_J2K);
351     }
352
353     if (!dec) {
354         av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
355         ret = AVERROR_EXTERNAL;
356         goto done;
357     }
358
359     if (!opj_set_error_handler(dec, error_callback, avctx) ||
360         !opj_set_warning_handler(dec, warning_callback, avctx) ||
361         !opj_set_info_handler(dec, info_callback, avctx)) {
362         av_log(avctx, AV_LOG_ERROR, "Error setting decoder handlers.\n");
363         ret = AVERROR_EXTERNAL;
364         goto done;
365     }
366
367     ctx->dec_params.cp_layer = ctx->lowqual;
368     ctx->dec_params.cp_reduce = avctx->lowres;
369
370     // Tie decoder with decoding parameters
371     opj_setup_decoder(dec, &ctx->dec_params);
372
373     stream = opj_stream_default_create(OPJ_STREAM_READ);
374
375     if (!stream) {
376         av_log(avctx, AV_LOG_ERROR,
377                "Codestream could not be opened for reading.\n");
378         ret = AVERROR_EXTERNAL;
379         goto done;
380     }
381
382     opj_stream_set_read_function(stream, stream_read);
383     opj_stream_set_skip_function(stream, stream_skip);
384     opj_stream_set_seek_function(stream, stream_seek);
385     opj_stream_set_user_data(stream, &reader, NULL);
386     opj_stream_set_user_data_length(stream, avpkt->size);
387     // Decode the header only.
388     ret = !opj_read_header(stream, dec, &image);
389
390     if (ret) {
391         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream header.\n");
392         ret = AVERROR_EXTERNAL;
393         goto done;
394     }
395
396     width  = image->x1 - image->x0;
397     height = image->y1 - image->y0;
398
399     ret = ff_set_dimensions(avctx, width, height);
400     if (ret < 0)
401         goto done;
402
403     if (avctx->pix_fmt != AV_PIX_FMT_NONE)
404         if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
405             avctx->pix_fmt = AV_PIX_FMT_NONE;
406
407     if (avctx->pix_fmt == AV_PIX_FMT_NONE)
408         avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
409
410     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
411         av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format.\n");
412         ret = AVERROR_UNKNOWN;
413         goto done;
414     }
415     for (i = 0; i < image->numcomps; i++)
416         if (image->comps[i].prec > avctx->bits_per_raw_sample)
417             avctx->bits_per_raw_sample = image->comps[i].prec;
418
419     if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
420         goto done;
421
422     ret = !opj_decode(dec, stream, image);
423
424     if (ret) {
425         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
426         ret = AVERROR_EXTERNAL;
427         goto done;
428     }
429
430     for (i = 0; i < image->numcomps; i++) {
431         if (!image->comps[i].data) {
432             av_log(avctx, AV_LOG_ERROR,
433                    "Image component %d contains no data.\n", i);
434             ret = AVERROR_INVALIDDATA;
435             goto done;
436         }
437     }
438
439     desc       = av_pix_fmt_desc_get(avctx->pix_fmt);
440     pixel_size = desc->comp[0].step;
441     ispacked   = libopenjpeg_ispacked(avctx->pix_fmt);
442
443     switch (pixel_size) {
444     case 1:
445         if (ispacked) {
446             libopenjpeg_copy_to_packed8(picture, image);
447         } else {
448             libopenjpeg_copyto8(picture, image);
449         }
450         break;
451     case 2:
452         if (ispacked) {
453             libopenjpeg_copy_to_packed8(picture, image);
454         } else {
455             libopenjpeg_copyto16(picture, image);
456         }
457         break;
458     case 3:
459     case 4:
460         if (ispacked) {
461             libopenjpeg_copy_to_packed8(picture, image);
462         }
463         break;
464     case 6:
465     case 8:
466         if (ispacked) {
467             libopenjpeg_copy_to_packed16(picture, image);
468         }
469         break;
470     default:
471         avpriv_report_missing_feature(avctx, "Pixel size %d", pixel_size);
472         ret = AVERROR_PATCHWELCOME;
473         goto done;
474     }
475
476     *got_frame = 1;
477     picture->pict_type = AV_PICTURE_TYPE_I;
478     picture->key_frame = 1;
479     ret        = buf_size;
480
481 done:
482     opj_image_destroy(image);
483     opj_stream_destroy(stream);
484     opj_destroy_codec(dec);
485     return ret;
486 }
487
488 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
489 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
490
491 static const AVOption options[] = {
492     { "lowqual", "Limit the number of layers used for decoding",
493         OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
494     { NULL },
495 };
496
497 static const AVClass openjpeg_class = {
498     .class_name = "libopenjpeg",
499     .item_name  = av_default_item_name,
500     .option     = options,
501     .version    = LIBAVUTIL_VERSION_INT,
502 };
503
504 AVCodec ff_libopenjpeg_decoder = {
505     .name           = "libopenjpeg",
506     .long_name      = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
507     .type           = AVMEDIA_TYPE_VIDEO,
508     .id             = AV_CODEC_ID_JPEG2000,
509     .priv_data_size = sizeof(LibOpenJPEGContext),
510     .init           = libopenjpeg_decode_init,
511     .decode         = libopenjpeg_decode_frame,
512     .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
513     .max_lowres     = 31,
514     .priv_class     = &openjpeg_class,
515     .wrapper_name   = "libopenjpeg",
516 };