DNA_sequence_types.h

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2001-2002 NaN Holding BV. All rights reserved.
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */
 
#pragma once
 
#include "DNA_color_types.h"
#include "DNA_defs.h"
#include "DNA_listBase.h"
#include "DNA_session_uid_types.h" /* for #SessionUID */
#include "DNA_vec_types.h"         /* for #rctf */
 
struct Ipo;
struct MovieClip;
struct Scene;
struct SequenceLookup;
struct VFont;
struct bSound;
 
#ifdef __cplusplus
namespace blender::seq {
struct MediaPresence;
struct ThumbnailCache;
}  // namespace blender::seq
using MediaPresence = blender::seq::MediaPresence;
using ThumbnailCache = blender::seq::ThumbnailCache;
#else
typedef struct MediaPresence MediaPresence;
typedef struct ThumbnailCache ThumbnailCache;
#endif
 
/* -------------------------------------------------------------------- */
 
/* strlens; 256= FILE_MAXFILE, 768= FILE_MAXDIR */
 
typedef struct StripAnim {
  struct StripAnim *next, *prev;
  struct ImBufAnim *anim;
} StripAnim;
 
typedef struct StripElem {
  char filename[256];
  int orig_width, orig_height;
  float orig_fps;
} StripElem;
 
typedef struct StripCrop {
  int top;
  int bottom;
  int left;
  int right;
} StripCrop;
 
typedef struct StripTransform {
  float xofs;
  float yofs;
  float scale_x;
  float scale_y;
  float rotation;
  float origin[2];
  int filter;
} StripTransform;
 
typedef struct StripColorBalance {
  int method;
  float lift[3];
  float gamma[3];
  float gain[3];
  float slope[3];
  float offset[3];
  float power[3];
  int flag;
  char _pad[4];
  // float exposure;
  // float saturation;
} StripColorBalance;
 
typedef struct StripProxy {
  char dirpath[768];
  char filename[256];
  struct ImBufAnim *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;
  char dirpath[768];
  StripProxy *proxy;
  StripCrop *crop;
  StripTransform *transform;
  StripColorBalance *color_balance DNA_DEPRECATED;
 
  /* color management */
  ColorManagedColorspaceSettings colorspace_settings;
} Strip;
 
typedef enum eSeqRetimingKeyFlag {
  SEQ_SPEED_TRANSITION_IN = (1 << 0),
  SEQ_SPEED_TRANSITION_OUT = (1 << 1),
  SEQ_FREEZE_FRAME_IN = (1 << 2),
  SEQ_FREEZE_FRAME_OUT = (1 << 3),
  SEQ_KEY_SELECTED = (1 << 4),
} eSeqRetimingKeyFlag;
 
typedef struct SeqRetimingKey {
  double strip_frame_index;
  int flag; /* eSeqRetimingKeyFlag */
  int _pad0;
  float retiming_factor; /* Value between 0-1 mapped to original content range. */
 
  char _pad1[4];
  double original_strip_frame_index; /* Used for transition keys only. */
  float original_retiming_factor;    /* Used for transition keys only. */
  char _pad2[4];
} SeqRetimingKey;
 
typedef struct SequenceRuntime {
  SessionUID session_uid;
} SequenceRuntime;

typedef struct Sequence {
  struct Sequence *next, *prev;
  void *tmp;
  void *lib;
  char name[64];

  int flag, type;
  int len;
  float start;
  float startofs, endofs;
  float startstill, endstill;
  int machine;
  int startdisp, enddisp;
  float sat;
  float mul;

  short streamindex;
  short _pad;
  int multicam_source;
  int clip_flag;
 
  Strip *strip;

  struct Ipo *ipo DNA_DEPRECATED;

  struct Scene *scene;
  struct Object *scene_camera;
  struct MovieClip *clip;
  struct Mask *mask;
  ListBase anims;
 
  float effect_fader;
  /* DEPRECATED, only used for versioning. */
  float speed_fader;
 
  /* pointers for effects: */
  struct Sequence *seq1, *seq2;
 
  /* This strange padding is needed due to how seqbasep deserialization is
   * done right now in #scene_blend_read_data. */
  void *_pad7;
  int _pad8[2];

  ListBase seqbase;
  ListBase channels; /* SeqTimelineChannel */
 
  /* List of strip connections (one-way, not bidirectional). */
  ListBase connections; /* SeqConnection */

  struct bSound *sound;
  void *scene_sound;
  float volume;

  float pitch DNA_DEPRECATED, pan;
  float strobe;
 
  float sound_offset;
  char _pad4[4];

  void *effectdata;

  int anim_startofs;
  int anim_endofs;
 
  int blend_mode;
  float blend_opacity;
 
  /* Tag color showed if `SEQ_TIMELINE_SHOW_STRIP_COLOR_TAG` is set. */
  int8_t color_tag;
 
  char alpha_mode;
  char _pad2[2];
 
  int cache_flag;
 
  /* is sfra needed anymore? - it looks like its only used in one place */
  int sfra;
 
  /* Multiview */
  char views_format;
  char _pad3[3];
  struct Stereo3dFormat *stereo3d_format;
 
  struct IDProperty *prop;
 
  /* modifiers */
  ListBase modifiers;
 
  /* Playback rate of strip content in frames per second. */
  float media_playback_rate;
  float speed_factor;
 
  struct SeqRetimingKey *retiming_keys;
  void *_pad5;
  int retiming_keys_num;
  char _pad6[4];
 
  SequenceRuntime runtime;
} Sequence;
 
