libopenjpegdec.c 14.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
/*
 * JPEG 2000 decoding support via OpenJPEG
 * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
 *
 * This file is part of FFmpeg.
 *
 * FFmpeg is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * FFmpeg is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with FFmpeg; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

/**
23 24 25 26 27
 * @file
 * JPEG 2000 decoder using libopenjpeg
 */

#define  OPJ_STATIC
28

29
#include "libavutil/common.h"
30
#include "libavutil/imgutils.h"
31
#include "libavutil/intreadwrite.h"
32
#include "libavutil/opt.h"
33 34
#include "libavutil/pixfmt.h"

35
#include "avcodec.h"
36
#include "internal.h"
37
#include "thread.h"
38

39 40 41 42 43 44
#if HAVE_OPENJPEG_1_5_OPENJPEG_H
# include <openjpeg-1.5/openjpeg.h>
#else
# include <openjpeg.h>
#endif

45 46 47
#define JP2_SIG_TYPE    0x6A502020
#define JP2_SIG_VALUE   0x0D0A870A

48 49
// pix_fmts with lower bpp have to be listed before
// 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
52

53
#define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8,                  \
54
                           AV_PIX_FMT_GRAY16, AV_PIX_FMT_YA16
55

56 57 58 59 60 61 62 63 64 65 66
#define YUV_PIXEL_FORMATS  AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
                           AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
                           AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
                           AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
                           AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
                           AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
                           AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
                           AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
                           AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
                           AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
                           AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
67

68 69
#define XYZ_PIXEL_FORMATS  AV_PIX_FMT_XYZ12

70
static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[]  = {
71 72
    RGB_PIXEL_FORMATS
};
73
static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
74 75
    GRAY_PIXEL_FORMATS
};
76
static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[]  = {
77 78
    YUV_PIXEL_FORMATS
};
79
static const enum AVPixelFormat libopenjpeg_all_pix_fmts[]  = {
80 81
    RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
};
82

83
typedef struct LibOpenJPEGContext {
84
    AVClass *class;
85
    opj_dparameters_t dec_params;
86
    int lowqual;
87 88
} LibOpenJPEGContext;

89
static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
90
{
91
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
92
    int match = 1;
93

94
    if (desc->nb_components != image->numcomps) {
95
        return 0;
96 97
    }

98
    switch (desc->nb_components) {
99 100
    case 4:
        match = match &&
101 102 103
                desc->comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
                1 == image->comps[3].dx &&
                1 == image->comps[3].dy;
104 105
    case 3:
        match = match &&
106 107 108
                desc->comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
                1 << desc->log2_chroma_w == image->comps[2].dx &&
                1 << desc->log2_chroma_h == image->comps[2].dy;
109 110
    case 2:
        match = match &&
111 112 113
                desc->comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
                1 << desc->log2_chroma_w == image->comps[1].dx &&
                1 << desc->log2_chroma_h == image->comps[1].dy;
114 115
    case 1:
        match = match &&
116 117 118
                desc->comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
                1 == image->comps[0].dx &&
                1 == image->comps[0].dy;
119 120
    default:
        break;
121 122
    }

123 124
    return match;
}
125

126
static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
127
    int index;
128
    const enum AVPixelFormat *possible_fmts = NULL;
129 130 131 132
    int possible_fmts_nb = 0;

    switch (image->color_space) {
    case CLRSPC_SRGB:
133
        possible_fmts    = libopenjpeg_rgb_pix_fmts;
134
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
135 136
        break;
    case CLRSPC_GRAY:
137
        possible_fmts    = libopenjpeg_gray_pix_fmts;
138
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
139 140
        break;
    case CLRSPC_SYCC:
141
        possible_fmts    = libopenjpeg_yuv_pix_fmts;
142
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
143 144
        break;
    default:
145
        possible_fmts    = libopenjpeg_all_pix_fmts;
146
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
147
        break;
148
    }
149

150
    for (index = 0; index < possible_fmts_nb; ++index)
151 152 153
        if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
            return possible_fmts[index];
        }
154

155
    return AV_PIX_FMT_NONE;
156 157
}

