[#34013] [video sequence editor] Offset and crop of strips are wrong
[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 StripColorBalance;
35 struct Editing;
36 struct ImBuf;
37 struct Main;
38 struct Mask;
39 struct Scene;
40 struct Sequence;
41 struct SequenceModifierData;
42 struct Strip;
43 struct StripElem;
44 struct bSound;
45
46 struct SeqIndexBuildContext;
47
48 #define BUILD_SEQAR_COUNT_NOTHING  0
49 #define BUILD_SEQAR_COUNT_CURRENT  1
50 #define BUILD_SEQAR_COUNT_CHILDREN 2
51
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
56
57 /* sequence iterator */
58
59 typedef struct SeqIterator {
60         struct Sequence **array;
61         int tot, cur;
62
63         struct Sequence *seq;
64         int valid;
65 } SeqIterator;
66
67 void BKE_sequence_iterator_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
68 void BKE_sequence_iterator_next(SeqIterator *iter);
69 void BKE_sequence_iterator_end(SeqIterator *iter);
70
71 #define SEQP_BEGIN(_ed, _seq)                                                 \
72         {                                                                         \
73                 SeqIterator iter_macro;                                               \
74                 for (BKE_sequence_iterator_begin(_ed, &iter_macro, 1);                \
75                      iter_macro.valid;                                                \
76                      BKE_sequence_iterator_next(&iter_macro))                         \
77                 {                                                                     \
78                         _seq = iter_macro.seq;
79
80 #define SEQ_BEGIN(ed, _seq)                                                   \
81         {                                                                         \
82                 SeqIterator iter_macro;                                               \
83                 for (BKE_sequence_iterator_begin(ed, &iter_macro, 0);                 \
84                      iter_macro.valid;                                                \
85                      BKE_sequence_iterator_next(&iter_macro))                         \
86                 {                                                                     \
87                         _seq = iter_macro.seq;
88
89 #define SEQ_END                                                               \
90                 }                                                                     \
91                 BKE_sequence_iterator_end(&iter_macro);                               \
92         }
93
94 typedef struct SeqRenderData {
95         struct Main *bmain;
96         struct Scene *scene;
97         int rectx;
98         int recty;
99         int preview_render_size;
100         int motion_blur_samples;
101         float motion_blur_shutter;
102 } SeqRenderData;
103
104 SeqRenderData BKE_sequencer_new_render_data(struct Main *bmain, struct Scene *scene, int rectx, int recty,
105                                             int preview_render_size);
106
107 /* Wipe effect */
108 enum {
109         DO_SINGLE_WIPE,
110         DO_DOUBLE_WIPE,
111         DO_BOX_WIPE,
112         DO_CROSS_WIPE,
113         DO_IRIS_WIPE,
114         DO_CLOCK_WIPE
115 };
116
117 struct SeqEffectHandle {
118         short multithreaded;
119         short supports_mask;
120
121         /* constructors & destructor */
122         /* init is _only_ called on first creation */
123         void (*init)(struct Sequence *seq);
124         
125         /* number of input strips needed 
126          * (called directly after construction) */
127         int (*num_inputs)(void);
128         
129         /* load is called first time after readblenfile in
130          * get_sequence_effect automatically */
131         void (*load)(struct Sequence *seq);
132         
133         /* duplicate */
134         void (*copy)(struct Sequence *dst, struct Sequence *src);
135         
136         /* destruct */
137         void (*free)(struct Sequence *seq);
138         
139         /* returns: -1: no input needed,
140          * 0: no early out,
141          * 1: out = ibuf1,
142          * 2: out = ibuf2 */
143         int (*early_out)(struct Sequence *seq, float facf0, float facf1); 
144         
145         /* stores the y-range of the effect IPO */
146         void (*store_icu_yrange)(struct Sequence *seq, short adrcode, float *ymin, float *ymax);
147         
148         /* stores the default facf0 and facf1 if no IPO is present */
149         void (*get_default_fac)(struct Sequence *seq, float cfra, float *facf0, float *facf1);
150         
151         /* execute the effect
152          * sequence effects are only required to either support
153          * float-rects or byte-rects
154          * (mixed cases are handled one layer up...) */
155         
156         struct ImBuf * (*execute)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
157                                   struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3);
158
159         struct ImBuf * (*init_execution)(SeqRenderData context, struct ImBuf *ibuf1, struct ImBuf *ibuf2,
160                                          struct ImBuf *ibuf3);
161
162         void (*execute_slice)(SeqRenderData context, struct Sequence *seq, float cfra, float facf0, float facf1,
163                               struct ImBuf *ibuf1, struct ImBuf *ibuf2, struct ImBuf *ibuf3,
164                               int start_line, int total_lines, struct ImBuf *out);
165 };
166
167 /* ********************* prototypes *************** */
168
169 /* **********************************************************************
170  * sequencer.c
171  *
172  * sequencer render functions
173  * ********************************************************************** */
174
175 struct ImBuf *BKE_sequencer_give_ibuf(SeqRenderData context, float cfra, int chanshown);
176 struct ImBuf *BKE_sequencer_give_ibuf_threaded(SeqRenderData context, float cfra, int chanshown);
177 struct ImBuf *BKE_sequencer_give_ibuf_direct(SeqRenderData context, float cfra, struct Sequence *seq);
178 struct ImBuf *BKE_sequencer_give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
179 void BKE_sequencer_give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
180
181 /* **********************************************************************
182  * sequencer.c
183  *
184  * sequencer color space functions
185  * ********************************************************************** */
186
187 void BKE_sequencer_imbuf_to_sequencer_space(struct Scene *scene, struct ImBuf *ibuf, int make_float);
188 void BKE_sequencer_imbuf_from_sequencer_space(struct Scene *scene, struct ImBuf *ibuf);
189 void BKE_sequencer_pixel_from_sequencer_space_v4(struct Scene *scene, float pixel[4]);
190
191 /* **********************************************************************
192  * sequencer scene functions
193  * ********************************************************************** */
194 struct Editing  *BKE_sequencer_editing_get(struct Scene *scene, int alloc);
195 struct Editing  *BKE_sequencer_editing_ensure(struct Scene *scene);
196 void             BKE_sequencer_editing_free(struct Scene *scene);
197
198 void             BKE_sequencer_sort(struct Scene *scene);
199
200 struct Sequence *BKE_sequencer_active_get(struct Scene *scene);
201 int              BKE_sequencer_active_get_pair(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
202 void             BKE_sequencer_active_set(struct Scene *scene, struct Sequence *seq);
203 struct Mask     *BKE_sequencer_mask_get(struct Scene *scene);
204
205 /* apply functions recursively */
206 int BKE_sequencer_base_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
207 int BKE_sequencer_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
208
209 /* maintenance functions, mostly for RNA */
210 /* extern  */
211
212 void BKE_sequencer_free_clipboard(void);
213
214 void BKE_sequence_free(struct Scene *scene, struct Sequence *seq);
215 const char *BKE_sequence_give_name(struct Sequence *seq);
216 void BKE_sequence_calc(struct Scene *scene, struct Sequence *seq);
217 void BKE_sequence_calc_disp(struct Scene *scene, struct Sequence *seq);
218 void BKE_sequence_reload_new_file(struct Scene *scene, struct Sequence *seq, int lock_range);
219 int BKE_sequencer_evaluate_frame(struct Scene *scene, int cfra);
220
221 struct StripElem *BKE_sequencer_give_stripelem(struct Sequence *seq, int cfra);
222
223 /* intern */
224 void BKE_sequencer_update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
225 int BKE_sequencer_input_have_to_preprocess(SeqRenderData context, struct Sequence *seq, float cfra);
226
227 struct SeqIndexBuildContext *BKE_sequencer_proxy_rebuild_context(struct Main *bmain, struct Scene *scene, struct Sequence *seq);
228 void BKE_sequencer_proxy_rebuild(struct SeqIndexBuildContext *context, short *stop, short *do_update, float *progress);
229 void BKE_sequencer_proxy_rebuild_finish(struct SeqIndexBuildContext *context, short stop);
230
231 /* **********************************************************************
232  * seqcache.c
233  *
234  * Sequencer memory cache management functions
235  * ********************************************************************** */
236
237 typedef enum {
238         SEQ_STRIPELEM_IBUF,
239         SEQ_STRIPELEM_IBUF_COMP,
240         SEQ_STRIPELEM_IBUF_STARTSTILL,
241         SEQ_STRIPELEM_IBUF_ENDSTILL
242 } seq_stripelem_ibuf_t;
243
244 void BKE_sequencer_cache_destruct(void);
245 void BKE_sequencer_cache_cleanup(void);
246
247 /* returned ImBuf is properly refed and has to be freed */
248 struct ImBuf *BKE_sequencer_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
249
250 /* passed ImBuf is properly refed, so ownership is *not* 
251  * transferred to the cache.
252  * you can pass the same ImBuf multiple times to the cache without problems.
253  */
254
255 void BKE_sequencer_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *nval);
256
257 void BKE_sequencer_cache_cleanup_sequence(struct Sequence *seq);
258
259 struct ImBuf *BKE_sequencer_preprocessed_cache_get(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type);
260 void BKE_sequencer_preprocessed_cache_put(SeqRenderData context, struct Sequence *seq, float cfra, seq_stripelem_ibuf_t type, struct ImBuf *ibuf);
261 void BKE_sequencer_preprocessed_cache_cleanup(void);
262 void BKE_sequencer_preprocessed_cache_cleanup_sequence(struct Sequence *seq);
263
264 /* **********************************************************************
265  * seqeffects.c
266  *
267  * Sequencer effect strip managment functions
268  *  **********************************************************************
269  */
270
271 /* intern */
272 struct SeqEffectHandle BKE_sequence_get_blend(struct Sequence *seq);
273 void BKE_sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
274
275 /* extern */
276 struct SeqEffectHandle BKE_sequence_get_effect(struct Sequence *seq);
277 int BKE_sequence_effect_get_num_inputs(int seq_type);
278 int BKE_sequence_effect_get_supports_mask(int seq_type);
279
280 /* **********************************************************************
281  * Sequencer editing functions
282  * **********************************************************************
283  */
284    
285 /* for transform but also could use elsewhere */
286 int BKE_sequence_tx_get_final_left(struct Sequence *seq, int metaclip);
287 int BKE_sequence_tx_get_final_right(struct Sequence *seq, int metaclip);
288 void BKE_sequence_tx_set_final_left(struct Sequence *seq, int val);
289 void BKE_sequence_tx_set_final_right(struct Sequence *seq, int val);
290 void BKE_sequence_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
291 int BKE_sequence_tx_test(struct Sequence *seq);
292 int BKE_sequence_single_check(struct Sequence *seq);
293 void BKE_sequence_single_fix(struct Sequence *seq);
294 int BKE_sequence_test_overlap(struct ListBase *seqbasep, struct Sequence *test);
295 void BKE_sequence_translate(struct Scene *scene, struct Sequence *seq, int delta);
296 void BKE_sequence_sound_init(struct Scene *scene, struct Sequence *seq);
297 struct Sequence *BKE_sequencer_foreground_frame_get(struct Scene *scene, int frame);
298 struct ListBase *BKE_sequence_seqbase(struct ListBase *seqbase, struct Sequence *seq);
299 struct Sequence *BKE_sequence_metastrip(ListBase *seqbase /* = ed->seqbase */, struct Sequence *meta /* = NULL */, struct Sequence *seq);
300
301 void BKE_sequencer_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
302 void BKE_sequencer_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
303 int BKE_sequence_base_shuffle(struct ListBase *seqbasep, struct Sequence *test, struct Scene *evil_scene);
304 int BKE_sequence_base_shuffle_time(ListBase *seqbasep, struct Scene *evil_scene);
305 int BKE_sequence_base_isolated_sel_check(struct ListBase *seqbase);
306 void BKE_sequencer_free_imbuf(struct Scene *scene, struct ListBase *seqbasep, int for_render);
307 struct Sequence *BKE_sequence_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence *seq, int dupe_flag);
308 int BKE_sequence_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
309
310 int BKE_sequence_check_depend(struct Sequence *seq, struct Sequence *cur);
311 void BKE_sequence_invalidate_cache(struct Scene *scene, struct Sequence *seq);
312 void BKE_sequence_invalidate_dependent(struct Scene *scene, struct Sequence *seq);
313 void BKE_sequence_invalidate_cache_for_modifier(struct Scene *scene, struct Sequence *seq);
314
315 void BKE_sequencer_update_sound_bounds_all(struct Scene *scene);
316 void BKE_sequencer_update_sound_bounds(struct Scene *scene, struct Sequence *seq);
317 void BKE_sequencer_update_muting(struct Editing *ed);
318 void BKE_sequencer_update_sound(struct Scene *scene, struct bSound *sound);
319
320 void BKE_sequence_base_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
321 void BKE_sequence_base_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
322 int  BKE_sequence_is_valid_check(struct Sequence *seq);
323
324 void BKE_sequencer_clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
325
326 struct Sequence *BKE_sequence_get_by_name(struct ListBase *seqbase, const char *name, int recursive);
327
328 /* api for adding new sequence strips */
329 typedef struct SeqLoadInfo {
330         int start_frame;
331         int end_frame;
332         int channel;
333         int flag;   /* use sound, replace sel */
334         int type;
335         int tot_success;
336         int tot_error;
337         int len;        /* only for image strips */
338         char path[512];
339         char name[64];
340 } SeqLoadInfo;
341
342 /* SeqLoadInfo.flag */
343 #define SEQ_LOAD_REPLACE_SEL    (1 << 0)
344 #define SEQ_LOAD_FRAME_ADVANCE  (1 << 1)
345 #define SEQ_LOAD_MOVIE_SOUND    (1 << 2)
346 #define SEQ_LOAD_SOUND_CACHE    (1 << 3)
347
348
349 /* seq_dupli' flags */
350 #define SEQ_DUPE_UNIQUE_NAME    (1 << 0)
351 #define SEQ_DUPE_CONTEXT        (1 << 1)
352 #define SEQ_DUPE_ANIM           (1 << 2)
353 #define SEQ_DUPE_ALL            (1 << 3) /* otherwise only selected are copied */
354
355 /* use as an api function */
356 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
357
358 struct Sequence *BKE_sequence_alloc(ListBase *lb, int cfra, int machine);
359 void BKE_sequence_init_colorspace(struct Sequence *seq);
360
361 struct Sequence *BKE_sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
362 struct Sequence *BKE_sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
363 struct Sequence *BKE_sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
364
365 /* view3d draw callback, run when not in background view */
366 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, int, int, int, char[256]);
367 extern SequencerDrawView sequencer_view3d_cb;
368
369 /* copy/paste */
370 extern ListBase seqbase_clipboard;
371 extern int seqbase_clipboard_frame;
372
373 /* modifiers */
374 typedef struct SequenceModifierTypeInfo {
375         /* default name for the modifier */
376         char name[64];  /* MAX_NAME */
377
378         /* DNA structure name used on load/save filed */
379         char struct_name[64];  /* MAX_NAME */
380
381         /* size of modifier data structure, used by allocation */
382         int struct_size;
383
384         /* data initialization */
385         void (*init_data) (struct SequenceModifierData *smd);
386
387         /* free data used by modifier,
388          * only modifier-specific data should be freed, modifier descriptor would
389          * be freed outside of this callback
390          */
391         void (*free_data) (struct SequenceModifierData *smd);
392
393         /* copy data from one modifier to another */
394         void (*copy_data) (struct SequenceModifierData *smd, struct SequenceModifierData *target);
395
396         /* apply modifier on a given image buffer */
397         void (*apply) (struct SequenceModifierData *smd, struct ImBuf *ibuf, struct ImBuf *mask);
398 } SequenceModifierTypeInfo;
399
400 struct SequenceModifierTypeInfo *BKE_sequence_modifier_type_info_get(int type);
401
402 struct SequenceModifierData *BKE_sequence_modifier_new(struct Sequence *seq, const char *name, int type);
403 int BKE_sequence_modifier_remove(struct Sequence *seq, struct SequenceModifierData *smd);
404 void BKE_sequence_modifier_clear(struct Sequence *seq);
405 void BKE_sequence_modifier_free(struct SequenceModifierData *smd);
406 void BKE_sequence_modifier_unique_name(struct Sequence *seq, struct SequenceModifierData *smd);
407 struct SequenceModifierData *BKE_sequence_modifier_find_by_name(struct Sequence *seq, char *name);
408 struct ImBuf *BKE_sequence_modifier_apply_stack(SeqRenderData context, struct Sequence *seq, struct ImBuf *ibuf, int cfra);
409 void BKE_sequence_modifier_list_copy(struct Sequence *seqn, struct Sequence *seq);
410
411 int BKE_sequence_supports_modifiers(struct Sequence *seq);
412
413 /* internal filters */
414 struct ImBuf *BKE_sequencer_render_mask_input(SeqRenderData context, int mask_input_type, struct Sequence *mask_sequence, struct Mask *mask_id, int cfra, int make_float);
415 void BKE_sequencer_color_balance_apply(struct StripColorBalance *cb, struct ImBuf *ibuf, float mul, short make_float, struct ImBuf *mask_input);
416
417 #endif /* __BKE_SEQUENCER_H__ */