libopenjpegenc: allow changing encoding parameters
[ffmpeg.git] / libavcodec / libopenjpegenc.c
1 /*
2  * JPEG 2000 encoding support via OpenJPEG
3  * Copyright (c) 2011 Michael Bradshaw <mbradshaw@sorensonmedia.com>
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 encoder using libopenjpeg
25 */
26
27 #include "libavutil/opt.h"
28 #include "libavutil/imgutils.h"
29 #include "libavutil/avassert.h"
30 #include "avcodec.h"
31 #include "libavutil/intreadwrite.h"
32 #include "internal.h"
33 #define  OPJ_STATIC
34 #include <openjpeg.h>
35
36 typedef struct {
37     AVClass *avclass;
38     opj_image_t *image;
39     opj_cparameters_t enc_params;
40     opj_cinfo_t *compress;
41     opj_event_mgr_t event_mgr;
42     int format;
43     int profile;
44     int cinema_mode;
45     int prog_order;
46     int numresolution;
47     int numlayers;
48     int disto_alloc;
49     int fixed_alloc;
50     int fixed_quality;
51 } LibOpenJPEGContext;
52
53 static void error_callback(const char *msg, void *data)
54 {
55     av_log((AVCodecContext*)data, AV_LOG_ERROR, "libopenjpeg: %s\n", msg);
56 }
57
58 static void warning_callback(const char *msg, void *data)
59 {
60     av_log((AVCodecContext*)data, AV_LOG_WARNING, "libopenjpeg: %s\n", msg);
61 }
62
63 static opj_image_t *mj2_create_image(AVCodecContext *avctx, opj_cparameters_t *parameters)
64 {
65     opj_image_cmptparm_t *cmptparm;
66     opj_image_t *img;
67     int i;
68     int sub_dx[4];
69     int sub_dy[4];
70     int numcomps;
71     OPJ_COLOR_SPACE color_space = CLRSPC_UNKNOWN;
72
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;
77
78     numcomps = av_pix_fmt_descriptors[avctx->pix_fmt].nb_components;
79
80     switch (avctx->pix_fmt) {
81     case PIX_FMT_GRAY8:
82     case PIX_FMT_GRAY8A:
83     case PIX_FMT_GRAY16:
84         color_space = CLRSPC_GRAY;
85         break;
86     case PIX_FMT_RGB24:
87     case PIX_FMT_RGBA:
88     case PIX_FMT_RGB48:
89     case PIX_FMT_RGBA64:
90         color_space = CLRSPC_SRGB;
91         break;
92     case PIX_FMT_YUV420P:
93     case PIX_FMT_YUV422P:
94     case PIX_FMT_YUV440P:
95     case PIX_FMT_YUV444P:
96     case PIX_FMT_YUVA420P:
97     case PIX_FMT_YUV420P9:
98     case PIX_FMT_YUV422P9:
99     case PIX_FMT_YUV444P9:
100     case PIX_FMT_YUV420P10:
101     case PIX_FMT_YUV422P10:
102     case PIX_FMT_YUV444P10:
103     case PIX_FMT_YUV420P16:
104     case PIX_FMT_YUV422P16:
105     case PIX_FMT_YUV444P16:
106         color_space = CLRSPC_SYCC;
107         break;
108     default:
109         av_log(avctx, AV_LOG_ERROR, "The requested pixel format '%s' is not supported\n", av_get_pix_fmt_name(avctx->pix_fmt));
110         return NULL;
111     }
112
113     cmptparm = av_mallocz(numcomps * sizeof(opj_image_cmptparm_t));
114     if (!cmptparm) {
115         av_log(avctx, AV_LOG_ERROR, "Not enough memory");
116         return NULL;
117     }
118     for (i = 0; i < numcomps; i++) {
119         cmptparm[i].prec = av_pix_fmt_descriptors[avctx->pix_fmt].comp[i].depth_minus1 + 1;
120         cmptparm[i].bpp = av_pix_fmt_descriptors[avctx->pix_fmt].comp[i].depth_minus1 + 1;
121         cmptparm[i].sgnd = 0;
122         cmptparm[i].dx = sub_dx[i];
123         cmptparm[i].dy = sub_dy[i];
124         cmptparm[i].w = avctx->width / sub_dx[i];
125         cmptparm[i].h = avctx->height / sub_dy[i];
126     }
127
128     img = opj_image_create(numcomps, cmptparm, color_space);
129     av_freep(&cmptparm);
130     return img;
131 }
132
133 static av_cold int libopenjpeg_encode_init(AVCodecContext *avctx)
134 {
135     LibOpenJPEGContext *ctx = avctx->priv_data;
136
137     opj_set_default_encoder_parameters(&ctx->enc_params);
138     ctx->enc_params.cp_rsiz = ctx->profile;
139     ctx->enc_params.mode = !!avctx->global_quality;
140     ctx->enc_params.cp_cinema = ctx->cinema_mode;
141     ctx->enc_params.prog_order = ctx->prog_order;
142     ctx->enc_params.numresolution = ctx->numresolution;
143     ctx->enc_params.cp_disto_alloc = ctx->disto_alloc;
144     ctx->enc_params.cp_fixed_alloc = ctx->fixed_alloc;
145     ctx->enc_params.cp_fixed_quality = ctx->fixed_quality;
146     ctx->enc_params.tcp_numlayers = ctx->numlayers;
147     ctx->enc_params.tcp_rates[0] = FFMAX(avctx->compression_level, 0) * 2;
148     ctx->enc_params.cp_disto_alloc = 1;
149
150     ctx->compress = opj_create_compress(ctx->format);
151     if (!ctx->compress) {
152         av_log(avctx, AV_LOG_ERROR, "Error creating the compressor\n");
153         return AVERROR(ENOMEM);
154     }
155
156     avctx->coded_frame = avcodec_alloc_frame();
157     if (!avctx->coded_frame) {
158         av_freep(&ctx->compress);
159         av_log(avctx, AV_LOG_ERROR, "Error allocating coded frame\n");
160         return AVERROR(ENOMEM);
161     }
162
163     ctx->image = mj2_create_image(avctx, &ctx->enc_params);
164     if (!ctx->image) {
165         av_freep(&ctx->compress);
166         av_freep(&avctx->coded_frame);
167         av_log(avctx, AV_LOG_ERROR, "Error creating the mj2 image\n");
168         return AVERROR(EINVAL);
169     }
170
171     memset(&ctx->event_mgr, 0, sizeof(opj_event_mgr_t));
172     ctx->event_mgr.error_handler = error_callback;
173     ctx->event_mgr.warning_handler = warning_callback;
174     ctx->event_mgr.info_handler = NULL;
175     opj_set_event_mgr((opj_common_ptr)ctx->compress, &ctx->event_mgr, avctx);
176
177     return 0;
178 }
179
180 static int libopenjpeg_copy_packed8(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
181 {
182     int compno;
183     int x;
184     int y;
185     int image_index;
186     int frame_index;
187     const int numcomps = image->numcomps;
188
189     for (compno = 0; compno < numcomps; ++compno) {
190         if (image->comps[compno].w > frame->linesize[0] / numcomps) {
191             av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
192             return 0;
193         }
194     }
195
196     for (compno = 0; compno < numcomps; ++compno) {
197         for (y = 0; y < avctx->height; ++y) {
198             image_index = y * avctx->width;
199             frame_index = y * frame->linesize[0] + compno;
200             for (x = 0; x < avctx->width; ++x) {
201                 image->comps[compno].data[image_index++] = frame->data[0][frame_index];
202                 frame_index += numcomps;
203             }
204         }
205     }
206
207     return 1;
208 }
209
210 static int libopenjpeg_copy_packed16(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
211 {
212     int compno;
213     int x;
214     int y;
215     int image_index;
216     int frame_index;
217     const int numcomps = image->numcomps;
218     uint16_t *frame_ptr = (uint16_t*)frame->data[0];
219
220     for (compno = 0; compno < numcomps; ++compno) {
221         if (image->comps[compno].w > frame->linesize[0] / numcomps) {
222             av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
223             return 0;
224         }
225     }
226
227     for (compno = 0; compno < numcomps; ++compno) {
228         for (y = 0; y < avctx->height; ++y) {
229             image_index = y * avctx->width;
230             frame_index = y * (frame->linesize[0] / 2) + compno;
231             for (x = 0; x < avctx->width; ++x) {
232                 image->comps[compno].data[image_index++] = frame_ptr[frame_index];
233                 frame_index += numcomps;
234             }
235         }
236     }
237
238     return 1;
239 }
240
241 static int libopenjpeg_copy_unpacked8(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
242 {
243     int compno;
244     int x;
245     int y;
246     int width;
247     int height;
248     int image_index;
249     int frame_index;
250     const int numcomps = image->numcomps;
251
252     for (compno = 0; compno < numcomps; ++compno) {
253         if (image->comps[compno].w > frame->linesize[compno]) {
254             av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
255             return 0;
256         }
257     }
258
259     for (compno = 0; compno < numcomps; ++compno) {
260         width = avctx->width / image->comps[compno].dx;
261         height = avctx->height / image->comps[compno].dy;
262         for (y = 0; y < height; ++y) {
263             image_index = y * width;
264             frame_index = y * frame->linesize[compno];
265             for (x = 0; x < width; ++x) {
266                 image->comps[compno].data[image_index++] = frame->data[compno][frame_index++];
267             }
268         }
269     }
270
271     return 1;
272 }
273
274 static int libopenjpeg_copy_unpacked16(AVCodecContext *avctx, const AVFrame *frame, opj_image_t *image)
275 {
276     int compno;
277     int x;
278     int y;
279     int width;
280     int height;
281     int image_index;
282     int frame_index;
283     const int numcomps = image->numcomps;
284     uint16_t *frame_ptr;
285
286     for (compno = 0; compno < numcomps; ++compno) {
287         if (image->comps[compno].w > frame->linesize[compno]) {
288             av_log(avctx, AV_LOG_ERROR, "Error: frame's linesize is too small for the image\n");
289             return 0;
290         }
291     }
292
293     for (compno = 0; compno < numcomps; ++compno) {
294         width = avctx->width / image->comps[compno].dx;
295         height = avctx->height / image->comps[compno].dy;
296         frame_ptr = (uint16_t*)frame->data[compno];
297         for (y = 0; y < height; ++y) {
298             image_index = y * width;
299             frame_index = y * (frame->linesize[compno] / 2);
300             for (x = 0; x < width; ++x) {
301                 image->comps[compno].data[image_index++] = frame_ptr[frame_index++];
302             }
303         }
304     }
305
306     return 1;
307 }
308
309 static int libopenjpeg_encode_frame(AVCodecContext *avctx, AVPacket *pkt,
310                                     const AVFrame *frame, int *got_packet)
311 {
312     LibOpenJPEGContext *ctx = avctx->priv_data;
313     opj_cinfo_t *compress = ctx->compress;
314     opj_image_t *image = ctx->image;
315     opj_cio_t *stream;
316     int cpyresult = 0;
317     int ret, len;
318
319     // x0, y0 is the top left corner of the image
320     // x1, y1 is the width, height of the reference grid
321     image->x0 = 0;
322     image->y0 = 0;
323     image->x1 = (avctx->width - 1) * ctx->enc_params.subsampling_dx + 1;
324     image->y1 = (avctx->height - 1) * ctx->enc_params.subsampling_dy + 1;
325
326     switch (avctx->pix_fmt) {
327     case PIX_FMT_RGB24:
328     case PIX_FMT_RGBA:
329     case PIX_FMT_GRAY8A:
330         cpyresult = libopenjpeg_copy_packed8(avctx, frame, image);
331         break;
332     case PIX_FMT_RGB48:
333     case PIX_FMT_RGBA64:
334         cpyresult = libopenjpeg_copy_packed16(avctx, frame, image);
335         break;
336     case PIX_FMT_GRAY8:
337     case PIX_FMT_YUV420P:
338     case PIX_FMT_YUV422P:
339     case PIX_FMT_YUV440P:
340     case PIX_FMT_YUV444P:
341     case PIX_FMT_YUVA420P:
342         cpyresult = libopenjpeg_copy_unpacked8(avctx, frame, image);
343         break;
344     case PIX_FMT_GRAY16:
345     case PIX_FMT_YUV420P9:
346     case PIX_FMT_YUV420P10:
347     case PIX_FMT_YUV420P16:
348     case PIX_FMT_YUV422P9:
349     case PIX_FMT_YUV422P10:
350     case PIX_FMT_YUV422P16:
351     case PIX_FMT_YUV444P9:
352     case PIX_FMT_YUV444P10:
353     case PIX_FMT_YUV444P16:
354         cpyresult = libopenjpeg_copy_unpacked16(avctx, frame, image);
355         break;
356     default:
357         av_log(avctx, AV_LOG_ERROR, "The frame's pixel format '%s' is not supported\n", av_get_pix_fmt_name(avctx->pix_fmt));
358         return AVERROR(EINVAL);
359         break;
360     }
361
362     if (!cpyresult) {
363         av_log(avctx, AV_LOG_ERROR, "Could not copy the frame data to the internal image buffer\n");
364         return -1;
365     }
366
367     opj_setup_encoder(compress, &ctx->enc_params, image);
368     stream = opj_cio_open((opj_common_ptr)compress, NULL, 0);
369     if (!stream) {
370         av_log(avctx, AV_LOG_ERROR, "Error creating the cio stream\n");
371         return AVERROR(ENOMEM);
372     }
373
374     if (!opj_encode(compress, stream, image, NULL)) {
375         opj_cio_close(stream);
376         av_log(avctx, AV_LOG_ERROR, "Error during the opj encode\n");
377         return -1;
378     }
379
380     len = cio_tell(stream);
381     if ((ret = ff_alloc_packet2(avctx, pkt, len)) < 0) {
382         opj_cio_close(stream);
383         return ret;
384     }
385
386     memcpy(pkt->data, stream->buffer, len);
387     pkt->flags |= AV_PKT_FLAG_KEY;
388     *got_packet = 1;
389     opj_cio_close(stream);
390     return 0;
391 }
392
393 static av_cold int libopenjpeg_encode_close(AVCodecContext *avctx)
394 {
395     LibOpenJPEGContext *ctx = avctx->priv_data;
396
397     opj_destroy_compress(ctx->compress);
398     opj_image_destroy(ctx->image);
399     av_freep(&avctx->coded_frame);
400     return 0 ;
401 }
402
403 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
404 #define VE AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_ENCODING_PARAM
405 static const AVOption options[] = {
406     { "format",        "Codec Format",      OFFSET(format),        AV_OPT_TYPE_INT,   { CODEC_JP2   }, CODEC_J2K, CODEC_JP2,   VE, "format"      },
407     { "j2k",           NULL,                0,                     AV_OPT_TYPE_CONST, { CODEC_J2K   }, 0,         0,           VE, "format"      },
408     { "jp2",           NULL,                0,                     AV_OPT_TYPE_CONST, { CODEC_JP2   }, 0,         0,           VE, "format"      },
409     { "profile",       NULL,                OFFSET(profile),       AV_OPT_TYPE_INT,   { STD_RSIZ    }, STD_RSIZ,  CINEMA4K,    VE, "profile"     },
410     { "jpeg2000",      NULL,                0,                     AV_OPT_TYPE_CONST, { STD_RSIZ    }, 0,         0,           VE, "profile"     },
411     { "cinema2k",      NULL,                0,                     AV_OPT_TYPE_CONST, { CINEMA2K    }, 0,         0,           VE, "profile"     },
412     { "cinema4k",      NULL,                0,                     AV_OPT_TYPE_CONST, { CINEMA4K    }, 0,         0,           VE, "profile"     },
413     { "cinema_mode",   "Digital Cinema",    OFFSET(cinema_mode),   AV_OPT_TYPE_INT,   { OFF         }, OFF,       CINEMA4K_24, VE, "cinema_mode" },
414     { "off",           NULL,                0,                     AV_OPT_TYPE_CONST, { OFF         }, 0,         0,           VE, "cinema_mode" },
415     { "2k_24",         NULL,                0,                     AV_OPT_TYPE_CONST, { CINEMA2K_24 }, 0,         0,           VE, "cinema_mode" },
416     { "2k_48",         NULL,                0,                     AV_OPT_TYPE_CONST, { CINEMA2K_48 }, 0,         0,           VE, "cinema_mode" },
417     { "4k_24",         NULL,                0,                     AV_OPT_TYPE_CONST, { CINEMA4K_24 }, 0,         0,           VE, "cinema_mode" },
418     { "prog_order",    "Progression Order", OFFSET(prog_order),    AV_OPT_TYPE_INT,   { LRCP        }, LRCP,      CPRL,        VE, "prog_order"  },
419     { "lrcp",          NULL,                0,                     AV_OPT_TYPE_CONST, { LRCP        }, 0,         0,           VE, "prog_order"  },
420     { "rlcp",          NULL,                0,                     AV_OPT_TYPE_CONST, { RLCP        }, 0,         0,           VE, "prog_order"  },
421     { "rpcl",          NULL,                0,                     AV_OPT_TYPE_CONST, { RPCL        }, 0,         0,           VE, "prog_order"  },
422     { "pcrl",          NULL,                0,                     AV_OPT_TYPE_CONST, { PCRL        }, 0,         0,           VE, "prog_order"  },
423     { "cprl",          NULL,                0,                     AV_OPT_TYPE_CONST, { CPRL        }, 0,         0,           VE, "prog_order"  },
424     { "numresolution", NULL,                OFFSET(numresolution), AV_OPT_TYPE_INT,   { 6           }, 1,         10,          VE                },
425     { "numlayers",     NULL,                OFFSET(numlayers),     AV_OPT_TYPE_INT,   { 1           }, 1,         10,          VE                },
426     { "disto_alloc",   NULL,                OFFSET(disto_alloc),   AV_OPT_TYPE_INT,   { 1           }, 0,         1,           VE                },
427     { "fixed_alloc",   NULL,                OFFSET(fixed_alloc),   AV_OPT_TYPE_INT,   { 0           }, 0,         1,           VE                },
428     { "fixed_quality", NULL,                OFFSET(fixed_quality), AV_OPT_TYPE_INT,   { 0           }, 0,         1,           VE                },
429     { NULL },
430 };
431
432 static const AVClass class = {
433     .class_name = "libopenjpeg",
434     .item_name  = av_default_item_name,
435     .option     = options,
436     .version    = LIBAVUTIL_VERSION_INT,
437 };
438
439 AVCodec ff_libopenjpeg_encoder = {
440     .name           = "libopenjpeg",
441     .type           = AVMEDIA_TYPE_VIDEO,
442     .id             = CODEC_ID_JPEG2000,
443     .priv_data_size = sizeof(LibOpenJPEGContext),
444     .init           = libopenjpeg_encode_init,
445     .encode2        = libopenjpeg_encode_frame,
446     .close          = libopenjpeg_encode_close,
447     .capabilities   = 0,
448     .pix_fmts = (const enum PixelFormat[]){PIX_FMT_RGB24,PIX_FMT_RGBA,PIX_FMT_RGB48,PIX_FMT_RGBA64,
449                                            PIX_FMT_GRAY8,PIX_FMT_GRAY8A,PIX_FMT_GRAY16,
450                                            PIX_FMT_YUV420P,PIX_FMT_YUV422P,PIX_FMT_YUVA420P,
451                                            PIX_FMT_YUV440P,PIX_FMT_YUV444P,
452                                            PIX_FMT_YUV420P9,PIX_FMT_YUV422P9,PIX_FMT_YUV444P9,
453                                            PIX_FMT_YUV420P10,PIX_FMT_YUV422P10,PIX_FMT_YUV444P10,
454                                            PIX_FMT_YUV420P16,PIX_FMT_YUV422P16,PIX_FMT_YUV444P16,
455                                            PIX_FMT_NONE},
456     .long_name = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
457     .priv_class     = &class,
458 };