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