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