== Sequencer ==
[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]; /* name, not set by default and dosnt need to be unique as with ID's */
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;
151         struct Scene *scene;
152         struct anim *anim;
153         float facf0, facf1;
154
155         PluginSeq *plugin;
156
157         /* pointers for effects: */
158         struct Sequence *seq1, *seq2, *seq3;
159
160         ListBase seqbase;       /* list of strips for metastrips */
161
162         struct bSound *sound;   /* the linked "bSound" object */
163         struct hdaudio *hdaudio; /* external hdaudio object */
164         float level, pan;       /* level in dB (0=full), pan -1..1 */
165         int scenenr;          /* for scene selection */
166         float strobe;
167
168         void *effectdata;       /* Struct pointer for effect settings */
169
170         int anim_startofs;    /* only use part of animation file */
171         int anim_endofs;      /* is subtle different to startofs / endofs */
172
173         int blend_mode;
174         float blend_opacity;
175
176 } Sequence;
177
178 typedef struct MetaStack {
179         struct MetaStack *next, *prev;
180         ListBase *oldbasep;
181         Sequence *parseq;
182 } MetaStack;
183
184 typedef struct Editing {
185         ListBase *seqbasep;
186         ListBase seqbase;
187         ListBase metastack;
188         short flag;
189         short pad;
190         int rt;
191 } Editing;
192
193 /* ************* Effect Variable Structs ********* */
194 typedef struct WipeVars {
195         float edgeWidth,angle;
196         short forward, wipetype;
197 } WipeVars;
198
199 typedef struct GlowVars {       
200         float fMini;    /*      Minimum intensity to trigger a glow */
201         float fClamp;
202         float fBoost;   /*      Amount to multiply glow intensity */
203     float dDist;        /*      Radius of glow blurring */
204         int     dQuality;
205         int     bNoComp;        /*      SHOW/HIDE glow buffer */
206 } GlowVars;
207
208 typedef struct TransformVars {
209         float ScalexIni;
210         float ScaleyIni;
211         float ScalexFin;
212         float ScaleyFin;
213         float xIni;
214         float xFin;
215         float yIni;
216         float yFin;
217         float rotIni;
218         float rotFin;
219         int percent;
220         int interpolation;
221 } TransformVars;
222
223 typedef struct SolidColorVars {
224         float col[3];
225         float pad;
226 } SolidColorVars;
227
228 typedef struct SpeedControlVars {
229         float * frameMap;
230         float globalSpeed;
231         int flags;
232         int length;
233         int lastValidFrame;
234 } SpeedControlVars;
235
236 /* SpeedControlVars->flags */
237 #define SEQ_SPEED_INTEGRATE      1
238 #define SEQ_SPEED_BLEND          2
239 #define SEQ_SPEED_COMPRESS_IPO_Y 4
240
241 /* ***************** SEQUENCE ****************** */
242
243 /* seq->flag */
244 #define SEQ_LEFTSEL                             2
245 #define SEQ_RIGHTSEL                    4
246 #define SEQ_OVERLAP                             8
247 #define SEQ_FILTERY                             16
248 #define SEQ_MUTE                                32
249 #define SEQ_MAKE_PREMUL                 64
250 #define SEQ_REVERSE_FRAMES              128
251 #define SEQ_IPO_FRAME_LOCKED    256
252 #define SEQ_EFFECT_NOT_LOADED   512
253 #define SEQ_FLAG_DELETE                 1024
254 #define SEQ_FLIPX                               2048
255 #define SEQ_FLIPY                               4096
256 #define SEQ_MAKE_FLOAT                          8192
257 #define SEQ_LOCK                                16384
258 #define SEQ_USE_PROXY                           32768
259 #define SEQ_USE_TRANSFORM                       65536
260 #define SEQ_USE_CROP                           131072
261 #define SEQ_USE_COLOR_BALANCE                  262144
262 #define SEQ_USE_PROXY_CUSTOM_DIR               524288
263 #define SEQ_ACTIVE                            1048576
264 #define SEQ_USE_PROXY_CUSTOM_FILE             2097152
265
266 #define SEQ_COLOR_BALANCE_INVERSE_GAIN 1
267 #define SEQ_COLOR_BALANCE_INVERSE_GAMMA 2
268 #define SEQ_COLOR_BALANCE_INVERSE_LIFT 4
269
270 /* seq->type WATCH IT: SEQ_EFFECT BIT is used to determine if this is an effect strip!!! */
271 #define SEQ_IMAGE               0
272 #define SEQ_META                1
273 #define SEQ_SCENE               2
274 #define SEQ_MOVIE               3
275 #define SEQ_RAM_SOUND           4
276 #define SEQ_HD_SOUND            5
277 #define SEQ_MOVIE_AND_HD_SOUND  6 /* helper for add_sequence */
278
279 #define SEQ_EFFECT              8
280 #define SEQ_CROSS               8
281 #define SEQ_ADD                 9
282 #define SEQ_SUB                 10
283 #define SEQ_ALPHAOVER   11
284 #define SEQ_ALPHAUNDER  12
285 #define SEQ_GAMCROSS    13
286 #define SEQ_MUL                 14
287 #define SEQ_OVERDROP    15
288 #define SEQ_PLUGIN              24
289 #define SEQ_WIPE                25
290 #define SEQ_GLOW                26
291 #define SEQ_TRANSFORM           27
292 #define SEQ_COLOR               28
293 #define SEQ_SPEED               29
294 #define SEQ_EFFECT_MAX          29
295
296 #define STRIPELEM_FAILED       0
297 #define STRIPELEM_OK           1
298
299 #define STRIPELEM_PREVIEW_DONE  1
300
301 #define SEQ_BLEND_REPLACE      0
302 /* all other BLEND_MODEs are simple SEQ_EFFECT ids and therefore identical
303    to the table above. (Only those effects that handle _exactly_ two inputs,
304    otherwise, you can't really blend, right :) !)
305 */
306
307 #endif
308