Code cleanup: use r_ prefix for return args
[blender.git] / source / blender / blenkernel / tracking_private.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  *                 Keir Mierle
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file blender/blenkernel/tracking_private.h
29  *  \ingroup bke
30  *
31  * This file contains declarations of function which are used
32  * by multiple tracking files but which should not be public.
33  */
34
35 #ifndef __TRACKING_PRIVATE_H__
36 #define __TRACKING_PRIVATE_H__
37
38 #include "BLI_threads.h"
39
40 struct GHash;
41 struct MovieTracking;
42 struct MovieTrackingMarker;
43
44 /*********************** Tracks map *************************/
45
46 typedef struct TracksMap {
47         char object_name[MAX_NAME];
48         bool is_camera;
49
50         int num_tracks;
51         int customdata_size;
52
53         char *customdata;
54         MovieTrackingTrack *tracks;
55
56         struct GHash *hash;
57
58         int ptr;
59
60         /* Spin lock is used to sync context during tracking. */
61         SpinLock spin_lock;
62 } TracksMap;
63
64 struct TracksMap *tracks_map_new(const char *object_name, bool is_camera, int num_tracks, int customdata_size);
65 int tracks_map_get_size(struct TracksMap *map);
66 void tracks_map_get_indexed_element(struct TracksMap *map, int index, struct MovieTrackingTrack **track, void **customdata);
67 void tracks_map_insert(struct TracksMap *map, struct MovieTrackingTrack *track, void *customdata);
68 void tracks_map_free(struct TracksMap *map, void (*customdata_free)(void *customdata));
69 void tracks_map_merge(struct TracksMap *map, struct MovieTracking *tracking);
70
71 /*********************** Space transformation functions *************************/
72
73 void tracking_get_search_origin_frame_pixel(int frame_width, int frame_height,
74                                             const struct MovieTrackingMarker *marker,
75                                             float frame_pixel[2]);
76
77 void tracking_get_marker_coords_for_tracking(int frame_width, int frame_height,
78                                              const struct MovieTrackingMarker *marker,
79                                              double search_pixel_x[5], double search_pixel_y[5]);
80
81 void tracking_set_marker_coords_from_tracking(int frame_width, int frame_height, struct MovieTrackingMarker *marker,
82                                               const double search_pixel_x[5], const double search_pixel_y[5]);
83
84 /*********************** General purpose utility functions *************************/
85
86 void tracking_marker_insert_disabled(struct MovieTrackingTrack *track, const struct MovieTrackingMarker *ref_marker,
87                                      bool before, bool overwrite);
88
89 #endif  /* __TRACKING_PRIVATE_H__ */