RNA: Add check_existing arg to other load() funcs
[blender.git] / source / blender / blenkernel / BKE_movieclip.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2011 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Blender Foundation,
22  *                 Sergey Sharybin
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 #ifndef __BKE_MOVIECLIP_H__
28 #define __BKE_MOVIECLIP_H__
29
30 /** \file BKE_movieclip.h
31  *  \ingroup bke
32  *  \author Sergey Sharybin
33  */
34
35 struct ImBuf;
36 struct Main;
37 struct MovieClip;
38 struct MovieClipScopes;
39 struct MovieClipUser;
40 struct MovieDistortion;
41
42 void BKE_movieclip_free(struct MovieClip *clip);
43 void BKE_movieclip_unlink(struct Main *bmain, struct MovieClip *clip);
44
45 struct MovieClip *BKE_movieclip_file_add(struct Main *bmain, const char *name);
46 struct MovieClip *BKE_movieclip_file_add_exists_ex(struct Main *bmain, const char *name, bool *r_exists);
47 struct MovieClip *BKE_movieclip_file_add_exists(struct Main *bmain, const char *name);
48 void BKE_movieclip_reload(struct MovieClip *clip);
49 void BKE_movieclip_clear_cache(struct MovieClip *clip);
50 void BKE_movieclip_clear_proxy_cache(struct MovieClip *clip);
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, struct MovieClipUser *user, int postprocess_flag);
54 struct ImBuf *BKE_movieclip_get_stable_ibuf(struct MovieClip *clip, struct MovieClipUser *user, float loc[2], float *scale, float *angle, int postprocess_flag);
55 struct ImBuf *BKE_movieclip_get_ibuf_flag(struct MovieClip *clip, struct MovieClipUser *user, int flag, int cache_flag);
56 void BKE_movieclip_get_size(struct MovieClip *clip, struct MovieClipUser *user, int *width, int *height);
57 void BKE_movieclip_get_size_fl(struct MovieClip *clip, struct MovieClipUser *user, float size[2]);
58 int  BKE_movieclip_get_duration(struct MovieClip *clip);
59 void BKE_movieclip_get_aspect(struct MovieClip *clip, float *aspx, float *aspy);
60 bool BKE_movieclip_has_frame(struct MovieClip *clip, struct MovieClipUser *user);
61 void BKE_movieclip_user_set_frame(struct MovieClipUser *user, int framenr);
62
63 void BKE_movieclip_update_scopes(struct MovieClip *clip, struct MovieClipUser *user, struct MovieClipScopes *scopes);
64
65 void BKE_movieclip_get_cache_segments(struct MovieClip *clip, struct MovieClipUser *user, int *r_totseg, int **r_points);
66
67 void BKE_movieclip_build_proxy_frame(struct MovieClip *clip, int clip_flag, struct MovieDistortion *distortion,
68                                      int cfra, int *build_sizes, int build_count, bool undistorted);
69
70 void BKE_movieclip_build_proxy_frame_for_ibuf(struct MovieClip *clip, struct ImBuf *ibuf, struct MovieDistortion *distortion,
71                                               int cfra, int *build_sizes, int build_count, bool undistorted);
72
73 float BKE_movieclip_remap_scene_to_clip_frame(struct MovieClip *clip, float framenr);
74 float BKE_movieclip_remap_clip_to_scene_frame(struct MovieClip *clip, float framenr);
75
76 void BKE_movieclip_filename_for_frame(struct MovieClip *clip, struct MovieClipUser *user, char *name);
77 struct ImBuf *BKE_movieclip_anim_ibuf_for_frame(struct MovieClip *clip, struct MovieClipUser *user);
78
79 bool BKE_movieclip_has_cached_frame(struct MovieClip *clip, struct MovieClipUser *user);
80 bool BKE_movieclip_put_frame_if_possible(struct MovieClip *clip, struct MovieClipUser *user, struct ImBuf *ibuf);
81
82 /* cacheing flags */
83 #define MOVIECLIP_CACHE_SKIP        (1 << 0)
84
85 /* postprocessing flags */
86 #define MOVIECLIP_DISABLE_RED       (1 << 0)
87 #define MOVIECLIP_DISABLE_GREEN     (1 << 1)
88 #define MOVIECLIP_DISABLE_BLUE      (1 << 2)
89 #define MOVIECLIP_PREVIEW_GRAYSCALE (1 << 3)
90
91 #endif