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