[#34013] [video sequence editor] Offset and crop of strips are wrong
[blender.git] / source / blender / blenkernel / BKE_tracking.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) 2011 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation,
22  *                 Sergey Sharybin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef __BKE_TRACKING_H__
28 #define __BKE_TRACKING_H__
29
30 /** \file BKE_tracking.h
31  *  \ingroup bke
32  *  \author Sergey Sharybin
33  */
34
35 struct bGPDlayer;
36 struct ImBuf;
37 struct ListBase;
38 struct MovieReconstructContext;
39 struct MovieTrackingTrack;
40 struct MovieTrackingMarker;
41 struct MovieTracking;
42 struct MovieTrackingContext;
43 struct MovieTrackingObject;
44 struct MovieClipUser;
45 struct MovieDistortion;
46 struct Camera;
47 struct Object;
48 struct Scene;
49
50 /* **** Common functions **** */
51
52 void BKE_tracking_free(struct MovieTracking *tracking);
53
54 void BKE_tracking_settings_init(struct MovieTracking *tracking);
55
56 struct ListBase *BKE_tracking_get_active_tracks(struct MovieTracking *tracking);
57 struct MovieTrackingReconstruction *BKE_tracking_get_active_reconstruction(struct MovieTracking *tracking);
58
59 /* matrices for constraints and drawing */
60 void BKE_tracking_get_camera_object_matrix(struct Scene *scene, struct Object *ob, float mat[4][4]);
61 void BKE_tracking_get_projection_matrix(struct MovieTracking *tracking, struct MovieTrackingObject *object,
62                                         int framenr, int winx, int winy, float mat[4][4]);
63
64 /* **** Clipboard **** */
65 void BKE_tracking_clipboard_free(void);
66 void BKE_tracking_clipboard_copy_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
67 int BKE_tracking_clipboard_has_tracks(void);
68 void BKE_tracking_clipboard_paste_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
69
70 /* **** Track **** */
71 struct MovieTrackingTrack *BKE_tracking_track_add(struct MovieTracking *tracking, struct ListBase *tracksbase,
72                                                   float x, float y, int framenr, int width, int height);
73 void BKE_tracking_track_unique_name(struct ListBase *tracksbase, struct MovieTrackingTrack *track);
74 void BKE_tracking_track_free(struct MovieTrackingTrack *track);
75
76 void BKE_tracking_track_flag_set(struct MovieTrackingTrack *track, int area, int flag);
77 void BKE_tracking_track_flag_clear(struct MovieTrackingTrack *track, int area, int flag);
78
79 int BKE_tracking_track_has_marker_at_frame(struct MovieTrackingTrack *track, int framenr);
80 int BKE_tracking_track_has_enabled_marker_at_frame(struct MovieTrackingTrack *track, int framenr);
81
82 void BKE_tracking_track_path_clear(struct MovieTrackingTrack *track, int ref_frame, int action);
83 void BKE_tracking_tracks_join(struct MovieTracking *tracking, struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
84
85 struct MovieTrackingTrack *BKE_tracking_track_get_named(struct MovieTracking *tracking,
86                                                         struct MovieTrackingObject *object,
87                                                         const char *name);
88 struct MovieTrackingTrack *BKE_tracking_track_get_indexed(struct MovieTracking *tracking, int tracknr,
89                                                           struct ListBase **tracksbase_r);
90
91 struct MovieTrackingTrack *BKE_tracking_track_get_active(struct MovieTracking *tracking);
92
93 float *BKE_tracking_track_get_mask(int frame_width, int frame_height, struct MovieTrackingTrack *track,
94                                    struct MovieTrackingMarker *marker);
95
96 /* selection */
97 void BKE_tracking_track_select(struct ListBase *tracksbase, struct MovieTrackingTrack *track, int area, int extend);
98 void BKE_tracking_track_deselect(struct MovieTrackingTrack *track, int area);
99
100 /* **** Marker **** */
101 struct MovieTrackingMarker *BKE_tracking_marker_insert(struct MovieTrackingTrack *track,
102                                                        struct MovieTrackingMarker *marker);
103 void BKE_tracking_marker_delete(struct MovieTrackingTrack *track, int framenr);
104
105 void BKE_tracking_marker_clamp(struct MovieTrackingMarker *marker, int event);
106
107 struct MovieTrackingMarker *BKE_tracking_marker_get(struct MovieTrackingTrack *track, int framenr);
108 struct MovieTrackingMarker *BKE_tracking_marker_get_exact(struct MovieTrackingTrack *track, int framenr);
109 struct MovieTrackingMarker *BKE_tracking_marker_ensure(struct MovieTrackingTrack *track, int framenr);
110
111 void BKE_tracking_marker_pattern_minmax(const struct MovieTrackingMarker *marker, float min[2], float max[2]);
112
113 void BKE_tracking_marker_get_subframe_position(struct MovieTrackingTrack *track, float framenr, float pos[2]);
114
115 /* **** Object **** */
116 struct MovieTrackingObject *BKE_tracking_object_add(struct MovieTracking *tracking, const char *name);
117 int BKE_tracking_object_delete(struct MovieTracking *tracking, struct MovieTrackingObject *object);
118
119 void BKE_tracking_object_unique_name(struct MovieTracking *tracking, struct MovieTrackingObject *object);
120
121 struct MovieTrackingObject *BKE_tracking_object_get_named(struct MovieTracking *tracking, const char *name);
122
123 struct MovieTrackingObject *BKE_tracking_object_get_active(struct MovieTracking *tracking);
124 struct MovieTrackingObject *BKE_tracking_object_get_camera(struct MovieTracking *tracking);
125
126 struct ListBase *BKE_tracking_object_get_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
127 struct MovieTrackingReconstruction *BKE_tracking_object_get_reconstruction(struct MovieTracking *tracking,
128                                                                            struct MovieTrackingObject *object);
129
130 /* **** Camera **** */
131 void BKE_tracking_camera_shift_get(struct MovieTracking *tracking, int winx, int winy, float *shiftx, float *shifty);
132 void BKE_tracking_camera_to_blender(struct MovieTracking *tracking, struct Scene *scene,
133                                     struct Camera *camera, int width, int height);
134
135 struct MovieReconstructedCamera *BKE_tracking_camera_get_reconstructed(struct MovieTracking *tracking,
136                                                                        struct MovieTrackingObject *object,
137                                                                        int framenr);
138 void BKE_tracking_camera_get_reconstructed_interpolate(struct MovieTracking *tracking,
139                                                        struct MovieTrackingObject *object,
140                                                        int framenr, float mat[4][4]);
141
142 /* **** Distortion/Undistortion **** */
143 struct MovieDistortion *BKE_tracking_distortion_new(void);
144 void BKE_tracking_distortion_update(struct MovieDistortion *distortion, struct MovieTracking *tracking,
145                                     int calibration_width, int calibration_height);
146 struct MovieDistortion *BKE_tracking_distortion_copy(struct MovieDistortion *distortion);
147 struct ImBuf *BKE_tracking_distortion_exec(struct MovieDistortion *distortion, struct MovieTracking *tracking,
148                                            struct ImBuf *ibuf, int width, int height, float overscan, int undistort);
149 void BKE_tracking_distortion_free(struct MovieDistortion *distortion);
150
151 void BKE_tracking_distort_v2(struct MovieTracking *tracking, const float co[2], float r_co[2]);
152 void BKE_tracking_undistort_v2(struct MovieTracking *tracking, const float co[2], float r_co[2]);
153
154 struct ImBuf *BKE_tracking_undistort_frame(struct MovieTracking *tracking, struct ImBuf *ibuf,
155                                            int calibration_width, int calibration_height, float overscan);
156 struct ImBuf *BKE_tracking_distort_frame(struct MovieTracking *tracking, struct ImBuf *ibuf,
157                                          int calibration_width, int calibration_height, float overscan);
158
159 /* **** Image sampling **** */
160 struct ImBuf *BKE_tracking_sample_pattern(int frame_width, int frame_height,
161                                           struct ImBuf *struct_ibuf, struct MovieTrackingTrack *track,
162                                           struct MovieTrackingMarker *marker, int use_mask,
163                                           int num_samples_x, int num_samples_y, float pos[2]);
164 struct ImBuf *BKE_tracking_get_pattern_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
165                                              struct MovieTrackingMarker *marker, int anchored, int disable_channels);
166 struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
167                                             struct MovieTrackingMarker *marker, int anchored, int disable_channels);
168
169 void BKE_tracking_disable_channels(struct ImBuf *ibuf, int disable_red, int disable_green,
170                                    int disable_blue, int grayscale);
171
172 /* **** 2D tracking **** */
173 struct MovieTrackingContext *BKE_tracking_context_new(struct MovieClip *clip, struct MovieClipUser *user,
174                                                       short backwards, short sequence);
175 void BKE_tracking_context_free(struct MovieTrackingContext *context);
176 void BKE_tracking_context_sync(struct MovieTrackingContext *context);
177 void BKE_tracking_context_sync_user(const struct MovieTrackingContext *context, struct MovieClipUser *user);
178 int BKE_tracking_context_step(struct MovieTrackingContext *context);
179
180 /* **** Camera solving **** */
181 int BKE_tracking_reconstruction_check(struct MovieTracking *tracking, struct MovieTrackingObject *object,
182                                       char *error_msg, int error_size);
183
184 struct MovieReconstructContext *BKE_tracking_reconstruction_context_new(struct MovieTracking *tracking,
185                                                                         struct MovieTrackingObject *object,
186                                                                         int keyframe1, int keyframe2,
187                                                                         int width, int height);
188 void BKE_tracking_reconstruction_context_free(struct MovieReconstructContext *context);
189 void BKE_tracking_reconstruction_solve(struct MovieReconstructContext *context, short *stop, short *do_update,
190                                        float *progress, char *stats_message, int message_size);
191 int BKE_tracking_reconstruction_finish(struct MovieReconstructContext *context, struct MovieTracking *tracking);
192
193 /* **** Feature detection **** */
194 void BKE_tracking_detect_fast(struct MovieTracking *tracking, struct ListBase *tracksbase, struct ImBuf *imbuf,
195                               int framenr, int margin, int min_trackness, int min_distance, struct bGPDlayer *layer,
196                               int place_outside_layer);
197
198 /* **** 2D stabilization **** */
199 void BKE_tracking_stabilization_data_get(struct MovieTracking *tracking, int framenr, int width, int height,
200                                          float loc[2], float *scale, float *angle);
201 struct ImBuf *BKE_tracking_stabilize_frame(struct MovieTracking *tracking, int framenr, struct ImBuf *ibuf,
202                                            float loc[2], float *scale, float *angle);
203 void BKE_tracking_stabilization_data_to_mat4(int width, int height, float aspect, float loc[2],
204                                              float scale, float angle, float mat[4][4]);
205
206 /* Dopesheet */
207 void BKE_tracking_dopesheet_tag_update(struct MovieTracking *tracking);
208 void BKE_tracking_dopesheet_update(struct MovieTracking *tracking);
209
210 #define TRACK_SELECTED(track)               ((track)->flag & SELECT || (track)->pat_flag & SELECT || (track)->search_flag & SELECT)
211
212 #define TRACK_AREA_SELECTED(track, area)    ((area) == TRACK_AREA_POINT ? (track)->flag & SELECT : \
213                                              ((area) == TRACK_AREA_PAT ? (track)->pat_flag & SELECT : \
214                                               (track)->search_flag & SELECT))
215
216 #define TRACK_VIEW_SELECTED(sc, track)      ((((track)->flag & TRACK_HIDDEN) == 0) && \
217                                              (TRACK_AREA_SELECTED(track, TRACK_AREA_POINT) || \
218                                               (((sc)->flag & SC_SHOW_MARKER_PATTERN) && TRACK_AREA_SELECTED(track, TRACK_AREA_PAT)) || \
219                                               (((sc)->flag & SC_SHOW_MARKER_SEARCH) && TRACK_AREA_SELECTED(track, TRACK_AREA_SEARCH))))
220
221 #define MARKER_VISIBLE(sc, track, marker)       (((marker)->flag & MARKER_DISABLED) == 0 || ((sc)->flag & SC_HIDE_DISABLED) == 0 || (sc->clip->tracking.act_track == track))
222
223 #define TRACK_CLEAR_UPTO        0
224 #define TRACK_CLEAR_REMAINED    1
225 #define TRACK_CLEAR_ALL         2
226
227 #define CLAMP_PAT_DIM       1
228 #define CLAMP_PAT_POS       2
229 #define CLAMP_SEARCH_DIM    3
230 #define CLAMP_SEARCH_POS    4
231
232 #define TRACK_AREA_NONE     -1
233 #define TRACK_AREA_POINT    1
234 #define TRACK_AREA_PAT      2
235 #define TRACK_AREA_SEARCH   4
236
237 #define TRACK_AREA_ALL      (TRACK_AREA_POINT | TRACK_AREA_PAT | TRACK_AREA_SEARCH)
238
239 #endif