Merge branch 'master' into blender2.8
[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 /** \file BKE_mask.h
32  *  \ingroup bke
33  */
34
35 struct Depsgraph;
36 struct ImageUser;
37 struct Image;
38 struct ListBase;
39 struct Main;
40 struct Mask;
41 struct MaskParent;
42 struct MaskLayer;
43 struct MaskLayerShape;
44 struct MaskSpline;
45 struct MaskSplinePoint;
46 struct MaskSplinePointUW;
47 struct MovieClip;
48 struct MovieClipUser;
49 struct Scene;
50
51 /* mask_ops.c */
52 typedef enum {
53         MASK_WHICH_HANDLE_NONE  = 0,
54         MASK_WHICH_HANDLE_STICK = 1,
55         MASK_WHICH_HANDLE_LEFT  = 2,
56         MASK_WHICH_HANDLE_RIGHT = 3,
57         MASK_WHICH_HANDLE_BOTH  = 4,
58 } eMaskWhichHandle;
59
60 typedef enum {
61         MASK_HANDLE_MODE_STICK = 1,
62         MASK_HANDLE_MODE_INDIVIDUAL_HANDLES = 2,
63 } eMaskhandleMode;
64
65 struct MaskSplinePoint *BKE_mask_spline_point_array(
66         struct MaskSpline *spline);
67 struct MaskSplinePoint *BKE_mask_spline_point_array_from_point(
68         struct MaskSpline *spline, const struct MaskSplinePoint *point_ref);
69
70 /* mask layers */
71 struct MaskLayer *BKE_mask_layer_new(struct Mask *mask, const char *name);
72 struct MaskLayer *BKE_mask_layer_active(struct Mask *mask);
73 void BKE_mask_layer_active_set(struct Mask *mask, struct MaskLayer *masklay);
74 void BKE_mask_layer_remove(struct Mask *mask, struct MaskLayer *masklay);
75
76 void BKE_mask_layer_free_shapes(struct MaskLayer *masklay);
77 void BKE_mask_layer_free(struct MaskLayer *masklay);
78 void BKE_mask_layer_free_list(struct ListBase *masklayers);
79 void BKE_mask_spline_free(struct MaskSpline *spline);
80 void BKE_mask_spline_free_list(struct ListBase *splines);
81 struct MaskSpline *BKE_mask_spline_copy(const struct MaskSpline *spline);
82 void BKE_mask_point_free(struct MaskSplinePoint *point);
83
84 void BKE_mask_layer_unique_name(struct Mask *mask, struct MaskLayer *masklay);
85 void BKE_mask_layer_rename(struct Mask *mask, struct MaskLayer *masklay, char *oldname, char *newname);
86
87 struct MaskLayer *BKE_mask_layer_copy(const struct MaskLayer *layer);
88 void BKE_mask_layer_copy_list(struct ListBase *masklayers_new, const struct ListBase *masklayers);
89
90 /* splines */
91 struct MaskSpline *BKE_mask_spline_add(struct MaskLayer *masklay);
92 bool BKE_mask_spline_remove(struct MaskLayer *mask_layer, struct MaskSpline *spline);
93 void BKE_mask_point_direction_switch(struct MaskSplinePoint *point);
94 void BKE_mask_spline_direction_switch(struct MaskLayer *masklay, struct MaskSpline *spline);
95
96 struct BezTriple *BKE_mask_spline_point_next_bezt(struct MaskSpline *spline, struct MaskSplinePoint *points_array,
97                                                   struct MaskSplinePoint *point);
98
99 typedef enum {
100         MASK_PROJ_NEG = -1,
101         MASK_PROJ_ANY = 0,
102         MASK_PROJ_POS = 1
103 } eMaskSign;
104 float BKE_mask_spline_project_co(struct MaskSpline *spline, struct MaskSplinePoint *point,
105                                  float start_u, const float co[2], const eMaskSign sign);
106
107 /* point */
108 eMaskhandleMode BKE_mask_point_handles_mode_get(struct MaskSplinePoint *point);
109 void BKE_mask_point_handle(struct MaskSplinePoint *point, eMaskWhichHandle which_handle, float handle[2]);
110 void BKE_mask_point_set_handle(struct MaskSplinePoint *point, eMaskWhichHandle which_handle, float loc[2], bool keep_direction,
111                                float orig_handle[2], float orig_vec[3][3]);
112
113 void BKE_mask_point_segment_co(struct MaskSpline *spline, struct MaskSplinePoint *point, float u, float co[2]);
114 void BKE_mask_point_normal(struct MaskSpline *spline, struct MaskSplinePoint *point,
115                            float u, float n[2]);
116 float BKE_mask_point_weight_scalar(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
117 float BKE_mask_point_weight(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
118 struct MaskSplinePointUW *BKE_mask_point_sort_uw(struct MaskSplinePoint *point, struct MaskSplinePointUW *uw);
119 void BKE_mask_point_add_uw(struct MaskSplinePoint *point, float u, float w);
120
121 void BKE_mask_point_select_set(struct MaskSplinePoint *point, const bool do_select);
122 void BKE_mask_point_select_set_handle(struct MaskSplinePoint *point, const eMaskWhichHandle which_handle, const bool do_select);
123
124 /* general */
125 struct Mask *BKE_mask_new(struct Main *bmain, const char *name);
126 void BKE_mask_copy_data(struct Main *bmain, struct Mask *mask_dst, const struct Mask *mask_src, const int flag);
127 struct Mask *BKE_mask_copy_nolib(struct Mask *mask);
128 struct Mask *BKE_mask_copy(struct Main *bmain, const struct Mask *mask);
129
130 void BKE_mask_make_local(struct Main *bmain, struct Mask *mask, const bool lib_local);
131
132 void BKE_mask_free(struct Mask *mask);
133
134 void BKE_mask_coord_from_frame(float r_co[2], const float co[2], const float frame_size[2]);
135 void BKE_mask_coord_from_movieclip(struct MovieClip *clip, struct MovieClipUser *user, float r_co[2], const float co[2]);
136 void BKE_mask_coord_from_image(struct Image *image, struct ImageUser *iuser, float r_co[2], const float co[2]);
137 void BKE_mask_coord_to_frame(float r_co[2], const float co[2], const float frame_size[2]);
138 void BKE_mask_coord_to_movieclip(struct MovieClip *clip, struct MovieClipUser *user, float r_co[2], const float co[2]);
139 void BKE_mask_coord_to_image(struct Image *image, struct ImageUser *iuser, float r_co[2], const float co[2]);
140
141 /* parenting */
142
143 void BKE_mask_update_display(struct Mask *mask, float ctime);
144
145 void BKE_mask_evaluate_all_masks(struct Main *bmain, float ctime, const bool do_newframe);
146 void BKE_mask_evaluate(struct Mask *mask, const float ctime, const bool do_newframe);
147 void BKE_mask_layer_evaluate(struct MaskLayer *masklay, const float ctime, const bool do_newframe);
148 void BKE_mask_parent_init(struct MaskParent *parent);
149 void BKE_mask_calc_handle_adjacent_interp(struct MaskSpline *spline, struct MaskSplinePoint *point, const float u);
150 void BKE_mask_calc_tangent_polyline(struct MaskSpline *spline, struct MaskSplinePoint *point, float t[2]);
151 void BKE_mask_calc_handle_point(struct MaskSpline *spline, struct MaskSplinePoint *point);
152 void BKE_mask_calc_handle_point_auto(struct MaskSpline *spline, struct MaskSplinePoint *point,
153                                      const bool do_recalc_length);
154 void BKE_mask_get_handle_point_adjacent(struct MaskSpline *spline, struct MaskSplinePoint *point,
155                                         struct MaskSplinePoint **r_point_prev, struct MaskSplinePoint **r_point_next);
156 void BKE_mask_layer_calc_handles(struct MaskLayer *masklay);
157 void BKE_mask_spline_ensure_deform(struct MaskSpline *spline);
158 void BKE_mask_point_parent_matrix_get(struct MaskSplinePoint *point, float ctime, float parent_matrix[3][3]);
159
160 /* animation */
161 int  BKE_mask_layer_shape_totvert(struct MaskLayer *masklay);
162 void BKE_mask_layer_shape_from_mask(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
163 void BKE_mask_layer_shape_to_mask(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
164 void BKE_mask_layer_shape_to_mask_interp(struct MaskLayer *masklay,
165                                          struct MaskLayerShape *masklay_shape_a,
166                                          struct MaskLayerShape *masklay_shape_b,
167                                          const float fac);
168 struct MaskLayerShape *BKE_mask_layer_shape_find_frame(struct MaskLayer *masklay, const int frame);
169 int BKE_mask_layer_shape_find_frame_range(struct MaskLayer *masklay, const float frame,
170                                           struct MaskLayerShape **r_masklay_shape_a,
171                                           struct MaskLayerShape **r_masklay_shape_b);
172 struct MaskLayerShape *BKE_mask_layer_shape_alloc(struct MaskLayer *masklay, const int frame);
173 void BKE_mask_layer_shape_free(struct MaskLayerShape *masklay_shape);
174 struct MaskLayerShape *BKE_mask_layer_shape_verify_frame(struct MaskLayer *masklay, const int frame);
175 struct MaskLayerShape *BKE_mask_layer_shape_duplicate(struct MaskLayerShape *masklay_shape);
176 void BKE_mask_layer_shape_unlink(struct MaskLayer *masklay, struct MaskLayerShape *masklay_shape);
177 void BKE_mask_layer_shape_sort(struct MaskLayer *masklay);
178
179 bool BKE_mask_layer_shape_spline_from_index(struct MaskLayer *masklay, int index,
180                                             struct MaskSpline **r_masklay_shape, int *r_index);
181 int BKE_mask_layer_shape_spline_to_index(struct MaskLayer *masklay, struct MaskSpline *spline);
182
183 void BKE_mask_layer_shape_changed_add(struct MaskLayer *masklay, int index,
184                                       bool do_init, bool do_init_interpolate);
185
186 void BKE_mask_layer_shape_changed_remove(struct MaskLayer *masklay, int index, int count);
187
188 int BKE_mask_get_duration(struct Mask *mask);
189
190 /* clipboard */
191 void BKE_mask_clipboard_free(void);
192 void BKE_mask_clipboard_copy_from_layer(struct MaskLayer *mask_layer);
193 bool BKE_mask_clipboard_is_empty(void);
194 void BKE_mask_clipboard_paste_to_layer(struct Main *bmain, struct MaskLayer *mask_layer);
195
196 #define MASKPOINT_ISSEL_ANY(p)          (( ((p)->bezt.f1 | (p)->bezt.f2 | (p)->bezt.f3) & SELECT) != 0)
197 #define MASKPOINT_ISSEL_KNOT(p)         (( (p)->bezt.f2 & SELECT) != 0)
198
199 #define MASKPOINT_ISSEL_HANDLE(point, which_handle) \
200         (((which_handle == MASK_WHICH_HANDLE_STICK) ? \
201          ((((point)->bezt.f1 | (point)->bezt.f3) & SELECT)) : \
202          ((which_handle == MASK_WHICH_HANDLE_LEFT) ? \
203          ((point)->bezt.f1 & SELECT) : \
204          ((point)->bezt.f3 & SELECT))) != 0)
205
206 #define MASKPOINT_SEL_ALL(p)    { (p)->bezt.f1 |=  SELECT; (p)->bezt.f2 |=  SELECT; (p)->bezt.f3 |=  SELECT; } (void)0
207 #define MASKPOINT_DESEL_ALL(p)  { (p)->bezt.f1 &= ~SELECT; (p)->bezt.f2 &= ~SELECT; (p)->bezt.f3 &= ~SELECT; } (void)0
208 #define MASKPOINT_INVSEL_ALL(p) { (p)->bezt.f1 ^=  SELECT; (p)->bezt.f2 ^=  SELECT; (p)->bezt.f3 ^=  SELECT; } (void)0
209
210 #define MASK_RESOL_MAX 128
211
212
213 /* mask_evaluate.c */
214 unsigned int BKE_mask_spline_resolution(struct MaskSpline *spline, int width, int height);
215 unsigned int BKE_mask_spline_feather_resolution(struct MaskSpline *spline, int width, int height);
216 int          BKE_mask_spline_differentiate_calc_total(const struct MaskSpline *spline, const unsigned int resol);
217
218 float (*BKE_mask_spline_differentiate_with_resolution(struct MaskSpline *spline, unsigned int *tot_diff_point,
219                                                       const unsigned int resol))[2];
220 void    BKE_mask_spline_feather_collapse_inner_loops(struct MaskSpline *spline, float (*feather_points)[2], const unsigned int tot_feather_point);
221 float (*BKE_mask_spline_differentiate(struct MaskSpline *spline, int width, int height, unsigned int *tot_diff_point))[2];
222 float (*BKE_mask_spline_feather_differentiated_points_with_resolution(struct MaskSpline *spline, unsigned int *tot_feather_point,
223                                                                       const unsigned int resol, const bool do_feather_isect))[2];
224
225 /* *** mask point functions which involve evaluation *** */
226 float (*BKE_mask_spline_feather_points(struct MaskSpline *spline, int *tot_feather_point))[2];
227
228 float *BKE_mask_point_segment_diff(struct MaskSpline *spline, struct MaskSplinePoint *point,
229                                    int width, int height,
230                                    unsigned int *tot_diff_point);
231
232 float *BKE_mask_point_segment_feather_diff(struct MaskSpline *spline, struct MaskSplinePoint *point,
233                                            int width, int height,
234                                            unsigned int *tot_feather_point);
235
236 void BKE_mask_layer_evaluate_animation(struct MaskLayer *masklay, const float ctime);
237 void BKE_mask_layer_evaluate_deform(struct MaskLayer *masklay, const float ctime);
238
239 void BKE_mask_eval_animation(struct Depsgraph *depsgraph, struct Mask *mask);
240 void BKE_mask_eval_update(struct Depsgraph *depsgraph, struct Mask *mask);
241
242 /* mask_rasterize.c */
243 struct MaskRasterHandle;
244 typedef struct MaskRasterHandle MaskRasterHandle;
245
246 MaskRasterHandle *BKE_maskrasterize_handle_new(void);
247 void              BKE_maskrasterize_handle_free(MaskRasterHandle *mr_handle);
248 void              BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, struct Mask *mask,
249                                                 const int width, const int height,
250                                                 const bool do_aspect_correct, const bool do_mask_aa,
251                                                 const bool do_feather);
252 float             BKE_maskrasterize_handle_sample(MaskRasterHandle *mr_handle, const float xy[2]);
253
254 void              BKE_maskrasterize_buffer(MaskRasterHandle *mr_handle,
255                                            const unsigned int width, const unsigned int height,
256                                            float *buffer);
257
258 #endif /* __BKE_MASK_H__ */