source/blender/blenkernel/BKE_sequencer.h

   1 /*
   2  * $Id$
   3  *
   4  * ***** BEGIN GPL LICENSE BLOCK *****
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version 2
   9  * of the License, or (at your option) any later version. The Blender
  10  * Foundation also sells licenses for use in proprietary software under
  11  * the Blender License.  See http://www.blender.org/BL/ for information
  12  * about this.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  *
  23  * The Original Code is Copyright (C) 2004 Blender Foundation.
  24  * All rights reserved.
  25  *
  26  * Contributor(s): Blender Foundation (2008).
  27  *
  28  * ***** END GPL LICENSE BLOCK *****
  29  */
  30
  31 #ifndef BKE_SEQUENCER_H
  32 #define BKE_SEQUENCER_H
  33
  34 /** \file BKE_sequencer.h
  35  *  \ingroup bke
  36  */
  37
  38 struct bContext;
  39 struct Editing;
  40 struct ImBuf;
  41 struct Main;
  42 struct Scene;
  43 struct Sequence;
  44 struct Strip;
  45 struct StripElem;
  46 struct bSound;
  47
  48 #define MAXSEQ          32
  49
  50 #define BUILD_SEQAR_COUNT_NOTHING  0
  51 #define BUILD_SEQAR_COUNT_CURRENT  1
  52 #define BUILD_SEQAR_COUNT_CHILDREN 2
  53
  54 #define EARLY_NO_INPUT          -1
  55 #define EARLY_DO_EFFECT         0
  56 #define EARLY_USE_INPUT_1       1
  57 #define EARLY_USE_INPUT_2       2
  58
  59 /* sequence iterator */
  60
  61 typedef struct SeqIterator {
  62         struct Sequence **array;
  63         int tot, cur;
  64
  65         struct Sequence *seq;
  66         int valid;
  67 } SeqIterator;
  68
  69 void seq_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
  70 void seq_next(SeqIterator *iter);
  71 void seq_end(SeqIterator *iter);
  72 void seq_array(struct Editing *ed, struct Sequence ***seqarray, int *tot, int use_pointer);
  73
  74 #define SEQP_BEGIN(ed, _seq) \
  75 { \
  76         SeqIterator iter;\
  77                 for(seq_begin(ed, &iter, 1); iter.valid; seq_next(&iter)) { \
  78                         _seq= iter.seq;
  79
  80 #define SEQ_BEGIN(ed, _seq) \
  81         { \
  82                 SeqIterator iter;\
  83                 for(seq_begin(ed, &iter, 0); iter.valid; seq_next(&iter)) { \
  84                         _seq= iter.seq;
  85
  86 #define SEQ_END \
  87                 } \
  88                 seq_end(&iter); \
  89         }
  90
  91 typedef struct SeqRenderData {
  92         struct Main *bmain;
  93         struct Scene *scene;
  94         int rectx;
  95         int recty;
  96         int preview_render_size;
  97         int motion_blur_samples;
  98         float motion_blur_shutter;
  99 } SeqRenderData;
 100
 101 SeqRenderData seq_new_render_data(
 102         struct Main * bmain, struct Scene * scene,
 103         int rectx, int recty, int preview_render_size);
 104
 105 int seq_cmp_render_data(const SeqRenderData * a, const SeqRenderData * b);
 106 unsigned int seq_hash_render_data(const SeqRenderData * a);
 107
 108 /* Wipe effect */
 109 enum {DO_SINGLE_WIPE, DO_DOUBLE_WIPE, DO_BOX_WIPE, DO_CROSS_WIPE,
 110         DO_IRIS_WIPE,DO_CLOCK_WIPE};
 111
 112
 113 struct SeqEffectHandle {
 114         /* constructors & destructor */
 115         /* init & init_plugin are _only_ called on first creation */
 116         void (*init)(struct Sequence *seq);
 117         void (*init_plugin)(struct Sequence *seq, const char *fname);
 118
 119         /* number of input strips needed
 120                 (called directly after construction) */
 121         int (*num_inputs)(void);
 122
 123         /* load is called first time after readblenfile in
 124                 get_sequence_effect automatically */
 125         void (*load)(struct Sequence *seq);
 126
 127         /* duplicate */
 128         void (*copy)(struct Sequence *dst, struct Sequence *src);
 129
 130         /* destruct */
 131         void (*free)(struct Sequence *seq);
 132
 133         /* returns: -1: no input needed,
 134         0: no early out,
 135         1: out = ibuf1,
 136         2: out = ibuf2 */
 137         int (*early_out)(struct Sequence *seq, float facf0, float facf1);
 138
 139         /* stores the y-range of the effect IPO */
 140         void (*store_icu_yrange)(struct Sequence * seq,
 141                                  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,
 145                                 float * facf0, float * facf1);
 146
 147         /* execute the effect
 148            sequence effects are only required to either support
 149            float-rects or byte-rects
 150            (mixed cases are handled one layer up...) */
 151
 152         struct ImBuf* (*execute)(
 153                 SeqRenderData context,
 154                 struct Sequence *seq, float cfra,
 155                 float facf0, float facf1,
 156                 struct ImBuf *ibuf1, struct ImBuf *ibuf2,
 157                 struct ImBuf *ibuf3);
 158 };
 159
 160 /* ********************* prototypes *************** */
 161
 162 /* **********************************************************************
 163    * sequence.c
 164
 165    * sequencer render functions
 166    ********************************************************************** */
 167
 168 struct ImBuf *give_ibuf_seq(SeqRenderData context, float cfra, int chanshown);
 169 struct ImBuf *give_ibuf_seq_threaded(SeqRenderData context, float cfra, int chanshown);
 170 struct ImBuf *give_ibuf_seq_direct(SeqRenderData context, float cfra, struct Sequence *seq);
 171 struct ImBuf *give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
 172 void give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
 173
 174 /* apply functions recursively */
 175 int seqbase_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
 176 int seq_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
 177
 178 /* maintainance functions, mostly for RNA */
 179 // extern
 180 void seq_free_sequence(struct Scene *scene, struct Sequence *seq);
 181 void seq_free_sequence_recurse(struct Scene *scene, struct Sequence *seq);
 182 void seq_free_strip(struct Strip *strip);
 183 void seq_free_editing(struct Scene *scene);
 184 void seq_free_clipboard(void);
 185 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
 186 const char *give_seqname(struct Sequence *seq);
 187 void calc_sequence(struct Scene *scene, struct Sequence *seq);
 188 void calc_sequence_disp(struct Scene *scene, struct Sequence *seq);
 189 void new_tstripdata(struct Sequence *seq);
 190 void reload_sequence_new_file(struct Scene *scene, struct Sequence * seq, int lock_range);
 191 void sort_seq(struct Scene *scene);
 192 void build_seqar_cb(struct ListBase *seqbase, struct Sequence  ***seqar, int *totseq,
 193                                         int (*test_func)(struct Sequence * seq));
 194 int evaluate_seq_frame(struct Scene *scene, int cfra);
 195 struct StripElem *give_stripelem(struct Sequence *seq, int cfra);
 196
 197 // intern
 198 void printf_strip(struct Sequence *seq); // debugging function (unused)
 199 void update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
 200
 201 int input_have_to_preprocess(
 202         SeqRenderData context, struct Sequence * seq, float cfra);
 203
 204 void seq_proxy_rebuild(struct Main * bmain,
 205                        struct Scene *scene, struct Sequence * seq,
 206                        short *stop, short *do_update, float *progress);
 207
 208
 209 /* **********************************************************************
 210    seqcache.c
 211
 212    Sequencer memory cache management functions
 213    ********************************************************************** */
 214
 215 typedef enum {
 216         SEQ_STRIPELEM_IBUF,
 217         SEQ_STRIPELEM_IBUF_COMP,
 218         SEQ_STRIPELEM_IBUF_STARTSTILL,
 219         SEQ_STRIPELEM_IBUF_ENDSTILL
 220 } seq_stripelem_ibuf_t;
 221
 222 void seq_stripelem_cache_init(void);
 223 void seq_stripelem_cache_destruct(void);
 224
 225 void seq_stripelem_cache_cleanup(void);
 226
 227 /* returned ImBuf is properly refed and has to be freed */
 228 struct ImBuf * seq_stripelem_cache_get(
 229         SeqRenderData context, struct Sequence * seq,
 230         float cfra, seq_stripelem_ibuf_t type);
 231
 232 /* passed ImBuf is properly refed, so ownership is *not*
 233    transfered to the cache.
 234    you can pass the same ImBuf multiple times to the cache without problems.
 235 */
 236
 237 void seq_stripelem_cache_put(
 238         SeqRenderData context, struct Sequence * seq,
 239         float cfra, seq_stripelem_ibuf_t type, struct ImBuf * nval);
 240
 241 /* **********************************************************************
 242    seqeffects.c
 243
 244    Sequencer effect strip managment functions
 245    **********************************************************************
 246 */
 247
 248 /* intern */
 249 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
 250 void sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
 251
 252 /* extern */
 253 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
 254 int get_sequence_effect_num_inputs(int seq_type);
 255
 256
 257 /* **********************************************************************
 258    Sequencer editing functions
 259    **********************************************************************
 260 */
 261
 262 /* for transform but also could use elsewhere */
 263 int seq_tx_get_start(struct Sequence *seq);
 264 int seq_tx_get_end(struct Sequence *seq);
 265 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
 266 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
 267 void seq_tx_set_final_left(struct Sequence *seq, int val);
 268 void seq_tx_set_final_right(struct Sequence *seq, int val);
 269 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
 270 int seq_tx_test(struct Sequence * seq);
 271 int seq_single_check(struct Sequence *seq);
 272 void seq_single_fix(struct Sequence *seq);
 273 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
 274 void seq_translate(struct Scene *scene, struct Sequence *seq, int delta);
 275 void seq_sound_init(struct Scene *scene, struct Sequence *seq);
 276 struct Sequence *seq_foreground_frame_get(struct Scene *scene, int frame);
 277 struct ListBase *seq_seqbase(struct ListBase *seqbase, struct Sequence *seq);
 278 struct Sequence *seq_metastrip(
 279         ListBase * seqbase /* = ed->seqbase */,
 280         struct Sequence * meta /* = NULL */, struct Sequence *seq);
 281
 282 void seq_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
 283 void seq_dupe_animdata(struct Scene *scene, char *name_from, char *name_to);
 284 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test, struct Scene *evil_scene);
 285 int shuffle_seq_time(ListBase * seqbasep, struct Scene *evil_scene);
 286 int seqbase_isolated_sel_check(struct ListBase *seqbase);
 287 void free_imbuf_seq(struct Scene *scene, struct ListBase * seqbasep, int check_mem_usage, int keep_file_handles);
 288 struct Sequence *seq_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence * seq, int dupe_flag);
 289 int seq_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
 290
 291 void seq_update_sound_bounds_all(struct Scene *scene);
 292 void seq_update_sound_bounds(struct Scene* scene, struct Sequence *seq);
 293 void seq_update_muting(struct Editing *ed);
 294 void seq_update_sound(struct Scene *scene, struct bSound *sound);
 295 void seqbase_sound_reload(struct Scene *scene, ListBase *seqbase);
 296 void seqbase_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
 297 void seqbase_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
 298
 299 void clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
 300
 301 struct Sequence *get_seq_by_name(struct ListBase *seqbase, const char *name, int recursive);
 302
 303 struct Sequence *seq_active_get(struct Scene *scene);
 304 void seq_active_set(struct Scene *scene, struct Sequence *seq);
 305 int seq_active_pair_get(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
 306
 307 /* api for adding new sequence strips */
 308 typedef struct SeqLoadInfo {
 309         int start_frame;
 310         int end_frame;
 311         int channel;
 312         int flag;       /* use sound, replace sel */
 313         int type;
 314         int tot_success;
 315         int tot_error;
 316         int len;                /* only for image strips */
 317         char path[512];
 318         char name[32];
 319 } SeqLoadInfo;
 320
 321 /* SeqLoadInfo.flag */
 322 #define SEQ_LOAD_REPLACE_SEL    (1<<0)
 323 #define SEQ_LOAD_FRAME_ADVANCE  (1<<1)
 324 #define SEQ_LOAD_MOVIE_SOUND    (1<<2)
 325 #define SEQ_LOAD_SOUND_CACHE    (1<<3)
 326
 327
 328 /* seq_dupli' flags */
 329 #define SEQ_DUPE_UNIQUE_NAME    (1<<0)
 330 #define SEQ_DUPE_CONTEXT                (1<<1)
 331 #define SEQ_DUPE_ANIM                   (1<<2)
 332 #define SEQ_DUPE_ALL                    (1<<3) /* otherwise only selected are copied */
 333
 334 /* use as an api function */
 335 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
 336
 337 struct Sequence *alloc_sequence(ListBase *lb, int cfra, int machine);
 338
 339 void seq_load_apply(struct Scene *scene, struct Sequence *seq, struct SeqLoadInfo *seq_load);
 340
 341 struct Sequence *sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 342 struct Sequence *sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 343 struct Sequence *sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 344
 345 /* view3d draw callback, run when not in background view */
 346 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, char[256]);
 347 extern SequencerDrawView sequencer_view3d_cb;
 348
 349 /* copy/paste */
 350 extern ListBase seqbase_clipboard;
 351 extern int seqbase_clipboard_frame;
 352
 353 #endif // BKE_SEQUENCER_H