Cleanup: MovieClip: Move to IDTypeInfo and remove unused BKE API.
[blender-staging.git] / source / blender / blenkernel / BKE_movieclip.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2011 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BKE_MOVIECLIP_H__
21 #define __BKE_MOVIECLIP_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30
31 struct Depsgraph;
32 struct ImBuf;
33 struct Main;
34 struct MovieClip;
35 struct MovieClipScopes;
36 struct MovieClipUser;
37 struct MovieDistortion;
38
39 struct MovieClip *BKE_movieclip_copy(struct Main *bmain, const struct MovieClip *clip);
40
41 struct MovieClip *BKE_movieclip_file_add(struct Main *bmain, const char *name);
42 struct MovieClip *BKE_movieclip_file_add_exists_ex(struct Main *bmain,
43                                                    const char *name,
44                                                    bool *r_exists);
45 struct MovieClip *BKE_movieclip_file_add_exists(struct Main *bmain, const char *name);
46 void BKE_movieclip_reload(struct Main *bmain, struct MovieClip *clip);
47 void BKE_movieclip_clear_cache(struct MovieClip *clip);
48 void BKE_movieclip_clear_proxy_cache(struct MovieClip *clip);
49
50 void BKE_movieclip_convert_multilayer_ibuf(struct ImBuf *ibuf);
51
52 struct ImBuf *BKE_movieclip_get_ibuf(struct MovieClip *clip, struct MovieClipUser *user);
53 struct ImBuf *BKE_movieclip_get_postprocessed_ibuf(struct MovieClip *clip,
54                                                    struct MovieClipUser *user,
55                                                    int postprocess_flag);
56 struct ImBuf *BKE_movieclip_get_stable_ibuf(struct MovieClip *clip,
57                                             struct MovieClipUser *user,
58                                             float loc[2],
59                                             float *scale,
60                                             float *angle,
61                                             int postprocess_flag);
62 struct ImBuf *BKE_movieclip_get_ibuf_flag(struct MovieClip *clip,
63                                           struct MovieClipUser *user,
64                                           int flag,
65                                           int cache_flag);
66 void BKE_movieclip_get_size(struct MovieClip *clip,
67                             struct MovieClipUser *user,
68                             int *width,
69                             int *height);
70 void BKE_movieclip_get_size_fl(struct MovieClip *clip, struct MovieClipUser *user, float size[2]);
71 int BKE_movieclip_get_duration(struct MovieClip *clip);
72 float BKE_movieclip_get_fps(struct MovieClip *clip);
73 void BKE_movieclip_get_aspect(struct MovieClip *clip, float *aspx, float *aspy);
74 bool BKE_movieclip_has_frame(struct MovieClip *clip, struct MovieClipUser *user);
75 void BKE_movieclip_user_set_frame(struct MovieClipUser *user, int framenr);
76
77 void BKE_movieclip_update_scopes(struct MovieClip *clip,
78                                  struct MovieClipUser *user,
79                                  struct MovieClipScopes *scopes);
80
81 void BKE_movieclip_get_cache_segments(struct MovieClip *clip,
82                                       struct MovieClipUser *user,
83                                       int *r_totseg,
84                                       int **r_points);
85
86 void BKE_movieclip_build_proxy_frame(struct MovieClip *clip,
87                                      int clip_flag,
88                                      struct MovieDistortion *distortion,
89                                      int cfra,
90                                      int *build_sizes,
91                                      int build_count,
92                                      bool undistorted);
93
94 void BKE_movieclip_build_proxy_frame_for_ibuf(struct MovieClip *clip,
95                                               struct ImBuf *ibuf,
96                                               struct MovieDistortion *distortion,
97                                               int cfra,
98                                               int *build_sizes,
99                                               int build_count,
100                                               bool undistorted);
101
102 float BKE_movieclip_remap_scene_to_clip_frame(const struct MovieClip *clip, float framenr);
103 float BKE_movieclip_remap_clip_to_scene_frame(const struct MovieClip *clip, float framenr);
104
105 void BKE_movieclip_filename_for_frame(struct MovieClip *clip,
106                                       struct MovieClipUser *user,
107                                       char *name);
108 struct ImBuf *BKE_movieclip_anim_ibuf_for_frame(struct MovieClip *clip,
109                                                 struct MovieClipUser *user);
110
111 bool BKE_movieclip_has_cached_frame(struct MovieClip *clip, struct MovieClipUser *user);
112 bool BKE_movieclip_put_frame_if_possible(struct MovieClip *clip,
113                                          struct MovieClipUser *user,
114                                          struct ImBuf *ibuf);
115
116 /* Dependency graph evaluation. */
117
118 void BKE_movieclip_eval_update(struct Depsgraph *depsgraph,
119                                struct Main *bmain,
120                                struct MovieClip *clip);
121 void BKE_movieclip_eval_selection_update(struct Depsgraph *depsgraph, struct MovieClip *clip);
122
123 /* caching flags */
124 #define MOVIECLIP_CACHE_SKIP (1 << 0)
125
126 /* postprocessing flags */
127 #define MOVIECLIP_DISABLE_RED (1 << 0)
128 #define MOVIECLIP_DISABLE_GREEN (1 << 1)
129 #define MOVIECLIP_DISABLE_BLUE (1 << 2)
130 #define MOVIECLIP_PREVIEW_GRAYSCALE (1 << 3)
131
132 #ifdef __cplusplus
133 }
134 #endif
135
136 #endif