svn merge ^/trunk/blender -r48153:48158
[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 /**
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         unsigned int *rect_view[5];     /* cached view rects which were converted from float buffer */
80                                         /* using different view transforms */
81         float *rect_float;              /* floating point Rect equivalent
82                                  * Linear RGB color space - may need gamma correction to
83                                  * sRGB when generating 8bit representations */
84
85         /* resolution - pixels per meter */
86         double ppm[2];
87
88         /* tiled pixel storage */
89         int tilex, tiley;
90         int xtiles, ytiles;
91         unsigned int **tiles;   
92
93         /* zbuffer */
94         int     *zbuf;                          /* z buffer data, original zbuffer */
95         float *zbuf_float;              /* z buffer data, camera coordinates */
96
97         /* parameters used by conversion between byte and float */
98         float dither;                           /* random dither value, for conversion from float -> byte rect */
99         short profile;                          /* color space/profile preset that the byte rect buffer represents */
100
101         /* mipmapping */
102         struct ImBuf *mipmap[IB_MIPMAP_LEVELS]; /* MipMap levels, a series of halved images */
103         int miptot, miplevel;
104
105         /* externally used data */
106         int index;                                              /* reference index for ImBuf lists */
107         int     userflags;                                      /* used to set imbuf to dirty and other stuff */
108         struct ImMetaData *metadata;    /* image metadata */
109         void *userdata;                                 /* temporary storage, only used by baking at the moment */
110
111         /* file information */
112         int     ftype;                                                  /* file type we are going to save as */
113         char name[IB_FILENAME_SIZE];            /* filename associated with this image */
114         char cachename[IB_FILENAME_SIZE];       /* full filename used for reading from cache */
115
116         /* memory cache limiter */
117         struct MEM_CacheLimiterHandle_s *c_handle; /* handle for cache limiter */
118         int refcounter; /* reference counter for multiple users */
119
120         /* some parameters to pass along for packing images */
121         unsigned char *encodedbuffer;     /* Compressed image only used with png currently */
122         unsigned int   encodedsize;       /* Size of data written to encodedbuffer */
123         unsigned int   encodedbuffersize; /* Size of encodedbuffer */
124 } ImBuf;
125
126 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
127 /**
128  * \brief userflags: Flags used internally by blender for imagebuffers
129  */
130
131 #define IB_BITMAPFONT           (1 << 0)        /* this image is a font */
132 #define IB_BITMAPDIRTY          (1 << 1)        /* image needs to be saved is not the same as filename */
133 #define IB_MIPMAP_INVALID       (1 << 2)        /* image mipmaps are invalid, need recreate */
134 #define IB_RECT_INVALID         (1 << 3)    /* float buffer changed, needs recreation of byte rect */
135
136 /**
137  * \name Imbuf Component flags
138  * \brief These flags determine the components of an ImBuf struct.
139  */
140 /**@{*/
141 /** \brief Flag defining the components of the ImBuf struct. */
142
143 #define IB_rect                         (1 << 0)
144 #define IB_test                         (1 << 1)
145 #define IB_fields                       (1 << 2)
146 #define IB_zbuf                         (1 << 3)
147 #define IB_mem                          (1 << 4)
148 #define IB_rectfloat            (1 << 5)
149 #define IB_zbuffloat            (1 << 6)
150 #define IB_multilayer           (1 << 7)
151 #define IB_metadata                     (1 << 8)
152 #define IB_animdeinterlace      (1 << 9)
153 #define IB_tiles                        (1 << 10)
154 #define IB_tilecache            (1 << 11)
155 #define IB_premul                       (1 << 12)
156 #define IB_cm_predivide         (1 << 13)
157
158 /*
159  * The bit flag is stored in the ImBuf.ftype variable.
160  * Note that the lower 10 bits is used for storing custom flags 
161  */
162 #define PNG                             (1 << 30)
163 #define TGA                             (1 << 28)
164 #define JPG                             (1 << 27)
165 #define BMP                             (1 << 26)
166
167 #ifdef WITH_QUICKTIME
168 #define QUICKTIME               (1 << 25)
169 #endif
170
171 #ifdef WITH_HDR
172 #define RADHDR                  (1 << 24)
173 #endif
174 #ifdef WITH_TIFF
175 #define TIF                             (1 << 23)
176 #define TIF_16BIT               (1 << 8 )
177 #endif
178
179 #define OPENEXR                 (1 << 22)
180 #define OPENEXR_HALF    (1 << 8 )
181 #define OPENEXR_COMPRESS (7)    
182
183 #ifdef WITH_CINEON
184 #define CINEON                  (1 << 21)
185 #define DPX                             (1 << 20)
186 #endif
187
188 #ifdef WITH_DDS
189 #define DDS                             (1 << 19)
190 #endif
191
192 #ifdef WITH_OPENJPEG
193 #define JP2                             (1 << 18)
194 #define JP2_12BIT               (1 << 17)
195 #define JP2_16BIT               (1 << 16)
196 #define JP2_YCC                 (1 << 15)
197 #define JP2_CINE                (1 << 14)
198 #define JP2_CINE_48FPS  (1 << 13) 
199 #endif
200
201 #define RAWTGA          (TGA | 1)
202
203 #define JPG_STD         (JPG | (0 << 8))
204 #define JPG_VID         (JPG | (1 << 8))
205 #define JPG_JST         (JPG | (2 << 8))
206 #define JPG_MAX         (JPG | (3 << 8))
207 #define JPG_MSK         (0xffffff00)
208
209 #define IMAGIC                  0732
210
211 /**
212  * \name Imbuf preset profile tags
213  * \brief Some predefined color space profiles that 8 bit imbufs can represent
214  */
215 #define IB_PROFILE_NONE                 0
216 #define IB_PROFILE_LINEAR_RGB   1
217 #define IB_PROFILE_SRGB                 2
218 #define IB_PROFILE_CUSTOM               3
219
220 extern const char *imb_ext_image[];
221 extern const char *imb_ext_image_qt[];
222 extern const char *imb_ext_movie[];
223 extern const char *imb_ext_audio[];
224
225 #endif