Longer names support for all ID and other object names
[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 Editing;
35 struct ImBuf;
36 struct Main;
37 struct Scene;
38 struct Sequence;
39 struct Strip;
40 struct StripElem;
41 struct bSound;
42
43 #define BUILD_SEQAR_COUNT_NOTHING  0
44 #define BUILD_SEQAR_COUNT_CURRENT  1
45 #define BUILD_SEQAR_COUNT_CHILDREN 2
46
47 #define EARLY_NO_INPUT          -1
48 #define EARLY_DO_EFFECT         0
49 #define EARLY_USE_INPUT_1       1
50 #define EARLY_USE_INPUT_2       2
51
52 /* sequence iterator */
53
54 typedef struct SeqIterator {
55         struct Sequence **array;
56         int tot, cur;
57
58         struct Sequence *seq;
59         int valid;
60 } SeqIterator;
61
62 void seq_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
63 void seq_next(SeqIterator *iter);
64 void seq_end(SeqIterator *iter);
65 void seq_array(struct Editing *ed, struct Sequence ***seqarray, int *tot, int use_pointer);
66
67 #define SEQP_BEGIN(ed, _seq)                                                  \
68 {                                                                             \
69         SeqIterator iter;                                                         \
70                 for(seq_begin(ed, &iter, 1); iter.valid; seq_next(&iter)) {           \
71                         _seq= iter.seq;
72                         
73 #define SEQ_BEGIN(ed, _seq)                                                   \
74         {                                                                         \
75                 SeqIterator iter;                                                     \
76                 for(seq_begin(ed, &iter, 0); iter.valid; seq_next(&iter)) {           \
77                         _seq= iter.seq;
78
79 #define SEQ_END                                                               \
80                 }                                                                     \
81                 seq_end(&iter);                                                       \
82         }
83
84 typedef struct SeqRenderData {
85         struct Main *bmain;
86         struct Scene *scene;
87         int rectx;
88         int recty;
89         int preview_render_size;
90         int motion_blur_samples;
91         float motion_blur_shutter;
92 } SeqRenderData;
93
94 SeqRenderData seq_new_render_data(
95         struct Main * bmain, struct Scene * scene,
96         int rectx, int recty, int preview_render_size);
97
98 int seq_cmp_render_data(const SeqRenderData * a, const SeqRenderData * b);
99 unsigned int seq_hash_render_data(const SeqRenderData * a);
100
101 /* Wipe effect */
102 enum {DO_SINGLE_WIPE, DO_DOUBLE_WIPE, DO_BOX_WIPE, DO_CROSS_WIPE,
103         DO_IRIS_WIPE,DO_CLOCK_WIPE};
104
105
106 struct SeqEffectHandle {
107         /* constructors & destructor */
108         /* init & init_plugin are _only_ called on first creation */
109         void (*init)(struct Sequence *seq);
110         void (*init_plugin)(struct Sequence *seq, const char *fname);
111         
112         /* number of input strips needed 
113                 (called directly after construction) */
114         int (*num_inputs)(void);
115         
116         /* load is called first time after readblenfile in
117                 get_sequence_effect automatically */
118         void (*load)(struct Sequence *seq);
119         
120         /* duplicate */
121         void (*copy)(struct Sequence *dst, struct Sequence *src);
122         
123         /* destruct */
124         void (*free)(struct Sequence *seq);
125         
126         /* returns: -1: no input needed,
127         0: no early out, 
128         1: out = ibuf1, 
129         2: out = ibuf2 */
130         int (*early_out)(struct Sequence *seq, float facf0, float facf1); 
131         
132         /* stores the y-range of the effect IPO */
133         void (*store_icu_yrange)(struct Sequence * seq,
134                                  short adrcode, float *ymin, float *ymax);
135         
136         /* stores the default facf0 and facf1 if no IPO is present */
137         void (*get_default_fac)(struct Sequence *seq, float cfra,
138                                 float * facf0, float * facf1);
139         
140         /* execute the effect
141            sequence effects are only required to either support
142            float-rects or byte-rects 
143            (mixed cases are handled one layer up...) */
144         
145         struct ImBuf* (*execute)(
146                 SeqRenderData context,
147                 struct Sequence *seq, float cfra,
148                 float facf0, float facf1,
149                 struct ImBuf *ibuf1, struct ImBuf *ibuf2,
150                 struct ImBuf *ibuf3);
151 };
152
153 /* ********************* prototypes *************** */
154
155 /* **********************************************************************
156    * sequence.c
157
158    * sequencer render functions
159    ********************************************************************** */
160
161 struct ImBuf *give_ibuf_seq(SeqRenderData context, float cfra, int chanshown);
162 struct ImBuf *give_ibuf_seq_threaded(SeqRenderData context, float cfra, int chanshown);
163 struct ImBuf *give_ibuf_seq_direct(SeqRenderData context, float cfra, struct Sequence *seq);
164 struct ImBuf *give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
165 void give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
166
167 /* apply functions recursively */
168 int seqbase_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
169 int seq_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
170
171 /* maintainance functions, mostly for RNA */
172 // extern 
173 void seq_free_sequence(struct Scene *scene, struct Sequence *seq);
174 void seq_free_sequence_recurse(struct Scene *scene, struct Sequence *seq);
175 void seq_free_strip(struct Strip *strip);
176 void seq_free_editing(struct Scene *scene);
177 void seq_free_clipboard(void);
178 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
179 const char *give_seqname(struct Sequence *seq);
180 void calc_sequence(struct Scene *scene, struct Sequence *seq);
181 void calc_sequence_disp(struct Scene *scene, struct Sequence *seq);
182 void new_tstripdata(struct Sequence *seq);
183 void reload_sequence_new_file(struct Scene *scene, struct Sequence * seq, int lock_range);
184 void sort_seq(struct Scene *scene);
185 void build_seqar_cb(struct ListBase *seqbase, struct Sequence  ***seqar, int *totseq,
186                                         int (*test_func)(struct Sequence * seq));
187 int evaluate_seq_frame(struct Scene *scene, int cfra);
188 struct StripElem *give_stripelem(struct Sequence *seq, int cfra);
189
190 // intern
191 void printf_strip(struct Sequence *seq); // debugging function (unused)
192 void update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
193
194 int input_have_to_preprocess(
195         SeqRenderData context, struct Sequence * seq, float cfra);
196
197 void seq_proxy_rebuild(struct Main * bmain, 
198                        struct Scene *scene, struct Sequence * seq,
199                        short *stop, short *do_update, float *progress);
200
201
202 /* **********************************************************************
203    seqcache.c
204
205    Sequencer memory cache management functions
206    ********************************************************************** */
207
208 typedef enum {
209         SEQ_STRIPELEM_IBUF,
210         SEQ_STRIPELEM_IBUF_COMP,
211         SEQ_STRIPELEM_IBUF_STARTSTILL,
212         SEQ_STRIPELEM_IBUF_ENDSTILL
213 } seq_stripelem_ibuf_t;
214
215 void seq_stripelem_cache_destruct(void);
216 void seq_stripelem_cache_cleanup(void);
217
218 /* returned ImBuf is properly refed and has to be freed */
219 struct ImBuf * seq_stripelem_cache_get(
220         SeqRenderData context, struct Sequence * seq, 
221         float cfra, seq_stripelem_ibuf_t type);
222
223 /* passed ImBuf is properly refed, so ownership is *not* 
224    transfered to the cache.
225    you can pass the same ImBuf multiple times to the cache without problems.
226 */
227    
228 void seq_stripelem_cache_put(
229         SeqRenderData context, struct Sequence * seq, 
230         float cfra, seq_stripelem_ibuf_t type, struct ImBuf * nval);
231
232 /* **********************************************************************
233    seqeffects.c 
234
235    Sequencer effect strip managment functions
236    **********************************************************************
237 */
238
239 /* intern */
240 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
241 void sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
242
243 /* extern */
244 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
245 int get_sequence_effect_num_inputs(int seq_type);
246
247
248 /* **********************************************************************
249    Sequencer editing functions
250    **********************************************************************
251 */
252    
253 /* for transform but also could use elsewhere */
254 int seq_tx_get_start(struct Sequence *seq);
255 int seq_tx_get_end(struct Sequence *seq);
256 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
257 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
258 void seq_tx_set_final_left(struct Sequence *seq, int val);
259 void seq_tx_set_final_right(struct Sequence *seq, int val);
260 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
261 int seq_tx_test(struct Sequence * seq);
262 int seq_single_check(struct Sequence *seq);
263 void seq_single_fix(struct Sequence *seq);
264 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
265 void seq_translate(struct Scene *scene, struct Sequence *seq, int delta);
266 void seq_sound_init(struct Scene *scene, struct Sequence *seq);
267 struct Sequence *seq_foreground_frame_get(struct Scene *scene, int frame);
268 struct ListBase *seq_seqbase(struct ListBase *seqbase, struct Sequence *seq);
269 struct Sequence *seq_metastrip(
270         ListBase * seqbase /* = ed->seqbase */, 
271         struct Sequence * meta /* = NULL */, struct Sequence *seq);
272
273 void seq_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
274 void seq_dupe_animdata(struct Scene *scene, const char *name_src, const char *name_dst);
275 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test, struct Scene *evil_scene);
276 int shuffle_seq_time(ListBase * seqbasep, struct Scene *evil_scene);
277 int seqbase_isolated_sel_check(struct ListBase *seqbase);
278 void free_imbuf_seq(struct Scene *scene, struct ListBase * seqbasep, int check_mem_usage, int keep_file_handles);
279 struct Sequence *seq_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence * seq, int dupe_flag);
280 int seq_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
281
282 void seq_update_sound_bounds_all(struct Scene *scene);
283 void seq_update_sound_bounds(struct Scene* scene, struct Sequence *seq);
284 void seq_update_muting(struct Editing *ed);
285 void seq_update_sound(struct Scene *scene, struct bSound *sound);
286 void seqbase_sound_reload(struct Scene *scene, ListBase *seqbase);
287 void seqbase_unique_name_recursive(ListBase *seqbasep, struct Sequence *seq);
288 void seqbase_dupli_recursive(struct Scene *scene, struct Scene *scene_to, ListBase *nseqbase, ListBase *seqbase, int dupe_flag);
289
290 void clear_scene_in_allseqs(struct Main *bmain, struct Scene *sce);
291
292 struct Sequence *get_seq_by_name(struct ListBase *seqbase, const char *name, int recursive);
293
294 struct Sequence *seq_active_get(struct Scene *scene);
295 void seq_active_set(struct Scene *scene, struct Sequence *seq);
296 int seq_active_pair_get(struct Scene *scene, struct Sequence **seq_act, struct Sequence **seq_other);
297
298 /* api for adding new sequence strips */
299 typedef struct SeqLoadInfo {
300         int start_frame;
301         int end_frame;
302         int channel;
303         int flag;       /* use sound, replace sel */
304         int type;
305         int tot_success;
306         int tot_error;
307         int len;                /* only for image strips */
308         char path[512];
309         char name[64];
310 } SeqLoadInfo;
311
312 /* SeqLoadInfo.flag */
313 #define SEQ_LOAD_REPLACE_SEL    (1<<0)
314 #define SEQ_LOAD_FRAME_ADVANCE  (1<<1)
315 #define SEQ_LOAD_MOVIE_SOUND    (1<<2)
316 #define SEQ_LOAD_SOUND_CACHE    (1<<3)
317
318
319 /* seq_dupli' flags */
320 #define SEQ_DUPE_UNIQUE_NAME    (1<<0)
321 #define SEQ_DUPE_CONTEXT                (1<<1)
322 #define SEQ_DUPE_ANIM                   (1<<2)
323 #define SEQ_DUPE_ALL                    (1<<3) /* otherwise only selected are copied */
324
325 /* use as an api function */
326 typedef struct Sequence *(*SeqLoadFunc)(struct bContext *, ListBase *, struct SeqLoadInfo *);
327
328 struct Sequence *alloc_sequence(ListBase *lb, int cfra, int machine);
329
330 void seq_load_apply(struct Scene *scene, struct Sequence *seq, struct SeqLoadInfo *seq_load);
331
332 struct Sequence *sequencer_add_image_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
333 struct Sequence *sequencer_add_sound_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
334 struct Sequence *sequencer_add_movie_strip(struct bContext *C, ListBase *seqbasep, struct SeqLoadInfo *seq_load);
335
336 /* view3d draw callback, run when not in background view */
337 typedef struct ImBuf *(*SequencerDrawView)(struct Scene *, struct Object *, int, int, unsigned int, int, char[256]);
338 extern SequencerDrawView sequencer_view3d_cb;
339
340 /* copy/paste */
341 extern ListBase seqbase_clipboard;
342 extern int seqbase_clipboard_frame;
343
344 #endif // BKE_SEQUENCER_H