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