IMB_imbuf_types.h

Go to the documentation of this file.

/*
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
 * All rights reserved.
 */
 
#pragma once
 
#include "DNA_vec_types.h" /* for rcti */
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define IMB_MIPMAP_LEVELS 20
#define IMB_FILENAME_SIZE 1024
 
typedef struct DDSData {
  unsigned int fourcc;
  unsigned int nummipmaps;
  unsigned char *data;
  unsigned int size;
} DDSData;
 
/* Warning: Keep explicit value assignments here,
 * this file is included in areas where not all format defines are set
 * (e.g. intern/dds only get WITH_DDS, even if TIFF, HDR etc are also defined).
 * See T46524. */
 
enum eImbFileType {
  IMB_FTYPE_PNG = 1,
  IMB_FTYPE_TGA = 2,
  IMB_FTYPE_JPG = 3,
  IMB_FTYPE_BMP = 4,
  IMB_FTYPE_OPENEXR = 5,
  IMB_FTYPE_IMAGIC = 6,
#ifdef WITH_OPENIMAGEIO
  IMB_FTYPE_PSD = 7,
#endif
#ifdef WITH_OPENJPEG
  IMB_FTYPE_JP2 = 8,
#endif
#ifdef WITH_HDR
  IMB_FTYPE_RADHDR = 9,
#endif
#ifdef WITH_TIFF
  IMB_FTYPE_TIF = 10,
#endif
#ifdef WITH_CINEON
  IMB_FTYPE_CINEON = 11,
  IMB_FTYPE_DPX = 12,
#endif
 
#ifdef WITH_DDS
  IMB_FTYPE_DDS = 13,
#endif
};
 
/* Only for readability. */
#define IMB_FTYPE_NONE 0
 
/* ibuf->foptions flag, type specific options.
 * Some formats include compression rations on some bits */
 
#define OPENEXR_HALF (1 << 8)
/* careful changing this, it's used in DNA as well */
#define OPENEXR_COMPRESS (15)
 
#ifdef WITH_CINEON
#  define CINEON_LOG (1 << 8)
#  define CINEON_16BIT (1 << 7)
#  define CINEON_12BIT (1 << 6)
#  define CINEON_10BIT (1 << 5)
#endif
 
#ifdef WITH_OPENJPEG
#  define JP2_12BIT (1 << 9)
#  define JP2_16BIT (1 << 8)
#  define JP2_YCC (1 << 7)
#  define JP2_CINE (1 << 6)
#  define JP2_CINE_48FPS (1 << 5)
#  define JP2_JP2 (1 << 4)
#  define JP2_J2K (1 << 3)
#endif
 
#define PNG_16BIT (1 << 10)
 
#define RAWTGA 1
 
#ifdef WITH_TIFF
#  define TIF_16BIT (1 << 8)
#  define TIF_COMPRESS_NONE (1 << 7)
#  define TIF_COMPRESS_DEFLATE (1 << 6)
#  define TIF_COMPRESS_LZW (1 << 5)
#  define TIF_COMPRESS_PACKBITS (1 << 4)
#endif
 
typedef struct ImbFormatOptions {
  short flag;
  char quality;
} ImbFormatOptions;
 
typedef enum eImBufFlags {
  IB_rect = 1 << 0,
  IB_test = 1 << 1,
  IB_zbuf = 1 << 3,
  IB_mem = 1 << 4,
  IB_rectfloat = 1 << 5,
  IB_zbuffloat = 1 << 6,
  IB_multilayer = 1 << 7,
  IB_metadata = 1 << 8,
  IB_animdeinterlace = 1 << 9,
  IB_tiles = 1 << 10,
  IB_tilecache = 1 << 11,
  IB_alphamode_premul = 1 << 12,
  IB_alphamode_detect = 1 << 13,
  /* alpha channel is unrelated to RGB and should not affect it */
  IB_alphamode_channel_packed = 1 << 14,
  IB_alphamode_ignore = 1 << 15,
  IB_thumbnail = 1 << 16,
  IB_multiview = 1 << 17,
  IB_halffloat = 1 << 18,
} eImBufFlags;
 
