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