Color management refactoiring and some extra options
[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 /**
54  * \ingroup imbuf
55  * This is the abstraction of an image.  ImBuf is the basic type used for all
56  * imbuf operations.
57  *
58  * Also; add new variables to the end to save pain!
59  *
60  */
61 typedef struct ImBuf {
62         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
63
64         /* dimensions */
65         int x, y;                               /* width and Height of our image buffer.
66                                                          * Should be 'unsigned int' since most formats use this.
67                                                          * but this is problematic with texture math in imagetexture.c
68                                                          * avoid problems and use int. - campbell */
69
70         unsigned char planes;   /* Active amount of bits/bitplanes */
71         int channels;                   /* amount of channels in rect_float (0 = 4 channel default) */
72
73         /* flags */
74         int     flags;                          /* Controls which components should exist. */
75         int     mall;                           /* what is malloced internal, and can be freed */
76
77         /* pixels */
78         unsigned int *rect;             /* pixel values stored here */
79         float *rect_float;              /* floating point Rect equivalent
80                                  * Linear RGB color space - may need gamma correction to
81                                  * sRGB when generating 8bit representations */
82
83         /* resolution - pixels per meter */
84         double ppm[2];
85
86         /* tiled pixel storage */
87         int tilex, tiley;
88         int xtiles, ytiles;
89         unsigned int **tiles;   
90
91         /* zbuffer */
92         int     *zbuf;                          /* z buffer data, original zbuffer */
93         float *zbuf_float;              /* z buffer data, camera coordinates */
94
95         /* parameters used by conversion between byte and float */
96         float dither;                           /* random dither value, for conversion from float -> byte rect */
97         short profile;                          /* color space/profile preset that the byte rect buffer represents */
98
99         /* mipmapping */
100         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
101         int miptot, miplevel;
102
103         /* externally used data */
104         int index;                                              /* reference index for ImBuf lists */
105         int     userflags;                                      /* used to set imbuf to dirty and other stuff */
106         struct ImMetaData *metadata;    /* image metadata */
107         void *userdata;                                 /* temporary storage, only used by baking at the moment */
108
109         /* file information */
110         int     ftype;                                                  /* file type we are going to save as */
111         char name[IB_FILENAME_SIZE];            /* filename associated with this image */
112         char cachename[IB_FILENAME_SIZE];       /* full filename used for reading from cache */
113
114         /* memory cache limiter */
115         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
116         int refcounter; /* reference counter for multiple users */
117
118         /* some parameters to pass along for packing images */
119         unsigned char *encodedbuffer;     /* Compressed image only used with png currently */
120         unsigned int   encodedsize;       /* Size of data written to encodedbuffer */
121         unsigned int   encodedbuffersize; /* Size of encodedbuffer */
122
123         /* color management */
124         int colormanage_refcounter;
125         unsigned int colormanage_flags;
126         unsigned int *display_buffer_flags;  /* array of per-display display buffers dirty flags */
127         void *colormanage_cache_data;        /* cache data which is being assigned when */
128                                              /* put ImBuf to colormanage cache */
129 } ImBuf;
130
131 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
132 /**
133  * \brief userflags: Flags used internally by blender for imagebuffers
134  */
135
136 #define IB_BITMAPFONT           (1 << 0)        /* this image is a font */
137 #define IB_BITMAPDIRTY          (1 << 1)        /* image needs to be saved is not the same as filename */
138 #define IB_MIPMAP_INVALID       (1 << 2)        /* image mipmaps are invalid, need recreate */
139 #define IB_RECT_INVALID         (1 << 3)    /* float buffer changed, needs recreation of byte rect */
140
141 /**
142  * \name Imbuf Component flags
143  * \brief These flags determine the components of an ImBuf struct.
144  */
145 /**@{*/
146 /** \brief Flag defining the components of the ImBuf struct. */
147
148 #define IB_rect                         (1 << 0)
149 #define IB_test                         (1 << 1)
150 #define IB_fields                       (1 << 2)
151 #define IB_zbuf                         (1 << 3)
152 #define IB_mem                          (1 << 4)
153 #define IB_rectfloat            (1 << 5)
154 #define IB_zbuffloat            (1 << 6)
155 #define IB_multilayer           (1 << 7)
156 #define IB_metadata                     (1 << 8)
157 #define IB_animdeinterlace      (1 << 9)
158 #define IB_tiles                        (1 << 10)
159 #define IB_tilecache            (1 << 11)
160 #define IB_premul                       (1 << 12)
161 #define IB_cm_predivide         (1 << 13)
162
163 /*
164  * The bit flag is stored in the ImBuf.ftype variable.
165  * Note that the lower 10 bits is used for storing custom flags 
166  */
167 #define PNG                             (1 << 30)
168 #define TGA                             (1 << 28)
169 #define JPG                             (1 << 27)
170 #define BMP                             (1 << 26)
171
172 #ifdef WITH_QUICKTIME
173 #define QUICKTIME               (1 << 25)
174 #endif
175
176 #ifdef WITH_HDR
177 #define RADHDR                  (1 << 24)
178 #endif
179 #ifdef WITH_TIFF
180 #define TIF                             (1 << 23)
181 #define TIF_16BIT               (1 << 8 )
182 #endif
183
184 #define OPENEXR                 (1 << 22)
185 #define OPENEXR_HALF    (1 << 8 )
186 #define OPENEXR_COMPRESS (7)    
187
188 #ifdef WITH_CINEON
189 #define CINEON                  (1 << 21)
190 #define DPX                             (1 << 20)
191 #endif
192
193 #ifdef WITH_DDS
194 #define DDS                             (1 << 19)
195 #endif
196
197 #ifdef WITH_OPENJPEG
198 #define JP2                             (1 << 18)
199 #define JP2_12BIT               (1 << 17)
200 #define JP2_16BIT               (1 << 16)
201 #define JP2_YCC                 (1 << 15)
202 #define JP2_CINE                (1 << 14)
203 #define JP2_CINE_48FPS  (1 << 13) 
204 #endif
205
206 #define RAWTGA          (TGA | 1)
207
208 #define JPG_STD         (JPG | (0 << 8))
209 #define JPG_VID         (JPG | (1 << 8))
210 #define JPG_JST         (JPG | (2 << 8))
211 #define JPG_MAX         (JPG | (3 << 8))
212 #define JPG_MSK         (0xffffff00)
213
214 #define IMAGIC                  0732
215
216 /**
217  * \name Imbuf preset profile tags
218  * \brief Some predefined color space profiles that 8 bit imbufs can represent
219  */
220 #define IB_PROFILE_NONE                 0
221 #define IB_PROFILE_LINEAR_RGB   1
222 #define IB_PROFILE_SRGB                 2
223 #define IB_PROFILE_CUSTOM               3
224
225 extern const char *imb_ext_image[];
226 extern const char *imb_ext_image_qt[];
227 extern const char *imb_ext_movie[];
228 extern const char *imb_ext_audio[];
229
230 /* colormanage flags */
231 #define IMB_COLORMANAGED                (1 << 0)
232
233 #endif