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