158
static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
159
{
160
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
161
    int i, component_plane;
162

163
    if (pix_fmt == AV_PIX_FMT_GRAY16)
164 165
        return 0;

166
    component_plane = desc->comp[0].plane;
167
    for (i = 1; i < desc->nb_components; i++)
168
        if (component_plane != desc->comp[i].plane)
169 170 171 172 173 174 175
            return 0;
    return 1;
}

static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
    uint8_t *img_ptr;
    int index, x, y, c;
176
    for (y = 0; y < picture->height; y++) {
177 178 179 180
        index   = y * picture->width;
        img_ptr = picture->data[0] + y * picture->linesize[0];
        for (x = 0; x < picture->width; x++, index++)
            for (c = 0; c < image->numcomps; c++)
181
                *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
182 183 184
    }
}

185 186 187 188
static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
    uint16_t *img_ptr;
    int index, x, y, c;
    int adjust[4];
189
    for (x = 0; x < image->numcomps; x++)
190
        adjust[x] = FFMAX(FFMIN(av_pix_fmt_desc_get(picture->format)->comp[x].depth_minus1 + 1 - image->comps[x].prec, 8), 0);
191

192
    for (y = 0; y < picture->height; y++) {
193 194 195 196
        index   = y * picture->width;
        img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
        for (x = 0; x < picture->width; x++, index++)
            for (c = 0; c < image->numcomps; c++)
197 198
                *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
                             (unsigned)image->comps[c].data[index] << adjust[c];
199 200 201
    }
}

202 203 204 205 206
static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
    int *comp_data;
    uint8_t *img_ptr;
    int index, x, y;

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 = 0x80 * image->comps[index].sgnd + *comp_data;
213 214 215 216 217 218 219 220 221 222 223
                img_ptr++;
                comp_data++;
            }
        }
    }
}

static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
    int *comp_data;
    uint16_t *img_ptr;
    int index, x, y;
224 225
    int adjust[4];
    for (x = 0; x < image->numcomps; x++)
226
        adjust[x] = FFMAX(FFMIN(av_pix_fmt_desc_get(picture->format)->comp[x].depth_minus1 + 1 - image->comps[x].prec, 8), 0);
227

228
    for (index = 0; index < image->numcomps; index++) {
229
        comp_data = image->comps[index].data;
230
        for (y = 0; y < image->comps[index].h; y++) {
231
            img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
232
            for (x = 0; x < image->comps[index].w; x++) {
233 234
                *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
                           (unsigned)*comp_data << adjust[index];
235 236 237 238 239
                img_ptr++;
                comp_data++;
            }
        }
    }
240 241 242 243 244 245 246
}

static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
{
    LibOpenJPEGContext *ctx = avctx->priv_data;

    opj_set_default_decoder_parameters(&ctx->dec_params);
247 248 249
    return 0;
}

250
static int libopenjpeg_decode_frame(AVCodecContext *avctx,
251
                                    void *data, int *got_frame,
252
                                    AVPacket *avpkt)
