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