typedef struct MetaStack {
  struct MetaStack *next, *prev;
  ListBase *oldbasep;
  ListBase *old_channels;
  Sequence *parseq;
  /* the startdisp/enddisp when entering the meta */
  int disp_range[2];
} MetaStack;
 
typedef struct SeqTimelineChannel {
  struct SeqTimelineChannel *next, *prev;
  char name[64];
  int index;
  int flag;
} SeqTimelineChannel;
 
typedef struct SeqConnection {
  struct SeqConnection *next, *prev;
  Sequence *seq_ref;
} SeqConnection;
 
typedef struct EditingRuntime {
  struct SequenceLookup *sequence_lookup;
  MediaPresence *media_presence;
  ThumbnailCache *thumbnail_cache;
  void *_pad;
} EditingRuntime;
 
typedef struct Editing {
  ListBase *seqbasep;
  ListBase *displayed_channels;
  void *_pad0;
  ListBase seqbase;
  ListBase metastack;
  ListBase channels; /* SeqTimelineChannel */
 
  /* Context vars, used to be static */
  Sequence *act_seq;
  char act_imagedir[1024];
  char act_sounddir[1024];
  char proxy_dir[1024];
 
  int proxy_storage;
 
  int overlay_frame_ofs, overlay_frame_abs;
  int overlay_frame_flag;
  rctf overlay_frame_rect;
 
  int show_missing_media_flag;
  int _pad1;
 
  struct SeqCache *cache;
 
  /* Cache control */
  float recycle_max_cost; /* UNUSED only for versioning. */
  int cache_flag;
 
  struct PrefetchJob *prefetch_job;
 
  /* Must be initialized only by seq_cache_create() */
  int64_t disk_cache_timestamp;
 
  EditingRuntime runtime;
} Editing;

 
/* -------------------------------------------------------------------- */
 
typedef struct WipeVars {
  float edgeWidth, angle;
  short forward, wipetype;
} WipeVars;
 
typedef struct GlowVars {
  float fMini;
  float fClamp;
  float fBoost;
  float dDist;
  int dQuality;
  int bNoComp;
} GlowVars;
 
typedef struct TransformVars {
  float ScalexIni;
  float ScaleyIni;
  float xIni;
  float yIni;
  float rotIni;
  int percent;
  int interpolation;
  int uniform_scale;
} TransformVars;
 
typedef struct SolidColorVars {
  float col[3];
  char _pad[4];
} SolidColorVars;
 
typedef struct SpeedControlVars {
  float *frameMap;
  /* DEPRECATED, only used for versioning. */
  float globalSpeed;
  int flags;
 
  int speed_control_type;
 
  float speed_fader;
  float speed_fader_length;
  float speed_fader_frame_number;
} SpeedControlVars;

enum {
  SEQ_SPEED_STRETCH = 0,
  SEQ_SPEED_MULTIPLY = 1,
  SEQ_SPEED_LENGTH = 2,
  SEQ_SPEED_FRAME_NUMBER = 3,
};
 
typedef struct GaussianBlurVars {
  float size_x;
  float size_y;
} GaussianBlurVars;
 
typedef struct TextVars {
  char text[512];
  struct VFont *text_font;
  int text_blf_id;
  float text_size;
  float color[4], shadow_color[4], box_color[4], outline_color[4];
  float loc[2];
  float wrap_width;
  float box_margin;
  float shadow_angle;
  float shadow_offset;
  float shadow_blur;
  float outline_width;
  char flag;
  char align, align_y;
  char _pad[5];
} TextVars;

