This looks like a lot but its a few small changes.
[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  */
66 typedef struct ImBuf{
67                 /** Width in pixels */
68         short   x, y;           /**< Height in scanlines */
69         short   skipx;          /**< Width in ints to get to the next scanline */
70         unsigned char   depth;          /**< Active amount of bits/bitplanes */
71         unsigned char   cbits;          /**< Amount of active bits in cmap */
72         unsigned short  mincol;         /**< First active color?*/
73         unsigned short  maxcol;         /**< Last active color?*/
74         int     type;           /**< 0=abgr, 1=bitplanes */
75         int     ftype;          /**< File type */
76         unsigned int    *cmap;          /**< Color map data. */
77         unsigned int    *rect;          /**< databuffer */
78         unsigned int    **planes;       /**< bitplanes */
79         int     flags;          /**< Controls which components should exist. */
80         int     mall;           /**< what is malloced internal, and can be freed */
81                 /** X origin.  What is this relative to? */
82         short   xorig, yorig;           /**< Y origin.  What is this relative to? */
83         char    name[1023];             /**< The file name */
84         char    namenull;               /**< What does this do?*/
85         int     userflags;              /**< What does this do? Holds an enum ImBuf_userflagsMask?*/
86         int     *zbuf;          /**< A z buffer */
87         void *userdata;         /**< What does this do?*/
88         unsigned char *encodedbuffer;           /**< Does encoded mean compressed? */
89         unsigned int   encodedsize;             /**< Compressed size?? */
90         unsigned int   encodedbuffersize;               /**< Uncompressed size?? */
91 } ImBuf;
92
93 /* Moved from BKE_bmfont_types.h because it is a userflag bit mask. */
94 /**
95  * \brief Flags for the user?
96  */
97 typedef enum {
98         IB_BITMAPFONT = 1 << 0,
99         IB_BITMAPDIRTY = 1 << 1
100 } ImBuf_userflagsMask;
101
102
103 /* From iff.h. This was once moved away by Frank, now Nzc moves it
104  * back. Such is the way it is... It is a long list of defines, and
105  * there are a few external defines in the back. Most of the stuff is
106  * probably imbuf_intern only. This will need to be merged later
107  * on. */
108
109 /**
110  * \name Imbuf Component flags
111  * \brief These flags determine the components of an ImBuf struct.
112  */
113 /**@{*/
114 /** \brief Flag defining the components of the ImBuf struct. */
115 #define IB_rect                 (1 << 0)
116 #define IB_planes               (1 << 1)
117 #define IB_cmap                 (1 << 2)
118
119 #define IB_vert                 (1 << 4)
120 #define IB_freem                (1 << 6)
121 #define IB_test                 (1 << 7)
122
123 #define IB_ttob                 (1 << 8)
124 #define IB_subdlta              (1 << 9)
125 #define IB_fields               (1 << 11)
126 #define IB_zbuf                 (1 << 13)
127
128 #define IB_mem                  (1 << 14)
129 /**@}*/
130
131 /** \name imbuf_formats Image file formats
132  * \brief These defines are bit flags for the various image file formats.
133  */
134 /**@{*/
135 /** \brief Identifier for an image file format.
136  *
137  * The bit flag is stored in the ImBuf.ftype variable.
138  */
139 #define AMI             (1 << 31)
140 #define PNG             (1 << 30)
141 #define Anim            (1 << 29)
142 #define TGA             (1 << 28)
143 #define JPG             (1 << 27)
144 #define BMP             (1 << 26)
145 #ifdef WITH_QUICKTIME
146 #define QUICKTIME       (1 << 25)
147 #endif
148 #ifdef WITH_FREEIMAGE
149 #define FREEIMAGE       (1 << 24)
150 #endif
151 #ifdef WITH_IMAGEMAGICK
152 #define IMAGEMAGICK     (1 << 23)
153 #endif
154
155 #define RAWTGA          (TGA | 1)
156
157 #define JPG_STD         (JPG | (0 << 8))
158 #define JPG_VID         (JPG | (1 << 8))
159 #define JPG_JST         (JPG | (2 << 8))
160 #define JPG_MAX         (JPG | (3 << 8))
161 #define JPG_MSK         (0xffffff00)
162
163 #define AM_ham          (0x0800 | AMI)
164 #define AM_hbrite       (0x0080 | AMI)
165
166 #define C233    1
167 #define YUVX    2
168 #define HAMX    3
169 #define TANX    4
170
171 #define AN_c233                 (Anim | C233)
172 #define AN_yuvx                 (Anim | YUVX)
173 #define AN_hamx                 (Anim | HAMX)
174 #define AN_tanx                 (Anim | TANX)
175 /**@}*/
176
177 /** \name Imbuf File Type Tests
178  * \brief These macros test if an ImBuf struct is the corresponding file type.
179  */
180 /**@{*/
181 /** \brief Tests the ImBuf.ftype variable for the file format. */
182 #define IS_amiga(x)             (x->ftype & AMI)
183 #define IS_ham(x)               ((x->ftype & AM_ham) == AM_ham)
184 #define IS_hbrite(x)    ((x->ftype & AM_hbrite) == AM_hbrite)
185
186 #define IS_anim(x)              (x->ftype & Anim)
187 #define IS_hamx(x)              (x->ftype == AN_hamx)
188 #define IS_tga(x)               (x->ftype & TGA)
189 #define IS_png(x)               (x->ftype & PNG)
190 #define IS_bmp(x)               (x->ftype & BMP)
191
192 #define IMAGIC  0732
193 #define IS_iris(x)              (x->ftype == IMAGIC)
194
195 #define IS_jpg(x)               (x->ftype & JPG)
196 #define IS_stdjpg(x)    ((x->ftype & JPG_MSK) == JPG_STD)
197 #define IS_vidjpg(x)    ((x->ftype & JPG_MSK) == JPG_VID)
198 #define IS_jstjpg(x)    ((x->ftype & JPG_MSK) == JPG_JST)
199 #define IS_maxjpg(x)    ((x->ftype & JPG_MSK) == JPG_MAX)
200 /**@}*/
201
202 #endif
203