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