Sequencer: refactor clipboard copy to no longer increase user count.
[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 Depsgraph;
35 struct StripColorBalance;
36 struct Editing;
37 struct GSet;
38 struct GPUOffScreen;
39 struct GPUFX;
40 struct ImBuf;
41 struct Main;
42 struct Mask;
43 struct RenderEngineType;
44 struct Scene;
45 struct Sequence;
46 struct SequenceModifierData;
47 struct Stereo3dFormat;
48 struct StripElem;
49 struct bSound;
50
51 struct SeqIndexBuildContext;
52
53 #define EARLY_NO_INPUT      -1
54 #define EARLY_DO_EFFECT     0
55 #define EARLY_USE_INPUT_1   1
56 #define EARLY_USE_INPUT_2   2
57
58 /* sequence iterator */
59
60 typedef struct SeqIterator {
61         struct Sequence **array;
62         int tot, cur;
63
64         struct Sequence *seq;
65         int valid;
66 } SeqIterator;
67
68 void BKE_sequence_iterator_begin(struct Editing *ed, SeqIterator *iter, bool use_pointer);
69 void BKE_sequence_iterator_next(SeqIterator *iter);
70 void BKE_sequence_iterator_end(SeqIterator *iter);
71
72 #define SEQP_BEGIN(_ed, _seq)                                                 \
73         {                                                                         \
74                 SeqIterator iter_macro;                                               \
75                 for (BKE_sequence_iterator_begin(_ed, &iter_macro, true);             \
76                      iter_macro.valid;                                                \
77                      BKE_sequence_iterator_next(&iter_macro))                         \
78                 {                                                                     \
79                         _seq = iter_macro.seq;
80
81 #define SEQ_BEGIN(ed, _seq)                                                   \
82         {                                                                         \
83                 SeqIterator iter_macro;                                               \
84                 for (BKE_sequence_iterator_begin(ed, &iter_macro, false);             \
85                      iter_macro.valid;                                                \
86                      BKE_sequence_iterator_next(&iter_macro))                         \
87                 {                                                                     \
88                         _seq = iter_macro.seq;
89
90 #define SEQ_END                                                               \
91                 }                                                                     \
92                 BKE_sequence_iterator_end(&iter_macro);                               \
93         } ((void)0)
94
95 typedef struct SeqRenderData {
96         struct Main *bmain;
97         struct Depsgraph *depsgraph;
98         struct Scene *scene;
99         int rectx;
100         int recty;
101         int preview_render_size;
102         int for_render;
103         int motion_blur_samples;
104         float motion_blur_shutter;
105         bool skip_cache;
106         bool is_proxy_render;
107         int view_id;
108
109         /* special case for OpenGL render */
110         struct GPUOffScreen *gpu_offscreen;
111         struct GPUFX *gpu_fx;
112         int gpu_samples;
113         bool gpu_full_samples;
114 } SeqRenderData;
115
116 void BKE_sequencer_new_render_data(
117         struct Main *bmain, struct Depsgraph *depsgraph, struct Scene *scene,
118         int rectx, int recty, int preview_render_size,
119         int for_render,
120         SeqRenderData *r_context);
121
122 int BKE_sequencer_cmp_time_startdisp(const void *a, const void *b);
123
124 /* Wipe effect */
125 enum {
126         DO_SINGLE_WIPE,
127         DO_DOUBLE_WIPE,
128         DO_BOX_WIPE,
129         DO_CROSS_WIPE,
130         DO_IRIS_WIPE,
131         DO_CLOCK_WIPE
132 };
133
134 struct SeqEffectHandle {
135         bool multithreaded;
136         bool supports_mask;
137
138         /* constructors & destructor */
139         /* init is _only_ called on first creation */
140         void (*init)(struct Sequence *seq);
141
142         /* number of input strips needed
143          * (called directly after construction) */
144         int (*num_inputs)(void);
145
146         /* load is called first time after readblenfile in
147          * get_sequence_effect automatically */
148         void (*load)(struct Sequence *seq);
149
150         /* duplicate */
151         void (*copy)(struct Sequence *dst, struct Sequence *src, const int flag);
152
153         /* destruct */
154         void (*free)(struct Sequence *seq, const bool do_id_user);
155
156         /* returns: -1: no input needed,
157          * 0: no early out,
158          * 1: out = ibuf1,
159          * 2: out = ibuf2 */
160         int (*early_out)(struct Sequence *seq, float facf0, float facf1);
161
162         /* stores the y-range of the effect IPO */
163         void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
164
165         /* stores the default facf0 and facf1 if no IPO is present */
166         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
167
168         /* execute the effect
169          * sequence effects are only required to either support
170          * float-rects or byte-rects
171          * (mixed cases are handled one layer up...) */
172
173         struct ImBuf * (*execute)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
174                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
175
176         struct ImBuf * (*init_execution)(const SeqRenderData *context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
177                                          struct ImBuf *ibuf3);
178
179         void (*execute_slice)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
180                               struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
181                               int start_line, int total_lines, struct ImBuf *out);
182 };
183
184 /* ********************* prototypes *************** */
185
186 /* **********************************************************************
187  * sequencer.c
188  *
189  * sequencer render functions
190  * ********************************************************************** */
191
192 struct ImBuf *BKE_sequencer_give_ibuf(const SeqRenderData *context, float cfra, int chanshown);
193 struct ImBuf *BKE_sequencer_give_ibuf_threaded(const SeqRenderData *context, float cfra, int chanshown);
194 struct ImBuf *BKE_sequencer_give_ibuf_direct(const SeqRenderData *context, float cfra, struct Sequence *seq);
195 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(const SeqRenderData *context, float cfra, int chan_shown, struct ListBase *seqbasep);
196 void BKE_sequencer_give_ibuf_prefetch_request(const SeqRenderData *context, float cfra, int chan_shown);
197
198 /* **********************************************************************
199  * sequencer.c
200  *
201  * sequencer color space functions
202  * ********************************************************************** */
203
204 void BKE_sequencer_imbuf_to_sequencer_space(struct Scene *scene, struct ImBuf *ibuf, bool make_float);
205 void BKE_sequencer_imbuf_from_sequencer_space(struct Scene *scene, struct ImBuf *ibuf);
206 void BKE_sequencer_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4]);
207
208 /* **********************************************************************
209  * sequencer scene functions
210  * ********************************************************************** */
211 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, bool alloc);
212 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
213 void             BKE_sequencer_editing_free(struct Scene *scene, const bool do_id_user);
214
215 void             BKE_sequencer_sort(struct Scene *scene);
216
217 struct Sequence *BKE_sequencer_from_elem(ListBase *seqbase, struct StripElem *se);
218 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
219 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
220 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
221 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
222
223 /* apply functions recursively */
224 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
225 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
226
227 /* maintenance functions, mostly for RNA */
228 /* extern  */
229
230 void BKE_sequencer_free_clipboard(void);
231
232 void BKE_sequencer_base_clipboard_pointers_free(struct ListBase *seqbase);
233 void BKE_sequencer_base_clipboard_pointers_store(struct Main *bmain, struct ListBase *seqbase);
234 void BKE_sequencer_base_clipboard_pointers_restore(struct ListBase *seqbase, struct Main *bmain);
235
236 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
237 void BKE_sequence_free_anim(struct Sequence *seq);
238 const char *BKE_sequence_give_name(struct Sequence *seq);
239 ListBase *BKE_sequence_seqbase_get(struct Sequence *seq, int *r_offset);
240 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
241 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
242 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, const bool lock_range);
243 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
244
245 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
246
247 /* intern */
248 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
249 bool BKE_sequencer_input_have_to_preprocess(const SeqRenderData *context, struct Sequence *seq, float cfra);
250
251 void BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Depsgraph *depsgraph, struct Scene *scene, struct Sequence *seq, struct GSet *file_list, ListBase *queue);
252 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
253 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, bool stop);
254
255 void BKE_sequencer_proxy_set(struct Sequence *seq, bool value);
256 /* **********************************************************************
257  * seqcache.c
258  *
259  * Sequencer memory cache management functions
260  * ********************************************************************** */
261
262 typedef enum {
263         SEQ_STRIPELEM_IBUF,
264         SEQ_STRIPELEM_IBUF_COMP,
265         SEQ_STRIPELEM_IBUF_STARTSTILL,
266         SEQ_STRIPELEM_IBUF_ENDSTILL
267 } eSeqStripElemIBuf;
268
269 void BKE_sequencer_cache_destruct(void);
270 void BKE_sequencer_cache_cleanup(void);
271
272 /* returned ImBuf is properly refed and has to be freed */
273 struct ImBuf *BKE_sequencer_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
274
275 /* passed ImBuf is properly refed, so ownership is *not*
276  * transferred to the cache.
277  * you can pass the same ImBuf multiple times to the cache without problems.
278  */
279
280 void BKE_sequencer_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *nval);
281
282 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
283
284 struct ImBuf *BKE_sequencer_preprocessed_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
285 void BKE_sequencer_preprocessed_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *ibuf);
286 void BKE_sequencer_preprocessed_cache_cleanup(void);
287 void BKE_sequencer_preprocessed_cache_cleanup_sequence(struct Sequence *seq);
288
289 /* **********************************************************************
290  * seqeffects.c
291  *
292  * Sequencer effect strip management functions
293  *  **********************************************************************
294  */
295
296 /* intern */
297 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
298 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, bool force);
299
300 /* extern */
301 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
302 int BKE_sequence_effect_get_num_inputs(int seq_type);
303 int BKE_sequence_effect_get_supports_mask(int seq_type);
304
305 /* **********************************************************************
306  * Sequencer editing functions
307  * **********************************************************************
308  */
309
310 /* for transform but also could use elsewhere */
311 int BKE_sequence_tx_get_final_left(struct Sequence *seq, bool metaclip);
312 int BKE_sequence_tx_get_final_right(struct Sequence *seq, bool metaclip);
313 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
314 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
315 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
316 bool BKE_sequence_tx_test(struct Sequence *seq);
317 bool BKE_sequence_tx_fullupdate_test(struct Sequence *seq);
318 bool BKE_sequence_single_check(struct Sequence *seq);
319 void BKE_sequence_single_fix(struct Sequence *seq);
320 bool BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
321 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
322 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
323 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
324 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
325 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
326
327 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
328 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
329 bool BKE_sequence_base_shuffle_ex(
330         struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene,
331         int channel_delta);
332 bool BKE_sequence_base_shuffle(
333         struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
334 bool BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
335 bool BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
336 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, bool for_render);
337 struct Sequence *BKE_sequence_dupli_recursive(
338         const struct Scene *scene_src, struct Scene *scene_dst, 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)  /* WARNING: does NOT work when duplicating Meta strips! */
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__ */