git.sesse.net Git - ffmpeg/blob - libavcodec/exr.c

   1 /*
   2  * OpenEXR (.exr) image decoder
   3  * Copyright (c) 2009 Jimmy Christensen
   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  * OpenEXR decoder
  25  * @author Jimmy Christensen
  26  *
  27  * For more information on the OpenEXR format, visit:
  28  *  http://openexr.com/
  29  *
  30  * exr_flt2uint() and exr_halflt2uint() is credited to  Reimar Döffinger
  31  */
  32
  33 #include "avcodec.h"
  34 #include "bytestream.h"
  35 #include "libavutil/imgutils.h"
  36
  37 enum ExrCompr {
  38     EXR_RAW   = 0,
  39     EXR_RLE   = 1,
  40     EXR_ZIP1  = 2,
  41     EXR_ZIP16 = 3,
  42     EXR_PIZ   = 4,
  43     EXR_B44   = 6
  44 };
  45
  46 typedef struct EXRContext {
  47     AVFrame picture;
  48     int compr;
  49     int bits_per_color_id;
  50     int8_t channel_offsets[3]; // 0 = red, 1 = green and 2 = blue
  51 } EXRContext;
  52
  53 /**
  54  * Converts from 32-bit float as uint32_t to uint16_t
  55  *
  56  * @param v 32-bit float
  57  * @return normalized 16-bit unsigned int
  58  */
  59 static inline uint16_t exr_flt2uint(uint32_t v)
  60 {
  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
  65         return 0;
  66     if (exp >= 127)
  67         return 0xffff;
  68     v &= 0x007fffff;
  69     return (v + (1 << 23)) >> (127 + 7 - exp);
  70 }
  71
  72 /**
  73  * Converts from 16-bit float as uint16_t to uint16_t
  74  *
  75  * @param v 16-bit float
  76  * @return normalized 16-bit unsigned int
  77  */
  78 static inline uint16_t exr_halflt2uint(uint16_t v)
  79 {
  80     unsigned exp = 14 - (v >> 10);
  81     if (exp >= 14) {
  82         if (exp == 14) return (v >> 9) & 1;
  83         else           return (v & 0x8000) ? 0 : 0xffff;
  84     }
  85     v <<= 6;
  86     return (v + (1 << 16)) >> (exp + 1);
  87 }
  88
  89 /**
  90  * Gets the size of the header variable
  91  *
  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
  96  */
  97 static unsigned int get_header_variable_length(const uint8_t **buf,
  98                                                const uint8_t *buf_end)
  99 {
 100     unsigned int variable_buffer_data_size = bytestream_get_le32(buf);
 101     if (variable_buffer_data_size >= buf_end - *buf)
 102         return 0;
 103     return variable_buffer_data_size;
 104 }
 105
 106 /**
 107  * Checks if the variable name corresponds with it's data type
 108  *
 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
 117  * after it's checked
 118  * @return negative if variable is invalid
 119  */
 120 static int check_header_variable(AVCodecContext *avctx,
 121                                               const uint8_t **buf,
 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)
 127 {
 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)
 136                 return -1;
 137             return 1;
 138         }
 139         *buf -= strlen(value_name)+1;
 140         av_log(avctx, AV_LOG_WARNING, "Unknown data type for header variable %s\n", value_name);
 141     }
 142     return -1;
 143 }
 144
 145 static int decode_frame(AVCodecContext *avctx,
 146                         void *data,
 147                         int *data_size,
 148                         AVPacket *avpkt)
 149 {
 150     const uint8_t *buf      = avpkt->data;
 151     unsigned int   buf_size = avpkt->size;
 152     const uint8_t *buf_end  = buf + buf_size;
 153
 154     EXRContext *const s = avctx->priv_data;
 155     AVFrame *picture  = data;
 156     AVFrame *const p = &s->picture;
 157     uint8_t *ptr;
 158
 159     int i, x, y, stride, magic_number, version_flag;
 160     int w = 0;
 161     int h = 0;
 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;
 167
 168     unsigned int current_channel_offset = 0;
 169
 170     s->channel_offsets[0] = -1;
 171     s->channel_offsets[1] = -1;
 172     s->channel_offsets[2] = -1;
 173     s->bits_per_color_id = -1;
 174
 175     if (buf_end - buf < 10) {
 176         av_log(avctx, AV_LOG_ERROR, "Too short header to parse\n");
 177         return -1;
 178     }
 179
 180     magic_number = bytestream_get_le32(&buf);
 181     if (magic_number != 20000630) { // As per documentation of OpenEXR it's supposed to be int 20000630 little-endian
 182         av_log(avctx, AV_LOG_ERROR, "Wrong magic number %d\n", magic_number);
 183         return -1;
 184     }
 185
 186     version_flag = bytestream_get_le32(&buf);
 187     if ((version_flag & 0x200) == 0x200) {
 188         av_log(avctx, AV_LOG_ERROR, "Tile based images are not supported\n");
 189         return -1;
 190     }
 191
 192     // Parse the header
 193     while (buf < buf_end && buf[0]) {
 194         unsigned int variable_buffer_data_size;
 195         // Process the channel list
 196         if (check_header_variable(avctx, &buf, buf_end, "channels", "chlist", 38, &variable_buffer_data_size) >= 0) {
 197             const uint8_t *channel_list_end;
 198             if (!variable_buffer_data_size)
 199                 return -1;
 200
 201             channel_list_end = buf + variable_buffer_data_size;
 202             while (channel_list_end - buf >= 19) {
 203                 int current_bits_per_color_id = -1;
 204                 int channel_index = -1;
 205
 206                 if (!strcmp(buf, "R"))
 207                     channel_index = 0;
 208                 if (!strcmp(buf, "G"))
 209                     channel_index = 1;
 210                 if (!strcmp(buf, "B"))
 211                     channel_index = 2;
 212
 213                 while (bytestream_get_byte(&buf) && buf < channel_list_end)
 214                     continue; /* skip */
 215
 216                 if (channel_list_end - * &buf < 4) {
 217                     av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
 218                     return -1;
 219                 }
 220
 221                 current_bits_per_color_id = bytestream_get_le32(&buf);
 222                 if (current_bits_per_color_id > 2) {
 223                     av_log(avctx, AV_LOG_ERROR, "Unknown color format\n");
 224                     return -1;
 225                 }
 226
 227                 if (channel_index >= 0) {
 228                     if (s->bits_per_color_id != -1 && s->bits_per_color_id != current_bits_per_color_id) {
 229                         av_log(avctx, AV_LOG_ERROR, "RGB channels not of the same depth\n");
 230                         return -1;
 231                     }
 232                     s->bits_per_color_id  = current_bits_per_color_id;
 233                     s->channel_offsets[channel_index] = current_channel_offset;
 234                 }
 235
 236                 current_channel_offset += 1 << current_bits_per_color_id;
 237                 buf += 12;
 238             }
 239
 240             /* Check if all channels are set with an offset or if the channels
 241              * are causing an overflow  */
 242
 243             if (FFMIN3(s->channel_offsets[0],
 244                        s->channel_offsets[1],
 245                        s->channel_offsets[2]) < 0) {
 246                 if (s->channel_offsets[0] < 0)
 247                     av_log(avctx, AV_LOG_ERROR, "Missing red channel\n");
 248                 if (s->channel_offsets[1] < 0)
 249                     av_log(avctx, AV_LOG_ERROR, "Missing green channel\n");
 250                 if (s->channel_offsets[2] < 0)
 251                     av_log(avctx, AV_LOG_ERROR, "Missing blue channel\n");
 252                 return -1;
 253             }
 254
 255             buf = channel_list_end;
 256             continue;
 257         }
 258
 259         // Process the dataWindow variable
 260         if (check_header_variable(avctx, &buf, buf_end, "dataWindow", "box2i", 31, &variable_buffer_data_size) >= 0) {
 261             if (!variable_buffer_data_size)
 262                 return -1;
 263
 264             xmin = AV_RL32(buf);
 265             ymin = AV_RL32(buf + 4);
 266             xmax = AV_RL32(buf + 8);
 267             ymax = AV_RL32(buf + 12);
 268             xdelta = (xmax-xmin) + 1;
 269
 270             buf += variable_buffer_data_size;
 271             continue;
 272         }
 273
 274         // Process the displayWindow variable
 275         if (check_header_variable(avctx, &buf, buf_end, "displayWindow", "box2i", 34, &variable_buffer_data_size) >= 0) {
 276             if (!variable_buffer_data_size)
 277                 return -1;
 278
 279             w = AV_RL32(buf + 8) + 1;
 280             h = AV_RL32(buf + 12) + 1;
 281
 282             buf += variable_buffer_data_size;
 283             continue;
 284         }
 285
 286         // Process the lineOrder variable
 287         if (check_header_variable(avctx, &buf, buf_end, "lineOrder", "lineOrder", 25, &variable_buffer_data_size) >= 0) {
 288             if (!variable_buffer_data_size)
 289                 return -1;
 290
 291             if (*buf) {
 292                 av_log(avctx, AV_LOG_ERROR, "Doesn't support this line order : %d\n", *buf);
 293                 return -1;
 294             }
 295
 296             buf += variable_buffer_data_size;
 297             continue;
 298         }
 299
 300         // Process the compression variable
 301         if (check_header_variable(avctx, &buf, buf_end, "compression", "compression", 29, &variable_buffer_data_size) >= 0) {
 302             if (!variable_buffer_data_size)
 303                 return -1;
 304
 305             switch (*buf) {
 306             case EXR_RAW:
 307                 s->compr = *buf;
 308                 break;
 309             case EXR_RLE:
 310             case EXR_ZIP1:
 311             case EXR_ZIP16:
 312             case EXR_PIZ:
 313             case EXR_B44:
 314             default:
 315                 av_log(avctx, AV_LOG_ERROR, "This type of compression is not supported\n");
 316                 return -1;
 317             }
 318
 319             buf += variable_buffer_data_size;
 320             continue;
 321         }
 322
 323         // Check if there is enough bytes for a header
 324         if (buf_end - buf <= 9) {
 325             av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
 326             return -1;
 327         }
 328
 329         // Process unknown variables
 330         for (i = 0; i < 2; i++) {
 331             // Skip variable name/type
 332             while (++buf < buf_end)
 333                 if (buf[0] == 0x0)
 334                     break;
 335         }
 336         buf++;
 337         // Skip variable length
 338         if (buf_end - buf >= 5) {
 339             variable_buffer_data_size = get_header_variable_length(&buf, buf_end);
 340             if (!variable_buffer_data_size) {
 341                 av_log(avctx, AV_LOG_ERROR, "Incomplete header\n");
 342                 return -1;
 343             }
 344             buf += variable_buffer_data_size;
 345         }
 346     }
 347
 348     if (buf >= buf_end) {
 349         av_log(avctx, AV_LOG_ERROR, "Incomplete frame\n");
 350         return -1;
 351     }
 352     buf++;
 353
 354     switch (s->bits_per_color_id) {
 355     case 2: // 32-bit
 356     case 1: // 16-bit
 357         avctx->pix_fmt = PIX_FMT_RGB48;
 358         break;
 359     // 8-bit
 360     case 0:
 361         av_log_missing_feature(avctx, "8-bit OpenEXR", 1);
 362         return -1;
 363     default:
 364         av_log(avctx, AV_LOG_ERROR, "Unknown color format : %d\n", s->bits_per_color_id);
 365         return -1;
 366     }
 367
 368     if (s->picture.data[0])
 369         avctx->release_buffer(avctx, &s->picture);
 370     if (av_image_check_size(w, h, 0, avctx))
 371         return -1;
 372
 373     // Verify the xmin, xmax, ymin, ymax and xdelta before setting the actual image size
 374     if (xmin > xmax || ymin > ymax || xdelta != xmax - xmin + 1 || xmax >= w || ymax >= h) {
 375         av_log(avctx, AV_LOG_ERROR, "Wrong sizing or missing size information\n");
 376         return -1;
 377     }
 378
 379     if (w != avctx->width || h != avctx->height) {
 380         avcodec_set_dimensions(avctx, w, h);
 381     }
 382
 383     if (avctx->get_buffer(avctx, p) < 0) {
 384         av_log(avctx, AV_LOG_ERROR, "get_buffer() failed\n");
 385         return -1;
 386     }
 387
 388     ptr    = p->data[0];
 389     stride = p->linesize[0];
 390
 391     // Zero out the start if ymin is not 0
 392     for (y = 0; y < ymin; y++) {
 393         memset(ptr, 0, avctx->width * 6);
 394         ptr += stride;
 395     }
 396
 397     // Process the actual lines
 398     for (y = ymin; y <= ymax; y++) {
 399         uint16_t *ptr_x = (uint16_t *)ptr;
 400         if (buf_end - buf > 8) {
 401             /* Read the lineoffset from the line offset table and add 8 bytes
 402                to skip the coordinates and data size fields */
 403             const uint64_t line_offset = bytestream_get_le64(&buf) + 8;
 404             // Check if the buffer has the required bytes needed from the offset
 405             if (line_offset > avpkt->size - xdelta * current_channel_offset) {
 406                 // Line offset is probably wrong and not inside the buffer
 407                 av_log(avctx, AV_LOG_WARNING, "Line offset for line %d is out of reach setting it to black\n", y);
 408                 memset(ptr_x, 0, avctx->width * 6);
 409             } else {
 410                 const uint8_t *red_channel_buffer   = avpkt->data + line_offset + xdelta * s->channel_offsets[0];
 411                 const uint8_t *green_channel_buffer = avpkt->data + line_offset + xdelta * s->channel_offsets[1];
 412                 const uint8_t *blue_channel_buffer  = avpkt->data + line_offset + xdelta * s->channel_offsets[2];
 413
 414                 // Zero out the start if xmin is not 0
 415                 memset(ptr_x, 0, xmin * 6);
 416                 ptr_x += xmin * 3;
 417                 if (s->bits_per_color_id == 2) {
 418                     // 32-bit
 419                     for (x = 0; x < xdelta; x++) {
 420                         *ptr_x++ = exr_flt2uint(bytestream_get_le32(&red_channel_buffer));
 421                         *ptr_x++ = exr_flt2uint(bytestream_get_le32(&green_channel_buffer));
 422                         *ptr_x++ = exr_flt2uint(bytestream_get_le32(&blue_channel_buffer));
 423                     }
 424                 } else {
 425                     // 16-bit
 426                     for (x = 0; x < xdelta; x++) {
 427                         *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&red_channel_buffer));
 428                         *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&green_channel_buffer));
 429                         *ptr_x++ = exr_halflt2uint(bytestream_get_le16(&blue_channel_buffer));
 430                     }
 431                 }
 432
 433                 // Zero out the end if xmax+1 is not w
 434                 memset(ptr_x, 0, (avctx->width - (xmax + 1)) * 6);
 435                 ptr_x += (avctx->width - (xmax + 1)) * 3;
 436
 437             }
 438             // Move to next line
 439             ptr += stride;
 440         }
 441     }
 442
 443     // Zero out the end if ymax+1 is not h
 444     for (y = ymax + 1; y < avctx->height; y++) {
 445         memset(ptr, 0, avctx->width * 6);
 446         ptr += stride;
 447     }
 448
 449     *picture   = s->picture;
 450     *data_size = sizeof(AVPicture);
 451
 452     return buf_size;
 453 }
 454
 455 static av_cold int decode_init(AVCodecContext *avctx)
 456 {
 457     EXRContext *s = avctx->priv_data;
 458     avcodec_get_frame_defaults(&s->picture);
 459     avctx->coded_frame = &s->picture;
 460     return 0;
 461 }
 462
 463 static av_cold int decode_end(AVCodecContext *avctx)
 464 {
 465     EXRContext *s = avctx->priv_data;
 466     if (s->picture.data[0])
 467         avctx->release_buffer(avctx, &s->picture);
 468
 469     return 0;
 470 }
 471
 472 AVCodec ff_exr_decoder = {
 473     .name               = "exr",
 474     .type               = AVMEDIA_TYPE_VIDEO,
 475     .id                 = CODEC_ID_EXR,
 476     .priv_data_size     = sizeof(EXRContext),
 477     .init               = decode_init,
 478     .close              = decode_end,
 479     .decode             = decode_frame,
 480     .long_name          = NULL_IF_CONFIG_SMALL("OpenEXR image"),
 481 };