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