lavc decoders: work with refcounted frames.
[ffmpeg.git] / 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 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 decoder using libopenjpeg
25  */
26
27 #define  OPJ_STATIC
28 #include <openjpeg.h>
29
30 #include "libavutil/common.h"
31 #include "libavutil/intreadwrite.h"
32 #include "libavutil/imgutils.h"
33 #include "libavutil/pixfmt.h"
34 #include "libavutil/opt.h"
35 #include "avcodec.h"
36 #include "thread.h"
37
38 #define JP2_SIG_TYPE    0x6A502020
39 #define JP2_SIG_VALUE   0x0D0A870A
40
41 // pix_fmts with lower bpp have to be listed before
42 // similar pix_fmts with higher bpp.
43 #define RGB_PIXEL_FORMATS  AV_PIX_FMT_RGB24, AV_PIX_FMT_RGBA,  \
44                            AV_PIX_FMT_RGB48
45
46 #define GRAY_PIXEL_FORMATS AV_PIX_FMT_GRAY8, AV_PIX_FMT_Y400A, \
47                            AV_PIX_FMT_GRAY16
48
49 #define YUV_PIXEL_FORMATS  AV_PIX_FMT_YUV410P,   AV_PIX_FMT_YUV411P,   \
50                            AV_PIX_FMT_YUVA420P, \
51                            AV_PIX_FMT_YUV420P,   AV_PIX_FMT_YUV422P,   \
52                            AV_PIX_FMT_YUV440P,   AV_PIX_FMT_YUV444P,   \
53                            AV_PIX_FMT_YUV420P9,  AV_PIX_FMT_YUV422P9,  \
54                            AV_PIX_FMT_YUV444P9, \
55                            AV_PIX_FMT_YUV420P10, AV_PIX_FMT_YUV422P10, \
56                            AV_PIX_FMT_YUV444P10, \
57                            AV_PIX_FMT_YUV420P16, AV_PIX_FMT_YUV422P16, \
58                            AV_PIX_FMT_YUV444P16
59
60 static const enum AVPixelFormat rgb_pix_fmts[]  = {RGB_PIXEL_FORMATS};
61 static const enum AVPixelFormat gray_pix_fmts[] = {GRAY_PIXEL_FORMATS};
62 static const enum AVPixelFormat yuv_pix_fmts[]  = {YUV_PIXEL_FORMATS};
63 static const enum AVPixelFormat any_pix_fmts[]  = {RGB_PIXEL_FORMATS,
64                                                  GRAY_PIXEL_FORMATS,
65                                                  YUV_PIXEL_FORMATS};
66
67 typedef struct {
68     AVClass *class;
69     opj_dparameters_t dec_params;
70     int lowres;
71     int lowqual;
72 } LibOpenJPEGContext;
73
74 static int libopenjpeg_matches_pix_fmt(const opj_image_t *img,
75                                        enum AVPixelFormat pix_fmt)
76 {
77     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
78     int match = 1;
79
80     if (desc->nb_components != img->numcomps) {
81         return 0;
82     }
83
84     switch (desc->nb_components) {
85     case 4:
86         match = match &&
87             desc->comp[3].depth_minus1 + 1 >= img->comps[3].prec &&
88             1 == img->comps[3].dx &&
89             1 == img->comps[3].dy;
90     case 3:
91         match = match &&
92             desc->comp[2].depth_minus1 + 1 >= img->comps[2].prec &&
93             1 << desc->log2_chroma_w == img->comps[2].dx &&
94             1 << desc->log2_chroma_h == img->comps[2].dy;
95     case 2:
96         match = match &&
97             desc->comp[1].depth_minus1 + 1 >= img->comps[1].prec &&
98             1 << desc->log2_chroma_w == img->comps[1].dx &&
99             1 << desc->log2_chroma_h == img->comps[1].dy;
100     case 1:
101         match = match &&
102             desc->comp[0].depth_minus1 + 1 >= img->comps[0].prec &&
103             1 == img->comps[0].dx &&
104             1 == img->comps[0].dy;
105     default:
106         break;
107     }
108
109     return match;
110 }
111
112 static enum AVPixelFormat libopenjpeg_guess_pix_fmt(const opj_image_t *image)
113 {
114     int index;
115     const enum AVPixelFormat *possible_fmts = NULL;
116     int possible_fmts_nb = 0;
117
118     switch (image->color_space) {
119     case CLRSPC_SRGB:
120         possible_fmts = rgb_pix_fmts;
121         possible_fmts_nb = FF_ARRAY_ELEMS(rgb_pix_fmts);
122         break;
123     case CLRSPC_GRAY:
124         possible_fmts = gray_pix_fmts;
125         possible_fmts_nb = FF_ARRAY_ELEMS(gray_pix_fmts);
126         break;
127     case CLRSPC_SYCC:
128         possible_fmts = yuv_pix_fmts;
129         possible_fmts_nb = FF_ARRAY_ELEMS(yuv_pix_fmts);
130         break;
131     default:
132         possible_fmts = any_pix_fmts;
133         possible_fmts_nb = FF_ARRAY_ELEMS(any_pix_fmts);
134         break;
135     }
136
137     for (index = 0; index < possible_fmts_nb; ++index) {
138         if (libopenjpeg_matches_pix_fmt(image, possible_fmts[index])) {
139             return possible_fmts[index];
140         }
141     }
142
143     return AV_PIX_FMT_NONE;
144 }
145
146 static inline int libopenjpeg_ispacked(enum AVPixelFormat pix_fmt)
147 {
148     const AVPixFmtDescriptor *desc = av_pix_fmt_desc_get(pix_fmt);
149     int i, component_plane;
150
151     if (pix_fmt == AV_PIX_FMT_GRAY16)
152         return 0;
153
154     component_plane = desc->comp[0].plane;
155     for (i = 1; i < desc->nb_components; i++) {
156         if (component_plane != desc->comp[i].plane)
157             return 0;
158     }
159     return 1;
160 }
161
162 static void libopenjpeg_copy_to_packed8(AVFrame *picture, opj_image_t *image)
163 {
164     uint8_t *img_ptr;
165     int index, x, y, c;
166
167     for (y = 0; y < picture->height; y++) {
168         index = y*picture->width;
169         img_ptr = picture->data[0] + y*picture->linesize[0];
170         for (x = 0; x < picture->width; x++, index++) {
171             for (c = 0; c < image->numcomps; c++) {
172                 *img_ptr++ = image->comps[c].data[index];
173             }
174         }
175     }
176 }
177
178 static void libopenjpeg_copy_to_packed16(AVFrame *picture, opj_image_t *image)
179 {
180     uint16_t *img_ptr;
181     int index, x, y, c;
182     int adjust[4];
183
184     for (x = 0; x < image->numcomps; x++)
185         adjust[x] = FFMAX(FFMIN(16 - image->comps[x].prec, 8), 0);
186
187     for (y = 0; y < picture->height; y++) {
188         index = y*picture->width;
189         img_ptr = (uint16_t*) (picture->data[0] + y*picture->linesize[0]);
190         for (x = 0; x < picture->width; x++, index++) {
191             for (c = 0; c < image->numcomps; c++) {
192                 *img_ptr++ = image->comps[c].data[index] << adjust[c];
193             }
194         }
195     }
196 }
197
198 static void libopenjpeg_copyto8(AVFrame *picture, opj_image_t *image)
199 {
200     int *comp_data;
201     uint8_t *img_ptr;
202     int index, x, y;
203
204     for (index = 0; index < image->numcomps; index++) {
205         comp_data = image->comps[index].data;
206         for (y = 0; y < image->comps[index].h; y++) {
207             img_ptr = picture->data[index] + y * picture->linesize[index];
208             for (x = 0; x < image->comps[index].w; x++) {
209                 *img_ptr = (uint8_t) *comp_data;
210                 img_ptr++;
211                 comp_data++;
212             }
213         }
214     }
215 }
216
217 static void libopenjpeg_copyto16(AVFrame *p, opj_image_t *image)
218 {
219     int *comp_data;
220     uint16_t *img_ptr;
221     int index, x, y;
222
223     for (index = 0; index < image->numcomps; index++) {
224         comp_data = image->comps[index].data;
225         for (y = 0; y < image->comps[index].h; y++) {
226             img_ptr = (uint16_t*) (p->data[index] + y * p->linesize[index]);
227             for (x = 0; x < image->comps[index].w; x++) {
228                 *img_ptr = *comp_data;
229                 img_ptr++;
230                 comp_data++;
231             }
232         }
233     }
234 }
235
236 static av_cold int libopenjpeg_decode_init(AVCodecContext *avctx)
237 {
238     LibOpenJPEGContext *ctx = avctx->priv_data;
239
240     opj_set_default_decoder_parameters(&ctx->dec_params);
241     return 0;
242 }
243
244 static int libopenjpeg_decode_frame(AVCodecContext *avctx,
245                                     void *data, int *got_frame,
246                                     AVPacket *avpkt)
247 {
248     uint8_t *buf = avpkt->data;
249     int buf_size = avpkt->size;
250     LibOpenJPEGContext *ctx = avctx->priv_data;
251     ThreadFrame frame = { .f = data };
252     AVFrame *picture  = data;
253     const AVPixFmtDescriptor *desc;
254     opj_dinfo_t *dec;
255     opj_cio_t *stream;
256     opj_image_t *image;
257     int width, height, ret = -1;
258     int pixel_size = 0;
259     int ispacked = 0;
260     int i;
261
262     *got_frame = 0;
263
264     // Check if input is a raw jpeg2k codestream or in jp2 wrapping
265     if ((AV_RB32(buf)     == 12)           &&
266         (AV_RB32(buf + 4) == JP2_SIG_TYPE) &&
267         (AV_RB32(buf + 8) == JP2_SIG_VALUE)) {
268         dec = opj_create_decompress(CODEC_JP2);
269     } else {
270         /* If the AVPacket contains a jp2c box, then skip to
271          * the starting byte of the codestream. */
272         if (AV_RB32(buf + 4) == AV_RB32("jp2c"))
273             buf += 8;
274         dec = opj_create_decompress(CODEC_J2K);
275     }
276
277     if (!dec) {
278         av_log(avctx, AV_LOG_ERROR, "Error initializing decoder.\n");
279         return -1;
280     }
281     opj_set_event_mgr((opj_common_ptr)dec, NULL, NULL);
282
283     ctx->dec_params.cp_limit_decoding = LIMIT_TO_MAIN_HEADER;
284     ctx->dec_params.cp_reduce         = ctx->lowres;
285     ctx->dec_params.cp_layer          = ctx->lowqual;
286     // Tie decoder with decoding parameters
287     opj_setup_decoder(dec, &ctx->dec_params);
288     stream = opj_cio_open((opj_common_ptr)dec, buf, buf_size);
289
290     if (!stream) {
291         av_log(avctx, AV_LOG_ERROR,
292                "Codestream could not be opened for reading.\n");
293         opj_destroy_decompress(dec);
294         return -1;
295     }
296
297     // Decode the header only.
298     image = opj_decode_with_info(dec, stream, NULL);
299     opj_cio_close(stream);
300
301     if (!image) {
302         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
303         opj_destroy_decompress(dec);
304         return -1;
305     }
306
307     width  = image->x1 - image->x0;
308     height = image->y1 - image->y0;
309
310     if (ctx->lowres) {
311         width  = (width  + (1 << ctx->lowres) - 1) >> ctx->lowres;
312         height = (height + (1 << ctx->lowres) - 1) >> ctx->lowres;
313     }
314
315     if (av_image_check_size(width, height, 0, avctx) < 0) {
316         av_log(avctx, AV_LOG_ERROR,
317                "%dx%d dimension invalid.\n", width, height);
318         goto done;
319     }
320
321     avcodec_set_dimensions(avctx, width, height);
322
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         avctx->pix_fmt = libopenjpeg_guess_pix_fmt(image);
329
330     if (avctx->pix_fmt == AV_PIX_FMT_NONE) {
331         av_log(avctx, AV_LOG_ERROR, "Unable to determine pixel format\n");
332         ret = AVERROR_INVALIDDATA;
333         goto done;
334     }
335
336     for (i = 0; i < image->numcomps; i++)
337         if (image->comps[i].prec > avctx->bits_per_raw_sample)
338             avctx->bits_per_raw_sample = image->comps[i].prec;
339
340     if (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     if (!stream) {
350         av_log(avctx, AV_LOG_ERROR,
351                "Codestream could not be opened for reading.\n");
352         goto done;
353     }
354
355     opj_image_destroy(image);
356     // Decode the codestream
357     image = opj_decode_with_info(dec, stream, NULL);
358     opj_cio_close(stream);
359
360     if (!image) {
361         av_log(avctx, AV_LOG_ERROR, "Error decoding codestream.\n");
362         goto done;
363     }
364
365     desc = av_pix_fmt_desc_get(avctx->pix_fmt);
366     pixel_size = desc->comp[0].step_minus1 + 1;
367     ispacked = libopenjpeg_ispacked(avctx->pix_fmt);
368
369     switch (pixel_size) {
370     case 1:
371         if (ispacked) {
372             libopenjpeg_copy_to_packed8(picture, image);
373         } else {
374             libopenjpeg_copyto8(picture, image);
375         }
376         break;
377     case 2:
378         if (ispacked) {
379             libopenjpeg_copy_to_packed8(picture, image);
380         } else {
381             libopenjpeg_copyto16(picture, image);
382         }
383         break;
384     case 3:
385     case 4:
386         if (ispacked) {
387             libopenjpeg_copy_to_packed8(picture, image);
388         }
389         break;
390     case 6:
391     case 8:
392         if (ispacked) {
393             libopenjpeg_copy_to_packed16(picture, image);
394         }
395         break;
396     default:
397         av_log(avctx, AV_LOG_ERROR, "unsupported pixel size %d\n", pixel_size);
398         goto done;
399     }
400
401     *got_frame = 1;
402     ret        = buf_size;
403
404 done:
405     opj_image_destroy(image);
406     opj_destroy_decompress(dec);
407     return ret;
408 }
409
410 #define OFFSET(x) offsetof(LibOpenJPEGContext, x)
411 #define VD AV_OPT_FLAG_VIDEO_PARAM | AV_OPT_FLAG_DECODING_PARAM
412
413 static const AVOption options[] = {
414     { "lowqual", "Limit the number of layers used for decoding",    OFFSET(lowqual), AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
415     { "lowres",  "Lower the decoding resolution by a power of two", OFFSET(lowres),  AV_OPT_TYPE_INT, { .i64 = 0 }, 0, INT_MAX, VD },
416     { NULL },
417 };
418
419 static const AVClass class = {
420     .class_name = "libopenjpeg",
421     .item_name  = av_default_item_name,
422     .option     = options,
423     .version    = LIBAVUTIL_VERSION_INT,
424 };
425
426 AVCodec ff_libopenjpeg_decoder = {
427     .name             = "libopenjpeg",
428     .type             = AVMEDIA_TYPE_VIDEO,
429     .id               = AV_CODEC_ID_JPEG2000,
430     .priv_data_size   = sizeof(LibOpenJPEGContext),
431     .init             = libopenjpeg_decode_init,
432     .decode           = libopenjpeg_decode_frame,
433     .capabilities     = CODEC_CAP_DR1 | CODEC_CAP_FRAME_THREADS,
434     .long_name        = NULL_IF_CONFIG_SMALL("OpenJPEG JPEG 2000"),
435     .priv_class       = &class,
436 };