5476e0a70a8b6da54013f31e70870a488f4deeaa
[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 #define  OPJ_STATIC
28
29 #include "libavutil/common.h"
30 #include "libavutil/intreadwrite.h"
31 #include "libavutil/imgutils.h"
32 #include "libavutil/pixfmt.h"
33 #include "libavutil/opt.h"
34 #include "avcodec.h"
35 #include "thread.h"
36
37 #if HAVE_OPENJPEG_1_5_OPENJPEG_H
38 # include <openjpeg-1.5/openjpeg.h>
39 #else
40 # include <openjpeg.h>
41 #endif
42
43 #define JP2_SIG_TYPE    0x6A502020
44 #define JP2_SIG_VALUE   0x0D0A870A
45
46 // pix_fmts with lower bpp have to be listed before
47 // similar pix_fmts with higher bpp.
48 #define RGB_PIXEL_FORMATS   AV_PIX_FMT_RGB24,AV_PIX_FMT_RGBA,AV_PIX_FMT_RGB48,AV_PIX_FMT_RGBA64
49 #define GRAY_PIXEL_FORMATS  AV_PIX_FMT_GRAY8,AV_PIX_FMT_GRAY8A,AV_PIX_FMT_GRAY16
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 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[]  = {RGB_PIXEL_FORMATS};
63 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
64 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[]  = {YUV_PIXEL_FORMATS};
65 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[]  = {RGB_PIXEL_FORMATS,GRAY_PIXEL_FORMATS,YUV_PIXEL_FORMATS};
66
67 typedef struct {
68     AVClass *class;
69     opj_dparameters_t dec_params;
70     int lowqual;
71 } LibOpenJPEGContext;
72
73 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
74 {
75     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
76     int match = 1;
77
78     if (desc->nb_components != image->numcomps) {
79         return 0;
80     }
81
82     switch (desc->nb_components) {
83     case 4: match = match && desc->comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
84                              1 == image->comps[3].dx &&
85                              1 == image->comps[3].dy;
86     case 3: match = match && desc->comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
87                              1 << desc->log2_chroma_w == image->comps[2].dx &&
88                              1 << desc->log2_chroma_h == image->comps[2].dy;
89     case 2: match = match && desc->comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
90                              1 << desc->log2_chroma_w == image->comps[1].dx &&
91                              1 << desc->log2_chroma_h == image->comps[1].dy;
92     case 1: match = match && desc->comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
93                              1 == image->comps[0].dx &&
94                              1 == image->comps[0].dy;
95     default:
96         break;
97     }
98
99     return match;
100 }
101
102 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
103     int index;
104     const enum AVPixelFormat *possible_fmts = NULL;
105     int possible_fmts_nb = 0;
106
107     switch (image->color_space) {
108     case CLRSPC_SRGB:
109         possible_fmts = libopenjpeg_rgb_pix_fmts;
110         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
111         break;
112     case CLRSPC_GRAY:
113         possible_fmts = libopenjpeg_gray_pix_fmts;
114         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
115         break;
116     case CLRSPC_SYCC:
117         possible_fmts = libopenjpeg_yuv_pix_fmts;
118         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
119         break;
120     default:
121         possible_fmts = libopenjpeg_all_pix_fmts;
122         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
123         break;
124     }
125
126     for (index = 0; index < possible_fmts_nb; ++index) {
127         if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
128             return possible_fmts[index];
129         }
130     }
131
132     return AV_PIX_FMT_NONE;
133 }
134
135 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
136 {
137     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
138     int i, component_plane;
139
140     if (pix_fmt == AV_PIX_FMT_GRAY16)
141         return 0;
142
143     component_plane = desc->comp[0].plane;
144     for (i = 1; i < desc->nb_components; i++) {
145         if (component_plane != desc->comp[i].plane)
146             return 0;
147     }
148     return 1;
149 }
150
151 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
152     uint8_t *img_ptr;
153     int index, x, y, c;
154     for (y = 0; y < picture->height; y++) {
155         index = y*picture->width;
156         img_ptr = picture->data[0] + y*picture->linesize[0];
157         for (x = 0; x < picture->width; x++, index++) {
158             for (c = 0; c < image->numcomps; c++) {
159                 *img_ptr++ = image->comps[c].data[index];
160             }
161         }
162     }
163 }
164
165 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
166     uint16_t *img_ptr;
167     int index, x, y, c;
168     int adjust[4];
169     for (x = 0; x < image->numcomps; x++)
170         adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
171
172     for (y = 0; y < picture->height; y++) {
173         index = y*picture->width;
174         img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
175         for (x = 0; x < picture->width; x++, index++) {
176             for (c = 0; c < image->numcomps; c++) {
177                 *img_ptr++ = image->comps[c].data[index] << adjust[c];
178             }
179         }
180     }
181 }
182
183 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
184     int *comp_data;
185     uint8_t *img_ptr;
186     int index, x, y;
187
188     for (index = 0; index < image->numcomps; index++) {
189         comp_data = image->comps[index].data;
190         for (y = 0; y < image->comps[index].h; y++) {
191             img_ptr = picture->data[index] + y * picture->linesize[index];
192             for (x = 0; x < image->comps[index].w; x++) {
193                 *img_ptr = (uint8_t) *comp_data;
194                 img_ptr++;
195                 comp_data++;
196             }
197         }
198     }
199 }
200
201 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
202     int *comp_data;
203     uint16_t *img_ptr;
204     int index, x, y;
205     for (index = 0; index < image->numcomps; index++) {
206         comp_data = image->comps[index].data;
207         for (y = 0; y < image->comps[index].h; y++) {
208             img_ptr = (uint16_t*) (picture->data[index] + y * picture->linesize[index]);
209             for (x = 0; x < image->comps[index].w; x++) {
210                 *img_ptr = *comp_data;
211                 img_ptr++;
212                 comp_data++;
213             }
214         }
215     }
216 }
217
218 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
219 {
220     LibOpenJPEGContext *ctx = avctx->priv_data;
221
222     opj_set_default_decoder_parameters(&ctx->dec_params);
223     return 0;
224 }
225
226 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
227                                     void *data, int *got_frame,
228                                     AVPacket *avpkt)
229 {
230     uint8_t *buf = avpkt->data;
231     int buf_size = avpkt->size;
232     LibOpenJPEGContext *ctx = avctx->priv_data;
233     ThreadFrame frame = { .f = data };
234     AVFrame *picture  = data;
235     const AVPixFmtDescriptor *desc;
236     opj_dinfo_t *dec;
237     opj_cio_t *stream;
238     opj_image_t *image;
239     int width, height, ret = -1;
240     int pixel_size = 0;
241     int ispacked = 0;
242     int i;
243
244     *got_frame = 0;
245
246     // Check if input is a raw jpeg2k codestream or in jp2 wrapping
247     if ((AV_RB32(buf)     == 12)           &&
248         (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
249         (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
250         dec = opj_create_decompress(CODEC_JP2);
251     } else {
252         /* If the AVPacket contains a jp2c box, then skip to
253          * the starting byte of the codestream. */
254         if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
255             buf += 8;
256         dec = opj_create_decompress(CODEC_J2K);
257     }
258
259     if (!dec) {
260         av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
261         return -1;
262     }
263     opj_set_event_mgr((opj_common_ptr)dec, NULL, NULL);
264     ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
265     ctx->dec_params.cp_layer          = ctx->lowqual;
266     // Tie decoder with decoding parameters
267     opj_setup_decoder(dec, &ctx->dec_params);
268     stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
269
270     if (!stream) {
271         av_log(avctx, AV_LOG_ERROR,
272                "Codestream could not be opened for reading.\n");
273         opj_destroy_decompress(dec);
274         return -1;
275     }
276
277     // Decode the header only.
278     image = opj_decode_with_info(dec, stream, NULL);
279     opj_cio_close(stream);
280
281     if (!image) {
282         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
283         opj_destroy_decompress(dec);
284         return -1;
285     }
286
287     width  = image->x1 - image->x0;
288     height = image->y1 - image->y0;
289
290     if (av_image_check_size(width, height, 0, avctx) < 0) {
291         av_log(avctx, AV_LOG_ERROR,
292                "%dx%d dimension invalid.\n", width, height);
293         goto done;
294     }
295
296     avcodec_set_dimensions(avctx, width, height);
297
298     if (avctx->pix_fmt != AV_PIX_FMT_NONE)
299         if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
300             avctx->pix_fmt = AV_PIX_FMT_NONE;
301
302     if (avctx->pix_fmt == AV_PIX_FMT_NONE)
303         avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
304
305     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
306         av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
307         goto done;
308     }
309     for (i = 0; i < image->numcomps; i++)
310         if (image->comps[i].prec > avctx->bits_per_raw_sample)
311             avctx->bits_per_raw_sample = image->comps[i].prec;
312
313     if (ff_thread_get_buffer(avctx, &frame, 0) < 0) {
314         av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
315         goto done;
316     }
317
318     ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
319     ctx->dec_params.cp_reduce = avctx->lowres;
320     // Tie decoder with decoding parameters.
321     opj_setup_decoder(dec, &ctx->dec_params);
322     stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
323     if (!stream) {
324         av_log(avctx, AV_LOG_ERROR,
325                "Codestream could not be opened for reading.\n");
326         goto done;
327     }
328
329     opj_image_destroy(image);
330     // Decode the codestream
331     image = opj_decode_with_info(dec, stream, NULL);
332     opj_cio_close(stream);
333
334     if (!image) {
335         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
336         goto done;
337     }
338
339     desc = av_pix_fmt_desc_get(avctx->pix_fmt);
340     pixel_size = desc->comp[0].step_minus1 + 1;
341     ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
342
343     switch (pixel_size) {
344     case 1:
345         if (ispacked) {
346             libopenjpeg_copy_to_packed8(picture, image);
347         } else {
348             libopenjpeg_copyto8(picture, image);
349         }
350         break;
351     case 2:
352         if (ispacked) {
353             libopenjpeg_copy_to_packed8(picture, image);
354         } else {
355             libopenjpeg_copyto16(picture, image);
356         }
357         break;
358     case 3:
359     case 4:
360         if (ispacked) {
361             libopenjpeg_copy_to_packed8(picture, image);
362         }
363         break;
364     case 6:
365     case 8:
366         if (ispacked) {
367             libopenjpeg_copy_to_packed16(picture, image);
368         }
369         break;
370     default:
371         av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
372         goto done;
373     }
374
375     *got_frame = 1;
376     ret        = buf_size;
377
378 done:
379     opj_image_destroy(image);
380     opj_destroy_decompress(dec);
381     return ret;
382 }
383
384 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
385 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
386
387 static const AVOption options[] = {
388     { "lowqual", "Limit the number of layers used for decoding",    OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
389     { NULL },
390 };
391
392 static const AVClass class = {
393     .class_name = "libopenjpeg",
394     .item_name  = av_default_item_name,
395     .option     = options,
396     .version    = LIBAVUTIL_VERSION_INT,
397 };
398
399 AVCodec ff_libopenjpeg_decoder = {
400     .name             = "libopenjpeg",
401     .type             = AVMEDIA_TYPE_VIDEO,
402     .id               = AV_CODEC_ID_JPEG2000,
403     .priv_data_size   = sizeof(LibOpenJPEGContext),
404     .init             = libopenjpeg_decode_init,
405     .decode           = libopenjpeg_decode_frame,
406     .capabilities     = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
407     .max_lowres       = 31,
408     .long_name        = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
409     .priv_class       = &class,
410 };