Added support for the WEBM/VP9 video codec
[blender.git] / source / blender / makesdna / DNA_scene_types.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) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /** \file DNA_scene_types.h
29  *  \ingroup DNA
30  */
31
32 #ifndef __DNA_SCENE_TYPES_H__
33 #define __DNA_SCENE_TYPES_H__
34
35 #include "DNA_defs.h"
36
37 /* XXX, temp feature - campbell */
38 #define DURIAN_CAMERA_SWITCH
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include "DNA_color_types.h"  /* color management */
45 #include "DNA_vec_types.h"
46 #include "DNA_listBase.h"
47 #include "DNA_ID.h"
48 #include "DNA_freestyle_types.h"
49 #include "DNA_gpu_types.h"
50 #include "DNA_userdef_types.h"
51
52 struct CurveMapping;
53 struct Object;
54 struct Brush;
55 struct World;
56 struct Scene;
57 struct Image;
58 struct Group;
59 struct Text;
60 struct bNodeTree;
61 struct AnimData;
62 struct Editing;
63 struct SceneStats;
64 struct bGPdata;
65 struct bGPDbrush;
66 struct MovieClip;
67 struct ColorSpace;
68
69 /* ************************************************************* */
70 /* Scene Data */
71
72 /* Base - Wrapper for referencing Objects in a Scene */
73 typedef struct Base {
74         struct Base *next, *prev;
75         unsigned int lay, selcol;
76         int flag;
77         short sx, sy;
78         struct Object *object;
79 } Base;
80
81 /* ************************************************************* */
82 /* Output Format Data */
83
84 typedef struct AviCodecData {
85         void                    *lpFormat;  /* save format */
86         void                    *lpParms;   /* compressor options */
87         unsigned int    cbFormat;           /* size of lpFormat buffer */
88         unsigned int    cbParms;            /* size of lpParms buffer */
89
90         unsigned int    fccType;            /* stream type, for consistency */
91         unsigned int    fccHandler;         /* compressor */
92         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
93         unsigned int    dwQuality;          /* compress quality 0-10,000 */
94         unsigned int    dwBytesPerSecond;   /* bytes per second */
95         unsigned int    dwFlags;            /* flags... see below */
96         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
97         unsigned int    pad;
98
99         char                    avicodecname[128];
100 } AviCodecData;
101
102 typedef enum eFFMpegPreset {
103         FFM_PRESET_NONE,
104
105 #ifdef DNA_DEPRECATED
106         /* Previously used by h.264 to control encoding speed vs. file size. */
107         FFM_PRESET_ULTRAFAST, /* DEPRECATED */
108         FFM_PRESET_SUPERFAST, /* DEPRECATED */
109         FFM_PRESET_VERYFAST,  /* DEPRECATED */
110         FFM_PRESET_FASTER,    /* DEPRECATED */
111         FFM_PRESET_FAST,      /* DEPRECATED */
112         FFM_PRESET_MEDIUM,    /* DEPRECATED */
113         FFM_PRESET_SLOW,      /* DEPRECATED */
114         FFM_PRESET_SLOWER,    /* DEPRECATED */
115         FFM_PRESET_VERYSLOW,  /* DEPRECATED */
116 #endif
117
118         /* Used by WEBM/VP9 and h.264 to control encoding speed vs. file size.
119          * WEBM/VP9 use these values directly, whereas h.264 map those to
120          * respectively the MEDIUM, SLOWER, and SUPERFAST presets.
121         */
122         FFM_PRESET_GOOD = 10, /* the default and recommended for most applications */
123         FFM_PRESET_BEST, /* recommended if you have lots of time and want the best compression efficiency */
124         FFM_PRESET_REALTIME, /* recommended for live / fast encoding */
125 } eFFMpegPreset;
126
127 /* Mapping from easily-understandable descriptions to CRF values.
128  * Assumes we output 8-bit video. Needs to be remapped if 10-bit
129  * is output.
130  * We use a slightly wider than "subjectively sane range" according
131  * to https://trac.ffmpeg.org/wiki/Encode/H.264#a1.ChooseaCRFvalue
132  */
133 typedef enum eFFMpegCrf {
134         FFM_CRF_NONE = -1,
135         FFM_CRF_LOSSLESS = 0,
136         FFM_CRF_PERC_LOSSLESS = 17,
137         FFM_CRF_HIGH = 20,
138         FFM_CRF_MEDIUM = 23,
139         FFM_CRF_LOW = 26,
140         FFM_CRF_VERYLOW = 29,
141         FFM_CRF_LOWEST = 32,
142 } eFFMpegCrf;
143
144 typedef struct FFMpegCodecData {
145         int type;
146         int codec;
147         int audio_codec;
148         int video_bitrate;
149         int audio_bitrate;
150         int audio_mixrate;
151         int audio_channels;
152         int audio_pad;
153         float audio_volume;
154         int gop_size;
155         int max_b_frames; /* only used if FFMPEG_USE_MAX_B_FRAMES flag is set. */
156         int flags;
157         int constant_rate_factor;
158         int ffmpeg_preset; /* see eFFMpegPreset */
159
160         int rc_min_rate;
161         int rc_max_rate;
162         int rc_buffer_size;
163         int mux_packet_size;
164         int mux_rate;
165         int pad1;
166
167         IDProperty *properties;
168 } FFMpegCodecData;
169
170 /* ************************************************************* */
171 /* Audio */
172
173 typedef struct AudioData {
174         int mixrate; // 2.5: now in FFMpegCodecData: audio_mixrate
175         float main; // 2.5: now in FFMpegCodecData: audio_volume
176         float speed_of_sound;
177         float doppler_factor;
178         int distance_model;
179         short flag;
180         short pad;
181         float volume;
182         float pad2;
183 } AudioData;
184
185 /* *************************************************************** */
186 /* Render Layers */
187
188 /* Render Layer */
189 typedef struct SceneRenderLayer {
190         struct SceneRenderLayer *next, *prev;
191         
192         char name[64];  /* MAX_NAME */
193         
194         struct Material *mat_override;
195         struct Group *light_override;
196         
197         unsigned int lay;                 /* Scene.lay itself has priority over this */
198         unsigned int lay_zmask;   /* has to be after lay, this is for Z-masking */
199         unsigned int lay_exclude; /* not used by internal, exclude */
200         int layflag;
201
202         /* pass_xor has to be after passflag */
203         /* note, this is treestore element 'nr' in outliner, short still... */
204         int passflag;
205         int pass_xor;
206
207         int samples;
208         float pass_alpha_threshold;
209
210         IDProperty *prop;
211
212         struct FreestyleConfig freestyleConfig;
213 } SceneRenderLayer;
214
215 /* SceneRenderLayer.layflag */
216 #define SCE_LAY_SOLID   1
217 #define SCE_LAY_ZTRA    2
218 #define SCE_LAY_HALO    4
219 #define SCE_LAY_EDGE    8
220 #define SCE_LAY_SKY             16
221 #define SCE_LAY_STRAND  32
222 #define SCE_LAY_FRS             64
223 #define SCE_LAY_AO              128
224         /* flags between 256 and 0x8000 are set to 1 already, for future options */
225
226 #define SCE_LAY_ALL_Z           0x8000
227 #define SCE_LAY_XOR                     0x10000
228 #define SCE_LAY_DISABLE         0x20000
229 #define SCE_LAY_ZMASK           0x40000
230 #define SCE_LAY_NEG_ZMASK       0x80000
231
232 /* SceneRenderLayer.passflag */
233 typedef enum eScenePassType {
234         SCE_PASS_COMBINED                 = (1 << 0),
235         SCE_PASS_Z                        = (1 << 1),
236         SCE_PASS_RGBA                     = (1 << 2),
237         SCE_PASS_DIFFUSE                  = (1 << 3),
238         SCE_PASS_SPEC                     = (1 << 4),
239         SCE_PASS_SHADOW                   = (1 << 5),
240         SCE_PASS_AO                       = (1 << 6),
241         SCE_PASS_REFLECT                  = (1 << 7),
242         SCE_PASS_NORMAL                   = (1 << 8),
243         SCE_PASS_VECTOR                   = (1 << 9),
244         SCE_PASS_REFRACT                  = (1 << 10),
245         SCE_PASS_INDEXOB                  = (1 << 11),
246         SCE_PASS_UV                       = (1 << 12),
247         SCE_PASS_INDIRECT                 = (1 << 13),
248         SCE_PASS_MIST                     = (1 << 14),
249         SCE_PASS_RAYHITS                  = (1 << 15),
250         SCE_PASS_EMIT                     = (1 << 16),
251         SCE_PASS_ENVIRONMENT              = (1 << 17),
252         SCE_PASS_INDEXMA                  = (1 << 18),
253         SCE_PASS_DIFFUSE_DIRECT           = (1 << 19),
254         SCE_PASS_DIFFUSE_INDIRECT         = (1 << 20),
255         SCE_PASS_DIFFUSE_COLOR            = (1 << 21),
256         SCE_PASS_GLOSSY_DIRECT            = (1 << 22),
257         SCE_PASS_GLOSSY_INDIRECT          = (1 << 23),
258         SCE_PASS_GLOSSY_COLOR             = (1 << 24),
259         SCE_PASS_TRANSM_DIRECT            = (1 << 25),
260         SCE_PASS_TRANSM_INDIRECT          = (1 << 26),
261         SCE_PASS_TRANSM_COLOR             = (1 << 27),
262         SCE_PASS_SUBSURFACE_DIRECT        = (1 << 28),
263         SCE_PASS_SUBSURFACE_INDIRECT      = (1 << 29),
264         SCE_PASS_SUBSURFACE_COLOR         = (1 << 30),
265         SCE_PASS_ROUGHNESS                = (1 << 31),
266 } eScenePassType;
267
268 #define RE_PASSNAME_COMBINED "Combined"
269 #define RE_PASSNAME_Z "Depth"
270 #define RE_PASSNAME_VECTOR "Vector"
271 #define RE_PASSNAME_NORMAL "Normal"
272 #define RE_PASSNAME_UV "UV"
273 #define RE_PASSNAME_RGBA "Color"
274 #define RE_PASSNAME_EMIT "Emit"
275 #define RE_PASSNAME_DIFFUSE "Diffuse"
276 #define RE_PASSNAME_SPEC "Spec"
277 #define RE_PASSNAME_SHADOW "Shadow"
278
279 #define RE_PASSNAME_AO "AO"
280 #define RE_PASSNAME_ENVIRONMENT "Env"
281 #define RE_PASSNAME_INDIRECT "Indirect"
282 #define RE_PASSNAME_REFLECT "Reflect"
283 #define RE_PASSNAME_REFRACT "Refract"
284 #define RE_PASSNAME_INDEXOB "IndexOB"
285 #define RE_PASSNAME_INDEXMA "IndexMA"
286 #define RE_PASSNAME_MIST "Mist"
287
288 #define RE_PASSNAME_RAYHITS "RayHits"
289 #define RE_PASSNAME_DIFFUSE_DIRECT "DiffDir"
290 #define RE_PASSNAME_DIFFUSE_INDIRECT "DiffInd"
291 #define RE_PASSNAME_DIFFUSE_COLOR "DiffCol"
292 #define RE_PASSNAME_GLOSSY_DIRECT "GlossDir"
293 #define RE_PASSNAME_GLOSSY_INDIRECT "GlossInd"
294 #define RE_PASSNAME_GLOSSY_COLOR "GlossCol"
295 #define RE_PASSNAME_TRANSM_DIRECT "TransDir"
296 #define RE_PASSNAME_TRANSM_INDIRECT "TransInd"
297 #define RE_PASSNAME_TRANSM_COLOR "TransCol"
298
299 #define RE_PASSNAME_SUBSURFACE_DIRECT "SubsurfaceDir"
300 #define RE_PASSNAME_SUBSURFACE_INDIRECT "SubsurfaceInd"
301 #define RE_PASSNAME_SUBSURFACE_COLOR "SubsurfaceCol"
302
303
304 /* View - MultiView */
305 typedef struct SceneRenderView {
306         struct SceneRenderView *next, *prev;
307
308         char name[64];  /* MAX_NAME */
309         char suffix[64];        /* MAX_NAME */
310
311         int viewflag;
312         int pad[2];
313         char pad2[4];
314
315 } SceneRenderView;
316
317 /* SceneRenderView.viewflag */
318 #define SCE_VIEW_DISABLE                (1<<0)
319
320 /* RenderData.views_format */
321 enum {
322         SCE_VIEWS_FORMAT_STEREO_3D = 0,
323         SCE_VIEWS_FORMAT_MULTIVIEW = 1,
324 };
325
326 /* ImageFormatData.views_format (also used for Sequence.views_format) */
327 enum {
328         R_IMF_VIEWS_INDIVIDUAL = 0,
329         R_IMF_VIEWS_STEREO_3D  = 1,
330         R_IMF_VIEWS_MULTIVIEW  = 2,
331 };
332
333 typedef struct Stereo3dFormat {
334         short flag;
335         char display_mode; /* encoding mode */
336         char anaglyph_type; /* anaglyph scheme for the user display */
337         char interlace_type;  /* interlace type for the user display */
338         char pad[3];
339 } Stereo3dFormat;
340
341 /* Stereo3dFormat.display_mode */
342 typedef enum eStereoDisplayMode {
343         S3D_DISPLAY_ANAGLYPH    = 0,
344         S3D_DISPLAY_INTERLACE   = 1,
345         S3D_DISPLAY_PAGEFLIP    = 2,
346         S3D_DISPLAY_SIDEBYSIDE  = 3,
347         S3D_DISPLAY_TOPBOTTOM   = 4,
348 } eStereoDisplayMode;
349
350 /* Stereo3dFormat.flag */
351 typedef enum eStereo3dFlag {
352         S3D_INTERLACE_SWAP        = (1 << 0),
353         S3D_SIDEBYSIDE_CROSSEYED  = (1 << 1),
354         S3D_SQUEEZED_FRAME        = (1 << 2),
355 } eStereo3dFlag;
356
357 /* Stereo3dFormat.anaglyph_type */
358 typedef enum eStereo3dAnaglyphType {
359         S3D_ANAGLYPH_REDCYAN      = 0,
360         S3D_ANAGLYPH_GREENMAGENTA = 1,
361         S3D_ANAGLYPH_YELLOWBLUE   = 2,
362 } eStereo3dAnaglyphType;
363
364 /* Stereo3dFormat.interlace_type */
365 typedef enum eStereo3dInterlaceType {
366         S3D_INTERLACE_ROW          = 0,
367         S3D_INTERLACE_COLUMN       = 1,
368         S3D_INTERLACE_CHECKERBOARD = 2,
369 } eStereo3dInterlaceType;
370
371 /* *************************************************************** */
372
373 /* Generic image format settings,
374  * this is used for NodeImageFile and IMAGE_OT_save_as operator too.
375  *
376  * note: its a bit strange that even though this is an image format struct
377  *  the imtype can still be used to select video formats.
378  *  RNA ensures these enum's are only selectable for render output.
379  */
380 typedef struct ImageFormatData {
381         char imtype;   /* R_IMF_IMTYPE_PNG, R_... */
382                        /* note, video types should only ever be set from this
383                         * structure when used from RenderData */
384         char depth;    /* bits per channel, R_IMF_CHAN_DEPTH_8 -> 32,
385                         * not a flag, only set 1 at a time */
386
387         char planes;   /* - R_IMF_PLANES_BW, R_IMF_PLANES_RGB, R_IMF_PLANES_RGBA */
388         char flag;     /* generic options for all image types, alpha zbuffer */
389
390         char quality;  /* (0 - 100), eg: jpeg quality */
391         char compress; /* (0 - 100), eg: png compression */
392
393
394         /* --- format specific --- */
395
396         /* OpenEXR */
397         char  exr_codec;
398
399         /* Cineon */
400         char  cineon_flag;
401         short cineon_white, cineon_black;
402         float cineon_gamma;
403
404         /* Jpeg2000 */
405         char  jp2_flag;
406         char jp2_codec;
407
408         /* TIFF */
409         char tiff_codec;
410
411         char pad[4];
412
413         /* Multiview */
414         char views_format;
415         Stereo3dFormat stereo3d_format;
416
417         /* color management */
418         ColorManagedViewSettings view_settings;
419         ColorManagedDisplaySettings display_settings;
420 } ImageFormatData;
421
422
423 /* ImageFormatData.imtype */
424 #define R_IMF_IMTYPE_TARGA           0
425 #define R_IMF_IMTYPE_IRIS            1
426 /* #define R_HAMX                    2 */ /* hamx is nomore */
427 /* #define R_FTYPE                   3 */ /* ftype is nomore */
428 #define R_IMF_IMTYPE_JPEG90          4
429 /* #define R_MOVIE                   5 */ /* movie is nomore */
430 #define R_IMF_IMTYPE_IRIZ            7
431 #define R_IMF_IMTYPE_RAWTGA         14
432 #define R_IMF_IMTYPE_AVIRAW         15
433 #define R_IMF_IMTYPE_AVIJPEG        16
434 #define R_IMF_IMTYPE_PNG            17
435 /* #define R_IMF_IMTYPE_AVICODEC    18 */ /* avicodec is nomore */
436 /* #define R_IMF_IMTYPE_QUICKTIME   19 */ /* quicktime is nomore */
437 #define R_IMF_IMTYPE_BMP            20
438 #define R_IMF_IMTYPE_RADHDR         21
439 #define R_IMF_IMTYPE_TIFF           22
440 #define R_IMF_IMTYPE_OPENEXR        23
441 #define R_IMF_IMTYPE_FFMPEG         24
442 #define R_IMF_IMTYPE_FRAMESERVER    25
443 #define R_IMF_IMTYPE_CINEON         26
444 #define R_IMF_IMTYPE_DPX            27
445 #define R_IMF_IMTYPE_MULTILAYER     28
446 #define R_IMF_IMTYPE_DDS            29
447 #define R_IMF_IMTYPE_JP2            30
448 #define R_IMF_IMTYPE_H264           31
449 #define R_IMF_IMTYPE_XVID           32
450 #define R_IMF_IMTYPE_THEORA         33
451 #define R_IMF_IMTYPE_PSD            34
452
453 #define R_IMF_IMTYPE_INVALID        255
454
455 /* ImageFormatData.flag */
456 #define R_IMF_FLAG_ZBUF         (1<<0)   /* was R_OPENEXR_ZBUF */
457 #define R_IMF_FLAG_PREVIEW_JPG  (1<<1)   /* was R_PREVIEW_JPG */
458
459 /* return values from BKE_imtype_valid_depths, note this is depts per channel */
460 #define R_IMF_CHAN_DEPTH_1  (1<<0) /* 1bits  (unused) */
461 #define R_IMF_CHAN_DEPTH_8  (1<<1) /* 8bits  (default) */
462 #define R_IMF_CHAN_DEPTH_10 (1<<2) /* 10bits (uncommon, Cineon/DPX support) */
463 #define R_IMF_CHAN_DEPTH_12 (1<<3) /* 12bits (uncommon, jp2/DPX support) */
464 #define R_IMF_CHAN_DEPTH_16 (1<<4) /* 16bits (tiff, halff float exr) */
465 #define R_IMF_CHAN_DEPTH_24 (1<<5) /* 24bits (unused) */
466 #define R_IMF_CHAN_DEPTH_32 (1<<6) /* 32bits (full float exr) */
467
468 /* ImageFormatData.planes */
469 #define R_IMF_PLANES_RGB   24
470 #define R_IMF_PLANES_RGBA  32
471 #define R_IMF_PLANES_BW    8
472
473 /* ImageFormatData.exr_codec */
474 #define R_IMF_EXR_CODEC_NONE  0
475 #define R_IMF_EXR_CODEC_PXR24 1
476 #define R_IMF_EXR_CODEC_ZIP   2
477 #define R_IMF_EXR_CODEC_PIZ   3
478 #define R_IMF_EXR_CODEC_RLE   4
479 #define R_IMF_EXR_CODEC_ZIPS  5
480 #define R_IMF_EXR_CODEC_B44   6
481 #define R_IMF_EXR_CODEC_B44A  7
482 #define R_IMF_EXR_CODEC_DWAA  8
483 #define R_IMF_EXR_CODEC_DWAB  9
484 #define R_IMF_EXR_CODEC_MAX  10
485
486 /* ImageFormatData.jp2_flag */
487 #define R_IMF_JP2_FLAG_YCC          (1<<0)  /* when disabled use RGB */ /* was R_JPEG2K_YCC */
488 #define R_IMF_JP2_FLAG_CINE_PRESET  (1<<1)  /* was R_JPEG2K_CINE_PRESET */
489 #define R_IMF_JP2_FLAG_CINE_48      (1<<2)  /* was R_JPEG2K_CINE_48FPS */
490
491 /* ImageFormatData.jp2_codec */
492 #define R_IMF_JP2_CODEC_JP2  0
493 #define R_IMF_JP2_CODEC_J2K  1
494
495 /* ImageFormatData.cineon_flag */
496 #define R_IMF_CINEON_FLAG_LOG (1<<0)  /* was R_CINEON_LOG */
497
498 /* ImageFormatData.tiff_codec */
499 enum {
500         R_IMF_TIFF_CODEC_DEFLATE   = 0,
501         R_IMF_TIFF_CODEC_LZW       = 1,
502         R_IMF_TIFF_CODEC_PACKBITS  = 2,
503         R_IMF_TIFF_CODEC_NONE      = 3,
504 };
505
506 typedef struct BakeData {
507         struct ImageFormatData im_format;
508
509         char filepath[1024]; /* FILE_MAX */
510
511         short width, height;
512         short margin, flag;
513
514         float cage_extrusion;
515         int pass_filter;
516
517         char normal_swizzle[3];
518         char normal_space;
519
520         char save_mode;
521         char pad[3];
522
523         char cage[64];  /* MAX_NAME */
524 } BakeData;
525
526 /* BakeData.normal_swizzle (char) */
527 typedef enum eBakeNormalSwizzle {
528         R_BAKE_POSX = 0,
529         R_BAKE_POSY = 1,
530         R_BAKE_POSZ = 2,
531         R_BAKE_NEGX = 3,
532         R_BAKE_NEGY = 4,
533         R_BAKE_NEGZ = 5,
534 } eBakeNormalSwizzle;
535
536 /* BakeData.save_mode (char) */
537 typedef enum eBakeSaveMode {
538         R_BAKE_SAVE_INTERNAL = 0,
539         R_BAKE_SAVE_EXTERNAL = 1,
540 } eBakeSaveMode;
541
542 /* BakeData.pass_filter */
543 typedef enum eBakePassFilter {
544         R_BAKE_PASS_FILTER_NONE           = 0,
545         R_BAKE_PASS_FILTER_AO             = (1 << 0),
546         R_BAKE_PASS_FILTER_EMIT           = (1 << 1),
547         R_BAKE_PASS_FILTER_DIFFUSE        = (1 << 2),
548         R_BAKE_PASS_FILTER_GLOSSY         = (1 << 3),
549         R_BAKE_PASS_FILTER_TRANSM         = (1 << 4),
550         R_BAKE_PASS_FILTER_SUBSURFACE     = (1 << 5),
551         R_BAKE_PASS_FILTER_DIRECT         = (1 << 6),
552         R_BAKE_PASS_FILTER_INDIRECT       = (1 << 7),
553         R_BAKE_PASS_FILTER_COLOR          = (1 << 8),
554 } eBakePassFilter;
555
556 #define R_BAKE_PASS_FILTER_ALL (~0)
557
558 /* *************************************************************** */
559 /* Render Data */
560
561 typedef struct RenderData {
562         struct ImageFormatData im_format;
563         
564         struct AviCodecData *avicodecdata;
565         struct FFMpegCodecData ffcodecdata;
566
567         int cfra, sfra, efra;   /* frames as in 'images' */
568         float subframe;                 /* subframe offset from cfra, in 0.0-1.0 */
569         int psfra, pefra;               /* start+end frames of preview range */
570
571         int images, framapto;
572         short flag, threads;
573
574         float framelen, blurfac;
575
576         /** For UR edge rendering: give the edges this color */
577         float edgeR, edgeG, edgeB;
578
579
580         /* standalone player */  //  XXX deprecated since 2.5
581         short fullscreen  DNA_DEPRECATED, xplay  DNA_DEPRECATED, yplay  DNA_DEPRECATED;
582         short freqplay  DNA_DEPRECATED;
583         /* standalone player */  //  XXX deprecated since 2.5
584         short depth  DNA_DEPRECATED, attrib  DNA_DEPRECATED;
585
586
587         int frame_step;         /* frames to jump during render/playback */
588
589         short stereomode  DNA_DEPRECATED;       /* standalone player stereo settings */  //  XXX deprecated since 2.5
590         
591         short dimensionspreset;         /* for the dimensions presets menu */
592
593         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
594
595         short size; /* size in % */
596         
597         short maximsize DNA_DEPRECATED; /* max in Kb */
598
599         short pad6;
600
601         /* from buttons: */
602         /**
603          * The desired number of pixels in the x direction
604          */
605         int xsch;
606         /**
607          * The desired number of pixels in the y direction
608          */
609         int ysch;
610
611         /**
612          * The number of part to use in the x direction
613          */
614         short xparts DNA_DEPRECATED;
615         /**
616          * The number of part to use in the y direction
617          */
618         short yparts DNA_DEPRECATED;
619
620         /**
621          * render tile dimensions
622          */
623         int tilex, tiley;
624
625         short planes  DNA_DEPRECATED, imtype  DNA_DEPRECATED, subimtype  DNA_DEPRECATED, quality  DNA_DEPRECATED; /*deprecated!*/
626         
627         /**
628          * Render to image editor, fullscreen or to new window.
629          */
630         short displaymode;
631         char use_lock_interface;
632         char pad7;
633
634         /**
635          * Flags for render settings. Use bit-masking to access the settings.
636          */
637         int scemode;
638
639         /**
640          * Flags for render settings. Use bit-masking to access the settings.
641          */
642         int mode;
643
644         /**
645          * Flags for raytrace settings. Use bit-masking to access the settings.
646          */
647         int raytrace_options;
648         
649         /**
650          * Raytrace acceleration structure
651          */
652         short raytrace_structure;
653
654         short pad1;
655
656         /* octree resolution */
657         short ocres;
658         short pad4;
659         
660         /**
661          * What to do with the sky/background. Picks sky/premul/key
662          * blending for the background
663          */
664         short alphamode;
665
666         /**
667          * The number of samples to use per pixel.
668          */
669         short osa;
670
671         short frs_sec, edgeint;
672
673         
674         /* safety, border and display rect */
675         rctf safety, border;
676         rcti disprect;
677         
678         /* information on different layers to be rendered */
679         ListBase layers;
680         short actlay;
681         
682         /* number of mblur samples */
683         short mblur_samples;
684         
685         /**
686          * Adjustment factors for the aspect ratio in the x direction, was a short in 2.45
687          */
688         float xasp, yasp;
689
690         float frs_sec_base;
691         
692         /**
693          * Value used to define filter size for all filter options  */
694         float gauss;
695         
696         
697         /* color management settings - color profiles, gamma correction, etc */
698         int color_mgt_flag;
699         
700         /** post-production settings. deprecated, but here for upwards compat (initialized to 1) */
701         float postgamma, posthue, postsat;
702         
703          /* Dither noise intensity */
704         float dither_intensity;
705         
706         /* Bake Render options */
707         short bake_osa, bake_filter, bake_mode, bake_flag;
708         short bake_normal_space, bake_quad_split;
709         float bake_maxdist, bake_biasdist;
710         short bake_samples, bake_pad;
711         float bake_user_scale, bake_pad1;
712
713         /* path to render output */
714         char pic[1024]; /* 1024 = FILE_MAX */
715
716         /* stamps flags. */
717         int stamp;
718         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
719
720         /* stamp info user data. */
721         char stamp_udata[768];
722
723         /* foreground/background color. */
724         float fg_stamp[4];
725         float bg_stamp[4];
726
727         /* sequencer options */
728         char seq_prev_type;
729         char seq_rend_type;  /* UNUSED! */
730         char seq_flag; /* flag use for sequence render/draw */
731         char pad5[5];
732
733         /* render simplify */
734         int simplify_flag;
735         short simplify_subsurf;
736         short simplify_subsurf_render;
737         short simplify_shadowsamples, pad9;
738         float simplify_particles;
739         float simplify_particles_render;
740         float simplify_aosss;
741
742         /* cineon */
743         short cineonwhite  DNA_DEPRECATED, cineonblack  DNA_DEPRECATED;  /*deprecated*/
744         float cineongamma  DNA_DEPRECATED;  /*deprecated*/
745         
746         /* jpeg2000 */
747         short jp2_preset  DNA_DEPRECATED, jp2_depth  DNA_DEPRECATED;  /*deprecated*/
748         int rpad3;
749
750         /* Dome variables */ //  XXX deprecated since 2.5
751         short domeres  DNA_DEPRECATED, domemode  DNA_DEPRECATED;        //  XXX deprecated since 2.5
752         short domeangle  DNA_DEPRECATED, dometilt  DNA_DEPRECATED;      //  XXX deprecated since 2.5
753         float domeresbuf  DNA_DEPRECATED;       //  XXX deprecated since 2.5
754         float pad2;
755         struct Text *dometext  DNA_DEPRECATED;  //  XXX deprecated since 2.5
756
757         /* Freestyle line thickness options */
758         int line_thickness_mode;
759         float unit_line_thickness; /* in pixels */
760
761         /* render engine */
762         char engine[32];
763
764         /* Cycles baking */
765         struct BakeData bake;
766
767         int preview_start_resolution;
768         short preview_pixel_size;
769
770         /* Type of the debug pass to use.
771          * Only used when built with debug passes support.
772          */
773         short debug_pass_type;
774
775         /* MultiView */
776         ListBase views;  /* SceneRenderView */
777         short actview;
778         short views_format;
779         short pad8[2];
780
781         /* Motion blur shutter */
782         struct CurveMapping mblur_shutter_curve;
783 } RenderData;
784
785 /* *************************************************************** */
786 /* Render Conversion/Simplfication Settings */
787
788 /* control render convert and shading engine */
789 typedef struct RenderProfile {
790         struct RenderProfile *next, *prev;
791         char name[32];
792         
793         short particle_perc;
794         short subsurf_max;
795         short shadbufsample_max;
796         short pad1;
797         
798         float ao_error, pad2;
799         
800 } RenderProfile;
801
802 /* *************************************************************** */
803 /* Game Engine - Dome */
804
805 typedef struct GameDome {
806         short res, mode;
807         short angle, tilt;
808         float resbuf, pad2;
809         struct Text *warptext;
810 } GameDome;
811
812 /* GameDome.mode */
813 #define DOME_FISHEYE                    1
814 #define DOME_TRUNCATED_FRONT    2
815 #define DOME_TRUNCATED_REAR             3
816 #define DOME_ENVMAP                             4
817 #define DOME_PANORAM_SPH                5
818 #define DOME_NUM_MODES                  6
819
820 /* *************************************************************** */
821 /* Game Engine */
822
823 typedef struct GameFraming {
824         float col[3];
825         char type, pad1, pad2, pad3;
826 } GameFraming;
827
828 /* GameFraming.type */
829 #define SCE_GAMEFRAMING_BARS   0
830 #define SCE_GAMEFRAMING_EXTEND 1
831 #define SCE_GAMEFRAMING_SCALE  2
832
833 typedef struct RecastData {
834         float cellsize;
835         float cellheight;
836         float agentmaxslope;
837         float agentmaxclimb;
838         float agentheight;
839         float agentradius;
840         float edgemaxlen;
841         float edgemaxerror;
842         float regionminsize;
843         float regionmergesize;
844         int vertsperpoly;
845         float detailsampledist;
846         float detailsamplemaxerror;
847         char partitioning;
848         char pad1;
849         short pad2;
850 } RecastData;
851
852 /* RecastData.partitioning */
853 #define RC_PARTITION_WATERSHED 0
854 #define RC_PARTITION_MONOTONE 1
855 #define RC_PARTITION_LAYERS 2
856
857 typedef struct GameData {
858
859         /* standalone player */
860         struct GameFraming framing;
861         short playerflag, xplay, yplay, freqplay;
862         short depth, attrib, rt1, rt2;
863         short aasamples, pad4[3];
864
865         /* stereo/dome mode */
866         struct GameDome dome;
867         short stereoflag, stereomode;
868         float eyeseparation;
869         RecastData recastData;
870
871
872         /* physics (it was in world)*/
873         float gravity; /*Gravitation constant for the game world*/
874
875         /*
876          * Radius of the activity bubble, in Manhattan length. Objects
877          * outside the box are activity-culled. */
878         float activityBoxRadius;
879
880         /*
881          * bit 3: (gameengine): Activity culling is enabled.
882          * bit 5: (gameengine) : enable Bullet DBVT tree for view frustum culling
883          */
884         int flag;
885         short mode, matmode;
886         short occlusionRes;             /* resolution of occlusion Z buffer in pixel */
887         short physicsEngine;
888         short exitkey;
889         short vsync; /* Controls vsync: off, on, or adaptive (if supported) */
890         short ticrate, maxlogicstep, physubstep, maxphystep;
891         short obstacleSimulation;
892         short raster_storage;
893         float levelHeight;
894         float deactivationtime, lineardeactthreshold, angulardeactthreshold;
895
896         /* Scene LoD */
897         short lodflag, pad2;
898         int scehysteresis, pad5;
899
900 } GameData;
901
902 /* GameData.stereoflag */
903 #define STEREO_NOSTEREO         1
904 #define STEREO_ENABLED          2
905 #define STEREO_DOME                     3
906
907 /* GameData.stereomode */
908 //#define STEREO_NOSTEREO                1
909 #define STEREO_QUADBUFFERED 2
910 #define STEREO_ABOVEBELOW        3
911 #define STEREO_INTERLACED        4
912 #define STEREO_ANAGLYPH         5
913 #define STEREO_SIDEBYSIDE       6
914 #define STEREO_VINTERLACE       7
915 //#define STEREO_DOME           8
916 #define STEREO_3DTVTOPBOTTOM 9
917
918 /* GameData.physicsEngine */
919 #define WOPHY_NONE              0
920 #define WOPHY_BULLET    5
921
922 /* obstacleSimulation */
923 #define OBSTSIMULATION_NONE             0
924 #define OBSTSIMULATION_TOI_rays         1
925 #define OBSTSIMULATION_TOI_cells        2
926
927 /* GameData.raster_storage */
928 #define RAS_STORE_AUTO          0
929 /* #define RAS_STORE_IMMEDIATE  1 */  /* DEPRECATED */
930 #define RAS_STORE_VA            2
931 #define RAS_STORE_VBO           3
932
933 /* GameData.vsync */
934 #define VSYNC_ON        0
935 #define VSYNC_OFF       1
936 #define VSYNC_ADAPTIVE  2
937
938 /* GameData.flag */
939 #define GAME_RESTRICT_ANIM_UPDATES                      (1 << 0)
940 #define GAME_ENABLE_ALL_FRAMES                          (1 << 1)
941 #define GAME_SHOW_DEBUG_PROPS                           (1 << 2)
942 #define GAME_SHOW_FRAMERATE                                     (1 << 3)
943 #define GAME_SHOW_PHYSICS                                       (1 << 4)
944 #define GAME_DISPLAY_LISTS                                      (1 << 5)
945 #define GAME_GLSL_NO_LIGHTS                                     (1 << 6)
946 #define GAME_GLSL_NO_SHADERS                            (1 << 7)
947 #define GAME_GLSL_NO_SHADOWS                            (1 << 8)
948 #define GAME_GLSL_NO_RAMPS                                      (1 << 9)
949 #define GAME_GLSL_NO_NODES                                      (1 << 10)
950 #define GAME_GLSL_NO_EXTRA_TEX                          (1 << 11)
951 #define GAME_IGNORE_DEPRECATION_WARNINGS        (1 << 12)
952 #define GAME_ENABLE_ANIMATION_RECORD            (1 << 13)
953 #define GAME_SHOW_MOUSE                                         (1 << 14)
954 #define GAME_GLSL_NO_COLOR_MANAGEMENT           (1 << 15)
955 #define GAME_SHOW_OBSTACLE_SIMULATION           (1 << 16)
956 #define GAME_NO_MATERIAL_CACHING                        (1 << 17)
957 #define GAME_GLSL_NO_ENV_LIGHTING                       (1 << 18)
958 /* Note: GameData.flag is now an int (max 32 flags). A short could only take 16 flags */
959
960 /* GameData.playerflag */
961 #define GAME_PLAYER_FULLSCREEN                          (1 << 0)
962 #define GAME_PLAYER_DESKTOP_RESOLUTION          (1 << 1)
963
964 /* GameData.matmode */
965 enum {
966 #ifdef DNA_DEPRECATED
967         GAME_MAT_TEXFACE    = 0, /* deprecated */
968 #endif
969         GAME_MAT_MULTITEX   = 1,
970         GAME_MAT_GLSL       = 2,
971 };
972
973 /* GameData.lodflag */
974 #define SCE_LOD_USE_HYST                (1 << 0)
975
976 /* UV Paint */
977 /* ToolSettings.uv_sculpt_settings */
978 #define UV_SCULPT_LOCK_BORDERS                          1
979 #define UV_SCULPT_ALL_ISLANDS                           2
980
981 /* ToolSettings.uv_sculpt_tool */
982 #define UV_SCULPT_TOOL_PINCH                            1
983 #define UV_SCULPT_TOOL_RELAX                            2
984 #define UV_SCULPT_TOOL_GRAB                                     3
985
986 /* ToolSettings.uv_relax_method */
987 #define UV_SCULPT_TOOL_RELAX_LAPLACIAN  1
988 #define UV_SCULPT_TOOL_RELAX_HC                 2
989
990 /* Stereo Flags */
991 #define STEREO_RIGHT_NAME "right"
992 #define STEREO_LEFT_NAME "left"
993 #define STEREO_RIGHT_SUFFIX "_R"
994 #define STEREO_LEFT_SUFFIX "_L"
995
996 /* View3D.stereo3d_camera / View3D.multiview_eye / ImageUser.multiview_eye */
997 typedef enum eStereoViews {
998         STEREO_LEFT_ID = 0,
999         STEREO_RIGHT_ID = 1,
1000         STEREO_3D_ID = 2,
1001         STEREO_MONO_ID = 3,
1002 } eStereoViews;
1003
1004 /* *************************************************************** */
1005 /* Markers */
1006
1007 typedef struct TimeMarker {
1008         struct TimeMarker *next, *prev;
1009         int frame;
1010         char name[64];
1011         unsigned int flag;
1012         struct Object *camera;
1013 } TimeMarker;
1014
1015 /* *************************************************************** */
1016 /* Paint Mode/Tool Data */
1017
1018 #define PAINT_MAX_INPUT_SAMPLES 64
1019
1020 /* Paint Tool Base */
1021 typedef struct Paint {
1022         struct Brush *brush;
1023         struct Palette *palette;
1024         struct CurveMapping *cavity_curve; /* cavity curve */
1025
1026         /* WM Paint cursor */
1027         void *paint_cursor;
1028         unsigned char paint_cursor_col[4];
1029
1030         /* enum ePaintFlags */
1031         int flags;
1032
1033         /* Paint stroke can use up to PAINT_MAX_INPUT_SAMPLES inputs to
1034          * smooth the stroke */
1035         int num_input_samples;
1036         
1037         /* flags used for symmetry */
1038         int symmetry_flags;
1039
1040         float tile_offset[3];
1041         int pad2;
1042 } Paint;
1043
1044 /* ------------------------------------------- */
1045 /* Image Paint */
1046
1047 /* Texture/Image Editor */
1048 typedef struct ImagePaintSettings {
1049         Paint paint;
1050
1051         short flag, missing_data;
1052         
1053         /* for projection painting only */
1054         short seam_bleed, normal_angle;
1055         short screen_grab_size[2]; /* capture size for re-projection */
1056
1057         int mode;                  /* mode used for texture painting */
1058
1059         void *paintcursor;                 /* wm handle */
1060         struct Image *stencil;     /* workaround until we support true layer masks */
1061         struct Image *clone;       /* clone layer for image mode for projective texture painting */
1062         struct Image *canvas;      /* canvas when the explicit system is used for painting */
1063         float stencil_col[3];
1064         float dither;              /* dither amount used when painting on byte images */
1065 } ImagePaintSettings;
1066
1067 /* ------------------------------------------- */
1068 /* Particle Edit */
1069
1070 /* Settings for a Particle Editing Brush */
1071 typedef struct ParticleBrushData {
1072         short size;                                             /* common setting */
1073         short step, invert, count;              /* for specific brushes only */
1074         int flag;
1075         float strength;
1076 } ParticleBrushData;
1077
1078 /* Particle Edit Mode Settings */
1079 typedef struct ParticleEditSettings {
1080         short flag;
1081         short totrekey;
1082         short totaddkey;
1083         short brushtype;
1084
1085         ParticleBrushData brush[7];
1086         void *paintcursor;                      /* runtime */
1087
1088         float emitterdist, rt;
1089
1090         int selectmode;
1091         int edittype;
1092
1093         int draw_step, fade_frames;
1094
1095         struct Scene *scene;
1096         struct Object *object;
1097         struct Object *shape_object;
1098 } ParticleEditSettings;
1099
1100 /* ------------------------------------------- */
1101 /* Sculpt */
1102
1103 /* Sculpt */
1104 typedef struct Sculpt {
1105         Paint paint;
1106
1107         /* For rotating around a pivot point */
1108         //float pivot[3]; XXX not used?
1109         int flags;
1110
1111         /* Control tablet input */
1112         //char tablet_size, tablet_strength; XXX not used?
1113         int radial_symm[3];
1114
1115         /* Maximum edge length for dynamic topology sculpting (in pixels) */
1116         float detail_size;
1117
1118         /* Direction used for SCULPT_OT_symmetrize operator */
1119         int symmetrize_direction;
1120
1121         /* gravity factor for sculpting */
1122         float gravity_factor;
1123
1124         /* scale for constant detail size */
1125         float constant_detail; /* Constant detail resolution (Blender unit / constant_detail) */
1126         float detail_percent;
1127         float pad;
1128
1129         struct Object *gravity_object;
1130 } Sculpt;
1131
1132 typedef struct UvSculpt {
1133         Paint paint;
1134 } UvSculpt;
1135
1136 /* ------------------------------------------- */
1137 /* Vertex Paint */
1138
1139 /* Vertex Paint */
1140 typedef struct VPaint {
1141         Paint paint;
1142         char flag;
1143         char pad[3];
1144         int radial_symm[3]; /* For mirrored painting */
1145 } VPaint;
1146
1147 /* VPaint.flag */
1148 enum {
1149         /* weight paint only */
1150         VP_FLAG_VGROUP_RESTRICT     = (1 << 7)
1151 };
1152
1153 /* ------------------------------------------- */
1154 /* GPencil Stroke Sculpting */
1155
1156 /* GP_BrushEdit_Settings.brushtype */
1157 typedef enum eGP_EditBrush_Types {
1158         GP_EDITBRUSH_TYPE_SMOOTH    = 0,
1159         GP_EDITBRUSH_TYPE_THICKNESS = 1,
1160         GP_EDITBRUSH_TYPE_GRAB      = 2,
1161         GP_EDITBRUSH_TYPE_PUSH      = 3,
1162         GP_EDITBRUSH_TYPE_TWIST     = 4,
1163         GP_EDITBRUSH_TYPE_PINCH     = 5,
1164         GP_EDITBRUSH_TYPE_RANDOMIZE = 6,
1165         GP_EDITBRUSH_TYPE_SUBDIVIDE = 7,
1166         GP_EDITBRUSH_TYPE_SIMPLIFY  = 8,
1167         GP_EDITBRUSH_TYPE_CLONE     = 9,
1168         GP_EDITBRUSH_TYPE_STRENGTH  = 10,
1169
1170         /* !!! Update GP_EditBrush_Data brush[###]; below !!! */
1171         TOT_GP_EDITBRUSH_TYPES
1172 } eGP_EditBrush_Types;
1173
1174 /* GP_BrushEdit_Settings.lock_axis */
1175 typedef enum eGP_Lockaxis_Types {
1176         GP_LOCKAXIS_NONE = 0,
1177         GP_LOCKAXIS_X = 1,
1178         GP_LOCKAXIS_Y = 2,
1179         GP_LOCKAXIS_Z = 3
1180 } eGP_Lockaxis_Types;
1181
1182 /* Settings for a GPencil Stroke Sculpting Brush */
1183 typedef struct GP_EditBrush_Data {
1184         short size;             /* radius of brush */
1185         short flag;             /* eGP_EditBrush_Flag */
1186         float strength;         /* strength of effect */
1187 } GP_EditBrush_Data;
1188
1189 /* GP_EditBrush_Data.flag */
1190 typedef enum eGP_EditBrush_Flag {
1191         /* invert the effect of the brush */
1192         GP_EDITBRUSH_FLAG_INVERT       = (1 << 0),
1193         /* adjust strength using pen pressure */
1194         GP_EDITBRUSH_FLAG_USE_PRESSURE = (1 << 1),
1195         
1196         /* strength of brush falls off with distance from cursor */
1197         GP_EDITBRUSH_FLAG_USE_FALLOFF  = (1 << 2),
1198         
1199         /* smooth brush affects pressure values as well */
1200         GP_EDITBRUSH_FLAG_SMOOTH_PRESSURE  = (1 << 3)
1201 } eGP_EditBrush_Flag;
1202
1203
1204
1205 /* GPencil Stroke Sculpting Settings */
1206 typedef struct GP_BrushEdit_Settings {
1207         GP_EditBrush_Data brush[11];  /* TOT_GP_EDITBRUSH_TYPES */
1208         void *paintcursor;            /* runtime */
1209         
1210         int brushtype;                /* eGP_EditBrush_Types */
1211         int flag;                     /* eGP_BrushEdit_SettingsFlag */
1212         int lock_axis;                /* eGP_Lockaxis_Types lock drawing to one axis */
1213         float alpha;                  /* alpha factor for selection color */
1214 } GP_BrushEdit_Settings;
1215
1216 /* GP_BrushEdit_Settings.flag */
1217 typedef enum eGP_BrushEdit_SettingsFlag {
1218         /* only affect selected points */
1219         GP_BRUSHEDIT_FLAG_SELECT_MASK = (1 << 0),
1220         /* apply brush to position */
1221         GP_BRUSHEDIT_FLAG_APPLY_POSITION = (1 << 1),
1222         /* apply brush to strength */
1223         GP_BRUSHEDIT_FLAG_APPLY_STRENGTH = (1 << 2),
1224         /* apply brush to thickness */
1225         GP_BRUSHEDIT_FLAG_APPLY_THICKNESS = (1 << 3),
1226 } eGP_BrushEdit_SettingsFlag;
1227
1228
1229 /* Settings for GP Interpolation Operators */
1230 typedef struct GP_Interpolate_Settings {
1231         short flag;                        /* eGP_Interpolate_SettingsFlag */
1232         
1233         char type;                         /* eGP_Interpolate_Type - Interpolation Mode */ 
1234         char easing;                       /* eBezTriple_Easing - Easing mode (if easing equation used) */
1235         
1236         float back;                        /* BEZT_IPO_BACK */
1237         float amplitude, period;           /* BEZT_IPO_ELASTIC */
1238         
1239         struct CurveMapping *custom_ipo;   /* custom interpolation curve (for use with GP_IPO_CURVEMAP) */
1240 } GP_Interpolate_Settings;
1241
1242 /* GP_Interpolate_Settings.flag */
1243 typedef enum eGP_Interpolate_SettingsFlag {
1244         /* apply interpolation to all layers */
1245         GP_TOOLFLAG_INTERPOLATE_ALL_LAYERS    = (1 << 0),
1246         /* apply interpolation to only selected */
1247         GP_TOOLFLAG_INTERPOLATE_ONLY_SELECTED = (1 << 1),
1248 } eGP_Interpolate_SettingsFlag;
1249
1250 /* GP_Interpolate_Settings.type */
1251 typedef enum eGP_Interpolate_Type {
1252         /* Traditional Linear Interpolation */
1253         GP_IPO_LINEAR   = 0,
1254         
1255         /* CurveMap Defined Interpolation */
1256         GP_IPO_CURVEMAP = 1,
1257         
1258         /* Easing Equations */
1259         GP_IPO_BACK = 3,
1260         GP_IPO_BOUNCE = 4,
1261         GP_IPO_CIRC = 5,
1262         GP_IPO_CUBIC = 6,
1263         GP_IPO_ELASTIC = 7,
1264         GP_IPO_EXPO = 8,
1265         GP_IPO_QUAD = 9,
1266         GP_IPO_QUART = 10,
1267         GP_IPO_QUINT = 11,
1268         GP_IPO_SINE = 12,
1269 } eGP_Interpolate_Type;
1270
1271
1272 /* *************************************************************** */
1273 /* Transform Orientations */
1274
1275 typedef struct TransformOrientation {
1276         struct TransformOrientation *next, *prev;
1277         char name[64];  /* MAX_NAME */
1278         float mat[3][3];
1279         int pad;
1280 } TransformOrientation;
1281
1282 /* *************************************************************** */
1283 /* Unified Paint Settings
1284  */
1285
1286 /* These settings can override the equivalent fields in the active
1287  * Brush for any paint mode; the flag field controls whether these
1288  * values are used */
1289 typedef struct UnifiedPaintSettings {
1290         /* unified radius of brush in pixels */
1291         int size;
1292
1293         /* unified radius of brush in Blender units */
1294         float unprojected_radius;
1295
1296         /* unified strength of brush */
1297         float alpha;
1298
1299         /* unified brush weight, [0, 1] */
1300         float weight;
1301
1302         /* unified brush color */
1303         float rgb[3];
1304         /* unified brush secondary color */
1305         float secondary_rgb[3];
1306
1307         /* user preferences for sculpt and paint */
1308         int flag;
1309
1310         /* rake rotation */
1311
1312         /* record movement of mouse so that rake can start at an intuitive angle */
1313         float last_rake[2];
1314         float last_rake_angle;
1315         
1316         int last_stroke_valid;
1317         float average_stroke_accum[3];
1318         int average_stroke_counter;
1319         
1320
1321         float brush_rotation;
1322         float brush_rotation_sec;
1323
1324         /*********************************************************************************
1325          *  all data below are used to communicate with cursor drawing and tex sampling  *
1326          *********************************************************************************/
1327         int anchored_size;
1328
1329         float overlap_factor; /* normalization factor due to accumulated value of curve along spacing.
1330                                * Calculated when brush spacing changes to dampen strength of stroke
1331                                * if space attenuation is used*/
1332         char draw_inverted;
1333         /* check is there an ongoing stroke right now */
1334         char stroke_active;
1335
1336         char draw_anchored;
1337         char do_linear_conversion;
1338
1339         /* store last location of stroke or whether the mesh was hit. Valid only while stroke is active */
1340         float last_location[3];
1341         int last_hit;
1342
1343         float anchored_initial_mouse[2];
1344
1345         /* radius of brush, premultiplied with pressure.
1346          * In case of anchored brushes contains the anchored radius */
1347         float pixel_radius;
1348
1349         /* drawing pressure */
1350         float size_pressure_value;
1351
1352         /* position of mouse, used to sample the texture */
1353         float tex_mouse[2];
1354
1355         /* position of mouse, used to sample the mask texture */
1356         float mask_tex_mouse[2];
1357
1358         /* ColorSpace cache to avoid locking up during sampling */
1359         struct ColorSpace *colorspace;
1360 } UnifiedPaintSettings;
1361
1362 /* UnifiedPaintSettings.flag */
1363 typedef enum {
1364         UNIFIED_PAINT_SIZE  = (1 << 0),
1365         UNIFIED_PAINT_ALPHA = (1 << 1),
1366         UNIFIED_PAINT_WEIGHT = (1 << 5),
1367         UNIFIED_PAINT_COLOR = (1 << 6),
1368
1369         /* only used if unified size is enabled, mirrors the brush flags
1370          * BRUSH_LOCK_SIZE and BRUSH_SIZE_PRESSURE */
1371         UNIFIED_PAINT_BRUSH_LOCK_SIZE = (1 << 2),
1372         UNIFIED_PAINT_BRUSH_SIZE_PRESSURE   = (1 << 3),
1373
1374         /* only used if unified alpha is enabled, mirrors the brush flag
1375          * BRUSH_ALPHA_PRESSURE */
1376         UNIFIED_PAINT_BRUSH_ALPHA_PRESSURE  = (1 << 4)
1377 } eUnifiedPaintSettingsFlags;
1378
1379
1380 typedef struct CurvePaintSettings {
1381         char curve_type;
1382         char flag;
1383         char depth_mode;
1384         char surface_plane;
1385         char fit_method;
1386         char pad;
1387         short error_threshold;
1388         float radius_min, radius_max;
1389         float radius_taper_start, radius_taper_end;
1390         float surface_offset;
1391         float corner_angle;
1392 } CurvePaintSettings;
1393
1394 /* CurvePaintSettings.flag */
1395 enum {
1396         CURVE_PAINT_FLAG_CORNERS_DETECT             = (1 << 0),
1397         CURVE_PAINT_FLAG_PRESSURE_RADIUS            = (1 << 1),
1398         CURVE_PAINT_FLAG_DEPTH_STROKE_ENDPOINTS     = (1 << 2),
1399         CURVE_PAINT_FLAG_DEPTH_STROKE_OFFSET_ABS    = (1 << 3),
1400 };
1401
1402 /* CurvePaintSettings.fit_method */
1403 enum {
1404         CURVE_PAINT_FIT_METHOD_REFIT            = 0,
1405         CURVE_PAINT_FIT_METHOD_SPLIT            = 1,
1406 };
1407
1408 /* CurvePaintSettings.depth_mode */
1409 enum {
1410         CURVE_PAINT_PROJECT_CURSOR              = 0,
1411         CURVE_PAINT_PROJECT_SURFACE             = 1,
1412 };
1413
1414 /* CurvePaintSettings.surface_plane */
1415 enum {
1416         CURVE_PAINT_SURFACE_PLANE_NORMAL_VIEW           = 0,
1417         CURVE_PAINT_SURFACE_PLANE_NORMAL_SURFACE        = 1,
1418         CURVE_PAINT_SURFACE_PLANE_VIEW                  = 2,
1419 };
1420
1421
1422 /* *************************************************************** */
1423 /* Stats */
1424
1425 /* Stats for Meshes */
1426 typedef struct MeshStatVis {
1427         char type;
1428         char _pad1[2];
1429
1430         /* overhang */
1431         char  overhang_axis;
1432         float overhang_min, overhang_max;
1433
1434         /* thickness */
1435         float thickness_min, thickness_max;
1436         char thickness_samples;
1437         char _pad2[3];
1438
1439         /* distort */
1440         float distort_min, distort_max;
1441
1442         /* sharp */
1443         float sharp_min, sharp_max;
1444 } MeshStatVis;
1445
1446
1447 /* *************************************************************** */
1448 /* Tool Settings */
1449
1450 typedef struct ToolSettings {
1451         VPaint *vpaint;         /* vertex paint */
1452         VPaint *wpaint;         /* weight paint */
1453         Sculpt *sculpt;
1454         UvSculpt *uvsculpt;     /* uv smooth */
1455         
1456         /* Vertex group weight - used only for editmode, not weight
1457          * paint */
1458         float vgroup_weight;
1459
1460         float doublimit;        /* remove doubles limit */
1461         float normalsize;       /* size of normals */
1462         short automerge;
1463
1464         /* Selection Mode for Mesh */
1465         short selectmode;
1466
1467         /* UV Calculation */
1468         char unwrapper;
1469         char uvcalc_flag;
1470         char uv_flag;
1471         char uv_selectmode;
1472
1473         float uvcalc_margin;
1474
1475         /* Auto-IK */
1476         short autoik_chainlen;  /* runtime only */
1477
1478         /* Grease Pencil */
1479         char gpencil_flags;             /* flags/options for how the tool works */
1480         char gpencil_src;               /* for main 3D view Grease Pencil, where data comes from */
1481
1482         char gpencil_v3d_align; /* stroke placement settings: 3D View */
1483         char gpencil_v2d_align; /*                          : General 2D Editor */
1484         char gpencil_seq_align; /*                          : Sequencer Preview */
1485         char gpencil_ima_align; /*                          : Image Editor */
1486         
1487         /* Grease Pencil Sculpt */
1488         struct GP_BrushEdit_Settings gp_sculpt;
1489         
1490         /* Grease Pencil Interpolation Tool(s) */
1491         struct GP_Interpolate_Settings gp_interpolate;
1492         
1493         /* Grease Pencil Drawing Brushes (bGPDbrush) */
1494         ListBase gp_brushes; 
1495
1496         /* Image Paint (8 byttse aligned please!) */
1497         struct ImagePaintSettings imapaint;
1498
1499         /* Particle Editing */
1500         struct ParticleEditSettings particle;
1501         
1502         /* Transform Proportional Area of Effect */
1503         float proportional_size;
1504
1505         /* Select Group Threshold */
1506         float select_thresh;
1507
1508         /* Auto-Keying Mode */
1509         short autokey_mode, autokey_flag;       /* defines in DNA_userdef_types.h */
1510         char keyframe_type;                 /* keyframe type (see DNA_curve_types.h) */
1511
1512         /* Multires */
1513         char multires_subdiv_type;
1514
1515         /* Skeleton generation */
1516         short skgen_resolution;
1517         float skgen_threshold_internal;
1518         float skgen_threshold_external;
1519         float skgen_length_ratio;
1520         float skgen_length_limit;
1521         float skgen_angle_limit;
1522         float skgen_correlation_limit;
1523         float skgen_symmetry_limit;
1524         float skgen_retarget_angle_weight;
1525         float skgen_retarget_length_weight;
1526         float skgen_retarget_distance_weight;
1527         short skgen_options;
1528         char  skgen_postpro;
1529         char  skgen_postpro_passes;
1530         char  skgen_subdivisions[3];
1531         char  skgen_multi_level;
1532
1533         /* Skeleton Sketching */
1534         struct Object *skgen_template;
1535         char bone_sketching;
1536         char bone_sketching_convert;
1537         char skgen_subdivision_number;
1538         char skgen_retarget_options;
1539         char skgen_retarget_roll;
1540         char skgen_side_string[8];
1541         char skgen_num_string[8];
1542         
1543         /* Alt+RMB option */
1544         char edge_mode;
1545         char edge_mode_live_unwrap;
1546
1547         /* Transform */
1548         char snap_mode, snap_node_mode;
1549         char snap_uv_mode;
1550         short snap_flag, snap_target;
1551         short proportional, prop_mode;
1552         char proportional_objects; /* proportional edit, object mode */
1553         char proportional_mask; /* proportional edit, mask editing */
1554         char proportional_action; /* proportional edit, action editor */
1555         char proportional_fcurve; /* proportional edit, graph editor */
1556         char lock_markers; /* lock marker editing */
1557         char pad4[5];
1558
1559         char auto_normalize; /*auto normalizing mode in wpaint*/
1560         char multipaint; /* paint multiple bones in wpaint */
1561         char weightuser;
1562         char vgroupsubset; /* subset selection filter in wpaint */
1563
1564         /* UV painting */
1565         int use_uv_sculpt;
1566         int uv_sculpt_settings;
1567         int uv_sculpt_tool;
1568         int uv_relax_method;
1569         /* XXX: these sculpt_paint_* fields are deprecated, use the
1570          * unified_paint_settings field instead! */
1571         short sculpt_paint_settings DNA_DEPRECATED;     short pad5;
1572         int sculpt_paint_unified_size DNA_DEPRECATED;
1573         float sculpt_paint_unified_unprojected_radius DNA_DEPRECATED;
1574         float sculpt_paint_unified_alpha DNA_DEPRECATED;
1575
1576         /* Unified Paint Settings */
1577         struct UnifiedPaintSettings unified_paint_settings;
1578
1579         struct CurvePaintSettings curve_paint_settings;
1580
1581         struct MeshStatVis statvis;
1582 } ToolSettings;
1583
1584 /* *************************************************************** */
1585 /* Assorted Scene Data */
1586
1587 /* ------------------------------------------- */
1588 /* Stats (show in Info header) */
1589
1590 typedef struct bStats {
1591         /* scene totals for visible layers */
1592         int totobj, totlamp, totobjsel, totcurve, totmesh, totarmature;
1593         int totvert, totface;
1594 } bStats;
1595
1596 /* ------------------------------------------- */
1597 /* Unit Settings */
1598
1599 typedef struct UnitSettings {
1600         /* Display/Editing unit options for each scene */
1601         float scale_length; /* maybe have other unit conversions? */
1602         char system; /* imperial, metric etc */
1603         char system_rotation; /* not implemented as a proper unit system yet */
1604         short flag;
1605 } UnitSettings;
1606
1607 /* ------------------------------------------- */
1608 /* Global/Common Physics Settings */
1609
1610 typedef struct PhysicsSettings {
1611         float gravity[3];
1612         int flag, quick_cache_step, rt;
1613 } PhysicsSettings;
1614
1615 /* ------------------------------------------- */
1616 /* Safe Area options used in Camera View & VSE
1617  */
1618 typedef struct DisplaySafeAreas {
1619         /* each value represents the (x,y) margins as a multiplier.
1620          * 'center' in this context is just the name for a different kind of safe-area */
1621
1622         float title[2];         /* Title Safe */
1623         float action[2];        /* Image/Graphics Safe */
1624
1625         /* use for alternate aspect ratio */
1626         float title_center[2];
1627         float action_center[2];
1628 } DisplaySafeAreas;
1629
1630 /* *************************************************************** */
1631 /* Scene ID-Block */
1632
1633 typedef struct Scene {
1634         ID id;
1635         struct AnimData *adt;   /* animation data (must be immediately after id for utilities to use it) */ 
1636         
1637         struct Object *camera;
1638         struct World *world;
1639         
1640         struct Scene *set;
1641         
1642         ListBase base;
1643         struct Base *basact;            /* active base */
1644         struct Object *obedit;          /* name replaces old G.obedit */
1645         
1646         float cursor[3];                        /* 3d cursor location */
1647         char _pad[4];
1648         
1649         unsigned int lay;                       /* bitflags for layer visibility */
1650         int layact;             /* active layer */
1651         unsigned int lay_updated;       /* runtime flag, has layer ever been updated since load? */
1652         
1653         short flag;                                                             /* various settings */
1654         
1655         char use_nodes;
1656         char pad[1];
1657         
1658         struct bNodeTree *nodetree;
1659         
1660         struct Editing *ed;                                                             /* sequence editor data is allocated here */
1661         
1662         struct ToolSettings *toolsettings;              /* default allocated now */
1663         struct SceneStats *stats;                               /* default allocated now */
1664         struct DisplaySafeAreas safe_areas;
1665
1666         /* migrate or replace? depends on some internal things... */
1667         /* no, is on the right place (ton) */
1668         struct RenderData r;
1669         struct AudioData audio;
1670         
1671         ListBase markers;
1672         ListBase transform_spaces;
1673         
1674         void *sound_scene;
1675         void *playback_handle;
1676         void *sound_scrub_handle;
1677         void *speaker_handles;
1678         
1679         void *fps_info;                                 /* (runtime) info/cache used for presenting playback framerate info to the user */
1680         
1681         /* none of the dependency graph  vars is mean to be saved */
1682         struct Depsgraph *depsgraph;
1683         void *pad1;
1684         struct  DagForest *theDag;
1685         short dagflags;
1686         short pad3;
1687
1688         /* User-Defined KeyingSets */
1689         int active_keyingset;                   /* index of the active KeyingSet. first KeyingSet has index 1, 'none' active is 0, 'add new' is -1 */
1690         ListBase keyingsets;                    /* KeyingSets for this scene */
1691         
1692         /* Game Settings */
1693         struct GameFraming framing  DNA_DEPRECATED; // XXX  deprecated since 2.5
1694         struct GameData gm;
1695
1696         /* Units */
1697         struct UnitSettings unit;
1698         
1699         /* Grease Pencil */
1700         struct bGPdata *gpd;
1701
1702         /* Movie Tracking */
1703         struct MovieClip *clip;                 /* active movie clip */
1704
1705         /* Physics simulation settings */
1706         struct PhysicsSettings physics_settings;
1707
1708         uint64_t customdata_mask;       /* XXX. runtime flag for drawing, actually belongs in the window, only used by BKE_object_handle_update() */
1709         uint64_t customdata_mask_modal; /* XXX. same as above but for temp operator use (gl renders) */
1710
1711         /* Color Management */
1712         ColorManagedViewSettings view_settings;
1713         ColorManagedDisplaySettings display_settings;
1714         ColorManagedColorspaceSettings sequencer_colorspace_settings;
1715         
1716         /* RigidBody simulation world+settings */
1717         struct RigidBodyWorld *rigidbody_world;
1718
1719         struct PreviewImage *preview;
1720 } Scene;
1721
1722 /* **************** RENDERDATA ********************* */
1723
1724 /* RenderData.flag */
1725         /* use preview range */
1726 #define SCER_PRV_RANGE  (1<<0)
1727 #define SCER_LOCK_FRAME_SELECTION       (1<<1)
1728         /* show/use subframes (for checking motion blur) */
1729 #define SCER_SHOW_SUBFRAME      (1<<3)
1730
1731 /* RenderData.mode */
1732 #define R_OSA                   0x0001
1733 #define R_SHADOW                0x0002
1734 #define R_GAMMA                 0x0004
1735 #define R_ORTHO                 0x0008
1736 #define R_ENVMAP                0x0010
1737 #define R_EDGE                  0x0020
1738 #define R_FIELDS                0x0040
1739 #define R_FIELDSTILL    0x0080
1740 /*#define R_RADIO                       0x0100 */ /* deprecated */
1741 #define R_BORDER                0x0200
1742 #define R_PANORAMA              0x0400  /* deprecated as scene option, still used in renderer */
1743 #define R_CROP                  0x0800
1744                 /* Disable camera switching: runtime (DURIAN_CAMERA_SWITCH) */
1745 #define R_NO_CAMERA_SWITCH      0x1000
1746 #define R_ODDFIELD              0x2000
1747 #define R_MBLUR                 0x4000
1748                 /* unified was here */
1749 #define R_RAYTRACE      0x10000
1750                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
1751 #define R_GAUSS         0x20000
1752                 /* fbuf obsolete... */
1753 /*#define R_FBUF                        0x40000*/
1754                 /* threads obsolete... is there for old files, now use for autodetect threads */
1755 #define R_THREADS               0x80000
1756                 /* Use the same flag for autothreads */
1757 #define R_FIXED_THREADS         0x80000 
1758
1759 #define R_SPEED                         0x100000
1760 #define R_SSS                           0x200000
1761 #define R_NO_OVERWRITE          0x400000  /* skip existing files */
1762 #define R_TOUCH                         0x800000  /* touch files before rendering */
1763 #define R_SIMPLIFY                      0x1000000
1764 #define R_EDGE_FRS                      0x2000000 /* R_EDGE reserved for Freestyle */
1765 #define R_PERSISTENT_DATA       0x4000000 /* keep data around for re-render */
1766 #define R_USE_WS_SHADING        0x8000000 /* use world space interpretation of lighting data */
1767
1768 /* RenderData.seq_flag */
1769 enum {
1770         // R_SEQ_GL_PREV = (1 << 1),  // UNUSED, we just use setting from seq_prev_type now.
1771         // R_SEQ_GL_REND = (1 << 2),  // UNUSED, opengl render has its own operator now.
1772         R_SEQ_SOLID_TEX  = (1 << 3),
1773         R_SEQ_CAMERA_DOF = (1 << 4),
1774 };
1775
1776 /* RenderData.displaymode */
1777 #define R_OUTPUT_SCREEN 0
1778 #define R_OUTPUT_AREA   1
1779 #define R_OUTPUT_WINDOW 2
1780 #define R_OUTPUT_NONE   3
1781 /*#define R_OUTPUT_FORKED       4*/
1782
1783 /* RenderData.filtertype */
1784 #define R_FILTER_BOX    0
1785 #define R_FILTER_TENT   1
1786 #define R_FILTER_QUAD   2
1787 #define R_FILTER_CUBIC  3
1788 #define R_FILTER_CATROM 4
1789 #define R_FILTER_GAUSS  5
1790 #define R_FILTER_MITCH  6
1791 #define R_FILTER_FAST_GAUSS     7 /* note, this is only used for nodes at the moment */
1792
1793 /* RenderData.raytrace_structure */
1794 #define R_RAYSTRUCTURE_AUTO                             0
1795 #define R_RAYSTRUCTURE_OCTREE                   1
1796 #define R_RAYSTRUCTURE_BLIBVH                   2       /* removed */
1797 #define R_RAYSTRUCTURE_VBVH                             3
1798 #define R_RAYSTRUCTURE_SIMD_SVBVH               4       /* needs SIMD */
1799 #define R_RAYSTRUCTURE_SIMD_QBVH                5       /* needs SIMD */
1800
1801 /* RenderData.raytrace_options */
1802 #define R_RAYTRACE_USE_LOCAL_COORDS             0x0001
1803 #define R_RAYTRACE_USE_INSTANCES                0x0002
1804
1805 /* RenderData.scemode (int now) */
1806 #define R_DOSEQ                         0x0001
1807 #define R_BG_RENDER                     0x0002
1808                 /* passepartout is camera option now, keep this for backward compatibility */
1809 #define R_PASSEPARTOUT          0x0004
1810 #define R_BUTS_PREVIEW          0x0008
1811 #define R_EXTENSION                     0x0010
1812 #define R_MATNODE_PREVIEW       0x0020
1813 #define R_DOCOMP                        0x0040
1814 #define R_COMP_CROP                     0x0080
1815 #define R_FREE_IMAGE            0x0100
1816 #define R_SINGLE_LAYER          0x0200
1817 #define R_EXR_TILE_FILE         0x0400
1818 /* #define R_COMP_FREE                  0x0800 */
1819 #define R_NO_IMAGE_LOAD         0x1000
1820 #define R_NO_TEX                        0x2000
1821 #define R_NO_FRAME_UPDATE       0x4000
1822 #define R_FULL_SAMPLE           0x8000
1823 /* #define R_DEPRECATED         0x10000 */
1824 /* #define R_RECURS_PROTECTION  0x20000 */
1825 #define R_TEXNODE_PREVIEW       0x40000
1826 #define R_VIEWPORT_PREVIEW      0x80000
1827 #define R_EXR_CACHE_FILE        0x100000
1828 #define R_MULTIVIEW                     0x200000
1829
1830 /* RenderData.stamp */
1831 #define R_STAMP_TIME    0x0001
1832 #define R_STAMP_FRAME   0x0002
1833 #define R_STAMP_DATE    0x0004
1834 #define R_STAMP_CAMERA  0x0008
1835 #define R_STAMP_SCENE   0x0010
1836 #define R_STAMP_NOTE    0x0020
1837 #define R_STAMP_DRAW    0x0040 /* draw in the image */
1838 #define R_STAMP_MARKER  0x0080
1839 #define R_STAMP_FILENAME        0x0100
1840 #define R_STAMP_SEQSTRIP        0x0200
1841 #define R_STAMP_RENDERTIME      0x0400
1842 #define R_STAMP_CAMERALENS      0x0800
1843 #define R_STAMP_STRIPMETA       0x1000
1844 #define R_STAMP_MEMORY          0x2000
1845 #define R_STAMP_HIDE_LABELS     0x4000
1846 #define R_STAMP_FRAME_RANGE     0x8000
1847 #define R_STAMP_ALL (R_STAMP_TIME|R_STAMP_FRAME|R_STAMP_DATE|R_STAMP_CAMERA|R_STAMP_SCENE| \
1848                      R_STAMP_NOTE|R_STAMP_MARKER|R_STAMP_FILENAME|R_STAMP_SEQSTRIP|        \
1849                      R_STAMP_RENDERTIME|R_STAMP_CAMERALENS|R_STAMP_MEMORY|                 \
1850                      R_STAMP_HIDE_LABELS|R_STAMP_FRAME_RANGE)
1851
1852 /* RenderData.alphamode */
1853 #define R_ADDSKY                0
1854 #define R_ALPHAPREMUL   1
1855 /*#define R_ALPHAKEY            2*/ /* deprecated, shouldn't be used */
1856
1857 /* RenderData.color_mgt_flag */
1858 enum {
1859         R_COLOR_MANAGEMENT              = (1 << 0),  /* deprecated, should only be used in versioning code only */
1860         /*R_COLOR_MANAGEMENT_PREDIVIDE    = (1 << 1)*/  /* deprecated, shouldn't be used */
1861 };
1862
1863 #ifdef DNA_DEPRECATED
1864 /* RenderData.subimtype flag options for imtype */
1865 enum {
1866         R_OPENEXR_HALF  = 1,  /*deprecated*/
1867         R_OPENEXR_ZBUF  = 2,  /*deprecated*/
1868         R_PREVIEW_JPG   = 4,  /*deprecated*/
1869         R_CINEON_LOG    = 8,  /*deprecated*/
1870         R_TIFF_16BIT    = 16, /*deprecated*/
1871
1872         R_JPEG2K_12BIT                  =     32,  /* Jpeg2000 */                    /*deprecated*/
1873         R_JPEG2K_16BIT                  =     64,                                    /*deprecated*/
1874         R_JPEG2K_YCC                    =     128,  /* when disabled use RGB */      /*deprecated*/
1875         R_JPEG2K_CINE_PRESET    =     256,                                   /*deprecated*/
1876         R_JPEG2K_CINE_48FPS             =     512,                                   /*deprecated*/
1877 };
1878 #endif
1879
1880 /* bake_mode: same as RE_BAKE_xxx defines */
1881 /* RenderData.bake_flag */
1882 #define R_BAKE_CLEAR            1
1883 #define R_BAKE_OSA                      2
1884 #define R_BAKE_TO_ACTIVE        4
1885 #define R_BAKE_NORMALIZE        8
1886 #define R_BAKE_MULTIRES         16
1887 #define R_BAKE_LORES_MESH       32
1888 #define R_BAKE_VCOL                     64
1889 #define R_BAKE_USERSCALE        128
1890 #define R_BAKE_CAGE                     256
1891 #define R_BAKE_SPLIT_MAT        512
1892 #define R_BAKE_AUTO_NAME        1024
1893
1894 /* RenderData.bake_normal_space */
1895 #define R_BAKE_SPACE_CAMERA      0
1896 #define R_BAKE_SPACE_WORLD       1
1897 #define R_BAKE_SPACE_OBJECT      2
1898 #define R_BAKE_SPACE_TANGENT 3
1899
1900 /* RenderData.simplify_flag */
1901 #define R_SIMPLE_NO_TRIANGULATE         1
1902
1903 /* RenderData.line_thickness_mode */
1904 #define R_LINE_THICKNESS_ABSOLUTE 1
1905 #define R_LINE_THICKNESS_RELATIVE 2
1906
1907 /* sequencer seq_prev_type seq_rend_type */
1908
1909 /* RenderData.engine (scene.c) */
1910 extern const char *RE_engine_id_BLENDER_RENDER;
1911 extern const char *RE_engine_id_BLENDER_GAME;
1912 extern const char *RE_engine_id_CYCLES;
1913
1914 /* **************** SCENE ********************* */
1915
1916 /* note that much higher maxframes give imprecise sub-frames, see: T46859 */
1917 /* Current precision is 16 for the sub-frames closer to MAXFRAME. */
1918
1919 /* for general use */
1920 #define MAXFRAME        1048574
1921 #define MAXFRAMEF       1048574.0f
1922
1923 #define MINFRAME        0
1924 #define MINFRAMEF       0.0f
1925
1926 /* (minimum frame number for current-frame) */
1927 #define MINAFRAME       -1048574
1928 #define MINAFRAMEF      -1048574.0f
1929
1930 /* depricate this! */
1931 #define TESTBASE(v3d, base)  (                                                \
1932         ((base)->flag & SELECT) &&                                                \
1933         ((base)->lay & v3d->lay) &&                                               \
1934         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1935 #define TESTBASELIB(v3d, base)  (                                             \
1936         ((base)->flag & SELECT) &&                                                \
1937         ((base)->lay & v3d->lay) &&                                               \
1938         ((base)->object->id.lib == NULL) &&                                       \
1939         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1940 #define TESTBASELIB_BGMODE(v3d, scene, base)  (                               \
1941         ((base)->flag & SELECT) &&                                                \
1942         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1943         ((base)->object->id.lib == NULL) &&                                       \
1944         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1945 #define BASE_EDITABLE_BGMODE(v3d, scene, base)  (                             \
1946         ((base)->lay & (v3d ? v3d->lay : scene->lay)) &&                          \
1947         ((base)->object->id.lib == NULL) &&                                       \
1948         (((base)->object->restrictflag & OB_RESTRICT_VIEW) == 0))
1949 #define BASE_SELECTABLE(v3d, base)  (                                         \
1950         (base->lay & v3d->lay) &&                                                 \
1951         (base->object->restrictflag & (OB_RESTRICT_SELECT | OB_RESTRICT_VIEW)) == 0)
1952 #define BASE_VISIBLE(v3d, base)  (                                            \
1953         (base->lay & v3d->lay) &&                                                 \
1954         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1955 #define BASE_VISIBLE_BGMODE(v3d, scene, base)  (                              \
1956         (base->lay & (v3d ? v3d->lay : scene->lay)) &&                            \
1957         (base->object->restrictflag & OB_RESTRICT_VIEW) == 0)
1958
1959 #define FIRSTBASE               scene->base.first
1960 #define LASTBASE                scene->base.last
1961 #define BASACT                  (scene->basact)
1962 #define OBACT                   (BASACT ? BASACT->object: NULL)
1963
1964 #define V3D_CAMERA_LOCAL(v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : NULL)
1965 #define V3D_CAMERA_SCENE(scene, v3d) ((!(v3d)->scenelock && (v3d)->camera) ? (v3d)->camera : (scene)->camera)
1966
1967 #define CFRA            (scene->r.cfra)
1968 #define SUBFRA          (scene->r.subframe)
1969 #define SFRA            (scene->r.sfra)
1970 #define EFRA            (scene->r.efra)
1971 #define PRVRANGEON      (scene->r.flag & SCER_PRV_RANGE)
1972 #define PSFRA           ((PRVRANGEON) ? (scene->r.psfra) : (scene->r.sfra))
1973 #define PEFRA           ((PRVRANGEON) ? (scene->r.pefra) : (scene->r.efra))
1974 #define FRA2TIME(a)     ((((double) scene->r.frs_sec_base) * (double)(a)) / (double)scene->r.frs_sec)
1975 #define TIME2FRA(a)     ((((double) scene->r.frs_sec) * (double)(a)) / (double)scene->r.frs_sec_base)
1976 #define FPS              (((double) scene->r.frs_sec) / (double)scene->r.frs_sec_base)
1977
1978 /* Base.flag is in DNA_object_types.h */
1979
1980 /* ToolSettings.snap_flag */
1981 #define SCE_SNAP                                1
1982 #define SCE_SNAP_ROTATE                 2
1983 #define SCE_SNAP_PEEL_OBJECT    4
1984 #define SCE_SNAP_PROJECT                8
1985 #define SCE_SNAP_NO_SELF                16
1986 #define SCE_SNAP_ABS_GRID               32
1987
1988 /* ToolSettings.snap_target */
1989 #define SCE_SNAP_TARGET_CLOSEST 0
1990 #define SCE_SNAP_TARGET_CENTER  1
1991 #define SCE_SNAP_TARGET_MEDIAN  2
1992 #define SCE_SNAP_TARGET_ACTIVE  3
1993 /* ToolSettings.snap_mode */
1994 #define SCE_SNAP_MODE_INCREMENT 0
1995 #define SCE_SNAP_MODE_VERTEX    1
1996 #define SCE_SNAP_MODE_EDGE              2
1997 #define SCE_SNAP_MODE_FACE              3
1998 #define SCE_SNAP_MODE_VOLUME    4
1999 #define SCE_SNAP_MODE_NODE_X    5
2000 #define SCE_SNAP_MODE_NODE_Y    6
2001 #define SCE_SNAP_MODE_NODE_XY   7
2002 #define SCE_SNAP_MODE_GRID              8
2003
2004 /* ToolSettings.selectmode */
2005 #define SCE_SELECT_VERTEX       1 /* for mesh */
2006 #define SCE_SELECT_EDGE         2
2007 #define SCE_SELECT_FACE         4
2008
2009 /* MeshStatVis.type */
2010 #define SCE_STATVIS_OVERHANG    0
2011 #define SCE_STATVIS_THICKNESS   1
2012 #define SCE_STATVIS_INTERSECT   2
2013 #define SCE_STATVIS_DISTORT             3
2014 #define SCE_STATVIS_SHARP               4
2015
2016 /* ParticleEditSettings.selectmode for particles */
2017 #define SCE_SELECT_PATH         1
2018 #define SCE_SELECT_POINT        2
2019 #define SCE_SELECT_END          4
2020
2021 /* ToolSettings.prop_mode (proportional falloff) */
2022 #define PROP_SMOOTH            0
2023 #define PROP_SPHERE            1
2024 #define PROP_ROOT              2
2025 #define PROP_SHARP             3
2026 #define PROP_LIN               4
2027 #define PROP_CONST             5
2028 #define PROP_RANDOM            6
2029 #define PROP_INVSQUARE         7
2030 #define PROP_MODE_MAX          8
2031
2032 /* ToolSettings.proportional */
2033 #define PROP_EDIT_OFF                   0
2034 #define PROP_EDIT_ON                    1
2035 #define PROP_EDIT_CONNECTED             2
2036 #define PROP_EDIT_PROJECTED             3
2037
2038 /* ToolSettings.weightuser */
2039 enum {
2040         OB_DRAW_GROUPUSER_NONE      = 0,
2041         OB_DRAW_GROUPUSER_ACTIVE    = 1,
2042         OB_DRAW_GROUPUSER_ALL       = 2
2043 };
2044
2045 /* object_vgroup.c */
2046 /* ToolSettings.vgroupsubset */
2047 typedef enum eVGroupSelect {
2048         WT_VGROUP_ALL = 0,
2049         WT_VGROUP_ACTIVE = 1,
2050         WT_VGROUP_BONE_SELECT = 2,
2051         WT_VGROUP_BONE_DEFORM = 3,
2052         WT_VGROUP_BONE_DEFORM_OFF = 4
2053 } eVGroupSelect;
2054
2055 #define WT_VGROUP_MASK_ALL \
2056         ((1 << WT_VGROUP_ACTIVE) | \
2057          (1 << WT_VGROUP_BONE_SELECT) | \
2058          (1 << WT_VGROUP_BONE_DEFORM) | \
2059          (1 << WT_VGROUP_BONE_DEFORM_OFF) | \
2060          (1 << WT_VGROUP_ALL))
2061
2062
2063 /* Scene.flag */
2064 #define SCE_DS_SELECTED                 (1<<0)
2065 #define SCE_DS_COLLAPSED                (1<<1)
2066 #define SCE_NLA_EDIT_ON                 (1<<2)
2067 #define SCE_FRAME_DROP                  (1<<3)
2068 #define SCE_KEYS_NO_SELONLY         (1<<4)
2069
2070         /* return flag BKE_scene_base_iter_next functions */
2071 /* #define F_ERROR                      -1 */  /* UNUSED */
2072 #define F_START                 0
2073 #define F_SCENE                 1
2074 #define F_DUPLI                 3
2075
2076 /* AudioData.flag */
2077 #define AUDIO_MUTE                (1<<0)
2078 #define AUDIO_SYNC                (1<<1)
2079 #define AUDIO_SCRUB                       (1<<2)
2080 #define AUDIO_VOLUME_ANIMATED     (1<<3)
2081
2082 /* FFMpegCodecData.flags */
2083 enum {
2084 #ifdef DNA_DEPRECATED
2085         FFMPEG_MULTIPLEX_AUDIO  = 1,  /* deprecated, you can choose none as audiocodec now */
2086 #endif
2087         FFMPEG_AUTOSPLIT_OUTPUT = 2,
2088         FFMPEG_LOSSLESS_OUTPUT  = 4,
2089         FFMPEG_USE_MAX_B_FRAMES = (1 << 3),
2090 };
2091
2092 /* Paint.flags */
2093 typedef enum ePaintFlags {
2094         PAINT_SHOW_BRUSH = (1 << 0),
2095         PAINT_FAST_NAVIGATE = (1 << 1),
2096         PAINT_SHOW_BRUSH_ON_SURFACE = (1 << 2),
2097         PAINT_USE_CAVITY_MASK = (1 << 3)
2098 } ePaintFlags;
2099
2100 /* Paint.symmetry_flags
2101  * (for now just a duplicate of sculpt symmetry flags) */
2102 typedef enum ePaintSymmetryFlags {
2103         PAINT_SYMM_X = (1 << 0),
2104         PAINT_SYMM_Y = (1 << 1),
2105         PAINT_SYMM_Z = (1 << 2),
2106         PAINT_SYMMETRY_FEATHER = (1 << 3),
2107         PAINT_TILE_X = (1 << 4),
2108         PAINT_TILE_Y = (1 << 5),
2109         PAINT_TILE_Z = (1 << 6),
2110 } ePaintSymmetryFlags;
2111
2112 #define PAINT_SYMM_AXIS_ALL (PAINT_SYMM_X | PAINT_SYMM_Y | PAINT_SYMM_Z)
2113
2114 /* Sculpt.flags */
2115 /* These can eventually be moved to paint flags? */
2116 typedef enum eSculptFlags {
2117 #ifdef DNA_DEPRECATED
2118         /* deprecated, part of paint struct symmetry_flags now */
2119         SCULPT_SYMM_X = (1 << 0),
2120         SCULPT_SYMM_Y = (1 << 1),
2121         SCULPT_SYMM_Z = (1 << 2),
2122 #endif
2123
2124         SCULPT_LOCK_X = (1 << 3),
2125         SCULPT_LOCK_Y = (1 << 4),
2126         SCULPT_LOCK_Z = (1 << 5),
2127         /* deprecated, part of paint struct symmetry_flags now */
2128         SCULPT_SYMMETRY_FEATHER = (1 << 6),
2129
2130         SCULPT_USE_OPENMP = (1 << 7),
2131         SCULPT_ONLY_DEFORM = (1 << 8),
2132         SCULPT_SHOW_DIFFUSE = (1 << 9),
2133
2134         /* If set, the mesh will be drawn with smooth-shading in
2135          * dynamic-topology mode */
2136         SCULPT_DYNTOPO_SMOOTH_SHADING = (1 << 10),
2137
2138         /* If set, dynamic-topology brushes will subdivide short edges */
2139         SCULPT_DYNTOPO_SUBDIVIDE = (1 << 12),
2140         /* If set, dynamic-topology brushes will collapse short edges */
2141         SCULPT_DYNTOPO_COLLAPSE = (1 << 11),
2142
2143         /* If set, dynamic-topology detail size will be constant in object space */
2144         SCULPT_DYNTOPO_DETAIL_CONSTANT = (1 << 13),
2145         SCULPT_DYNTOPO_DETAIL_BRUSH = (1 << 14),
2146
2147         /* Don't display mask in viewport, but still use it for strokes. */
2148         SCULPT_HIDE_MASK = (1 << 15),
2149 } eSculptFlags;
2150
2151 /* ImagePaintSettings.mode */
2152 typedef enum eImagePaintMode {
2153         IMAGEPAINT_MODE_MATERIAL, /* detect texture paint slots from the material */
2154         IMAGEPAINT_MODE_IMAGE,    /* select texture paint image directly */
2155 } eImagePaintMode;
2156
2157 /* ImagePaintSettings.flag */
2158 #define IMAGEPAINT_DRAWING                              1
2159 // #define IMAGEPAINT_DRAW_TOOL                 2 // deprecated
2160 // #define IMAGEPAINT_DRAW_TOOL_DRAWING 4 // deprecated
2161
2162 /* projection painting only */
2163 /* ImagePaintSettings.flag */
2164 #define IMAGEPAINT_PROJECT_XRAY                 (1 << 4)
2165 #define IMAGEPAINT_PROJECT_BACKFACE             (1 << 5)
2166 #define IMAGEPAINT_PROJECT_FLAT                 (1 << 6)
2167 #define IMAGEPAINT_PROJECT_LAYER_CLONE  (1 << 7)
2168 #define IMAGEPAINT_PROJECT_LAYER_STENCIL        (1 << 8)
2169 #define IMAGEPAINT_PROJECT_LAYER_STENCIL_INV    (1 << 9)
2170
2171 /* ImagePaintSettings.missing_data */
2172 #define IMAGEPAINT_MISSING_UVS       (1 << 0)
2173 #define IMAGEPAINT_MISSING_MATERIAL  (1 << 1)
2174 #define IMAGEPAINT_MISSING_TEX       (1 << 2)
2175 #define IMAGEPAINT_MISSING_STENCIL   (1 << 3)
2176
2177 /* ToolSettings.uvcalc_flag */
2178 #define UVCALC_FILLHOLES                        1
2179 #define UVCALC_NO_ASPECT_CORRECT        2       /* would call this UVCALC_ASPECT_CORRECT, except it should be default with old file */
2180 #define UVCALC_TRANSFORM_CORRECT        4       /* adjust UV's while transforming to avoid distortion */
2181 #define UVCALC_USESUBSURF                       8       /* Use mesh data after subsurf to compute UVs*/
2182
2183 /* ToolSettings.uv_flag */
2184 #define UV_SYNC_SELECTION       1
2185 #define UV_SHOW_SAME_IMAGE      2
2186
2187 /* ToolSettings.uv_selectmode */
2188 #define UV_SELECT_VERTEX        1
2189 #define UV_SELECT_EDGE          2
2190 #define UV_SELECT_FACE          4
2191 #define UV_SELECT_ISLAND        8
2192
2193 /* ToolSettings.edge_mode */
2194 #define EDGE_MODE_SELECT                                0
2195 #define EDGE_MODE_TAG_SEAM                              1
2196 #define EDGE_MODE_TAG_SHARP                             2
2197 #define EDGE_MODE_TAG_CREASE                    3
2198 #define EDGE_MODE_TAG_BEVEL                             4
2199 #define EDGE_MODE_TAG_FREESTYLE                 5
2200
2201 /* ToolSettings.gpencil_flags */
2202 typedef enum eGPencil_Flags {
2203         /* "Continuous Drawing" - The drawing operator enters a mode where multiple strokes can be drawn */
2204         GP_TOOL_FLAG_PAINTSESSIONS_ON       = (1 << 0),
2205         /* When creating new frames, the last frame gets used as the basis for the new one */
2206         GP_TOOL_FLAG_RETAIN_LAST            = (1 << 1),
2207         /* Add the strokes below all strokes in the layer */
2208         GP_TOOL_FLAG_PAINT_ONBACK = (1 << 2)
2209 } eGPencil_Flags;
2210
2211 /* ToolSettings.gpencil_src */
2212 typedef enum eGPencil_Source_3D {
2213         GP_TOOL_SOURCE_SCENE    = 0,
2214         GP_TOOL_SOURCE_OBJECT   = 1
2215 } eGPencil_Source_3d;
2216
2217 /* ToolSettings.gpencil_*_align - Stroke Placement mode flags */
2218 typedef enum eGPencil_Placement_Flags {
2219         /* New strokes are added in viewport/data space (i.e. not screen space) */
2220         GP_PROJECT_VIEWSPACE    = (1 << 0),
2221         
2222         /* Viewport space, but relative to render canvas (Sequencer Preview Only) */
2223         GP_PROJECT_CANVAS       = (1 << 1),
2224         
2225         /* Project into the screen's Z values */
2226         GP_PROJECT_DEPTH_VIEW   = (1 << 2),
2227         GP_PROJECT_DEPTH_STROKE = (1 << 3),
2228         
2229         /* "Use Endpoints" */
2230         GP_PROJECT_DEPTH_STROKE_ENDPOINTS = (1 << 4),
2231 } eGPencil_Placement_Flags;
2232
2233 /* ToolSettings.particle flag */
2234 #define PE_KEEP_LENGTHS                 1
2235 #define PE_LOCK_FIRST                   2
2236 #define PE_DEFLECT_EMITTER              4
2237 #define PE_INTERPOLATE_ADDED    8
2238 #define PE_DRAW_PART                    16
2239 /* #define PE_X_MIRROR                  64 */   /* deprecated */
2240 #define PE_FADE_TIME                    128
2241 #define PE_AUTO_VELOCITY                256
2242
2243 /* ParticleEditSettings.brushtype */
2244 #define PE_BRUSH_NONE           -1
2245 #define PE_BRUSH_COMB           0
2246 #define PE_BRUSH_CUT            1
2247 #define PE_BRUSH_LENGTH         2
2248 #define PE_BRUSH_PUFF           3
2249 #define PE_BRUSH_ADD            4
2250 #define PE_BRUSH_SMOOTH         5
2251 #define PE_BRUSH_WEIGHT         6
2252
2253 /* ParticleBrushData.flag */
2254 #define PE_BRUSH_DATA_PUFF_VOLUME 1
2255
2256 /* ParticleBrushData.edittype */
2257 #define PE_TYPE_PARTICLES       0
2258 #define PE_TYPE_SOFTBODY        1
2259 #define PE_TYPE_CLOTH           2
2260
2261 /* ToolSettings.skgen_options */
2262 #define SKGEN_FILTER_INTERNAL   (1 << 0)
2263 #define SKGEN_FILTER_EXTERNAL   (1 << 1)
2264 #define SKGEN_SYMMETRY                  (1 << 2)
2265 #define SKGEN_CUT_LENGTH                (1 << 3)
2266 #define SKGEN_CUT_ANGLE                 (1 << 4)
2267 #define SKGEN_CUT_CORRELATION   (1 << 5)
2268 #define SKGEN_HARMONIC                  (1 << 6)
2269 #define SKGEN_STICK_TO_EMBEDDING        (1 << 7)
2270 #define SKGEN_ADAPTIVE_DISTANCE         (1 << 8)
2271 #define SKGEN_FILTER_SMART              (1 << 9)
2272 #define SKGEN_DISP_LENGTH               (1 << 10)
2273 #define SKGEN_DISP_WEIGHT               (1 << 11)
2274 #define SKGEN_DISP_ORIG                 (1 << 12)
2275 #define SKGEN_DISP_EMBED                (1 << 13)
2276 #define SKGEN_DISP_INDEX                (1 << 14)
2277
2278 #define SKGEN_SUB_LENGTH                0
2279 #define SKGEN_SUB_ANGLE                 1
2280 #define SKGEN_SUB_CORRELATION   2
2281 #define SKGEN_SUB_TOTAL                 3
2282
2283 /* ToolSettings.skgen_postpro */
2284 #define SKGEN_SMOOTH                    0
2285 #define SKGEN_AVERAGE                   1
2286 #define SKGEN_SHARPEN                   2
2287
2288 /* ToolSettings.bone_sketching */
2289 #define BONE_SKETCHING                  1
2290 #define BONE_SKETCHING_QUICK    2
2291 #define BONE_SKETCHING_ADJUST   4
2292
2293 /* ToolSettings.bone_sketching_convert */
2294 #define SK_CONVERT_CUT_FIXED                    0
2295 #define SK_CONVERT_CUT_LENGTH                   1
2296 #define SK_CONVERT_CUT_ADAPTATIVE               2
2297 #define SK_CONVERT_RETARGET                             3
2298
2299 /* ToolSettings.skgen_retarget_options */
2300 #define SK_RETARGET_AUTONAME                    1
2301
2302 /* ToolSettings.skgen_retarget_roll */
2303 #define SK_RETARGET_ROLL_NONE                   0
2304 #define SK_RETARGET_ROLL_VIEW                   1
2305 #define SK_RETARGET_ROLL_JOINT                  2
2306
2307 /* PhysicsSettings.flag */
2308 #define PHYS_GLOBAL_GRAVITY             1
2309
2310 /* UnitSettings */
2311
2312 /* UnitSettings.system */
2313 #define USER_UNIT_NONE                  0
2314 #define USER_UNIT_METRIC                1
2315 #define USER_UNIT_IMPERIAL              2
2316 /* UnitSettings.flag */
2317 #define USER_UNIT_OPT_SPLIT             1
2318 #define USER_UNIT_ROT_RADIANS   2
2319
2320 #ifdef __cplusplus
2321 }
2322 #endif
2323
2324 #endif  /* __DNA_SCENE_TYPES_H__ */