2.50:
[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 } 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         struct ImBuf *ibuf_startstill;
100         struct ImBuf *ibuf_endstill;
101 } Strip;
102
103
104 typedef struct PluginSeq {
105         char name[256];
106         void *handle;
107
108         char *pname;
109
110         int vars, version;
111
112         void *varstr;
113         float *cfra;
114
115         float data[32];
116
117         void *instance_private_data;
118         void **current_private_data;
119
120         void (*doit)(void);
121
122         void (*callback)(void);
123 } PluginSeq;
124
125 /* The sequence structure is the basic struct used by any strip. each of the strips uses a different sequence structure.*/
126 /* WATCH IT: first part identical to ID (for use in ipo's) */
127
128 typedef struct Sequence {
129         struct Sequence *next, *prev;
130         void *tmp; /* tmp var for copying, and tagging for linked selection */
131         void *lib; /* needed (to be like ipo), else it will raise libdata warnings, this should never be used */
132         char name[24]; /* name, not set by default and dosnt need to be unique as with ID's */
133
134         int flag, type; /*flags bitmap (see below) and the type of sequence*/
135         int len; /* the length of the contense of this strip - before handles are applied */
136         int start, startofs, endofs;
137         int startstill, endstill;
138         int machine, depth; /*machine - the strip channel, depth - the depth in the sequence when dealing with metastrips */
139         int startdisp, enddisp; /*starting and ending points in the sequence*/
140         float mul, handsize;
141                                         /* is sfra needed anymore? - it looks like its only used in one place */
142         int sfra;               /* starting frame according to the timeline of the scene. */
143         int anim_preseek;
144
145         Strip *strip;
146
147         struct Ipo *ipo;
148         struct Scene *scene;
149         struct anim *anim;
150         float facf0, facf1;
151
152         PluginSeq *plugin;
153
154         /* pointers for effects: */
155         struct Sequence *seq1, *seq2, *seq3;
156
157         ListBase seqbase;       /* list of strips for metastrips */
158
159         struct bSound *sound;   /* the linked "bSound" object */
160         struct hdaudio *hdaudio; /* external hdaudio object */
161         float level, pan;       /* level in dB (0=full), pan -1..1 */
162         int curpos;             /* last sample position in audio_fill() */
163         float strobe;
164
165         void *effectdata;       /* Struct pointer for effect settings */
166
167         int anim_startofs;    /* only use part of animation file */
168         int anim_endofs;      /* is subtle different to startofs / endofs */
169
170         int blend_mode;
171         float blend_opacity;
172
173         int scenenr;          /* for scene selection */
174         int pad;
175 } Sequence;
176
177 typedef struct MetaStack {
178         struct MetaStack *next, *prev;
179         ListBase *oldbasep;
180         Sequence *parseq;
181 } MetaStack;
182
183 typedef struct Editing {
184         ListBase *seqbasep;
185         ListBase seqbase;
186         ListBase metastack;
187         
188         /* Context vars, used to be static */
189         Sequence *act_seq;
190         char act_imagedir[256];
191         char act_sounddir[256];
192 } Editing;
193
194 /* ************* Effect Variable Structs ********* */
195 typedef struct WipeVars {
196         float edgeWidth,angle;
197         short forward, wipetype;
198 } WipeVars;
199
200 typedef struct GlowVars {       
201         float fMini;    /*      Minimum intensity to trigger a glow */
202         float fClamp;
203         float fBoost;   /*      Amount to multiply glow intensity */
204     float dDist;        /*      Radius of glow blurring */
205         int     dQuality;
206         int     bNoComp;        /*      SHOW/HIDE glow buffer */
207 } GlowVars;
208
209 typedef struct TransformVars {
210         float ScalexIni;
211         float ScaleyIni;
212         float ScalexFin;
213         float ScaleyFin;
214         float xIni;
215         float xFin;
216         float yIni;
217         float yFin;
218         float rotIni;
219         float rotFin;
220         int percent;
221         int interpolation;
222 } TransformVars;
223
224 typedef struct SolidColorVars {
225         float col[3];
226         float pad;
227 } SolidColorVars;
228
229 typedef struct SpeedControlVars {
230         float * frameMap;
231         float globalSpeed;
232         int flags;
233         int length;
234         int lastValidFrame;
235 } SpeedControlVars;
236
237 #define SEQ_STRIP_OFSBOTTOM             0.2f
238 #define SEQ_STRIP_OFSTOP                0.8f
239
240 /* SpeedControlVars->flags */
241 #define SEQ_SPEED_INTEGRATE      1
242 #define SEQ_SPEED_BLEND          2
243 #define SEQ_SPEED_COMPRESS_IPO_Y 4
244
245 /* ***************** SEQUENCE ****************** */
246
247 /* seq->flag */
248 #define SEQ_LEFTSEL                             2
249 #define SEQ_RIGHTSEL                    4
250 #define SEQ_OVERLAP                             8
251 #define SEQ_FILTERY                             16
252 #define SEQ_MUTE                                32
253 #define SEQ_MAKE_PREMUL                 64
254 #define SEQ_REVERSE_FRAMES              128
255 #define SEQ_IPO_FRAME_LOCKED    256
256 #define SEQ_EFFECT_NOT_LOADED   512
257 #define SEQ_FLAG_DELETE                 1024
258 #define SEQ_FLIPX                               2048
259 #define SEQ_FLIPY                               4096
260 #define SEQ_MAKE_FLOAT                          8192
261 #define SEQ_LOCK                                16384
262 #define SEQ_USE_PROXY                           32768
263 #define SEQ_USE_TRANSFORM                       65536
264 #define SEQ_USE_CROP                           131072
265 #define SEQ_USE_COLOR_BALANCE                  262144
266 #define SEQ_USE_PROXY_CUSTOM_DIR               524288
267 #define SEQ_USE_PROXY_CUSTOM_FILE             2097152
268
269 /* deprecated, dont use a flag anymore*/
270 /*#define SEQ_ACTIVE                            1048576*/
271
272 #define SEQ_COLOR_BALANCE_INVERSE_GAIN 1
273 #define SEQ_COLOR_BALANCE_INVERSE_GAMMA 2
274 #define SEQ_COLOR_BALANCE_INVERSE_LIFT 4
275
276 /* seq->type WATCH IT: SEQ_EFFECT BIT is used to determine if this is an effect strip!!! */
277 #define SEQ_IMAGE               0
278 #define SEQ_META                1
279 #define SEQ_SCENE               2
280 #define SEQ_MOVIE               3
281 #define SEQ_RAM_SOUND           4
282 #define SEQ_HD_SOUND            5
283 #define SEQ_MOVIE_AND_HD_SOUND  6 /* helper for add_sequence */
284
285 #define SEQ_EFFECT              8
286 #define SEQ_CROSS               8
287 #define SEQ_ADD                 9
288 #define SEQ_SUB                 10
289 #define SEQ_ALPHAOVER   11
290 #define SEQ_ALPHAUNDER  12
291 #define SEQ_GAMCROSS    13
292 #define SEQ_MUL                 14
293 #define SEQ_OVERDROP    15
294 #define SEQ_PLUGIN              24
295 #define SEQ_WIPE                25
296 #define SEQ_GLOW                26
297 #define SEQ_TRANSFORM           27
298 #define SEQ_COLOR               28
299 #define SEQ_SPEED               29
300 #define SEQ_EFFECT_MAX          29
301
302 #define STRIPELEM_FAILED       0
303 #define STRIPELEM_OK           1
304
305 #define STRIPELEM_PREVIEW_DONE  1
306
307 #define SEQ_BLEND_REPLACE      0
308 /* all other BLEND_MODEs are simple SEQ_EFFECT ids and therefore identical
309    to the table above. (Only those effects that handle _exactly_ two inputs,
310    otherwise, you can't really blend, right :) !)
311 */
312
313 #endif
314