Merging r44227 through r45619 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 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 seq_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
65 void seq_next(SeqIterator *iter);
66 void seq_end(SeqIterator *iter);
67 void seq_array(struct Editing *ed, struct Sequence ***seqarray, int *tot, int use_pointer);
68
69 #define SEQP_BEGIN(ed, _seq)                                                  \
70 {                                                                             \
71         SeqIterator iter;                                                         \
72                 for(seq_begin(ed, &iter, 1); iter.valid; seq_next(&iter)) {           \
73                         _seq= iter.seq;
74                         
75 #define SEQ_BEGIN(ed, _seq)                                                   \
76         {                                                                         \
77                 SeqIterator iter;                                                     \
78                 for(seq_begin(ed, &iter, 0); iter.valid; seq_next(&iter)) {           \
79                         _seq= iter.seq;
80
81 #define SEQ_END                                                               \
82                 }                                                                     \
83                 seq_end(&iter);                                                       \
84         }
85
86 typedef struct SeqRenderData {
87         struct Main *bmain;
88         struct Scene *scene;
89         int rectx;
90         int recty;
91         int preview_render_size;
92         int motion_blur_samples;
93         float motion_blur_shutter;
94 } SeqRenderData;
95
96 SeqRenderData seq_new_render_data(
97         struct Main * bmain, struct Scene * scene,
98         int rectx, int recty, int preview_render_size);
99
100 int seq_cmp_render_data(const SeqRenderData * a, const SeqRenderData * b);
101 unsigned int seq_hash_render_data(const SeqRenderData * a);
102
103 /* Wipe effect */
104 enum {
105         DO_SINGLE_WIPE,
106         DO_DOUBLE_WIPE,
107         DO_BOX_WIPE,
108         DO_CROSS_WIPE,
109         DO_IRIS_WIPE,
110         DO_CLOCK_WIPE
111 };
112
113
114 struct SeqEffectHandle {
115         /* constructors & destructor */
116         /* init & init_plugin are _only_ called on first creation */
117         void (*init)(struct Sequence *seq);
118         void (*init_plugin)(struct Sequence *seq, const char *fname);
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,
142                                  short adrcode, float *ymin, float *ymax);
143         
144         /* stores the default facf0 and facf1 if no IPO is present */
145         void (*get_default_fac)(struct Sequence *seq, float cfra,
146                                 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)(
154                 SeqRenderData context,
155                 struct Sequence *seq, float cfra,
156                 float facf0, float facf1,
157                 struct ImBuf *ibuf1, struct ImBuf *ibuf2,
158                 struct ImBuf *ibuf3);
159 };
160
161 /* ********************* prototypes *************** */
162
163 /* **********************************************************************
164  * sequence.c
165  *
166  * sequencer render functions
167  * ********************************************************************** */
168
169 struct ImBuf *give_ibuf_seq(SeqRenderData context, float cfra, int chanshown);
170 struct ImBuf *give_ibuf_seq_threaded(SeqRenderData context, float cfra, int chanshown);
171 struct ImBuf *give_ibuf_seq_direct(SeqRenderData context, float cfra, struct Sequence *seq);
172 struct ImBuf *give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
173 void give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
174
175 /* apply functions recursively */
176 int seqbase_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
177 int seq_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
178
179 /* maintenance functions, mostly for RNA */
180 // extern 
181 void seq_free_sequence(struct Scene *scene, struct Sequence *seq);
182 void seq_free_sequence_recurse(struct Scene *scene, struct Sequence *seq);
183 void seq_free_strip(struct Strip *strip);
184 void seq_free_editing(struct Scene *scene);
185 void seq_free_clipboard(void);
186 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
187 const char *give_seqname(struct Sequence *seq);
188 void calc_sequence(struct Scene *scene, struct Sequence *seq);
189 void calc_sequence_disp(struct Scene *scene, 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 struct SeqIndexBuildContext *seq_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq);
205 void seq_proxy_rebuild(struct SeqIndexBuildContext *context,
206                        short *stop, short *do_update, float *progress);
207 void seq_proxy_rebuild_finish(struct SeqIndexBuildContext *context, short stop);
208
209
210 /* **********************************************************************
211  * seqcache.c
212  *
213  * Sequencer memory cache management functions
214  * ********************************************************************** */
215
216 typedef enum {
217         SEQ_STRIPELEM_IBUF,
218         SEQ_STRIPELEM_IBUF_COMP,
219         SEQ_STRIPELEM_IBUF_STARTSTILL,
220         SEQ_STRIPELEM_IBUF_ENDSTILL
221 } seq_stripelem_ibuf_t;
222
223 void seq_stripelem_cache_destruct(void);
224 void seq_stripelem_cache_cleanup(void);
225
226 /* returned ImBuf is properly refed and has to be freed */
227 struct ImBuf * seq_stripelem_cache_get(
228         SeqRenderData context, struct Sequence * seq, 
229         float cfra, seq_stripelem_ibuf_t type);
230
231 /* passed ImBuf is properly refed, so ownership is *not* 
232  * transfered to the cache.
233  * you can pass the same ImBuf multiple times to the cache without problems.
234  */
235    
236 void seq_stripelem_cache_put(
237         SeqRenderData context, struct Sequence * seq, 
238         float cfra, seq_stripelem_ibuf_t type, struct ImBuf * nval);
239
240 /* **********************************************************************
241  * seqeffects.c
242  *
243  * Sequencer effect strip managment functions
244  *  **********************************************************************
245  */
246
247 /* intern */
248 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
249 void sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
250
251 /* extern */
252 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
253 int get_sequence_effect_num_inputs(int seq_type);
254
255
256 /* **********************************************************************
257  * Sequencer editing functions
258  * **********************************************************************
259  */
260    
261 /* for transform but also could use elsewhere */
262 int seq_tx_get_start(struct Sequence *seq);
263 int seq_tx_get_end(struct Sequence *seq);
264 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
265 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
266 void seq_tx_set_final_left(struct Sequence *seq, int val);
267 void seq_tx_set_final_right(struct Sequence *seq, int val);
268 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
269 int seq_tx_test(struct Sequence * seq);
270 int seq_single_check(struct Sequence *seq);
271 void seq_single_fix(struct Sequence *seq);
272 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
273 void seq_translate(struct Scene *scene, struct Sequence *seq, int delta);
274 void seq_sound_init(struct Scene *scene, struct Sequence *seq);
275 struct Sequence *seq_foreground_frame_get(struct Scene *scene, int frame);
276 struct ListBase *seq_seqbase(struct ListBase *seqbase, struct Sequence *seq);
277 struct Sequence *seq_metastrip(
278         ListBase * seqbase /* = ed->seqbase */, 
279         struct Sequence * meta /* = NULL */, struct Sequence *seq);
280
281 void seq_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
282 void seq_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
283 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test, struct Scene *evil_scene);
284 int shuffle_seq_time(ListBase * seqbasep, struct Scene *evil_scene);
285 int seqbase_isolated_sel_check(struct ListBase *seqbase);
286 void free_imbuf_seq(struct Scene *scene, struct ListBase * seqbasep, int check_mem_usage, int keep_file_handles);
287 struct Sequence *seq_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence * seq, int dupe_flag);
288 int seq_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
289
290 void seq_update_sound_bounds_all(struct Scene *scene);
291 void seq_update_sound_bounds(struct Scene* scene, struct Sequence *seq);
292 void seq_update_muting(struct Editing *ed);
293 void seq_update_sound(struct Scene *scene, struct bSound *sound);
294 void seqbase_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
295 void seqbase_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
296
297 void clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
298
299 struct Sequence *get_seq_by_name(struct ListBase *seqbase, const char *name, int recursive);
300
301 struct Sequence *seq_active_get(struct Scene *scene);
302 void seq_active_set(struct Scene *scene, struct Sequence *seq);
303 int seq_active_pair_get(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
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 *alloc_sequence(ListBase *lb, int cfra, int machine);
336
337 void seq_load_apply(struct Scene *scene, struct Sequence *seq, struct SeqLoadInfo *seq_load);
338
339 struct Sequence *sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
340 struct Sequence *sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
341 struct Sequence *sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
342
343 /* view3d draw callback, run when not in background view */
344 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, int, char[256]);
345 extern SequencerDrawView sequencer_view3d_cb;
346
347 /* copy/paste */
348 extern ListBase seqbase_clipboard;
349 extern int seqbase_clipboard_frame;
350
351 #endif // __BKE_SEQUENCER_H__