workaround for loopselect-slide (with multicut enabled) changing from vertex-select...
[blender-staging.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 #include "DNA_vec_types.h"  /* for rcti */
32
33 /**
34  * \file IMB_imbuf_types.h
35  * \ingroup imbuf
36  * \brief Contains defines and structs used throughout the imbuf module.
37  * \todo Clean up includes.
38  *
39  * Types needed for using the image buffer.
40  *
41  * Imbuf is external code, slightly adapted to live in the Blender
42  * context. It requires an external jpeg module, and the avi-module
43  * (also external code) in order to function correctly.
44  *
45  * This file contains types and some constants that go with them. Most
46  * are self-explanatory (e.g. IS_amiga tests whether the buffer
47  * contains an Amiga-format file).
48  */
49
50 struct ImMetaData;
51
52 #define IB_MIPMAP_LEVELS        20
53 #define IB_FILENAME_SIZE        1024
54
55 typedef struct DDSData {
56         unsigned int fourcc; /* DDS fourcc info */
57         unsigned int nummipmaps; /* The number of mipmaps in the dds file */
58         unsigned char *data; /* The compressed image data */
59         unsigned int size; /* The size of the compressed data */
60 } DDSData;
61
62 /**
63  * \ingroup imbuf
64  * This is the abstraction of an image.  ImBuf is the basic type used for all
65  * imbuf operations.
66  *
67  * Also; add new variables to the end to save pain!
68  *
69  */
70 typedef struct ImBuf {
71         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
72
73         /* dimensions */
74         int x, y;                               /* width and Height of our image buffer.
75                                                          * Should be 'unsigned int' since most formats use this.
76                                                          * but this is problematic with texture math in imagetexture.c
77                                                          * avoid problems and use int. - campbell */
78
79         unsigned char planes;   /* Active amount of bits/bitplanes */
80         int channels;                   /* amount of channels in rect_float (0 = 4 channel default) */
81
82         /* flags */
83         int     flags;                          /* Controls which components should exist. */
84         int     mall;                           /* what is malloced internal, and can be freed */
85
86         /* pixels */
87         unsigned int *rect;             /* pixel values stored here */
88         float *rect_float;              /* floating point Rect equivalent
89                                  * Linear RGB color space - may need gamma correction to
90                                  * sRGB when generating 8bit representations */
91
92         /* resolution - pixels per meter */
93         double ppm[2];
94
95         /* tiled pixel storage */
96         int tilex, tiley;
97         int xtiles, ytiles;
98         unsigned int **tiles;
99
100         /* zbuffer */
101         int     *zbuf;                          /* z buffer data, original zbuffer */
102         float *zbuf_float;              /* z buffer data, camera coordinates */
103
104         /* parameters used by conversion between byte and float */
105         float dither;                           /* random dither value, for conversion from float -> byte rect */
106
107         /* mipmapping */
108         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
109         int miptot, miplevel;
110
111         /* externally used data */
112         int index;                                              /* reference index for ImBuf lists */
113         int     userflags;                                      /* used to set imbuf to dirty and other stuff */
114         struct ImMetaData *metadata;    /* image metadata */
115         void *userdata;                                 /* temporary storage, only used by baking at the moment */
116
117         /* file information */
118         int     ftype;                                                  /* file type we are going to save as */
119         char name[IB_FILENAME_SIZE];            /* filename associated with this image */
120         char cachename[IB_FILENAME_SIZE];       /* full filename used for reading from cache */
121
122         /* memory cache limiter */
123         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
124         int refcounter; /* reference counter for multiple users */
125
126         /* some parameters to pass along for packing images */
127         unsigned char *encodedbuffer;     /* Compressed image only used with png currently */
128         unsigned int   encodedsize;       /* Size of data written to encodedbuffer */
129         unsigned int   encodedbuffersize; /* Size of encodedbuffer */
130
131         /* color management */
132         struct ColorSpace *rect_colorspace;          /* color space of byte buffer */
133         struct ColorSpace *float_colorspace;         /* color space of float buffer, used by sequencer only */
134         unsigned int *display_buffer_flags;          /* array of per-display display buffers dirty flags */
135         struct ColormanageCache *colormanage_cache;  /* cache used by color management */
136         int colormanage_flag;
137         rcti invalid_rect;
138
139         /* information for compressed textures */
140         struct DDSData dds_data;
141 } ImBuf;
142
143 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
144 /**
145  * \brief userflags: Flags used internally by blender for imagebuffers
146  */
147
148 #define IB_BITMAPFONT                   (1 << 0)        /* this image is a font */
149 #define IB_BITMAPDIRTY                  (1 << 1)        /* image needs to be saved is not the same as filename */
150 #define IB_MIPMAP_INVALID               (1 << 2)        /* image mipmaps are invalid, need recreate */
151 #define IB_RECT_INVALID                 (1 << 3)        /* float buffer changed, needs recreation of byte rect */
152 #define IB_DISPLAY_BUFFER_INVALID       (1 << 4)        /* either float or byte buffer changed, need to re-calculate display buffers */
153
154 /**
155  * \name Imbuf Component flags
156  * \brief These flags determine the components of an ImBuf struct.
157  */
158 /**@{*/
159 /** \brief Flag defining the components of the ImBuf struct. */
160
161 #define IB_rect                         (1 << 0)
162 #define IB_test                         (1 << 1)
163 #define IB_fields                       (1 << 2)
164 #define IB_zbuf                         (1 << 3)
165 #define IB_mem                          (1 << 4)
166 #define IB_rectfloat            (1 << 5)
167 #define IB_zbuffloat            (1 << 6)
168 #define IB_multilayer           (1 << 7)
169 #define IB_metadata                     (1 << 8)
170 #define IB_animdeinterlace      (1 << 9)
171 #define IB_tiles                        (1 << 10)
172 #define IB_tilecache            (1 << 11)
173 #define IB_alphamode_premul     (1 << 12)  /* indicates whether image on disk have premul alpha */
174 #define IB_alphamode_detect     (1 << 13)  /* if this flag is set, alpha mode would be guessed from file */
175 #define IB_ignore_alpha         (1 << 14)  /* ignore alpha on load and substitude it with 1.0f */
176
177 /*
178  * The bit flag is stored in the ImBuf.ftype variable.
179  * Note that the lower 11 bits is used for storing custom flags
180  */
181 #define IB_CUSTOM_FLAGS_MASK 0x7ff
182
183 #define PNG                             (1 << 30)
184 #define TGA                             (1 << 28)
185 #define JPG                             (1 << 27)
186 #define BMP                             (1 << 26)
187
188 #ifdef WITH_QUICKTIME
189 #define QUICKTIME               (1 << 25)
190 #endif
191
192 #ifdef WITH_HDR
193 #define RADHDR                  (1 << 24)
194 #endif
195 #ifdef WITH_TIFF
196 #define TIF                             (1 << 23)
197 #define TIF_16BIT               (1 << 8 )
198 #endif
199
200 #define OPENEXR                 (1 << 22)
201 #define OPENEXR_HALF    (1 << 8 )
202 #define OPENEXR_COMPRESS (7)    
203
204 #ifdef WITH_CINEON
205 #define CINEON                  (1 << 21)
206 #define DPX                             (1 << 20)
207 #define CINEON_LOG              (1 << 8)
208 #define CINEON_16BIT    (1 << 7)
209 #define CINEON_12BIT    (1 << 6)
210 #define CINEON_10BIT    (1 << 5)
211 #endif
212
213 #ifdef WITH_DDS
214 #define DDS                             (1 << 19)
215 #endif
216
217 #ifdef WITH_OPENJPEG
218 #define JP2                             (1 << 18)
219 #define JP2_12BIT               (1 << 17)
220 #define JP2_16BIT               (1 << 16)
221 #define JP2_YCC                 (1 << 15)
222 #define JP2_CINE                (1 << 14)
223 #define JP2_CINE_48FPS  (1 << 13) 
224 #define JP2_JP2 (1 << 12)
225 #define JP2_J2K (1 << 11)
226 #endif
227
228 #define PNG_16BIT                       (1 << 10)
229
230 #define RAWTGA          (TGA | 1)
231
232 #define JPG_STD         (JPG | (0 << 8))
233 #define JPG_VID         (JPG | (1 << 8))
234 #define JPG_JST         (JPG | (2 << 8))
235 #define JPG_MAX         (JPG | (3 << 8))
236 #define JPG_MSK         (0xffffff00)
237
238 #define IMAGIC                  0732
239
240 /**
241  * \name Imbuf preset profile tags
242  * \brief Some predefined color space profiles that 8 bit imbufs can represent
243  */
244 #define IB_PROFILE_NONE                 0
245 #define IB_PROFILE_LINEAR_RGB   1
246 #define IB_PROFILE_SRGB                 2
247 #define IB_PROFILE_CUSTOM               3
248
249 /* dds */
250 #ifdef WITH_DDS
251 #ifndef MAKEFOURCC
252 #define MAKEFOURCC(ch0, ch1, ch2, ch3)\
253         ((unsigned long)(unsigned char)(ch0) | \
254         ((unsigned long)(unsigned char)(ch1) << 8) | \
255         ((unsigned long)(unsigned char)(ch2) << 16) | \
256         ((unsigned long)(unsigned char)(ch3) << 24))
257 #endif  /* MAKEFOURCC */
258
259 /*
260  * FOURCC codes for DX compressed-texture pixel formats
261  */
262
263 #define FOURCC_DDS   (MAKEFOURCC('D','D','S',' '))
264 #define FOURCC_DXT1  (MAKEFOURCC('D','X','T','1'))
265 #define FOURCC_DXT2  (MAKEFOURCC('D','X','T','2'))
266 #define FOURCC_DXT3  (MAKEFOURCC('D','X','T','3'))
267 #define FOURCC_DXT4  (MAKEFOURCC('D','X','T','4'))
268 #define FOURCC_DXT5  (MAKEFOURCC('D','X','T','5'))
269
270 #endif  /* DDS */
271 extern const char *imb_ext_image[];
272 extern const char *imb_ext_image_qt[];
273 extern const char *imb_ext_movie[];
274 extern const char *imb_ext_audio[];
275
276 enum {
277         IMB_COLORMANAGE_IS_DATA = (1 << 0)
278 };
279
280 #endif