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