Image Stamping patch by Diego (and peach request)- stamps image info into metadata...
[blender.git] / source / blender / makesdna / DNA_scene_types.h
1 /**
2  * $Id$ 
3  *
4  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  */
32 #ifndef DNA_SCENE_TYPES_H
33 #define DNA_SCENE_TYPES_H
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 #include "DNA_vec_types.h"
40 #include "DNA_listBase.h"
41 #include "DNA_scriptlink_types.h"
42 #include "DNA_ID.h"
43 #include "DNA_scriptlink_types.h"
44
45 struct Radio;
46 struct Object;
47 struct World;
48 struct Scene;
49 struct Image;
50 struct Group;
51 struct bNodeTree;
52
53 typedef struct Base {
54         struct Base *next, *prev;
55         unsigned int lay, selcol;
56         int flag;
57         short sx, sy;
58         struct Object *object;
59 } Base;
60
61 typedef struct AviCodecData {
62         void                    *lpFormat;  /* save format */
63         void                    *lpParms;   /* compressor options */
64         unsigned int    cbFormat;           /* size of lpFormat buffer */
65         unsigned int    cbParms;            /* size of lpParms buffer */
66
67         unsigned int    fccType;            /* stream type, for consistency */
68         unsigned int    fccHandler;         /* compressor */
69         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
70         unsigned int    dwQuality;          /* compress quality 0-10,000 */
71         unsigned int    dwBytesPerSecond;   /* bytes per second */
72         unsigned int    dwFlags;            /* flags... see below */
73         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
74         unsigned int    pad;
75
76         char                    avicodecname[128];
77 } AviCodecData;
78
79 typedef struct QuicktimeCodecData {
80
81         void                    *cdParms;   /* codec/compressor options */
82         void                    *pad;       /* padding */
83
84         unsigned int    cdSize;             /* size of cdParms buffer */
85         unsigned int    pad2;               /* padding */
86
87         char                    qtcodecname[128];
88 } QuicktimeCodecData;
89
90 typedef struct FFMpegCodecData {
91         int type;
92         int codec;
93         int audio_codec;
94         int video_bitrate;
95         int audio_bitrate;
96         int gop_size;
97         int flags;
98
99         int rc_min_rate;
100         int rc_max_rate;
101         int rc_buffer_size;
102         int mux_packet_size;
103         int mux_rate;
104 } FFMpegCodecData;
105
106
107 typedef struct AudioData {
108         int mixrate;
109         float main;             /* Main mix in dB */
110         short flag;
111         short pad[3];
112 } AudioData;
113
114 typedef struct SceneRenderLayer {
115         struct SceneRenderLayer *next, *prev;
116         
117         char name[32];
118         
119         struct Material *mat_override;
120         struct Group *light_override;
121         
122         unsigned int lay;               /* scene->lay itself has priority over this */
123         int layflag;
124         int passflag;                   /* pass_xor has to be after passflag */
125         int pass_xor;
126 } SceneRenderLayer;
127
128 /* srl->layflag */
129 #define SCE_LAY_SOLID   1
130 #define SCE_LAY_ZTRA    2
131 #define SCE_LAY_HALO    4
132 #define SCE_LAY_EDGE    8
133 #define SCE_LAY_SKY             16
134 #define SCE_LAY_STRAND  32
135         /* flags between 32 and 0x8000 are set to 1 already, for future options */
136
137 #define SCE_LAY_ALL_Z   0x8000
138 #define SCE_LAY_XOR             0x10000
139 #define SCE_LAY_DISABLE 0x20000
140
141 /* srl->passflag */
142 #define SCE_PASS_COMBINED       1
143 #define SCE_PASS_Z                      2
144 #define SCE_PASS_RGBA           4
145 #define SCE_PASS_DIFFUSE        8
146 #define SCE_PASS_SPEC           16
147 #define SCE_PASS_SHADOW         32
148 #define SCE_PASS_AO                     64
149 #define SCE_PASS_REFLECT        128
150 #define SCE_PASS_NORMAL         256
151 #define SCE_PASS_VECTOR         512
152 #define SCE_PASS_REFRACT        1024
153 #define SCE_PASS_INDEXOB        2048
154 #define SCE_PASS_UV                     4096
155 #define SCE_PASS_RADIO          8192
156 /* note, srl->passflag is treestore element 'nr' in outliner, short still... */
157
158
159 typedef struct RenderData {
160         
161         struct AviCodecData *avicodecdata;
162         struct QuicktimeCodecData *qtcodecdata;
163         struct FFMpegCodecData ffcodecdata;
164
165         int cfra, sfra, efra;   /* frames as in 'images' */
166         int psfra, pefra;               /* start+end frames of preview range */
167
168         int images, framapto;
169         short flag, threads;
170
171         float ctime;                    /* use for calcutions */
172         float framelen, blurfac;
173
174         /** For UR edge rendering: give the edges this color */
175         float edgeR, edgeG, edgeB;
176         
177         short fullscreen, xplay, yplay, freqplay;       /* standalone player */
178         short depth, attrib, rt1, rt2;                  /* standalone player */
179
180         short stereomode;       /* standalone player stereo settings */
181         
182         short dimensionspreset;         /* for the dimensions presets menu */
183         
184         short filtertype;       /* filter is box, tent, gauss, mitch, etc */
185
186         short size, maximsize;  /* size in %, max in Kb */
187         /* from buttons: */
188         /**
189          * The desired number of pixels in the x direction
190          */
191         short xsch;
192         /**
193          * The desired number of pixels in the y direction
194          */
195         short ysch;
196         /**
197          * Adjustment factors for the aspect ratio in the x direction
198          */
199         short xasp;
200         /**
201          * Adjustment factors for the aspect ratio in the x direction
202          */
203         short yasp;
204         /**
205          * The number of part to use in the x direction
206          */
207         short xparts;
208         /**
209          * The number of part to use in the y direction
210          */
211         short yparts;
212         
213         short winpos, planes, imtype, subimtype;
214         
215         /** Mode bits:                                                           */
216         /* 0: Enable backbuffering for images                                    */
217         short bufflag;
218         short quality;
219         
220         /**
221          * Flags for render settings. Use bit-masking to access the settings.
222          */
223         short scemode;
224
225         /**
226          * Flags for render settings. Use bit-masking to access the settings.
227          */
228         int mode;
229
230         /* render engine, octree resolution */
231         short renderer, ocres, rpad[2];
232
233         /**
234          * What to do with the sky/background. Picks sky/premul/key
235          * blending for the background
236          */
237         short alphamode;
238
239         /**
240          * The number of samples to use per pixel.
241          */
242         short osa;
243         
244         short frs_sec, edgeint;
245
246         /* safety, border and display rect */
247         rctf safety, border;
248         rcti disprect;
249         
250         /* information on different layers to be rendered */
251         ListBase layers;
252         short actlay, pad;
253         int pad2;
254         
255         /**
256          * Value used to define filter size for all filter options  */
257         float gauss;
258         
259         /** post-production settings. Depricated, but here for upwards compat (initialized to 1) */      
260         float postmul, postgamma, posthue, postsat;      
261         
262         /* Dither noise intensity */
263         float dither_intensity;
264         
265         /* Bake Render options */
266         short bake_osa, bake_filter, bake_mode, bake_flag;
267         
268         /* yafray: global panel params. TODO: move elsewhere */
269         short GIquality, GIcache, GImethod, GIphotons, GIdirect;
270         short YF_AA, YFexportxml, YF_nobump, YF_clamprgb, yfpad1;
271         int GIdepth, GIcausdepth, GIpixelspersample;
272         int GIphotoncount, GImixphotons;
273         float GIphotonradius;
274         int YF_numprocs, YF_raydepth, YF_AApasses, YF_AAsamples;
275         float GIshadowquality, GIrefinement, GIpower, GIindirpower;
276         float YF_gamma, YF_exposure, YF_raybias, YF_AApixelsize, YF_AAthreshold;
277
278         /* paths to backbufffer, output, ftype */
279         char backbuf[160], pic[160], ftype[160];
280
281         /* stamps flags. */
282         int stamp;
283         short stamp_font_id, pad3; /* select one of blenders bitmap fonts */
284
285         /* stamp info user data. */
286         char stamp_udata[160];
287
288         /* foreground/background color. */
289         float fg_stamp[4];
290         float bg_stamp[4];
291 } RenderData;
292
293
294 typedef struct GameFraming {
295         float col[3];
296         char type, pad1, pad2, pad3;
297 } GameFraming;
298
299 #define SCE_GAMEFRAMING_BARS   0
300 #define SCE_GAMEFRAMING_EXTEND 1
301 #define SCE_GAMEFRAMING_SCALE  2
302
303 typedef struct TimeMarker {
304         struct TimeMarker *next, *prev;
305         int frame;
306         char name[64];
307         unsigned int flag;
308 } TimeMarker;
309
310 struct ImagePaintSettings {
311         struct Brush *brush;
312         short flag, tool;
313         int pad3;
314 };
315
316 typedef struct ToolSettings {
317         /* Subdivide Settings */
318         short cornertype;
319         short editbutflag;
320         /*Triangle to Quad conversion threshold*/
321         float jointrilimit;
322         /* Extrude Tools */
323         float degr; 
324         short step;
325         short turn; 
326         
327         float extr_offs; 
328         float doublimit;
329         
330         /* Primitive Settings */
331         /* UV Sphere */
332         short segments;
333         short rings;
334         
335         /* Cylinder - Tube - Circle */
336         short vertices;
337
338         /* UV Calculation */
339         short unwrapper;
340         float uvcalc_radius;
341         float uvcalc_cubesize;
342         short uvcalc_mapdir;
343         short uvcalc_mapalign;
344         short uvcalc_flag;
345
346         short pad2;
347         
348         /* Image Paint (8 byte aligned please!) */
349         struct ImagePaintSettings imapaint;
350         
351         /* Select Group Threshold */
352         float select_thresh;
353         
354         /* IPO-Editor */
355         float clean_thresh;
356         
357         /* Retopo */
358         char retopo_mode;
359         char retopo_paint_tool;
360         char line_div, ellipse_div, retopo_hotspot;
361
362         /* Multires */
363         char multires_subdiv_type;
364         
365         char  pad4[2];
366 } ToolSettings;
367
368 /* Used by all brushes to store their properties, which can be directly set
369    by the interface code. Note that not all properties are actually used by
370    all the brushes. */
371 typedef struct BrushData
372 {
373         short size;
374         char strength, dir; /* Not used for smooth brush */
375         char airbrush;
376         char view;
377         char pad[2];
378 } BrushData;
379
380 struct SculptSession;
381 typedef struct SculptData
382 {
383         /* Data stored only from entering sculptmode until exiting sculptmode */
384         struct SculptSession *session;
385
386         /* Pointers to all of sculptmodes's textures */
387         struct MTex *mtex[10];
388
389         /* Settings for each brush */
390         BrushData drawbrush, smoothbrush, pinchbrush, inflatebrush, grabbrush, layerbrush, flattenbrush;
391         short brush_type;
392
393         /* For the Brush Shape */
394         short texact, texnr;
395         short spacing;
396         char texrept;
397         char texfade;
398         char texsep;
399
400         char averaging;
401         char flags;
402         
403         /* Control tablet input */
404         char tablet_size, tablet_strength;
405         
406         /* Symmetry is separate from the other BrushData because the same
407            settings are always used for all brush types */
408         char symm;
409 } SculptData;
410
411 typedef struct Scene {
412         ID id;
413         struct Object *camera;
414         struct World *world;
415         
416         struct Scene *set;
417         struct Image *ima;
418         
419         ListBase base;
420         struct Base *basact;
421         
422         float cursor[3];
423         float twcent[3];                        /* center for transform widget */
424         float twmin[3], twmax[3];       /* boundbox of selection for transform widget */
425         unsigned int lay;
426         
427         /* editmode stuff */
428         float editbutsize;                      /* size of normals */
429         short selectmode;
430         short proportional, prop_mode;
431         short automerge, pad5, pad6, pad7;
432         
433         short use_nodes;
434         
435         struct bNodeTree *nodetree;     
436         
437         void *ed;                                                               /* sequence editor data is allocated here */
438         struct Radio *radio;
439         
440         struct GameFraming framing;
441
442         struct ToolSettings *toolsettings;
443
444         /* migrate or replace? depends on some internal things... */
445         /* no, is on the right place (ton) */
446         struct RenderData r;
447         struct AudioData audio; 
448         
449         ScriptLink scriptlink;
450         
451         ListBase markers;
452         
453         short jumpframe, pad1;
454         short snap_flag, snap_target;
455         
456         /* none of the dependancy graph  vars is mean to be saved */
457         struct  DagForest *theDag;
458         short dagisvalid, dagflags;
459         short pad4, recalc;                             /* recalc = counterpart of ob->recalc */
460
461         /* Sculptmode data */
462         struct SculptData sculptdata;
463 } Scene;
464
465
466 /* **************** RENDERDATA ********************* */
467
468 /* bufflag */
469 #define R_BACKBUF               1
470 #define R_BACKBUFANIM   2
471 #define R_FRONTBUF              4
472 #define R_FRONTBUFANIM  8
473
474 /* mode (int now) */
475 #define R_OSA                   0x0001
476 #define R_SHADOW                0x0002
477 #define R_GAMMA                 0x0004
478 #define R_ORTHO                 0x0008
479 #define R_ENVMAP                0x0010
480 #define R_EDGE                  0x0020
481 #define R_FIELDS                0x0040
482 #define R_FIELDSTILL    0x0080
483 #define R_RADIO                 0x0100
484 #define R_BORDER                0x0200
485 #define R_PANORAMA              0x0400
486 #define R_CROP                  0x0800
487 #define R_COSMO                 0x1000
488 #define R_ODDFIELD              0x2000
489 #define R_MBLUR                 0x4000
490                 /* unified was here */
491 #define R_RAYTRACE      0x10000
492                 /* R_GAUSS is obsolete, but used to retrieve setting from old files */
493 #define R_GAUSS         0x20000
494                 /* fbuf obsolete... */
495 #define R_FBUF                  0x40000
496                 /* threads obsolete... is there for old files */
497 #define R_THREADS               0x80000
498 #define R_SPEED                 0x100000
499 #define R_SSS                   0x200000
500
501 /* filtertype */
502 #define R_FILTER_BOX    0
503 #define R_FILTER_TENT   1
504 #define R_FILTER_QUAD   2
505 #define R_FILTER_CUBIC  3
506 #define R_FILTER_CATROM 4
507 #define R_FILTER_GAUSS  5
508 #define R_FILTER_MITCH  6
509
510 /* yafray: renderer flag (not only exclusive to yafray) */
511 #define R_INTERN        0
512 #define R_YAFRAY        1
513
514 /* scemode */
515 #define R_DOSEQ                         0x0001
516 #define R_BG_RENDER                     0x0002
517                 /* passepartout is camera option now, keep this for backward compatibility */
518 #define R_PASSEPARTOUT          0x0004
519 #define R_PREVIEWBUTS           0x0008
520 #define R_EXTENSION                     0x0010
521 #define R_NODE_PREVIEW          0x0020
522 #define R_DOCOMP                        0x0040
523 #define R_COMP_CROP                     0x0080
524 #define R_FREE_IMAGE            0x0100
525 #define R_SINGLE_LAYER          0x0200
526 #define R_EXR_TILE_FILE         0x0400
527 #define R_COMP_FREE                     0x0800
528 #define R_NO_IMAGE_LOAD         0x1000
529 #define R_NO_TEX                0x2000
530 #define R_STAMP_INFO            0x4000
531
532 /* r->stamp */
533 #define R_STAMP_TIME    0x0001
534 #define R_STAMP_FRAME   0x0002
535 #define R_STAMP_DATE    0x0004
536 #define R_STAMP_CAMERA  0x0008
537 #define R_STAMP_SCENE   0x0010
538 #define R_STAMP_NOTE    0x0020
539 #define R_STAMP_DRAW    0x0040 /* draw in the image */
540 #define R_STAMP_MARKER  0x0080
541
542 /* alphamode */
543 #define R_ADDSKY                0
544 #define R_ALPHAPREMUL   1
545 #define R_ALPHAKEY              2
546
547 /* planes */
548 #define R_PLANES24              24
549 #define R_PLANES32              32
550 #define R_PLANESBW              8
551
552 /* imtype */
553 #define R_TARGA         0
554 #define R_IRIS          1
555 #define R_HAMX          2
556 #define R_FTYPE         3
557 #define R_JPEG90        4
558 #define R_MOVIE         5
559 #define R_IRIZ          7
560 #define R_RAWTGA        14
561 #define R_AVIRAW        15
562 #define R_AVIJPEG       16
563 #define R_PNG           17
564 #define R_AVICODEC      18
565 #define R_QUICKTIME 19
566 #define R_BMP           20
567 #define R_RADHDR        21
568 #define R_TIFF          22
569 #define R_OPENEXR       23
570 #define R_FFMPEG        24
571 #define R_FRAMESERVER   25
572 #define R_CINEON                26
573 #define R_DPX                   27
574 #define R_MULTILAYER    28
575 #define R_DDS                   29
576
577 /* subimtype, flag options for imtype */
578 #define R_OPENEXR_HALF  1
579 #define R_OPENEXR_ZBUF  2
580 #define R_PREVIEW_JPG   4
581
582 /* bake_mode: same as RE_BAKE_xxx defines */
583 /* bake_flag: */
584 #define R_BAKE_CLEAR    1
585 #define R_BAKE_OSA              2
586
587 /* **************** SCENE ********************* */
588 #define RAD_PHASE_PATCHES       1
589 #define RAD_PHASE_FACES         2
590
591 /* base->flag is in DNA_object_types.h */
592
593 /* scene->snap_flag */
594 #define SCE_SNAP                                1
595 /* scene->snap_target */
596 #define SCE_SNAP_TARGET_CLOSEST 0
597 #define SCE_SNAP_TARGET_CENTER  1
598 #define SCE_SNAP_TARGET_MEDIAN  2
599
600 /* sce->selectmode */
601 #define SCE_SELECT_VERTEX       1
602 #define SCE_SELECT_EDGE         2
603 #define SCE_SELECT_FACE         4
604
605 /* sce->recalc (now in use by previewrender) */
606 #define SCE_PRV_CHANGED         1
607
608 /* sce->prop_mode (proportional falloff) */
609 #define PROP_SMOOTH            0
610 #define PROP_SPHERE            1
611 #define PROP_ROOT              2
612 #define PROP_SHARP             3
613 #define PROP_LIN               4
614 #define PROP_CONST             5
615 #define PROP_RANDOM             6
616
617         /* return flag next_object function */
618 #define F_START                 0
619 #define F_SCENE                 1
620 #define F_SET                   2
621 #define F_DUPLI                 3
622
623 /* audio->flag */
624 #define AUDIO_MUTE              1
625 #define AUDIO_SYNC              2
626 #define AUDIO_SCRUB             4
627
628 #define FFMPEG_MULTIPLEX_AUDIO  1
629 #define FFMPEG_AUTOSPLIT_OUTPUT 2
630
631 /* SculptData.flags */
632 #define SCULPT_INPUT_SMOOTH 1
633 #define SCULPT_DRAW_FAST    2
634 #define SCULPT_DRAW_BRUSH   4
635 /* SculptData.brushtype */
636 #define DRAW_BRUSH    1
637 #define SMOOTH_BRUSH  2
638 #define PINCH_BRUSH   3
639 #define INFLATE_BRUSH 4
640 #define GRAB_BRUSH    5
641 #define LAYER_BRUSH   6
642 #define FLATTEN_BRUSH 7
643 /* SculptData.texrept */
644 #define SCULPTREPT_DRAG 1
645 #define SCULPTREPT_TILE 2
646 #define SCULPTREPT_3D   3
647
648 #define SYMM_X 1
649 #define SYMM_Y 2
650 #define SYMM_Z 4
651
652 /* toolsettings->imagepaint_flag */
653 #define IMAGEPAINT_DRAWING                              1
654 #define IMAGEPAINT_DRAW_TOOL                    2
655 #define IMAGEPAINT_DRAW_TOOL_DRAWING    4
656
657 /* toolsettings->retopo_mode */
658 #define RETOPO 1
659 #define RETOPO_PAINT 2
660
661 /* toolsettings->retopo_paint_tool */
662 #define RETOPO_PEN 1
663 #define RETOPO_LINE 2
664 #define RETOPO_ELLIPSE 4
665
666 #ifdef __cplusplus
667 }
668 #endif
669
670 #endif