Gizmo: move transform to a persistent option
[blender.git] / source / blender / imbuf / IMB_imbuf_types.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __IMB_IMBUF_TYPES_H__
21 #define __IMB_IMBUF_TYPES_H__
22
23 #include "DNA_vec_types.h"  /* for rcti */
24
25 /** \file
26  * \ingroup imbuf
27  * \brief Contains defines and structs used throughout the imbuf module.
28  * \todo Clean up includes.
29  *
30  * Types needed for using the image buffer.
31  *
32  * Imbuf is external code, slightly adapted to live in the Blender
33  * context. It requires an external jpeg module, and the avi-module
34  * (also external code) in order to function correctly.
35  *
36  * This file contains types and some constants that go with them. Most
37  * are self-explanatory (e.g. IS_amiga tests whether the buffer
38  * contains an Amiga-format file).
39  */
40
41 #define IMB_MIPMAP_LEVELS       20
42 #define IMB_FILENAME_SIZE       1024
43
44 typedef struct DDSData {
45         /** DDS fourcc info */
46         unsigned int fourcc;
47         /** The number of mipmaps in the dds file */
48         unsigned int nummipmaps;
49         /** The compressed image data */
50         unsigned char *data;
51         /** The size of the compressed data */
52         unsigned int size;
53 } DDSData;
54
55 /**
56  * \ingroup imbuf
57  * This is the abstraction of an image.  ImBuf is the basic type used for all
58  * imbuf operations.
59  *
60  * Also; add new variables to the end to save pain!
61  */
62
63
64 /* Warning: Keep explicit value assignments here,
65  * this file is included in areas where not all format defines are set
66  * (e.g. intern/dds only get WITH_DDS, even if TIFF, HDR etc are also defined).
67  * See T46524. */
68
69 /** #ImBuf.ftype flag, main image types. */
70 enum eImbTypes {
71         IMB_FTYPE_PNG       = 1,
72         IMB_FTYPE_TGA       = 2,
73         IMB_FTYPE_JPG       = 3,
74         IMB_FTYPE_BMP       = 4,
75         IMB_FTYPE_OPENEXR   = 5,
76         IMB_FTYPE_IMAGIC    = 6,
77 #ifdef WITH_OPENIMAGEIO
78         IMB_FTYPE_PSD       = 7,
79 #endif
80 #ifdef WITH_OPENJPEG
81         IMB_FTYPE_JP2       = 8,
82 #endif
83 #ifdef WITH_HDR
84         IMB_FTYPE_RADHDR    = 9,
85 #endif
86 #ifdef WITH_TIFF
87         IMB_FTYPE_TIF       = 10,
88 #endif
89 #ifdef WITH_CINEON
90         IMB_FTYPE_CINEON    = 11,
91         IMB_FTYPE_DPX       = 12,
92 #endif
93
94 #ifdef WITH_DDS
95         IMB_FTYPE_DDS       = 13,
96 #endif
97 };
98
99 /* ibuf->foptions flag, type specific options.
100  * Some formats include compression rations on some bits */
101
102 #define OPENEXR_HALF    (1 << 8 )
103 /* careful changing this, it's used in DNA as well */
104 #define OPENEXR_COMPRESS (15)
105
106 #ifdef WITH_CINEON
107 #define CINEON_LOG              (1 << 8)
108 #define CINEON_16BIT    (1 << 7)
109 #define CINEON_12BIT    (1 << 6)
110 #define CINEON_10BIT    (1 << 5)
111 #endif
112
113 #ifdef WITH_OPENJPEG
114 #define JP2_12BIT               (1 << 9)
115 #define JP2_16BIT               (1 << 8)
116 #define JP2_YCC                 (1 << 7)
117 #define JP2_CINE                (1 << 6)
118 #define JP2_CINE_48FPS  (1 << 5)
119 #define JP2_JP2 (1 << 4)
120 #define JP2_J2K (1 << 3)
121 #endif
122
123 #define PNG_16BIT                       (1 << 10)
124
125 #define RAWTGA          1
126
127 #ifdef WITH_TIFF
128 #define TIF_16BIT                       (1 << 8)
129 #define TIF_COMPRESS_NONE               (1 << 7)
130 #define TIF_COMPRESS_DEFLATE            (1 << 6)
131 #define TIF_COMPRESS_LZW                (1 << 5)
132 #define TIF_COMPRESS_PACKBITS           (1 << 4)
133 #endif
134
135 typedef struct ImbFormatOptions {
136         short flag;
137         /** quality serves dual purpose as quality number for jpeg or compression amount for png */
138         char quality;
139 } ImbFormatOptions;
140
141 typedef struct ImBuf {
142         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
143
144         /* dimensions */
145         /** Width and Height of our image buffer.
146          * Should be 'unsigned int' since most formats use this.
147          * but this is problematic with texture math in imagetexture.c
148          * avoid problems and use int. - campbell */
149         int x, y;
150
151         /** Active amount of bits/bitplanes */
152         unsigned char planes;
153         /** Number of channels in `rect_float` (0 = 4 channel default) */
154         int channels;
155
156         /* flags */
157         /** Controls which components should exist. */
158         int     flags;
159         /** what is malloced internal, and can be freed */
160         int     mall;
161
162         /* pixels */
163
164         /** Image pixel buffer (8bit representation):
165          * - color space defaults to `sRGB`.
166          * - alpha defaults to 'straight'.
167          */
168         unsigned int *rect;
169         /** Image pixel buffer (float representation):
170          * - color space defaults to 'linear' (`rec709`).
171          * - alpha defaults to 'premul'.
172          * \note May need gamma correction to `sRGB` when generating 8bit representations.
173          * \note Formats that support higher more than 8 but channels load as floats.
174          */
175         float *rect_float;
176
177         /* resolution - pixels per meter */
178         double ppm[2];
179
180         /* tiled pixel storage */
181         int tilex, tiley;
182         int xtiles, ytiles;
183         unsigned int **tiles;
184
185         /* zbuffer */
186         /** z buffer data, original zbuffer */
187         int     *zbuf;
188         /** z buffer data, camera coordinates */
189         float *zbuf_float;
190
191         /* parameters used by conversion between byte and float */
192         /** random dither value, for conversion from float -> byte rect */
193         float dither;
194
195         /* mipmapping */
196         /** MipMap levels, a series of halved images */
197         struct ImBuf *mipmap[IMB_MIPMAP_LEVELS];
198         int miptot, miplevel;
199
200         /* externally used data */
201         /** reference index for ImBuf lists */
202         int index;
203         /** used to set imbuf to dirty and other stuff */
204         int     userflags;
205         /** image metadata */
206         struct IDProperty *metadata;
207         /** temporary storage */
208         void *userdata;
209
210         /* file information */
211         /** file type we are going to save as */
212         enum eImbTypes  ftype;
213         /** file format specific flags */
214         ImbFormatOptions foptions;
215         /** filename associated with this image */
216         char name[IMB_FILENAME_SIZE];
217         /** full filename used for reading from cache */
218         char cachename[IMB_FILENAME_SIZE];
219
220         /* memory cache limiter */
221         /** handle for cache limiter */
222         struct MEM_CacheLimiterHandle_s *c_handle;
223         /** reference counter for multiple users */
224         int refcounter;
225
226         /* some parameters to pass along for packing images */
227         /** Compressed image only used with png currently */
228         unsigned char *encodedbuffer;
229         /** Size of data written to encodedbuffer */
230         unsigned int   encodedsize;
231         /** Size of encodedbuffer */
232         unsigned int   encodedbuffersize;
233
234         /* color management */
235         /** color space of byte buffer */
236         struct ColorSpace *rect_colorspace;
237         /** color space of float buffer, used by sequencer only */
238         struct ColorSpace *float_colorspace;
239         /** array of per-display display buffers dirty flags */
240         unsigned int *display_buffer_flags;
241         /** cache used by color management */
242         struct ColormanageCache *colormanage_cache;
243         int colormanage_flag;
244         rcti invalid_rect;
245
246         /* information for compressed textures */
247         struct DDSData dds_data;
248 } ImBuf;
249
250 /**
251  * \brief userflags: Flags used internally by blender for imagebuffers
252  */
253
254 enum {
255         /** image needs to be saved is not the same as filename */
256         IB_BITMAPDIRTY =          (1 << 1),
257         /** image mipmaps are invalid, need recreate */
258         IB_MIPMAP_INVALID =       (1 << 2),
259         /** float buffer changed, needs recreation of byte rect */
260         IB_RECT_INVALID =         (1 << 3),
261         /** either float or byte buffer changed, need to re-calculate display buffers */
262         IB_DISPLAY_BUFFER_INVALID =   (1 << 4),
263         /** image buffer is persistent in the memory and should never be removed from the cache */
264         IB_PERSISTENT =               (1 << 5),
265 };
266
267 /**
268  * \name Imbuf Component flags
269  * \brief These flags determine the components of an ImBuf struct.
270  *
271  * \{ */
272
273 enum {
274         IB_rect             = 1 << 0,
275         IB_test             = 1 << 1,
276         IB_zbuf             = 1 << 3,
277         IB_mem              = 1 << 4,
278         IB_rectfloat        = 1 << 5,
279         IB_zbuffloat        = 1 << 6,
280         IB_multilayer       = 1 << 7,
281         IB_metadata         = 1 << 8,
282         IB_animdeinterlace  = 1 << 9,
283         IB_tiles            = 1 << 10,
284         IB_tilecache        = 1 << 11,
285         /** indicates whether image on disk have premul alpha */
286         IB_alphamode_premul = 1 << 12,
287         /** if this flag is set, alpha mode would be guessed from file */
288         IB_alphamode_detect = 1 << 13,
289         /** ignore alpha on load and substitute it with 1.0f */
290         IB_ignore_alpha     = 1 << 14,
291         IB_thumbnail        = 1 << 15,
292         IB_multiview        = 1 << 16,
293 };
294
295 /** \} */
296
297 /**
298  * \name Imbuf preset profile tags
299  * \brief Some predefined color space profiles that 8 bit imbufs can represent
300  *
301  * \{ */
302 #define IB_PROFILE_NONE                 0
303 #define IB_PROFILE_LINEAR_RGB   1
304 #define IB_PROFILE_SRGB                 2
305 #define IB_PROFILE_CUSTOM               3
306
307 /** \} */
308
309 /* dds */
310 #ifdef WITH_DDS
311 #ifndef DDS_MAKEFOURCC
312 #define DDS_MAKEFOURCC(ch0, ch1, ch2, ch3)\
313         ((unsigned long)(unsigned char)(ch0) | \
314         ((unsigned long)(unsigned char)(ch1) << 8) | \
315         ((unsigned long)(unsigned char)(ch2) << 16) | \
316         ((unsigned long)(unsigned char)(ch3) << 24))
317 #endif  /* DDS_MAKEFOURCC */
318
319 /*
320  * FOURCC codes for DX compressed-texture pixel formats
321  */
322
323 #define FOURCC_DDS   (DDS_MAKEFOURCC('D','D','S',' '))
324 #define FOURCC_DXT1  (DDS_MAKEFOURCC('D','X','T','1'))
325 #define FOURCC_DXT2  (DDS_MAKEFOURCC('D','X','T','2'))
326 #define FOURCC_DXT3  (DDS_MAKEFOURCC('D','X','T','3'))
327 #define FOURCC_DXT4  (DDS_MAKEFOURCC('D','X','T','4'))
328 #define FOURCC_DXT5  (DDS_MAKEFOURCC('D','X','T','5'))
329
330 #endif  /* DDS */
331 extern const char *imb_ext_image[];
332 extern const char *imb_ext_movie[];
333 extern const char *imb_ext_audio[];
334
335 /* image formats that can only be loaded via filepath */
336 extern const char *imb_ext_image_filepath_only[];
337
338 /**
339  * \name Imbuf Color Management Flag
340  * \brief Used with #ImBuf.colormanage_flag
341  *
342  * \{ */
343
344 enum {
345         IMB_COLORMANAGE_IS_DATA = (1 << 0),
346 };
347
348 /** \} */
349
350 #endif  /* __IMB_IMBUF_TYPES_H__ */