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