2 * JPEG 2000 decoding support via OpenJPEG
3 * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
5 * This file is part of FFmpeg.
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.
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.
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
24 * JPEG 2000 decoder using libopenjpeg
29 #include "libavutil/common.h"
30 #include "libavutil/imgutils.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/opt.h"
33 #include "libavutil/pixfmt.h"
39 #if HAVE_OPENJPEG_2_1_OPENJPEG_H
40 # include <openjpeg-2.1/openjpeg.h>
41 #elif HAVE_OPENJPEG_2_0_OPENJPEG_H
42 # include <openjpeg-2.0/openjpeg.h>
43 #elif HAVE_OPENJPEG_1_5_OPENJPEG_H
44 # include <openjpeg-1.5/openjpeg.h>
46 # include <openjpeg.h>
49 #if HAVE_OPENJPEG_2_1_OPENJPEG_H || HAVE_OPENJPEG_2_0_OPENJPEG_H
50 # define OPENJPEG_MAJOR_VERSION 2
51 # define OPJ(x) OPJ_##x
53 # define OPENJPEG_MAJOR_VERSION 1
57 #define JP2_SIG_TYPE 0x6A502020
58 #define JP2_SIG_VALUE 0x0D0A870A
60 // pix_fmts with lower bpp have to be listed before
61 // similar pix_fmts with higher bpp.
62 #define RGB_PIXEL_FORMATS AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA, \
63 AV_PIX_FMT_RGB48, AV_PIX_FMT_RGBA64
65 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8, \
66 AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16
68 #define YUV_PIXEL_FORMATS AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
69 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
70 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
71 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
72 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
73 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
74 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
75 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
76 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
77 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
78 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
80 #define XYZ_PIXEL_FORMATS AV_PIX_FMT_XYZ12
82 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[] = {
85 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
88 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[] = {
91 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[] = {
92 RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
95 typedef struct LibOpenJPEGContext {
97 opj_dparameters_t dec_params;
98 #if OPENJPEG_MAJOR_VERSION == 1
99 opj_event_mgr_t event_mgr;
100 #endif // OPENJPEG_MAJOR_VERSION == 1
102 } LibOpenJPEGContext;
104 static void error_callback(const char *msg, void *data)
106 av_log(data, AV_LOG_ERROR, "%s", msg);
109 static void warning_callback(const char *msg, void *data)
111 av_log(data, AV_LOG_WARNING, "%s", msg);
114 static void info_callback(const char *msg, void *data)
116 av_log(data, AV_LOG_DEBUG, "%s", msg);
119 #if OPENJPEG_MAJOR_VERSION == 2
120 typedef struct BufferReader {
123 const uint8_t *buffer;
126 static OPJ_SIZE_T stream_read(void *out_buffer, OPJ_SIZE_T nb_bytes, void *user_data)
128 BufferReader *reader = user_data;
129 if (reader->pos == reader->size) {
130 return (OPJ_SIZE_T)-1;
132 int remaining = reader->size - reader->pos;
133 if (nb_bytes > remaining) {
134 nb_bytes = remaining;
136 memcpy(out_buffer, reader->buffer + reader->pos, nb_bytes);
137 reader->pos += (int)nb_bytes;
141 static OPJ_OFF_T stream_skip(OPJ_OFF_T nb_bytes, void *user_data)
143 BufferReader *reader = user_data;
145 if (reader->pos == 0) {
146 return (OPJ_SIZE_T)-1;
148 if (nb_bytes + reader->pos < 0) {
149 nb_bytes = -reader->pos;
152 if (reader->pos == reader->size) {
153 return (OPJ_SIZE_T)-1;
155 int remaining = reader->size - reader->pos;
156 if (nb_bytes > remaining) {
157 nb_bytes = remaining;
160 reader->pos += (int)nb_bytes;
164 static OPJ_BOOL stream_seek(OPJ_OFF_T nb_bytes, void *user_data)
166 BufferReader *reader = user_data;
167 if (nb_bytes < 0 || nb_bytes > reader->size) {
170 reader->pos = (int)nb_bytes;
173 #endif // OPENJPEG_MAJOR_VERSION == 2
175 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
177 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
180 if (desc->nb_components != image->numcomps) {
184 switch (desc->nb_components) {
187 desc->comp[3].depth >= image->comps[3].prec &&
188 1 == image->comps[3].dx &&
189 1 == image->comps[3].dy;
192 desc->comp[2].depth >= image->comps[2].prec &&
193 1 << desc->log2_chroma_w == image->comps[2].dx &&
194 1 << desc->log2_chroma_h == image->comps[2].dy;
197 desc->comp[1].depth >= image->comps[1].prec &&
198 1 << desc->log2_chroma_w == image->comps[1].dx &&
199 1 << desc->log2_chroma_h == image->comps[1].dy;
202 desc->comp[0].depth >= image->comps[0].prec &&
203 1 == image->comps[0].dx &&
204 1 == image->comps[0].dy;
212 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
214 const enum AVPixelFormat *possible_fmts = NULL;
215 int possible_fmts_nb = 0;
217 switch (image->color_space) {
218 case OPJ(CLRSPC_SRGB):
219 possible_fmts = libopenjpeg_rgb_pix_fmts;
220 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
222 case OPJ(CLRSPC_GRAY):
223 possible_fmts = libopenjpeg_gray_pix_fmts;
224 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
226 case OPJ(CLRSPC_SYCC):
227 possible_fmts = libopenjpeg_yuv_pix_fmts;
228 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
231 possible_fmts = libopenjpeg_all_pix_fmts;
232 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
236 for (index = 0; index < possible_fmts_nb; ++index)
237 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
238 return possible_fmts[index];
241 return AV_PIX_FMT_NONE;
244 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
246 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
247 int i, component_plane;
249 if (pix_fmt == AV_PIX_FMT_GRAY16)
252 component_plane = desc->comp[0].plane;
253 for (i = 1; i < desc->nb_components; i++)
254 if (component_plane != desc->comp[i].plane)
259 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
262 for (y = 0; y < picture->height; y++) {
263 index = y * picture->width;
264 img_ptr = picture->data[0] + y * picture->linesize[0];
265 for (x = 0; x < picture->width; x++, index++)
266 for (c = 0; c < image->numcomps; c++)
267 *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
271 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
273 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
276 for (x = 0; x < image->numcomps; x++)
277 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
279 for (y = 0; y < picture->height; y++) {
280 index = y * picture->width;
281 img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
282 for (x = 0; x < picture->width; x++, index++)
283 for (c = 0; c < image->numcomps; c++)
284 *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
285 (unsigned)image->comps[c].data[index] << adjust[c];
289 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
294 for (index = 0; index < image->numcomps; index++) {
295 comp_data = image->comps[index].data;
296 for (y = 0; y < image->comps[index].h; y++) {
297 img_ptr = picture->data[index] + y * picture->linesize[index];
298 for (x = 0; x < image->comps[index].w; x++) {
299 *img_ptr = 0x80 * image->comps[index].sgnd + *comp_data;
307 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
310 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
313 for (x = 0; x < image->numcomps; x++)
314 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
316 for (index = 0; index < image->numcomps; index++) {
317 comp_data = image->comps[index].data;
318 for (y = 0; y < image->comps[index].h; y++) {
319 img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
320 for (x = 0; x < image->comps[index].w; x++) {
321 *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
322 (unsigned)*comp_data << adjust[index];
330 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
332 LibOpenJPEGContext *ctx = avctx->priv_data;
334 opj_set_default_decoder_parameters(&ctx->dec_params);
338 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
339 void *data, int *got_frame,
342 uint8_t *buf = avpkt->data;
343 int buf_size = avpkt->size;
344 LibOpenJPEGContext *ctx = avctx->priv_data;
345 ThreadFrame frame = { .f = data };
346 AVFrame *picture = data;
347 const AVPixFmtDescriptor *desc;
348 int width, height, ret;
352 opj_image_t *image = NULL;
353 #if OPENJPEG_MAJOR_VERSION == 1
354 opj_dinfo_t *dec = NULL;
355 opj_cio_t *stream = NULL;
356 #else // OPENJPEG_MAJOR_VERSION == 2
357 BufferReader reader = {0, avpkt->size, avpkt->data};
358 opj_codec_t *dec = NULL;
359 opj_stream_t *stream = NULL;
360 #endif // OPENJPEG_MAJOR_VERSION == 1
364 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
365 if ((AV_RB32(buf) == 12) &&
366 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
367 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
368 dec = opj_create_decompress(OPJ(CODEC_JP2));
370 /* If the AVPacket contains a jp2c box, then skip to
371 * the starting byte of the codestream. */
372 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
374 dec = opj_create_decompress(OPJ(CODEC_J2K));
378 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
379 ret = AVERROR_EXTERNAL;
383 #if OPENJPEG_MAJOR_VERSION == 1
384 memset(&ctx->event_mgr, 0, sizeof(ctx->event_mgr));
385 ctx->event_mgr.info_handler = info_callback;
386 ctx->event_mgr.error_handler = error_callback;
387 ctx->event_mgr.warning_handler = warning_callback;
388 opj_set_event_mgr((opj_common_ptr) dec, &ctx->event_mgr, avctx);
389 ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
390 ctx->dec_params.cp_layer = ctx->lowqual;
391 #else // OPENJPEG_MAJOR_VERSION == 2
392 if (!opj_set_error_handler(dec, error_callback, avctx) ||
393 !opj_set_warning_handler(dec, warning_callback, avctx) ||
394 !opj_set_info_handler(dec, info_callback, avctx)) {
395 av_log(avctx, AV_LOG_ERROR, "Error setting decoder handlers.\n");
396 ret = AVERROR_EXTERNAL;
400 ctx->dec_params.cp_layer = ctx->lowqual;
401 ctx->dec_params.cp_reduce = avctx->lowres;
402 #endif // OPENJPEG_MAJOR_VERSION == 1
404 // Tie decoder with decoding parameters
405 opj_setup_decoder(dec, &ctx->dec_params);
407 #if OPENJPEG_MAJOR_VERSION == 1
408 stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
409 #else // OPENJPEG_MAJOR_VERSION == 2
410 stream = opj_stream_default_create(OPJ_STREAM_READ);
411 #endif // OPENJPEG_MAJOR_VERSION == 1
414 av_log(avctx, AV_LOG_ERROR,
415 "Codestream could not be opened for reading.\n");
416 ret = AVERROR_EXTERNAL;
420 #if OPENJPEG_MAJOR_VERSION == 1
421 // Decode the header only.
422 image = opj_decode_with_info(dec, stream, NULL);
423 opj_cio_close(stream);
426 #else // OPENJPEG_MAJOR_VERSION == 2
427 opj_stream_set_read_function(stream, stream_read);
428 opj_stream_set_skip_function(stream, stream_skip);
429 opj_stream_set_seek_function(stream, stream_seek);
430 #if HAVE_OPENJPEG_2_1_OPENJPEG_H
431 opj_stream_set_user_data(stream, &reader, NULL);
432 #elif HAVE_OPENJPEG_2_0_OPENJPEG_H
433 opj_stream_set_user_data(stream, &reader);
435 #error Missing call to opj_stream_set_user_data
437 opj_stream_set_user_data_length(stream, avpkt->size);
438 // Decode the header only.
439 ret = !opj_read_header(stream, dec, &image);
440 #endif // OPENJPEG_MAJOR_VERSION == 1
443 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream header.\n");
444 ret = AVERROR_EXTERNAL;
448 width = image->x1 - image->x0;
449 height = image->y1 - image->y0;
451 ret = ff_set_dimensions(avctx, width, height);
455 if (avctx->pix_fmt != AV_PIX_FMT_NONE)
456 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
457 avctx->pix_fmt = AV_PIX_FMT_NONE;
459 if (avctx->pix_fmt == AV_PIX_FMT_NONE)
460 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
462 if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
463 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format.\n");
464 ret = AVERROR_UNKNOWN;
467 for (i = 0; i < image->numcomps; i++)
468 if (image->comps[i].prec > avctx->bits_per_raw_sample)
469 avctx->bits_per_raw_sample = image->comps[i].prec;
471 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
474 #if OPENJPEG_MAJOR_VERSION == 1
475 ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
476 ctx->dec_params.cp_reduce = avctx->lowres;
477 // Tie decoder with decoding parameters.
478 opj_setup_decoder(dec, &ctx->dec_params);
479 stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
481 av_log(avctx, AV_LOG_ERROR,
482 "Codestream could not be opened for reading.\n");
483 ret = AVERROR_EXTERNAL;
486 opj_image_destroy(image);
487 // Decode the codestream
488 image = opj_decode_with_info(dec, stream, NULL);
490 #else // OPENJPEG_MAJOR_VERSION == 2
491 ret = !opj_decode(dec, stream, image);
492 #endif // OPENJPEG_MAJOR_VERSION == 1
495 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
496 ret = AVERROR_EXTERNAL;
500 for (i = 0; i < image->numcomps; i++) {
501 if (!image->comps[i].data) {
502 av_log(avctx, AV_LOG_ERROR,
503 "Image component %d contains no data.\n", i);
504 ret = AVERROR_INVALIDDATA;
509 desc = av_pix_fmt_desc_get(avctx->pix_fmt);
510 pixel_size = desc->comp[0].step;
511 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
513 switch (pixel_size) {
516 libopenjpeg_copy_to_packed8(picture, image);
518 libopenjpeg_copyto8(picture, image);
523 libopenjpeg_copy_to_packed8(picture, image);
525 libopenjpeg_copyto16(picture, image);
531 libopenjpeg_copy_to_packed8(picture, image);
537 libopenjpeg_copy_to_packed16(picture, image);
541 av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
542 ret = AVERROR_PATCHWELCOME;
550 opj_image_destroy(image);
551 #if OPENJPEG_MAJOR_VERSION == 2
552 opj_stream_destroy(stream);
553 opj_destroy_codec(dec);
555 opj_cio_close(stream);
556 opj_destroy_decompress(dec);
561 static av_cold void libopenjpeg_static_init(AVCodec *codec)
563 const char *version = opj_version();
566 if (sscanf(version, "%d.%d", &major, &minor) == 2 && 1000*major + minor <= 1003)
567 codec->capabilities |= AV_CODEC_CAP_EXPERIMENTAL;
570 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
571 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
573 static const AVOption options[] = {
574 { "lowqual", "Limit the number of layers used for decoding",
575 OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
579 static const AVClass openjpeg_class = {
580 .class_name = "libopenjpeg",
581 .item_name = av_default_item_name,
583 .version = LIBAVUTIL_VERSION_INT,
586 AVCodec ff_libopenjpeg_decoder = {
587 .name = "libopenjpeg",
588 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
589 .type = AVMEDIA_TYPE_VIDEO,
590 .id = AV_CODEC_ID_JPEG2000,
591 .priv_data_size = sizeof(LibOpenJPEGContext),
592 .init = libopenjpeg_decode_init,
593 .decode = libopenjpeg_decode_frame,
594 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
596 .priv_class = &openjpeg_class,
597 .init_static_data = libopenjpeg_static_init,