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/imgutils.h"
28 #include "libavutil/pixfmt.h"
30 #include "libavutil/intreadwrite.h"
35 #define JP2_SIG_TYPE 0x6A502020
36 #define JP2_SIG_VALUE 0x0D0A870A
38 #define RGB_PIXEL_FORMATS PIX_FMT_RGB24,PIX_FMT_RGBA,PIX_FMT_RGB48,PIX_FMT_RGBA64
39 #define GRAY_PIXEL_FORMATS PIX_FMT_GRAY8,PIX_FMT_GRAY8A,PIX_FMT_GRAY16
40 #define YUV_PIXEL_FORMATS PIX_FMT_YUV420P,PIX_FMT_YUV422P,PIX_FMT_YUVA420P, \
41 PIX_FMT_YUV440P,PIX_FMT_YUV444P, \
42 PIX_FMT_YUV420P9,PIX_FMT_YUV422P9,PIX_FMT_YUV444P9, \
43 PIX_FMT_YUV420P10,PIX_FMT_YUV422P10,PIX_FMT_YUV444P10, \
44 PIX_FMT_YUV420P16,PIX_FMT_YUV422P16,PIX_FMT_YUV444P16
46 static const enum PixelFormat libopenjpeg_rgb_pix_fmts[] = {RGB_PIXEL_FORMATS};
47 static const enum PixelFormat libopenjpeg_gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
48 static const enum PixelFormat libopenjpeg_yuv_pix_fmts[] = {YUV_PIXEL_FORMATS};
49 static const enum PixelFormat libopenjpeg_all_pix_fmts[] = {RGB_PIXEL_FORMATS,GRAY_PIXEL_FORMATS,YUV_PIXEL_FORMATS};
52 opj_dparameters_t dec_params;
56 static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum PixelFormat pix_fmt){
57 AVPixFmtDescriptor descriptor = av_pix_fmt_descriptors[pix_fmt];
60 if (descriptor.nb_components != image->numcomps) {
64 switch (descriptor.nb_components) {
65 case 4: match = match && descriptor.comp[3].depth_minus1 + 1 == image->comps[3].prec &&
66 1 << descriptor.log2_chroma_w == image->comps[3].dx &&
67 1 << descriptor.log2_chroma_h == image->comps[3].dy;
68 case 3: match = match && descriptor.comp[2].depth_minus1 + 1 == image->comps[2].prec &&
69 1 << descriptor.log2_chroma_w == image->comps[2].dx &&
70 1 << descriptor.log2_chroma_h == image->comps[2].dy;
71 case 2: match = match && descriptor.comp[1].depth_minus1 + 1 == image->comps[1].prec &&
72 1 << descriptor.log2_chroma_w == image->comps[1].dx &&
73 1 << descriptor.log2_chroma_h == image->comps[1].dy;
74 case 1: match = match && descriptor.comp[0].depth_minus1 + 1 == image->comps[0].prec &&
75 1 == image->comps[0].dx &&
76 1 == image->comps[0].dy;
84 static inline enum PixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
86 const enum PixelFormat *possible_fmts = NULL;
87 int possible_fmts_nb = 0;
89 switch (image->color_space) {
91 possible_fmts = libopenjpeg_rgb_pix_fmts;
92 possible_fmts_nb = sizeof(libopenjpeg_rgb_pix_fmts) / sizeof(enum PixelFormat);
95 possible_fmts = libopenjpeg_gray_pix_fmts;
96 possible_fmts_nb = sizeof(libopenjpeg_gray_pix_fmts) / sizeof(enum PixelFormat);
99 possible_fmts = libopenjpeg_yuv_pix_fmts;
100 possible_fmts_nb = sizeof(libopenjpeg_yuv_pix_fmts) / sizeof(enum PixelFormat);
103 possible_fmts = libopenjpeg_all_pix_fmts;
104 possible_fmts_nb = sizeof(libopenjpeg_all_pix_fmts) / sizeof(enum PixelFormat);
108 for (index = 0; index < possible_fmts_nb; ++index) {
109 if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
110 return possible_fmts[index];
117 static inline int libopenjpeg_ispacked(enum PixelFormat pix_fmt) {
118 int i, component_plane;
120 if (pix_fmt == PIX_FMT_GRAY16)
123 component_plane = av_pix_fmt_descriptors[pix_fmt].comp[0].plane;
124 for(i = 1; i < av_pix_fmt_descriptors[pix_fmt].nb_components; i++) {
125 if (component_plane != av_pix_fmt_descriptors[pix_fmt].comp[i].plane)
131 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
134 for(y = 0; y < picture->height; y++) {
135 index = y*picture->width;
136 img_ptr = picture->data[0] + y*picture->linesize[0];
137 for(x = 0; x < picture->width; x++, index++) {
138 for(c = 0; c < image->numcomps; c++) {
139 *img_ptr++ = image->comps[c].data[index];
145 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
149 for (x = 0; x < image->numcomps; x++) {
150 adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
152 for (y = 0; y < picture->height; y++) {
153 index = y*picture->width;
154 img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
155 for (x = 0; x < picture->width; x++, index++) {
156 for (c = 0; c < image->numcomps; c++) {
157 *img_ptr++ = image->comps[c].data[index] << adjust[c];
163 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
168 for(index = 0; index < image->numcomps; index++) {
169 comp_data = image->comps[index].data;
170 for(y = 0; y < image->comps[index].h; y++) {
171 img_ptr = picture->data[index] + y * picture->linesize[index];
172 for(x = 0; x < image->comps[index].w; x++) {
173 *img_ptr = (uint8_t) *comp_data;
181 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
185 for(index = 0; index < image->numcomps; index++) {
186 comp_data = image->comps[index].data;
187 for(y = 0; y < image->comps[index].h; y++) {
188 img_ptr = (uint16_t*) (picture->data[index] + y * picture->linesize[index]);
189 for(x = 0; x < image->comps[index].w; x++) {
190 *img_ptr = *comp_data;
198 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
200 LibOpenJPEGContext *ctx = avctx->priv_data;
202 opj_set_default_decoder_parameters(&ctx->dec_params);
203 avcodec_get_frame_defaults(&ctx->image);
204 avctx->coded_frame = &ctx->image;
208 static av_cold int libopenjpeg_decode_init_thread_copy(AVCodecContext *avctx)
210 LibOpenJPEGContext *ctx = avctx->priv_data;
212 avctx->coded_frame = &ctx->image;
216 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
217 void *data, int *data_size,
220 uint8_t *buf = avpkt->data;
221 int buf_size = avpkt->size;
222 LibOpenJPEGContext *ctx = avctx->priv_data;
223 AVFrame *picture = &ctx->image, *output = data;
227 int width, height, ret = -1;
233 // Check if input is a raw jpeg2k codestream or in jp2 wrapping
234 if((AV_RB32(buf) == 12) &&
235 (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
236 (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
237 dec = opj_create_decompress(CODEC_JP2);
239 // If the AVPacket contains a jp2c box, then skip to
240 // the starting byte of the codestream.
241 if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
243 dec = opj_create_decompress(CODEC_J2K);
247 av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
250 opj_set_event_mgr((opj_common_ptr)dec, NULL, NULL);
252 ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
253 // Tie decoder with decoding parameters
254 opj_setup_decoder(dec, &ctx->dec_params);
255 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
257 av_log(avctx, AV_LOG_ERROR, "Codestream could not be opened for reading.\n");
258 opj_destroy_decompress(dec);
262 // Decode the header only
263 image = opj_decode_with_info(dec, stream, NULL);
264 opj_cio_close(stream);
266 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
267 opj_destroy_decompress(dec);
270 width = image->x1 - image->x0;
271 height = image->y1 - image->y0;
272 if(av_image_check_size(width, height, 0, avctx) < 0) {
273 av_log(avctx, AV_LOG_ERROR, "%dx%d dimension invalid.\n", width, height);
276 avcodec_set_dimensions(avctx, width, height);
278 if (avctx->pix_fmt != PIX_FMT_NONE) {
279 if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt)) {
280 avctx->pix_fmt = PIX_FMT_NONE;
284 if (avctx->pix_fmt == PIX_FMT_NONE) {
285 avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
288 if (avctx->pix_fmt == PIX_FMT_NONE) {
289 av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
294 ff_thread_release_buffer(avctx, picture);
296 if(ff_thread_get_buffer(avctx, picture) < 0){
297 av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
301 ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
302 ctx->dec_params.cp_reduce = avctx->lowres;
303 // Tie decoder with decoding parameters
304 opj_setup_decoder(dec, &ctx->dec_params);
305 stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
307 av_log(avctx, AV_LOG_ERROR, "Codestream could not be opened for reading.\n");
311 opj_image_destroy(image);
312 // Decode the codestream
313 image = opj_decode_with_info(dec, stream, NULL);
314 opj_cio_close(stream);
316 av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
320 pixel_size = av_pix_fmt_descriptors[avctx->pix_fmt].comp[0].step_minus1 + 1;
321 ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
323 switch (pixel_size) {
326 libopenjpeg_copy_to_packed8(picture, image);
328 libopenjpeg_copyto8(picture, image);
333 libopenjpeg_copy_to_packed8(picture, image);
335 libopenjpeg_copyto16(picture, image);
341 libopenjpeg_copy_to_packed8(picture, image);
347 libopenjpeg_copy_to_packed16(picture, image);
351 av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
355 *output = ctx->image;
356 *data_size = sizeof(AVPicture);
360 opj_image_destroy(image);
361 opj_destroy_decompress(dec);
365 static av_cold int libopenjpeg_decode_close(AVCodecContext *avctx)
367 LibOpenJPEGContext *ctx = avctx->priv_data;
369 if(ctx->image.data[0])
370 ff_thread_release_buffer(avctx, &ctx->image);
375 AVCodec ff_libopenjpeg_decoder = {
376 .name = "libopenjpeg",
377 .type = AVMEDIA_TYPE_VIDEO,
378 .id = CODEC_ID_JPEG2000,
379 .priv_data_size = sizeof(LibOpenJPEGContext),
380 .init = libopenjpeg_decode_init,
381 .close = libopenjpeg_decode_close,
382 .decode = libopenjpeg_decode_frame,
383 .capabilities = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
385 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
386 .init_thread_copy = ONLY_IF_THREADS_ENABLED(libopenjpeg_decode_init_thread_copy),