svn merge -r 21041:21301 https://svn.blender.org/svnroot/bf-blender/branches/blender2...
[blender.git] / source / blender / blenkernel / BKE_sequence.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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, 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_SEQUENCE_H
32 #define BKE_SEQUENCE_H
33
34 struct Editing;
35 struct Sequence;
36 struct Strip;
37 struct StripElem;
38 struct ImBuf;
39 struct Scene;
40
41 #define MAXSEQ          32
42
43 #define BUILD_SEQAR_COUNT_NOTHING  0
44 #define BUILD_SEQAR_COUNT_CURRENT  1
45 #define BUILD_SEQAR_COUNT_CHILDREN 2
46
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 #endif
81
82
83 /* Wipe effect */
84 enum {DO_SINGLE_WIPE, DO_DOUBLE_WIPE, DO_BOX_WIPE, DO_CROSS_WIPE,
85         DO_IRIS_WIPE,DO_CLOCK_WIPE};
86
87
88 struct SeqEffectHandle {
89         /* constructors & destructor */
90         /* init & init_plugin are _only_ called on first creation */
91         void (*init)(struct Sequence *seq);
92         void (*init_plugin)(struct Sequence *seq, const char *fname);
93         
94         /* number of input strips needed 
95                 (called directly after construction) */
96         int (*num_inputs)();
97         
98         /* load is called first time after readblenfile in
99                 get_sequence_effect automatically */
100         void (*load)(struct Sequence *seq);
101         
102         /* duplicate */
103         void (*copy)(struct Sequence *dst, struct Sequence *src);
104         
105         /* destruct */
106         void (*free)(struct Sequence *seq);
107         
108         /* returns: -1: no input needed,
109         0: no early out, 
110         1: out = ibuf1, 
111         2: out = ibuf2 */
112         int (*early_out)(struct Sequence *seq,
113                                          float facf0, float facf1); 
114         
115         /* stores the y-range of the effect IPO */
116         void (*store_icu_yrange)(struct Sequence * seq,
117                                                          short adrcode, float *ymin, float *ymax);
118         
119         /* stores the default facf0 and facf1 if no IPO is present */
120         void (*get_default_fac)(struct Sequence *seq, int cfra,
121                                                         float * facf0, float * facf1);
122         
123         /* execute the effect
124                 sequence effects are only required to either support
125                 float-rects or byte-rects 
126                 (mixed cases are handled one layer up...) */
127         
128         void (*execute)(struct Sequence *seq, int cfra,
129                                         float facf0, float facf1,
130                                         int x, int y,
131                                         struct ImBuf *ibuf1, struct ImBuf *ibuf2,
132                                         struct ImBuf *ibuf3, struct ImBuf *out);
133 };
134
135 /* ********************* prototypes *************** */
136
137 /* sequence.c */
138
139 // extern
140 void seq_free_sequence(struct Editing *ed, struct Sequence *seq);
141 void seq_free_strip(struct Strip *strip);
142 void seq_free_editing(struct Editing *ed);
143 struct Editing *seq_give_editing(struct Scene *scene, int alloc);
144 char *give_seqname(struct Sequence *seq);
145 struct ImBuf *give_ibuf_seq(struct Scene *scene, int rectx, int recty, int cfra, int chanshown, int render_size);
146 struct ImBuf *give_ibuf_seq_threaded(struct Scene *scene, int rectx, int recty, int cfra, int chanshown, int render_size);
147 struct ImBuf *give_ibuf_seq_direct(struct Scene *scene, int rectx, int recty, int cfra, int render_size, struct Sequence *seq);
148 void give_ibuf_prefetch_request(int rectx, int recty, int cfra, int chanshown, int render_size);
149 void calc_sequence(struct Sequence *seq);
150 void calc_sequence_disp(struct Sequence *seq);
151 void new_tstripdata(struct Sequence *seq);
152 void reload_sequence_new_file(struct Scene *scene, struct Sequence * seq);
153 void sort_seq(struct Scene *scene);
154 void build_seqar_cb(struct ListBase *seqbase, struct Sequence  ***seqar, int *totseq,
155                                         int (*test_func)(struct Sequence * seq));
156 int evaluate_seq_frame(struct Scene *scene, int cfra);
157 struct StripElem *give_stripelem(struct Sequence *seq, int cfra);
158
159 // intern?
160 void update_changed_seq_and_deps(struct Scene *scene, struct Sequence *changed_seq, int len_change, int ibuf_change);
161
162 /* seqeffects.c */
163 // intern?
164 struct SeqEffectHandle get_sequence_blend(struct Sequence *seq);
165 void sequence_effect_speed_rebuild_map(struct Sequence *seq, int force);
166
167 // extern
168 struct SeqEffectHandle get_sequence_effect(struct Sequence *seq);
169 int get_sequence_effect_num_inputs(int seq_type);
170
171 /* for transform but also could use elsewhere */
172 int seq_tx_get_start(struct Sequence *seq);
173 int seq_tx_get_end(struct Sequence *seq);
174 int seq_tx_get_final_left(struct Sequence *seq, int metaclip);
175 int seq_tx_get_final_right(struct Sequence *seq, int metaclip);
176 void seq_tx_set_final_left(struct Sequence *seq, int val);
177 void seq_tx_set_final_right(struct Sequence *seq, int val);
178 void seq_tx_handle_xlimits(struct Sequence *seq, int leftflag, int rightflag);
179 int seq_tx_test(struct Sequence * seq);
180 int check_single_seq(struct Sequence *seq);
181 void fix_single_seq(struct Sequence *seq);
182 int seq_test_overlap(struct ListBase * seqbasep, struct Sequence *test);
183 int shuffle_seq(struct ListBase * seqbasep, struct Sequence *test);
184 void free_imbuf_seq(struct ListBase * seqbasep);
185