merging game_engine branch changes into trunk, 2d-filters and opengl speedup
[blender.git] / source / blender / makesdna / DNA_sequence_types.h
1 /**
2  * blenlib/DNA_sequence_types.h (mar-2001 nzc)
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version. The Blender
12  * Foundation also sells licenses for use in proprietary software under
13  * the Blender License.  See http://www.blender.org/BL/ for information
14  * about this.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software Foundation,
23  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
24  *
25  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
26  * All rights reserved.
27  *
28  * The Original Code is: all of this file.
29  *
30  * Contributor(s): none yet.
31  *
32  * ***** END GPL/BL DUAL LICENSE BLOCK *****
33  */
34 #ifndef DNA_SEQUENCE_TYPES_H
35 #define DNA_SEQUENCE_TYPES_H
36
37 #include "DNA_listBase.h"
38
39 /* needed for sound support */
40 #include "DNA_sound_types.h"
41
42 struct Ipo;
43 struct Scene;
44
45 /* strlens; 80= FILE_MAXFILE, 160= FILE_MAXDIR */
46
47 typedef struct StripElem {
48         char name[80];
49 } StripElem;
50
51 typedef struct TStripElem {
52         struct ImBuf *ibuf;
53         struct ImBuf *ibuf_comp;
54         struct TStripElem *se1, *se2, *se3;
55         short ok;
56         short flag;
57         int nr;
58 } TStripElem;
59
60 typedef struct StripCrop {
61         int top;
62         int bottom;
63         int left;
64         int right;
65 } StripCrop;
66
67 typedef struct StripTransform {
68         int xofs;
69         int yofs;
70 } StripTransform;
71
72 typedef struct StripColorBalance {
73         float lift[3];
74         float gamma[3];
75         float gain[3];
76         int flag;
77         float exposure;
78         float saturation;
79 } StripColorBalance;
80
81 typedef struct StripProxy {
82         char dir[160];
83 } StripProxy;
84
85 typedef struct Strip {
86         struct Strip *next, *prev;
87         int rt, len, us, done;
88         int startstill, endstill;
89         StripElem *stripdata;
90         char dir[160];
91         int orx, ory;
92         StripProxy *proxy;
93         StripCrop *crop;
94         StripTransform *transform;
95         StripColorBalance *color_balance;
96         TStripElem *tstripdata;
97         TStripElem *tstripdata_startstill;
98         TStripElem *tstripdata_endstill;
99 } Strip;
100
101
102 typedef struct PluginSeq {
103         char name[256];
104         void *handle;
105
106         char *pname;
107
108         int vars, version;
109
110         void *varstr;
111         float *cfra;
112
113         float data[32];
114
115         void *instance_private_data;
116         void **current_private_data;
117
118         void (*doit)(void);
119
120         void (*callback)(void);
121 } PluginSeq;
122
123 /* The sequence structure is the basic struct used by any strip. each of the strips uses a different sequence structure.*/
124 /* WATCH IT: first part identical to ID (for use in ipo's) */
125
126 typedef struct Sequence {
127         struct Sequence *next, *prev;
128         void *tmp; /* tmp var for copying, and tagging for linked selection */
129         void *lib; /* needed (to be like ipo), else it will raise libdata warnings, this should never be used */
130         char name[24]; /* name, not set by default and dosnt need to be unique as with ID's */
131
132         int flag, type; /*flags bitmap (see below) and the type of sequence*/
133         int len; /* the length of the contense of this strip - before handles are applied */
134         int start, startofs, endofs;
135         int startstill, endstill;
136         int machine, depth; /*machine - the strip channel, depth - the depth in the sequence when dealing with metastrips */
137         int startdisp, enddisp; /*starting and ending points in the sequence*/
138         float mul, handsize;
139                                         /* is sfra needed anymore? - it looks like its only used in one place */
140         int sfra;               /* starting frame according to the timeline of the scene. */
141         int anim_preseek;
142
143         Strip *strip;
144
145         struct Ipo *ipo;
146         struct Scene *scene;
147         struct anim *anim;
148         float facf0, facf1;
149
150         PluginSeq *plugin;
151
152         /* pointers for effects: */
153         struct Sequence *seq1, *seq2, *seq3;
154
155         ListBase seqbase;       /* list of strips for metastrips */
156
157         struct bSound *sound;   /* the linked "bSound" object */
158         struct hdaudio *hdaudio; /* external hdaudio object */
159         float level, pan;       /* level in dB (0=full), pan -1..1 */
160         int curpos;             /* last sample position in audio_fill() */
161         float strobe;
162
163         void *effectdata;       /* Struct pointer for effect settings */
164
165         int anim_startofs;    /* only use part of animation file */
166         int anim_endofs;      /* is subtle different to startofs / endofs */
167
168         int blend_mode;
169         float blend_opacity;
170
171         int scenenr;          /* for scene selection */
172         int pad;
173 } Sequence;
174
175 typedef struct MetaStack {
176         struct MetaStack *next, *prev;
177         ListBase *oldbasep;
178         Sequence *parseq;
179 } MetaStack;
180
181 typedef struct Editing {
182         ListBase *seqbasep;
183         ListBase seqbase;
184         ListBase metastack;
185         short flag;
186         short pad;
187         int rt;
188 } Editing;
189
190 /* ************* Effect Variable Structs ********* */
191 typedef struct WipeVars {
192         float edgeWidth,angle;
193         short forward, wipetype;
194 } WipeVars;
195
196 typedef struct GlowVars {       
197         float fMini;    /*      Minimum intensity to trigger a glow */
198         float fClamp;
199         float fBoost;   /*      Amount to multiply glow intensity */
200     float dDist;        /*      Radius of glow blurring */
201         int     dQuality;
202         int     bNoComp;        /*      SHOW/HIDE glow buffer */
203 } GlowVars;
204
205 typedef struct TransformVars {
206         float ScalexIni;
207         float ScaleyIni;
208         float ScalexFin;
209         float ScaleyFin;
210         float xIni;
211         float xFin;
212         float yIni;
213         float yFin;
214         float rotIni;
215         float rotFin;
216         int percent;
217         int interpolation;
218 } TransformVars;
219
220 typedef struct SolidColorVars {
221         float col[3];
222         float pad;
223 } SolidColorVars;
224
225 typedef struct SpeedControlVars {
226         float * frameMap;
227         float globalSpeed;
228         int flags;
229         int length;
230         int lastValidFrame;
231 } SpeedControlVars;
232
233 /* SpeedControlVars->flags */
234 #define SEQ_SPEED_INTEGRATE      1
235 #define SEQ_SPEED_BLEND          2
236 #define SEQ_SPEED_COMPRESS_IPO_Y 4
237
238 /* ***************** SEQUENCE ****************** */
239
240 /* seq->flag */
241 #define SEQ_LEFTSEL                             2
242 #define SEQ_RIGHTSEL                    4
243 #define SEQ_OVERLAP                             8
244 #define SEQ_FILTERY                             16
245 #define SEQ_MUTE                                32
246 #define SEQ_MAKE_PREMUL                 64
247 #define SEQ_REVERSE_FRAMES              128
248 #define SEQ_IPO_FRAME_LOCKED    256
249 #define SEQ_EFFECT_NOT_LOADED   512
250 #define SEQ_FLAG_DELETE                 1024
251 #define SEQ_FLIPX                               2048
252 #define SEQ_FLIPY                               4096
253 #define SEQ_MAKE_FLOAT                          8192
254 #define SEQ_LOCK                                16384
255 #define SEQ_USE_PROXY                           32768
256 #define SEQ_USE_TRANSFORM                       65536
257 #define SEQ_USE_CROP                           131072
258 #define SEQ_USE_COLOR_BALANCE                  262144
259 #define SEQ_USE_PROXY_CUSTOM_DIR               524288
260
261 #define SEQ_COLOR_BALANCE_INVERSE_GAIN 1
262 #define SEQ_COLOR_BALANCE_INVERSE_GAMMA 2
263 #define SEQ_COLOR_BALANCE_INVERSE_LIFT 4
264
265 /* seq->type WATCH IT: SEQ_EFFECT BIT is used to determine if this is an effect strip!!! */
266 #define SEQ_IMAGE               0
267 #define SEQ_META                1
268 #define SEQ_SCENE               2
269 #define SEQ_MOVIE               3
270 #define SEQ_RAM_SOUND           4
271 #define SEQ_HD_SOUND            5
272 #define SEQ_MOVIE_AND_HD_SOUND  6 /* helper for add_sequence */
273
274 #define SEQ_EFFECT              8
275 #define SEQ_CROSS               8
276 #define SEQ_ADD                 9
277 #define SEQ_SUB                 10
278 #define SEQ_ALPHAOVER   11
279 #define SEQ_ALPHAUNDER  12
280 #define SEQ_GAMCROSS    13
281 #define SEQ_MUL                 14
282 #define SEQ_OVERDROP    15
283 #define SEQ_PLUGIN              24
284 #define SEQ_WIPE                25
285 #define SEQ_GLOW                26
286 #define SEQ_TRANSFORM           27
287 #define SEQ_COLOR               28
288 #define SEQ_SPEED               29
289 #define SEQ_EFFECT_MAX          29
290
291 #define STRIPELEM_FAILED       0
292 #define STRIPELEM_OK           1
293 #define STRIPELEM_META         2
294
295 #define STRIPELEM_PREVIEW_DONE  1
296
297 #define SEQ_BLEND_REPLACE      0
298 /* all other BLEND_MODEs are simple SEQ_EFFECT ids and therefore identical
299    to the table above. (Only those effects that handle _exactly_ two inputs,
300    otherwise, you can't really blend, right :) !)
301 */
302
303 #endif
304