Merging r49624 through r49628 from trunk into soc-2011-tomato
[blender.git] / source / blender / imbuf / IMB_imbuf_types.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __IMB_IMBUF_TYPES_H__
29 #define __IMB_IMBUF_TYPES_H__
30
31 /**
32  * \file IMB_imbuf_types.h
33  * \ingroup imbuf
34  * \brief Contains defines and structs used throughout the imbuf module.
35  * \todo Clean up includes.
36  *
37  * Types needed for using the image buffer.
38  *
39  * Imbuf is external code, slightly adapted to live in the Blender
40  * context. It requires an external jpeg module, and the avi-module
41  * (also external code) in order to function correctly.
42  *
43  * This file contains types and some constants that go with them. Most
44  * are self-explanatory (e.g. IS_amiga tests whether the buffer
45  * contains an Amiga-format file).
46  */
47
48 struct ImMetaData;
49
50 #define IB_MIPMAP_LEVELS        20
51 #define IB_FILENAME_SIZE        1024
52
53 typedef struct DDSData {
54         unsigned int fourcc; /* DDS fourcc info */
55         unsigned int nummipmaps; /* The number of mipmaps in the dds file */
56         unsigned char *data; /* The compressed image data */
57         unsigned int size; /* The size of the compressed data */
58 } DDSData;
59
60 /**
61  * \ingroup imbuf
62  * This is the abstraction of an image.  ImBuf is the basic type used for all
63  * imbuf operations.
64  *
65  * Also; add new variables to the end to save pain!
66  *
67  */
68 typedef struct ImBuf {
69         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
70
71         /* dimensions */
72         int x, y;                               /* width and Height of our image buffer.
73                                                          * Should be 'unsigned int' since most formats use this.
74                                                          * but this is problematic with texture math in imagetexture.c
75                                                          * avoid problems and use int. - campbell */
76
77         unsigned char planes;   /* Active amount of bits/bitplanes */
78         int channels;                   /* amount of channels in rect_float (0 = 4 channel default) */
79
80         /* flags */
81         int     flags;                          /* Controls which components should exist. */
82         int     mall;                           /* what is malloced internal, and can be freed */
83
84         /* pixels */
85         unsigned int *rect;             /* pixel values stored here */
86         float *rect_float;              /* floating point Rect equivalent
87                                  * Linear RGB color space - may need gamma correction to
88                                  * sRGB when generating 8bit representations */
89
90         /* resolution - pixels per meter */
91         double ppm[2];
92
93         /* tiled pixel storage */
94         int tilex, tiley;
95         int xtiles, ytiles;
96         unsigned int **tiles;   
97
98         /* zbuffer */
99         int     *zbuf;                          /* z buffer data, original zbuffer */
100         float *zbuf_float;              /* z buffer data, camera coordinates */
101
102         /* parameters used by conversion between byte and float */
103         float dither;                           /* random dither value, for conversion from float -> byte rect */
104         short profile;                          /* color space/profile preset that the byte rect buffer represents */
105
106         /* mipmapping */
107         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
108         int miptot, miplevel;
109
110         /* externally used data */
111         int index;                                              /* reference index for ImBuf lists */
112         int     userflags;                                      /* used to set imbuf to dirty and other stuff */
113         struct ImMetaData *metadata;    /* image metadata */
114         void *userdata;                                 /* temporary storage, only used by baking at the moment */
115
116         /* file information */
117         int     ftype;                                                  /* file type we are going to save as */
118         char name[IB_FILENAME_SIZE];            /* filename associated with this image */
119         char cachename[IB_FILENAME_SIZE];       /* full filename used for reading from cache */
120
121         /* memory cache limiter */
122         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
123         int refcounter; /* reference counter for multiple users */
124
125         /* some parameters to pass along for packing images */
126         unsigned char *encodedbuffer;     /* Compressed image only used with png currently */
127         unsigned int   encodedsize;       /* Size of data written to encodedbuffer */
128         unsigned int   encodedbuffersize; /* Size of encodedbuffer */
129
130         /* color management */
131         unsigned int colormanagement_flags;  /* flags filed used by color management rutines */
132         unsigned int *display_buffer_flags;  /* array of per-display display buffers dirty flags */
133         struct ColormanageCache *colormanage_cache;  /* cache used by color management */
134
135         /* information for compressed textures */
136         struct DDSData dds_data;
137 } ImBuf;
138
139 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
140 /**
141  * \brief userflags: Flags used internally by blender for imagebuffers
142  */
143
144 #define IB_BITMAPFONT           (1 << 0)        /* this image is a font */
145 #define IB_BITMAPDIRTY          (1 << 1)        /* image needs to be saved is not the same as filename */
146 #define IB_MIPMAP_INVALID       (1 << 2)        /* image mipmaps are invalid, need recreate */
147 #define IB_RECT_INVALID         (1 << 3)    /* float buffer changed, needs recreation of byte rect */
148
149 /**
150  * \name Imbuf Component flags
151  * \brief These flags determine the components of an ImBuf struct.
152  */
153 /**@{*/
154 /** \brief Flag defining the components of the ImBuf struct. */
155
156 #define IB_rect                         (1 << 0)
157 #define IB_test                         (1 << 1)
158 #define IB_fields                       (1 << 2)
159 #define IB_zbuf                         (1 << 3)
160 #define IB_mem                          (1 << 4)
161 #define IB_rectfloat            (1 << 5)
162 #define IB_zbuffloat            (1 << 6)
163 #define IB_multilayer           (1 << 7)
164 #define IB_metadata                     (1 << 8)
165 #define IB_animdeinterlace      (1 << 9)
166 #define IB_tiles                        (1 << 10)
167 #define IB_tilecache            (1 << 11)
168 #define IB_premul                       (1 << 12)
169 #define IB_cm_predivide         (1 << 13)
170
171 /*
172  * The bit flag is stored in the ImBuf.ftype variable.
173  * Note that the lower 10 bits is used for storing custom flags 
174  */
175 #define PNG                             (1 << 30)
176 #define TGA                             (1 << 28)
177 #define JPG                             (1 << 27)
178 #define BMP                             (1 << 26)
179
180 #ifdef WITH_QUICKTIME
181 #define QUICKTIME               (1 << 25)
182 #endif
183
184 #ifdef WITH_HDR
185 #define RADHDR                  (1 << 24)
186 #endif
187 #ifdef WITH_TIFF
188 #define TIF                             (1 << 23)
189 #define TIF_16BIT               (1 << 8 )
190 #endif
191
192 #define OPENEXR                 (1 << 22)
193 #define OPENEXR_HALF    (1 << 8 )
194 #define OPENEXR_COMPRESS (7)    
195
196 #ifdef WITH_CINEON
197 #define CINEON                  (1 << 21)
198 #define DPX                             (1 << 20)
199 #endif
200
201 #ifdef WITH_DDS
202 #define DDS                             (1 << 19)
203 #endif
204
205 #ifdef WITH_OPENJPEG
206 #define JP2                             (1 << 18)
207 #define JP2_12BIT               (1 << 17)
208 #define JP2_16BIT               (1 << 16)
209 #define JP2_YCC                 (1 << 15)
210 #define JP2_CINE                (1 << 14)
211 #define JP2_CINE_48FPS  (1 << 13) 
212 #endif
213
214 #define RAWTGA          (TGA | 1)
215
216 #define JPG_STD         (JPG | (0 << 8))
217 #define JPG_VID         (JPG | (1 << 8))
218 #define JPG_JST         (JPG | (2 << 8))
219 #define JPG_MAX         (JPG | (3 << 8))
220 #define JPG_MSK         (0xffffff00)
221
222 #define IMAGIC                  0732
223
224 /**
225  * \name Imbuf preset profile tags
226  * \brief Some predefined color space profiles that 8 bit imbufs can represent
227  */
228 #define IB_PROFILE_NONE                 0
229 #define IB_PROFILE_LINEAR_RGB   1
230 #define IB_PROFILE_SRGB                 2
231 #define IB_PROFILE_CUSTOM               3
232
233 /* dds */
234 #ifdef WITH_DDS
235 #ifndef MAKEFOURCC
236 #define MAKEFOURCC(ch0, ch1, ch2, ch3)\
237         ((unsigned long)(unsigned char)(ch0) | \
238         ((unsigned long)(unsigned char)(ch1) << 8) | \
239         ((unsigned long)(unsigned char)(ch2) << 16) | \
240         ((unsigned long)(unsigned char)(ch3) << 24))
241 #endif //MAKEFOURCC
242
243 /*
244  * FOURCC codes for DX compressed-texture pixel formats
245  */
246
247 #define FOURCC_DDS   (MAKEFOURCC('D','D','S',' '))
248 #define FOURCC_DXT1  (MAKEFOURCC('D','X','T','1'))
249 #define FOURCC_DXT2  (MAKEFOURCC('D','X','T','2'))
250 #define FOURCC_DXT3  (MAKEFOURCC('D','X','T','3'))
251 #define FOURCC_DXT4  (MAKEFOURCC('D','X','T','4'))
252 #define FOURCC_DXT5  (MAKEFOURCC('D','X','T','5'))
253
254 #endif // DDS
255 extern const char *imb_ext_image[];
256 extern const char *imb_ext_image_qt[];
257 extern const char *imb_ext_movie[];
258 extern const char *imb_ext_audio[];
259
260 /* imbuf->colormanagement_flags */
261
262 /* special flag used for color management of compositor results,
263  * which are in sRGB space and requires extra step in color conversions
264  * could be replaced with something more general in the future
265  */
266 #define IMB_COLORMANAGEMENT_SRGB_SOURCE    (1 << 0)
267
268 #endif