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