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