libopenjpegdec.c 15.4 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
    opj_event_mgr_t event_mgr;
87
    int lowqual;
88 89
} LibOpenJPEGContext;

90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
static void error_callback(const char *msg, void *data)
{
    av_log(data, AV_LOG_ERROR, "%s", msg);
}

static void warning_callback(const char *msg, void *data)
{
    av_log(data, AV_LOG_WARNING, "%s", msg);
}

static void info_callback(const char *msg, void *data)
{
    av_log(data, AV_LOG_DEBUG, "%s", msg);
}

105
static inline int libopenjpeg_matches_pix_fmt(const opj_image_t *image, enum AVPixelFormat pix_fmt)
106
{
107
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
108
    int match = 1;
109

110
    if (desc->nb_components != image->numcomps) {
111
        return 0;
112 113
    }

114
    switch (desc->nb_components) {
115 116
    case 4:
        match = match &&
117
                desc->comp[3].depth >= image->comps[3].prec &&
118 119
                1 == image->comps[3].dx &&
                1 == image->comps[3].dy;
120 121
    case 3:
        match = match &&
122
                desc->comp[2].depth >= image->comps[2].prec &&
123 124
                1 << desc->log2_chroma_w == image->comps[2].dx &&
                1 << desc->log2_chroma_h == image->comps[2].dy;
125 126
    case 2:
        match = match &&
127
                desc->comp[1].depth >= image->comps[1].prec &&
128 129
                1 << desc->log2_chroma_w == image->comps[1].dx &&
                1 << desc->log2_chroma_h == image->comps[1].dy;
130 131
    case 1:
        match = match &&
132
                desc->comp[0].depth >= image->comps[0].prec &&
133 134
                1 == image->comps[0].dx &&
                1 == image->comps[0].dy;
135 136
    default:
        break;
137 138
    }

139 140
    return match;
}
141

142
static inline enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image) {
143
    int index;
144
    const enum AVPixelFormat *possible_fmts = NULL;
145 146 147 148
    int possible_fmts_nb = 0;

    switch (image->color_space) {
    case CLRSPC_SRGB:
149
        possible_fmts    = libopenjpeg_rgb_pix_fmts;
150
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
151 152
        break;
    case CLRSPC_GRAY:
153
        possible_fmts    = libopenjpeg_gray_pix_fmts;
154
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
155 156
        break;
    case CLRSPC_SYCC:
157
        possible_fmts    = libopenjpeg_yuv_pix_fmts;
158
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
159 160
        break;
    default:
161
        possible_fmts    = libopenjpeg_all_pix_fmts;
162
        possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_all_pix_fmts);
163
        break;
164
    }
165

166
    for (index = 0; index < possible_fmts_nb; ++index)
167 168 169
        if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
            return possible_fmts[index];
        }
170

171
    return AV_PIX_FMT_NONE;
172 173
}

174
static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
175
{
176
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
177
    int i, component_plane;
178

179
    if (pix_fmt == AV_PIX_FMT_GRAY16)
180 181
        return 0;

182
    component_plane = desc->comp[0].plane;
183
    for (i = 1; i < desc->nb_components; i++)
184
        if (component_plane != desc->comp[i].plane)
185 186 187 188 189 190 191
            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;
192
    for (y = 0; y < picture->height; y++) {
193 194 195 196
        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++)
197
                *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
198 199 200
    }
}

201 202
static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
    uint16_t *img_ptr;
203
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
204 205
    int index, x, y, c;
    int adjust[4];
206
    for (x = 0; x < image->numcomps; x++)
207
        adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
208

209
    for (y = 0; y < picture->height; y++) {
210 211 212 213
        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++)
214 215
                *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
                             (unsigned)image->comps[c].data[index] << adjust[c];
216 217 218
    }
}

219 220 221 222 223
static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
    int *comp_data;
    uint8_t *img_ptr;
    int index, x, y;

