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