Glyph cache is cleared by UI_view2d_zoom_cache_reset, when zooming V2D, but is requir...
[blender.git] / source / blender / blenkernel / BKE_sequencer.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2004 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_SEQUENCER_H__
21 #define __BKE_SEQUENCER_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 struct Depsgraph;
28 struct Editing;
29 struct GPUFX;
30 struct GPUOffScreen;
31 struct GSet;
32 struct ImBuf;
33 struct Main;
34 struct Mask;
35 struct RenderEngineType;
36 struct Scene;
37 struct Sequence;
38 struct SequenceModifierData;
39 struct Stereo3dFormat;
40 struct StripColorBalance;
41 struct StripElem;
42 struct TextVars;
43 struct bContext;
44 struct bSound;
45
46 struct SeqIndexBuildContext;
47
48 #define EARLY_NO_INPUT      -1
49 #define EARLY_DO_EFFECT     0
50 #define EARLY_USE_INPUT_1   1
51 #define EARLY_USE_INPUT_2   2
52
53 /* sequence iterator */
54
55 typedef struct SeqIterator {
56         struct Sequence **array;
57         int tot, cur;
58
59         struct Sequence *seq;
60         int valid;
61 } SeqIterator;
62
63 void BKE_sequence_iterator_begin(struct Editing *ed, SeqIterator *iter, bool use_pointer);
64 void BKE_sequence_iterator_next(SeqIterator *iter);
65 void BKE_sequence_iterator_end(SeqIterator *iter);
66
67 #define SEQP_BEGIN(_ed, _seq)                                                 \
68         {                                                                         \
69                 SeqIterator iter_macro;                                               \
70                 for (BKE_sequence_iterator_begin(_ed, &iter_macro, true);             \
71                      iter_macro.valid;                                                \
72                      BKE_sequence_iterator_next(&iter_macro))                         \
73                 {                                                                     \
74                         _seq = iter_macro.seq;
75
76 #define SEQ_BEGIN(ed, _seq)                                                   \
77         {                                                                         \
78                 SeqIterator iter_macro;                                               \
79                 for (BKE_sequence_iterator_begin(ed, &iter_macro, false);             \
80                      iter_macro.valid;                                                \
81                      BKE_sequence_iterator_next(&iter_macro))                         \
82                 {                                                                     \
83                         _seq = iter_macro.seq;
84
85 #define SEQ_END                                                               \
86                 }                                                                     \
87                 BKE_sequence_iterator_end(&iter_macro);                               \
88         } ((void)0)
89
90 typedef struct SeqRenderData {
91         struct Main *bmain;
92         struct Depsgraph *depsgraph;
93         struct Scene *scene;
94         int rectx;
95         int recty;
96         int preview_render_size;
97         int for_render;
98         int motion_blur_samples;
99         float motion_blur_shutter;
100         bool skip_cache;
101         bool is_proxy_render;
102         int view_id;
103
104         /* special case for OpenGL render */
105         struct GPUOffScreen *gpu_offscreen;
106         struct GPUFX *gpu_fx;
107         int gpu_samples;
108         bool gpu_full_samples;
109 } SeqRenderData;
110
111 void BKE_sequencer_new_render_data(
112         struct Main *bmain, struct Depsgraph *depsgraph, struct Scene *scene,
113         int rectx, int recty, int preview_render_size,
114         int for_render,
115         SeqRenderData *r_context);
116
117 int BKE_sequencer_cmp_time_startdisp(const void *a, const void *b);
118
119 /* Wipe effect */
120 enum {
121         DO_SINGLE_WIPE,
122         DO_DOUBLE_WIPE,
123         DO_BOX_WIPE,
124         DO_CROSS_WIPE,
125         DO_IRIS_WIPE,
126         DO_CLOCK_WIPE,
127 };
128
129 struct SeqEffectHandle {
130         bool multithreaded;
131         bool supports_mask;
132
133         /* constructors & destructor */
134         /* init is _only_ called on first creation */
135         void (*init)(struct Sequence *seq);
136
137         /* number of input strips needed
138          * (called directly after construction) */
139         int (*num_inputs)(void);
140
141         /* load is called first time after readblenfile in
142          * get_sequence_effect automatically */
143         void (*load)(struct Sequence *seqconst);
144
145         /* duplicate */
146         void (*copy)(struct Sequence *dst, struct Sequence *src, const int flag);
147
148         /* destruct */
149         void (*free)(struct Sequence *seq, const bool do_id_user);
150
151         /* returns: -1: no input needed,
152          * 0: no early out,
153          * 1: out = ibuf1,
154          * 2: out = ibuf2 */
155         int (*early_out)(struct Sequence *seq, float facf0, float facf1);
156
157         /* stores the y-range of the effect IPO */
158         void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
159
160         /* stores the default facf0 and facf1 if no IPO is present */
161         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
162
163         /* execute the effect
164          * sequence effects are only required to either support
165          * float-rects or byte-rects
166          * (mixed cases are handled one layer up...) */
167
168         struct ImBuf * (*execute)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
169                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
170
171         struct ImBuf * (*init_execution)(const SeqRenderData *context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
172                                          struct ImBuf *ibuf3);
173
174         void (*execute_slice)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
175                               struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
176                               int start_line, int total_lines, struct ImBuf *out);
177 };
178
179 /* ********************* prototypes *************** */
180
181 /* **********************************************************************
182  * sequencer.c
183  *
184  * sequencer render functions
185  * ********************************************************************** */
186
187 struct ImBuf *BKE_sequencer_give_ibuf(const SeqRenderData *context, float cfra, int chanshown);
188 struct ImBuf *BKE_sequencer_give_ibuf_threaded(const SeqRenderData *context, float cfra, int chanshown);
189 struct ImBuf *BKE_sequencer_give_ibuf_direct(const SeqRenderData *context, float cfra, struct Sequence *seq);
190 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(const SeqRenderData *context, float cfra, int chan_shown, struct ListBase *seqbasep);
191 void BKE_sequencer_give_ibuf_prefetch_request(const SeqRenderData *context, float cfra, int chan_shown);
192
193 /* **********************************************************************
194  * sequencer.c
195  *
196  * sequencer color space functions
197  * ********************************************************************** */
198
199 void BKE_sequencer_imbuf_to_sequencer_space(struct Scene *scene, struct ImBuf *ibuf, bool make_float);
200 void BKE_sequencer_imbuf_from_sequencer_space(struct Scene *scene, struct ImBuf *ibuf);
201 void BKE_sequencer_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4]);
202
203 /* **********************************************************************
204  * sequencer scene functions
205  * ********************************************************************** */
206 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, bool alloc);
207 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
208 void             BKE_sequencer_editing_free(struct Scene *scene, const bool do_id_user);
209
210 void             BKE_sequencer_sort(struct Scene *scene);
211
212 struct Sequence *BKE_sequencer_from_elem(ListBase *seqbase, struct StripElem *se);
213 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
214 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
215 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
216 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
217
218 /* apply functions recursively */
219 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
220 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
221
222 /* maintenance functions, mostly for RNA */
223 /* extern  */
224
225 void BKE_sequencer_free_clipboard(void);
226
227 void BKE_sequencer_base_clipboard_pointers_free(struct ListBase *seqbase);
228 void BKE_sequencer_base_clipboard_pointers_store(struct Main *bmain, struct ListBase *seqbase);
229 void BKE_sequencer_base_clipboard_pointers_restore(struct ListBase *seqbase, struct Main *bmain);
230
231 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
232 void BKE_sequence_free_anim(struct Sequence *seq);
233 const char *BKE_sequence_give_name(struct Sequence *seq);
234 ListBase *BKE_sequence_seqbase_get(struct Sequence *seq, int *r_offset);
235 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
236 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
237 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, const bool lock_range);
238 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
239
240 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
241
242 /* intern */
243 double seq_rendersize_to_scale_factor(int size);
244 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
245 bool BKE_sequencer_input_have_to_preprocess(const SeqRenderData *context, struct Sequence *seq, float cfra);
246
247 void BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Depsgraph *depsgraph, struct Scene *scene, struct Sequence *seq, struct GSet *file_list, ListBase *queue);
248 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
249 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, bool stop);
250
251 void BKE_sequencer_proxy_set(struct Sequence *seq, bool value);
252 /* **********************************************************************
253  * seqcache.c
254  *
255  * Sequencer memory cache management functions
256  * ********************************************************************** */
257
258 typedef enum {
259         SEQ_STRIPELEM_IBUF,
260         SEQ_STRIPELEM_IBUF_COMP,
261         SEQ_STRIPELEM_IBUF_STARTSTILL,
262         SEQ_STRIPELEM_IBUF_ENDSTILL
263 } eSeqStripElemIBuf;
264
265 void BKE_sequencer_cache_destruct(void);
266 void BKE_sequencer_cache_cleanup(void);
267
268 /* returned ImBuf is properly refed and has to be freed */
269 struct ImBuf *BKE_sequencer_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
270
271 /* passed ImBuf is properly refed, so ownership is *not*
272  * transferred to the cache.
273  * you can pass the same ImBuf multiple times to the cache without problems.
274  */
275
276 void BKE_sequencer_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *nval);
277
278 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
279
280 struct ImBuf *BKE_sequencer_preprocessed_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
281 void BKE_sequencer_preprocessed_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *ibuf);
282 void BKE_sequencer_preprocessed_cache_cleanup(void);
283 void BKE_sequencer_preprocessed_cache_cleanup_sequence(struct Sequence *seq);
284
285 /* **********************************************************************
286  * seqeffects.c
287  *
288  * Sequencer effect strip management functions
289  *  **********************************************************************
290  */
291
292 /* intern */
293 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
294 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, bool force);
295
296 /* extern */
297 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
298 int BKE_sequence_effect_get_num_inputs(int seq_type);
299 int BKE_sequence_effect_get_supports_mask(int seq_type);
300 void BKE_sequencer_text_font_unload(struct TextVars *data, const bool do_id_user);
301 void BKE_sequencer_text_font_load(struct TextVars *data, const bool do_id_user);
302
303
304 /* **********************************************************************
305  * Sequencer editing functions
306  * **********************************************************************
307  */
308
309 /* for transform but also could use elsewhere */
310 int BKE_sequence_tx_get_final_left(struct Sequence *seq, bool metaclip);
311 int BKE_sequence_tx_get_final_right(struct Sequence *seq, bool metaclip);
312 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
313 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
314 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
315 bool BKE_sequence_tx_test(struct Sequence *seq);
316 bool BKE_sequence_tx_fullupdate_test(struct Sequence *seq);
317 bool BKE_sequence_single_check(struct Sequence *seq);
318 void BKE_sequence_single_fix(struct Sequence *seq);
319 bool BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
320 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
321 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
322 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
323 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
324 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
325
326 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
327 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
328 bool BKE_sequence_base_shuffle_ex(
329         struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene,
330         int channel_delta);
331 bool BKE_sequence_base_shuffle(
332         struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
333 bool BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
334 bool BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
335 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, bool for_render);
336 struct Sequence *BKE_sequence_dupli_recursive(
337         const struct Scene *scene_src, struct Scene *scene_dst,
338         struct ListBase *new_seq_list, struct Sequence *seq, int dupe_flag);
339 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
340
341 bool BKE_sequence_check_depend(struct Sequence *seq, struct Sequence *cur);
342 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
343 void BKE_sequence_invalidate_dependent(struct Scene *scene, struct Sequence *seq);
344 void BKE_sequence_invalidate_cache_for_modifier(struct Scene *scene, struct Sequence *seq);
345
346 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
347 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
348 void BKE_sequencer_update_muting(struct Editing *ed);
349 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
350
351 void BKE_sequencer_refresh_sound_length(struct Scene *scene);
352
353 void BKE_sequence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
354 void BKE_sequence_base_dupli_recursive(
355         const struct Scene *scene_src, struct Scene *scene_dst, struct ListBase *nseqbase, const struct ListBase *seqbase,
356         int dupe_flag, const int flag);
357 bool BKE_sequence_is_valid_check(struct Sequence *seq);
358
359 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
360
361 struct Sequence *BKE_sequence_get_by_name(struct ListBase *seqbase, const char *name, bool recursive);
362
363 /* api for adding new sequence strips */
364 typedef struct SeqLoadInfo {
365         int start_frame;
366         int end_frame;
367         int channel;
368         int flag;   /* use sound, replace sel */
369         int type;
370         int len;        /* only for image strips */
371         char path[1024]; /* 1024 = FILE_MAX */
372
373         /* multiview */
374         char views_format;
375         struct Stereo3dFormat *stereo3d_format;
376
377         /* return values */
378         char name[64];
379         struct Sequence *seq_sound;  /* for movie's */
380         int tot_success;
381         int tot_error;
382 } SeqLoadInfo;
383
384 /* SeqLoadInfo.flag */
385 #define SEQ_LOAD_REPLACE_SEL    (1 << 0)
386 #define SEQ_LOAD_FRAME_ADVANCE  (1 << 1)
387 #define SEQ_LOAD_MOVIE_SOUND    (1 << 2)
388 #define SEQ_LOAD_SOUND_CACHE    (1 << 3)
389 #define SEQ_LOAD_SYNC_FPS       (1 << 4)
390 #define SEQ_LOAD_SOUND_MONO     (1 << 5)
391
392
393 /* seq_dupli' flags */
394 #define SEQ_DUPE_UNIQUE_NAME    (1 << 0)
395 #define SEQ_DUPE_CONTEXT        (1 << 1)
396 #define SEQ_DUPE_ANIM           (1 << 2)
397 #define SEQ_DUPE_ALL            (1 << 3) /* otherwise only selected are copied */
398
399 /* use as an api function */
400 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
401
402 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
403
404 void BKE_sequence_alpha_mode_from_extension(struct Sequence *seq);
405 void BKE_sequence_init_colorspace(struct Sequence *seq);
406
407 float BKE_sequence_get_fps(struct Scene *scene, struct Sequence *seq);
408
409 /* RNA enums, just to be more readable */
410 enum {
411         SEQ_SIDE_NONE = 0,
412         SEQ_SIDE_LEFT,
413         SEQ_SIDE_RIGHT,
414         SEQ_SIDE_BOTH,
415 };
416 int BKE_sequencer_find_next_prev_edit(
417         struct Scene *scene, int cfra, const short side,
418         const bool do_skip_mute, const bool do_center, const bool do_unselected);
419
420 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
421 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
422 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
423
424 /* view3d draw callback, run when not in background view */
425 /* NOTE: Keep in sync with V3D_OFSDRAW_* flags. */
426 enum {
427     SEQ_OFSDRAW_NONE             = (0),
428     SEQ_OFSDRAW_USE_BACKGROUND   = (1 << 0),
429     SEQ_OFSDRAW_USE_FULL_SAMPLE  = (1 << 1),
430     SEQ_OFSDRAW_USE_GPENCIL      = (1 << 2),
431     SEQ_OFSDRAW_USE_SOLID_TEX    = (1 << 2),
432     SEQ_OFSDRAW_USE_CAMERA_DOF   = (1 << 3),
433 };
434
435 typedef struct ImBuf *(*SequencerDrawView)(
436         struct Depsgraph *depsgraph, struct Scene *scene,
437         int drawtype,
438         struct Object *camera, int width, int height,
439         unsigned int flag, unsigned int draw_flags, int alpha_mode,
440         int samples, const char *viewname,
441         struct GPUOffScreen *ofs, char err_out[256]);
442 extern SequencerDrawView sequencer_view3d_cb;
443
444 /* copy/paste */
445 extern ListBase seqbase_clipboard;
446 extern int seqbase_clipboard_frame;
447
448 /* modifiers */
449 typedef struct SequenceModifierTypeInfo {
450         /* default name for the modifier */
451         char name[64];  /* MAX_NAME */
452
453         /* DNA structure name used on load/save filed */
454         char struct_name[64];  /* MAX_NAME */
455
456         /* size of modifier data structure, used by allocation */
457         int struct_size;
458
459         /* data initialization */
460         void (*init_data) (struct SequenceModifierData *smd);
461
462         /* free data used by modifier,
463          * only modifier-specific data should be freed, modifier descriptor would
464          * be freed outside of this callback
465          */
466         void (*free_data) (struct SequenceModifierData *smd);
467
468         /* copy data from one modifier to another */
469         void (*copy_data) (struct SequenceModifierData *smd, struct SequenceModifierData *target);
470
471         /* apply modifier on a given image buffer */
472         void (*apply) (struct SequenceModifierData *smd, struct ImBuf *ibuf, struct ImBuf *mask);
473 } SequenceModifierTypeInfo;
474
475 const struct SequenceModifierTypeInfo *BKE_sequence_modifier_type_info_get(int type);
476
477 struct SequenceModifierData *BKE_sequence_modifier_new(struct Sequence *seq, const char *name, int type);
478 bool BKE_sequence_modifier_remove(struct Sequence *seq, struct SequenceModifierData *smd);
479 void BKE_sequence_modifier_clear(struct Sequence *seq);
480 void BKE_sequence_modifier_free(struct SequenceModifierData *smd);
481 void BKE_sequence_modifier_unique_name(struct Sequence *seq, struct SequenceModifierData *smd);
482 struct SequenceModifierData *BKE_sequence_modifier_find_by_name(struct Sequence *seq, const char *name);
483 struct ImBuf *BKE_sequence_modifier_apply_stack(const SeqRenderData *context, struct Sequence *seq, struct ImBuf *ibuf, int cfra);
484 void BKE_sequence_modifier_list_copy(struct Sequence *seqn, struct Sequence *seq);
485
486 int BKE_sequence_supports_modifiers(struct Sequence *seq);
487
488 /* internal filters */
489 struct ImBuf *BKE_sequencer_render_mask_input(
490         const SeqRenderData *context, int mask_input_type, struct Sequence *mask_sequence, struct Mask *mask_id,
491         int cfra, int fra_offset, bool make_float);
492 void BKE_sequencer_color_balance_apply(struct StripColorBalance *cb, struct ImBuf *ibuf, float mul, bool make_float, struct ImBuf *mask_input);
493
494 void BKE_sequencer_all_free_anim_ibufs(struct Main *bmain, int cfra);
495
496 #endif  /* __BKE_SEQUENCER_H__ */