Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesrna / intern / rna_movieclip.c
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  * Contributor(s): Blender Foundation,
19  *                 Sergey Sharybin
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file blender/makesrna/intern/rna_movieclip.c
25  *  \ingroup RNA
26  */
27
28 #include <stdlib.h>
29 #include <limits.h>
30
31 #include "MEM_guardedalloc.h"
32
33 #include "DNA_movieclip_types.h"
34 #include "DNA_scene_types.h"
35
36 #include "RNA_define.h"
37
38 #include "rna_internal.h"
39
40 #include "BKE_movieclip.h"
41 #include "BKE_tracking.h"
42
43 #include "WM_types.h"
44
45 #include "IMB_imbuf_types.h"
46 #include "IMB_imbuf.h"
47
48 #ifdef RNA_RUNTIME
49
50 #include "DEG_depsgraph.h"
51
52 #include "ED_clip.h"
53
54 #include "DNA_screen_types.h"
55 #include "DNA_space_types.h"
56
57 static void rna_MovieClip_reload_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
58 {
59         MovieClip *clip = (MovieClip *)ptr->id.data;
60
61         BKE_movieclip_reload(clip);
62         DEG_id_tag_update(&clip->id, 0);
63 }
64
65 static void rna_MovieClip_size_get(PointerRNA *ptr, int *values)
66 {
67         MovieClip *clip = (MovieClip *)ptr->id.data;
68
69         values[0] = clip->lastsize[0];
70         values[1] = clip->lastsize[1];
71 }
72
73 static void rna_MovieClipUser_proxy_render_settings_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
74 {
75         ID *id = (ID *) ptr->id.data;
76         MovieClipUser *user = (MovieClipUser *) ptr->data;
77
78         /* when changing render settings of space clip user
79          * clear cache for clip, so all the memory is available
80          * for new render settings
81          */
82         if (GS(id->name) == ID_SCR) {
83                 bScreen *screen = (bScreen *) id;
84                 ScrArea *area;
85                 SpaceLink *sl;
86
87                 for (area = screen->areabase.first; area; area = area->next) {
88                         for (sl = area->spacedata.first; sl; sl = sl->next) {
89                                 if (sl->spacetype == SPACE_CLIP) {
90                                         SpaceClip *sc = (SpaceClip *) sl;
91
92                                         if (&sc->user == user) {
93                                                 MovieClip *clip = ED_space_clip_get_clip(sc);
94
95                                                 if (clip && (clip->flag & MCLIP_USE_PROXY))
96                                                         BKE_movieclip_clear_cache(clip);
97
98                                                 break;
99                                         }
100                                 }
101                         }
102                 }
103         }
104 }
105
106 #else
107
108 static void rna_def_movieclip_proxy(BlenderRNA *brna)
109 {
110         StructRNA *srna;
111         PropertyRNA *prop;
112
113         static const EnumPropertyItem clip_tc_items[] = {
114                 {IMB_TC_NONE, "NONE", 0, "No TC in use", ""},
115                 {IMB_TC_RECORD_RUN, "RECORD_RUN", 0, "Record Run", "Use images in the order they are recorded"},
116                 {IMB_TC_FREE_RUN, "FREE_RUN", 0, "Free Run", "Use global timestamp written by recording device"},
117                 {IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN, "FREE_RUN_REC_DATE", 0, "Free Run (rec date)",
118                                                         "Interpolate a global timestamp using the record date and time "
119                                                         "written by recording device"},
120                 {IMB_TC_RECORD_RUN_NO_GAPS, "FREE_RUN_NO_GAPS", 0, "Free Run No Gaps",
121                                             "Record run, but ignore timecode, changes in framerate or dropouts"},
122                 {0, NULL, 0, NULL, NULL}
123         };
124
125         srna = RNA_def_struct(brna, "MovieClipProxy", NULL);
126         RNA_def_struct_ui_text(srna, "Movie Clip Proxy", "Proxy parameters for a movie clip");
127         RNA_def_struct_sdna(srna, "MovieClipProxy");
128
129         /* build proxy sized */
130         prop = RNA_def_property(srna, "build_25", PROP_BOOLEAN, PROP_NONE);
131         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_SIZE_25);
132         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
133         RNA_def_property_ui_text(prop, "25%", "Build proxy resolution 25% of the original footage dimension");
134
135         prop = RNA_def_property(srna, "build_50", PROP_BOOLEAN, PROP_NONE);
136         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_SIZE_50);
137         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
138         RNA_def_property_ui_text(prop, "50%", "Build proxy resolution 50% of the original footage dimension");
139
140         prop = RNA_def_property(srna, "build_75", PROP_BOOLEAN, PROP_NONE);
141         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_SIZE_75);
142         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
143         RNA_def_property_ui_text(prop, "75%", "Build proxy resolution 75% of the original footage dimension");
144
145         prop = RNA_def_property(srna, "build_100", PROP_BOOLEAN, PROP_NONE);
146         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_SIZE_100);
147         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
148         RNA_def_property_ui_text(prop, "100%", "Build proxy resolution 100% of the original footage dimension");
149
150         prop = RNA_def_property(srna, "build_undistorted_25", PROP_BOOLEAN, PROP_NONE);
151         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_UNDISTORTED_SIZE_25);
152         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
153         RNA_def_property_ui_text(prop, "25%", "Build proxy resolution 25% of the original undistorted footage dimension");
154
155         prop = RNA_def_property(srna, "build_undistorted_50", PROP_BOOLEAN, PROP_NONE);
156         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_UNDISTORTED_SIZE_50);
157         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
158         RNA_def_property_ui_text(prop, "50%", "Build proxy resolution 50% of the original undistorted footage dimension");
159
160         prop = RNA_def_property(srna, "build_undistorted_75", PROP_BOOLEAN, PROP_NONE);
161         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_UNDISTORTED_SIZE_75);
162         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
163         RNA_def_property_ui_text(prop, "75%", "Build proxy resolution 75% of the original undistorted footage dimension");
164
165         prop = RNA_def_property(srna, "build_undistorted_100", PROP_BOOLEAN, PROP_NONE);
166         RNA_def_property_boolean_sdna(prop, NULL, "build_size_flag", MCLIP_PROXY_UNDISTORTED_SIZE_100);
167         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
168         RNA_def_property_ui_text(prop, "100%",
169                                  "Build proxy resolution 100% of the original undistorted footage dimension");
170
171         /* build timecodes */
172         prop = RNA_def_property(srna, "build_record_run", PROP_BOOLEAN, PROP_NONE);
173         RNA_def_property_boolean_sdna(prop, NULL, "build_tc_flag", IMB_TC_RECORD_RUN);
174         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
175         RNA_def_property_ui_text(prop, "Rec Run", "Build record run time code index");
176
177         prop = RNA_def_property(srna, "build_free_run", PROP_BOOLEAN, PROP_NONE);
178         RNA_def_property_boolean_sdna(prop, NULL, "build_tc_flag", IMB_TC_FREE_RUN);
179         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
180         RNA_def_property_ui_text(prop, "Free Run", "Build free run time code index");
181
182         prop = RNA_def_property(srna, "build_free_run_rec_date", PROP_BOOLEAN, PROP_NONE);
183         RNA_def_property_boolean_sdna(prop, NULL, "build_tc_flag", IMB_TC_INTERPOLATED_REC_DATE_FREE_RUN);
184         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
185         RNA_def_property_ui_text(prop, "Free Run (Rec Date)", "Build free run time code index using Record Date/Time");
186
187         /* quality of proxied image */
188         prop = RNA_def_property(srna, "quality", PROP_INT, PROP_UNSIGNED);
189         RNA_def_property_int_sdna(prop, NULL, "quality");
190         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
191         RNA_def_property_ui_text(prop, "Quality", "JPEG quality of proxy images");
192         RNA_def_property_ui_range(prop, 1, 100, 1, -1);
193
194         prop = RNA_def_property(srna, "timecode", PROP_ENUM, PROP_NONE);
195         RNA_def_property_enum_sdna(prop, NULL, "tc");
196         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
197         RNA_def_property_enum_items(prop, clip_tc_items);
198         RNA_def_property_ui_text(prop, "Timecode", "");
199         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
200
201         /* directory */
202         prop = RNA_def_property(srna, "directory", PROP_STRING, PROP_DIRPATH);
203         RNA_def_property_string_sdna(prop, NULL, "dir");
204         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
205         RNA_def_property_ui_text(prop, "Directory", "Location to store the proxy files");
206         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
207 }
208
209 static void rna_def_moviecliUser(BlenderRNA *brna)
210 {
211         StructRNA *srna;
212         PropertyRNA *prop;
213
214         static EnumPropertyItem clip_render_size_items[] = {
215                 {MCLIP_PROXY_RENDER_SIZE_25, "PROXY_25", 0, "Proxy size 25%", ""},
216                 {MCLIP_PROXY_RENDER_SIZE_50, "PROXY_50", 0, "Proxy size 50%", ""},
217                 {MCLIP_PROXY_RENDER_SIZE_75, "PROXY_75", 0, "Proxy size 75%", ""},
218                 {MCLIP_PROXY_RENDER_SIZE_100, "PROXY_100", 0, "Proxy size 100%", ""},
219                 {MCLIP_PROXY_RENDER_SIZE_FULL, "FULL", 0, "No proxy, full render", ""},
220                 {0, NULL, 0, NULL, NULL}
221         };
222
223         srna = RNA_def_struct(brna, "MovieClipUser", NULL);
224         RNA_def_struct_ui_text(srna, "Movie Clip User",
225                                "Parameters defining how a MovieClip data-block is used by another data-block");
226
227         prop = RNA_def_property(srna, "frame_current", PROP_INT, PROP_TIME);
228         RNA_def_property_int_sdna(prop, NULL, "framenr");
229         RNA_def_property_range(prop, MINAFRAME, MAXFRAME);
230         RNA_def_property_ui_text(prop, "Current Frame", "Current frame number in movie or image sequence");
231
232         /* render size */
233         prop = RNA_def_property(srna, "proxy_render_size", PROP_ENUM, PROP_NONE);
234         RNA_def_property_enum_sdna(prop, NULL, "render_size");
235         RNA_def_property_enum_items(prop, clip_render_size_items);
236         RNA_def_property_ui_text(prop, "Proxy render size",
237                                  "Draw preview using full resolution or different proxy resolutions");
238         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClipUser_proxy_render_settings_update");
239
240         /* render undistorted */
241         prop = RNA_def_property(srna, "use_render_undistorted", PROP_BOOLEAN, PROP_NONE);
242         RNA_def_property_boolean_sdna(prop, NULL, "render_flag", MCLIP_PROXY_RENDER_UNDISTORT);
243         RNA_def_property_ui_text(prop, "Render Undistorted", "Render preview using undistorted proxy");
244         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClipUser_proxy_render_settings_update");
245 }
246
247 static void rna_def_movieClipScopes(BlenderRNA *brna)
248 {
249         StructRNA *srna;
250
251         srna = RNA_def_struct(brna, "MovieClipScopes", NULL);
252         RNA_def_struct_ui_text(srna, "MovieClipScopes", "Scopes for statistical view of a movie clip");
253 }
254
255
256 static void rna_def_movieclip(BlenderRNA *brna)
257 {
258         StructRNA *srna;
259         PropertyRNA *prop;
260
261         static EnumPropertyItem clip_source_items[] = {
262                 {MCLIP_SRC_SEQUENCE, "SEQUENCE", 0, "Image Sequence", "Multiple image files, as a sequence"},
263                 {MCLIP_SRC_MOVIE, "MOVIE", 0, "Movie File", "Movie file"},
264                 {0, NULL, 0, NULL, NULL}
265         };
266
267         srna = RNA_def_struct(brna, "MovieClip", "ID");
268         RNA_def_struct_ui_text(srna, "MovieClip", "MovieClip data-block referencing an external movie file");
269         RNA_def_struct_ui_icon(srna, ICON_SEQUENCE);
270
271         prop = RNA_def_property(srna, "filepath", PROP_STRING, PROP_FILEPATH);
272         RNA_def_property_string_sdna(prop, NULL, "name");
273         RNA_def_property_ui_text(prop, "File Path", "Filename of the movie or sequence file");
274         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
275
276         prop = RNA_def_property(srna, "tracking", PROP_POINTER, PROP_NONE);
277         RNA_def_property_struct_type(prop, "MovieTracking");
278
279         prop = RNA_def_property(srna, "proxy", PROP_POINTER, PROP_NONE);
280         RNA_def_property_struct_type(prop, "MovieClipProxy");
281
282         /* use proxy */
283         prop = RNA_def_property(srna, "use_proxy", PROP_BOOLEAN, PROP_NONE);
284         RNA_def_property_boolean_sdna(prop, NULL, "flag", MCLIP_USE_PROXY);
285         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
286         RNA_def_property_ui_text(prop, "Use Proxy / Timecode",
287                                  "Use a preview proxy and/or timecode index for this clip");
288         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, NULL);
289
290         prop = RNA_def_int_vector(srna, "size", 2, NULL, 0, 0, "Size",
291                                   "Width and height in pixels, zero when image data cant be loaded", 0, 0);
292         RNA_def_property_int_funcs(prop, "rna_MovieClip_size_get", NULL, NULL);
293         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
294
295         prop = RNA_def_property(srna, "display_aspect", PROP_FLOAT, PROP_XYZ);
296         RNA_def_property_float_sdna(prop, NULL, "aspx");
297         RNA_def_property_array(prop, 2);
298         RNA_def_property_range(prop, 0.1f, FLT_MAX);
299         RNA_def_property_ui_range(prop, 0.1f, 5000.0f, 1, 2);
300         RNA_def_property_ui_text(prop, "Display Aspect", "Display Aspect for this clip, does not affect rendering");
301         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, NULL);
302
303         /* source */
304         prop = RNA_def_property(srna, "source", PROP_ENUM, PROP_NONE);
305         RNA_def_property_enum_items(prop, clip_source_items);
306         RNA_def_property_ui_text(prop, "Source", "Where the clip comes from");
307         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
308
309         /* custom proxy directory */
310         prop = RNA_def_property(srna, "use_proxy_custom_directory", PROP_BOOLEAN, PROP_NONE);
311         RNA_def_property_boolean_sdna(prop, NULL, "flag", MCLIP_USE_PROXY_CUSTOM_DIR);
312         RNA_def_property_clear_flag(prop, PROP_ANIMATABLE);
313         RNA_def_property_ui_text(prop, "Proxy Custom Directory",
314                                  "Create proxy images in a custom directory (default is movie location)");
315         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
316
317         /* grease pencil */
318         prop = RNA_def_property(srna, "grease_pencil", PROP_POINTER, PROP_NONE);
319         RNA_def_property_pointer_sdna(prop, NULL, "gpd");
320         RNA_def_property_struct_type(prop, "GreasePencil");
321         RNA_def_property_flag(prop, PROP_EDITABLE | PROP_ID_REFCOUNT);
322         RNA_def_property_ui_text(prop, "Grease Pencil", "Grease pencil data for this movie clip");
323         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, NULL);
324
325         /* start_frame */
326         prop = RNA_def_property(srna, "frame_start", PROP_INT, PROP_NONE);
327         RNA_def_property_int_sdna(prop, NULL, "start_frame");
328         RNA_def_property_ui_text(prop, "Start Frame", "Global scene frame number at which this movie starts playing "
329                                  "(affects all data associated with a clip)");
330         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
331
332         /* frame_offset */
333         prop = RNA_def_property(srna, "frame_offset", PROP_INT, PROP_NONE);
334         RNA_def_property_int_sdna(prop, NULL, "frame_offset");
335         RNA_def_property_ui_text(prop, "Frame Offset", "Offset of footage first frame relative to it's file name "
336                                  "(affects only how footage is loading, does not change data associated with a clip)");
337         RNA_def_property_update(prop, NC_MOVIECLIP | ND_DISPLAY, "rna_MovieClip_reload_update");
338
339         /* length */
340         prop = RNA_def_property(srna, "frame_duration", PROP_INT, PROP_NONE);
341         RNA_def_property_clear_flag(prop, PROP_EDITABLE);
342         RNA_def_property_int_sdna(prop, NULL, "len");
343         RNA_def_property_ui_text(prop, "Duration", "Detected duration of movie clip in frames");
344
345         /* color management */
346         prop = RNA_def_property(srna, "colorspace_settings", PROP_POINTER, PROP_NONE);
347         RNA_def_property_pointer_sdna(prop, NULL, "colorspace_settings");
348         RNA_def_property_struct_type(prop, "ColorManagedInputColorspaceSettings");
349         RNA_def_property_ui_text(prop, "Color Space Settings", "Input color space settings");
350
351         rna_def_animdata_common(srna);
352 }
353
354 void RNA_def_movieclip(BlenderRNA *brna)
355 {
356         rna_def_movieclip(brna);
357         rna_def_movieclip_proxy(brna);
358         rna_def_moviecliUser(brna);
359         rna_def_movieClipScopes(brna);
360 }
361
362 #endif