2 * OpenEXR (.exr) image decoder
3 * Copyright (c) 2009 Jimmy Christensen
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
25 * @author Jimmy Christensen
27 * For more information on the OpenEXR format, visit:
30 * exr_flt2uint() and exr_halflt2uint() is credited to Reimar Döffinger
34 #include "bytestream.h"
35 #include "libavutil/imgutils.h"
46 typedef struct EXRContext {
49 int bits_per_color_id;
50 int8_t channel_offsets[4]; // 0 = red, 1 = green, 2 = blue and 3 = alpha
54 * Converts from 32-bit float as uint32_t to uint16_t
56 * @param v 32-bit float
57 * @return normalized 16-bit unsigned int
59 static inline uint16_t exr_flt2uint(uint32_t v)
61 unsigned int exp = v >> 23;
62 // "HACK": negative values result in exp< 0, so clipping them to 0
63 // is also handled by this condition, avoids explicit check for sign bit.
64 if (exp<= 127 + 7 - 24) // we would shift out all bits anyway
69 return (v + (1 << 23)) >> (127 + 7 - exp);
73 * Converts from 16-bit float as uint16_t to uint16_t
75 * @param v 16-bit float
76 * @return normalized 16-bit unsigned int
78 static inline uint16_t exr_halflt2uint(uint16_t v)
80 unsigned exp = 14 - (v >> 10);
82 if (exp == 14) return (v >> 9) & 1;
83 else return (v & 0x8000) ? 0 : 0xffff;
86 return (v + (1 << 16)) >> (exp + 1);
90 * Gets the size of the header variable
92 * @param **buf the current pointer location in the header where
93 * the variable data starts
94 * @param *buf_end pointer location of the end of the buffer
95 * @return size of variable data
97 static unsigned int get_header_variable_length(const uint8_t **buf,
98 const uint8_t *buf_end)
100 unsigned int variable_buffer_data_size = bytestream_get_le32(buf);
101 if (variable_buffer_data_size >= buf_end - *buf)
103 return variable_buffer_data_size;
107 * Checks if the variable name corresponds with it's data type
109 * @param *avctx the AVCodecContext
110 * @param **buf the current pointer location in the header where
111 * the variable name starts
112 * @param *buf_end pointer location of the end of the buffer
113 * @param *value_name name of the varible to check
114 * @param *value_type type of the varible to check
115 * @param minimum_length minimum length of the variable data
116 * @param variable_buffer_data_size variable length read from the header
118 * @return negative if variable is invalid
120 static int check_header_variable(AVCodecContext *avctx,
122 const uint8_t *buf_end,
123 const char *value_name,
124 const char *value_type,
125 unsigned int minimum_length,
126 unsigned int *variable_buffer_data_size)
128 if (buf_end - *buf >= minimum_length && !strcmp(*buf, value_name)) {
129 *buf += strlen(value_name)+1;
130 if (!strcmp(*buf, value_type)) {
131 *buf += strlen(value_type)+1;
132 *variable_buffer_data_size = get_header_variable_length(buf, buf_end);
133 if (!*variable_buffer_data_size)
134 av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
135 if (*variable_buffer_data_size > buf_end - *buf)
139 *buf -= strlen(value_name)+1;
140 av_log(avctx, AV_LOG_WARNING, "Unknown data type for header variable %s\n", value_name);
145 static int decode_frame(AVCodecContext *avctx,
150 const uint8_t *buf = avpkt->data;
151 unsigned int buf_size = avpkt->size;
152 const uint8_t *buf_end = buf + buf_size;
154 EXRContext *const s = avctx->priv_data;
155 AVFrame *picture = data;
156 AVFrame *const p = &s->picture;
159 int i, x, y, stride, magic_number, version_flag;
162 unsigned int xmin = ~0;
163 unsigned int xmax = ~0;
164 unsigned int ymin = ~0;
165 unsigned int ymax = ~0;
166 unsigned int xdelta = ~0;
168 unsigned int current_channel_offset = 0;
170 s->channel_offsets[0] = -1;
171 s->channel_offsets[1] = -1;
172 s->channel_offsets[2] = -1;
173 s->channel_offsets[3] = -1;
174 s->bits_per_color_id = -1;
176 if (buf_end - buf < 10) {
177 av_log(avctx, AV_LOG_ERROR, "Too short header to parse\n");
181 magic_number = bytestream_get_le32(&buf);
182 if (magic_number != 20000630) { // As per documentation of OpenEXR it's supposed to be int 20000630 little-endian
183 av_log(avctx, AV_LOG_ERROR, "Wrong magic number %d\n", magic_number);
187 version_flag = bytestream_get_le32(&buf);
188 if ((version_flag & 0x200) == 0x200) {
189 av_log(avctx, AV_LOG_ERROR, "Tile based images are not supported\n");
194 while (buf < buf_end && buf[0]) {
195 unsigned int variable_buffer_data_size;
196 // Process the channel list
197 if (check_header_variable(avctx, &buf, buf_end, "channels", "chlist", 38, &variable_buffer_data_size) >= 0) {
198 const uint8_t *channel_list_end;
199 if (!variable_buffer_data_size)
202 channel_list_end = buf + variable_buffer_data_size;
203 while (channel_list_end - buf >= 19) {
204 int current_bits_per_color_id = -1;
205 int channel_index = -1;
207 if (!strcmp(buf, "R"))
209 if (!strcmp(buf, "G"))
211 if (!strcmp(buf, "B"))
213 if (!strcmp(buf, "A"))
216 while (bytestream_get_byte(&buf) && buf < channel_list_end)
219 if (channel_list_end - * &buf < 4) {
220 av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
224 current_bits_per_color_id = bytestream_get_le32(&buf);
225 if (current_bits_per_color_id > 2) {
226 av_log(avctx, AV_LOG_ERROR, "Unknown color format\n");
230 if (channel_index >= 0) {
231 if (s->bits_per_color_id != -1 && s->bits_per_color_id != current_bits_per_color_id) {
232 av_log(avctx, AV_LOG_ERROR, "RGB channels not of the same depth\n");
235 s->bits_per_color_id = current_bits_per_color_id;
236 s->channel_offsets[channel_index] = current_channel_offset;
239 current_channel_offset += 1 << current_bits_per_color_id;
243 /* Check if all channels are set with an offset or if the channels
244 * are causing an overflow */
246 if (FFMIN3(s->channel_offsets[0],
247 s->channel_offsets[1],
248 s->channel_offsets[2]) < 0) {
249 if (s->channel_offsets[0] < 0)
250 av_log(avctx, AV_LOG_ERROR, "Missing red channel\n");
251 if (s->channel_offsets[1] < 0)
252 av_log(avctx, AV_LOG_ERROR, "Missing green channel\n");
253 if (s->channel_offsets[2] < 0)
254 av_log(avctx, AV_LOG_ERROR, "Missing blue channel\n");
258 buf = channel_list_end;
262 // Process the dataWindow variable
263 if (check_header_variable(avctx, &buf, buf_end, "dataWindow", "box2i", 31, &variable_buffer_data_size) >= 0) {
264 if (!variable_buffer_data_size)
268 ymin = AV_RL32(buf + 4);
269 xmax = AV_RL32(buf + 8);
270 ymax = AV_RL32(buf + 12);
271 xdelta = (xmax-xmin) + 1;
273 buf += variable_buffer_data_size;
277 // Process the displayWindow variable
278 if (check_header_variable(avctx, &buf, buf_end, "displayWindow", "box2i", 34, &variable_buffer_data_size) >= 0) {
279 if (!variable_buffer_data_size)
282 w = AV_RL32(buf + 8) + 1;
283 h = AV_RL32(buf + 12) + 1;
285 buf += variable_buffer_data_size;
289 // Process the lineOrder variable
290 if (check_header_variable(avctx, &buf, buf_end, "lineOrder", "lineOrder", 25, &variable_buffer_data_size) >= 0) {
291 if (!variable_buffer_data_size)
295 av_log(avctx, AV_LOG_ERROR, "Doesn't support this line order : %d\n", *buf);
299 buf += variable_buffer_data_size;
303 // Process the compression variable
304 if (check_header_variable(avctx, &buf, buf_end, "compression", "compression", 29, &variable_buffer_data_size) >= 0) {
305 if (!variable_buffer_data_size)
318 av_log(avctx, AV_LOG_ERROR, "Compression type %d is not supported\n", s->compr);
322 buf += variable_buffer_data_size;
326 // Check if there is enough bytes for a header
327 if (buf_end - buf <= 9) {
328 av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
332 // Process unknown variables
333 for (i = 0; i < 2; i++) {
334 // Skip variable name/type
335 while (++buf < buf_end)
340 // Skip variable length
341 if (buf_end - buf >= 5) {
342 variable_buffer_data_size = get_header_variable_length(&buf, buf_end);
343 if (!variable_buffer_data_size) {
344 av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
347 buf += variable_buffer_data_size;
351 if (buf >= buf_end) {
352 av_log(avctx, AV_LOG_ERROR, "Incomplete frame\n");
357 switch (s->bits_per_color_id) {
360 if (s->channel_offsets[3] >= 0)
361 avctx->pix_fmt = PIX_FMT_RGBA64;
363 avctx->pix_fmt = PIX_FMT_RGB48;
367 av_log_missing_feature(avctx, "8-bit OpenEXR", 1);
370 av_log(avctx, AV_LOG_ERROR, "Unknown color format : %d\n", s->bits_per_color_id);
374 if (s->picture.data[0])
375 avctx->release_buffer(avctx, &s->picture);
376 if (av_image_check_size(w, h, 0, avctx))
379 // Verify the xmin, xmax, ymin, ymax and xdelta before setting the actual image size
380 if (xmin > xmax || ymin > ymax || xdelta != xmax - xmin + 1 || xmax >= w || ymax >= h) {
381 av_log(avctx, AV_LOG_ERROR, "Wrong sizing or missing size information\n");
385 if (w != avctx->width || h != avctx->height) {
386 avcodec_set_dimensions(avctx, w, h);
389 if (avctx->get_buffer(avctx, p) < 0) {
390 av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
395 stride = p->linesize[0];
397 // Zero out the start if ymin is not 0
398 for (y = 0; y < ymin; y++) {
399 memset(ptr, 0, avctx->width * 2 * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components);
403 // Process the actual lines
404 for (y = ymin; y <= ymax; y++) {
405 uint16_t *ptr_x = (uint16_t *)ptr;
406 if (buf_end - buf > 8) {
407 /* Read the lineoffset from the line offset table and add 8 bytes
408 to skip the coordinates and data size fields */
409 const uint64_t line_offset = bytestream_get_le64(&buf) + 8;
410 // Check if the buffer has the required bytes needed from the offset
411 if (line_offset > avpkt->size - xdelta * current_channel_offset) {
412 // Line offset is probably wrong and not inside the buffer
413 av_log(avctx, AV_LOG_WARNING, "Line offset for line %d is out of reach setting it to black\n", y);
414 memset(ptr_x, 0, avctx->width * 2 * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components);
416 const uint8_t *red_channel_buffer = avpkt->data + line_offset + xdelta * s->channel_offsets[0];
417 const uint8_t *green_channel_buffer = avpkt->data + line_offset + xdelta * s->channel_offsets[1];
418 const uint8_t *blue_channel_buffer = avpkt->data + line_offset + xdelta * s->channel_offsets[2];
419 const uint8_t *alpha_channel_buffer = 0;
421 if (s->channel_offsets[3] >= 0)
422 alpha_channel_buffer = avpkt->data + line_offset + xdelta * s->channel_offsets[3];
424 // Zero out the start if xmin is not 0
425 memset(ptr_x, 0, xmin * 2 * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components);
426 ptr_x += xmin * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components;
427 if (s->bits_per_color_id == 2) {
429 for (x = 0; x < xdelta; x++) {
430 *ptr_x++ = exr_flt2uint(bytestream_get_le32(&red_channel_buffer));
431 *ptr_x++ = exr_flt2uint(bytestream_get_le32(&green_channel_buffer));
432 *ptr_x++ = exr_flt2uint(bytestream_get_le32(&blue_channel_buffer));
433 if (alpha_channel_buffer)
434 *ptr_x++ = exr_flt2uint(bytestream_get_le32(&alpha_channel_buffer));
438 for (x = 0; x < xdelta; x++) {
439 *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&red_channel_buffer));
440 *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&green_channel_buffer));
441 *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&blue_channel_buffer));
442 if (alpha_channel_buffer)
443 *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&alpha_channel_buffer));
447 // Zero out the end if xmax+1 is not w
448 memset(ptr_x, 0, (avctx->width - (xmax + 1)) * 2 * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components);
449 ptr_x += (avctx->width - (xmax + 1)) * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components;
457 // Zero out the end if ymax+1 is not h
458 for (y = ymax + 1; y < avctx->height; y++) {
459 memset(ptr, 0, avctx->width * 2 * av_pix_fmt_descriptors[avctx->pix_fmt].nb_components);
463 *picture = s->picture;
464 *data_size = sizeof(AVPicture);
469 static av_cold int decode_init(AVCodecContext *avctx)
471 EXRContext *s = avctx->priv_data;
472 avcodec_get_frame_defaults(&s->picture);
473 avctx->coded_frame = &s->picture;
477 static av_cold int decode_end(AVCodecContext *avctx)
479 EXRContext *s = avctx->priv_data;
480 if (s->picture.data[0])
481 avctx->release_buffer(avctx, &s->picture);
486 AVCodec ff_exr_decoder = {
488 .type = AVMEDIA_TYPE_VIDEO,
490 .priv_data_size = sizeof(EXRContext),
493 .decode = decode_frame,
494 .long_name = NULL_IF_CONFIG_SMALL("OpenEXR image"),