svn merge ^/trunk/blender -r41230:41266
[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  *
15  * ***** BEGIN GPL LICENSE BLOCK *****
16  *
17  * This program is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU General Public License
19  * as published by the Free Software Foundation; either version 2
20  * of the License, or (at your option) any later version.
21  *
22  * This program is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
25  * GNU General Public License for more details.
26  *
27  * You should have received a copy of the GNU General Public License
28  * along with this program; if not, write to the Free Software Foundation,
29  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
30  *
31  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
32  * All rights reserved.
33  *
34  * The Original Code is: all of this file.
35  *
36  * Contributor(s): none yet.
37  *
38  * ***** END GPL LICENSE BLOCK *****
39  */
40 /**
41  * \file IMB_imbuf_types.h
42  * \ingroup imbuf
43  * \brief Contains defines and structs used throughout the imbuf module.
44  * \todo Clean up includes.
45  */
46
47 #ifndef IMB_IMBUF_TYPES_H
48 #define IMB_IMBUF_TYPES_H
49
50 struct ImMetaData;
51
52 #define IB_MIPMAP_LEVELS        20
53 #define IB_FILENAME_SIZE        1023
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  * REMINDER: if any changes take place, they need to be carried over
61  * to source/blender/blenpluginapi/iff.h too, OTHERWISE PLUGINS WON'T
62  * WORK CORRECTLY!
63  *
64  * Also; add new variables to the end to save pain!
65  *
66  * Also, that iff.h needs to be in the final release "plugins/include" dir, too!
67  */
68 typedef struct ImBuf {
69         struct ImBuf *next, *prev;      /**< allow lists of ImBufs, for caches or flipbooks */
70
71         /* dimensions */
72         int x, y;                               /* width and Height of our image buffer.
73                                                          * Should be 'unsigned int' since most formats use this.
74                                                          * but this is problematic with texture math in imagetexture.c
75                                                          * avoid problems and use int. - campbell */
76
77         unsigned char depth;    /* Active amount of bits/bitplanes */
78         int channels;                   /* amount of channels in rect_float (0 = 4 channel default) */
79
80         /* flags */
81         int     flags;                          /* Controls which components should exist. */
82         int     mall;                           /* what is malloced internal, and can be freed */
83
84         /* pixels */
85         unsigned int *rect;             /* pixel values stored here */
86         float *rect_float;              /* floating point Rect equivalent
87                                                         Linear RGB color space - may need gamma correction to 
88                                                         sRGB when generating 8bit representations */
89
90         /* resolution - pixels per meter */
91         double ppm[2];
92
93         /* tiled pixel storage */
94         int tilex, tiley;
95         int xtiles, ytiles;
96         unsigned int **tiles;   
97
98         /* zbuffer */
99         int     *zbuf;                          /* z buffer data, original zbuffer */
100         float *zbuf_float;              /* z buffer data, camera coordinates */
101
102         /* parameters used by conversion between byte and float */
103         float dither;                           /* random dither value, for conversion from float -> byte rect */
104         short profile;                          /* color space/profile preset that the byte rect buffer represents */
105
106         /* mipmapping */
107         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
108         int miptot, miplevel;
109
110         /* externally used data */
111         int index;                                              /* reference index for ImBuf lists */
112         int     userflags;                                      /* used to set imbuf to dirty and other stuff */
113         struct ImMetaData *metadata;    /* image metadata */
114         void *userdata;                                 /* temporary storage, only used by baking at the moment */
115
116         /* file information */
117         int     ftype;                                                  /* file type we are going to save as */
118         char name[IB_FILENAME_SIZE];            /* filename associated with this image */
119         char cachename[IB_FILENAME_SIZE];       /* full filename used for reading from cache */
120
121         /* memory cache limiter */
122         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
123         int refcounter; /* reference counter for multiple users */
124
125         /* some parameters to pass along for packing images */
126         unsigned char *encodedbuffer;     /* Compressed image only used with png currently */
127         unsigned int   encodedsize;       /* Size of data written to encodedbuffer */
128         unsigned int   encodedbuffersize; /* Size of encodedbuffer */
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
162 /*
163  * The bit flag is stored in the ImBuf.ftype variable.
164  * Note that the lower 10 bits is used for storing custom flags 
165  */
166 #define PNG                             (1 << 30)
167 #define TGA                             (1 << 28)
168 #define JPG                             (1 << 27)
169 #define BMP                             (1 << 26)
170
171 #ifdef WITH_QUICKTIME
172 #define QUICKTIME               (1 << 25)
173 #endif
174
175 #ifdef WITH_HDR
176 #define RADHDR                  (1 << 24)
177 #endif
178 #ifdef WITH_TIFF
179 #define TIF                             (1 << 23)
180 #define TIF_16BIT               (1 << 8 )
181 #endif
182
183 #define OPENEXR                 (1 << 22)
184 #define OPENEXR_HALF    (1 << 8 )
185 #define OPENEXR_COMPRESS (7)    
186
187 #ifdef WITH_CINEON
188 #define CINEON                  (1 << 21)
189 #define DPX                             (1 << 20)
190 #endif
191
192 #ifdef WITH_DDS
193 #define DDS                             (1 << 19)
194 #endif
195
196 #ifdef WITH_OPENJPEG
197 #define JP2                             (1 << 18)
198 #define JP2_12BIT               (1 << 17)
199 #define JP2_16BIT               (1 << 16)
200 #define JP2_YCC                 (1 << 15)
201 #define JP2_CINE                (1 << 14)
202 #define JP2_CINE_48FPS  (1 << 13) 
203 #endif
204
205 #define RAWTGA          (TGA | 1)
206
207 #define JPG_STD         (JPG | (0 << 8))
208 #define JPG_VID         (JPG | (1 << 8))
209 #define JPG_JST         (JPG | (2 << 8))
210 #define JPG_MAX         (JPG | (3 << 8))
211 #define JPG_MSK         (0xffffff00)
212
213 #define IMAGIC                  0732
214
215 /**
216  * \name Imbuf preset profile tags
217  * \brief Some predefined color space profiles that 8 bit imbufs can represent
218  */
219 #define IB_PROFILE_NONE                 0
220 #define IB_PROFILE_LINEAR_RGB   1
221 #define IB_PROFILE_SRGB                 2
222 #define IB_PROFILE_CUSTOM               3
223
224 extern const char *imb_ext_image[];
225 extern const char *imb_ext_image_qt[];
226 extern const char *imb_ext_movie[];
227 extern const char *imb_ext_audio[];
228
229 #endif