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_1_5_OPENJPEG_H
40 # include <openjpeg-1.5/openjpeg.h>
42 # include <openjpeg.h>
45 #define JP2_SIG_TYPE 0x6A502020
46 #define JP2_SIG_VALUE 0x0D0A870A
48 // pix_fmts with lower bpp have to be listed before
49 // similar pix_fmts with higher bpp.
50 #define RGB_PIXEL_FORMATS AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA, \
51 AV_PIX_FMT_RGB48, AV_PIX_FMT_RGBA64
53 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8, \
54 AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16
56 #define YUV_PIXEL_FORMATS AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
57 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
58 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
59 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
60 AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
61 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
62 AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
63 AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
64 AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
65 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
66 AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
68 #define XYZ_PIXEL_FORMATS AV_PIX_FMT_XYZ12
70 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[] = {
73 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
76 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[] = {
79 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[] = {
80 RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
83 typedef struct LibOpenJPEGContext {
85 opj_dparameters_t dec_params;
89 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
91 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
94 if (desc->nb_components != image->numcomps) {
98 switch (desc->nb_components) {
101 desc->comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
102 1 == image->comps[3].dx &&
103 1 == image->comps[3].dy;
106 desc->comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
107 1 << desc->log2_chroma_w == image->comps[2].dx &&
108 1 << desc->log2_chroma_h == image->comps[2].dy;
111 desc->comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
112 1 << desc->log2_chroma_w == image->comps[1].dx &&
113 1 << desc->log2_chroma_h == image->comps[1].dy;
116 desc->comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
117 1 == image->comps[0].dx &&
118 1 == image->comps[0].dy;
126 static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
128 const enum AVPixelFormat *possible_fmts = NULL;
129 int possible_fmts_nb = 0;
131 switch (image->color_space) {
133 possible_fmts = libopenjpeg_rgb_pix_fmts;
134 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
137 possible_fmts = libopenjpeg_gray_pix_fmts;
138 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
141 possible_fmts = libopenjpeg_yuv_pix_fmts;
142 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
145 possible_fmts = libopenjpeg_all_pix_fmts;
146 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
150 for (index = 0; index < possible_fmts_nb; ++index)
151 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
152 return possible_fmts[index];
155 return AV_PIX_FMT_NONE;
158 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
160 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
161 int i, component_plane;
163 if (pix_fmt == AV_PIX_FMT_GRAY16)
166 component_plane = desc->comp[0].plane;
167 for (i = 1; i < desc->nb_components; i++)
168 if (component_plane != desc->comp[i].plane)
173 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
176 for (y = 0; y < picture->height; y++) {
177 index = y * picture->width;
178 img_ptr = picture->data[0] + y * picture->linesize[0];
179 for (x = 0; x < picture->width; x++, index++)
180 for (c = 0; c < image->numcomps; c++)
181 *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
185 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
187 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
190 for (x = 0; x < image->numcomps; x++)
191 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth_minus1 + 1 - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
193 for (y = 0; y < picture->height; y++) {
194 index = y * picture->width;
195 img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
196 for (x = 0; x < picture->width; x++, index++)
197 for (c = 0; c < image->numcomps; c++)
198 *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
199 (unsigned)image->comps[c].data[index] << adjust[c];
203 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
208 for (index = 0; index < image->numcomps; index++) {
209 comp_data = image->comps[index].data;
210 for (y = 0; y < image->comps[index].h; y++) {
211 img_ptr = picture->data[index] + y * picture->linesize[index];
212 for (x = 0; x < image->comps[index].w; x++) {
213 *img_ptr = 0x80 * image->comps[index].sgnd + *comp_data;
221 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
224 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
227 for (x = 0; x < image->numcomps; x++)
228 adjust[x] = FFMAX(FFMIN(desc->comp[x].depth_minus1 + 1 - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
230 for (index = 0; index < image->numcomps; index++) {
231 comp_data = image->comps[index].data;
232 for (y = 0; y < image->comps[index].h; y++) {
233 img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
234 for (x = 0; x < image->comps[index].w; x++) {
235 *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
236 (unsigned)*comp_data << adjust[index];
244 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
246 LibOpenJPEGContext *ctx = avctx->priv_data;
248 opj_set_default_decoder_parameters(&ctx->dec_params);
252 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
253 void *data, int *got_frame,
256 uint8_t *buf = avpkt->data;
257 int buf_size = avpkt->size;
258 LibOpenJPEGContext *ctx = avctx->priv_data;
259 ThreadFrame frame = { .f = data };
260 AVFrame *picture = data;
261 const AVPixFmtDescriptor *desc;
265 int width, height, ret;
272 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
273 if ((AV_RB32(buf) == 12) &&
274 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
275 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
276 dec = opj_create_decompress(CODEC_JP2);
278 /* If the AVPacket contains a jp2c box, then skip to
279 * the starting byte of the codestream. */
280 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
282 dec = opj_create_decompress(CODEC_J2K);
286 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
287 return AVERROR_UNKNOWN;
289 opj_set_event_mgr((opj_common_ptr) dec, NULL, NULL);
290 ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
291 ctx->dec_params.cp_layer = ctx->lowqual;
292 // Tie decoder with decoding parameters
293 opj_setup_decoder(dec, &ctx->dec_params);
294 stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
297 av_log(avctx, AV_LOG_ERROR,
298 "Codestream could not be opened for reading.\n");
299 opj_destroy_decompress(dec);
300 return AVERROR_UNKNOWN;
303 // Decode the header only.
304 image = opj_decode_with_info(dec, stream, NULL);
305 opj_cio_close(stream);
308 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
309 opj_destroy_decompress(dec);
310 return AVERROR_UNKNOWN;
313 width = image->x1 - image->x0;
314 height = image->y1 - image->y0;
316 ret = ff_set_dimensions(avctx, width, height);
320 if (avctx->pix_fmt != AV_PIX_FMT_NONE)
321 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
322 avctx->pix_fmt = AV_PIX_FMT_NONE;
324 if (avctx->pix_fmt == AV_PIX_FMT_NONE)
325 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
327 if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
328 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
331 for (i = 0; i < image->numcomps; i++)
332 if (image->comps[i].prec > avctx->bits_per_raw_sample)
333 avctx->bits_per_raw_sample = image->comps[i].prec;
335 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
338 ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
339 ctx->dec_params.cp_reduce = avctx->lowres;
340 // Tie decoder with decoding parameters.
341 opj_setup_decoder(dec, &ctx->dec_params);
342 stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
344 av_log(avctx, AV_LOG_ERROR,
345 "Codestream could not be opened for reading.\n");
346 ret = AVERROR_UNKNOWN;
350 opj_image_destroy(image);
351 // Decode the codestream
352 image = opj_decode_with_info(dec, stream, NULL);
353 opj_cio_close(stream);
356 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
357 ret = AVERROR_UNKNOWN;
361 desc = av_pix_fmt_desc_get(avctx->pix_fmt);
362 pixel_size = desc->comp[0].step_minus1 + 1;
363 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
365 switch (pixel_size) {
368 libopenjpeg_copy_to_packed8(picture, image);
370 libopenjpeg_copyto8(picture, image);
375 libopenjpeg_copy_to_packed8(picture, image);
377 libopenjpeg_copyto16(picture, image);
383 libopenjpeg_copy_to_packed8(picture, image);
389 libopenjpeg_copy_to_packed16(picture, image);
393 av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
394 ret = AVERROR_PATCHWELCOME;
402 opj_image_destroy(image);
403 opj_destroy_decompress(dec);
407 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
408 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
410 static const AVOption options[] = {
411 { "lowqual", "Limit the number of layers used for decoding",
412 OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
416 static const AVClass openjpeg_class = {
417 .class_name = "libopenjpeg",
418 .item_name = av_default_item_name,
420 .version = LIBAVUTIL_VERSION_INT,
423 AVCodec ff_libopenjpeg_decoder = {
424 .name = "libopenjpeg",
425 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
426 .type = AVMEDIA_TYPE_VIDEO,
427 .id = AV_CODEC_ID_JPEG2000,
428 .priv_data_size = sizeof(LibOpenJPEGContext),
429 .init = libopenjpeg_decode_init,
430 .decode = libopenjpeg_decode_frame,
431 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
433 .priv_class = &openjpeg_class,