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 BUILD_SEQAR_COUNT_NOTHING  0
  49 #define BUILD_SEQAR_COUNT_CURRENT  1
  50 #define BUILD_SEQAR_COUNT_CHILDREN 2
  51
  52 #define EARLY_NO_INPUT          -1
  53 #define EARLY_DO_EFFECT         0
  54 #define EARLY_USE_INPUT_1       1
  55 #define EARLY_USE_INPUT_2       2
  56
  57 /* sequence iterator */
  58
  59 typedef struct SeqIterator {
  60         struct Sequence **array;
  61         int tot, cur;
  62
  63         struct Sequence *seq;
  64         int valid;
  65 } SeqIterator;
  66
  67 void seq_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
  68 void seq_next(SeqIterator *iter);
  69 void seq_end(SeqIterator *iter);
  70 void seq_array(struct Editing *ed, struct Sequence ***seqarray, int *tot, int use_pointer);
  71
  72 #define SEQP_BEGIN(ed, _seq) \
  73 { \
  74         SeqIterator iter;\
  75                 for(seq_begin(ed, &iter, 1); iter.valid; seq_next(&iter)) { \
  76                         _seq= iter.seq;
  77
  78 #define SEQ_BEGIN(ed, _seq) \
  79         { \
  80                 SeqIterator iter;\
  81                 for(seq_begin(ed, &iter, 0); iter.valid; seq_next(&iter)) { \
  82                         _seq= iter.seq;
  83
  84 #define SEQ_END \
  85                 } \
  86                 seq_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 seq_new_render_data(
 100         struct Main * bmain, struct Scene * scene,
 101         int rectx, int recty, int preview_render_size);
 102
 103 int seq_cmp_render_data(const SeqRenderData * a, const SeqRenderData * b);
 104 unsigned int seq_hash_render_data(const SeqRenderData * a);
 105
 106 /* Wipe effect */
 107 enum {DO_SINGLE_WIPE, DO_DOUBLE_WIPE, DO_BOX_WIPE, DO_CROSS_WIPE,
 108         DO_IRIS_WIPE,DO_CLOCK_WIPE};
 109
 110
 111 struct SeqEffectHandle {
 112         /* constructors & destructor */
 113         /* init & init_plugin are _only_ called on first creation */
 114         void (*init)(struct Sequence *seq);
 115         void (*init_plugin)(struct Sequence *seq, const char *fname);
 116
 117         /* number of input strips needed
 118                 (called directly after construction) */
 119         int (*num_inputs)(void);
 120
 121         /* load is called first time after readblenfile in
 122                 get_sequence_effect automatically */
 123         void (*load)(struct Sequence *seq);
 124
 125         /* duplicate */
 126         void (*copy)(struct Sequence *dst, struct Sequence *src);
 127
 128         /* destruct */
 129         void (*free)(struct Sequence *seq);
 130
 131         /* returns: -1: no input needed,
 132         0: no early out,
 133         1: out = ibuf1,
 134         2: out = ibuf2 */
 135         int (*early_out)(struct Sequence *seq, float facf0, float facf1);
 136
 137         /* stores the y-range of the effect IPO */
 138         void (*store_icu_yrange)(struct Sequence * seq,
 139                                  short adrcode, float *ymin, float *ymax);
 140
 141         /* stores the default facf0 and facf1 if no IPO is present */
 142         void (*get_default_fac)(struct Sequence *seq, float cfra,
 143                                 float * facf0, float * facf1);
 144
 145         /* execute the effect
 146            sequence effects are only required to either support
 147            float-rects or byte-rects
 148            (mixed cases are handled one layer up...) */
 149
 150         struct ImBuf* (*execute)(
 151                 SeqRenderData context,
 152                 struct Sequence *seq, float cfra,
 153                 float facf0, float facf1,
 154                 struct ImBuf *ibuf1, struct ImBuf *ibuf2,
 155                 struct ImBuf *ibuf3);
 156 };
 157
 158 /* ********************* prototypes *************** */
 159
 160 /* **********************************************************************
 161    * sequence.c
 162
 163    * sequencer render functions
 164    ********************************************************************** */
 165
 166 struct ImBuf *give_ibuf_seq(SeqRenderData context, float cfra, int chanshown);
 167 struct ImBuf *give_ibuf_seq_threaded(SeqRenderData context, float cfra, int chanshown);
 168 struct ImBuf *give_ibuf_seq_direct(SeqRenderData context, float cfra, struct Sequence *seq);
 169 struct ImBuf *give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
 170 void give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
 171
 172 /* apply functions recursively */
 173 int seqbase_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
 174 int seq_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
 175
 176 /* maintainance functions, mostly for RNA */
 177 // extern
 178 void seq_free_sequence(struct Scene *scene, struct Sequence *seq);
 179 void seq_free_sequence_recurse(struct Scene *scene, struct Sequence *seq);
 180 void seq_free_strip(struct Strip *strip);
 181 void seq_free_editing(struct Scene *scene);
 182 void seq_free_clipboard(void);
 183 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
 184 const char *give_seqname(struct Sequence *seq);
 185 void calc_sequence(struct Scene *scene, struct Sequence *seq);
 186 void calc_sequence_disp(struct Scene *scene, struct Sequence *seq);
 187 void new_tstripdata(struct Sequence *seq);
 188 void reload_sequence_new_file(struct Scene *scene, struct Sequence * seq, int lock_range);
 189 void sort_seq(struct Scene *scene);
 190 void build_seqar_cb(struct ListBase *seqbase, struct Sequence  ***seqar, int *totseq,
 191                                         int (*test_func)(struct Sequence * seq));
 192 int evaluate_seq_frame(struct Scene *scene, int cfra);
 193 struct StripElem *give_stripelem(struct Sequence *seq, int cfra);
 194
 195 // intern
 196 void printf_strip(struct Sequence *seq); // debugging function (unused)
 197 void update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
 198
 199 int input_have_to_preprocess(
 200         SeqRenderData context, struct Sequence * seq, float cfra);
 201
 202 void seq_proxy_rebuild(struct Main * bmain,
 203                        struct Scene *scene, struct Sequence * seq,
 204                        short *stop, short *do_update, float *progress);
 205
 206
 207 /* **********************************************************************
 208    seqcache.c
 209
 210    Sequencer memory cache management functions
 211    ********************************************************************** */
 212
 213 typedef enum {
 214         SEQ_STRIPELEM_IBUF,
 215         SEQ_STRIPELEM_IBUF_COMP,
 216         SEQ_STRIPELEM_IBUF_STARTSTILL,
 217         SEQ_STRIPELEM_IBUF_ENDSTILL
 218 } seq_stripelem_ibuf_t;
 219
 220 void seq_stripelem_cache_destruct(void);
 221 void seq_stripelem_cache_cleanup(void);
 222
 223 /* returned ImBuf is properly refed and has to be freed */
 224 struct ImBuf * seq_stripelem_cache_get(
 225         SeqRenderData context, struct Sequence * seq,
 226         float cfra, seq_stripelem_ibuf_t type);
 227
 228 /* passed ImBuf is properly refed, so ownership is *not*
 229    transfered to the cache.
 230    you can pass the same ImBuf multiple times to the cache without problems.
 231 */
 232
 233 void seq_stripelem_cache_put(
 234         SeqRenderData context, struct Sequence * seq,
 235         float cfra, seq_stripelem_ibuf_t type, struct ImBuf * nval);
 236
 237 /* **********************************************************************
 238    seqeffects.c
 239
 240    Sequencer effect strip managment functions
 241    **********************************************************************
 242 */
 243
 244 /* intern */
 245 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
 246 void sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
 247
 248 /* extern */
 249 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
 250 int get_sequence_effect_num_inputs(int seq_type);
 251
 252
 253 /* **********************************************************************
 254    Sequencer editing functions
 255    **********************************************************************
 256 */
 257
 258 /* for transform but also could use elsewhere */
 259 int seq_tx_get_start(struct Sequence *seq);
 260 int seq_tx_get_end(struct Sequence *seq);
 261 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
 262 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
 263 void seq_tx_set_final_left(struct Sequence *seq, int val);
 264 void seq_tx_set_final_right(struct Sequence *seq, int val);
 265 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
 266 int seq_tx_test(struct Sequence * seq);
 267 int seq_single_check(struct Sequence *seq);
 268 void seq_single_fix(struct Sequence *seq);
 269 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
 270 void seq_translate(struct Scene *scene, struct Sequence *seq, int delta);
 271 void seq_sound_init(struct Scene *scene, struct Sequence *seq);
 272 struct Sequence *seq_foreground_frame_get(struct Scene *scene, int frame);
 273 struct ListBase *seq_seqbase(struct ListBase *seqbase, struct Sequence *seq);
 274 struct Sequence *seq_metastrip(
 275         ListBase * seqbase /* = ed->seqbase */,
 276         struct Sequence * meta /* = NULL */, struct Sequence *seq);
 277
 278 void seq_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
 279 void seq_dupe_animdata(struct Scene *scene, char *name_from, char *name_to);
 280 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test, struct Scene *evil_scene);
 281 int shuffle_seq_time(ListBase * seqbasep, struct Scene *evil_scene);
 282 int seqbase_isolated_sel_check(struct ListBase *seqbase);
 283 void free_imbuf_seq(struct Scene *scene, struct ListBase * seqbasep, int check_mem_usage, int keep_file_handles);
 284 struct Sequence *seq_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence * seq, int dupe_flag);
 285 int seq_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
 286
 287 void seq_update_sound_bounds_all(struct Scene *scene);
 288 void seq_update_sound_bounds(struct Scene* scene, struct Sequence *seq);
 289 void seq_update_muting(struct Editing *ed);
 290 void seq_update_sound(struct Scene *scene, struct bSound *sound);
 291 void seqbase_sound_reload(struct Scene *scene, ListBase *seqbase);
 292 void seqbase_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
 293 void seqbase_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
 294
 295 void clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
 296
 297 struct Sequence *get_seq_by_name(struct ListBase *seqbase, const char *name, int recursive);
 298
 299 struct Sequence *seq_active_get(struct Scene *scene);
 300 void seq_active_set(struct Scene *scene, struct Sequence *seq);
 301 int seq_active_pair_get(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
 302
 303 /* api for adding new sequence strips */
 304 typedef struct SeqLoadInfo {
 305         int start_frame;
 306         int end_frame;
 307         int channel;
 308         int flag;       /* use sound, replace sel */
 309         int type;
 310         int tot_success;
 311         int tot_error;
 312         int len;                /* only for image strips */
 313         char path[512];
 314         char name[32];
 315 } SeqLoadInfo;
 316
 317 /* SeqLoadInfo.flag */
 318 #define SEQ_LOAD_REPLACE_SEL    (1<<0)
 319 #define SEQ_LOAD_FRAME_ADVANCE  (1<<1)
 320 #define SEQ_LOAD_MOVIE_SOUND    (1<<2)
 321 #define SEQ_LOAD_SOUND_CACHE    (1<<3)
 322
 323
 324 /* seq_dupli' flags */
 325 #define SEQ_DUPE_UNIQUE_NAME    (1<<0)
 326 #define SEQ_DUPE_CONTEXT                (1<<1)
 327 #define SEQ_DUPE_ANIM                   (1<<2)
 328 #define SEQ_DUPE_ALL                    (1<<3) /* otherwise only selected are copied */
 329
 330 /* use as an api function */
 331 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
 332
 333 struct Sequence *alloc_sequence(ListBase *lb, int cfra, int machine);
 334
 335 void seq_load_apply(struct Scene *scene, struct Sequence *seq, struct SeqLoadInfo *seq_load);
 336
 337 struct Sequence *sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 338 struct Sequence *sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
 339 struct Sequence *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, 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