2 * JPEG 2000 encoding support via OpenJPEG
3 * Copyright (c) 2011 Michael Bradshaw <mbradshaw@sorensonmedia.com>
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 encoder using libopenjpeg
27 #include "libavutil/opt.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/avassert.h"
31 #include "libavutil/intreadwrite.h"
39 opj_cparameters_t enc_params;
40 opj_cinfo_t *compress;
41 opj_event_mgr_t event_mgr;
53 static void error_callback(const char *msg, void *data)
55 av_log((AVCodecContext*)data, AV_LOG_ERROR, "libopenjpeg: %s\n", msg);
58 static void warning_callback(const char *msg, void *data)
60 av_log((AVCodecContext*)data, AV_LOG_WARNING, "libopenjpeg: %s\n", msg);
63 static opj_image_t *mj2_create_image(AVCodecContext *avctx, opj_cparameters_t *parameters)
65 opj_image_cmptparm_t *cmptparm;
71 OPJ_COLOR_SPACE color_space = CLRSPC_UNKNOWN;
73 sub_dx[0] = sub_dx[3] = 1;
74 sub_dy[0] = sub_dy[3] = 1;
75 sub_dx[1] = sub_dx[2] = 1<<av_pix_fmt_descriptors[avctx->pix_fmt].log2_chroma_w;
76 sub_dy[1] = sub_dy[2] = 1<<av_pix_fmt_descriptors[avctx->pix_fmt].log2_chroma_h;
78 numcomps = av_pix_fmt_descriptors[avctx->pix_fmt].nb_components;
80 switch (avctx->pix_fmt) {
84 color_space = CLRSPC_GRAY;
90 color_space = CLRSPC_SRGB;
98 case PIX_FMT_YUVA420P:
99 case PIX_FMT_YUVA422P:
100 case PIX_FMT_YUVA444P:
101 case PIX_FMT_YUV420P9:
102 case PIX_FMT_YUV422P9:
103 case PIX_FMT_YUV444P9:
104 case PIX_FMT_YUV420P10:
105 case PIX_FMT_YUV422P10:
106 case PIX_FMT_YUV444P10:
107 case PIX_FMT_YUV420P12:
108 case PIX_FMT_YUV422P12:
109 case PIX_FMT_YUV444P12:
110 case PIX_FMT_YUV420P14:
111 case PIX_FMT_YUV422P14:
112 case PIX_FMT_YUV444P14:
113 case PIX_FMT_YUV420P16:
114 case PIX_FMT_YUV422P16:
115 case PIX_FMT_YUV444P16:
116 color_space = CLRSPC_SYCC;
119 av_log(avctx, AV_LOG_ERROR, "The requested pixel format '%s' is not supported\n", av_get_pix_fmt_name(avctx->pix_fmt));
123 cmptparm = av_mallocz(numcomps * sizeof(opj_image_cmptparm_t));
125 av_log(avctx, AV_LOG_ERROR, "Not enough memory");
128 for (i = 0; i < numcomps; i++) {
129 cmptparm[i].prec = av_pix_fmt_descriptors[avctx->pix_fmt].comp[i].depth_minus1 + 1;
130 cmptparm[i].bpp = av_pix_fmt_descriptors[avctx->pix_fmt].comp[i].depth_minus1 + 1;
131 cmptparm[i].sgnd = 0;
132 cmptparm[i].dx = sub_dx[i];
133 cmptparm[i].dy = sub_dy[i];
134 cmptparm[i].w = avctx->width / sub_dx[i];
135 cmptparm[i].h = avctx->height / sub_dy[i];
138 img = opj_image_create(numcomps, cmptparm, color_space);
143 static av_cold int libopenjpeg_encode_init(AVCodecContext *avctx)
145 LibOpenJPEGContext *ctx = avctx->priv_data;
147 opj_set_default_encoder_parameters(&ctx->enc_params);
148 ctx->enc_params.cp_rsiz = ctx->profile;
149 ctx->enc_params.mode = !!avctx->global_quality;
150 ctx->enc_params.cp_cinema = ctx->cinema_mode;
151 ctx->enc_params.prog_order = ctx->prog_order;
152 ctx->enc_params.numresolution = ctx->numresolution;
153 ctx->enc_params.cp_disto_alloc = ctx->disto_alloc;
154 ctx->enc_params.cp_fixed_alloc = ctx->fixed_alloc;
155 ctx->enc_params.cp_fixed_quality = ctx->fixed_quality;
156 ctx->enc_params.tcp_numlayers = ctx->numlayers;
157 ctx->enc_params.tcp_rates[0] = FFMAX(avctx->compression_level, 0) * 2;
159 ctx->compress = opj_create_compress(ctx->format);
160 if (!ctx->compress) {
161 av_log(avctx, AV_LOG_ERROR, "Error creating the compressor\n");
162 return AVERROR(ENOMEM);
165 avctx->coded_frame = avcodec_alloc_frame();
166 if (!avctx->coded_frame) {
167 av_freep(&ctx->compress);
168 av_log(avctx, AV_LOG_ERROR, "Error allocating coded frame\n");
169 return AVERROR(ENOMEM);
172 ctx->image = mj2_create_image(avctx, &ctx->enc_params);
174 av_freep(&ctx->compress);
175 av_freep(&avctx->coded_frame);
176 av_log(avctx, AV_LOG_ERROR, "Error creating the mj2 image\n");
177 return AVERROR(EINVAL);
180 memset(&ctx->event_mgr, 0, sizeof(opj_event_mgr_t));
181 ctx->event_mgr.error_handler = error_callback;
182 ctx->event_mgr.warning_handler = warning_callback;
183 ctx->event_mgr.info_handler = NULL;
184 opj_set_event_mgr((opj_common_ptr)ctx->compress, &ctx->event_mgr, avctx);
189 static int libopenjpeg_copy_packed8(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
196 const int numcomps = image->numcomps;
198 for (compno = 0; compno < numcomps; ++compno) {
199 if (image->comps[compno].w > frame->linesize[0] / numcomps) {
200 av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
205 for (compno = 0; compno < numcomps; ++compno) {
206 for (y = 0; y < avctx->height; ++y) {
207 image_index = y * avctx->width;
208 frame_index = y * frame->linesize[0] + compno;
209 for (x = 0; x < avctx->width; ++x) {
210 image->comps[compno].data[image_index++] = frame->data[0][frame_index];
211 frame_index += numcomps;
219 static int libopenjpeg_copy_packed16(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
226 const int numcomps = image->numcomps;
227 uint16_t *frame_ptr = (uint16_t*)frame->data[0];
229 for (compno = 0; compno < numcomps; ++compno) {
230 if (image->comps[compno].w > frame->linesize[0] / numcomps) {
231 av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
236 for (compno = 0; compno < numcomps; ++compno) {
237 for (y = 0; y < avctx->height; ++y) {
238 image_index = y * avctx->width;
239 frame_index = y * (frame->linesize[0] / 2) + compno;
240 for (x = 0; x < avctx->width; ++x) {
241 image->comps[compno].data[image_index++] = frame_ptr[frame_index];
242 frame_index += numcomps;
250 static int libopenjpeg_copy_unpacked8(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
259 const int numcomps = image->numcomps;
261 for (compno = 0; compno < numcomps; ++compno) {
262 if (image->comps[compno].w > frame->linesize[compno]) {
263 av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
268 for (compno = 0; compno < numcomps; ++compno) {
269 width = avctx->width / image->comps[compno].dx;
270 height = avctx->height / image->comps[compno].dy;
271 for (y = 0; y < height; ++y) {
272 image_index = y * width;
273 frame_index = y * frame->linesize[compno];
274 for (x = 0; x < width; ++x) {
275 image->comps[compno].data[image_index++] = frame->data[compno][frame_index++];
283 static int libopenjpeg_copy_unpacked16(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
292 const int numcomps = image->numcomps;
295 for (compno = 0; compno < numcomps; ++compno) {
296 if (image->comps[compno].w > frame->linesize[compno]) {
297 av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
302 for (compno = 0; compno < numcomps; ++compno) {
303 width = avctx->width / image->comps[compno].dx;
304 height = avctx->height / image->comps[compno].dy;
305 frame_ptr = (uint16_t*)frame->data[compno];
306 for (y = 0; y < height; ++y) {
307 image_index = y * width;
308 frame_index = y * (frame->linesize[compno] / 2);
309 for (x = 0; x < width; ++x) {
310 image->comps[compno].data[image_index++] = frame_ptr[frame_index++];
318 static int libopenjpeg_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
319 const AVFrame *frame, int *got_packet)
321 LibOpenJPEGContext *ctx = avctx->priv_data;
322 opj_cinfo_t *compress = ctx->compress;
323 opj_image_t *image = ctx->image;
328 // x0, y0 is the top left corner of the image
329 // x1, y1 is the width, height of the reference grid
332 image->x1 = (avctx->width - 1) * ctx->enc_params.subsampling_dx + 1;
333 image->y1 = (avctx->height - 1) * ctx->enc_params.subsampling_dy + 1;
335 switch (avctx->pix_fmt) {
339 cpyresult = libopenjpeg_copy_packed8(avctx, frame, image);
343 cpyresult = libopenjpeg_copy_packed16(avctx, frame, image);
346 case PIX_FMT_YUV410P:
347 case PIX_FMT_YUV411P:
348 case PIX_FMT_YUV420P:
349 case PIX_FMT_YUV422P:
350 case PIX_FMT_YUV440P:
351 case PIX_FMT_YUV444P:
352 case PIX_FMT_YUVA420P:
353 case PIX_FMT_YUVA422P:
354 case PIX_FMT_YUVA444P:
355 cpyresult = libopenjpeg_copy_unpacked8(avctx, frame, image);
358 case PIX_FMT_YUV420P9:
359 case PIX_FMT_YUV422P9:
360 case PIX_FMT_YUV444P9:
361 case PIX_FMT_YUV444P10:
362 case PIX_FMT_YUV422P10:
363 case PIX_FMT_YUV420P10:
364 case PIX_FMT_YUV420P12:
365 case PIX_FMT_YUV422P12:
366 case PIX_FMT_YUV444P12:
367 case PIX_FMT_YUV420P14:
368 case PIX_FMT_YUV422P14:
369 case PIX_FMT_YUV444P14:
370 case PIX_FMT_YUV444P16:
371 case PIX_FMT_YUV422P16:
372 case PIX_FMT_YUV420P16:
373 cpyresult = libopenjpeg_copy_unpacked16(avctx, frame, image);
376 av_log(avctx, AV_LOG_ERROR, "The frame's pixel format '%s' is not supported\n", av_get_pix_fmt_name(avctx->pix_fmt));
377 return AVERROR(EINVAL);
382 av_log(avctx, AV_LOG_ERROR, "Could not copy the frame data to the internal image buffer\n");
386 opj_setup_encoder(compress, &ctx->enc_params, image);
387 stream = opj_cio_open((opj_common_ptr)compress, NULL, 0);
389 av_log(avctx, AV_LOG_ERROR, "Error creating the cio stream\n");
390 return AVERROR(ENOMEM);
393 if (!opj_encode(compress, stream, image, NULL)) {
394 opj_cio_close(stream);
395 av_log(avctx, AV_LOG_ERROR, "Error during the opj encode\n");
399 len = cio_tell(stream);
400 if ((ret = ff_alloc_packet2(avctx, pkt, len)) < 0) {
401 opj_cio_close(stream);
405 memcpy(pkt->data, stream->buffer, len);
406 pkt->flags |= AV_PKT_FLAG_KEY;
408 opj_cio_close(stream);
412 static av_cold int libopenjpeg_encode_close(AVCodecContext *avctx)
414 LibOpenJPEGContext *ctx = avctx->priv_data;
416 opj_destroy_compress(ctx->compress);
417 opj_image_destroy(ctx->image);
418 av_freep(&avctx->coded_frame);
422 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
423 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
424 static const AVOption options[] = {
425 { "format", "Codec Format", OFFSET(format), AV_OPT_TYPE_INT, { CODEC_JP2 }, CODEC_J2K, CODEC_JP2, VE, "format" },
426 { "j2k", NULL, 0, AV_OPT_TYPE_CONST, { CODEC_J2K }, 0, 0, VE, "format" },
427 { "jp2", NULL, 0, AV_OPT_TYPE_CONST, { CODEC_JP2 }, 0, 0, VE, "format" },
428 { "profile", NULL, OFFSET(profile), AV_OPT_TYPE_INT, { STD_RSIZ }, STD_RSIZ, CINEMA4K, VE, "profile" },
429 { "jpeg2000", NULL, 0, AV_OPT_TYPE_CONST, { STD_RSIZ }, 0, 0, VE, "profile" },
430 { "cinema2k", NULL, 0, AV_OPT_TYPE_CONST, { CINEMA2K }, 0, 0, VE, "profile" },
431 { "cinema4k", NULL, 0, AV_OPT_TYPE_CONST, { CINEMA4K }, 0, 0, VE, "profile" },
432 { "cinema_mode", "Digital Cinema", OFFSET(cinema_mode), AV_OPT_TYPE_INT, { OFF }, OFF, CINEMA4K_24, VE, "cinema_mode" },
433 { "off", NULL, 0, AV_OPT_TYPE_CONST, { OFF }, 0, 0, VE, "cinema_mode" },
434 { "2k_24", NULL, 0, AV_OPT_TYPE_CONST, { CINEMA2K_24 }, 0, 0, VE, "cinema_mode" },
435 { "2k_48", NULL, 0, AV_OPT_TYPE_CONST, { CINEMA2K_48 }, 0, 0, VE, "cinema_mode" },
436 { "4k_24", NULL, 0, AV_OPT_TYPE_CONST, { CINEMA4K_24 }, 0, 0, VE, "cinema_mode" },
437 { "prog_order", "Progression Order", OFFSET(prog_order), AV_OPT_TYPE_INT, { LRCP }, LRCP, CPRL, VE, "prog_order" },
438 { "lrcp", NULL, 0, AV_OPT_TYPE_CONST, { LRCP }, 0, 0, VE, "prog_order" },
439 { "rlcp", NULL, 0, AV_OPT_TYPE_CONST, { RLCP }, 0, 0, VE, "prog_order" },
440 { "rpcl", NULL, 0, AV_OPT_TYPE_CONST, { RPCL }, 0, 0, VE, "prog_order" },
441 { "pcrl", NULL, 0, AV_OPT_TYPE_CONST, { PCRL }, 0, 0, VE, "prog_order" },
442 { "cprl", NULL, 0, AV_OPT_TYPE_CONST, { CPRL }, 0, 0, VE, "prog_order" },
443 { "numresolution", NULL, OFFSET(numresolution), AV_OPT_TYPE_INT, { 6 }, 1, 10, VE },
444 { "numlayers", NULL, OFFSET(numlayers), AV_OPT_TYPE_INT, { 1 }, 1, 10, VE },
445 { "disto_alloc", NULL, OFFSET(disto_alloc), AV_OPT_TYPE_INT, { 1 }, 0, 1, VE },
446 { "fixed_alloc", NULL, OFFSET(fixed_alloc), AV_OPT_TYPE_INT, { 0 }, 0, 1, VE },
447 { "fixed_quality", NULL, OFFSET(fixed_quality), AV_OPT_TYPE_INT, { 0 }, 0, 1, VE },
451 static const AVClass class = {
452 .class_name = "libopenjpeg",
453 .item_name = av_default_item_name,
455 .version = LIBAVUTIL_VERSION_INT,
458 AVCodec ff_libopenjpeg_encoder = {
459 .name = "libopenjpeg",
460 .type = AVMEDIA_TYPE_VIDEO,
461 .id = CODEC_ID_JPEG2000,
462 .priv_data_size = sizeof(LibOpenJPEGContext),
463 .init = libopenjpeg_encode_init,
464 .encode2 = libopenjpeg_encode_frame,
465 .close = libopenjpeg_encode_close,
467 .pix_fmts = (const enum PixelFormat[]){
468 PIX_FMT_RGB24, PIX_FMT_RGBA, PIX_FMT_RGB48, PIX_FMT_RGBA64,
469 PIX_FMT_GRAY8, PIX_FMT_GRAY8A, PIX_FMT_GRAY16,
470 PIX_FMT_YUV420P, PIX_FMT_YUV422P, PIX_FMT_YUVA420P,
471 PIX_FMT_YUV440P, PIX_FMT_YUV444P, PIX_FMT_YUVA422P,
472 PIX_FMT_YUV411P, PIX_FMT_YUV410P, PIX_FMT_YUVA444P,
473 PIX_FMT_YUV420P9, PIX_FMT_YUV422P9, PIX_FMT_YUV444P9,
474 PIX_FMT_YUV420P10, PIX_FMT_YUV422P10, PIX_FMT_YUV444P10,
475 PIX_FMT_YUV420P12, PIX_FMT_YUV422P12, PIX_FMT_YUV444P12,
476 PIX_FMT_YUV420P14, PIX_FMT_YUV422P14, PIX_FMT_YUV444P14,
477 PIX_FMT_YUV420P16, PIX_FMT_YUV422P16, PIX_FMT_YUV444P16,
480 .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
481 .priv_class = &class,