Cleanup: remove redundant doxygen \file argument
[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 \ingroup bke
24  */
25
26 struct Depsgraph;
27 struct ImBuf;
28 struct Main;
29 struct MovieClip;
30 struct MovieClipScopes;
31 struct MovieClipUser;
32 struct MovieDistortion;
33
34 void BKE_movieclip_free(struct MovieClip *clip);
35
36 void BKE_movieclip_copy_data(struct Main *bmain, struct MovieClip *clip_dst, const struct MovieClip *clip_src, const int flag);
37 struct MovieClip *BKE_movieclip_copy(struct Main *bmain, const struct MovieClip *clip);
38 void BKE_movieclip_make_local(struct Main *bmain, struct MovieClip *clip, const bool lib_local);
39
40 struct MovieClip *BKE_movieclip_file_add(struct Main *bmain, const char *name);
41 struct MovieClip *BKE_movieclip_file_add_exists_ex(struct Main *bmain, const char *name, bool *r_exists);
42 struct MovieClip *BKE_movieclip_file_add_exists(struct Main *bmain, const char *name);
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, struct MovieClipUser *user, int postprocess_flag);
51 struct ImBuf *BKE_movieclip_get_stable_ibuf(struct MovieClip *clip, struct MovieClipUser *user, float loc[2], float *scale, float *angle, int postprocess_flag);
52 struct ImBuf *BKE_movieclip_get_ibuf_flag(struct MovieClip *clip, struct MovieClipUser *user, int flag, int cache_flag);
53 void BKE_movieclip_get_size(struct MovieClip *clip, struct MovieClipUser *user, int *width, int *height);
54 void BKE_movieclip_get_size_fl(struct MovieClip *clip, struct MovieClipUser *user, float size[2]);
55 int  BKE_movieclip_get_duration(struct MovieClip *clip);
56 float BKE_movieclip_get_fps(struct MovieClip *clip);
57 void BKE_movieclip_get_aspect(struct MovieClip *clip, float *aspx, float *aspy);
58 bool BKE_movieclip_has_frame(struct MovieClip *clip, struct MovieClipUser *user);
59 void BKE_movieclip_user_set_frame(struct MovieClipUser *user, int framenr);
60
61 void BKE_movieclip_update_scopes(struct MovieClip *clip, struct MovieClipUser *user, struct MovieClipScopes *scopes);
62
63 void BKE_movieclip_get_cache_segments(struct MovieClip *clip, struct MovieClipUser *user, int *r_totseg, int **r_points);
64
65 void BKE_movieclip_build_proxy_frame(struct MovieClip *clip, int clip_flag, struct MovieDistortion *distortion,
66                                      int cfra, int *build_sizes, int build_count, bool undistorted);
67
68 void BKE_movieclip_build_proxy_frame_for_ibuf(struct MovieClip *clip, struct ImBuf *ibuf, struct MovieDistortion *distortion,
69                                               int cfra, int *build_sizes, int build_count, bool undistorted);
70
71 float BKE_movieclip_remap_scene_to_clip_frame(const struct MovieClip *clip, float framenr);
72 float BKE_movieclip_remap_clip_to_scene_frame(const struct MovieClip *clip, float framenr);
73
74 void BKE_movieclip_filename_for_frame(struct MovieClip *clip, struct MovieClipUser *user, char *name);
75 struct ImBuf *BKE_movieclip_anim_ibuf_for_frame(struct MovieClip *clip, struct MovieClipUser *user);
76
77 bool BKE_movieclip_has_cached_frame(struct MovieClip *clip, struct MovieClipUser *user);
78 bool BKE_movieclip_put_frame_if_possible(struct MovieClip *clip, struct MovieClipUser *user, struct ImBuf *ibuf);
79
80 /* Evaluation. */
81 void BKE_movieclip_eval_update(struct Depsgraph *depsgraph, struct MovieClip *clip);
82 void BKE_movieclip_eval_selection_update(struct Depsgraph *depsgraph, struct MovieClip *clip);
83
84 /* caching flags */
85 #define MOVIECLIP_CACHE_SKIP        (1 << 0)
86
87 /* postprocessing flags */
88 #define MOVIECLIP_DISABLE_RED       (1 << 0)
89 #define MOVIECLIP_DISABLE_GREEN     (1 << 1)
90 #define MOVIECLIP_DISABLE_BLUE      (1 << 2)
91 #define MOVIECLIP_PREVIEW_GRAYSCALE (1 << 3)
92
93 #endif