253
{
254 255
    uint8_t *buf            = avpkt->data;
    int buf_size            = avpkt->size;
256
    LibOpenJPEGContext *ctx = avctx->priv_data;
257 258
    ThreadFrame frame       = { .f = data };
    AVFrame *picture        = data;
259
    const AVPixFmtDescriptor *desc;
260 261 262
    opj_dinfo_t *dec;
    opj_cio_t *stream;
    opj_image_t *image;
263
    int width, height, ret;
264
    int pixel_size = 0;
265
    int ispacked   = 0;
266
    int i;
267

268
    *got_frame = 0;
269 270

    // Check if input is a raw jpeg2k codestream or in jp2 wrapping
271
    if ((AV_RB32(buf) == 12) &&
272 273
        (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
        (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
Jai Menon's avatar
Jai Menon committed
274
        dec = opj_create_decompress(CODEC_JP2);
275
    } else {
276 277
        /* If the AVPacket contains a jp2c box, then skip to
         * the starting byte of the codestream. */
278 279
        if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
            buf += 8;
Jai Menon's avatar
Jai Menon committed
280
        dec = opj_create_decompress(CODEC_J2K);
281 282
    }

283
    if (!dec) {
284
        av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
285
        return AVERROR_UNKNOWN;
286
    }
287
    opj_set_event_mgr((opj_common_ptr) dec, NULL, NULL);
288
    ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
289
    ctx->dec_params.cp_layer          = ctx->lowqual;
290 291
    // Tie decoder with decoding parameters
    opj_setup_decoder(dec, &ctx->dec_params);
292
    stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
293 294 295 296

    if (!stream) {
        av_log(avctx, AV_LOG_ERROR,
               "Codestream could not be opened for reading.\n");
297
        opj_destroy_decompress(dec);
298
        return AVERROR_UNKNOWN;
299 300
    }

301
    // Decode the header only.
302 303
    image = opj_decode_with_info(dec, stream, NULL);
    opj_cio_close(stream);
304 305

    if (!image) {
306 307
        av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
        opj_destroy_decompress(dec);
308
        return AVERROR_UNKNOWN;
309
    }
310

311 312
    width  = image->x1 - image->x0;
    height = image->y1 - image->y0;
313

314 315
    ret = ff_set_dimensions(avctx, width, height);
    if (ret < 0)
316 317
        goto done;

318
    if (avctx->pix_fmt != AV_PIX_FMT_NONE)
319
        if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
320
            avctx->pix_fmt = AV_PIX_FMT_NONE;
321

322
    if (avctx->pix_fmt == AV_PIX_FMT_NONE)
323 324
        avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);

325
    if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
326 327
        av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
        goto done;
328
    }
329 330 331
    for (i = 0; i < image->numcomps; i++)
        if (image->comps[i].prec > avctx->bits_per_raw_sample)
            avctx->bits_per_raw_sample = image->comps[i].prec;
332

333
    if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
334
        goto done;
335

336
    ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
Michael Niedermayer's avatar
Michael Niedermayer committed
337
    ctx->dec_params.cp_reduce = avctx->lowres;
338
    // Tie decoder with decoding parameters.
339
    opj_setup_decoder(dec, &ctx->dec_params);
340
    stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
341 342 343
    if (!stream) {
        av_log(avctx, AV_LOG_ERROR,
               "Codestream could not be opened for reading.\n");
344
        ret = AVERROR_UNKNOWN;
345
        goto done;
346 347
    }

348
    opj_image_destroy(image);
349
    // Decode the codestream
350 351
    image = opj_decode_with_info(dec, stream, NULL);
    opj_cio_close(stream);
352

353
    if (!image) {
354
        av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
355
        ret = AVERROR_UNKNOWN;
356
        goto done;
357
    }
358

359
    desc       = av_pix_fmt_desc_get(avctx->pix_fmt);
360
    pixel_size = desc->comp[0].step_minus1 + 1;
361
    ispacked   = libopenjpeg_ispacked(avctx->pix_fmt);
362

363 364 365 366 367 368
    switch (pixel_size) {
    case 1:
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto8(picture, image);
369
        }
370 371
        break;
    case 2:
372 373 374 375 376
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto16(picture, image);
        }
377 378
        break;
    case 3:
379
    case 4:
380 381 382 383
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        }
        break;
384
    case 6:
385
    case 8:
386 387 388 389
        if (ispacked) {
            libopenjpeg_copy_to_packed16(picture, image);
        }
        break;
390 391
    default:
        av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
392
        ret = AVERROR_PATCHWELCOME;
393
        goto done;
394 395
    }

396
    *got_frame = 1;
397
    ret        = buf_size;
398 399 400 401 402 403 404

done:
    opj_image_destroy(image);
    opj_destroy_decompress(dec);
    return ret;
}

405 406 407 408
#define OFFSET(x) offsetof(LibOpenJPEGContext, x)
#define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM

static const AVOption options[] = {
409 410
    { "lowqual", "Limit the number of layers used for decoding",
        OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
411 412 413
    { NULL },
};

414
static const AVClass openjpeg_class = {
415 416 417 418 419
    .class_name = "libopenjpeg",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};
420

421
AVCodec ff_libopenjpeg_decoder = {
422 423 424 425 426 427 428 429
    .name           = "libopenjpeg",
    .long_name      = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
    .type           = AVMEDIA_TYPE_VIDEO,
    .id             = AV_CODEC_ID_JPEG2000,
    .priv_data_size = sizeof(LibOpenJPEGContext),
    .init           = libopenjpeg_decode_init,
    .decode         = libopenjpeg_decode_frame,
    .capabilities   = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
430 431
    .max_lowres     = 31,
    .priv_class     = &openjpeg_class,
432
};