1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
|
/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file DNA_sequence_types.h
* \ingroup DNA
* \since mar-2001
* \author nzc
*
* Structs for use by the 'Sequencer' (Video Editor)
*
* Note on terminology
* - #Sequence: video/effect/audio data you can select and manipulate in the sequencer.
* - #Sequence.machine: Strange name for the channel.
* - #Strip: The data referenced by the #Sequence
* - Meta Strip (SEQ_TYPE_META): Support for nesting Sequences.
*/
#ifndef __DNA_SEQUENCE_TYPES_H__
#define __DNA_SEQUENCE_TYPES_H__
#include "DNA_defs.h"
#include "DNA_color_types.h"
#include "DNA_listBase.h"
#include "DNA_vec_types.h"
struct Ipo;
struct Scene;
struct bSound;
struct MovieClip;
/* strlens; 256= FILE_MAXFILE, 768= FILE_MAXDIR */
typedef struct StripAnim {
struct StripAnim *next, *prev;
struct anim *anim;
} StripAnim;
typedef struct StripElem {
char name[256];
int orig_width, orig_height;
} StripElem;
typedef struct StripCrop {
int top;
int bottom;
int left;
int right;
} StripCrop;
typedef struct StripTransform {
int xofs;
int yofs;
} StripTransform;
typedef struct StripColorBalance {
float lift[3];
float gamma[3];
float gain[3];
int flag;
int pad;
// float exposure;
// float saturation;
} StripColorBalance;
typedef struct StripProxy {
char dir[768]; // custom directory for index and proxy files
// (defaults to BL_proxy)
char file[256]; // custom file
struct anim *anim; // custom proxy anim file
short tc; // time code in use
short quality; // proxy build quality
short build_size_flags; // size flags (see below) of all proxies
// to build
short build_tc_flags; // time code flags (see below) of all tc indices
// to build
short build_flags;
char storage;
char pad[5];
} StripProxy;
typedef struct Strip {
struct Strip *next, *prev;
int us, done;
int startstill, endstill;
StripElem *stripdata; /* only used as an array in IMAGE sequences(!),
* and as a 1-element array in MOVIE sequences,
* NULL for all other strip-types */
char dir[768];
StripProxy *proxy;
StripCrop *crop;
StripTransform *transform;
StripColorBalance *color_balance DNA_DEPRECATED;
/* color management */
ColorManagedColorspaceSettings colorspace_settings;
} Strip;
/**
* The sequence structure is the basic struct used by any strip.
* each of the strips uses a different sequence structure.
*
* \warning The first part identical to ID (for use in ipo's)
* the comment above is historic, probably we can drop the ID compatibility,
* but take care making this change.
*
* \warning This is really a 'Strip' in the UI!, name is highly confusing.
*/
typedef struct Sequence {
struct Sequence *next, *prev;
void *tmp; /* tmp var for copying, and tagging for linked selection */
void *lib; /* needed (to be like ipo), else it will raise libdata warnings, this should never be used */
char name[64]; /* SEQ_NAME_MAXSTR - name, set by default and needs to be unique, for RNA paths */
int flag, type; /*flags bitmap (see below) and the type of sequence*/
int len; /* the length of the contents of this strip - before handles are applied */
int start; /* start frame of contents of strip in absolute frame coordinates. For metastrips start of first strip startdisp */
int startofs, endofs; /* frames after the first frame where display starts, frames before the last frame where display ends */
int startstill, endstill; /* frames that use the first frame before data begins, frames that use the last frame after data ends */
int machine, depth; /*machine - the strip channel, depth - the depth in the sequence when dealing with metastrips */
int startdisp, enddisp; /* starting and ending points of the strip in the sequence*/
float sat;
float mul, handsize;
short anim_preseek;
short streamindex; /* streamindex for movie or sound files with several streams */
int multicam_source; /* for multicam source selection */
int clip_flag; /* MOVIECLIP render flags */
Strip *strip;
struct Ipo *ipo DNA_DEPRECATED; /* old animation system, deprecated for 2.5 */
/** these ID vars should never be NULL but can be when linked libs fail to load,
* so check on access */
struct Scene *scene;
struct Object *scene_camera; /* override scene camera */
struct MovieClip *clip; /* for MOVIECLIP strips */
struct Mask *mask; /* for MASK strips */
ListBase anims; /* for MOVIE strips */
float effect_fader;
float speed_fader;
/* pointers for effects: */
struct Sequence *seq1, *seq2, *seq3;
ListBase seqbase; /* list of strips for metastrips */
struct bSound *sound; /* the linked "bSound" object */
void *scene_sound;
float volume;
float pitch, pan; /* pitch (-0.1..10), pan -2..2 */
float strobe;
void *effectdata; /* Struct pointer for effect settings */
int anim_startofs; /* only use part of animation file */
int anim_endofs; /* is subtle different to startofs / endofs */
int blend_mode;
float blend_opacity;
/* is sfra needed anymore? - it looks like its only used in one place */
int sfra; /* starting frame according to the timeline of the scene. */
char alpha_mode;
char pad[2];
/* Multiview */
char views_format;
struct Stereo3dFormat *stereo3d_format;
struct IDProperty *prop;
/* modifiers */
ListBase modifiers;
} Sequence;
typedef struct MetaStack {
struct MetaStack *next, *prev;
ListBase *oldbasep;
Sequence *parseq;
/* the startdisp/enddisp when entering the meta */
int disp_range[2];
} MetaStack;
typedef struct Editing {
ListBase *seqbasep; /* pointer to the current list of seq's being edited (can be within a meta strip) */
ListBase seqbase; /* pointer to the top-most seq's */
ListBase metastack;
/* Context vars, used to be static */
Sequence *act_seq;
char act_imagedir[1024]; /* 1024 = FILE_MAX */
char act_sounddir[1024]; /* 1024 = FILE_MAX */
char proxy_dir[1024]; /* 1024 = FILE_MAX */
int over_ofs, over_cfra;
int over_flag, proxy_storage;
rctf over_border;
} Editing;
/* ************* Effect Variable Structs ********* */
typedef struct WipeVars {
float edgeWidth, angle;
short forward, wipetype;
} WipeVars;
typedef struct GlowVars {
float fMini; /* Minimum intensity to trigger a glow */
float fClamp;
float fBoost; /* Amount to multiply glow intensity */
float dDist; /* Radius of glow blurring */
int dQuality;
int bNoComp; /* SHOW/HIDE glow buffer */
} GlowVars;
typedef struct TransformVars {
float ScalexIni;
float ScaleyIni;
float xIni;
float yIni;
float rotIni;
int percent;
int interpolation;
int uniform_scale; /* preserve aspect/ratio when scaling */
} TransformVars;
typedef struct SolidColorVars {
float col[3];
float pad;
} SolidColorVars;
typedef struct SpeedControlVars {
float *frameMap;
float globalSpeed;
int flags;
int length;
int lastValidFrame;
} SpeedControlVars;
typedef struct GaussianBlurVars {
float size_x;
float size_y;
} GaussianBlurVars;
typedef struct TextVars {
char text[512];
int text_size;
float color[4], shadow_color[4];
float loc[2];
float wrap_width;
char flag;
char align, align_y;
char pad[5];
} TextVars;
/* TextVars.flag */
enum {
SEQ_TEXT_SHADOW = (1 << 0),
};
/* TextVars.align */
enum {
SEQ_TEXT_ALIGN_X_LEFT = 0,
SEQ_TEXT_ALIGN_X_CENTER = 1,
SEQ_TEXT_ALIGN_X_RIGHT = 2,
};
/* TextVars.align_y */
enum {
SEQ_TEXT_ALIGN_Y_TOP = 0,
SEQ_TEXT_ALIGN_Y_CENTER = 1,
SEQ_TEXT_ALIGN_Y_BOTTOM = 2,
};
typedef struct ColorMixVars {
int blend_effect; /* value from SEQ_TYPE_XXX enumeration */
float factor; /* blend factor [0.0f, 1.0f] */
} ColorMixVars;
/* ***************** Sequence modifiers ****************** */
typedef struct SequenceModifierData {
struct SequenceModifierData *next, *prev;
int type, flag;
char name[64]; /* MAX_NAME */
/* mask input, either sequence or mask ID */
int mask_input_type;
int mask_time;
struct Sequence *mask_sequence;
struct Mask *mask_id;
} SequenceModifierData;
typedef struct ColorBalanceModifierData {
SequenceModifierData modifier;
StripColorBalance color_balance;
float color_multiply;
} ColorBalanceModifierData;
typedef struct CurvesModifierData {
SequenceModifierData modifier;
struct CurveMapping curve_mapping;
} CurvesModifierData;
typedef struct HueCorrectModifierData {
SequenceModifierData modifier;
struct CurveMapping curve_mapping;
} HueCorrectModifierData;
typedef struct BrightContrastModifierData {
SequenceModifierData modifier;
float bright;
float contrast;
} BrightContrastModifierData;
typedef struct SequencerMaskModifierData {
SequenceModifierData modifier;
} SequencerMaskModifierData;
typedef struct WhiteBalanceModifierData {
SequenceModifierData modifier;
float white_value[3];
float pad;
} WhiteBalanceModifierData;
typedef struct SequencerTonemapModifierData {
SequenceModifierData modifier;
float key, offset, gamma;
float intensity, contrast, adaptation, correction;
int type;
} SequencerTonemapModifierData;
enum {
SEQ_TONEMAP_RH_SIMPLE = 0,
SEQ_TONEMAP_RD_PHOTORECEPTOR = 1,
};
/* ***************** Scopes ****************** */
typedef struct SequencerScopes {
struct ImBuf *reference_ibuf;
struct ImBuf *zebra_ibuf;
struct ImBuf *waveform_ibuf;
struct ImBuf *sep_waveform_ibuf;
struct ImBuf *vector_ibuf;
struct ImBuf *histogram_ibuf;
} SequencerScopes;
#define MAXSEQ 32
#define SELECT 1
/* Editor->over_flag */
#define SEQ_EDIT_OVERLAY_SHOW 1
#define SEQ_EDIT_OVERLAY_ABS 2
#define SEQ_STRIP_OFSBOTTOM 0.2f
#define SEQ_STRIP_OFSTOP 0.8f
/* Editor->proxy_storage */
/* store proxies in project directory */
#define SEQ_EDIT_PROXY_DIR_STORAGE 1
/* SpeedControlVars->flags */
#define SEQ_SPEED_INTEGRATE 1
/* #define SEQ_SPEED_BLEND 2 */ /* DEPRECATED */
#define SEQ_SPEED_COMPRESS_IPO_Y 4
/* ***************** SEQUENCE ****************** */
#define SEQ_NAME_MAXSTR 64
/* seq->flag */
enum {
SEQ_LEFTSEL = (1 << 1),
SEQ_RIGHTSEL = (1 << 2),
SEQ_OVERLAP = (1 << 3),
SEQ_FILTERY = (1 << 4),
SEQ_MUTE = (1 << 5),
#ifdef DNA_DEPRECATED
SEQ_MAKE_PREMUL = (1 << 6), /* deprecated, used for compatibility code only */
#endif
SEQ_REVERSE_FRAMES = (1 << 7),
SEQ_IPO_FRAME_LOCKED = (1 << 8),
SEQ_EFFECT_NOT_LOADED = (1 << 9),
SEQ_FLAG_DELETE = (1 << 10),
SEQ_FLIPX = (1 << 11),
SEQ_FLIPY = (1 << 12),
SEQ_MAKE_FLOAT = (1 << 13),
SEQ_LOCK = (1 << 14),
SEQ_USE_PROXY = (1 << 15),
SEQ_USE_TRANSFORM = (1 << 16),
SEQ_USE_CROP = (1 << 17),
/* SEQ_USE_COLOR_BALANCE = (1 << 18), */ /* DEPRECATED */
/* SEQ_USE_PROXY_CUSTOM_DIR = (1 << 19), */ /* DEPRECATED */
/* SEQ_USE_PROXY_CUSTOM_FILE = (1 << 21), */ /* DEPRECATED */
SEQ_USE_EFFECT_DEFAULT_FADE = (1 << 22),
SEQ_USE_LINEAR_MODIFIERS = (1 << 23),
/* flags for whether those properties are animated or not */
SEQ_AUDIO_VOLUME_ANIMATED = (1 << 24),
SEQ_AUDIO_PITCH_ANIMATED = (1 << 25),
SEQ_AUDIO_PAN_ANIMATED = (1 << 26),
SEQ_AUDIO_DRAW_WAVEFORM = (1 << 27),
/* don't include Grease Pencil in OpenGL previews of Scene strips */
SEQ_SCENE_NO_GPENCIL = (1 << 28),
SEQ_USE_VIEWS = (1 << 29),
/* access scene strips directly (like a metastrip) */
SEQ_SCENE_STRIPS = (1 << 30),
SEQ_INVALID_EFFECT = (1u << 31),
};
/* StripProxy->storage */
enum {
SEQ_STORAGE_PROXY_CUSTOM_FILE = (1 << 1), /* store proxy in custom directory */
SEQ_STORAGE_PROXY_CUSTOM_DIR = (1 << 2), /* store proxy in custom file */
};
/* convenience define for all selection flags */
#define SEQ_ALLSEL (SELECT + SEQ_LEFTSEL + SEQ_RIGHTSEL)
/* deprecated, don't use a flag anymore*/
/*#define SEQ_ACTIVE 1048576*/
#define SEQ_COLOR_BALANCE_INVERSE_GAIN 1
#define SEQ_COLOR_BALANCE_INVERSE_GAMMA 2
#define SEQ_COLOR_BALANCE_INVERSE_LIFT 4
/* !!! has to be same as IMB_imbuf.h IMB_PROXY_... and IMB_TC_... */
#define SEQ_PROXY_IMAGE_SIZE_25 1
#define SEQ_PROXY_IMAGE_SIZE_50 2
#define SEQ_PROXY_IMAGE_SIZE_75 4
#define SEQ_PROXY_IMAGE_SIZE_100 8
#define SEQ_PROXY_TC_NONE 0
#define SEQ_PROXY_TC_RECORD_RUN 1
#define SEQ_PROXY_TC_FREE_RUN 2
#define SEQ_PROXY_TC_INTERP_REC_DATE_FREE_RUN 4
#define SEQ_PROXY_TC_RECORD_RUN_NO_GAPS 8
#define SEQ_PROXY_TC_ALL 15
/* SeqProxy->build_flags */
enum {
SEQ_PROXY_SKIP_EXISTING = 1,
};
/* seq->alpha_mode */
enum {
SEQ_ALPHA_STRAIGHT = 0,
SEQ_ALPHA_PREMUL = 1
};
/* seq->type WATCH IT: SEQ_TYPE_EFFECT BIT is used to determine if this is an effect strip!!! */
enum {
SEQ_TYPE_IMAGE = 0,
SEQ_TYPE_META = 1,
SEQ_TYPE_SCENE = 2,
SEQ_TYPE_MOVIE = 3,
SEQ_TYPE_SOUND_RAM = 4,
SEQ_TYPE_SOUND_HD = 5,
SEQ_TYPE_MOVIECLIP = 6,
SEQ_TYPE_MASK = 7,
SEQ_TYPE_EFFECT = 8,
SEQ_TYPE_CROSS = 8,
SEQ_TYPE_ADD = 9,
SEQ_TYPE_SUB = 10,
SEQ_TYPE_ALPHAOVER = 11,
SEQ_TYPE_ALPHAUNDER = 12,
SEQ_TYPE_GAMCROSS = 13,
SEQ_TYPE_MUL = 14,
SEQ_TYPE_OVERDROP = 15,
/* SEQ_TYPE_PLUGIN = 24, */ /* Deprecated */
SEQ_TYPE_WIPE = 25,
SEQ_TYPE_GLOW = 26,
SEQ_TYPE_TRANSFORM = 27,
SEQ_TYPE_COLOR = 28,
SEQ_TYPE_SPEED = 29,
SEQ_TYPE_MULTICAM = 30,
SEQ_TYPE_ADJUSTMENT = 31,
SEQ_TYPE_GAUSSIAN_BLUR = 40,
SEQ_TYPE_TEXT = 41,
SEQ_TYPE_COLORMIX = 42,
/* Blend modes */
SEQ_TYPE_SCREEN = 43,
SEQ_TYPE_LIGHTEN = 44,
SEQ_TYPE_DODGE = 45,
SEQ_TYPE_DARKEN = 46,
SEQ_TYPE_BURN = 47,
SEQ_TYPE_LINEAR_BURN = 48,
SEQ_TYPE_OVERLAY = 49,
SEQ_TYPE_HARD_LIGHT = 50,
SEQ_TYPE_SOFT_LIGHT = 51,
SEQ_TYPE_PIN_LIGHT = 52,
SEQ_TYPE_LIN_LIGHT = 53,
SEQ_TYPE_VIVID_LIGHT = 54,
SEQ_TYPE_HUE = 55,
SEQ_TYPE_SATURATION = 56,
SEQ_TYPE_VALUE = 57,
SEQ_TYPE_BLEND_COLOR = 58,
SEQ_TYPE_DIFFERENCE = 59,
SEQ_TYPE_EXCLUSION = 60,
SEQ_TYPE_MAX = 60
};
#define SEQ_MOVIECLIP_RENDER_UNDISTORTED (1 << 0)
#define SEQ_MOVIECLIP_RENDER_STABILIZED (1 << 1)
#define SEQ_BLEND_REPLACE 0
/* all other BLEND_MODEs are simple SEQ_TYPE_EFFECT ids and therefore identical
* to the table above. (Only those effects that handle _exactly_ two inputs,
* otherwise, you can't really blend, right :) !)
*/
#define SEQ_HAS_PATH(_seq) (ELEM((_seq)->type, SEQ_TYPE_MOVIE, SEQ_TYPE_IMAGE, SEQ_TYPE_SOUND_RAM, SEQ_TYPE_SOUND_HD))
/* modifiers */
/* SequenceModifierData->type */
enum {
seqModifierType_ColorBalance = 1,
seqModifierType_Curves = 2,
seqModifierType_HueCorrect = 3,
seqModifierType_BrightContrast = 4,
seqModifierType_Mask = 5,
seqModifierType_WhiteBalance = 6,
seqModifierType_Tonemap = 7,
NUM_SEQUENCE_MODIFIER_TYPES
};
/* SequenceModifierData->flag */
enum {
SEQUENCE_MODIFIER_MUTE = (1 << 0),
SEQUENCE_MODIFIER_EXPANDED = (1 << 1),
};
enum {
SEQUENCE_MASK_INPUT_STRIP = 0,
SEQUENCE_MASK_INPUT_ID = 1
};
enum {
/* Mask animation will be remapped relative to the strip start frame. */
SEQUENCE_MASK_TIME_RELATIVE = 0,
/* Global (scene) frame number will be used to access the mask. */
SEQUENCE_MASK_TIME_ABSOLUTE = 1,
};
#endif /* __DNA_SEQUENCE_TYPES_H__ */
|