2 * ***** BEGIN GPL LICENSE BLOCK *****
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.
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.
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.
18 * The Original Code is Copyright (C) 2004 Blender Foundation.
19 * All rights reserved.
21 * Contributor(s): Blender Foundation (2008).
23 * ***** END GPL LICENSE BLOCK *****
26 #ifndef __BKE_SEQUENCER_H__
27 #define __BKE_SEQUENCER_H__
29 /** \file BKE_sequencer.h
34 struct EvaluationContext;
35 struct StripColorBalance;
45 struct SequenceModifierData;
46 struct Stereo3dFormat;
50 struct SeqIndexBuildContext;
52 #define EARLY_NO_INPUT -1
53 #define EARLY_DO_EFFECT 0
54 #define EARLY_USE_INPUT_1 1
55 #define EARLY_USE_INPUT_2 2
57 /* sequence iterator */
59 typedef struct SeqIterator {
60 struct Sequence **array;
67 void BKE_sequence_iterator_begin(struct Editing *ed, SeqIterator *iter, bool use_pointer);
68 void BKE_sequence_iterator_next(SeqIterator *iter);
69 void BKE_sequence_iterator_end(SeqIterator *iter);
71 #define SEQP_BEGIN(_ed, _seq) \
73 SeqIterator iter_macro; \
74 for (BKE_sequence_iterator_begin(_ed, &iter_macro, true); \
76 BKE_sequence_iterator_next(&iter_macro)) \
78 _seq = iter_macro.seq;
80 #define SEQ_BEGIN(ed, _seq) \
82 SeqIterator iter_macro; \
83 for (BKE_sequence_iterator_begin(ed, &iter_macro, false); \
85 BKE_sequence_iterator_next(&iter_macro)) \
87 _seq = iter_macro.seq;
91 BKE_sequence_iterator_end(&iter_macro); \
94 typedef struct SeqRenderData {
95 struct EvaluationContext *eval_ctx;
100 int preview_render_size;
101 int motion_blur_samples;
102 float motion_blur_shutter;
104 bool is_proxy_render;
107 /* special case for OpenGL render */
108 struct GPUOffScreen *gpu_offscreen;
109 struct GPUFX *gpu_fx;
111 bool gpu_full_samples;
114 void BKE_sequencer_new_render_data(
115 struct EvaluationContext *eval_ctx, struct Main *bmain, struct Scene *scene,
116 int rectx, int recty, int preview_render_size,
117 SeqRenderData *r_context);
119 int BKE_sequencer_cmp_time_startdisp(const void *a, const void *b);
131 struct SeqEffectHandle {
135 /* constructors & destructor */
136 /* init is _only_ called on first creation */
137 void (*init)(struct Sequence *seq);
139 /* number of input strips needed
140 * (called directly after construction) */
141 int (*num_inputs)(void);
143 /* load is called first time after readblenfile in
144 * get_sequence_effect automatically */
145 void (*load)(struct Sequence *seq);
148 void (*copy)(struct Sequence *dst, struct Sequence *src);
151 void (*free)(struct Sequence *seq);
153 /* returns: -1: no input needed,
157 int (*early_out)(struct Sequence *seq, float facf0, float facf1);
159 /* stores the y-range of the effect IPO */
160 void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
162 /* stores the default facf0 and facf1 if no IPO is present */
163 void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
165 /* execute the effect
166 * sequence effects are only required to either support
167 * float-rects or byte-rects
168 * (mixed cases are handled one layer up...) */
170 struct ImBuf * (*execute)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
171 struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
173 struct ImBuf * (*init_execution)(const SeqRenderData *context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
174 struct ImBuf *ibuf3);
176 void (*execute_slice)(const SeqRenderData *context, struct Sequence *seq, float cfra, float facf0, float facf1,
177 struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
178 int start_line, int total_lines, struct ImBuf *out);
181 /* ********************* prototypes *************** */
183 /* **********************************************************************
186 * sequencer render functions
187 * ********************************************************************** */
189 struct ImBuf *BKE_sequencer_give_ibuf(const SeqRenderData *context, float cfra, int chanshown);
190 struct ImBuf *BKE_sequencer_give_ibuf_threaded(const SeqRenderData *context, float cfra, int chanshown);
191 struct ImBuf *BKE_sequencer_give_ibuf_direct(const SeqRenderData *context, float cfra, struct Sequence *seq);
192 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(const SeqRenderData *context, float cfra, int chan_shown, struct ListBase *seqbasep);
193 void BKE_sequencer_give_ibuf_prefetch_request(const SeqRenderData *context, float cfra, int chan_shown);
195 /* **********************************************************************
198 * sequencer color space functions
199 * ********************************************************************** */
201 void BKE_sequencer_imbuf_to_sequencer_space(struct Scene *scene, struct ImBuf *ibuf, bool make_float);
202 void BKE_sequencer_imbuf_from_sequencer_space(struct Scene *scene, struct ImBuf *ibuf);
203 void BKE_sequencer_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4]);
205 /* **********************************************************************
206 * sequencer scene functions
207 * ********************************************************************** */
208 struct Editing *BKE_sequencer_editing_get(struct Scene *scene, bool alloc);
209 struct Editing *BKE_sequencer_editing_ensure(struct Scene *scene);
210 void BKE_sequencer_editing_free(struct Scene *scene);
212 void BKE_sequencer_sort(struct Scene *scene);
214 struct Sequence *BKE_sequencer_from_elem(ListBase *seqbase, struct StripElem *se);
215 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
216 int BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
217 void BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
218 struct Mask *BKE_sequencer_mask_get(struct Scene *scene);
220 /* apply functions recursively */
221 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
222 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
224 /* maintenance functions, mostly for RNA */
227 void BKE_sequencer_free_clipboard(void);
229 void BKE_sequence_clipboard_pointers_free(struct Sequence *seq);
230 void BKE_sequence_clipboard_pointers_store(struct Sequence *seq);
231 void BKE_sequence_clipboard_pointers_restore(struct Sequence *seq, struct Main *bmain);
233 void BKE_sequencer_base_clipboard_pointers_free(struct ListBase *seqbase);
234 void BKE_sequencer_base_clipboard_pointers_store(struct ListBase *seqbase);
235 void BKE_sequencer_base_clipboard_pointers_restore(struct ListBase *seqbase, struct Main *bmain);
237 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
238 void BKE_sequence_free_anim(struct Sequence *seq);
239 const char *BKE_sequence_give_name(struct Sequence *seq);
240 ListBase *BKE_sequence_seqbase_get(struct Sequence *seq, int *r_offset);
241 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
242 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
243 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, const bool lock_range);
244 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
246 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
249 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
250 bool BKE_sequencer_input_have_to_preprocess(const SeqRenderData *context, struct Sequence *seq, float cfra);
252 void BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq, struct GSet *file_list, ListBase *queue);
253 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
254 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, bool stop);
256 void BKE_sequencer_proxy_set(struct Sequence *seq, bool value);
257 /* **********************************************************************
260 * Sequencer memory cache management functions
261 * ********************************************************************** */
265 SEQ_STRIPELEM_IBUF_COMP,
266 SEQ_STRIPELEM_IBUF_STARTSTILL,
267 SEQ_STRIPELEM_IBUF_ENDSTILL
270 void BKE_sequencer_cache_destruct(void);
271 void BKE_sequencer_cache_cleanup(void);
273 /* returned ImBuf is properly refed and has to be freed */
274 struct ImBuf *BKE_sequencer_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
276 /* passed ImBuf is properly refed, so ownership is *not*
277 * transferred to the cache.
278 * you can pass the same ImBuf multiple times to the cache without problems.
281 void BKE_sequencer_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *nval);
283 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
285 struct ImBuf *BKE_sequencer_preprocessed_cache_get(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type);
286 void BKE_sequencer_preprocessed_cache_put(const SeqRenderData *context, struct Sequence *seq, float cfra, eSeqStripElemIBuf type, struct ImBuf *ibuf);
287 void BKE_sequencer_preprocessed_cache_cleanup(void);
288 void BKE_sequencer_preprocessed_cache_cleanup_sequence(struct Sequence *seq);
290 /* **********************************************************************
293 * Sequencer effect strip management functions
294 * **********************************************************************
298 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
299 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, bool force);
302 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
303 int BKE_sequence_effect_get_num_inputs(int seq_type);
304 int BKE_sequence_effect_get_supports_mask(int seq_type);
306 /* **********************************************************************
307 * Sequencer editing functions
308 * **********************************************************************
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);
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,
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, struct Sequence *seq, int dupe_flag);
340 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
342 bool BKE_sequence_check_depend(struct Sequence *seq, struct Sequence *cur);
343 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
344 void BKE_sequence_invalidate_dependent(struct Scene *scene, struct Sequence *seq);
345 void BKE_sequence_invalidate_cache_for_modifier(struct Scene *scene, struct Sequence *seq);
347 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
348 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
349 void BKE_sequencer_update_muting(struct Editing *ed);
350 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
352 void BKE_sequencer_refresh_sound_length(struct Scene *scene);
354 void BKE_sequence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
355 void BKE_sequence_base_dupli_recursive(
356 const struct Scene *scene_src, struct Scene *scene_dst, struct ListBase *nseqbase, const struct ListBase *seqbase,
357 int dupe_flag, const int flag);
358 bool BKE_sequence_is_valid_check(struct Sequence *seq);
360 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
362 struct Sequence *BKE_sequence_get_by_name(struct ListBase *seqbase, const char *name, bool recursive);
364 /* api for adding new sequence strips */
365 typedef struct SeqLoadInfo {
369 int flag; /* use sound, replace sel */
371 int len; /* only for image strips */
372 char path[1024]; /* 1024 = FILE_MAX */
376 struct Stereo3dFormat *stereo3d_format;
380 struct Sequence *seq_sound; /* for movie's */
385 /* SeqLoadInfo.flag */
386 #define SEQ_LOAD_REPLACE_SEL (1 << 0)
387 #define SEQ_LOAD_FRAME_ADVANCE (1 << 1)
388 #define SEQ_LOAD_MOVIE_SOUND (1 << 2)
389 #define SEQ_LOAD_SOUND_CACHE (1 << 3)
390 #define SEQ_LOAD_SYNC_FPS (1 << 4)
391 #define SEQ_LOAD_SOUND_MONO (1 << 5)
394 /* seq_dupli' flags */
395 #define SEQ_DUPE_UNIQUE_NAME (1 << 0)
396 #define SEQ_DUPE_CONTEXT (1 << 1)
397 #define SEQ_DUPE_ANIM (1 << 2)
398 #define SEQ_DUPE_ALL (1 << 3) /* otherwise only selected are copied */
400 /* use as an api function */
401 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
403 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
405 void BKE_sequence_alpha_mode_from_extension(struct Sequence *seq);
406 void BKE_sequence_init_colorspace(struct Sequence *seq);
408 /* RNA enums, just to be more readable */
415 int BKE_sequencer_find_next_prev_edit(
416 struct Scene *scene, int cfra, const short side,
417 const bool do_skip_mute, const bool do_center, const bool do_unselected);
419 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
420 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
421 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
423 /* view3d draw callback, run when not in background view */
424 typedef struct ImBuf *(*SequencerDrawView)(
425 const struct EvaluationContext *eval_ctx, struct Scene *,
426 struct SceneLayer *sl, struct Object *, int, int,
427 unsigned int, int, bool, bool, bool,
428 int, int, bool, const char *,
429 struct GPUFX *, struct GPUOffScreen *, char[256]);
430 extern SequencerDrawView sequencer_view3d_cb;
433 extern ListBase seqbase_clipboard;
434 extern int seqbase_clipboard_frame;
437 typedef struct SequenceModifierTypeInfo {
438 /* default name for the modifier */
439 char name[64]; /* MAX_NAME */
441 /* DNA structure name used on load/save filed */
442 char struct_name[64]; /* MAX_NAME */
444 /* size of modifier data structure, used by allocation */
447 /* data initialization */
448 void (*init_data) (struct SequenceModifierData *smd);
450 /* free data used by modifier,
451 * only modifier-specific data should be freed, modifier descriptor would
452 * be freed outside of this callback
454 void (*free_data) (struct SequenceModifierData *smd);
456 /* copy data from one modifier to another */
457 void (*copy_data) (struct SequenceModifierData *smd, struct SequenceModifierData *target);
459 /* apply modifier on a given image buffer */
460 void (*apply) (struct SequenceModifierData *smd, struct ImBuf *ibuf, struct ImBuf *mask);
461 } SequenceModifierTypeInfo;
463 const struct SequenceModifierTypeInfo *BKE_sequence_modifier_type_info_get(int type);
465 struct SequenceModifierData *BKE_sequence_modifier_new(struct Sequence *seq, const char *name, int type);
466 bool BKE_sequence_modifier_remove(struct Sequence *seq, struct SequenceModifierData *smd);
467 void BKE_sequence_modifier_clear(struct Sequence *seq);
468 void BKE_sequence_modifier_free(struct SequenceModifierData *smd);
469 void BKE_sequence_modifier_unique_name(struct Sequence *seq, struct SequenceModifierData *smd);
470 struct SequenceModifierData *BKE_sequence_modifier_find_by_name(struct Sequence *seq, const char *name);
471 struct ImBuf *BKE_sequence_modifier_apply_stack(const SeqRenderData *context, struct Sequence *seq, struct ImBuf *ibuf, int cfra);
472 void BKE_sequence_modifier_list_copy(struct Sequence *seqn, struct Sequence *seq);
474 int BKE_sequence_supports_modifiers(struct Sequence *seq);
476 /* internal filters */
477 struct ImBuf *BKE_sequencer_render_mask_input(
478 const SeqRenderData *context, int mask_input_type, struct Sequence *mask_sequence, struct Mask *mask_id,
479 int cfra, int fra_offset, bool make_float);
480 void BKE_sequencer_color_balance_apply(struct StripColorBalance *cb, struct ImBuf *ibuf, float mul, bool make_float, struct ImBuf *mask_input);
482 void BKE_sequencer_all_free_anim_ibufs(int cfra);
484 #endif /* __BKE_SEQUENCER_H__ */