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