Blender  V3.3
Macros | Typedefs | Enumerations | Functions
SEQ_sequencer.h File Reference
#include "DNA_scene_types.h"

Go to the source code of this file.

Macros

#define SEQ_DUPE_UNIQUE_NAME   (1 << 0)
 
#define SEQ_DUPE_ALL   (1 << 3) /* otherwise only selected are copied */
 
#define SEQ_DUPE_IS_RECURSIVE_CALL   (1 << 4)
 

Typedefs

typedef enum eSequenceLookupTag eSequenceLookupTag
 

Enumerations

enum  {
  SEQ_SIDE_MOUSE = -1 , SEQ_SIDE_NONE = 0 , SEQ_SIDE_LEFT , SEQ_SIDE_RIGHT ,
  SEQ_SIDE_BOTH , SEQ_SIDE_NO_CHANGE
}
 
enum  eSequenceLookupTag { SEQ_LOOKUP_TAG_INVALID = (1 << 0) }
 

Functions

struct SequencerToolSettingsSEQ_tool_settings_init (void)
 
struct SequencerToolSettingsSEQ_tool_settings_ensure (struct Scene *scene)
 
void SEQ_tool_settings_free (struct SequencerToolSettings *tool_settings)
 
eSeqImageFitMethod SEQ_tool_settings_fit_method_get (struct Scene *scene)
 
void SEQ_tool_settings_fit_method_set (struct Scene *scene, eSeqImageFitMethod fit_method)
 
short SEQ_tool_settings_snap_flag_get (struct Scene *scene)
 
short SEQ_tool_settings_snap_mode_get (struct Scene *scene)
 
int SEQ_tool_settings_snap_distance_get (struct Scene *scene)
 
eSeqOverlapMode SEQ_tool_settings_overlap_mode_get (struct Scene *scene)
 
int SEQ_tool_settings_pivot_point_get (struct Scene *scene)
 
struct SequencerToolSettingsSEQ_tool_settings_copy (struct SequencerToolSettings *tool_settings)
 
struct EditingSEQ_editing_get (const struct Scene *scene)
 
struct EditingSEQ_editing_ensure (struct Scene *scene)
 
void SEQ_editing_free (struct Scene *scene, bool do_id_user)
 
struct ListBaseSEQ_active_seqbase_get (const struct Editing *ed)
 
void SEQ_seqbase_active_set (struct Editing *ed, struct ListBase *seqbase)
 
struct SequenceSEQ_sequence_alloc (ListBase *lb, int timeline_frame, int machine, int type)
 
void SEQ_sequence_free (struct Scene *scene, struct Sequence *seq)
 
struct MetaStackSEQ_meta_stack_active_get (const struct Editing *ed)
 
void SEQ_meta_stack_set (const struct Scene *scene, struct Sequence *dst_seq)
 
struct SequenceSEQ_meta_stack_pop (struct Editing *ed)
 
struct SequenceSEQ_sequence_dupli_recursive (const struct Scene *scene_src, struct Scene *scene_dst, struct ListBase *new_seq_list, struct Sequence *seq, int dupe_flag)
 
void SEQ_sequence_base_dupli_recursive (const struct Scene *scene_src, struct Scene *scene_dst, struct ListBase *nseqbase, const struct ListBase *seqbase, int dupe_flag, int flag)
 
bool SEQ_valid_strip_channel (struct Sequence *seq)
 
void SEQ_blend_write (struct BlendWriter *writer, struct ListBase *seqbase)
 
void SEQ_blend_read (struct BlendDataReader *reader, struct ListBase *seqbase)
 
void SEQ_blend_read_lib (struct BlendLibReader *reader, struct Scene *scene, struct ListBase *seqbase)
 
void SEQ_blend_read_expand (struct BlendExpander *expander, struct ListBase *seqbase)
 
void SEQ_eval_sequences (struct Depsgraph *depsgraph, struct Scene *scene, struct ListBase *seqbase)
 
struct SequenceSEQ_sequence_lookup_seq_by_name (const struct Scene *scene, const char *key)
 
void SEQ_sequence_lookup_free (const struct Scene *scene)
 
void SEQ_sequence_lookup_tag (const struct Scene *scene, eSequenceLookupTag tag)
 

Macro Definition Documentation

◆ SEQ_DUPE_ALL

#define SEQ_DUPE_ALL   (1 << 3) /* otherwise only selected are copied */

Definition at line 39 of file SEQ_sequencer.h.

◆ SEQ_DUPE_IS_RECURSIVE_CALL

#define SEQ_DUPE_IS_RECURSIVE_CALL   (1 << 4)

Definition at line 40 of file SEQ_sequencer.h.

