Merging r50226 through r50236 from trunk into soc-2011-tomato
[blender.git] / source / blender / blenkernel / BKE_mask.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) 2012 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation,
22  *                 Sergey Sharybin,
23  *                 Campbell Barton
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 #ifndef __BKE_MASK_H__
29 #define __BKE_MASK_H__
30
31 struct ListBase;
32 struct Main;
33 struct Mask;
34 struct MaskParent;
35 struct MaskLayer;
36 struct MaskLayerShape;
37 struct MaskSpline;
38 struct MaskSplinePoint;
39 struct MaskSplinePointUW;
40 struct MovieClip;
41 struct MovieClipUser;
42 struct Scene;
43
44 struct MaskSplinePoint *BKE_mask_spline_point_array(struct MaskSpline *spline);
45 struct MaskSplinePoint *BKE_mask_spline_point_array_from_point(struct MaskSpline *spline, struct MaskSplinePoint *point_ref);
46
47 /* mask layers */
48 struct MaskLayer *BKE_mask_layer_new(struct Mask *mask, const char *name);
49 struct MaskLayer *BKE_mask_layer_active(struct Mask *mask);
50 void BKE_mask_layer_active_set(struct Mask *mask, struct MaskLayer *masklay);
51 void BKE_mask_layer_remove(struct Mask *mask, struct MaskLayer *masklay);
52
53 void BKE_mask_layer_free_shapes(struct MaskLayer *masklay);
54 void BKE_mask_layer_free(struct MaskLayer *masklay);
55 void BKE_mask_layer_free_list(struct ListBase *masklayers);
56 void BKE_mask_spline_free(struct MaskSpline *spline);
57 struct MaskSpline *BKE_mask_spline_copy(struct MaskSpline *spline);
58 void BKE_mask_point_free(struct MaskSplinePoint *point);
59
60 void BKE_mask_layer_unique_name(struct Mask *mask, struct MaskLayer *masklay);
61
62 struct MaskLayer *BKE_mask_layer_copy(struct MaskLayer *layer);
63 void BKE_mask_layer_copy_list(struct ListBase *masklayers_new, struct ListBase *masklayers);
64
65 /* splines */
66 struct MaskSpline *BKE_mask_spline_add(struct MaskLayer *masklay);
67 void BKE_mask_point_direction_switch(struct MaskSplinePoint *point);
68 void BKE_mask_spline_direction_switch(struct MaskLayer *masklay, struct MaskSpline *spline);
69
70 struct BezTriple *BKE_mask_spline_point_next_bezt(struct MaskSpline *spline, struct MaskSplinePoint *points_array,
71                                                   struct MaskSplinePoint *point);
72
73 typedef enum {
74         MASK_PROJ_NEG = -1,
75         MASK_PROJ_ANY = 0,
76         MASK_PROJ_POS = 1
77 } eMaskSign;
78 float BKE_mask_spline_project_co(struct MaskSpline *spline, struct MaskSplinePoint *point,
79                                  float start_u, const float co[2], const eMaskSign sign);
80
81 /* point */
82 int BKE_mask_point_has_handle(struct MaskSplinePoint *point);
83 void BKE_mask_point_handle(struct MaskSplinePoint *point, float handle[2]);
84 void BKE_mask_point_set_handle(struct MaskSplinePoint *point, float loc[2], int keep_direction,
85                                float orig_handle[2], float orig_vec[3][3]);
86
87 void BKE_mask_point_segment_co(struct MaskSpline *spline, struct MaskSplinePoint *point, float u, float co[2]);
88 void BKE_mask_point_normal(struct MaskSpline *spline, struct MaskSplinePoint *point,
89                            float u, float n[2]);
90 float BKE_mask_point_weight_scalar(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
91 float BKE_mask_point_weight(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
92 struct MaskSplinePointUW *BKE_mask_point_sort_uw(struct MaskSplinePoint *point, struct MaskSplinePointUW *uw);
93 void BKE_mask_point_add_uw(struct MaskSplinePoint *point, float u, float w);
94
95 void BKE_mask_point_select_set(struct MaskSplinePoint *point, const short do_select);
96 void BKE_mask_point_select_set_handle(struct MaskSplinePoint *point, const short do_select);
97
98 /* general */
99 struct Mask *BKE_mask_new(const char *name);
100 struct Mask *BKE_mask_copy_nolib(struct Mask *mask);
101 struct Mask *BKE_mask_copy(struct Mask *mask);
102
103 void BKE_mask_free(struct Mask *mask);
104 void BKE_mask_unlink(struct Main *bmain, struct Mask *mask);
105
106 void BKE_mask_coord_from_movieclip(struct MovieClip *clip, struct MovieClipUser *user, float r_co[2], const float co[2]);
107 void BKE_mask_coord_from_frame(float r_co[2], const float co[2], const float frame_size[2]);
108 void BKE_mask_coord_to_movieclip(struct MovieClip *clip, struct MovieClipUser *user, float r_co[2], const float co[2]);
109 void BKE_mask_coord_to_frame(float r_co[2], const float co[2], const float frame_size[2]);
110
111 /* parenting */
112
113 void BKE_mask_update_display(struct Mask *mask, float ctime);
114
115 void BKE_mask_evaluate_all_masks(struct Main *bmain, float ctime, const int do_newframe);
116 void BKE_mask_evaluate(struct Mask *mask, const float ctime, const int do_newframe);
117 void BKE_mask_layer_evaluate(struct MaskLayer *masklay, const float ctime, const int do_newframe);
118 void BKE_mask_update_scene(struct Main *bmain, struct Scene *scene, const int do_newframe);
119 void BKE_mask_parent_init(struct MaskParent *parent);
120 void BKE_mask_calc_handle_adjacent_interp(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
121 void BKE_mask_calc_tangent_polyline(struct MaskSpline *spline, struct MaskSplinePoint *point, float t[2]);
122 void BKE_mask_calc_handle_point(struct MaskSpline *spline, struct MaskSplinePoint *point);
123 void BKE_mask_calc_handle_point_auto(struct MaskSpline *spline, struct MaskSplinePoint *point,
124                                      const short do_recalc_length);
125 void BKE_mask_get_handle_point_adjacent(struct MaskSpline *spline, struct MaskSplinePoint *point,
126                                         struct MaskSplinePoint **r_point_prev, struct MaskSplinePoint **r_point_next);
127 void BKE_mask_layer_calc_handles(struct MaskLayer *masklay);
128 void BKE_mask_layer_calc_handles_deform(struct MaskLayer *masklay);
129 void BKE_mask_calc_handles(struct Mask *mask);
130 void BKE_mask_calc_handles_deform(struct Mask *mask);
131 void BKE_mask_spline_ensure_deform(struct MaskSpline *spline);
132
133 /* animation */
134 int  BKE_mask_layer_shape_totvert(struct MaskLayer *masklay);
135 void BKE_mask_layer_shape_from_mask(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
136 void BKE_mask_layer_shape_to_mask(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
137 void BKE_mask_layer_shape_to_mask_interp(struct MaskLayer *masklay,
138                                          struct MaskLayerShape *masklay_shape_a,
139                                          struct MaskLayerShape *masklay_shape_b,
140                                          const float fac);
141 struct MaskLayerShape *BKE_mask_layer_shape_find_frame(struct MaskLayer *masklay, const int frame);
142 int BKE_mask_layer_shape_find_frame_range(struct MaskLayer *masklay, const float frame,
143                                           struct MaskLayerShape **r_masklay_shape_a,
144                                           struct MaskLayerShape **r_masklay_shape_b);
145 struct MaskLayerShape *BKE_mask_layer_shape_alloc(struct MaskLayer *masklay, const int frame);
146 void BKE_mask_layer_shape_free(struct MaskLayerShape *masklay_shape);
147 struct MaskLayerShape *BKE_mask_layer_shape_varify_frame(struct MaskLayer *masklay, const int frame);
148 struct MaskLayerShape *BKE_mask_layer_shape_duplicate(struct MaskLayerShape *masklay_shape);
149 void BKE_mask_layer_shape_unlink(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
150 void BKE_mask_layer_shape_sort(struct MaskLayer *masklay);
151
152 int BKE_mask_layer_shape_spline_from_index(struct MaskLayer *masklay, int index,
153                                             struct MaskSpline **r_masklay_shape, int *r_index);
154 int BKE_mask_layer_shape_spline_to_index(struct MaskLayer *masklay, struct MaskSpline *spline);
155
156 int BKE_mask_layer_shape_spline_index(struct MaskLayer *masklay, int index,
157                                        struct MaskSpline **r_masklay_shape, int *r_index);
158 void BKE_mask_layer_shape_changed_add(struct MaskLayer *masklay, int index,
159                                        int do_init, int do_init_interpolate);
160
161 void BKE_mask_layer_shape_changed_remove(struct MaskLayer *masklay, int index, int count);
162
163 int BKE_mask_get_duration(struct Mask *mask);
164
165 #define MASKPOINT_ISSEL_ANY(p)          ( ((p)->bezt.f1 | (p)->bezt.f2 | (p)->bezt.f2) & SELECT)
166 #define MASKPOINT_ISSEL_KNOT(p)         ( (p)->bezt.f2 & SELECT)
167 #define MASKPOINT_ISSEL_HANDLE_ONLY(p)  ( (((p)->bezt.f1 | (p)->bezt.f2) & SELECT) && (((p)->bezt.f2 & SELECT) == 0) )
168 #define MASKPOINT_ISSEL_HANDLE(p)       ( (((p)->bezt.f1 | (p)->bezt.f2) & SELECT) )
169
170 #define MASKPOINT_SEL_ALL(p)    { (p)->bezt.f1 |=  SELECT; (p)->bezt.f2 |=  SELECT; (p)->bezt.f3 |=  SELECT; } (void)0
171 #define MASKPOINT_DESEL_ALL(p)  { (p)->bezt.f1 &= ~SELECT; (p)->bezt.f2 &= ~SELECT; (p)->bezt.f3 &= ~SELECT; } (void)0
172 #define MASKPOINT_INVSEL_ALL(p) { (p)->bezt.f1 ^=  SELECT; (p)->bezt.f2 ^=  SELECT; (p)->bezt.f3 ^=  SELECT; } (void)0
173
174 #define MASKPOINT_SEL_HANDLE(p)     { (p)->bezt.f1 |=  SELECT; (p)->bezt.f3 |=  SELECT; } (void)0
175 #define MASKPOINT_DESEL_HANDLE(p)   { (p)->bezt.f1 &= ~SELECT; (p)->bezt.f3 &= ~SELECT; } (void)0
176
177 #define MASK_RESOL_MAX 128
178
179
180 /* mask_evaluate.c */
181 unsigned int BKE_mask_spline_resolution(struct MaskSpline *spline, int width, int height);
182 unsigned int BKE_mask_spline_feather_resolution(struct MaskSpline *spline, int width, int height);
183 int          BKE_mask_spline_differentiate_calc_total(const struct MaskSpline *spline, const unsigned int resol);
184
185 float (*BKE_mask_spline_differentiate(struct MaskSpline *spline, int *tot_diff_point))[2];
186 float (*BKE_mask_spline_feather_differentiated_points(struct MaskSpline *spline, int *tot_feather_point))[2];
187
188 float (*BKE_mask_spline_differentiate_with_resolution_ex(struct MaskSpline *spline, int *tot_diff_point,
189                                                          const unsigned int resol))[2];
190 void    BKE_mask_spline_feather_collapse_inner_loops(struct MaskSpline *spline, float (*feather_points)[2], const int tot_feather_point);
191 float (*BKE_mask_spline_differentiate_with_resolution(struct MaskSpline *spline, int width, int height, int *tot_diff_point))[2];
192 float (*BKE_mask_spline_feather_differentiated_points_with_resolution_ex(struct MaskSpline *spline, int *tot_feather_point,
193                                                                          const unsigned int resol, const int do_feather_isect))[2];
194 float (*BKE_mask_spline_feather_differentiated_points_with_resolution(struct MaskSpline *spline, int width, int height,
195                                                                       int *tot_feather_point, const int do_feather_isect))[2];
196 /* *** mask point functions which involve evaluation *** */
197 float (*BKE_mask_spline_feather_points(struct MaskSpline *spline, int *tot_feather_point))[2];
198
199 float *BKE_mask_point_segment_diff(struct MaskSpline *spline, struct MaskSplinePoint *point,
200                                    unsigned int *tot_diff_point);
201 float *BKE_mask_point_segment_feather_diff(struct MaskSpline *spline, struct MaskSplinePoint *point,
202                                            unsigned int *tot_feather_point);
203
204 float *BKE_mask_point_segment_diff_with_resolution(struct MaskSpline *spline, struct MaskSplinePoint *point,
205                                                    int width, int height,
206                                                    unsigned int *tot_diff_point);
207
208 float *BKE_mask_point_segment_feather_diff_with_resolution(struct MaskSpline *spline, struct MaskSplinePoint *point,
209                                                            int width, int height,
210                                                            unsigned int *tot_feather_point);
211
212 /* mask_rasterize.c */
213 struct MaskRasterHandle;
214 typedef struct MaskRasterHandle MaskRasterHandle;
215
216 MaskRasterHandle *BKE_maskrasterize_handle_new(void);
217 void              BKE_maskrasterize_handle_free(MaskRasterHandle *mr_handle);
218 void              BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, struct Mask *mask,
219                                                 const int width, const int height,
220                                                 const short do_aspect_correct, const short do_mask_aa,
221                                                 const short do_feather);
222 float             BKE_maskrasterize_handle_sample(MaskRasterHandle *mr_handle, const float xy[2]);
223
224 void              BKE_maskrasterize_buffer(MaskRasterHandle *mr_handle,
225                                            const unsigned int width, const unsigned int height,
226                                            float *buffer);
227
228 #endif /* __BKE_MASK_H__ */