enum {
  SEQ_TEXT_SHADOW = (1 << 0),
  SEQ_TEXT_BOX = (1 << 1),
  SEQ_TEXT_BOLD = (1 << 2),
  SEQ_TEXT_ITALIC = (1 << 3),
  SEQ_TEXT_OUTLINE = (1 << 4),
};

enum {
  SEQ_TEXT_ALIGN_X_LEFT = 0,
  SEQ_TEXT_ALIGN_X_CENTER = 1,
  SEQ_TEXT_ALIGN_X_RIGHT = 2,
};

enum {
  SEQ_TEXT_ALIGN_Y_TOP = 0,
  SEQ_TEXT_ALIGN_Y_CENTER = 1,
  SEQ_TEXT_ALIGN_Y_BOTTOM = 2,
};
 
#define SEQ_FONT_NOT_LOADED -2
 
typedef struct ColorMixVars {
  int blend_effect;
  float factor;
} ColorMixVars;

 
/* -------------------------------------------------------------------- */
 
typedef struct SequenceModifierData {
  struct SequenceModifierData *next, *prev;
  int type, flag;
  char name[64];
 
  /* 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;
 
enum {
  SEQ_COLOR_BALANCE_METHOD_LIFTGAMMAGAIN = 0,
  SEQ_COLOR_BALANCE_METHOD_SLOPEOFFSETPOWER = 1,
};
 
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];
  char _pad[4];
} 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,
};


 
typedef struct EQCurveMappingData {
  struct EQCurveMappingData *next, *prev;
  struct CurveMapping curve_mapping;
} EQCurveMappingData;
 
typedef struct SoundEqualizerModifierData {
  SequenceModifierData modifier;
  /* EQCurveMappingData */
  ListBase graphics;
} SoundEqualizerModifierData;

 
/* -------------------------------------------------------------------- */

enum {
  SEQ_EDIT_OVERLAY_FRAME_SHOW = 1,
  SEQ_EDIT_OVERLAY_FRAME_ABS = 2,
};

enum {
  SEQ_EDIT_SHOW_MISSING_MEDIA = 1 << 0,
};
 
#define SEQ_STRIP_OFSBOTTOM 0.05f
#define SEQ_STRIP_OFSTOP 0.95f

enum {
  SEQ_EDIT_PROXY_DIR_STORAGE = 1,
};

enum {
  SEQ_SPEED_UNUSED_2 = 1 << 0, /* cleared */
  SEQ_SPEED_UNUSED_1 = 1 << 1, /* cleared */
  SEQ_SPEED_UNUSED_3 = 1 << 2, /* cleared */
  SEQ_SPEED_USE_INTERPOLATION = 1 << 3,
};
 
#define SEQ_NAME_MAXSTR 64
 
/* From: `DNA_object_types.h`, see it's doc-string there. */
#define SELECT 1

enum {
  /* `SELECT = (1 << 0)` */
  SEQ_LEFTSEL = (1 << 1),
  SEQ_RIGHTSEL = (1 << 2),
  SEQ_OVERLAP = (1 << 3),
  SEQ_FILTERY = (1 << 4),
  SEQ_MUTE = (1 << 5),
  /* SEQ_FLAG_SKIP_THUMBNAILS = (1 << 6), */ /* no longer used */
  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_IGNORE_CHANNEL_LOCK = (1 << 16),
  SEQ_AUTO_PLAYBACK_RATE = (1 << 17),
  SEQ_SINGLE_FRAME_CONTENT = (1 << 18),
  SEQ_SHOW_RETIMING = (1 << 19),
  SEQ_MULTIPLY_ALPHA = (1 << 21),
 
  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 Annotations in OpenGL previews of Scene strips */
  SEQ_SCENE_NO_ANNOTATION = (1 << 28),
  SEQ_USE_VIEWS = (1 << 29),
 
  /* Access scene strips directly (like a meta-strip). */
  SEQ_SCENE_STRIPS = (1 << 30),
 
  SEQ_INVALID_EFFECT = (1u << 31),
};

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
 