224
    for (index = 0; index < image->numcomps; index++) {
225
        comp_data = image->comps[index].data;
226
        for (y = 0; y < image->comps[index].h; y++) {
227
            img_ptr = picture->data[index] + y * picture->linesize[index];
228
            for (x = 0; x < image->comps[index].w; x++) {
229
                *img_ptr = 0x80 * image->comps[index].sgnd + *comp_data;
230 231 232 233 234 235 236 237 238 239
                img_ptr++;
                comp_data++;
            }
        }
    }
}

static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
    int *comp_data;
    uint16_t *img_ptr;
240
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
241
    int index, x, y;
242 243
    int adjust[4];
    for (x = 0; x < image->numcomps; x++)
244
        adjust[x] = FFMAX(FFMIN(desc->comp[x].depth - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
245

246
    for (index = 0; index < image->numcomps; index++) {
247
        comp_data = image->comps[index].data;
248
        for (y = 0; y < image->comps[index].h; y++) {
249
            img_ptr = (uint16_t *)(picture->data[index] + y * picture->linesize[index]);
250
            for (x = 0; x < image->comps[index].w; x++) {
251 252
                *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
                           (unsigned)*comp_data << adjust[index];
253 254 255 256 257
                img_ptr++;
                comp_data++;
            }
        }
    }
258 259 260 261 262 263 264
}

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

    opj_set_default_decoder_parameters(&ctx->dec_params);
265 266 267
    return 0;
}

268
static int libopenjpeg_decode_frame(AVCodecContext *avctx,
269
                                    void *data, int *got_frame,
270
                                    AVPacket *avpkt)
271
{
272 273
    uint8_t *buf            = avpkt->data;
    int buf_size            = avpkt->size;
274
    LibOpenJPEGContext *ctx = avctx->priv_data;
275 276
    ThreadFrame frame       = { .f = data };
    AVFrame *picture        = data;
277
    const AVPixFmtDescriptor *desc;
278 279 280
    opj_dinfo_t *dec;
    opj_cio_t *stream;
    opj_image_t *image;
281
    int width, height, ret;
282
    int pixel_size = 0;
283
    int ispacked   = 0;
284
    int i;
285

286
    *got_frame = 0;
287 288

    // Check if input is a raw jpeg2k codestream or in jp2 wrapping
289
    if ((AV_RB32(buf) == 12) &&
290 291
        (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
        (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
Jai Menon's avatar
Jai Menon committed
292
        dec = opj_create_decompress(CODEC_JP2);
293
    } else {
294 295
        /* If the AVPacket contains a jp2c box, then skip to
         * the starting byte of the codestream. */
296 297
        if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
            buf += 8;
Jai Menon's avatar
Jai Menon committed
298
        dec = opj_create_decompress(CODEC_J2K);
299 300
    }

301
    if (!dec) {
302
        av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
303
        return AVERROR_UNKNOWN;
304
    }
305 306 307 308 309
    memset(&ctx->event_mgr, 0, sizeof(ctx->event_mgr));
    ctx->event_mgr.info_handler    = info_callback;
    ctx->event_mgr.error_handler   = error_callback;
    ctx->event_mgr.warning_handler = warning_callback;
    opj_set_event_mgr((opj_common_ptr) dec, &ctx->event_mgr, avctx);
310
    ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
311
    ctx->dec_params.cp_layer          = ctx->lowqual;
312 313
    // Tie decoder with decoding parameters
    opj_setup_decoder(dec, &ctx->dec_params);
314
    stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
315 316 317 318

    if (!stream) {
        av_log(avctx, AV_LOG_ERROR,
               "Codestream could not be opened for reading.\n");
319
        opj_destroy_decompress(dec);
320
        return AVERROR_UNKNOWN;
321 322
    }

323
    // Decode the header only.
324 325
    image = opj_decode_with_info(dec, stream, NULL);
    opj_cio_close(stream);
326 327

    if (!image) {
328 329
        av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
        opj_destroy_decompress(dec);
330
        return AVERROR_UNKNOWN;
331
    }
332

333 334
    width  = image->x1 - image->x0;
    height = image->y1 - image->y0;
335

336 337
    ret = ff_set_dimensions(avctx, width, height);
    if (ret < 0)
338 339
        goto done;

340
    if (avctx->pix_fmt != AV_PIX_FMT_NONE)
341
        if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
342
            avctx->pix_fmt = AV_PIX_FMT_NONE;
343

344
    if (avctx->pix_fmt == AV_PIX_FMT_NONE)
345 346
        avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);

347
    if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
348 349
        av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
        goto done;
350
    }
351 352 353
    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;
354

355
    if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0)
