better error reporting for seq_swap()
[blender.git] / source / blender / blenkernel / BKE_sequencer.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.  
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22  *
23  * The Original Code is Copyright (C) 2004 Blender Foundation.
24  * All rights reserved.
25  *
26  * Contributor(s): Blender Foundation (2008).
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  */
30
31 #ifndef BKE_SEQUENCER_H
32 #define BKE_SEQUENCER_H
33
34 /** \file BKE_sequencer.h
35  *  \ingroup bke
36  */
37
38 struct bContext;
39 struct Editing;
40 struct ImBuf;
41 struct Main;
42 struct Scene;
43 struct Sequence;
44 struct Strip;
45 struct StripElem;
46
47 #define MAXSEQ          32
48
49 #define BUILD_SEQAR_COUNT_NOTHING  0
50 #define BUILD_SEQAR_COUNT_CURRENT  1
51 #define BUILD_SEQAR_COUNT_CHILDREN 2
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 seq_begin(struct Editing *ed, SeqIterator *iter, int use_pointer);
69 void seq_next(SeqIterator *iter);
70 void seq_end(SeqIterator *iter);
71 void seq_array(struct Editing *ed, struct Sequence ***seqarray, int *tot, int use_pointer);
72
73 #define SEQP_BEGIN(ed, _seq) \
74 { \
75         SeqIterator iter;\
76                 for(seq_begin(ed, &iter, 1); iter.valid; seq_next(&iter)) { \
77                         _seq= iter.seq;
78                         
79 #define SEQ_BEGIN(ed, _seq) \
80         { \
81                 SeqIterator iter;\
82                 for(seq_begin(ed, &iter, 0); iter.valid; seq_next(&iter)) { \
83                         _seq= iter.seq;
84
85 #define SEQ_END \
86                 } \
87                 seq_end(&iter); \
88         }
89
90 typedef struct SeqRenderData {
91         struct Main *bmain;
92         struct Scene *scene;
93         int rectx;
94         int recty;
95         int preview_render_size;
96         int motion_blur_samples;
97         float motion_blur_shutter;
98 } SeqRenderData;
99
100 SeqRenderData seq_new_render_data(
101         struct Main * bmain, struct Scene * scene,
102         int rectx, int recty, int preview_render_size);
103
104 int seq_cmp_render_data(const SeqRenderData * a, const SeqRenderData * b);
105 unsigned int seq_hash_render_data(const SeqRenderData * a);
106
107 /* Wipe effect */
108 enum {DO_SINGLE_WIPE, DO_DOUBLE_WIPE, DO_BOX_WIPE, DO_CROSS_WIPE,
109         DO_IRIS_WIPE,DO_CLOCK_WIPE};
110
111
112 struct SeqEffectHandle {
113         /* constructors & destructor */
114         /* init & init_plugin are _only_ called on first creation */
115         void (*init)(struct Sequence *seq);
116         void (*init_plugin)(struct Sequence *seq, const char *fname);
117         
118         /* number of input strips needed 
119                 (called directly after construction) */
120         int (*num_inputs)(void);
121         
122         /* load is called first time after readblenfile in
123                 get_sequence_effect automatically */
124         void (*load)(struct Sequence *seq);
125         
126         /* duplicate */
127         void (*copy)(struct Sequence *dst, struct Sequence *src);
128         
129         /* destruct */
130         void (*free)(struct Sequence *seq);
131         
132         /* returns: -1: no input needed,
133         0: no early out, 
134         1: out = ibuf1, 
135         2: out = ibuf2 */
136         int (*early_out)(struct Sequence *seq, float facf0, float facf1); 
137         
138         /* stores the y-range of the effect IPO */
139         void (*store_icu_yrange)(struct Sequence * seq,
140                                  short adrcode, float *ymin, float *ymax);
141         
142         /* stores the default facf0 and facf1 if no IPO is present */
143         void (*get_default_fac)(struct Sequence *seq, float cfra,
144                                 float * facf0, float * facf1);
145         
146         /* execute the effect
147            sequence effects are only required to either support
148            float-rects or byte-rects 
149            (mixed cases are handled one layer up...) */
150         
151         struct ImBuf* (*execute)(
152                 SeqRenderData context,
153                 struct Sequence *seq, float cfra,
154                 float facf0, float facf1,
155                 struct ImBuf *ibuf1, struct ImBuf *ibuf2,
156                 struct ImBuf *ibuf3);
157 };
158
159 /* ********************* prototypes *************** */
160
161 /* **********************************************************************
162    * sequence.c
163
164    * sequencer render functions
165    ********************************************************************** */
166
167 struct ImBuf *give_ibuf_seq(SeqRenderData context, float cfra, int chanshown);
168 struct ImBuf *give_ibuf_seq_threaded(SeqRenderData context, float cfra, int chanshown);
169 struct ImBuf *give_ibuf_seq_direct(SeqRenderData context, float cfra, struct Sequence *seq);
170 struct ImBuf *give_ibuf_seqbase(SeqRenderData context, float cfra, int chan_shown, struct ListBase *seqbasep);
171 void give_ibuf_prefetch_request(SeqRenderData context, float cfra, int chan_shown);
172
173 /* apply functions recursively */
174 int seqbase_recursive_apply(struct ListBase *seqbase, int (*apply_func)(struct Sequence *seq, void *), void *arg);
175 int seq_recursive_apply(struct Sequence *seq, int (*apply_func)(struct Sequence *, void *), void *arg);
176
177 /* maintainance functions, mostly for RNA */
178 // extern 
179 void seq_free_sequence(struct Scene *scene, struct Sequence *seq);
180 void seq_free_strip(struct Strip *strip);
181 void seq_free_editing(struct Scene *scene);
182 void seq_free_clipboard(void);
183 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
184 const char *give_seqname(struct Sequence *seq);
185 void calc_sequence(struct Scene *scene, struct Sequence *seq);
186 void calc_sequence_disp(struct Scene *scene, struct Sequence *seq);
187 void new_tstripdata(struct Sequence *seq);
188 void reload_sequence_new_file(struct Scene *scene, struct Sequence * seq, int lock_range);
189 void sort_seq(struct Scene *scene);
190 void build_seqar_cb(struct ListBase *seqbase, struct Sequence  ***seqar, int *totseq,
191                                         int (*test_func)(struct Sequence * seq));
192 int evaluate_seq_frame(struct Scene *scene, int cfra);
193 struct StripElem *give_stripelem(struct Sequence *seq, int cfra);
194
195 // intern
196 void printf_strip(struct Sequence *seq); // debugging function (unused)
197 void update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
198
199 int input_have_to_preprocess(
200         SeqRenderData context, struct Sequence * seq, float cfra);
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_init(void);
216 void seq_stripelem_cache_destruct(void);
217
218 void seq_stripelem_cache_cleanup(void);
219
220 /* returned ImBuf is properly refed and has to be freed */
221 struct ImBuf * seq_stripelem_cache_get(
222         SeqRenderData context, struct Sequence * seq, 
223         float cfra, seq_stripelem_ibuf_t type);
224
225 /* passed ImBuf is properly refed, so ownership is *not* 
226    transfered to the cache.
227    you can pass the same ImBuf multiple times to the cache without problems.
228 */
229    
230 void seq_stripelem_cache_put(
231         SeqRenderData context, struct Sequence * seq, 
232         float cfra, seq_stripelem_ibuf_t type, struct ImBuf * nval);
233
234 /* **********************************************************************
235    seqeffects.c 
236
237    Sequencer effect strip managment functions
238    **********************************************************************
239 */
240
241 /* intern */
242 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
243 void sequence_effect_speed_rebuild_map(struct Scene *scene, struct Sequence *seq, int force);
244
245 /* extern */
246 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
247 int get_sequence_effect_num_inputs(int seq_type);
248
249
250 /* **********************************************************************
251    Sequencer editing functions
252    **********************************************************************
253 */
254    
255 /* for transform but also could use elsewhere */
256 int seq_tx_get_start(struct Sequence *seq);
257 int seq_tx_get_end(struct Sequence *seq);
258 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
259 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
260 void seq_tx_set_final_left(struct Sequence *seq, int val);
261 void seq_tx_set_final_right(struct Sequence *seq, int val);
262 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
263 int seq_tx_test(struct Sequence * seq);
264 int seq_single_check(struct Sequence *seq);
265 void seq_single_fix(struct Sequence *seq);
266 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
267 void seq_translate(struct Scene *scene, struct Sequence *seq, int delta);
268 void seq_sound_init(struct Scene *scene, struct Sequence *seq);
269 struct Sequence *seq_foreground_frame_get(struct Scene *scene, int frame);
270 struct ListBase *seq_seqbase(struct ListBase *seqbase, struct Sequence *seq);
271 struct Sequence *seq_metastrip(
272         ListBase * seqbase /* = ed->seqbase */, 
273         struct Sequence * meta /* = NULL */, struct Sequence *seq);
274
275 void seq_offset_animdata(struct Scene *scene, struct Sequence *seq, int ofs);
276 void seq_dupe_animdata(struct Scene *scene, char *name_from, char *name_to);
277 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test, struct Scene *evil_scene);
278 int shuffle_seq_time(ListBase * seqbasep, struct Scene *evil_scene);
279 int seqbase_isolated_sel_check(struct ListBase *seqbase);
280 void free_imbuf_seq(struct Scene *scene, struct ListBase * seqbasep, int check_mem_usage, int keep_file_handles);
281 struct Sequence *seq_dupli_recursive(struct Scene *scene, struct Scene *scene_to, struct Sequence * seq, int dupe_flag);
282 int seq_swap(struct Sequence *seq_a, struct Sequence *seq_b, const char **error_str);
283
284 void seq_update_sound(struct Scene* scene, struct Sequence *seq);
285 void seq_update_muting(struct Scene* scene, struct Editing *ed);
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[32];
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