libopenjpegdec.c 13.5 KB
Newer Older
1 2 3 4
/*
 * JPEG 2000 decoding support via OpenJPEG
 * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
 *
5
 * This file is part of Libav.
6
 *
7
 * Libav is free software; you can redistribute it and/or
8 9 10 11
 * 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.
 *
12
 * Libav is distributed in the hope that it will be useful,
13 14 15 16 17
 * 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
18
 * License along with Libav; if not, write to the Free Software
19 20 21 22
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

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

#define  OPJ_STATIC
#include <openjpeg.h>
29

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

36
#include "avcodec.h"
37
#include "internal.h"
38
#include "thread.h"
39 40 41 42

#define JP2_SIG_TYPE    0x6A502020
#define JP2_SIG_VALUE   0x0D0A870A

43 44
// pix_fmts with lower bpp have to be listed before
// similar pix_fmts with higher bpp.
45
#define RGB_PIXEL_FORMATS  AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA,                 \
46
                           AV_PIX_FMT_RGB48, AV_PIX_FMT_RGBA64
47

48
#define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_YA8,                  \
49 50
                           AV_PIX_FMT_GRAY16

51 52 53 54 55 56 57 58 59
#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_YUV440P,   AV_PIX_FMT_YUV444P,          \
                           AV_PIX_FMT_YUV420P9,  AV_PIX_FMT_YUV422P9,         \
                           AV_PIX_FMT_YUV444P9,                               \
                           AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10,        \
                           AV_PIX_FMT_YUV444P10,                              \
                           AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16,        \
60 61
                           AV_PIX_FMT_YUV444P16

62 63
#define XYZ_PIXEL_FORMATS  AV_PIX_FMT_XYZ12

64 65 66 67 68 69 70 71 72 73 74 75
static const enum AVPixelFormat rgb_pix_fmts[] = {
    RGB_PIXEL_FORMATS
};
static const enum AVPixelFormat gray_pix_fmts[] = {
    GRAY_PIXEL_FORMATS
};
static const enum AVPixelFormat yuv_pix_fmts[] = {
    YUV_PIXEL_FORMATS
};
static const enum AVPixelFormat any_pix_fmts[] = {
    RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
};
76

77
typedef struct LibOpenJPEGContext {
78
    AVClass *class;
79
    opj_dparameters_t dec_params;
80 81
    int lowres;
    int lowqual;
82 83
} LibOpenJPEGContext;

84
static int libopenjpeg_matches_pix_fmt(const opj_image_t *img,
85
                                       enum AVPixelFormat pix_fmt)
86
{
87
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
88 89
    int match = 1;

90
    if (desc->nb_components != img->numcomps) {
91 92 93
        return 0;
    }

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

    return match;
}

122
static enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image)
123 124
{
    int index;
125
    const enum AVPixelFormat *possible_fmts = NULL;
126 127 128 129
    int possible_fmts_nb = 0;

    switch (image->color_space) {
    case CLRSPC_SRGB:
130
        possible_fmts    = rgb_pix_fmts;
131 132 133
        possible_fmts_nb = FF_ARRAY_ELEMS(rgb_pix_fmts);
        break;
    case CLRSPC_GRAY:
134
        possible_fmts    = gray_pix_fmts;
135 136 137
        possible_fmts_nb = FF_ARRAY_ELEMS(gray_pix_fmts);
        break;
    case CLRSPC_SYCC:
138
        possible_fmts    = yuv_pix_fmts;
139 140 141
        possible_fmts_nb = FF_ARRAY_ELEMS(yuv_pix_fmts);
        break;
    default:
142
        possible_fmts    = any_pix_fmts;
143 144 145 146
        possible_fmts_nb = FF_ARRAY_ELEMS(any_pix_fmts);
        break;
    }

147
    for (index = 0; index < possible_fmts_nb; ++index)
148 149 150 151
        if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
            return possible_fmts[index];
        }

152
    return AV_PIX_FMT_NONE;
153 154
}

155
static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
156
{
157
    const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
158 159
    int i, component_plane;

160
    if (pix_fmt == AV_PIX_FMT_GRAY16)
161 162
        return 0;

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

static void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image)
{
    uint8_t *img_ptr;
    int index, x, y, c;

    for (y = 0; y < picture->height; y++) {
176 177 178 179
        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++)
180 181 182 183 184 185 186 187 188 189 190 191 192 193
                *img_ptr++ = image->comps[c].data[index];
    }
}

static void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image)
{
    uint16_t *img_ptr;
    int index, x, y, c;
    int adjust[4];

    for (x = 0; x < image->numcomps; x++)
        adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);

    for (y = 0; y < picture->height; y++) {
194 195 196 197
        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++)
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221
                *img_ptr++ = image->comps[c].data[index] << adjust[c];
    }
}

static void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image)
{
    int *comp_data;
    uint8_t *img_ptr;
    int index, x, y;

    for (index = 0; index < image->numcomps; index++) {
        comp_data = image->comps[index].data;
        for (y = 0; y < image->comps[index].h; y++) {
            img_ptr = picture->data[index] + y * picture->linesize[index];
            for (x = 0; x < image->comps[index].w; x++) {
                *img_ptr = (uint8_t) *comp_data;
                img_ptr++;
                comp_data++;
            }
        }
    }
}

static void libopenjpeg_copyto16(AVFrame *p, opj_image_t *image)
222
{
223 224 225 226 227 228 229
    int *comp_data;
    uint16_t *img_ptr;
    int index, x, y;

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

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

    opj_set_default_decoder_parameters(&ctx->dec_params);
245 246 247
    return 0;
}

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

266
    *got_frame = 0;
267 268

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

281
    if (!dec) {
282
        av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
283
        return AVERROR_UNKNOWN;
284
    }
285
    opj_set_event_mgr((opj_common_ptr) dec, NULL, NULL);
286

287
    ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
288 289
    ctx->dec_params.cp_reduce         = ctx->lowres;
    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

    if (ctx->lowres) {
315
        width  = (width + (1 << ctx->lowres) - 1) >> ctx->lowres;
316 317 318
        height = (height + (1 << ctx->lowres) - 1) >> ctx->lowres;
    }

319 320
    ret = ff_set_dimensions(avctx, width, height);
    if (ret < 0)
321 322
        goto done;

323
    if (avctx->pix_fmt != AV_PIX_FMT_NONE)
324
        if (!libopenjpeg_matches_pix_fmt(image, avctx->pix_fmt))
325
            avctx->pix_fmt = AV_PIX_FMT_NONE;
326

327
    if (avctx->pix_fmt == AV_PIX_FMT_NONE)
328 329
        avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);

330
    if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
331 332
        av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
        ret = AVERROR_INVALIDDATA;
333
        goto done;
334 335
    }

336 337 338 339
    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;

340
    if ((ret = ff_thread_get_buffer(avctx, &frame, 0)) < 0) {
341
        av_log(avctx, AV_LOG_ERROR, "ff_thread_get_buffer() failed\n");
342
        goto done;
343
    }
344

345
    ctx->dec_params.cp_limit_decoding = NO_LIMITATION;
346
    // Tie decoder with decoding parameters.
347
    opj_setup_decoder(dec, &ctx->dec_params);
348
    stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
349 350 351
    if (!stream) {
        av_log(avctx, AV_LOG_ERROR,
               "Codestream could not be opened for reading.\n");
352
        ret = AVERROR_UNKNOWN;
353
        goto done;
354 355
    }

356 357
    opj_image_destroy(image);
    // Decode the codestream
358 359 360
    image = opj_decode_with_info(dec, stream, NULL);
    opj_cio_close(stream);

361 362
    if (!image) {
        av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
363
        ret = AVERROR_UNKNOWN;
364 365 366
        goto done;
    }

367
    desc       = av_pix_fmt_desc_get(avctx->pix_fmt);
368
    pixel_size = desc->comp[0].step;
369
    ispacked   = libopenjpeg_ispacked(avctx->pix_fmt);
370 371 372 373 374 375 376 377 378 379 380 381 382 383

    switch (pixel_size) {
    case 1:
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto8(picture, image);
        }
        break;
    case 2:
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        } else {
            libopenjpeg_copyto16(picture, image);
384
        }
385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
        break;
    case 3:
    case 4:
        if (ispacked) {
            libopenjpeg_copy_to_packed8(picture, image);
        }
        break;
    case 6:
    case 8:
        if (ispacked) {
            libopenjpeg_copy_to_packed16(picture, image);
        }
        break;
    default:
        av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
400
        ret = AVERROR_PATCHWELCOME;
401
        goto done;
402 403
    }

404
    *got_frame = 1;
405
    ret        = buf_size;
406 407 408 409 410 411 412

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

413 414 415 416
#define OFFSET(x) offsetof(LibOpenJPEGContext, x)
#define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM

static const AVOption options[] = {
417 418 419 420
    { "lowqual", "Limit the number of layers used for decoding",
        OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
    { "lowres",  "Lower the decoding resolution by a power of two",
        OFFSET(lowres),  AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
421 422 423 424 425 426 427 428 429
    { NULL },
};

static const AVClass class = {
    .class_name = "libopenjpeg",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
};
430

431
AVCodec ff_libopenjpeg_decoder = {
432 433 434 435 436 437 438
    .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,
439
    .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
440
    .priv_class     = &class,
441
};