356
        goto done;
357

358
    ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
Michael Niedermayer's avatar
Michael Niedermayer committed
359
    ctx->dec_params.cp_reduce = avctx->lowres;
360
    // Tie decoder with decoding parameters.
361
    opj_setup_decoder(dec, &ctx->dec_params);
362
    stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
363 364 365
    if (!stream) {
        av_log(avctx, AV_LOG_ERROR,
               "Codestream could not be opened for reading.\n");
366
        ret = AVERROR_UNKNOWN;
367
        goto done;
368 369
    }

370
    opj_image_destroy(image);
371
    // Decode the codestream
372 373
    image = opj_decode_with_info(dec, stream, NULL);
    opj_cio_close(stream);
374

375
    if (!image) {
376
        av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
377
        ret = AVERROR_UNKNOWN;
378
        goto done;
379
    }
380

381 382 383 384 385 386 387 388 389
    for (i = 0; i < image->numcomps; i++) {
        if (!image->comps[i].data) {
            av_log(avctx, AV_LOG_ERROR,
                   "Image component %d contains no data.\n", i);
            ret = AVERROR_INVALIDDATA;
            goto done;
        }
    }

390
    desc       = av_pix_fmt_desc_get(avctx->pix_fmt);
391
    pixel_size = desc->comp[0].step;
392
    ispacked   = libopenjpeg_ispacked(avctx->pix_fmt);
393

394 395 396 397 398 399
    switch (pixel_size) {
    case 1:
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto8(picture, image);
400
        }
401 402
        break;
    case 2:
403 404 405 406 407
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto16(picture, image);
        }
408 409
        break;
    case 3:
410
    case 4:
411 412 413 414
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        }
        break;
415
    case 6:
416
    case 8:
417 418 419 420
        if (ispacked) {
            libopenjpeg_copy_to_packed16(picture, image);
        }
        break;
421 422
    default:
        av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
423
        ret = AVERROR_PATCHWELCOME;
424
        goto done;
425 426
    }

427
    *got_frame = 1;
428
    ret        = buf_size;
429 430 431 432 433 434 435

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

436 437 438 439 440 441
static av_cold void libopenjpeg_static_init(AVCodec *codec)
{
    const char *version = opj_version();
    int major, minor;

    if (sscanf(version, "%d.%d", &major, &minor) == 2 && 1000*major + minor <= 1003)
442
        codec->capabilities |= AV_CODEC_CAP_EXPERIMENTAL;
443 444
}

445 446 447 448
#define OFFSET(x) offsetof(LibOpenJPEGContext, x)
#define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM

static const AVOption options[] = {
449 450
    { "lowqual", "Limit the number of layers used for decoding",
        OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
451 452 453
    { NULL },
};

454
static const AVClass openjpeg_class = {
455 456 457 458 459
    .class_name = "libopenjpeg",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};
460

461
AVCodec ff_libopenjpeg_decoder = {
462 463 464 465 466 467 468
    .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,
469
    .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
470 471
    .max_lowres     = 31,
    .priv_class     = &openjpeg_class,
472
    .init_static_data = libopenjpeg_static_init,
473
};