== 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/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 TStripElem *se1, *se2, *se3;
54         short ok;
55         short pad;
56         int nr;
57 } TStripElem;
58
59 typedef struct Strip {
60         struct Strip *next, *prev;
61         int rt, len, us, done;
62         StripElem *stripdata;
63         char dir[160];
64         int orx, ory;
65         TStripElem *tstripdata;
66 } Strip;
67
68
69 typedef struct PluginSeq {
70         char name[256];
71         void *handle;
72
73         char *pname;
74
75         int vars, version;
76
77         void *varstr;
78         float *cfra;
79
80         float data[32];
81
82         void *instance_private_data;
83         void **current_private_data;
84
85         void (*doit)(void);
86
87         void (*callback)(void);
88 } PluginSeq;
89
90 /* The sequence structure is the basic struct used by any strip. each of the strips uses a different sequence structure.*/
91 /* WATCH IT: first part identical to ID (for use in ipo's) */
92
93 typedef struct Sequence {
94         struct Sequence *next, *prev;
95         void *tmp; /* tmp var for copying, and tagging for linked selection */
96         void *lib; /* needed (to be like ipo), else it will raise libdata warnings, this should never be used */
97         char name[24]; /* name, not set by default and dosnt need to be unique as with ID's */
98
99         short flag, type;       /*flags bitmap (see below) and the type of sequence*/
100         int len; /* the length of the contense of this strip - before handles are applied */
101         int start, startofs, endofs;
102         int startstill, endstill;
103         int machine, depth; /*machine - the strip channel, depth - the depth in the sequence when dealing with metastrips */
104         int startdisp, enddisp; /*starting and ending points in the sequence*/
105         float mul, handsize;
106                                         /* is sfra needed anymore? - it looks like its only used in one place */
107         int sfra;               /* starting frame according to the timeline of the scene. */
108
109         Strip *strip;
110
111         struct Ipo *ipo;
112         struct Scene *scene;
113         struct anim *anim;
114         float facf0, facf1;
115
116         PluginSeq *plugin;
117
118         /* pointers for effects: */
119         struct Sequence *seq1, *seq2, *seq3;
120
121         ListBase seqbase;       /* list of strips for metastrips */
122
123         struct bSound *sound;   /* the linked "bSound" object */
124         struct hdaudio *hdaudio; /* external hdaudio object */
125         float level, pan;       /* level in dB (0=full), pan -1..1 */
126         int curpos;             /* last sample position in audio_fill() */
127         float strobe;
128
129         void *effectdata;       /* Struct pointer for effect settings */
130
131         int anim_preseek;
132         int pad;
133 } Sequence;
134
135 typedef struct MetaStack {
136         struct MetaStack *next, *prev;
137         ListBase *oldbasep;
138         Sequence *parseq;
139 } MetaStack;
140
141 typedef struct Editing {
142         ListBase *seqbasep;
143         ListBase seqbase;
144         ListBase metastack;
145         short flag;
146         short pad;
147         int rt;
148 } Editing;
149
150 /* ************* Effect Variable Structs ********* */
151 typedef struct WipeVars {
152         float edgeWidth,angle;
153         short forward, wipetype;
154 } WipeVars;
155
156 typedef struct GlowVars {       
157         float fMini;    /*      Minimum intensity to trigger a glow */
158         float fClamp;
159         float fBoost;   /*      Amount to multiply glow intensity */
160     float dDist;        /*      Radius of glow blurring */
161         int     dQuality;
162         int     bNoComp;        /*      SHOW/HIDE glow buffer */
163 } GlowVars;
164
165 typedef struct TransformVars {
166         float ScalexIni;
167         float ScaleyIni;
168         float ScalexFin;
169         float ScaleyFin;
170         float xIni;
171         float xFin;
172         float yIni;
173         float yFin;
174         float rotIni;
175         float rotFin;
176         int percent;
177         int interpolation;
178 } TransformVars;
179
180 typedef struct SolidColorVars {
181         float col[3];
182         float pad;
183 } SolidColorVars;
184
185 typedef struct SpeedControlVars {
186         float * frameMap;
187         float globalSpeed;
188         int flags;
189         int length;
190         int lastValidFrame;
191 } SpeedControlVars;
192
193 /* SpeedControlVars->flags */
194 #define SEQ_SPEED_INTEGRATE      1
195 #define SEQ_SPEED_BLEND          2
196 #define SEQ_SPEED_COMPRESS_IPO_Y 4
197
198 /* ***************** SEQUENCE ****************** */
199
200 /* seq->flag */
201 #define SEQ_LEFTSEL                             2
202 #define SEQ_RIGHTSEL                    4
203 #define SEQ_OVERLAP                             8
204 #define SEQ_FILTERY                             16
205 #define SEQ_MUTE                                32
206 #define SEQ_MAKE_PREMUL                 64
207 #define SEQ_REVERSE_FRAMES              128
208 #define SEQ_IPO_FRAME_LOCKED    256
209 #define SEQ_EFFECT_NOT_LOADED   512
210 #define SEQ_FLAG_DELETE                 1024
211 #define SEQ_FLIPX                               2048
212 #define SEQ_FLIPY                               4096
213
214 /* seq->type WATCH IT: SEQ_EFFECT BIT is used to determine if this is an effect strip!!! */
215 #define SEQ_IMAGE               0
216 #define SEQ_META                1
217 #define SEQ_SCENE               2
218 #define SEQ_MOVIE               3
219 #define SEQ_RAM_SOUND           4
220 #define SEQ_HD_SOUND            5
221 #define SEQ_MOVIE_AND_HD_SOUND  6 /* helper for add_sequence */
222
223 #define SEQ_EFFECT              8
224 #define SEQ_CROSS               8
225 #define SEQ_ADD                 9
226 #define SEQ_SUB                 10
227 #define SEQ_ALPHAOVER   11
228 #define SEQ_ALPHAUNDER  12
229 #define SEQ_GAMCROSS    13
230 #define SEQ_MUL                 14
231 #define SEQ_OVERDROP    15
232 #define SEQ_PLUGIN              24
233 #define SEQ_WIPE                25
234 #define SEQ_GLOW                26
235 #define SEQ_TRANSFORM           27
236 #define SEQ_COLOR               28
237 #define SEQ_SPEED               29
238
239 #define STRIPELEM_FAILED       0
240 #define STRIPELEM_OK           1
241 #define STRIPELEM_META         2
242
243 #endif
244