Page MenuHome
Differential D1135 Diff 3599 source/blender/makesdna/DNA_imbuf_types.h

Changeset View

Standalone View

View Options

source/blender/makesdna/DNA_imbuf_types.h

  • This file was added.
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* 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.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
#ifndef __DNA_IMBUF_TYPES_H__
#define __DNA_IMBUF_TYPES_H__
#include "DNA_vec_types.h" /* for rcti */
/**
* \file DNA_imbuf_types.h
* \ingroup DNA
* \brief Contains defines and structs used throughout the imbuf module.
* \todo Clean up includes.
*
* Types needed for using the image buffer.
*
* Imbuf is external code, slightly adapted to live in the Blender
* context. It requires an external jpeg module, and the avi-module
* (also external code) in order to function correctly.
*
* This file contains types and some constants that go with them. Most
* are self-explanatory (e.g. IS_amiga tests whether the buffer
* contains an Amiga-format file).
*/
#define IB_MIPMAP_LEVELS 20
#define IB_FILENAME_SIZE 1024
typedef struct DDSData {
unsigned int fourcc; /* DDS fourcc info */
unsigned int nummipmaps; /* The number of mipmaps in the dds file */
unsigned char *data; /* The compressed image data */
unsigned int pad;
unsigned int size; /* The size of the compressed data */
} DDSData;
/**
* \ingroup imbuf
* This is the abstraction of an image. ImBuf is the basic type used for all
* imbuf operations.
*
* Also; add new variables to the end to save pain!
*
*/
typedef struct ImBuf {
struct ImBuf *next, *prev; /**< allow lists of ImBufs, for caches or flipbooks */
/* dimensions */
int x, y; /* width and Height of our image buffer.
* Should be 'unsigned int' since most formats use this.
* but this is problematic with texture math in imagetexture.c
* avoid problems and use int. - campbell */
unsigned char planes; /* Active amount of bits/bitplanes */
unsigned char pad[3];
int channels; /* amount of channels in rect_float (0 = 4 channel default) */
/* flags */
int flags; /* Controls which components should exist. */
int mall; /* what is malloced internal, and can be freed */
/* pixels */
unsigned int *rect; /* pixel values stored here */
float *rect_float; /* floating point Rect equivalent
* Linear RGB color space - may need gamma correction to
* sRGB when generating 8bit representations */
/* resolution - pixels per meter */
double ppm[2];
/* tiled pixel storage */
int tilex, tiley;
int xtiles, ytiles;
unsigned int **tiles;
/* zbuffer */
int *zbuf; /* z buffer data, original zbuffer */
float *zbuf_float; /* z buffer data, camera coordinates */
/* parameters used by conversion between byte and float */
float dither; /* random dither value, for conversion from float -> byte rect */
int pad1;
/* mipmapping */
struct ImBuf *mipmap[20]; /* IB_MIPMAP_LEVELS, MipMap levels, a series of halved images */
int miptot, miplevel;
/* externally used data */
int index; /* reference index for ImBuf lists */
int userflags; /* used to set imbuf to dirty and other stuff */
struct IDProperty *metadata; /* image metadata */
void *userdata; /* temporary storage, only used by baking at the moment */
/* file information */
int ftype; /* file type we are going to save as */
char name[1024]; /* IB_FILENAME_SIZE, filename associated with this image */
char cachename[1024]; /* IB_FILENAME_SIZE, full filename used for reading from cache */
int pad2;
/* memory cache limiter */
struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
int refcounter; /* reference counter for multiple users */
/* some parameters to pass along for packing images */
unsigned int encodedsize; /* Size of data written to encodedbuffer */
unsigned int encodedbuffersize; /* Size of encodedbuffer */
int pad3;
unsigned char *encodedbuffer; /* Compressed image only used with png currently */
int pad4;
float pad5;
/* color management */
struct ColorSpace *rect_colorspace; /* color space of byte buffer */
struct ColorSpace *float_colorspace; /* color space of float buffer, used by sequencer only */
unsigned int *display_buffer_flags; /* array of per-display display buffers dirty flags */
struct ColormanageCache *colormanage_cache; /* cache used by color management */
int colormanage_flag;
int pad6;
rcti invalid_rect;
/* information for compressed textures */
struct DDSData dds_data;
} ImBuf;
/* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
/**
* \brief userflags: Flags used internally by blender for imagebuffers
*/
#define IB_BITMAPFONT (1 << 0) /* this image is a font */
#define IB_BITMAPDIRTY (1 << 1) /* image needs to be saved is not the same as filename */
#define IB_MIPMAP_INVALID (1 << 2) /* image mipmaps are invalid, need recreate */
#define IB_RECT_INVALID (1 << 3) /* float buffer changed, needs recreation of byte rect */
#define IB_DISPLAY_BUFFER_INVALID (1 << 4) /* either float or byte buffer changed, need to re-calculate display buffers */
#define IB_PERSISTENT (1 << 5) /* image buffer is persistent in the memory and should never be removed from the cache */
/**
* \name Imbuf Component flags
* \brief These flags determine the components of an ImBuf struct.
*/
/**@{*/
/** \brief Flag defining the components of the ImBuf struct. */
#define IB_rect (1 << 0)
#define IB_test (1 << 1)
#define IB_fields (1 << 2)
#define IB_zbuf (1 << 3)
#define IB_mem (1 << 4)
#define IB_rectfloat (1 << 5)
#define IB_zbuffloat (1 << 6)
#define IB_multilayer (1 << 7)
#define IB_metadata (1 << 8)
#define IB_animdeinterlace (1 << 9)
#define IB_tiles (1 << 10)
#define IB_tilecache (1 << 11)
#define IB_alphamode_premul (1 << 12) /* indicates whether image on disk have premul alpha */
#define IB_alphamode_detect (1 << 13) /* if this flag is set, alpha mode would be guessed from file */
#define IB_ignore_alpha (1 << 14) /* ignore alpha on load and substitude it with 1.0f */
/*
* The bit flag is stored in the ImBuf.ftype variable.
* Note that the lower 11 bits is used for storing custom flags
*/
#define IB_CUSTOM_FLAGS_MASK 0x7ff
#ifdef WITH_OPENIMAGEIO
#define PSD (1 << 31)
#endif
#define PNG (1 << 30)
#define TGA (1 << 28)
#define JPG (1 << 27)
#define BMP (1 << 26)
#ifdef WITH_QUICKTIME
#define QUICKTIME (1 << 25)
#endif
#ifdef WITH_HDR
#define RADHDR (1 << 24)
#endif
#ifdef WITH_TIFF
#define TIF (1 << 23)
#define TIF_16BIT (1 << 8 )
#endif
#define OPENEXR (1 << 22)
#define OPENEXR_HALF (1 << 8 )
#define OPENEXR_COMPRESS (7)
#ifdef WITH_CINEON
#define CINEON (1 << 21)
#define DPX (1 << 20)
#define CINEON_LOG (1 << 8)
#define CINEON_16BIT (1 << 7)
#define CINEON_12BIT (1 << 6)
#define CINEON_10BIT (1 << 5)
#endif
#ifdef WITH_DDS
#define DDS (1 << 19)
#endif
#ifdef WITH_OPENJPEG
#define JP2 (1 << 18)
#define JP2_12BIT (1 << 17)
#define JP2_16BIT (1 << 16)
#define JP2_YCC (1 << 15)
#define JP2_CINE (1 << 14)
#define JP2_CINE_48FPS (1 << 13)
#define JP2_JP2 (1 << 12)
#define JP2_J2K (1 << 11)
#endif
#define PNG_16BIT (1 << 10)
#define RAWTGA (TGA | 1)
#define JPG_STD (JPG | (0 << 8))
#define JPG_VID (JPG | (1 << 8))
#define JPG_JST (JPG | (2 << 8))
#define JPG_MAX (JPG | (3 << 8))
#define JPG_MSK (0xffffff00)
#define IMAGIC 0732
/**
* \name Imbuf preset profile tags
* \brief Some predefined color space profiles that 8 bit imbufs can represent
*/
#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_image_qt[];
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)
};
#endif