e6c98c72b55ebeddb835154c815c5e8fce208972
[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 void BKE_tracking_init_settings(struct MovieTracking *tracking);
51 void BKE_tracking_clamp_marker(struct MovieTrackingMarker *marker, int event);
52 void BKE_tracking_track_flag(struct MovieTrackingTrack *track, int area, int flag, int clear);
53
54 struct MovieTrackingTrack *BKE_tracking_add_track(struct MovieTracking *tracking, struct ListBase *tracksbase,
55                                                   float x, float y, int framenr, int width, int height);
56 struct MovieTrackingMarker *BKE_tracking_insert_marker(struct MovieTrackingTrack *track,
57                                                        struct MovieTrackingMarker *marker);
58 void BKE_tracking_delete_marker(struct MovieTrackingTrack *track, int framenr);
59
60 void BKE_tracking_marker_pattern_minmax(const struct MovieTrackingMarker *marker, float min[2], float max[2]);
61 struct MovieTrackingMarker *BKE_tracking_get_marker(struct MovieTrackingTrack *track, int framenr);
62 struct MovieTrackingMarker *BKE_tracking_ensure_marker(struct MovieTrackingTrack *track, int framenr);
63 struct MovieTrackingMarker *BKE_tracking_exact_marker(struct MovieTrackingTrack *track, int framenr);
64 int BKE_tracking_has_marker(struct MovieTrackingTrack *track, int framenr);
65 int BKE_tracking_has_enabled_marker(struct MovieTrackingTrack *track, int framenr);
66
67 void BKE_tracking_free_track(struct MovieTrackingTrack *track);
68
69 void BKE_tracking_clear_path(struct MovieTrackingTrack *track, int ref_frame, int action);
70
71 void BKE_tracking_join_tracks(struct MovieTrackingTrack *dst_track, struct MovieTrackingTrack *src_track);
72 void BKE_tracking_free(struct MovieTracking *tracking);
73
74 struct ImBuf *BKE_tracking_sample_pattern_imbuf(int frame_width, int frame_height,
75                                                 struct ImBuf *struct_ibuf, struct MovieTrackingTrack *track,
76                                                 struct MovieTrackingMarker *marker, int use_mask,
77                                                 int num_samples_x, int num_samples_y, float pos[2]);
78 struct ImBuf *BKE_tracking_get_pattern_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
79                                              struct MovieTrackingMarker *marker, int anchored, int disable_channels);
80 struct ImBuf *BKE_tracking_get_search_imbuf(struct ImBuf *ibuf, struct MovieTrackingTrack *track,
81                                             struct MovieTrackingMarker *marker, int anchored, int disable_channels);
82 float *BKE_tracking_track_mask_get(int frame_width, int frame_height, struct MovieTrackingTrack *track,
83                                    struct MovieTrackingMarker *marker);
84
85 void BKE_track_unique_name(struct ListBase *tracksbase, struct MovieTrackingTrack *track);
86
87 struct MovieTrackingTrack *BKE_tracking_named_track(struct MovieTracking *tracking, struct MovieTrackingObject *object, const char *name);
88 struct MovieTrackingTrack *BKE_tracking_indexed_track(struct MovieTracking *tracking, int tracknr, struct ListBase **tracksbase_r);
89
90 void BKE_tracking_camera_shift(struct MovieTracking *tracking, int winx, int winy, float *shiftx, float *shifty);
91 void BKE_tracking_camera_to_blender(struct MovieTracking *tracking, struct Scene *scene, struct Camera *camera, int width, int height);
92
93 void BKE_get_tracking_mat(struct Scene *scene, struct Object *ob, float mat[4][4]);
94 void BKE_tracking_projection_matrix(struct MovieTracking *tracking, struct MovieTrackingObject *object,
95                                     int framenr, int winx, int winy, float mat[4][4]);
96
97 struct ListBase *BKE_tracking_get_tracks(struct MovieTracking *tracking);
98 struct MovieTrackingReconstruction *BKE_tracking_get_reconstruction(struct MovieTracking *tracking);
99
100 struct MovieTrackingTrack *BKE_tracking_active_track(struct MovieTracking *tracking);
101 struct MovieTrackingObject *BKE_tracking_active_object(struct MovieTracking *tracking);
102 struct MovieTrackingObject *BKE_tracking_get_camera_object(struct MovieTracking *tracking);
103 struct ListBase *BKE_tracking_object_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
104 struct MovieTrackingReconstruction *BKE_tracking_object_reconstruction(struct MovieTracking *tracking,
105                                                                        struct MovieTrackingObject *object);
106
107 void BKE_tracking_disable_imbuf_channels(struct ImBuf *ibuf, int disable_red, int disable_green, int disable_blue, int grayscale);
108
109 /* clipboard */
110 void BKE_tracking_free_clipboard(void);
111 void BKE_tracking_clipboard_copy_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
112 int BKE_tracking_clipboard_has_tracks(void);
113 void BKE_tracking_clipboard_paste_tracks(struct MovieTracking *tracking, struct MovieTrackingObject *object);
114
115 /* 2D tracking */
116 struct MovieTrackingContext *BKE_tracking_context_new(struct MovieClip *clip, struct MovieClipUser *user,
117                                                       short backwards, short sequence);
118 void BKE_tracking_context_free(struct MovieTrackingContext *context);
119 void BKE_tracking_sync(struct MovieTrackingContext *context);
120 void BKE_tracking_sync_user(struct MovieClipUser *user, struct MovieTrackingContext *context);
121 int BKE_tracking_next(struct MovieTrackingContext *context);
122
123 /* Camera solving */
124 int BKE_tracking_can_reconstruct(struct MovieTracking *tracking, struct MovieTrackingObject *object,
125                                  char *error_msg, int error_size);
126
127 struct MovieReconstructContext *BKE_tracking_reconstruction_context_new(struct MovieTracking *tracking,
128                                                                         struct MovieTrackingObject *object, int keyframe1, int keyframe2, int width, int height);
129 void BKE_tracking_reconstruction_context_free(struct MovieReconstructContext *context);
130 void BKE_tracking_solve_reconstruction(struct MovieReconstructContext *context, short *stop, short *do_update,
131                                        float *progress, char *stats_message, int message_size);
132 int BKE_tracking_finish_reconstruction(struct MovieReconstructContext *context, struct MovieTracking *tracking);
133
134 struct MovieReconstructedCamera *BKE_tracking_get_reconstructed_camera(struct MovieTracking *tracking,
135                                                                        struct MovieTrackingObject *object, int framenr);
136 void BKE_tracking_get_interpolated_camera(struct MovieTracking *tracking, struct MovieTrackingObject *object,
137                                           int framenr, float mat[4][4]);
138
139 /* Feature detection */
140 void BKE_tracking_detect_fast(struct MovieTracking *tracking, struct ListBase *tracksbase, struct ImBuf *imbuf,
141                               int framenr, int margin, int min_trackness, int min_distance, struct bGPDlayer *layer,
142                               int place_outside_layer);
143
144 /* 2D stabilization */
145 void BKE_tracking_stabilization_data(struct MovieTracking *tracking, int framenr, int width, int height, float loc[2], float *scale, float *angle);
146 struct ImBuf *BKE_tracking_stabilize(struct MovieTracking *tracking, int framenr, struct ImBuf *ibuf, float loc[2], float *scale, float *angle);
147 void BKE_tracking_stabdata_to_mat4(int width, int height, float aspect, float loc[2], float scale, float angle, float mat[4][4]);
148
149 /* Distortion/Undistortion */
150 void BKE_tracking_apply_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
151 void BKE_tracking_invert_intrinsics(struct MovieTracking *tracking, float co[2], float nco[2]);
152
153 struct MovieDistortion *BKE_tracking_distortion_create(void);
154 struct MovieDistortion *BKE_tracking_distortion_copy(struct MovieDistortion *distortion);
155 struct ImBuf *BKE_tracking_distortion_exec(struct MovieDistortion *distortion, struct MovieTracking *tracking,
156                                            struct ImBuf *ibuf, int width, int height, float overscan, int undistort);
157 void BKE_tracking_distortion_destroy(struct MovieDistortion *distortion);
158
159 struct ImBuf *BKE_tracking_undistort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
160 struct ImBuf *BKE_tracking_distort(struct MovieTracking *tracking, struct ImBuf *ibuf, int width, int height, float overscan);
161
162 /* Object tracking */
163 struct MovieTrackingObject *BKE_tracking_new_object(struct MovieTracking *tracking, const char *name);
164 void BKE_tracking_remove_object(struct MovieTracking *tracking, struct MovieTrackingObject *object);
165 void BKE_tracking_object_unique_name(struct MovieTracking *tracking, struct MovieTrackingObject *object);
166 struct MovieTrackingObject *BKE_tracking_named_object(struct MovieTracking *tracking, const char *name);
167
168 /* Select */
169 void BKE_tracking_select_track(struct ListBase *tracksbase, struct MovieTrackingTrack *track, int area, int extend);
170 void BKE_tracking_deselect_track(struct MovieTrackingTrack *track, int area);
171
172 /* Dopesheet */
173 void BKE_tracking_dopesheet_tag_update(struct MovieTracking *tracking);
174 void BKE_tracking_dopesheet_update(struct MovieTracking *tracking);
175
176 #define TRACK_SELECTED(track)               ((track)->flag & SELECT || (track)->pat_flag & SELECT || (track)->search_flag & SELECT)
177
178 #define TRACK_AREA_SELECTED(track, area)    ((area) == TRACK_AREA_POINT ? (track)->flag & SELECT : \
179                                              ((area) == TRACK_AREA_PAT ? (track)->pat_flag & SELECT : \
180                                               (track)->search_flag & SELECT))
181
182 #define TRACK_VIEW_SELECTED(sc, track)      ((((track)->flag & TRACK_HIDDEN) == 0) && \
183                                              (TRACK_AREA_SELECTED(track, TRACK_AREA_POINT) || \
184                                               (((sc)->flag & SC_SHOW_MARKER_PATTERN) && TRACK_AREA_SELECTED(track, TRACK_AREA_PAT)) || \
185                                               (((sc)->flag & SC_SHOW_MARKER_SEARCH) && TRACK_AREA_SELECTED(track, TRACK_AREA_SEARCH))))
186
187 #define MARKER_VISIBLE(sc, track, marker)       (((marker)->flag & MARKER_DISABLED) == 0 || ((sc)->flag & SC_HIDE_DISABLED) == 0 || (sc->clip->tracking.act_track == track))
188
189 #define TRACK_CLEAR_UPTO        0
190 #define TRACK_CLEAR_REMAINED    1
191 #define TRACK_CLEAR_ALL         2
192
193 #define CLAMP_PAT_DIM       1
194 #define CLAMP_PAT_POS       2
195 #define CLAMP_SEARCH_DIM    3
196 #define CLAMP_SEARCH_POS    4
197
198 #define TRACK_AREA_NONE     -1
199 #define TRACK_AREA_POINT    1
200 #define TRACK_AREA_PAT      2
201 #define TRACK_AREA_SEARCH   4
202
203 #define TRACK_AREA_ALL      (TRACK_AREA_POINT | TRACK_AREA_PAT | TRACK_AREA_SEARCH)
204
205 #endif