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
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"
39 #define JP2_SIG_TYPE 0x6A502020
40 #define JP2_SIG_VALUE 0x0D0A870A
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
47 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8, \
48 AV_PIX_FMT_GRAY10, AV_PIX_FMT_GRAY12, AV_PIX_FMT_GRAY14, \
49 AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16
51 #define YUV_PIXEL_FORMATS AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
52 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
53 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
54 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
55 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
56 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
57 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
58 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
59 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
60 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
61 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
63 #define XYZ_PIXEL_FORMATS AV_PIX_FMT_XYZ12
65 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[] = {
68 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
71 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[] = {
74 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[] = {
75 RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
78 typedef struct LibOpenJPEGContext {
80 opj_dparameters_t dec_params;
84 static void error_callback(const char *msg, void *data)
86 av_log(data, AV_LOG_ERROR, "%s", msg);
89 static void warning_callback(const char *msg, void *data)
91 av_log(data, AV_LOG_WARNING, "%s", msg);
94 static void info_callback(const char *msg, void *data)
96 av_log(data, AV_LOG_DEBUG, "%s", msg);
99 typedef struct BufferReader {
102 const uint8_t *buffer;
105 static OPJ_SIZE_T stream_read(void *out_buffer, OPJ_SIZE_T nb_bytes, void *user_data)
107 BufferReader *reader = user_data;
110 if (reader->pos == reader->size) {
111 return (OPJ_SIZE_T)-1;
113 remaining = reader->size - reader->pos;
114 if (nb_bytes > remaining) {
115 nb_bytes = remaining;
117 memcpy(out_buffer, reader->buffer + reader->pos, nb_bytes);
118 reader->pos += (int)nb_bytes;
122 static OPJ_OFF_T stream_skip(OPJ_OFF_T nb_bytes, void *user_data)
124 BufferReader *reader = user_data;
126 if (reader->pos == 0) {
127 return (OPJ_SIZE_T)-1;
129 if (nb_bytes + reader->pos < 0) {
130 nb_bytes = -reader->pos;
135 if (reader->pos == reader->size) {
136 return (OPJ_SIZE_T)-1;
138 remaining = reader->size - reader->pos;
139 if (nb_bytes > remaining) {
140 nb_bytes = remaining;
143 reader->pos += (int)nb_bytes;
147 static OPJ_BOOL stream_seek(OPJ_OFF_T nb_bytes, void *user_data)
149 BufferReader *reader = user_data;
150 if (nb_bytes < 0 || nb_bytes > reader->size) {
153 reader->pos = (int)nb_bytes;
157 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
159 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
162 if (desc->nb_components != image->numcomps) {
166 switch (desc->nb_components) {
169 desc->comp[3].depth >= image->comps[3].prec &&
170 1 == image->comps[3].dx &&
171 1 == image->comps[3].dy;
174 desc->comp[2].depth >= image->comps[2].prec &&
175 1 << desc->log2_chroma_w == image->comps[2].dx &&
176 1 << desc->log2_chroma_h == image->comps[2].dy;
179 desc->comp[1].depth >= image->comps[1].prec &&
180 1 << desc->log2_chroma_w == image->comps[1].dx &&
181 1 << desc->log2_chroma_h == image->comps[1].dy;
184 desc->comp[0].depth >= image->comps[0].prec &&
185 1 == image->comps[0].dx &&
186 1 == image->comps[0].dy;
194 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
196 const enum AVPixelFormat *possible_fmts = NULL;
197 int possible_fmts_nb = 0;
199 switch (image->color_space) {
200 case OPJ_CLRSPC_SRGB:
201 possible_fmts = libopenjpeg_rgb_pix_fmts;
202 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
204 case OPJ_CLRSPC_GRAY:
205 possible_fmts = libopenjpeg_gray_pix_fmts;
206 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
208 case OPJ_CLRSPC_SYCC:
209 possible_fmts = libopenjpeg_yuv_pix_fmts;
210 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
213 possible_fmts = libopenjpeg_all_pix_fmts;
214 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
218 for (index = 0; index < possible_fmts_nb; ++index)
219 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
220 return possible_fmts[index];
223 return AV_PIX_FMT_NONE;
226 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
228 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
229 int i, component_plane;
231 if (pix_fmt == AV_PIX_FMT_GRAY16)
234 component_plane = desc->comp[0].plane;
235 for (i = 1; i < desc->nb_components; i++)
236 if (component_plane != desc->comp[i].plane)
241 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
244 for (y = 0; y < picture->height; y++) {
245 index = y * picture->width;
246 img_ptr = picture->data[0] + y * picture->linesize[0];
247 for (x = 0; x < picture->width; x++, index++)
248 for (c = 0; c < image->numcomps; c++)
249 *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
253 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
255 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
258 for (x = 0; x < image->numcomps; x++)
259 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
261 for (y = 0; y < picture->height; y++) {
262 index = y * picture->width;
263 img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
264 for (x = 0; x < picture->width; x++, index++)
265 for (c = 0; c < image->numcomps; c++)
266 *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
267 (unsigned)image->comps[c].data[index] << adjust[c];
271 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
276 for (index = 0; index < image->numcomps; index++) {
277 comp_data = image->comps[index].data;
278 for (y = 0; y < image->comps[index].h; y++) {
279 img_ptr = picture->data[index] + y * picture->linesize[index];
280 for (x = 0; x < image->comps[index].w; x++) {
281 *img_ptr = 0x80 * image->comps[index].sgnd + *comp_data;
289 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
292 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
295 for (x = 0; x < image->numcomps; x++)
296 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
298 for (index = 0; index < image->numcomps; index++) {
299 comp_data = image->comps[index].data;
300 for (y = 0; y < image->comps[index].h; y++) {
301 img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
302 for (x = 0; x < image->comps[index].w; x++) {
303 *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
304 (unsigned)*comp_data << adjust[index];
312 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
314 LibOpenJPEGContext *ctx = avctx->priv_data;
316 opj_set_default_decoder_parameters(&ctx->dec_params);
320 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
321 void *data, int *got_frame,
324 uint8_t *buf = avpkt->data;
325 int buf_size = avpkt->size;
326 LibOpenJPEGContext *ctx = avctx->priv_data;
327 ThreadFrame frame = { .f = data };
328 AVFrame *picture = data;
329 const AVPixFmtDescriptor *desc;
330 int width, height, ret;
334 opj_image_t *image = NULL;
335 BufferReader reader = {0, avpkt->size, avpkt->data};
336 opj_codec_t *dec = NULL;
337 opj_stream_t *stream = NULL;
341 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
342 if ((AV_RB32(buf) == 12) &&
343 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
344 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
345 dec = opj_create_decompress(OPJ_CODEC_JP2);
347 /* If the AVPacket contains a jp2c box, then skip to
348 * the starting byte of the codestream. */
349 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
351 dec = opj_create_decompress(OPJ_CODEC_J2K);
355 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
356 ret = AVERROR_EXTERNAL;
360 if (!opj_set_error_handler(dec, error_callback, avctx) ||
361 !opj_set_warning_handler(dec, warning_callback, avctx) ||
362 !opj_set_info_handler(dec, info_callback, avctx)) {
363 av_log(avctx, AV_LOG_ERROR, "Error setting decoder handlers.\n");
364 ret = AVERROR_EXTERNAL;
368 ctx->dec_params.cp_layer = ctx->lowqual;
369 ctx->dec_params.cp_reduce = avctx->lowres;
371 // Tie decoder with decoding parameters
372 opj_setup_decoder(dec, &ctx->dec_params);
374 stream = opj_stream_default_create(OPJ_STREAM_READ);
377 av_log(avctx, AV_LOG_ERROR,
378 "Codestream could not be opened for reading.\n");
379 ret = AVERROR_EXTERNAL;
383 opj_stream_set_read_function(stream, stream_read);
384 opj_stream_set_skip_function(stream, stream_skip);
385 opj_stream_set_seek_function(stream, stream_seek);
386 opj_stream_set_user_data(stream, &reader, NULL);
387 opj_stream_set_user_data_length(stream, avpkt->size);
388 // Decode the header only.
389 ret = !opj_read_header(stream, dec, &image);
392 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream header.\n");
393 ret = AVERROR_EXTERNAL;
397 width = image->x1 - image->x0;
398 height = image->y1 - image->y0;
400 ret = ff_set_dimensions(avctx, width, height);
404 if (avctx->pix_fmt != AV_PIX_FMT_NONE)
405 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
406 avctx->pix_fmt = AV_PIX_FMT_NONE;
408 if (avctx->pix_fmt == AV_PIX_FMT_NONE)
409 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
411 if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
412 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format.\n");
413 ret = AVERROR_UNKNOWN;
416 for (i = 0; i < image->numcomps; i++)
417 if (image->comps[i].prec > avctx->bits_per_raw_sample)
418 avctx->bits_per_raw_sample = image->comps[i].prec;
420 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
423 ret = !opj_decode(dec, stream, image);
426 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
427 ret = AVERROR_EXTERNAL;
431 for (i = 0; i < image->numcomps; i++) {
432 if (!image->comps[i].data) {
433 av_log(avctx, AV_LOG_ERROR,
434 "Image component %d contains no data.\n", i);
435 ret = AVERROR_INVALIDDATA;
440 desc = av_pix_fmt_desc_get(avctx->pix_fmt);
441 pixel_size = desc->comp[0].step;
442 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
444 switch (pixel_size) {
447 libopenjpeg_copy_to_packed8(picture, image);
449 libopenjpeg_copyto8(picture, image);
454 libopenjpeg_copy_to_packed8(picture, image);
456 libopenjpeg_copyto16(picture, image);
462 libopenjpeg_copy_to_packed8(picture, image);
468 libopenjpeg_copy_to_packed16(picture, image);
472 avpriv_report_missing_feature(avctx, "Pixel size %d", pixel_size);
473 ret = AVERROR_PATCHWELCOME;
478 picture->pict_type = AV_PICTURE_TYPE_I;
479 picture->key_frame = 1;
483 opj_image_destroy(image);
484 opj_stream_destroy(stream);
485 opj_destroy_codec(dec);
489 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
490 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
492 static const AVOption options[] = {
493 { "lowqual", "Limit the number of layers used for decoding",
494 OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
498 static const AVClass openjpeg_class = {
499 .class_name = "libopenjpeg",
500 .item_name = av_default_item_name,
502 .version = LIBAVUTIL_VERSION_INT,
505 AVCodec ff_libopenjpeg_decoder = {
506 .name = "libopenjpeg",
507 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
508 .type = AVMEDIA_TYPE_VIDEO,
509 .id = AV_CODEC_ID_JPEG2000,
510 .priv_data_size = sizeof(LibOpenJPEGContext),
511 .init = libopenjpeg_decode_init,
512 .decode = libopenjpeg_decode_frame,
513 .capabilities = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
515 .priv_class = &openjpeg_class,
516 .wrapper_name = "libopenjpeg",