Updated Quicktime code so settings can be stored in the blendfile.
[blender.git] / source / blender / makesdna / DNA_scene_types.h
1 /**
2  * blenlib/DNA_scene_types.h (mar-2001 nzc)
3  *
4  * Renderrecipe and scene decription. The fact that there is a
5  * hierarchy here is a bit strange, and not desirable.
6  *
7  * $Id$ 
8  *
9  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version. The Blender
15  * Foundation also sells licenses for use in proprietary software under
16  * the Blender License.  See http://www.blender.org/BL/ for information
17  * about this.
18  *
19  * This program is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
22  * GNU General Public License for more details.
23  *
24  * You should have received a copy of the GNU General Public License
25  * along with this program; if not, write to the Free Software Foundation,
26  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
27  *
28  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
29  * All rights reserved.
30  *
31  * The Original Code is: all of this file.
32  *
33  * Contributor(s): none yet.
34  *
35  * ***** END GPL/BL DUAL LICENSE BLOCK *****
36  */
37 #ifndef DNA_SCENE_TYPES_H
38 #define DNA_SCENE_TYPES_H
39
40 #ifdef __cplusplus
41 extern "C" {
42 #endif
43
44 #include "DNA_vec_types.h"
45 #include "DNA_listBase.h"
46 #include "DNA_scriptlink_types.h"
47 #include "DNA_ID.h"
48 #include "DNA_scriptlink_types.h"
49
50 struct FreeCamera;
51 struct Radio;
52 struct Object;
53 struct World;
54 struct Scene;
55 struct Image;
56 struct Group;
57
58 typedef struct Base {
59         struct Base *next, *prev;
60         unsigned int lay, selcol;
61         int flag;
62         short sx, sy;
63         struct Object *object;
64 } Base;
65
66 typedef struct AviCodecData {
67         void                    *lpFormat;                      /* save format */
68         void                    *lpParms;                       /* compressor options */
69         unsigned int    cbFormat;                       /* size of lpFormat buffer */
70         unsigned int    cbParms;                        /* size of lpParms buffer */
71
72         unsigned int    fccType;            /* stream type, for consistency */
73         unsigned int    fccHandler;         /* compressor */
74         unsigned int    dwKeyFrameEvery;    /* keyframe rate */
75         unsigned int    dwQuality;          /* compress quality 0-10,000 */
76         unsigned int    dwBytesPerSecond;   /* bytes per second */
77         unsigned int    dwFlags;            /* flags... see below */
78         unsigned int    dwInterleaveEvery;  /* for non-video streams only */
79         unsigned int    pad;
80
81         char                    avicodecname[128];
82 } AviCodecData;
83
84 typedef struct QuicktimeCodecData {
85
86         void                    *cdParms;                       /* codec/compressor options */
87         void                    *pad;                           /* padding */
88
89         unsigned int    cdSize;                         /* size of cdParms buffer */
90         unsigned int    pad2;                           /* padding */
91
92         char                    qtcodecname[128];
93 } QuicktimeCodecData;
94
95
96 typedef struct RenderData {
97         struct AviCodecData *avicodecdata;
98         struct QuicktimeCodecData *qtcodecdata;
99         
100         short cfra, sfra, efra; /* fames as in 'images' */
101         short images, framapto, flag;
102         float ctime;                    /* use for calcutions */
103         float framelen, blurfac;
104
105         /** For UR edge rendering: give the edges this colour */
106         float edgeR, edgeG, edgeB;
107         
108         short fullscreen, xplay, yplay, freqplay;       /* standalone player */
109         short depth, attrib, rt1, rt2;                          /* standalone player */
110
111         short stereomode;                                       /* standalone player stereo settings */
112         short pad[3];
113
114         short size, maximsize;  /* size in %, max in Kb */
115         /* from buttons: */
116         /**
117          * The desired number of pixels in the x direction
118          */
119         short xsch;
120         /**
121          * The desired number of pixels in the y direction
122          */
123         short ysch;
124         /**
125          * Adjustment factors for the aspect ratio in the x direction
126          */
127         short xasp;
128         /**
129          * Adjustment factors for the aspect ratio in the x direction
130          */
131         short yasp;
132         /**
133          * The number of part to use in the x direction
134          */
135         short xparts;
136         /**
137          * The number of part to use in the y direction
138          */
139         short yparts;
140         /* should rewrite this I think... */
141         rctf safety, border;
142         
143         short winpos, planes, imtype;
144         /** Mode bits:                                                           */
145         /* 0: Enable backbuffering for images                                    */
146         short bufflag;
147         short quality;
148         /**
149          * Flags for render settings. Use bit-masking to access the settings.
150          * 0: enable sequence output rendering                                   
151          * 1: render daemon                                                      
152          * 4: add extensions to filenames
153          */
154         short scemode;
155
156         /**
157          * Flags for render settings. Use bit-masking to access the settings.
158          * The bits have these meanings:
159          * 0: do oversampling                                                    
160          * 1: do shadows                                                         
161          * 2: do gamma correction                                                
162          * 3: ortho (not used?)                                                  
163          * 4: trace (not used?)                                                  
164          * 5: edge shading                                                       
165          * 6: field rendering                                                    
166          * 7: Disables time difference in field calculations                     
167          * 8: Gauss ? is this for sampling?                                      
168          * 9: borders                                                            
169          * 10: panorama                                                          
170          * 11: crop                                                              
171          * 12: save SGI movies with Cosmo hardware (????)                        
172          * 13: odd field first rendering                                         
173          * 14: motion blur                                                       
174          * 15: use unified renderer for this pic!                                
175          */
176         short mode;
177
178         /**
179          * What to do with the sky/background. Picks sky/premul/key
180          * blending for the background
181          */
182         short alphamode;
183         /**
184          * Toggles whether to apply a gamma correction for subpixel to
185          * pixel blending
186          */
187         short dogamma;
188         /**
189          * The number of samples to use per pixel.
190          */
191         short osa;
192         short frs_sec, edgeint;
193
194         /** For unified renderer: reduce intensity on boundaries with
195          * identical materials with this number.*/
196         short same_mat_redux, pad_3[3];
197         
198         /**
199          * The gamma for the normal rendering. Used when doing
200          * oversampling, to correctly blend subpixels to pixels.  */
201         float gamma;
202         /** post-production settings. Don't really belong here */
203         float postmul, postgamma, postadd, postigamma;
204         
205         char backbuf[160], pic[160], ftype[160];
206         
207 } RenderData;
208
209
210 typedef struct GameFraming {
211         float col[3];
212         char type, pad1, pad2, pad3;
213 } GameFraming;
214
215 #define SCE_GAMEFRAMING_BARS   0
216 #define SCE_GAMEFRAMING_EXTEND 1
217 #define SCE_GAMEFRAMING_SCALE  2
218
219 typedef struct Scene {
220         ID id;
221         struct Object *camera;
222         struct World *world;
223         
224         struct Scene *set;
225         struct Image *ima;
226         
227         ListBase base;
228         struct Base *basact;
229         struct Group *group;
230         
231         float cursor[3];
232         unsigned int lay;
233
234         /* some realtime vars */
235         struct FreeCamera *fcam;  /* old, can be removed (ton) */
236         
237         void *ed;
238         struct Radio *radio;
239         void *sumohandle;
240         
241         struct GameFraming framing;
242
243         /* migrate or replace? depends on some internal things... */
244         /* no, is on the right place (ton) */
245         struct RenderData r;
246         
247         ScriptLink scriptlink;
248 } Scene;
249
250
251 /* **************** RENDERDATA ********************* */
252
253 /* bufflag */
254 #define R_BACKBUF               1
255 #define R_BACKBUFANIM   2
256 #define R_FRONTBUF              4
257 #define R_FRONTBUFANIM  8
258
259 /* mode */
260 #define R_OSA                   0x0001  
261 #define R_SHADOW                0x0002  
262 #define R_GAMMA                 0x0004
263 #define R_ORTHO                 0x0008
264 #define R_TRACE                 0x0010
265 #define R_EDGE                  0x0020
266 #define R_FIELDS                0x0040
267 #define R_FIELDSTILL    0x0080
268 #define R_GAUSS                 0x0100
269 #define R_BORDER                0x0200
270 #define R_PANORAMA              0x0400
271 #define R_MOVIECROP             0x0800
272 #define R_COSMO                 0x1000
273 /* these difines were different between IrisGL and OpenGL!!! */
274 #define R_ODDFIELD              0x2000
275 #define R_MBLUR                 0x4000
276 #define R_UNIFIED       0x8000
277
278 /* scemode */
279 #define R_DOSEQ                 0x0001
280 #define R_BG_RENDER             0x0002
281
282 #define R_EXTENSION             0x0010
283 #define R_OGL                   0x0020
284
285 /* alphamode */
286 #define R_ADDSKY                0
287 #define R_ALPHAPREMUL   1
288 #define R_ALPHAKEY              2
289
290 /* planes */
291 #define R_PLANES24              24
292 #define R_PLANES32              32
293 #define R_PLANESBW              8
294
295 /* imtype */
296 #define R_TARGA         0
297 #define R_IRIS          1
298 #define R_HAMX          2
299 #define R_FTYPE         3
300 #define R_JPEG90        4
301 #define R_MOVIE         5
302 #define R_IRIZ          7
303 #define R_RAWTGA        14
304 #define R_AVIRAW        15
305 #define R_AVIJPEG       16
306 #define R_PNG           17
307 #define R_AVICODEC      18
308 #define R_QUICKTIME 19
309
310
311 /* **************** RENDER ********************* */
312 /* mode flag is same as for renderdata */
313 /* flag */
314 #define R_ZTRA                  1
315 #define R_HALO                  2
316 #define R_SEC_FIELD             4
317 #define R_LAMPHALO              8
318 #define R_RENDERING             16
319 #define R_ANIMRENDER    32
320
321 /* vlakren->flag (vlak = face in dutch) */
322 #define R_SMOOTH                1
323 #define R_VISIBLE               2
324 #define R_NOPUNOFLIP    8
325 #define R_CMAPCODE              16
326 #define R_FACE_SPLIT    32
327
328 /* vertren->texofs (texcoordinate offset relative to vertren->orco */
329 #define R_UVOFS3        1
330
331 /* **************** SCENE ********************* */
332 #define RAD_PHASE_PATCHES       1
333 #define RAD_PHASE_FACES         2
334
335 /* base->flag and ob->flag */
336 #define BA_WASSEL                       2
337 #define BA_PARSEL                       4
338 #define BA_WHERE_UPDATE         8
339 #define BA_DISP_UPDATE          16
340 #define BA_DO_IPO                       32
341 #define BA_FROMSET                      128
342 #define OB_DO_IMAT                      256
343 #define OB_FROMDUPLI            512
344 #define OB_DONE                         1024
345 #define OB_RADIO                        2048
346 #define OB_FROMGROUP            4096
347
348 /* sce->flag */
349 #define SCE_ADDSCENAME          1
350
351 /* return flag next_object function */
352 #define F_START                 0
353 #define F_SCENE                 1
354 #define F_SET                   2
355 #define F_DUPLI                 3
356
357 #ifdef __cplusplus
358 }
359 #endif
360
361 #endif
362