== Sculpt ==
[blender.git] / source / blender / imbuf / IMB_imbuf_types.h
1 /**
2  * IMB_imbuf_types.h (mar-2001 nzc)
3  *
4  * Types needed for using the image buffer.
5  *
6  * Imbuf is external code, slightly adapted to live in the Blender
7  * context. It requires an external jpeg module, and the avi-module
8  * (also external code) in order to function correctly.
9  *
10  * This file contains types and some constants that go with them. Most
11  * are self-explanatory (e.g. IS_amiga tests whether the buffer
12  * contains an Amiga-format file).
13  *
14  * $Id$ 
15  *
16  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License
20  * as published by the Free Software Foundation; either version 2
21  * of the License, or (at your option) any later version. The Blender
22  * Foundation also sells licenses for use in proprietary software under
23  * the Blender License.  See http://www.blender.org/BL/ for information
24  * about this.
25  *
26  * This program is distributed in the hope that it will be useful,
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29  * GNU General Public License for more details.
30  *
31  * You should have received a copy of the GNU General Public License
32  * along with this program; if not, write to the Free Software Foundation,
33  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
34  *
35  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
36  * All rights reserved.
37  *
38  * The Original Code is: all of this file.
39  *
40  * Contributor(s): none yet.
41  *
42  * ***** END GPL/BL DUAL LICENSE BLOCK *****
43  */
44 /**
45  * \file IMB_imbuf_types.h
46  * \ingroup imbuf
47  * \brief Contains defines and structs used throughout the imbuf module.
48  * \todo Clean up includes.
49  */
50
51 #ifndef IMB_IMBUF_TYPES_H
52 #define IMB_IMBUF_TYPES_H
53
54 #include <stdio.h>        /* for size_t */
55 #include "DNA_listBase.h" /* for ListBase */
56 struct _AviMovie;
57 struct Mdec;
58
59 struct ImgInfo;
60
61 #define IB_MIPMAP_LEVELS        10
62
63 /**
64  * \brief The basic imbuf type
65  * \ingroup imbuf
66  * This is the abstraction of an image.  ImBuf is the basic type used for all
67  * imbuf operations.
68  *
69  * REMINDER: if any changes take place, they need to be carried over
70  * to source/blender/blenpluginapi/iff.h too, OTHERWISE PLUGINS WON'T
71  * WORK CORRECTLY!
72  *
73  * Also; add new variables to the end to save pain!
74  *
75  * Also, that iff.h needs to be in the final release "plugins/include" dir, too!
76  */
77 typedef struct ImBuf {
78         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
79         short   x, y;                           /**< width and Height of our image buffer */
80         short   skipx;                          /**< Width in ints to get to the next scanline */
81         unsigned char   depth;          /**< Active amount of bits/bitplanes */
82         unsigned char   cbits;          /**< Amount of active bits in cmap */
83         unsigned short  mincol;         /**< smallest color in colormap */
84         unsigned short  maxcol;         /**< Largest color in colormap */
85         int     type;                                   /**< 0=abgr, 1=bitplanes */
86         int     ftype;                                  /**< File type we are going to save as */
87         unsigned int    *cmap;          /**< Color map data. */
88         unsigned int    *rect;          /**< pixel values stored here */
89         unsigned int    **planes;       /**< bitplanes */
90         int     flags;                          /**< Controls which components should exist. */
91         int     mall;                           /**< what is malloced internal, and can be freed */
92         short   xorig, yorig;           /**< Cordinates of first pixel of an image used in some formats (example: targa) */
93         char    name[1023];             /**< The file name assocated with this image */
94         char    namenull;               /**< Unused don't want to remove it thought messes things up */
95         int     userflags;                      /**< Used to set imbuf to Dirty and other stuff */
96         int     *zbuf;                          /**< z buffer data, original zbuffer */
97         float *zbuf_float;              /**< z buffer data, camera coordinates */
98         void *userdata; 
99         unsigned char *encodedbuffer;     /**< Compressed image only used with png currently */
100         unsigned int   encodedsize;       /**< Size of data written to encodedbuffer */
101         unsigned int   encodedbuffersize; /**< Size of encodedbuffer */
102
103         float *rect_float;              /**< floating point Rect equivilant */
104         int channels;                   /**< amount of channels in rect_float (0 = 4 channel default) */
105         float dither;                   /**< random dither value, for conversion from float -> byte rect */
106         
107         struct MEM_CacheLimiterHandle_s * c_handle; /**< handle for cache limiter */
108         struct ImgInfo * img_info;
109         int refcounter;                 /**< Refcounter for multiple users */
110         int index;                              /**< reference index for ImBuf lists */
111         
112         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /**< MipMap levels, a series of halved images */
113 } ImBuf;
114
115 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
116 /**
117  * \brief Flags used internally by blender for imagebuffers
118  */
119 typedef enum {
120         IB_BITMAPFONT = 1 << 0,         /* This image is a font */
121         IB_BITMAPDIRTY = 1 << 1         /* Image needs to be saved is not the same as filename */
122 } ImBuf_userflagsMask;
123
124
125 /* From iff.h. This was once moved away by Frank, now Nzc moves it
126  * back. Such is the way it is... It is a long list of defines, and
127  * there are a few external defines in the back. Most of the stuff is
128  * probably imbuf_intern only. This will need to be merged later
129  * on. */
130
131 /**
132  * \name Imbuf Component flags
133  * \brief These flags determine the components of an ImBuf struct.
134  */
135 /**@{*/
136 /** \brief Flag defining the components of the ImBuf struct. */
137 #define IB_rect                 (1 << 0)
138 #define IB_planes               (1 << 1)
139 #define IB_cmap                 (1 << 2)
140
141 #define IB_vert                 (1 << 4)
142 #define IB_freem                (1 << 6)
143 #define IB_test                 (1 << 7)
144
145 #define IB_ttob                 (1 << 8)
146 #define IB_subdlta              (1 << 9)
147 #define IB_fields               (1 << 11)
148 #define IB_zbuf                 (1 << 13)
149
150 #define IB_mem                  (1 << 14)
151 #define IB_rectfloat    (1 << 15)
152 #define IB_zbuffloat    (1 << 16)
153 #define IB_multilayer   (1 << 17)
154 #define IB_imginfo              (1 << 18)
155
156 /*
157  * The bit flag is stored in the ImBuf.ftype variable.
158  * Note that the lower 10 bits is used for storing custom flags 
159  */
160 #define AMI                             (1 << 31)
161 #define PNG                             (1 << 30)
162 #define Anim            (1 << 29)
163 #define TGA                             (1 << 28)
164 #define JPG                             (1 << 27)
165 #define BMP                             (1 << 26)
166
167 #ifdef WITH_QUICKTIME
168 #define QUICKTIME               (1 << 25)
169 #endif
170
171 #define RADHDR                  (1 << 24)
172 #define TIF                             (1 << 23)
173
174 #define OPENEXR                 (1 << 22)
175 #define OPENEXR_HALF    (1 << 8 )
176 #define OPENEXR_COMPRESS (7)    
177
178 #define CINEON                  (1 << 21)
179 #define DPX                             (1 << 20)
180
181 #ifdef WITH_DDS
182 #define DDS                             (1 << 19)
183 #endif
184
185 #define RAWTGA          (TGA | 1)
186
187 #define JPG_STD         (JPG | (0 << 8))
188 #define JPG_VID         (JPG | (1 << 8))
189 #define JPG_JST         (JPG | (2 << 8))
190 #define JPG_MAX         (JPG | (3 << 8))
191 #define JPG_MSK         (0xffffff00)
192
193 #define AM_ham          (0x0800 | AMI)
194 #define AM_hbrite       (0x0080 | AMI)
195
196 #define C233    1
197 #define YUVX    2
198 #define HAMX    3
199 #define TANX    4
200
201 #define AN_c233                 (Anim | C233)
202 #define AN_yuvx                 (Anim | YUVX)
203 #define AN_hamx                 (Anim | HAMX)
204 #define AN_tanx                 (Anim | TANX)
205 /**@}*/
206
207 /** \name Imbuf File Type Tests
208  * \brief These macros test if an ImBuf struct is the corresponding file type.
209  */
210 /**@{*/
211 /** \brief Tests the ImBuf.ftype variable for the file format. */
212 #define IS_amiga(x)             (x->ftype & AMI)
213 #define IS_ham(x)               ((x->ftype & AM_ham) == AM_ham)
214 #define IS_hbrite(x)    ((x->ftype & AM_hbrite) == AM_hbrite)
215
216 #define IS_anim(x)              (x->ftype & Anim)
217 #define IS_hamx(x)              (x->ftype == AN_hamx)
218 #define IS_tga(x)               (x->ftype & TGA)
219 #define IS_png(x)               (x->ftype & PNG)
220 #define IS_openexr(x)   (x->ftype & OPENEXR)
221 #define IS_cineon(x)    (x->ftype & CINEON)
222 #define IS_dpx(x)               (x->ftype & DPX)
223 #define IS_bmp(x)               (x->ftype & BMP)
224 #define IS_tiff(x)              (x->ftype & TIF)
225 #define IS_radhdr(x)    (x->ftype & RADHDR)
226
227 #ifdef WITH_DDS
228 #define IS_dds(x)               (x->ftype & DDS)
229 #endif
230
231 #define IMAGIC  0732
232 #define IS_iris(x)              (x->ftype == IMAGIC)
233
234 #define IS_jpg(x)               (x->ftype & JPG)
235 #define IS_stdjpg(x)    ((x->ftype & JPG_MSK) == JPG_STD)
236 #define IS_vidjpg(x)    ((x->ftype & JPG_MSK) == JPG_VID)
237 #define IS_jstjpg(x)    ((x->ftype & JPG_MSK) == JPG_JST)
238 #define IS_maxjpg(x)    ((x->ftype & JPG_MSK) == JPG_MAX)
239 /**@}*/
240
241 #endif
242