New: Import/Export of Cineon and DPX image files. The first is Kodak's
[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  * $Id$ 
15  *
16  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
17  *
18  * This program is free software; you can redistribute it and/or
19  * modify it under the terms of the GNU General Public License
20  * as published by the Free Software Foundation; either version 2
21  * of the License, or (at your option) any later version. The Blender
22  * Foundation also sells licenses for use in proprietary software under
23  * the Blender License.  See http://www.blender.org/BL/ for information
24  * about this.
25  *
26  * This program is distributed in the hope that it will be useful,
27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
29  * GNU General Public License for more details.
30  *
31  * You should have received a copy of the GNU General Public License
32  * along with this program; if not, write to the Free Software Foundation,
33  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
34  *
35  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
36  * All rights reserved.
37  *
38  * The Original Code is: all of this file.
39  *
40  * Contributor(s): none yet.
41  *
42  * ***** END GPL/BL DUAL LICENSE BLOCK *****
43  */
44 /**
45  * \file IMB_imbuf_types.h
46  * \ingroup imbuf
47  * \brief Contains defines and structs used throughout the imbuf module.
48  * \todo Clean up includes.
49  */
50
51 #ifndef IMB_IMBUF_TYPES_H
52 #define IMB_IMBUF_TYPES_H
53
54 #include <stdio.h>        /* for size_t */
55 #include "DNA_listBase.h" /* for ListBase */
56 struct _AviMovie;
57 struct Mdec;
58
59 /**
60  * \brief The basic imbuf type
61  * \ingroup imbuf
62  * This is the abstraction of an image.  ImBuf is the basic type used for all
63  * imbuf operations.
64  *
65  * REMINDER: if any changes take place, they need to be carried over
66  * to source/blender/blenpluginapi/iff.h too, OTHERWISE PLUGINS WON'T
67  * WORK CORRECTLY!
68  *
69  * Also; add new variables to the end to save pain!
70  *
71  * Also, that iff.h needs to be in the final release "plugins/include" dir, too!
72  */
73 typedef struct ImBuf{
74         short   x, y;                   /**< width and Height of our image buffer */
75         short   skipx;                  /**< Width in ints to get to the next scanline */
76         unsigned char   depth;          /**< Active amount of bits/bitplanes */
77         unsigned char   cbits;          /**< Amount of active bits in cmap */
78         unsigned short  mincol;         /**< smallest color in colormap */
79         unsigned short  maxcol;         /**< Largest color in colormap */
80         int     type;                   /**< 0=abgr, 1=bitplanes */
81         int     ftype;                  /**< File type we are going to save as */
82         unsigned int    *cmap;          /**< Color map data. */
83         unsigned int    *rect;          /**< pixel values stored here */
84         unsigned int    **planes;       /**< bitplanes */
85         int     flags;                  /**< Controls which components should exist. */
86         int     mall;                   /**< what is malloced internal, and can be freed */
87         short   xorig, yorig;           /**< Cordinates of first pixel of an image used in some formats (example: targa) */
88         char    name[1023];             /**< The file name assocated with this image */
89         char    namenull;               /**< Unused don't want to remove it thought messes things up */
90         int     userflags;              /**< Used to set imbuf to Dirty and other stuff */
91         int     *zbuf;                  /**< z buffer data, original zbuffer */
92         float *zbuf_float;      /**< z buffer data, camera coordinates */
93         void *userdata; 
94         unsigned char *encodedbuffer;     /**< Compressed image only used with png currently */
95         unsigned int   encodedsize;       /**< Size of data written to encodedbuffer */
96         unsigned int   encodedbuffersize; /**< Size of encodedbuffer */
97
98         float *rect_float;              /**< floating point Rect equivilant */
99         float dither;                   /**< random dither value, for conversion from float -> byte rect */
100         
101         struct MEM_CacheLimiterHandle_s * c_handle; /**< handle for cache limiter */
102         int refcounter;                /**< Refcounter for multiple users */
103 } ImBuf;
104
105 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
106 /**
107  * \brief Flags used internally by blender for imagebuffers
108  */
109 typedef enum {
110         IB_BITMAPFONT = 1 << 0,         /* This image is a font */
111         IB_BITMAPDIRTY = 1 << 1         /* Image needs to be saved is not the same as filename */
112 } ImBuf_userflagsMask;
113
114
115 /* From iff.h. This was once moved away by Frank, now Nzc moves it
116  * back. Such is the way it is... It is a long list of defines, and
117  * there are a few external defines in the back. Most of the stuff is
118  * probably imbuf_intern only. This will need to be merged later
119  * on. */
120
121 /**
122  * \name Imbuf Component flags
123  * \brief These flags determine the components of an ImBuf struct.
124  */
125 /**@{*/
126 /** \brief Flag defining the components of the ImBuf struct. */
127 #define IB_rect                 (1 << 0)
128 #define IB_planes               (1 << 1)
129 #define IB_cmap                 (1 << 2)
130
131 #define IB_vert                 (1 << 4)
132 #define IB_freem                (1 << 6)
133 #define IB_test                 (1 << 7)
134
135 #define IB_ttob                 (1 << 8)
136 #define IB_subdlta              (1 << 9)
137 #define IB_fields               (1 << 11)
138 #define IB_zbuf                 (1 << 13)
139
140 #define IB_mem                  (1 << 14)
141 #define IB_rectfloat            (1 << 15)
142 #define IB_zbuffloat            (1 << 16)
143
144 /*
145  * The bit flag is stored in the ImBuf.ftype variable.
146  * Note that the lower 10 bits is used for storing custom flags 
147  */
148 #define AMI                             (1 << 31)
149 #define PNG                             (1 << 30)
150 #define Anim            (1 << 29)
151 #define TGA                             (1 << 28)
152 #define JPG                             (1 << 27)
153 #define BMP                             (1 << 26)
154
155 #ifdef WITH_QUICKTIME
156 #define QUICKTIME               (1 << 25)
157 #endif
158
159 #define RADHDR                  (1 << 24)
160 #define TIF                             (1 << 23)
161
162 #define OPENEXR                 (1 << 22)
163 #define OPENEXR_HALF    (1 << 8 )
164 #define OPENEXR_COMPRESS (7)    
165
166 #define CINEON                  (1 << 21)
167 #define DPX                             (1 << 20)
168
169 #define RAWTGA          (TGA | 1)
170
171 #define JPG_STD         (JPG | (0 << 8))
172 #define JPG_VID         (JPG | (1 << 8))
173 #define JPG_JST         (JPG | (2 << 8))
174 #define JPG_MAX         (JPG | (3 << 8))
175 #define JPG_MSK         (0xffffff00)
176
177 #define AM_ham          (0x0800 | AMI)
178 #define AM_hbrite       (0x0080 | AMI)
179
180 #define C233    1
181 #define YUVX    2
182 #define HAMX    3
183 #define TANX    4
184
185 #define AN_c233                 (Anim | C233)
186 #define AN_yuvx                 (Anim | YUVX)
187 #define AN_hamx                 (Anim | HAMX)
188 #define AN_tanx                 (Anim | TANX)
189 /**@}*/
190
191 /** \name Imbuf File Type Tests
192  * \brief These macros test if an ImBuf struct is the corresponding file type.
193  */
194 /**@{*/
195 /** \brief Tests the ImBuf.ftype variable for the file format. */
196 #define IS_amiga(x)             (x->ftype & AMI)
197 #define IS_ham(x)               ((x->ftype & AM_ham) == AM_ham)
198 #define IS_hbrite(x)    ((x->ftype & AM_hbrite) == AM_hbrite)
199
200 #define IS_anim(x)              (x->ftype & Anim)
201 #define IS_hamx(x)              (x->ftype == AN_hamx)
202 #define IS_tga(x)               (x->ftype & TGA)
203 #define IS_png(x)               (x->ftype & PNG)
204 #define IS_openexr(x)   (x->ftype & OPENEXR)
205 #define IS_cineon(x)    (x->ftype & CINEON)
206 #define IS_dpx(x)               (x->ftype & DPX)
207 #define IS_bmp(x)               (x->ftype & BMP)
208 #define IS_tiff(x)              (x->ftype & TIF)
209 #define IS_radhdr(x)    (x->ftype & RADHDR)
210
211 #define IMAGIC  0732
212 #define IS_iris(x)              (x->ftype == IMAGIC)
213
214 #define IS_jpg(x)               (x->ftype & JPG)
215 #define IS_stdjpg(x)    ((x->ftype & JPG_MSK) == JPG_STD)
216 #define IS_vidjpg(x)    ((x->ftype & JPG_MSK) == JPG_VID)
217 #define IS_jstjpg(x)    ((x->ftype & JPG_MSK) == JPG_JST)
218 #define IS_maxjpg(x)    ((x->ftype & JPG_MSK) == JPG_MAX)
219 /**@}*/
220
221 #endif
222