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