enum {
  SEQ_COLOR_BALANCE_INVERSE_GAIN = 1 << 0,
  SEQ_COLOR_BALANCE_INVERSE_GAMMA = 1 << 1,
  SEQ_COLOR_BALANCE_INVERSE_LIFT = 1 << 2,
  SEQ_COLOR_BALANCE_INVERSE_SLOPE = 1 << 3,
  SEQ_COLOR_BALANCE_INVERSE_OFFSET = 1 << 4,
  SEQ_COLOR_BALANCE_INVERSE_POWER = 1 << 5,
};

enum {
  SEQ_PROXY_IMAGE_SIZE_25 = 1 << 0,
  SEQ_PROXY_IMAGE_SIZE_50 = 1 << 1,
  SEQ_PROXY_IMAGE_SIZE_75 = 1 << 2,
  SEQ_PROXY_IMAGE_SIZE_100 = 1 << 3,
};

enum {
  SEQ_PROXY_TC_NONE = 0,
  SEQ_PROXY_TC_RECORD_RUN = 1 << 0,
  SEQ_PROXY_TC_RECORD_RUN_NO_GAPS = 1 << 1,
};

enum {
  SEQ_PROXY_SKIP_EXISTING = 1,
};

enum {
  SEQ_ALPHA_STRAIGHT = 0,
  SEQ_ALPHA_PREMUL = 1,
};

typedef enum SequenceType {
  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, /* DEPRECATED */
  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_COLOR_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,
} SequenceType;
 
enum {
  SEQ_MOVIECLIP_RENDER_UNDISTORTED = 1 << 0,
  SEQ_MOVIECLIP_RENDER_STABILIZED = 1 << 1,
};
 
enum {
  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 */

enum {
  seqModifierType_ColorBalance = 1,
  seqModifierType_Curves = 2,
  seqModifierType_HueCorrect = 3,
  seqModifierType_BrightContrast = 4,
  seqModifierType_Mask = 5,
  seqModifierType_WhiteBalance = 6,
  seqModifierType_Tonemap = 7,
  seqModifierType_SoundEqualizer = 8,
  /* Keep last. */
  NUM_SEQUENCE_MODIFIER_TYPES,
};

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,
};

enum {
  SEQ_CACHE_STORE_RAW = (1 << 0),
  SEQ_CACHE_STORE_PREPROCESSED = (1 << 1),
  SEQ_CACHE_STORE_COMPOSITE = (1 << 2),
  SEQ_CACHE_STORE_FINAL_OUT = (1 << 3),
 
  /* For lookup purposes */
  SEQ_CACHE_ALL_TYPES = SEQ_CACHE_STORE_RAW | SEQ_CACHE_STORE_PREPROCESSED |
                        SEQ_CACHE_STORE_COMPOSITE | SEQ_CACHE_STORE_FINAL_OUT,
 
  SEQ_CACHE_OVERRIDE = (1 << 4),
 
  SEQ_CACHE_UNUSED_5 = (1 << 5),
  SEQ_CACHE_UNUSED_6 = (1 << 6),
  SEQ_CACHE_UNUSED_7 = (1 << 7),
  SEQ_CACHE_UNUSED_8 = (1 << 8),
  SEQ_CACHE_UNUSED_9 = (1 << 9),
 
  SEQ_CACHE_PREFETCH_ENABLE = (1 << 10),
  SEQ_CACHE_DISK_CACHE_ENABLE = (1 << 11),
};

typedef enum SequenceColorTag {
  SEQUENCE_COLOR_NONE = -1,
  SEQUENCE_COLOR_01,
  SEQUENCE_COLOR_02,
  SEQUENCE_COLOR_03,
  SEQUENCE_COLOR_04,
  SEQUENCE_COLOR_05,
  SEQUENCE_COLOR_06,
  SEQUENCE_COLOR_07,
  SEQUENCE_COLOR_08,
  SEQUENCE_COLOR_09,
 
  SEQUENCE_COLOR_TOT,
} SequenceColorTag;
 
/* Sequence->StripTransform->filter */
enum {
  SEQ_TRANSFORM_FILTER_AUTO = -1,
  SEQ_TRANSFORM_FILTER_NEAREST = 0,
  SEQ_TRANSFORM_FILTER_BILINEAR = 1,
  SEQ_TRANSFORM_FILTER_BOX = 2,
  SEQ_TRANSFORM_FILTER_CUBIC_BSPLINE = 3,
  SEQ_TRANSFORM_FILTER_CUBIC_MITCHELL = 4,
};
 
typedef enum eSeqChannelFlag {
  SEQ_CHANNEL_LOCK = (1 << 0),
  SEQ_CHANNEL_MUTE = (1 << 1),
} eSeqChannelFlag;