◆ SEQ_DUPE_UNIQUE_NAME

#define SEQ_DUPE_UNIQUE_NAME   (1 << 0)

Definition at line 38 of file SEQ_sequencer.h.

Typedef Documentation

◆ eSequenceLookupTag

Enumeration Type Documentation

◆ anonymous enum

anonymous enum
Enumerator
SEQ_SIDE_MOUSE 
SEQ_SIDE_NONE 
SEQ_SIDE_LEFT 
SEQ_SIDE_RIGHT 
SEQ_SIDE_BOTH 
SEQ_SIDE_NO_CHANGE 

Definition at line 28 of file SEQ_sequencer.h.

◆ eSequenceLookupTag

Enumerator
SEQ_LOOKUP_TAG_INVALID 

Definition at line 129 of file SEQ_sequencer.h.

Function Documentation

◆ SEQ_active_seqbase_get()

struct ListBase* SEQ_active_seqbase_get ( const struct Editing ed)

Get seqbase that is being viewed currently. This can be main seqbase or meta strip seqbase

Parameters
edsequence editor data
Returns
pointer to active seqbase. returns NULL if ed is NULL

◆ SEQ_blend_read()

void SEQ_blend_read ( struct BlendDataReader reader,
struct ListBase seqbase 
)

Definition at line 823 of file sequencer.c.

References SEQ_for_each_callback(), and seq_read_data_cb().

Referenced by scene_blend_read_data().

◆ SEQ_blend_read_expand()

void SEQ_blend_read_expand ( struct BlendExpander expander,
struct ListBase seqbase 
)

Definition at line 919 of file sequencer.c.

References seq_blend_read_expand(), and SEQ_for_each_callback().

Referenced by scene_blend_read_expand().

◆ SEQ_blend_read_lib()

void SEQ_blend_read_lib ( struct BlendLibReader reader,
struct Scene scene,
struct ListBase seqbase 
)

Definition at line 884 of file sequencer.c.

References data, scene, SEQ_for_each_callback(), and seq_read_lib_cb().

Referenced by scene_blend_read_lib().

◆ SEQ_blend_write()

void SEQ_blend_write ( struct BlendWriter writer,
struct ListBase seqbase 
)

Read and Write functions for .blend file data.

Definition at line 755 of file sequencer.c.

References NULL, SEQ_for_each_callback(), seq_set_strip_done_cb(), and seq_write_data_cb().

Referenced by scene_blend_write().

◆ SEQ_editing_ensure()

struct Editing* SEQ_editing_ensure ( struct Scene scene)

◆ SEQ_editing_free()

void SEQ_editing_free ( struct Scene scene,
bool  do_id_user 
)

◆ SEQ_editing_get()

struct Editing* SEQ_editing_get ( const struct Scene scene)

◆ SEQ_eval_sequences()

void SEQ_eval_sequences ( struct Depsgraph depsgraph,
struct Scene scene,
struct ListBase seqbase 
)

Evaluate parts of sequences which needs to be done as a part of a dependency graph evaluation. This does NOT include actual rendering of the strips, but rather makes them up-to-date for animation playback and makes them ready for the sequencer's rendering pipeline to render them.

Definition at line 978 of file sequencer.c.

References BKE_sound_ensure_scene(), DEG_debug_print_eval(), depsgraph, Scene::ed, Scene::id, ID::name, scene, SEQ_edit_update_muting(), SEQ_for_each_callback(), SEQ_sound_update_bounds_all(), and seq_update_seq_cb().

◆ SEQ_meta_stack_active_get()

struct MetaStack* SEQ_meta_stack_active_get ( const struct Editing ed)

Get MetaStack that corresponds to current level that is being viewed

Returns
pointer to meta stack

◆ SEQ_meta_stack_pop()

struct Sequence* SEQ_meta_stack_pop ( struct Editing ed)

Close last Meta strip open for editing.

Parameters
edsequence editor data

Definition at line 453 of file sequencer.c.

References BLI_remlink(), MEM_freeN, Editing::metastack, MetaStack::old_channels, MetaStack::oldbasep, MetaStack::parseq, SEQ_channels_displayed_set(), SEQ_meta_stack_active_get(), and SEQ_seqbase_active_set().

Referenced by sequencer_meta_toggle_exec().

◆ SEQ_meta_stack_set()

void SEQ_meta_stack_set ( const struct Scene scene,
struct Sequence dst_seq 
)

Open Meta strip content for editing.

Parameters
edsequence editor data
seqmmeta sequence or NULL for top level view

◆ SEQ_seqbase_active_set()

