source/blender/sequencer/SEQ_relations.hh

   1 /* SPDX-FileCopyrightText: 2004 Blender Authors
   2  *
   3  * SPDX-License-Identifier: GPL-2.0-or-later */
   4
   5 #pragma once
   6
   7 /** \file
   8  * \ingroup sequencer
   9  */
  10
  11 #include <cstddef>
  12
  13 struct ListBase;
  14 struct Main;
  15 struct MovieClip;
  16 struct ReportList;
  17 struct Scene;
  18 struct Strip;
  19
  20 /**
  21  * Check if one sequence is input to the other.
  22  */
  23 bool SEQ_relation_is_effect_of_strip(const Strip *effect, const Strip *input);
  24 /**
  25  * Function to free imbuf and anim data on changes.
  26  */
  27 void SEQ_relations_sequence_free_anim(Strip *strip);
  28 bool SEQ_relations_check_scene_recursion(Scene *scene, ReportList *reports);
  29 /**
  30  * Check if "strip_main" (indirectly) uses strip "strip".
  31  */
  32 bool SEQ_relations_render_loop_check(Strip *strip_main, Strip *strip);
  33 void SEQ_relations_free_imbuf(Scene *scene, ListBase *seqbase, bool for_render);
  34 void SEQ_relations_invalidate_cache_raw(Scene *scene, Strip *strip);
  35 void SEQ_relations_invalidate_cache_preprocessed(Scene *scene, Strip *strip);
  36 void SEQ_relations_invalidate_cache_composite(Scene *scene, Strip *strip);
  37 void SEQ_relations_invalidate_dependent(Scene *scene, Strip *strip);
  38 void SEQ_relations_invalidate_scene_strips(Main *bmain, Scene *scene_target);
  39 void SEQ_relations_invalidate_movieclip_strips(Main *bmain, MovieClip *clip_target);
  40 void SEQ_relations_invalidate_cache_in_range(Scene *scene,
  41                                              Strip *strip,
  42                                              Strip *range_mask,
  43                                              int invalidate_types);
  44 /**
  45  * Release FFmpeg handles of strips that are not currently displayed to minimize memory usage.
  46  */
  47 void SEQ_relations_free_all_anim_ibufs(Scene *scene, int timeline_frame);
  48 /**
  49  * A debug and development function which checks whether sequences have unique UIDs.
  50  * Errors will be reported to the console.
  51  */
  52 void SEQ_relations_check_uids_unique_and_report(const Scene *scene);
  53 /**
  54  * Generate new UID for the given sequence.
  55  */
  56 void SEQ_relations_session_uid_generate(Strip *sequence);
  57
  58 void SEQ_cache_cleanup(Scene *scene);
  59 void SEQ_cache_iterate(
  60     Scene *scene,
  61     void *userdata,
  62     bool callback_init(void *userdata, size_t item_count),
  63     bool callback_iter(void *userdata, Strip *strip, int timeline_frame, int cache_type));
  64 /**
  65  * Return immediate parent meta of sequence.
  66  */
  67 Strip *SEQ_find_metastrip_by_sequence(ListBase *seqbase /* = ed->seqbase */,
  68                                       Strip *meta /* = NULL */,
  69                                       Strip *strip);
  70 bool SEQ_exists_in_seqbase(const Strip *strip, const ListBase *seqbase);