Merging r58475 through r58700 from trunk into soc-2013-depsgraph_mt
[blender.git] / 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 StripColorBalance;
35 struct Editing;
36 struct ImBuf;
37 struct Main;
38 struct Mask;
39 struct MovieClip;
40 struct Scene;
41 struct Sequence;
42 struct SequenceModifierData;
43 struct Strip;
44 struct StripElem;
45 struct bSound;
46
47 struct SeqIndexBuildContext;
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_sequence_iterator_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
65 void BKE_sequence_iterator_next(SeqIterator *iter);
66 void BKE_sequence_iterator_end(SeqIterator *iter);
67
68 #define SEQP_BEGIN(_ed, _seq)                                                 \
69         {                                                                         \
70                 SeqIterator iter_macro;                                               \
71                 for (BKE_sequence_iterator_begin(_ed, &iter_macro, 1);                \
72                      iter_macro.valid;                                                \
73                      BKE_sequence_iterator_next(&iter_macro))                         \
74                 {                                                                     \
75                         _seq = iter_macro.seq;
76
77 #define SEQ_BEGIN(ed, _seq)                                                   \
78         {                                                                         \
79                 SeqIterator iter_macro;                                               \
80                 for (BKE_sequence_iterator_begin(ed, &iter_macro, 0);                 \
81                      iter_macro.valid;                                                \
82                      BKE_sequence_iterator_next(&iter_macro))                         \
83                 {                                                                     \
84                         _seq = iter_macro.seq;
85
86 #define SEQ_END                                                               \
87                 }                                                                     \
88                 BKE_sequence_iterator_end(&iter_macro);                               \
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 BKE_sequencer_new_render_data(struct Main *bmain, struct Scene *scene, int rectx, int recty,
102                                             int preview_render_size);
103
104 /* Wipe effect */
105 enum {
106         DO_SINGLE_WIPE,
107         DO_DOUBLE_WIPE,
108         DO_BOX_WIPE,
109         DO_CROSS_WIPE,
110         DO_IRIS_WIPE,
111         DO_CLOCK_WIPE
112 };
113
114 struct SeqEffectHandle {
115         short multithreaded;
116         short supports_mask;
117
118         /* constructors & destructor */
119         /* init is _only_ called on first creation */
120         void (*init)(struct Sequence *seq);
121         
122         /* number of input strips needed 
123          * (called directly after construction) */
124         int (*num_inputs)(void);
125         
126         /* load is called first time after readblenfile in
127          * get_sequence_effect automatically */
128         void (*load)(struct Sequence *seq);
129         
130         /* duplicate */
131         void (*copy)(struct Sequence *dst, struct Sequence *src);
132         
133         /* destruct */
134         void (*free)(struct Sequence *seq);
135         
136         /* returns: -1: no input needed,
137          * 0: no early out,
138          * 1: out = ibuf1,
139          * 2: out = ibuf2 */
140         int (*early_out)(struct Sequence *seq, float facf0, float facf1); 
141         
142         /* stores the y-range of the effect IPO */
143         void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
144         
145         /* stores the default facf0 and facf1 if no IPO is present */
146         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
147         
148         /* execute the effect
149          * sequence effects are only required to either support
150          * float-rects or byte-rects
151          * (mixed cases are handled one layer up...) */
152         
153         struct ImBuf * (*execute)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
154                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
155
156         struct ImBuf * (*init_execution)(SeqRenderData context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
157                                          struct ImBuf *ibuf3);
158
159         void (*execute_slice)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
160                               struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
161                               int start_line, int total_lines, struct ImBuf *out);
162 };
163
164 /* ********************* prototypes *************** */
165
166 /* **********************************************************************
167  * sequencer.c
168  *
169  * sequencer render functions
170  * ********************************************************************** */
171
172 struct ImBuf *BKE_sequencer_give_ibuf(SeqRenderData context, float cfra, int chanshown);
173 struct ImBuf *BKE_sequencer_give_ibuf_threaded(SeqRenderData context, float cfra, int chanshown);
174 struct ImBuf *BKE_sequencer_give_ibuf_direct(SeqRenderData context, float cfra, struct Sequence *seq);
175 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
176 void BKE_sequencer_give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
177
178 /* **********************************************************************
179  * sequencer.c
180  *
181  * sequencer color space functions
182  * ********************************************************************** */
183
184 void BKE_sequencer_imbuf_to_sequencer_space(struct Scene *scene, struct ImBuf *ibuf, int make_float);
185 void BKE_sequencer_imbuf_from_sequencer_space(struct Scene *scene, struct ImBuf *ibuf);
186 void BKE_sequencer_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4]);
187
188 /* **********************************************************************
189  * sequencer scene functions
190  * ********************************************************************** */
191 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, bool alloc);
192 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
193 void             BKE_sequencer_editing_free(struct Scene *scene);
194
195 void             BKE_sequencer_sort(struct Scene *scene);
196
197 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
198 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
199 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
200 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
201
202 /* apply functions recursively */
203 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
204 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
205
206 /* maintenance functions, mostly for RNA */
207 /* extern  */
208
209 void BKE_sequencer_free_clipboard(void);
210
211 void BKE_sequence_clipboard_pointers_free(struct Sequence *seq);
212 void BKE_sequence_clipboard_pointers_store(struct Sequence *seq);
213 void BKE_sequence_clipboard_pointers_restore(struct Sequence *seq, struct Main *bmain);
214
215 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
216 const char *BKE_sequence_give_name(struct Sequence *seq);
217 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
218 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
219 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, int lock_range);
220 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
221
222 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
223
224 /* intern */
225 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
226 int BKE_sequencer_input_have_to_preprocess(SeqRenderData context, struct Sequence *seq, float cfra);
227
228 struct SeqIndexBuildContext *BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq);
229 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
230 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, short stop);
231
232 /* **********************************************************************
233  * seqcache.c
234  *
235  * Sequencer memory cache management functions
236  * ********************************************************************** */
237
238 typedef enum {
239         SEQ_STRIPELEM_IBUF,
240         SEQ_STRIPELEM_IBUF_COMP,
241         SEQ_STRIPELEM_IBUF_STARTSTILL,
242         SEQ_STRIPELEM_IBUF_ENDSTILL
243 } seq_stripelem_ibuf_t;
244
245 void BKE_sequencer_cache_destruct(void);
246 void BKE_sequencer_cache_cleanup(void);
247
248 /* returned ImBuf is properly refed and has to be freed */
249 struct ImBuf *BKE_sequencer_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
250
251 /* passed ImBuf is properly refed, so ownership is *not* 
252  * transferred to the cache.
253  * you can pass the same ImBuf multiple times to the cache without problems.
254  */
255
256 void BKE_sequencer_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *nval);
257
258 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
259
260 struct ImBuf *BKE_sequencer_preprocessed_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
261 void BKE_sequencer_preprocessed_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *ibuf);
262 void BKE_sequencer_preprocessed_cache_cleanup(void);
263 void BKE_sequencer_preprocessed_cache_cleanup_sequence(struct Sequence *seq);
264
265 /* **********************************************************************
266  * seqeffects.c
267  *
268  * Sequencer effect strip management functions
269  *  **********************************************************************
270  */
271
272 /* intern */
273 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
274 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
275
276 /* extern */
277 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
278 int BKE_sequence_effect_get_num_inputs(int seq_type);
279 int BKE_sequence_effect_get_supports_mask(int seq_type);
280
281 /* **********************************************************************
282  * Sequencer editing functions
283  * **********************************************************************
284  */
285    
286 /* for transform but also could use elsewhere */
287 int BKE_sequence_tx_get_final_left(struct Sequence *seq, int metaclip);
288 int BKE_sequence_tx_get_final_right(struct Sequence *seq, int metaclip);
289 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
290 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
291 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
292 bool BKE_sequence_tx_test(struct Sequence *seq);
293 bool BKE_sequence_single_check(struct Sequence *seq);
294 void BKE_sequence_single_fix(struct Sequence *seq);
295 bool BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
296 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
297 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
298 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
299 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
300 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
301
302 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
303 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
304 bool BKE_sequence_base_shuffle(struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
305 bool BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
306 bool BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
307 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, int for_render);
308 struct Sequence *BKE_sequence_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence *seq, int dupe_flag);
309 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
310
311 bool BKE_sequence_check_depend(struct Sequence *seq, struct Sequence *cur);
312 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
313 void BKE_sequence_invalidate_dependent(struct Scene *scene, struct Sequence *seq);
314 void BKE_sequence_invalidate_cache_for_modifier(struct Scene *scene, struct Sequence *seq);
315
316 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
317 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
318 void BKE_sequencer_update_muting(struct Editing *ed);
319 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
320
321 void BKE_sequence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
322 void BKE_sequence_base_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
323 bool BKE_sequence_is_valid_check(struct Sequence *seq);
324
325 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
326
327 struct Sequence *BKE_sequence_get_by_name(struct ListBase *seqbase, const char *name, int recursive);
328
329 /* api for adding new sequence strips */
330 typedef struct SeqLoadInfo {
331         int start_frame;
332         int end_frame;
333         int channel;
334         int flag;   /* use sound, replace sel */
335         int type;
336         int tot_success;
337         int tot_error;
338         int len;        /* only for image strips */
339         char path[1024]; /* 1024 = FILE_MAX */
340         char name[64];
341 } SeqLoadInfo;
342
343 /* SeqLoadInfo.flag */
344 #define SEQ_LOAD_REPLACE_SEL    (1 << 0)
345 #define SEQ_LOAD_FRAME_ADVANCE  (1 << 1)
346 #define SEQ_LOAD_MOVIE_SOUND    (1 << 2)
347 #define SEQ_LOAD_SOUND_CACHE    (1 << 3)
348
349
350 /* seq_dupli' flags */
351 #define SEQ_DUPE_UNIQUE_NAME    (1 << 0)
352 #define SEQ_DUPE_CONTEXT        (1 << 1)
353 #define SEQ_DUPE_ANIM           (1 << 2)
354 #define SEQ_DUPE_ALL            (1 << 3) /* otherwise only selected are copied */
355
356 /* use as an api function */
357 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
358
359 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
360
361 void BKE_sequence_alpha_mode_from_extension(struct Sequence *seq);
362 void BKE_sequence_init_colorspace(struct Sequence *seq);
363
364 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
365 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
366 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
367
368 /* view3d draw callback, run when not in background view */
369 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, bool, bool, int, char[256]);
370 extern SequencerDrawView sequencer_view3d_cb;
371
372 /* copy/paste */
373 extern ListBase seqbase_clipboard;
374 extern int seqbase_clipboard_frame;
375
376 /* modifiers */
377 typedef struct SequenceModifierTypeInfo {
378         /* default name for the modifier */
379         char name[64];  /* MAX_NAME */
380
381         /* DNA structure name used on load/save filed */
382         char struct_name[64];  /* MAX_NAME */
383
384         /* size of modifier data structure, used by allocation */
385         int struct_size;
386
387         /* data initialization */
388         void (*init_data) (struct SequenceModifierData *smd);
389
390         /* free data used by modifier,
391          * only modifier-specific data should be freed, modifier descriptor would
392          * be freed outside of this callback
393          */
394         void (*free_data) (struct SequenceModifierData *smd);
395
396         /* copy data from one modifier to another */
397         void (*copy_data) (struct SequenceModifierData *smd, struct SequenceModifierData *target);
398
399         /* apply modifier on a given image buffer */
400         void (*apply) (struct SequenceModifierData *smd, struct ImBuf *ibuf, struct ImBuf *mask);
401 } SequenceModifierTypeInfo;
402
403 struct SequenceModifierTypeInfo *BKE_sequence_modifier_type_info_get(int type);
404
405 struct SequenceModifierData *BKE_sequence_modifier_new(struct Sequence *seq, const char *name, int type);
406 int BKE_sequence_modifier_remove(struct Sequence *seq, struct SequenceModifierData *smd);
407 void BKE_sequence_modifier_clear(struct Sequence *seq);
408 void BKE_sequence_modifier_free(struct SequenceModifierData *smd);
409 void BKE_sequence_modifier_unique_name(struct Sequence *seq, struct SequenceModifierData *smd);
410 struct SequenceModifierData *BKE_sequence_modifier_find_by_name(struct Sequence *seq, const char *name);
411 struct ImBuf *BKE_sequence_modifier_apply_stack(SeqRenderData context, struct Sequence *seq, struct ImBuf *ibuf, int cfra);
412 void BKE_sequence_modifier_list_copy(struct Sequence *seqn, struct Sequence *seq);
413
414 int BKE_sequence_supports_modifiers(struct Sequence *seq);
415
416 /* internal filters */
417 struct ImBuf *BKE_sequencer_render_mask_input(SeqRenderData context, int mask_input_type, struct Sequence *mask_sequence, struct Mask *mask_id, int cfra, int make_float);
418 void BKE_sequencer_color_balance_apply(struct StripColorBalance *cb, struct ImBuf *ibuf, float mul, short make_float, struct ImBuf *mask_input);
419
420 #endif  /* __BKE_SEQUENCER_H__ */