GPencil: Fix unreported unable to deselect when masking is OFF
[blender.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 struct Depsgraph;
28 struct ImBuf;
29 struct Main;
30 struct MovieClip;
31 struct MovieClipScopes;
32 struct MovieClipUser;
33 struct MovieDistortion;
34
35 void BKE_movieclip_free(struct MovieClip *clip);
36
37 void BKE_movieclip_copy_data(struct Main *bmain,
38                              struct MovieClip *clip_dst,
39                              const struct MovieClip *clip_src,
40                              const int flag);
41 struct MovieClip *BKE_movieclip_copy(struct Main *bmain, const struct MovieClip *clip);
42 void BKE_movieclip_make_local(struct Main *bmain, struct MovieClip *clip, const bool lib_local);
43
44 struct MovieClip *BKE_movieclip_file_add(struct Main *bmain, const char *name);
45 struct MovieClip *BKE_movieclip_file_add_exists_ex(struct Main *bmain,
46                                                    const char *name,
47                                                    bool *r_exists);
48 struct MovieClip *BKE_movieclip_file_add_exists(struct Main *bmain, const char *name);
49 void BKE_movieclip_reload(struct Main *bmain, struct MovieClip *clip);
50 void BKE_movieclip_clear_cache(struct MovieClip *clip);
51 void BKE_movieclip_clear_proxy_cache(struct MovieClip *clip);
52
53 void BKE_movieclip_convert_multilayer_ibuf(struct ImBuf *ibuf);
54
55 struct ImBuf *BKE_movieclip_get_ibuf(struct MovieClip *clip, struct MovieClipUser *user);
56 struct ImBuf *BKE_movieclip_get_postprocessed_ibuf(struct MovieClip *clip,
57                                                    struct MovieClipUser *user,
58                                                    int postprocess_flag);
59 struct ImBuf *BKE_movieclip_get_stable_ibuf(struct MovieClip *clip,
60                                             struct MovieClipUser *user,
61                                             float loc[2],
62                                             float *scale,
63                                             float *angle,
64                                             int postprocess_flag);
65 struct ImBuf *BKE_movieclip_get_ibuf_flag(struct MovieClip *clip,
66                                           struct MovieClipUser *user,
67                                           int flag,
68                                           int cache_flag);
69 void BKE_movieclip_get_size(struct MovieClip *clip,
70                             struct MovieClipUser *user,
71                             int *width,
72                             int *height);
73 void BKE_movieclip_get_size_fl(struct MovieClip *clip, struct MovieClipUser *user, float size[2]);
74 int BKE_movieclip_get_duration(struct MovieClip *clip);
75 float BKE_movieclip_get_fps(struct MovieClip *clip);
76 void BKE_movieclip_get_aspect(struct MovieClip *clip, float *aspx, float *aspy);
77 bool BKE_movieclip_has_frame(struct MovieClip *clip, struct MovieClipUser *user);
78 void BKE_movieclip_user_set_frame(struct MovieClipUser *user, int framenr);
79
80 void BKE_movieclip_update_scopes(struct MovieClip *clip,
81                                  struct MovieClipUser *user,
82                                  struct MovieClipScopes *scopes);
83
84 void BKE_movieclip_get_cache_segments(struct MovieClip *clip,
85                                       struct MovieClipUser *user,
86                                       int *r_totseg,
87                                       int **r_points);
88
89 void BKE_movieclip_build_proxy_frame(struct MovieClip *clip,
90                                      int clip_flag,
91                                      struct MovieDistortion *distortion,
92                                      int cfra,
93                                      int *build_sizes,
94                                      int build_count,
95                                      bool undistorted);
96
97 void BKE_movieclip_build_proxy_frame_for_ibuf(struct MovieClip *clip,
98                                               struct ImBuf *ibuf,
99                                               struct MovieDistortion *distortion,
100                                               int cfra,
101                                               int *build_sizes,
102                                               int build_count,
103                                               bool undistorted);
104
105 float BKE_movieclip_remap_scene_to_clip_frame(const struct MovieClip *clip, float framenr);
106 float BKE_movieclip_remap_clip_to_scene_frame(const struct MovieClip *clip, float framenr);
107
108 void BKE_movieclip_filename_for_frame(struct MovieClip *clip,
109                                       struct MovieClipUser *user,
110                                       char *name);
111 struct ImBuf *BKE_movieclip_anim_ibuf_for_frame(struct MovieClip *clip,
112                                                 struct MovieClipUser *user);
113
114 bool BKE_movieclip_has_cached_frame(struct MovieClip *clip, struct MovieClipUser *user);
115 bool BKE_movieclip_put_frame_if_possible(struct MovieClip *clip,
116                                          struct MovieClipUser *user,
117                                          struct ImBuf *ibuf);
118
119 /* Dependency graph evaluation. */
120
121 void BKE_movieclip_eval_update(struct Depsgraph *depsgraph,
122                                struct Main *bmain,
123                                struct MovieClip *clip);
124 void BKE_movieclip_eval_selection_update(struct Depsgraph *depsgraph, struct MovieClip *clip);
125
126 /* caching flags */
127 #define MOVIECLIP_CACHE_SKIP (1 << 0)
128
129 /* postprocessing flags */
130 #define MOVIECLIP_DISABLE_RED (1 << 0)
131 #define MOVIECLIP_DISABLE_GREEN (1 << 1)
132 #define MOVIECLIP_DISABLE_BLUE (1 << 2)
133 #define MOVIECLIP_PREVIEW_GRAYSCALE (1 << 3)
134
135 #endif