source/blender/blenkernel/BKE_sequencer.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) 2004 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  * Contributor(s): Blender Foundation (2008).
  22  *
  23  * ***** END GPL LICENSE BLOCK *****
  24  */
  25
  26 #ifndef __BKE_SEQUENCER_H__
  27 #define __BKE_SEQUENCER_H__
  28
  29 /** \file BKE_sequencer.h
  30  *  \ingroup bke
  31  */
  32
  33 struct bContext;
  34 struct Editing;
  35 struct ImBuf;
  36 struct Main;
  37 struct Scene;
  38 struct Sequence;
  39 struct Strip;
  40 struct StripElem;
  41 struct bSound;
  42
  43 struct SeqIndexBuildContext;
  44
  45 #define BUILD_SEQAR_COUNT_NOTHING  0
  46 #define BUILD_SEQAR_COUNT_CURRENT  1
  47 #define BUILD_SEQAR_COUNT_CHILDREN 2
  48
  49 #define EARLY_NO_INPUT      -1
  50 #define EARLY_DO_EFFECT     0
  51 #define EARLY_USE_INPUT_1   1
  52 #define EARLY_USE_INPUT_2   2
  53
  54 /* sequence iterator */
  55
  56 typedef struct SeqIterator {
  57         struct Sequence **array;
  58         int tot, cur;
  59
  60         struct Sequence *seq;
  61         int valid;
  62 } SeqIterator;
  63
  64 void BKE_seqence_iterator_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
  65 void BKE_seqence_iterator_next(SeqIterator *iter);
  66 void BKE_seqence_iterator_end(SeqIterator *iter);
  67
  68 #define SEQP_BEGIN(ed, _seq)                                                  \
  69         {                                                                         \
  70                 SeqIterator iter;                                                     \
  71                 for (BKE_seqence_iterator_begin(ed, &iter, 1);                        \
  72                      iter.valid;                                                      \
  73                      BKE_seqence_iterator_next(&iter)) {                              \
  74                         _seq = iter.seq;
  75
  76 #define SEQ_BEGIN(ed, _seq)                                                   \
  77         {                                                                         \
  78                 SeqIterator iter;                                                     \
  79                 for (BKE_seqence_iterator_begin(ed, &iter, 0);                        \
  80                      iter.valid;                                                      \
  81                      BKE_seqence_iterator_next(&iter)) {                              \
  82                         _seq = iter.seq;
  83
  84 #define SEQ_END                                                               \
  85                 }                                                                     \
  86                 BKE_seqence_iterator_end(&iter);                                      \
  87         }
  88
  89 typedef struct SeqRenderData {
  90         struct Main *bmain;
  91         struct Scene *scene;
  92         int rectx;
  93         int recty;
  94         int preview_render_size;
  95         int motion_blur_samples;
  96         float motion_blur_shutter;
  97 } SeqRenderData;
  98
  99 SeqRenderData BKE_sequencer_new_render_data(struct Main *bmain, struct Scene *scene, int rectx, int recty,
 100                                             int preview_render_size);
 101
 102 /* Wipe effect */
 103 enum {
 104         DO_SINGLE_WIPE,
 105         DO_DOUBLE_WIPE,
 106         DO_BOX_WIPE,
 107         DO_CROSS_WIPE,
 108         DO_IRIS_WIPE,
 109         DO_CLOCK_WIPE
 110 };
 111
 112 struct SeqEffectHandle {
 113         short multithreaded;
 114         short supports_mask;
 115
 116         /* constructors & destructor */
 117         /* init is _only_ called on first creation */
 118         void (*init)(struct Sequence *seq);
 119
 120         /* number of input strips needed
 121          * (called directly after construction) */
 122         int (*num_inputs)(void);
 123
 124         /* load is called first time after readblenfile in
 125          * get_sequence_effect automatically */
 126         void (*load)(struct Sequence *seq);
 127
 128         /* duplicate */
 129         void (*copy)(struct Sequence *dst, struct Sequence *src);
 130
 131         /* destruct */
 132         void (*free)(struct Sequence *seq);
 133
 134         /* returns: -1: no input needed,
 135          * 0: no early out,
 136          * 1: out = ibuf1,
 137          * 2: out = ibuf2 */
 138         int (*early_out)(struct Sequence *seq, float facf0, float facf1);
 139
 140         /* stores the y-range of the effect IPO */
 141         void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
 142
 143         /* stores the default facf0 and facf1 if no IPO is present */
 144         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
 145
 146         /* execute the effect
 147          * sequence effects are only required to either support
 148          * float-rects or byte-rects
 149          * (mixed cases are handled one layer up...) */
 150
 151         struct ImBuf * (*execute)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
 152                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
 153
 154         struct ImBuf * (*init_execution)(SeqRenderData context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
 155                                          struct ImBuf *ibuf3);
 156
 157         void (*execute_slice)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
 158                               struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
 159                               int start_line, int total_lines, struct ImBuf *out);
 160 };
 161
 162 /* ********************* prototypes *************** */
 163
 164 /* **********************************************************************
 165  * sequencer.c
 166  *
 167  * sequencer render functions
 168  * ********************************************************************** */
 169
 170 struct ImBuf *BKE_sequencer_give_ibuf(SeqRenderData context, float cfra, int chanshown);
 171 struct ImBuf *BKE_sequencer_give_ibuf_threaded(SeqRenderData context, float cfra, int chanshown);
 172 struct ImBuf *BKE_sequencer_give_ibuf_direct(SeqRenderData context, float cfra, struct Sequence *seq);
 173 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
 174 void BKE_sequencer_give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
 175
 176 /* **********************************************************************
 177  * sequencer scene functions
 178  * ********************************************************************** */
 179 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, int alloc);
 180 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
 181 void             BKE_sequencer_editing_free(struct Scene *scene);
 182
 183 void             BKE_sequencer_sort(struct Scene *scene);
 184
 185 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
 186 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
 187 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
 188 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
 189
 190 /* apply functions recursively */
 191 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
 192 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
 193
 194 /* maintenance functions, mostly for RNA */
 195 /* extern  */
 196
 197 void BKE_sequencer_free_clipboard(void);
 198
 199 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
 200 const char *BKE_sequence_give_name(struct Sequence *seq);
 201 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
 202 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
 203 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, int lock_range);
 204 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
 205
 206 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
 207
 208 /* intern */
 209 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
 210 int BKE_sequencer_input_have_to_preprocess(SeqRenderData context, struct Sequence *seq, float cfra);
 211
 212 struct SeqIndexBuildContext *BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq);
 213 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
 214 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, short stop);
 215
 216 /* **********************************************************************
 217  * seqcache.c
 218  *
 219  * Sequencer memory cache management functions
 220  * ********************************************************************** */
 221
 222 typedef enum {
 223         SEQ_STRIPELEM_IBUF,
 224         SEQ_STRIPELEM_IBUF_COMP,
 225         SEQ_STRIPELEM_IBUF_STARTSTILL,
 226         SEQ_STRIPELEM_IBUF_ENDSTILL
 227 } seq_stripelem_ibuf_t;
 228
 229 void BKE_sequencer_cache_destruct(void);
 230 void BKE_sequencer_cache_cleanup(void);
 231
 232 /* returned ImBuf is properly refed and has to be freed */
 233 struct ImBuf *BKE_sequencer_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
 234
 235 /* passed ImBuf is properly refed, so ownership is *not*
 236  * transfered to the cache.
 237  * you can pass the same ImBuf multiple times to the cache without problems.
 238  */
 239
 240 void BKE_sequencer_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *nval);
 241
 242 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
 243
 244 /* **********************************************************************
 245  * seqeffects.c
 246  *
 247  * Sequencer effect strip managment functions
 248  *  **********************************************************************
 249  */
 250
 251 /* intern */
 252 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
 253 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
 254
 255 /* extern */
 256 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
 257 int BKE_sequence_effect_get_num_inputs(int seq_type);
 258 int BKE_sequence_effect_get_supports_mask(int seq_type);
 259
 260 /* **********************************************************************
 261  * Sequencer editing functions
 262  * **********************************************************************
 263  */
 264
 265 /* for transform but also could use elsewhere */
 266 int BKE_sequence_tx_get_final_left(struct Sequence *seq, int metaclip);
 267 int BKE_sequence_tx_get_final_right(struct Sequence *seq, int metaclip);
 268 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
 269 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
 270 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
 271 int BKE_sequence_tx_test(struct Sequence *seq);
 272 int BKE_sequence_single_check(struct Sequence *seq);
 273 void BKE_sequence_single_fix(struct Sequence *seq);
 274 int BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
 275 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
 276 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
 277 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
 278 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
 279 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
 280
 281 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
 282 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
 283 int BKE_sequence_base_shuffle(struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
 284 int BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
 285 int BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
 286 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, int check_mem_usage, int keep_file_handles);
 287 struct Sequence *BKE_sequence_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence *seq, int dupe_flag);
 288 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
 289
 290 int BKE_sequence_check_depend(struct Sequence *seq, struct Sequence *cur);
 291 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
 292
 293 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
 294 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
 295 void BKE_sequencer_update_muting(struct Editing *ed);
 296 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
 297
 298 void BKE_seqence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
 299 void BKE_sequence_base_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
 300
 301 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
 302
 303 struct Sequence *BKE_sequwnce_get_by_name(struct ListBase *seqbase, const char *name, int recursive);
 304
 305 /* api for adding new sequence strips */
 306 typedef struct SeqLoadInfo {
 307         int start_frame;
 308         int end_frame;
 309         int channel;
 310         int flag;   /* use sound, replace sel */
 311         int type;
 312         int tot_success;
 313         int tot_error;
 314         int len;        /* only for image strips */
 315         char path[512];
 316         char name[64];
 317 } SeqLoadInfo;
 318
 319 /* SeqLoadInfo.flag */
 320 #define SEQ_LOAD_REPLACE_SEL    (1 << 0)
 321 #define SEQ_LOAD_FRAME_ADVANCE  (1 << 1)
 322 #define SEQ_LOAD_MOVIE_SOUND    (1 << 2)
 323 #define SEQ_LOAD_SOUND_CACHE    (1 << 3)
 324
 325
 326 /* seq_dupli' flags */
 327 #define SEQ_DUPE_UNIQUE_NAME    (1 << 0)
 328 #define SEQ_DUPE_CONTEXT        (1 << 1)
 329 #define SEQ_DUPE_ANIM           (1 << 2)
 330 #define SEQ_DUPE_ALL            (1 << 3) /* otherwise only selected are copied */
 331
 332 /* use as an api function */
 333 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
 334
 335 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
 336
 337 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 338 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 339 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 340
 341 /* view3d draw callback, run when not in background view */
 342 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, int, char[256]);
 343 extern SequencerDrawView sequencer_view3d_cb;
 344
 345 /* copy/paste */
 346 extern ListBase seqbase_clipboard;
 347 extern int seqbase_clipboard_frame;
 348
 349 #endif /* __BKE_SEQUENCER_H__ */