void SEQ_seqbase_active_set ( struct Editing ed,
struct ListBase seqbase 
)

Set seqbase that is being viewed currently. This can be main seqbase or meta strip seqbase

Parameters
edsequence editor data
seqbaseListBase with strips

Definition at line 397 of file sequencer.c.

References Editing::seqbasep.

Referenced by SEQ_meta_stack_pop(), SEQ_meta_stack_set(), seq_prefetch_update_active_seqbase(), and seq_update_meta_disp_range().

◆ SEQ_sequence_alloc()

struct Sequence* SEQ_sequence_alloc ( ListBase lb,
int  timeline_frame,
int  machine,
int  type 
)

◆ SEQ_sequence_base_dupli_recursive()

void SEQ_sequence_base_dupli_recursive ( const struct Scene scene_src,
struct Scene scene_dst,
struct ListBase nseqbase,
const struct ListBase seqbase,
int  dupe_flag,
int  flag 
)

◆ SEQ_sequence_dupli_recursive()

struct Sequence* SEQ_sequence_dupli_recursive ( const struct Scene scene_src,
struct Scene scene_dst,
struct ListBase new_seq_list,
struct Sequence seq,
int  dupe_flag 
)

◆ SEQ_sequence_free()

void SEQ_sequence_free ( struct Scene scene,
struct Sequence seq 
)

Definition at line 224 of file sequencer.c.

References scene, and seq_sequence_free_ex().

Referenced by SEQ_edit_remove_flagged_sequences(), and thumbnail_hash_data_free().

◆ SEQ_sequence_lookup_free()

void SEQ_sequence_lookup_free ( const struct Scene scene)

Free lookup hash data.

Parameters
scenescene that owns lookup hash

◆ SEQ_sequence_lookup_seq_by_name()

struct Sequence* SEQ_sequence_lookup_seq_by_name ( const struct Scene scene,
const char *  key 
)

Find a sequence with a given name. If lookup hash doesn't exist, it will be created. If hash is tagged as invalid, it will be rebuilt.

Parameters
scenescene that owns lookup hash
keySequence name without SQ prefix (seq->name + 2)
Returns
pointer to Sequence

◆ SEQ_sequence_lookup_tag()

void SEQ_sequence_lookup_tag ( const struct Scene scene,
eSequenceLookupTag  tag 
)

Find a sequence with a given name.

Parameters
scenescene that owns lookup hash
tagtag to set

◆ SEQ_tool_settings_copy()

struct SequencerToolSettings* SEQ_tool_settings_copy ( struct SequencerToolSettings tool_settings)

Definition at line 664 of file sequencer.c.

References MEM_dupallocN.

Referenced by BKE_toolsettings_copy().

◆ SEQ_tool_settings_ensure()

struct SequencerToolSettings* SEQ_tool_settings_ensure ( struct Scene scene)

◆ SEQ_tool_settings_fit_method_get()

eSeqImageFitMethod SEQ_tool_settings_fit_method_get ( struct Scene scene)

◆ SEQ_tool_settings_fit_method_set()

void SEQ_tool_settings_fit_method_set ( struct Scene scene,
eSeqImageFitMethod  fit_method 
)

◆ SEQ_tool_settings_free()

void SEQ_tool_settings_free ( struct SequencerToolSettings tool_settings)

Definition at line 341 of file sequencer.c.

References MEM_freeN.

Referenced by BKE_toolsettings_free().

◆ SEQ_tool_settings_init()

struct SequencerToolSettings* SEQ_tool_settings_init ( void  )

◆ SEQ_tool_settings_overlap_mode_get()

eSeqOverlapMode SEQ_tool_settings_overlap_mode_get ( struct Scene scene)

◆ SEQ_tool_settings_pivot_point_get()

int SEQ_tool_settings_pivot_point_get ( struct Scene scene)

Definition at line 382 of file sequencer.c.

References SequencerToolSettings::pivot_point, scene, and SEQ_tool_settings_ensure().

Referenced by t_around_get().

◆ SEQ_tool_settings_snap_distance_get()

int SEQ_tool_settings_snap_distance_get ( struct Scene scene)

◆ SEQ_tool_settings_snap_flag_get()

short SEQ_tool_settings_snap_flag_get ( struct Scene scene)

◆ SEQ_tool_settings_snap_mode_get()

short SEQ_tool_settings_snap_mode_get ( struct Scene scene)

◆ SEQ_valid_strip_channel()

bool SEQ_valid_strip_channel ( struct Sequence seq)

Definition at line 653 of file sequencer.c.

References Sequence::machine, and MAXSEQ.

Referenced by link_recurs_seq(), and SEQ_transform_seqbase_shuffle_ex().