Code cleanup: use defines instead of magic constants
[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 BKE_seqence_iterator_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
65 void BKE_seqence_iterator_next(SeqIterator *iter);
66 void BKE_seqence_iterator_end(SeqIterator *iter);
67
68 #define SEQP_BEGIN(ed, _seq)                                                  \
69         {                                                                         \
70                 SeqIterator iter;                                                     \
71                 for (BKE_seqence_iterator_begin(ed, &iter, 1);                        \
72                      iter.valid;                                                      \
73                      BKE_seqence_iterator_next(&iter)) {                              \
74                         _seq = iter.seq;
75                         
76 #define SEQ_BEGIN(ed, _seq)                                                   \
77         {                                                                         \
78                 SeqIterator iter;                                                     \
79                 for (BKE_seqence_iterator_begin(ed, &iter, 0);                        \
80                      iter.valid;                                                      \
81                      BKE_seqence_iterator_next(&iter)) {                              \
82                         _seq = iter.seq;
83
84 #define SEQ_END                                                               \
85                 }                                                                     \
86                 BKE_seqence_iterator_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 BKE_sequencer_new_render_data(struct Main *bmain, struct Scene *scene, int rectx, int recty,
100                                             int preview_render_size);
101
102 /* Wipe effect */
103 enum {
104         DO_SINGLE_WIPE,
105         DO_DOUBLE_WIPE,
106         DO_BOX_WIPE,
107         DO_CROSS_WIPE,
108         DO_IRIS_WIPE,
109         DO_CLOCK_WIPE
110 };
111
112 struct SeqEffectHandle {
113         /* constructors & destructor */
114         /* init is _only_ called on first creation */
115         void (*init)(struct Sequence *seq);
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, short adrcode, float *ymin, float *ymax);
139         
140         /* stores the default facf0 and facf1 if no IPO is present */
141         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
142         
143         /* execute the effect
144          * sequence effects are only required to either support
145          * float-rects or byte-rects
146          * (mixed cases are handled one layer up...) */
147         
148         struct ImBuf * (*execute)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
149                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
150 };
151
152 /* ********************* prototypes *************** */
153
154 /* **********************************************************************
155  * sequencer.c
156  *
157  * sequencer render functions
158  * ********************************************************************** */
159
160 struct ImBuf *BKE_sequencer_give_ibuf(SeqRenderData context, float cfra, int chanshown);
161 struct ImBuf *BKE_sequencer_give_ibuf_threaded(SeqRenderData context, float cfra, int chanshown);
162 struct ImBuf *BKE_sequencer_give_ibuf_direct(SeqRenderData context, float cfra, struct Sequence *seq);
163 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
164 void BKE_sequencer_give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
165
166 /* **********************************************************************
167  * sequencer scene functions
168  * ********************************************************************** */
169 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, int alloc);
170 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
171 void             BKE_sequencer_editing_free(struct Scene *scene);
172
173 void             BKE_sequencer_sort(struct Scene *scene);
174
175 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
176 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
177 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
178 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
179
180 /* apply functions recursively */
181 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
182 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
183
184 /* maintenance functions, mostly for RNA */
185 /* extern  */
186
187 void BKE_sequencer_free_clipboard(void);
188
189 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
190 const char *BKE_sequence_give_name(struct Sequence *seq);
191 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
192 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
193 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, int lock_range);
194 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
195
196 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
197
198 /* intern */
199 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
200 int BKE_sequencer_input_have_to_preprocess(SeqRenderData context, struct Sequence *seq, float cfra);
201
202 struct SeqIndexBuildContext *BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq);
203 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
204 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, short stop);
205
206 /* **********************************************************************
207  * seqcache.c
208  *
209  * Sequencer memory cache management functions
210  * ********************************************************************** */
211
212 typedef enum {
213         SEQ_STRIPELEM_IBUF,
214         SEQ_STRIPELEM_IBUF_COMP,
215         SEQ_STRIPELEM_IBUF_STARTSTILL,
216         SEQ_STRIPELEM_IBUF_ENDSTILL
217 } seq_stripelem_ibuf_t;
218
219 void BKE_sequencer_cache_destruct(void);
220 void BKE_sequencer_cache_cleanup(void);
221
222 /* returned ImBuf is properly refed and has to be freed */
223 struct ImBuf *BKE_sequencer_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
224
225 /* passed ImBuf is properly refed, so ownership is *not* 
226  * transfered to the cache.
227  * you can pass the same ImBuf multiple times to the cache without problems.
228  */
229
230 void BKE_sequencer_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *nval);
231
232 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
233
234 /* **********************************************************************
235  * seqeffects.c
236  *
237  * Sequencer effect strip managment functions
238  *  **********************************************************************
239  */
240
241 /* intern */
242 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
243 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
244
245 /* extern */
246 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
247 int BKE_sequence_effect_get_num_inputs(int seq_type);
248
249 /* **********************************************************************
250  * Sequencer editing functions
251  * **********************************************************************
252  */
253    
254 /* for transform but also could use elsewhere */
255 int BKE_sequence_tx_get_final_left(struct Sequence *seq, int metaclip);
256 int BKE_sequence_tx_get_final_right(struct Sequence *seq, int metaclip);
257 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
258 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
259 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
260 int BKE_sequence_tx_test(struct Sequence *seq);
261 int BKE_sequence_single_check(struct Sequence *seq);
262 void BKE_sequence_single_fix(struct Sequence *seq);
263 int BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
264 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
265 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
266 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
267 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
268 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
269
270 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
271 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
272 int BKE_sequence_base_shuffle(struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
273 int BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
274 int BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
275 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, int check_mem_usage, int keep_file_handles);
276 struct Sequence *BKE_sequence_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence *seq, int dupe_flag);
277 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
278
279 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
280
281 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
282 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
283 void BKE_sequencer_update_muting(struct Editing *ed);
284 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
285
286 void BKE_seqence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
287 void BKE_sequence_base_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
288
289 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
290
291 struct Sequence *BKE_sequwnce_get_by_name(struct ListBase *seqbase, const char *name, int recursive);
292
293 /* api for adding new sequence strips */
294 typedef struct SeqLoadInfo {
295         int start_frame;
296         int end_frame;
297         int channel;
298         int flag;   /* use sound, replace sel */
299         int type;
300         int tot_success;
301         int tot_error;
302         int len;        /* only for image strips */
303         char path[512];
304         char name[64];
305 } SeqLoadInfo;
306
307 /* SeqLoadInfo.flag */
308 #define SEQ_LOAD_REPLACE_SEL    (1 << 0)
309 #define SEQ_LOAD_FRAME_ADVANCE  (1 << 1)
310 #define SEQ_LOAD_MOVIE_SOUND    (1 << 2)
311 #define SEQ_LOAD_SOUND_CACHE    (1 << 3)
312
313
314 /* seq_dupli' flags */
315 #define SEQ_DUPE_UNIQUE_NAME    (1 << 0)
316 #define SEQ_DUPE_CONTEXT        (1 << 1)
317 #define SEQ_DUPE_ANIM           (1 << 2)
318 #define SEQ_DUPE_ALL            (1 << 3) /* otherwise only selected are copied */
319
320 /* use as an api function */
321 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
322
323 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
324
325 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
326 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
327 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
328
329 /* view3d draw callback, run when not in background view */
330 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, int, char[256]);
331 extern SequencerDrawView sequencer_view3d_cb;
332
333 /* copy/paste */
334 extern ListBase seqbase_clipboard;
335 extern int seqbase_clipboard_frame;
336
337 #endif /* __BKE_SEQUENCER_H__ */