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