typedef struct ImBuf {
  struct ImBuf *next, *prev; 
  /* dimensions */
  int x, y;
 
  unsigned char planes;
  int channels;
 
  /* flags */
  int flags;
  int mall;
 
  /* pixels */
 
  unsigned int *rect;
  float *rect_float;
 
  double ppm[2];
 
  /* tiled pixel storage */
  int tilex, tiley;
  int xtiles, ytiles;
  unsigned int **tiles;
 
  /* zbuffer */
  int *zbuf;
  float *zbuf_float;
 
  /* parameters used by conversion between byte and float */
  float dither;
 
  /* mipmapping */
  struct ImBuf *mipmap[IMB_MIPMAP_LEVELS];
  int miptot, miplevel;
 
  /* externally used data */
  int index;
  int userflags;
  struct IDProperty *metadata;
  void *userdata;
 
  /* file information */
  enum eImbFileType ftype;
  ImbFormatOptions foptions;
  char name[IMB_FILENAME_SIZE];
  char cachename[IMB_FILENAME_SIZE];
 
  /* memory cache limiter */
  struct MEM_CacheLimiterHandle_s *c_handle;
  int refcounter;
 
  /* some parameters to pass along for packing images */
  unsigned char *encodedbuffer;
  unsigned int encodedsize;
  unsigned int encodedbuffersize;
 
  /* color management */
  struct ColorSpace *rect_colorspace;
  struct ColorSpace *float_colorspace;
  unsigned int *display_buffer_flags;
  struct ColormanageCache *colormanage_cache;
  int colormanage_flag;
  rcti invalid_rect;
 
  /* information for compressed textures */
  struct DDSData dds_data;
} ImBuf;
 
enum {
  IB_BITMAPDIRTY = (1 << 1),
  IB_MIPMAP_INVALID = (1 << 2),
  IB_RECT_INVALID = (1 << 3),
  IB_DISPLAY_BUFFER_INVALID = (1 << 4),
  IB_PERSISTENT = (1 << 5),
};
 
#define IB_PROFILE_NONE 0
#define IB_PROFILE_LINEAR_RGB 1
#define IB_PROFILE_SRGB 2
#define IB_PROFILE_CUSTOM 3
 
/* dds */
#ifdef WITH_DDS
#  ifndef DDS_MAKEFOURCC
#    define DDS_MAKEFOURCC(ch0, ch1, ch2, ch3) \
      ((unsigned long)(unsigned char)(ch0) | ((unsigned long)(unsigned char)(ch1) << 8) | \
       ((unsigned long)(unsigned char)(ch2) << 16) | ((unsigned long)(unsigned char)(ch3) << 24))
#  endif /* DDS_MAKEFOURCC */
 
/*
 * FOURCC codes for DX compressed-texture pixel formats
 */
 
#  define FOURCC_DDS (DDS_MAKEFOURCC('D', 'D', 'S', ' '))
#  define FOURCC_DXT1 (DDS_MAKEFOURCC('D', 'X', 'T', '1'))
#  define FOURCC_DXT2 (DDS_MAKEFOURCC('D', 'X', 'T', '2'))
#  define FOURCC_DXT3 (DDS_MAKEFOURCC('D', 'X', 'T', '3'))
#  define FOURCC_DXT4 (DDS_MAKEFOURCC('D', 'X', 'T', '4'))
#  define FOURCC_DXT5 (DDS_MAKEFOURCC('D', 'X', 'T', '5'))
 
#endif /* DDS */
extern const char *imb_ext_image[];
extern const char *imb_ext_movie[];
extern const char *imb_ext_audio[];
 
/* image formats that can only be loaded via filepath */
extern const char *imb_ext_image_filepath_only[];
 
enum {
  IMB_COLORMANAGE_IS_DATA = (1 << 0),
};
 
#ifdef __cplusplus
}
#endif