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/opt.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/pixfmt.h"
31 #include "libavutil/intreadwrite.h"
36 #define JP2_SIG_TYPE 0x6A502020
37 #define JP2_SIG_VALUE 0x0D0A870A
39 // pix_fmts with lower bpp have to be listed before
40 // similar pix_fmts with higher bpp.
41 #define RGB_PIXEL_FORMATS PIX_FMT_RGB24,PIX_FMT_RGBA,PIX_FMT_RGB48,PIX_FMT_RGBA64
42 #define GRAY_PIXEL_FORMATS PIX_FMT_GRAY8,PIX_FMT_GRAY8A,PIX_FMT_GRAY16
43 #define YUV_PIXEL_FORMATS PIX_FMT_YUV410P,PIX_FMT_YUV411P,PIX_FMT_YUVA420P, \
44 PIX_FMT_YUV420P,PIX_FMT_YUV422P,PIX_FMT_YUVA422P, \
45 PIX_FMT_YUV440P,PIX_FMT_YUV444P,PIX_FMT_YUVA444P, \
46 PIX_FMT_YUV420P9,PIX_FMT_YUV422P9,PIX_FMT_YUV444P9, \
47 PIX_FMT_YUV420P10,PIX_FMT_YUV422P10,PIX_FMT_YUV444P10, \
48 PIX_FMT_YUV420P12,PIX_FMT_YUV422P12,PIX_FMT_YUV444P12, \
49 PIX_FMT_YUV420P14,PIX_FMT_YUV422P14,PIX_FMT_YUV444P14, \
50 PIX_FMT_YUV420P16,PIX_FMT_YUV422P16,PIX_FMT_YUV444P16
52 static const enum PixelFormat libopenjpeg_rgb_pix_fmts[] = {RGB_PIXEL_FORMATS};
53 static const enum PixelFormat libopenjpeg_gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
54 static const enum PixelFormat libopenjpeg_yuv_pix_fmts[] = {YUV_PIXEL_FORMATS};
55 static const enum PixelFormat libopenjpeg_all_pix_fmts[] = {RGB_PIXEL_FORMATS,GRAY_PIXEL_FORMATS,YUV_PIXEL_FORMATS};
59 opj_dparameters_t dec_params;
64 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum PixelFormat pix_fmt){
65 AVPixFmtDescriptor descriptor = av_pix_fmt_descriptors[pix_fmt];
68 if (descriptor.nb_components != image->numcomps) {
72 switch (descriptor.nb_components) {
73 case 4: match = match && descriptor.comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
74 1 == image->comps[3].dx &&
75 1 == image->comps[3].dy;
76 case 3: match = match && descriptor.comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
77 1 << descriptor.log2_chroma_w == image->comps[2].dx &&
78 1 << descriptor.log2_chroma_h == image->comps[2].dy;
79 case 2: match = match && descriptor.comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
80 1 << descriptor.log2_chroma_w == image->comps[1].dx &&
81 1 << descriptor.log2_chroma_h == image->comps[1].dy;
82 case 1: match = match && descriptor.comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
83 1 == image->comps[0].dx &&
84 1 == image->comps[0].dy;
92 static inline enum PixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
94 const enum PixelFormat *possible_fmts = NULL;
95 int possible_fmts_nb = 0;
97 switch (image->color_space) {
99 possible_fmts = libopenjpeg_rgb_pix_fmts;
100 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
103 possible_fmts = libopenjpeg_gray_pix_fmts;
104 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
107 possible_fmts = libopenjpeg_yuv_pix_fmts;
108 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
111 possible_fmts = libopenjpeg_all_pix_fmts;
112 possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
116 for (index = 0; index < possible_fmts_nb; ++index) {
117 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
118 return possible_fmts[index];
125 static inline int libopenjpeg_ispacked(enum PixelFormat pix_fmt) {
126 int i, component_plane;
128 if (pix_fmt == PIX_FMT_GRAY16)
131 component_plane = av_pix_fmt_descriptors[pix_fmt].comp[0].plane;
132 for(i = 1; i < av_pix_fmt_descriptors[pix_fmt].nb_components; i++) {
133 if (component_plane != av_pix_fmt_descriptors[pix_fmt].comp[i].plane)
139 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
142 for(y = 0; y < picture->height; y++) {
143 index = y*picture->width;
144 img_ptr = picture->data[0] + y*picture->linesize[0];
145 for(x = 0; x < picture->width; x++, index++) {
146 for(c = 0; c < image->numcomps; c++) {
147 *img_ptr++ = image->comps[c].data[index];
153 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
157 for (x = 0; x < image->numcomps; x++) {
158 adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
160 for (y = 0; y < picture->height; y++) {
161 index = y*picture->width;
162 img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
163 for (x = 0; x < picture->width; x++, index++) {
164 for (c = 0; c < image->numcomps; c++) {
165 *img_ptr++ = image->comps[c].data[index] << adjust[c];
171 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
176 for(index = 0; index < image->numcomps; index++) {
177 comp_data = image->comps[index].data;
178 for(y = 0; y < image->comps[index].h; y++) {
179 img_ptr = picture->data[index] + y * picture->linesize[index];
180 for(x = 0; x < image->comps[index].w; x++) {
181 *img_ptr = (uint8_t) *comp_data;
189 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
193 for(index = 0; index < image->numcomps; index++) {
194 comp_data = image->comps[index].data;
195 for(y = 0; y < image->comps[index].h; y++) {
196 img_ptr = (uint16_t*) (picture->data[index] + y * picture->linesize[index]);
197 for(x = 0; x < image->comps[index].w; x++) {
198 *img_ptr = *comp_data;
206 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
208 LibOpenJPEGContext *ctx = avctx->priv_data;
210 opj_set_default_decoder_parameters(&ctx->dec_params);
211 avcodec_get_frame_defaults(&ctx->image);
212 avctx->coded_frame = &ctx->image;
216 static av_cold int libopenjpeg_decode_init_thread_copy(AVCodecContext *avctx)
218 LibOpenJPEGContext *ctx = avctx->priv_data;
220 avctx->coded_frame = &ctx->image;
224 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
225 void *data, int *data_size,
228 uint8_t *buf = avpkt->data;
229 int buf_size = avpkt->size;
230 LibOpenJPEGContext *ctx = avctx->priv_data;
231 AVFrame *picture = &ctx->image, *output = data;
235 int width, height, ret = -1;
242 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
243 if((AV_RB32(buf) == 12) &&
244 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
245 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
246 dec = opj_create_decompress(CODEC_JP2);
248 // If the AVPacket contains a jp2c box, then skip to
249 // the starting byte of the codestream.
250 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
252 dec = opj_create_decompress(CODEC_J2K);
256 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
259 opj_set_event_mgr((opj_common_ptr)dec, NULL, NULL);
260 ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
261 ctx->dec_params.cp_layer = ctx->lowqual;
262 // Tie decoder with decoding parameters
263 opj_setup_decoder(dec, &ctx->dec_params);
264 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
266 av_log(avctx, AV_LOG_ERROR, "Codestream could not be opened for reading.\n");
267 opj_destroy_decompress(dec);
271 // Decode the header only
272 image = opj_decode_with_info(dec, stream, NULL);
273 opj_cio_close(stream);
275 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
276 opj_destroy_decompress(dec);
279 width = image->x1 - image->x0;
280 height = image->y1 - image->y0;
282 if(av_image_check_size(width, height, 0, avctx) < 0) {
283 av_log(avctx, AV_LOG_ERROR, "%dx%d dimension invalid.\n", width, height);
286 avcodec_set_dimensions(avctx, width, height);
288 if (avctx->pix_fmt != PIX_FMT_NONE) {
289 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt)) {
290 avctx->pix_fmt = PIX_FMT_NONE;
294 if (avctx->pix_fmt == PIX_FMT_NONE) {
295 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
298 if (avctx->pix_fmt == PIX_FMT_NONE) {
299 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
302 for (i = 0; i < image->numcomps; i++)
303 if (image->comps[i].prec > avctx->bits_per_raw_sample)
304 avctx->bits_per_raw_sample = image->comps[i].prec;
307 ff_thread_release_buffer(avctx, picture);
309 if(ff_thread_get_buffer(avctx, picture) < 0){
310 av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
314 ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
315 ctx->dec_params.cp_reduce = avctx->lowres;
316 // Tie decoder with decoding parameters
317 opj_setup_decoder(dec, &ctx->dec_params);
318 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
320 av_log(avctx, AV_LOG_ERROR, "Codestream could not be opened for reading.\n");
324 opj_image_destroy(image);
325 // Decode the codestream
326 image = opj_decode_with_info(dec, stream, NULL);
327 opj_cio_close(stream);
329 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
333 pixel_size = av_pix_fmt_descriptors[avctx->pix_fmt].comp[0].step_minus1 + 1;
334 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
336 switch (pixel_size) {
339 libopenjpeg_copy_to_packed8(picture, image);
341 libopenjpeg_copyto8(picture, image);
346 libopenjpeg_copy_to_packed8(picture, image);
348 libopenjpeg_copyto16(picture, image);
354 libopenjpeg_copy_to_packed8(picture, image);
360 libopenjpeg_copy_to_packed16(picture, image);
364 av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
368 *output = ctx->image;
369 *data_size = sizeof(AVPicture);
373 opj_image_destroy(image);
374 opj_destroy_decompress(dec);
378 static av_cold int libopenjpeg_decode_close(AVCodecContext *avctx)
380 LibOpenJPEGContext *ctx = avctx->priv_data;
382 if(ctx->image.data[0])
383 ff_thread_release_buffer(avctx, &ctx->image);
387 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
388 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
390 static const AVOption options[] = {
391 { "lowqual", "Limit the number of layers used for decoding", OFFSET(lowqual), AV_OPT_TYPE_INT, { 0 }, 0, INT_MAX, VD },
395 static const AVClass class = {
396 .class_name = "libopenjpeg",
397 .item_name = av_default_item_name,
399 .version = LIBAVUTIL_VERSION_INT,
402 AVCodec ff_libopenjpeg_decoder = {
403 .name = "libopenjpeg",
404 .type = AVMEDIA_TYPE_VIDEO,
405 .id = CODEC_ID_JPEG2000,
406 .priv_data_size = sizeof(LibOpenJPEGContext),
407 .init = libopenjpeg_decode_init,
408 .close = libopenjpeg_decode_close,
409 .decode = libopenjpeg_decode_frame,
410 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
412 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
413 .priv_class = &class,
414 .init_thread_copy = ONLY_IF_THREADS_ENABLED(libopenjpeg_decode_init_thread_copy),