2 * JPEG 2000 decoding support via OpenJPEG
3 * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
5 * This file is part of Libav.
7 * Libav 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 * Libav 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 Libav; 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
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"
38 #define JP2_SIG_TYPE 0x6A502020
39 #define JP2_SIG_VALUE 0x0D0A870A
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, \
46 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_Y400A, \
49 #define YUV_PIXEL_FORMATS AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, \
50 AV_PIX_FMT_YUVA420P, \
51 AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, \
52 AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, \
53 AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, \
54 AV_PIX_FMT_YUV444P9, \
55 AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, \
56 AV_PIX_FMT_YUV444P10, \
57 AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, \
60 #define XYZ_PIXEL_FORMATS AV_PIX_FMT_XYZ12
62 static const enum AVPixelFormat rgb_pix_fmts[] = {RGB_PIXEL_FORMATS};
63 static const enum AVPixelFormat gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
64 static const enum AVPixelFormat yuv_pix_fmts[] = {YUV_PIXEL_FORMATS};
65 static const enum AVPixelFormat any_pix_fmts[] = {RGB_PIXEL_FORMATS,
72 opj_dparameters_t dec_params;
77 static int libopenjpeg_matches_pix_fmt(const opj_image_t *img,
78 enum AVPixelFormat pix_fmt)
80 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
83 if (desc->nb_components != img->numcomps) {
87 switch (desc->nb_components) {
90 desc->comp[3].depth_minus1 + 1 >= img->comps[3].prec &&
91 1 == img->comps[3].dx &&
92 1 == img->comps[3].dy;
95 desc->comp[2].depth_minus1 + 1 >= img->comps[2].prec &&
96 1 << desc->log2_chroma_w == img->comps[2].dx &&
97 1 << desc->log2_chroma_h == img->comps[2].dy;
100 desc->comp[1].depth_minus1 + 1 >= img->comps[1].prec &&
101 1 << desc->log2_chroma_w == img->comps[1].dx &&
102 1 << desc->log2_chroma_h == img->comps[1].dy;
105 desc->comp[0].depth_minus1 + 1 >= img->comps[0].prec &&
106 1 == img->comps[0].dx &&
107 1 == img->comps[0].dy;
115 static enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image)
118 const enum AVPixelFormat *possible_fmts = NULL;
119 int possible_fmts_nb = 0;
121 switch (image->color_space) {
123 possible_fmts = rgb_pix_fmts;
124 possible_fmts_nb = FF_ARRAY_ELEMS(rgb_pix_fmts);
127 possible_fmts = gray_pix_fmts;
128 possible_fmts_nb = FF_ARRAY_ELEMS(gray_pix_fmts);
131 possible_fmts = yuv_pix_fmts;
132 possible_fmts_nb = FF_ARRAY_ELEMS(yuv_pix_fmts);
135 possible_fmts = any_pix_fmts;
136 possible_fmts_nb = FF_ARRAY_ELEMS(any_pix_fmts);
140 for (index = 0; index < possible_fmts_nb; ++index) {
141 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
142 return possible_fmts[index];
146 return AV_PIX_FMT_NONE;
149 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
151 const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
152 int i, component_plane;
154 if (pix_fmt == AV_PIX_FMT_GRAY16)
157 component_plane = desc->comp[0].plane;
158 for (i = 1; i < desc->nb_components; i++) {
159 if (component_plane != desc->comp[i].plane)
165 static void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image)
170 for (y = 0; y < picture->height; y++) {
171 index = y*picture->width;
172 img_ptr = picture->data[0] + y*picture->linesize[0];
173 for (x = 0; x < picture->width; x++, index++) {
174 for (c = 0; c < image->numcomps; c++) {
175 *img_ptr++ = image->comps[c].data[index];
181 static void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image)
187 for (x = 0; x < image->numcomps; x++)
188 adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
190 for (y = 0; y < picture->height; y++) {
191 index = y*picture->width;
192 img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
193 for (x = 0; x < picture->width; x++, index++) {
194 for (c = 0; c < image->numcomps; c++) {
195 *img_ptr++ = image->comps[c].data[index] << adjust[c];
201 static void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image)
207 for (index = 0; index < image->numcomps; index++) {
208 comp_data = image->comps[index].data;
209 for (y = 0; y < image->comps[index].h; y++) {
210 img_ptr = picture->data[index] + y * picture->linesize[index];
211 for (x = 0; x < image->comps[index].w; x++) {
212 *img_ptr = (uint8_t) *comp_data;
220 static void libopenjpeg_copyto16(AVFrame *p, opj_image_t *image)
226 for (index = 0; index < image->numcomps; index++) {
227 comp_data = image->comps[index].data;
228 for (y = 0; y < image->comps[index].h; y++) {
229 img_ptr = (uint16_t*) (p->data[index] + y * p->linesize[index]);
230 for (x = 0; x < image->comps[index].w; x++) {
231 *img_ptr = *comp_data;
239 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
241 LibOpenJPEGContext *ctx = avctx->priv_data;
243 opj_set_default_decoder_parameters(&ctx->dec_params);
247 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
248 void *data, int *got_frame,
251 uint8_t *buf = avpkt->data;
252 int buf_size = avpkt->size;
253 LibOpenJPEGContext *ctx = avctx->priv_data;
254 ThreadFrame frame = { .f = data };
255 AVFrame *picture = data;
256 const AVPixFmtDescriptor *desc;
260 int width, height, ret;
267 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
268 if ((AV_RB32(buf) == 12) &&
269 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
270 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
271 dec = opj_create_decompress(CODEC_JP2);
273 /* If the AVPacket contains a jp2c box, then skip to
274 * the starting byte of the codestream. */
275 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
277 dec = opj_create_decompress(CODEC_J2K);
281 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
282 return AVERROR_UNKNOWN;
284 opj_set_event_mgr((opj_common_ptr)dec, NULL, NULL);
286 ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
287 ctx->dec_params.cp_reduce = ctx->lowres;
288 ctx->dec_params.cp_layer = ctx->lowqual;
289 // Tie decoder with decoding parameters
290 opj_setup_decoder(dec, &ctx->dec_params);
291 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
294 av_log(avctx, AV_LOG_ERROR,
295 "Codestream could not be opened for reading.\n");
296 opj_destroy_decompress(dec);
297 return AVERROR_UNKNOWN;
300 // Decode the header only.
301 image = opj_decode_with_info(dec, stream, NULL);
302 opj_cio_close(stream);
305 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
306 opj_destroy_decompress(dec);
307 return AVERROR_UNKNOWN;
310 width = image->x1 - image->x0;
311 height = image->y1 - image->y0;
314 width = (width + (1 << ctx->lowres) - 1) >> ctx->lowres;
315 height = (height + (1 << ctx->lowres) - 1) >> ctx->lowres;
318 if ((ret = av_image_check_size(width, height, 0, avctx)) < 0) {
319 av_log(avctx, AV_LOG_ERROR,
320 "%dx%d dimension invalid.\n", width, height);
324 avcodec_set_dimensions(avctx, width, height);
326 if (avctx->pix_fmt != AV_PIX_FMT_NONE)
327 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
328 avctx->pix_fmt = AV_PIX_FMT_NONE;
330 if (avctx->pix_fmt == AV_PIX_FMT_NONE)
331 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
333 if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
334 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
335 ret = AVERROR_INVALIDDATA;
339 for (i = 0; i < image->numcomps; i++)
340 if (image->comps[i].prec > avctx->bits_per_raw_sample)
341 avctx->bits_per_raw_sample = image->comps[i].prec;
343 if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0) {
344 av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
348 ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
349 // Tie decoder with decoding parameters.
350 opj_setup_decoder(dec, &ctx->dec_params);
351 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
353 av_log(avctx, AV_LOG_ERROR,
354 "Codestream could not be opened for reading.\n");
355 ret = AVERROR_UNKNOWN;
359 opj_image_destroy(image);
360 // Decode the codestream
361 image = opj_decode_with_info(dec, stream, NULL);
362 opj_cio_close(stream);
365 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
366 ret = AVERROR_UNKNOWN;
370 desc = av_pix_fmt_desc_get(avctx->pix_fmt);
371 pixel_size = desc->comp[0].step_minus1 + 1;
372 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
374 switch (pixel_size) {
377 libopenjpeg_copy_to_packed8(picture, image);
379 libopenjpeg_copyto8(picture, image);
384 libopenjpeg_copy_to_packed8(picture, image);
386 libopenjpeg_copyto16(picture, image);
392 libopenjpeg_copy_to_packed8(picture, image);
398 libopenjpeg_copy_to_packed16(picture, image);
402 av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
403 ret = AVERROR_PATCHWELCOME;
411 opj_image_destroy(image);
412 opj_destroy_decompress(dec);
416 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
417 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
419 static const AVOption options[] = {
420 { "lowqual", "Limit the number of layers used for decoding", OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
421 { "lowres", "Lower the decoding resolution by a power of two", OFFSET(lowres), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
425 static const AVClass class = {
426 .class_name = "libopenjpeg",
427 .item_name = av_default_item_name,
429 .version = LIBAVUTIL_VERSION_INT,
432 AVCodec ff_libopenjpeg_decoder = {
433 .name = "libopenjpeg",
434 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
435 .type = AVMEDIA_TYPE_VIDEO,
436 .id = AV_CODEC_ID_JPEG2000,
437 .priv_data_size = sizeof(LibOpenJPEGContext),
438 .init = libopenjpeg_decode_init,
439 .decode = libopenjpeg_decode_frame,
440 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
441 .priv_class = &class,