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