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