5f3c36bbe5ca51c1d755b5ed7269186dded48c36
[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 #include <openjpeg.h>
29
30 #include "libavutil/common.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/pixfmt.h"
34 #include "libavutil/opt.h"
35 #include "avcodec.h"
36 #include "thread.h"
37
38 #define JP2_SIG_TYPE    0x6A502020
39 #define JP2_SIG_VALUE   0x0D0A870A
40
41 // pix_fmts with lower bpp have to be listed before
42 // similar pix_fmts with higher bpp.
43 #define RGB_PIXEL_FORMATS   AV_PIX_FMT_RGB24,AV_PIX_FMT_RGBA,AV_PIX_FMT_RGB48,AV_PIX_FMT_RGBA64
44 #define GRAY_PIXEL_FORMATS  AV_PIX_FMT_GRAY8,AV_PIX_FMT_GRAY8A,AV_PIX_FMT_GRAY16
45 #define YUV_PIXEL_FORMATS   AV_PIX_FMT_YUV410P,AV_PIX_FMT_YUV411P,AV_PIX_FMT_YUVA420P, \
46                             AV_PIX_FMT_YUV420P,AV_PIX_FMT_YUV422P,AV_PIX_FMT_YUVA422P, \
47                             AV_PIX_FMT_YUV440P,AV_PIX_FMT_YUV444P,AV_PIX_FMT_YUVA444P, \
48                             AV_PIX_FMT_YUV420P9,AV_PIX_FMT_YUV422P9,AV_PIX_FMT_YUV444P9, \
49                             AV_PIX_FMT_YUVA420P9,AV_PIX_FMT_YUVA422P9,AV_PIX_FMT_YUVA444P9, \
50                             AV_PIX_FMT_YUV420P10,AV_PIX_FMT_YUV422P10,AV_PIX_FMT_YUV444P10, \
51                             AV_PIX_FMT_YUVA420P10,AV_PIX_FMT_YUVA422P10,AV_PIX_FMT_YUVA444P10, \
52                             AV_PIX_FMT_YUV420P12,AV_PIX_FMT_YUV422P12,AV_PIX_FMT_YUV444P12, \
53                             AV_PIX_FMT_YUV420P14,AV_PIX_FMT_YUV422P14,AV_PIX_FMT_YUV444P14, \
54                             AV_PIX_FMT_YUV420P16,AV_PIX_FMT_YUV422P16,AV_PIX_FMT_YUV444P16, \
55                             AV_PIX_FMT_YUVA420P16,AV_PIX_FMT_YUVA422P16,AV_PIX_FMT_YUVA444P16
56
57 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[]  = {RGB_PIXEL_FORMATS};
58 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
59 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[]  = {YUV_PIXEL_FORMATS};
60 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[]  = {RGB_PIXEL_FORMATS,GRAY_PIXEL_FORMATS,YUV_PIXEL_FORMATS};
61
62 typedef struct {
63     AVClass *class;
64     opj_dparameters_t dec_params;
65     AVFrame image;
66     int lowqual;
67 } LibOpenJPEGContext;
68
69 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
70 {
71     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
72     int match = 1;
73
74     if (desc->nb_components != image->numcomps) {
75         return 0;
76     }
77
78     switch (desc->nb_components) {
79     case 4: match = match && desc->comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
80                              1 == image->comps[3].dx &&
81                              1 == image->comps[3].dy;
82     case 3: match = match && desc->comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
83                              1 << desc->log2_chroma_w == image->comps[2].dx &&
84                              1 << desc->log2_chroma_h == image->comps[2].dy;
85     case 2: match = match && desc->comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
86                              1 << desc->log2_chroma_w == image->comps[1].dx &&
87                              1 << desc->log2_chroma_h == image->comps[1].dy;
88     case 1: match = match && desc->comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
89                              1 == image->comps[0].dx &&
90                              1 == image->comps[0].dy;
91     default:
92         break;
93     }
94
95     return match;
96 }
97
98 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
99     int index;
100     const enum AVPixelFormat *possible_fmts = NULL;
101     int possible_fmts_nb = 0;
102
103     switch (image->color_space) {
104     case CLRSPC_SRGB:
105         possible_fmts = libopenjpeg_rgb_pix_fmts;
106         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
107         break;
108     case CLRSPC_GRAY:
109         possible_fmts = libopenjpeg_gray_pix_fmts;
110         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
111         break;
112     case CLRSPC_SYCC:
113         possible_fmts = libopenjpeg_yuv_pix_fmts;
114         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
115         break;
116     default:
117         possible_fmts = libopenjpeg_all_pix_fmts;
118         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
119         break;
120     }
121
122     for (index = 0; index < possible_fmts_nb; ++index) {
123         if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
124             return possible_fmts[index];
125         }
126     }
127
128     return AV_PIX_FMT_NONE;
129 }
130
131 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
132 {
133     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
134     int i, component_plane;
135
136     if (pix_fmt == AV_PIX_FMT_GRAY16)
137         return 0;
138
139     component_plane = desc->comp[0].plane;
140     for (i = 1; i < desc->nb_components; i++) {
141         if (component_plane != desc->comp[i].plane)
142             return 0;
143     }
144     return 1;
145 }
146
147 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
148     uint8_t *img_ptr;
149     int index, x, y, c;
150     for (y = 0; y < picture->height; y++) {
151         index = y*picture->width;
152         img_ptr = picture->data[0] + y*picture->linesize[0];
153         for (x = 0; x < picture->width; x++, index++) {
154             for (c = 0; c < image->numcomps; c++) {
155                 *img_ptr++ = image->comps[c].data[index];
156             }
157         }
158     }
159 }
160
161 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
162     uint16_t *img_ptr;
163     int index, x, y, c;
164     int adjust[4];
165     for (x = 0; x < image->numcomps; x++)
166         adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
167
168     for (y = 0; y < picture->height; y++) {
169         index = y*picture->width;
170         img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
171         for (x = 0; x < picture->width; x++, index++) {
172             for (c = 0; c < image->numcomps; c++) {
173                 *img_ptr++ = image->comps[c].data[index] << adjust[c];
174             }
175         }
176     }
177 }
178
179 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
180     int *comp_data;
181     uint8_t *img_ptr;
182     int index, x, y;
183
184     for (index = 0; index < image->numcomps; index++) {
185         comp_data = image->comps[index].data;
186         for (y = 0; y < image->comps[index].h; y++) {
187             img_ptr = picture->data[index] + y * picture->linesize[index];
188             for (x = 0; x < image->comps[index].w; x++) {
189                 *img_ptr = (uint8_t) *comp_data;
190                 img_ptr++;
191                 comp_data++;
192             }
193         }
194     }
195 }
196
197 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
198     int *comp_data;
199     uint16_t *img_ptr;
200     int index, x, y;
201     for (index = 0; index < image->numcomps; index++) {
202         comp_data = image->comps[index].data;
203         for (y = 0; y < image->comps[index].h; y++) {
204             img_ptr = (uint16_t*) (picture->data[index] + y * picture->linesize[index]);
205             for (x = 0; x < image->comps[index].w; x++) {
206                 *img_ptr = *comp_data;
207                 img_ptr++;
208                 comp_data++;
209             }
210         }
211     }
212 }
213
214 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
215 {
216     LibOpenJPEGContext *ctx = avctx->priv_data;
217
218     opj_set_default_decoder_parameters(&ctx->dec_params);
219     avcodec_get_frame_defaults(&ctx->image);
220     avctx->coded_frame = &ctx->image;
221     return 0;
222 }
223
224 static av_cold int libopenjpeg_decode_init_thread_copy(AVCodecContext *avctx)
225 {
226     LibOpenJPEGContext *ctx = avctx->priv_data;
227
228     avctx->coded_frame = &ctx->image;
229     return 0;
230 }
231
232 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
233                                     void *data, int *data_size,
234                                     AVPacket *avpkt)
235 {
236     uint8_t *buf = avpkt->data;
237     int buf_size = avpkt->size;
238     LibOpenJPEGContext *ctx = avctx->priv_data;
239     AVFrame *picture = &ctx->image, *output = 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     *data_size = 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 (picture->data[0])
319         ff_thread_release_buffer(avctx, picture);
320
321     if (ff_thread_get_buffer(avctx, picture) < 0) {
322         av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
323         goto done;
324     }
325
326     ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
327     ctx->dec_params.cp_reduce = avctx->lowres;
328     // Tie decoder with decoding parameters.
329     opj_setup_decoder(dec, &ctx->dec_params);
330     stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
331     if (!stream) {
332         av_log(avctx, AV_LOG_ERROR,
333                "Codestream could not be opened for reading.\n");
334         goto done;
335     }
336
337     opj_image_destroy(image);
338     // Decode the codestream
339     image = opj_decode_with_info(dec, stream, NULL);
340     opj_cio_close(stream);
341
342     if (!image) {
343         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
344         goto done;
345     }
346
347     desc = av_pix_fmt_desc_get(avctx->pix_fmt);
348     pixel_size = desc->comp[0].step_minus1 + 1;
349     ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
350
351     switch (pixel_size) {
352     case 1:
353         if (ispacked) {
354             libopenjpeg_copy_to_packed8(picture, image);
355         } else {
356             libopenjpeg_copyto8(picture, image);
357         }
358         break;
359     case 2:
360         if (ispacked) {
361             libopenjpeg_copy_to_packed8(picture, image);
362         } else {
363             libopenjpeg_copyto16(picture, image);
364         }
365         break;
366     case 3:
367     case 4:
368         if (ispacked) {
369             libopenjpeg_copy_to_packed8(picture, image);
370         }
371         break;
372     case 6:
373     case 8:
374         if (ispacked) {
375             libopenjpeg_copy_to_packed16(picture, image);
376         }
377         break;
378     default:
379         av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
380         goto done;
381     }
382
383     *output    = ctx->image;
384     *data_size = sizeof(AVPicture);
385     ret        = buf_size;
386
387 done:
388     opj_image_destroy(image);
389     opj_destroy_decompress(dec);
390     return ret;
391 }
392
393 static av_cold int libopenjpeg_decode_close(AVCodecContext *avctx)
394 {
395     LibOpenJPEGContext *ctx = avctx->priv_data;
396
397     if (ctx->image.data[0])
398         ff_thread_release_buffer(avctx, &ctx->image);
399     return 0;
400 }
401
402 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
403 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
404
405 static const AVOption options[] = {
406     { "lowqual", "Limit the number of layers used for decoding",    OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
407     { NULL },
408 };
409
410 static const AVClass class = {
411     .class_name = "libopenjpeg",
412     .item_name  = av_default_item_name,
413     .option     = options,
414     .version    = LIBAVUTIL_VERSION_INT,
415 };
416
417 AVCodec ff_libopenjpeg_decoder = {
418     .name             = "libopenjpeg",
419     .type             = AVMEDIA_TYPE_VIDEO,
420     .id               = AV_CODEC_ID_JPEG2000,
421     .priv_data_size   = sizeof(LibOpenJPEGContext),
422     .init             = libopenjpeg_decode_init,
423     .close            = libopenjpeg_decode_close,
424     .decode           = libopenjpeg_decode_frame,
425     .capabilities     = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
426     .max_lowres       = 31,
427     .long_name        = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
428     .priv_class       = &class,
429     .init_thread_copy = ONLY_IF_THREADS_ENABLED(libopenjpeg_decode_init_thread_copy),
430 };