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