git.sesse.net Git - ffmpeg/blob - libavcodec/libopenjpegdec.c

   1 /*
   2  * JPEG 2000 decoding support via OpenJPEG
   3  * Copyright (c) 2009 Jaikrishnan Menon <realityman@gmx.net>
   4  *
   5  * This file is part of FFmpeg.
   6  *
   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.
  11  *
  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.
  16  *
  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
  20  */
  21
  22 /**
  23  * @file
  24  * JPEG 2000 decoder using libopenjpeg
  25  */
  26
  27 #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 #include "libavutil/pixfmt.h"
  34
  35 #include "avcodec.h"
  36 #include "internal.h"
  37 #include "thread.h"
  38
  39 #if HAVE_OPENJPEG_1_5_OPENJPEG_H
  40 # include <openjpeg-1.5/openjpeg.h>
  41 #else
  42 # include <openjpeg.h>
  43 #endif
  44
  45 #define JP2_SIG_TYPE    0x6A502020
  46 #define JP2_SIG_VALUE   0x0D0A870A
  47
  48 // pix_fmts with lower bpp have to be listed before
  49 // 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 #define YUV_PIXEL_FORMATS  AV_PIX_FMT_YUV410P, AV_PIX_FMT_YUV411P, AV_PIX_FMT_YUVA420P, \
  57                            AV_PIX_FMT_YUV420P, AV_PIX_FMT_YUV422P, AV_PIX_FMT_YUVA422P, \
  58                            AV_PIX_FMT_YUV440P, AV_PIX_FMT_YUV444P, AV_PIX_FMT_YUVA444P, \
  59                            AV_PIX_FMT_YUV420P9, AV_PIX_FMT_YUV422P9, AV_PIX_FMT_YUV444P9, \
  60                            AV_PIX_FMT_YUVA420P9, AV_PIX_FMT_YUVA422P9, AV_PIX_FMT_YUVA444P9, \
  61                            AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, AV_PIX_FMT_YUV444P10, \
  62                            AV_PIX_FMT_YUVA420P10, AV_PIX_FMT_YUVA422P10, AV_PIX_FMT_YUVA444P10, \
  63                            AV_PIX_FMT_YUV420P12, AV_PIX_FMT_YUV422P12, AV_PIX_FMT_YUV444P12, \
  64                            AV_PIX_FMT_YUV420P14, AV_PIX_FMT_YUV422P14, AV_PIX_FMT_YUV444P14, \
  65                            AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, AV_PIX_FMT_YUV444P16, \
  66                            AV_PIX_FMT_YUVA420P16, AV_PIX_FMT_YUVA422P16, AV_PIX_FMT_YUVA444P16
  67
  68 #define XYZ_PIXEL_FORMATS  AV_PIX_FMT_XYZ12
  69
  70 static const enum AVPixelFormat libopenjpeg_rgb_pix_fmts[]  = {
  71     RGB_PIXEL_FORMATS
  72 };
  73 static const enum AVPixelFormat libopenjpeg_gray_pix_fmts[] = {
  74     GRAY_PIXEL_FORMATS
  75 };
  76 static const enum AVPixelFormat libopenjpeg_yuv_pix_fmts[]  = {
  77     YUV_PIXEL_FORMATS
  78 };
  79 static const enum AVPixelFormat libopenjpeg_all_pix_fmts[]  = {
  80     RGB_PIXEL_FORMATS, GRAY_PIXEL_FORMATS, YUV_PIXEL_FORMATS, XYZ_PIXEL_FORMATS
  81 };
  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 } LibOpenJPEGContext;
  89
  90 static void error_callback(const char *msg, void *data)
  91 {
  92     av_log(data, AV_LOG_ERROR, "%s", msg);
  93 }
  94
  95 static void warning_callback(const char *msg, void *data)
  96 {
  97     av_log(data, AV_LOG_WARNING, "%s", msg);
  98 }
  99
 100 static void info_callback(const char *msg, void *data)
 101 {
 102     av_log(data, AV_LOG_DEBUG, "%s", msg);
 103 }
 104
 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     case 4:
 116         match = match &&
 117                 desc->comp[3].depth_minus1 + 1 >= image->comps[3].prec &&
 118                 1 == image->comps[3].dx &&
 119                 1 == image->comps[3].dy;
 120     case 3:
 121         match = match &&
 122                 desc->comp[2].depth_minus1 + 1 >= image->comps[2].prec &&
 123                 1 << desc->log2_chroma_w == image->comps[2].dx &&
 124                 1 << desc->log2_chroma_h == image->comps[2].dy;
 125     case 2:
 126         match = match &&
 127                 desc->comp[1].depth_minus1 + 1 >= image->comps[1].prec &&
 128                 1 << desc->log2_chroma_w == image->comps[1].dx &&
 129                 1 << desc->log2_chroma_h == image->comps[1].dy;
 130     case 1:
 131         match = match &&
 132                 desc->comp[0].depth_minus1 + 1 >= image->comps[0].prec &&
 133                 1 == image->comps[0].dx &&
 134                 1 == image->comps[0].dy;
 135     default:
 136         break;
 137     }
 138
 139     return match;
 140 }
 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     int possible_fmts_nb = 0;
 146
 147     switch (image->color_space) {
 148     case CLRSPC_SRGB:
 149         possible_fmts    = libopenjpeg_rgb_pix_fmts;
 150         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_rgb_pix_fmts);
 151         break;
 152     case CLRSPC_GRAY:
 153         possible_fmts    = libopenjpeg_gray_pix_fmts;
 154         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_gray_pix_fmts);
 155         break;
 156     case CLRSPC_SYCC:
 157         possible_fmts    = libopenjpeg_yuv_pix_fmts;
 158         possible_fmts_nb = FF_ARRAY_ELEMS(libopenjpeg_yuv_pix_fmts);
 159         break;
 160     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         if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
 168             return possible_fmts[index];
 169         }
 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         return 0;
 181
 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             return 0;
 186     return 1;
 187 }
 188
 189 static inline void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image) {
 190     uint8_t *img_ptr;
 191     int index, x, y, c;
 192     for (y = 0; y < picture->height; y++) {
 193         index   = y * picture->width;
 194         img_ptr = picture->data[0] + y * picture->linesize[0];
 195         for (x = 0; x < picture->width; x++, index++)
 196             for (c = 0; c < image->numcomps; c++)
 197                 *img_ptr++ = 0x80 * image->comps[c].sgnd + image->comps[c].data[index];
 198     }
 199 }
 200
 201 static inline void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image) {
 202     uint16_t *img_ptr;
 203     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
 204     int index, x, y, c;
 205     int adjust[4];
 206     for (x = 0; x < image->numcomps; x++)
 207         adjust[x] = FFMAX(FFMIN(desc->comp[x].depth_minus1 + 1 - image->comps[x].prec, 8), 0) + desc->comp[x].shift;
 208
 209     for (y = 0; y < picture->height; y++) {
 210         index   = y * picture->width;
 211         img_ptr = (uint16_t *) (picture->data[0] + y * picture->linesize[0]);
 212         for (x = 0; x < picture->width; x++, index++)
 213             for (c = 0; c < image->numcomps; c++)
 214                 *img_ptr++ = (1 << image->comps[c].prec - 1) * image->comps[c].sgnd +
 215                              (unsigned)image->comps[c].data[index] << adjust[c];
 216     }
 217 }
 218
 219 static inline void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image) {
 220     int *comp_data;
 221     uint8_t *img_ptr;
 222     int index, x, y;
 223
 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                 img_ptr++;
 231                 comp_data++;
 232             }
 233         }
 234     }
 235 }
 236
 237 static inline void libopenjpeg_copyto16(AVFrame *picture, opj_image_t *image) {
 238     int *comp_data;
 239     uint16_t *img_ptr;
 240     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(picture->format);
 241     int index, x, y;
 242     int adjust[4];
 243     for (x = 0; x < image->numcomps; x++)
 244         adjust[x] = FFMAX(FFMIN(desc->comp[x].depth_minus1 + 1 - 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                 *img_ptr = (1 << image->comps[index].prec - 1) * image->comps[index].sgnd +
 252                            (unsigned)*comp_data << adjust[index];
 253                 img_ptr++;
 254                 comp_data++;
 255             }
 256         }
 257     }
 258 }
 259
 260 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
 261 {
 262     LibOpenJPEGContext *ctx = avctx->priv_data;
 263
 264     opj_set_default_decoder_parameters(&ctx->dec_params);
 265     return 0;
 266 }
 267
 268 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
 269                                     void *data, int *got_frame,
 270                                     AVPacket *avpkt)
 271 {
 272     uint8_t *buf            = avpkt->data;
 273     int buf_size            = avpkt->size;
 274     LibOpenJPEGContext *ctx = avctx->priv_data;
 275     ThreadFrame frame       = { .f = data };
 276     AVFrame *picture        = data;
 277     const AVPixFmtDescriptor *desc;
 278     opj_dinfo_t *dec;
 279     opj_cio_t *stream;
 280     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         (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
 291         (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
 292         dec = opj_create_decompress(CODEC_JP2);
 293     } else {
 294         /* If the AVPacket contains a jp2c box, then skip to
 295          * the starting byte of the codestream. */
 296         if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
 297             buf += 8;
 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     memset(&ctx->event_mgr, 0, sizeof(ctx->event_mgr));
 306     ctx->event_mgr.info_handler    = info_callback;
 307     ctx->event_mgr.error_handler   = error_callback;
 308     ctx->event_mgr.warning_handler = warning_callback;
 309     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     // Tie decoder with decoding parameters
 313     opj_setup_decoder(dec, &ctx->dec_params);
 314     stream = opj_cio_open((opj_common_ptr) dec, buf, buf_size);
 315
 316     if (!stream) {
 317         av_log(avctx, AV_LOG_ERROR,
 318                "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     image = opj_decode_with_info(dec, stream, NULL);
 325     opj_cio_close(stream);
 326
 327     if (!image) {
 328         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
 329         opj_destroy_decompress(dec);
 330         return AVERROR_UNKNOWN;
 331     }
 332
 333     width  = image->x1 - image->x0;
 334     height = image->y1 - image->y0;
 335
 336     ret = ff_set_dimensions(avctx, width, height);
 337     if (ret < 0)
 338         goto done;
 339
 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         avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
 346
 347     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
 348         av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
 349         goto done;
 350     }
 351     for (i = 0; i < image->numcomps; i++)
 352         if (image->comps[i].prec > avctx->bits_per_raw_sample)
 353             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;
 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     if (!stream) {
 364         av_log(avctx, AV_LOG_ERROR,
 365                "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     image = opj_decode_with_info(dec, stream, NULL);
 373     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     for (i = 0; i < image->numcomps; i++) {
 382         if (!image->comps[i].data) {
 383             av_log(avctx, AV_LOG_ERROR,
 384                    "Image component %d contains no data.\n", i);
 385             ret = AVERROR_INVALIDDATA;
 386             goto done;
 387         }
 388     }
 389
 390     desc       = av_pix_fmt_desc_get(avctx->pix_fmt);
 391     pixel_size = desc->comp[0].step_minus1 + 1;
 392     ispacked   = libopenjpeg_ispacked(avctx->pix_fmt);
 393
 394     switch (pixel_size) {
 395     case 1:
 396         if (ispacked) {
 397             libopenjpeg_copy_to_packed8(picture, image);
 398         } else {
 399             libopenjpeg_copyto8(picture, image);
 400         }
 401         break;
 402     case 2:
 403         if (ispacked) {
 404             libopenjpeg_copy_to_packed8(picture, image);
 405         } else {
 406             libopenjpeg_copyto16(picture, image);
 407         }
 408         break;
 409     case 3:
 410     case 4:
 411         if (ispacked) {
 412             libopenjpeg_copy_to_packed8(picture, image);
 413         }
 414         break;
 415     case 6:
 416     case 8:
 417         if (ispacked) {
 418             libopenjpeg_copy_to_packed16(picture, image);
 419         }
 420         break;
 421     default:
 422         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 done:
 431     opj_image_destroy(image);
 432     opj_destroy_decompress(dec);
 433     return ret;
 434 }
 435
 436 static av_cold void libopenjpeg_static_init(AVCodec *codec)
 437 {
 438     const char *version = opj_version();
 439     int major, minor;
 440
 441     if (sscanf(version, "%d.%d", &major, &minor) == 2 && 1000*major + minor <= 1003)
 442         codec->capabilities |= AV_CODEC_CAP_EXPERIMENTAL;
 443 }
 444
 445 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
 446 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
 447
 448 static const AVOption options[] = {
 449     { "lowqual", "Limit the number of layers used for decoding",
 450         OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
 451     { NULL },
 452 };
 453
 454 static const AVClass openjpeg_class = {
 455     .class_name = "libopenjpeg",
 456     .item_name  = av_default_item_name,
 457     .option     = options,
 458     .version    = LIBAVUTIL_VERSION_INT,
 459 };
 460
 461 AVCodec ff_libopenjpeg_decoder = {
 462     .name           = "libopenjpeg",
 463     .long_name      = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
 464     .type           = AVMEDIA_TYPE_VIDEO,
 465     .id             = AV_CODEC_ID_JPEG2000,
 466     .priv_data_size = sizeof(LibOpenJPEGContext),
 467     .init           = libopenjpeg_decode_init,
 468     .decode         = libopenjpeg_decode_frame,
 469     .capabilities   = AV_CODEC_CAP_DR1 | AV_CODEC_CAP_FRAME_THREADS,
 470     .max_lowres     = 31,
 471     .priv_class     = &openjpeg_class,
 472     .init_static_data = libopenjpeg_static_init,
 473 };