7db96c0759225fc3461f66687778ba760afe6508
[blender-staging.git] / source / blender / blenkernel / intern / scene.c
1 /*  scene.c
2  *  
3  * 
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  */
31
32 #include <stdio.h>
33 #include <string.h>
34
35 #ifdef HAVE_CONFIG_H
36 #include <config.h>
37 #endif
38
39 #ifndef WIN32 
40 #include <unistd.h>
41 #else
42 #include <io.h>
43 #endif
44 #include "MEM_guardedalloc.h"
45
46 #include "DNA_anim_types.h"
47 #include "DNA_armature_types.h" 
48 #include "DNA_color_types.h"
49 #include "DNA_constraint_types.h"
50 #include "DNA_curve_types.h"
51 #include "DNA_group_types.h"
52 #include "DNA_lamp_types.h"
53 #include "DNA_material_types.h"
54 #include "DNA_meta_types.h"
55 #include "DNA_object_types.h"
56 #include "DNA_scene_types.h"
57 #include "DNA_scriptlink_types.h"
58 #include "DNA_texture_types.h"
59 #include "DNA_userdef_types.h"
60
61 #include "BKE_action.h"                 
62 #include "BKE_anim.h"
63 #include "BKE_animsys.h"
64 #include "BKE_armature.h"               
65 #include "BKE_colortools.h"
66 #include "BKE_colortools.h"
67 #include "BKE_constraint.h"
68 #include "BKE_depsgraph.h"
69 #include "BKE_global.h"
70 #include "BKE_group.h"
71 #include "BKE_ipo.h"
72 #include "BKE_idprop.h"
73 #include "BKE_image.h"
74 #include "BKE_key.h"
75 #include "BKE_library.h"
76 #include "BKE_main.h"
77 #include "BKE_node.h"
78 #include "BKE_object.h"
79 #include "BKE_scene.h"
80 #include "BKE_sculpt.h"
81 #include "BKE_sequence.h"
82 #include "BKE_world.h"
83 #include "BKE_utildefines.h"
84
85 //XXX #include "BIF_previewrender.h"
86 //XXX #include "BIF_editseq.h"
87
88 #ifndef DISABLE_PYTHON
89 #include "BPY_extern.h"
90 #endif
91
92 #include "BLI_arithb.h"
93 #include "BLI_blenlib.h"
94
95 //XXX #include "nla.h"
96
97 #ifdef WIN32
98 #else
99 #include <sys/time.h>
100 #endif
101
102 void free_avicodecdata(AviCodecData *acd)
103 {
104         if (acd) {
105                 if (acd->lpFormat){
106                         MEM_freeN(acd->lpFormat);
107                         acd->lpFormat = NULL;
108                         acd->cbFormat = 0;
109                 }
110                 if (acd->lpParms){
111                         MEM_freeN(acd->lpParms);
112                         acd->lpParms = NULL;
113                         acd->cbParms = 0;
114                 }
115         }
116 }
117
118 void free_qtcodecdata(QuicktimeCodecData *qcd)
119 {
120         if (qcd) {
121                 if (qcd->cdParms){
122                         MEM_freeN(qcd->cdParms);
123                         qcd->cdParms = NULL;
124                         qcd->cdSize = 0;
125                 }
126         }
127 }
128
129 /* copy_scene moved to src/header_info.c... should be back */
130
131 /* do not free scene itself */
132 void free_scene(Scene *sce)
133 {
134         Base *base;
135
136         base= sce->base.first;
137         while(base) {
138                 base->object->id.us--;
139                 base= base->next;
140         }
141         /* do not free objects! */
142
143         BLI_freelistN(&sce->base);
144         seq_free_editing(sce->ed);
145         if(sce->radio) MEM_freeN(sce->radio);
146         sce->radio= 0;
147         
148 #ifndef DISABLE_PYTHON
149         BPY_free_scriptlink(&sce->scriptlink);
150 #endif
151
152         BKE_free_animdata((ID *)sce);
153         BKE_keyingsets_free(&sce->keyingsets);
154         
155         if (sce->r.avicodecdata) {
156                 free_avicodecdata(sce->r.avicodecdata);
157                 MEM_freeN(sce->r.avicodecdata);
158                 sce->r.avicodecdata = NULL;
159         }
160         if (sce->r.qtcodecdata) {
161                 free_qtcodecdata(sce->r.qtcodecdata);
162                 MEM_freeN(sce->r.qtcodecdata);
163                 sce->r.qtcodecdata = NULL;
164         }
165         if (sce->r.ffcodecdata.properties) {
166                 IDP_FreeProperty(sce->r.ffcodecdata.properties);
167                 MEM_freeN(sce->r.ffcodecdata.properties);
168                 sce->r.ffcodecdata.properties = NULL;
169         }
170         
171         BLI_freelistN(&sce->markers);
172         BLI_freelistN(&sce->transform_spaces);
173         BLI_freelistN(&sce->r.layers);
174         
175         if(sce->toolsettings) {
176                 if(sce->toolsettings->vpaint)
177                         MEM_freeN(sce->toolsettings->vpaint);
178                 if(sce->toolsettings->wpaint)
179                         MEM_freeN(sce->toolsettings->wpaint);
180                 if(sce->toolsettings->sculpt) {
181                         sculptsession_free(sce->toolsettings->sculpt);
182                         MEM_freeN(sce->toolsettings->sculpt);
183                 }
184                 
185                 MEM_freeN(sce->toolsettings);
186                 sce->toolsettings = NULL;       
187         }
188         
189         if (sce->theDag) {
190                 free_forest(sce->theDag);
191                 MEM_freeN(sce->theDag);
192         }
193         
194         if(sce->nodetree) {
195                 ntreeFreeTree(sce->nodetree);
196                 MEM_freeN(sce->nodetree);
197         }
198 }
199
200 Scene *add_scene(char *name)
201 {
202         Scene *sce;
203         ParticleEditSettings *pset;
204         int a;
205
206         sce= alloc_libblock(&G.main->scene, ID_SCE, name);
207         sce->lay= 1;
208         sce->selectmode= SCE_SELECT_VERTEX;
209         sce->editbutsize= 0.1;
210         sce->autokey_mode= U.autokey_mode;
211         
212         sce->r.mode= R_GAMMA;
213         sce->r.cfra= 1;
214         sce->r.sfra= 1;
215         sce->r.efra= 250;
216         sce->r.xsch= 320;
217         sce->r.ysch= 256;
218         sce->r.xasp= 1;
219         sce->r.yasp= 1;
220         sce->r.xparts= 4;
221         sce->r.yparts= 4;
222         sce->r.size= 100;
223         sce->r.planes= 24;
224         sce->r.quality= 90;
225         sce->r.framapto= 100;
226         sce->r.images= 100;
227         sce->r.framelen= 1.0;
228         sce->r.frs_sec= 25;
229         sce->r.frs_sec_base= 1;
230         sce->r.ocres = 128;
231         
232         sce->r.bake_mode= 1;    /* prevent to include render stuff here */
233         sce->r.bake_filter= 2;
234         sce->r.bake_osa= 5;
235         sce->r.bake_flag= R_BAKE_CLEAR;
236         sce->r.bake_normal_space= R_BAKE_SPACE_TANGENT;
237         
238         sce->r.xplay= 640;
239         sce->r.yplay= 480;
240         sce->r.freqplay= 60;
241         sce->r.depth= 32;
242         
243         sce->r.threads= 1;
244         
245         sce->r.stereomode = 1;  // no stereo
246
247         sce->r.simplify_subsurf= 6;
248         sce->r.simplify_particles= 1.0f;
249         sce->r.simplify_shadowsamples= 16;
250         sce->r.simplify_aosss= 1.0f;
251
252         sce->r.cineonblack= 95;
253         sce->r.cineonwhite= 685;
254         sce->r.cineongamma= 1.7f;
255         
256         sce->toolsettings = MEM_callocN(sizeof(struct ToolSettings),"Tool Settings Struct");
257         sce->toolsettings->cornertype=1;
258         sce->toolsettings->degr = 90; 
259         sce->toolsettings->step = 9;
260         sce->toolsettings->turn = 1;                            
261         sce->toolsettings->extr_offs = 1; 
262         sce->toolsettings->doublimit = 0.001;
263         sce->toolsettings->segments = 32;
264         sce->toolsettings->rings = 32;
265         sce->toolsettings->vertices = 32;
266         sce->toolsettings->editbutflag = 1;
267         sce->toolsettings->uvcalc_radius = 1.0f;
268         sce->toolsettings->uvcalc_cubesize = 1.0f;
269         sce->toolsettings->uvcalc_mapdir = 1;
270         sce->toolsettings->uvcalc_mapalign = 1;
271         sce->toolsettings->unwrapper = 1;
272         sce->toolsettings->select_thresh= 0.01f;
273         sce->toolsettings->jointrilimit = 0.8f;
274
275         sce->toolsettings->skgen_resolution = 100;
276         sce->toolsettings->skgen_threshold_internal     = 0.01f;
277         sce->toolsettings->skgen_threshold_external     = 0.01f;
278         sce->toolsettings->skgen_angle_limit                    = 45.0f;
279         sce->toolsettings->skgen_length_ratio                   = 1.3f;
280         sce->toolsettings->skgen_length_limit                   = 1.5f;
281         sce->toolsettings->skgen_correlation_limit              = 0.98f;
282         sce->toolsettings->skgen_symmetry_limit                 = 0.1f;
283         sce->toolsettings->skgen_postpro = SKGEN_SMOOTH;
284         sce->toolsettings->skgen_postpro_passes = 1;
285         sce->toolsettings->skgen_options = SKGEN_FILTER_INTERNAL|SKGEN_FILTER_EXTERNAL|SKGEN_FILTER_SMART|SKGEN_HARMONIC|SKGEN_SUB_CORRELATION|SKGEN_STICK_TO_EMBEDDING;
286         sce->toolsettings->skgen_subdivisions[0] = SKGEN_SUB_CORRELATION;
287         sce->toolsettings->skgen_subdivisions[1] = SKGEN_SUB_LENGTH;
288         sce->toolsettings->skgen_subdivisions[2] = SKGEN_SUB_ANGLE;
289
290         pset= &sce->toolsettings->particle;
291         pset->flag= PE_KEEP_LENGTHS|PE_LOCK_FIRST|PE_DEFLECT_EMITTER;
292         pset->emitterdist= 0.25f;
293         pset->totrekey= 5;
294         pset->totaddkey= 5;
295         pset->brushtype= PE_BRUSH_NONE;
296         for(a=0; a<PE_TOT_BRUSH; a++) {
297                 pset->brush[a].strength= 50;
298                 pset->brush[a].size= 50;
299                 pset->brush[a].step= 10;
300         }
301         pset->brush[PE_BRUSH_CUT].strength= 100;
302         
303         sce->jumpframe = 10;
304         sce->audio.mixrate = 44100;
305
306         strcpy(sce->r.backbuf, "//backbuf");
307         strcpy(sce->r.pic, U.renderdir);
308
309         BLI_init_rctf(&sce->r.safety, 0.1f, 0.9f, 0.1f, 0.9f);
310         sce->r.osa= 8;
311
312         /* note; in header_info.c the scene copy happens..., if you add more to renderdata it has to be checked there */
313         scene_add_render_layer(sce);
314         
315         return sce;
316 }
317
318 Base *object_in_scene(Object *ob, Scene *sce)
319 {
320         Base *base;
321         
322         base= sce->base.first;
323         while(base) {
324                 if(base->object == ob) return base;
325                 base= base->next;
326         }
327         return NULL;
328 }
329
330 void set_scene_bg(Scene *scene)
331 {
332         Scene *sce;
333         Base *base;
334         Object *ob;
335         Group *group;
336         GroupObject *go;
337         int flag;
338         
339         /* check for cyclic sets, for reading old files but also for definite security (py?) */
340         scene_check_setscene(scene);
341         
342         /* deselect objects (for dataselect) */
343         for(ob= G.main->object.first; ob; ob= ob->id.next)
344                 ob->flag &= ~(SELECT|OB_FROMGROUP);
345
346         /* group flags again */
347         for(group= G.main->group.first; group; group= group->id.next) {
348                 go= group->gobject.first;
349                 while(go) {
350                         if(go->ob) go->ob->flag |= OB_FROMGROUP;
351                         go= go->next;
352                 }
353         }
354
355         /* sort baselist */
356         DAG_scene_sort(scene);
357         
358         /* ensure dags are built for sets */
359         for(sce= scene->set; sce; sce= sce->set)
360                 if(sce->theDag==NULL)
361                         DAG_scene_sort(sce);
362
363         /* copy layers and flags from bases to objects */
364         for(base= scene->base.first; base; base= base->next) {
365                 ob= base->object;
366                 ob->lay= base->lay;
367                 
368                 /* group patch... */
369                 base->flag &= ~(OB_FROMGROUP);
370                 flag= ob->flag & (OB_FROMGROUP);
371                 base->flag |= flag;
372                 
373                 /* not too nice... for recovering objects with lost data */
374                 if(ob->pose==NULL) base->flag &= ~OB_POSEMODE;
375                 ob->flag= base->flag;
376                 
377                 ob->ctime= -1234567.0;  /* force ipo to be calculated later */
378         }
379         /* no full animation update, this to enable render code to work (render code calls own animation updates) */
380         
381         /* do we need FRAMECHANGED in set_scene? */
382 //      if (G.f & G_DOSCRIPTLINKS) BPY_do_all_scripts(SCRIPT_FRAMECHANGED, 0);
383 }
384
385 /* called from creator.c */
386 void set_scene_name(char *name)
387 {
388         Scene *sce;
389
390         for (sce= G.main->scene.first; sce; sce= sce->id.next) {
391                 if (BLI_streq(name, sce->id.name+2)) {
392                         set_scene_bg(sce);
393                         return;
394                 }
395         }
396         
397         //XXX error("Can't find scene: %s", name);
398 }
399
400 /* used by metaballs
401  * doesnt return the original duplicated object, only dupli's
402  */
403 int next_object(Scene *scene, int val, Base **base, Object **ob)
404 {
405         static ListBase *duplilist= NULL;
406         static DupliObject *dupob;
407         static int fase;
408         int run_again=1;
409         
410         /* init */
411         if(val==0) {
412                 fase= F_START;
413                 dupob= NULL;
414         }
415         else {
416
417                 /* run_again is set when a duplilist has been ended */
418                 while(run_again) {
419                         run_again= 0;
420
421                         /* the first base */
422                         if(fase==F_START) {
423                                 *base= scene->base.first;
424                                 if(*base) {
425                                         *ob= (*base)->object;
426                                         fase= F_SCENE;
427                                 }
428                                 else {
429                                     /* exception: empty scene */
430                                         if(scene->set && scene->set->base.first) {
431                                                 *base= scene->set->base.first;
432                                                 *ob= (*base)->object;
433                                                 fase= F_SET;
434                                         }
435                                 }
436                         }
437                         else {
438                                 if(*base && fase!=F_DUPLI) {
439                                         *base= (*base)->next;
440                                         if(*base) *ob= (*base)->object;
441                                         else {
442                                                 if(fase==F_SCENE) {
443                                                         /* scene is finished, now do the set */
444                                                         if(scene->set && scene->set->base.first) {
445                                                                 *base= scene->set->base.first;
446                                                                 *ob= (*base)->object;
447                                                                 fase= F_SET;
448                                                         }
449                                                 }
450                                         }
451                                 }
452                         }
453                         
454                         if(*base == NULL) fase= F_START;
455                         else {
456                                 if(fase!=F_DUPLI) {
457                                         if( (*base)->object->transflag & OB_DUPLI) {
458                                                 /* groups cannot be duplicated for mballs yet, 
459                                                 this enters eternal loop because of 
460                                                 makeDispListMBall getting called inside of group_duplilist */
461                                                 if((*base)->object->dup_group == NULL) {
462                                                         duplilist= object_duplilist(scene, (*base)->object);
463                                                         
464                                                         dupob= duplilist->first;
465
466                                                         if(!dupob)
467                                                                 free_object_duplilist(duplilist);
468                                                 }
469                                         }
470                                 }
471                                 /* handle dupli's */
472                                 if(dupob) {
473                                         
474                                         Mat4CpyMat4(dupob->ob->obmat, dupob->mat);
475                                         
476                                         (*base)->flag |= OB_FROMDUPLI;
477                                         *ob= dupob->ob;
478                                         fase= F_DUPLI;
479                                         
480                                         dupob= dupob->next;
481                                 }
482                                 else if(fase==F_DUPLI) {
483                                         fase= F_SCENE;
484                                         (*base)->flag &= ~OB_FROMDUPLI;
485                                         
486                                         for(dupob= duplilist->first; dupob; dupob= dupob->next) {
487                                                 Mat4CpyMat4(dupob->ob->obmat, dupob->omat);
488                                         }
489                                         
490                                         free_object_duplilist(duplilist);
491                                         duplilist= NULL;
492                                         run_again= 1;
493                                 }
494                         }
495                 }
496         }
497         
498         return fase;
499 }
500
501 Object *scene_find_camera(Scene *sc)
502 {
503         Base *base;
504         
505         for (base= sc->base.first; base; base= base->next)
506                 if (base->object->type==OB_CAMERA)
507                         return base->object;
508
509         return NULL;
510 }
511
512
513 Base *scene_add_base(Scene *sce, Object *ob)
514 {
515         Base *b= MEM_callocN(sizeof(*b), "scene_add_base");
516         BLI_addhead(&sce->base, b);
517
518         b->object= ob;
519         b->flag= ob->flag;
520         b->lay= ob->lay;
521
522         return b;
523 }
524
525 void scene_deselect_all(Scene *sce)
526 {
527         Base *b;
528
529         for (b= sce->base.first; b; b= b->next) {
530                 b->flag&= ~SELECT;
531                 b->object->flag= b->flag;
532         }
533 }
534
535 void scene_select_base(Scene *sce, Base *selbase)
536 {
537         scene_deselect_all(sce);
538
539         selbase->flag |= SELECT;
540         selbase->object->flag= selbase->flag;
541
542         sce->basact= selbase;
543 }
544
545 /* checks for cycle, returns 1 if it's all OK */
546 int scene_check_setscene(Scene *sce)
547 {
548         Scene *scene;
549         int a, totscene;
550         
551         if(sce->set==NULL) return 1;
552         
553         totscene= 0;
554         for(scene= G.main->scene.first; scene; scene= scene->id.next)
555                 totscene++;
556         
557         for(a=0, scene=sce; scene->set; scene=scene->set, a++) {
558                 /* more iterations than scenes means we have a cycle */
559                 if(a > totscene) {
560                         /* the tested scene gets zero'ed, that's typically current scene */
561                         sce->set= NULL;
562                         return 0;
563                 }
564         }
565
566         return 1;
567 }
568
569 /* This (evil) function is needed to cope with two legacy Blender rendering features
570 * mblur (motion blur that renders 'subframes' and blurs them together), and fields 
571 * rendering. Thus, the use of ugly globals from object.c
572 */
573 // BAD... EVIL... JUJU...!!!!
574 // XXX moved here temporarily
575 float frame_to_float (Scene *scene, int cfra)           /* see also bsystem_time in object.c */
576 {
577         extern float bluroffs;  /* bad stuff borrowed from object.c */
578         extern float fieldoffs;
579         float ctime;
580         
581         ctime= (float)cfra;
582         ctime+= bluroffs+fieldoffs;
583         ctime*= scene->r.framelen;
584         
585         return ctime;
586 }
587
588 static void scene_update(Scene *sce, unsigned int lay)
589 {
590         Base *base;
591         Object *ob;
592         float ctime = frame_to_float(sce, sce->r.cfra); 
593         
594         if(sce->theDag==NULL)
595                 DAG_scene_sort(sce);
596         
597         DAG_scene_update_flags(sce, lay);   // only stuff that moves or needs display still
598         
599         /* All 'standard' (i.e. without any dependencies) animation is handled here,
600                 * with an 'local' to 'macro' order of evaluation. This should ensure that
601                 * settings stored nestled within a hierarchy (i.e. settings in a Texture block
602             * can be overridden by settings from Scene, which owns the Texture through a hierarchy 
603             * such as Scene->World->MTex/Texture) can still get correctly overridden.
604                 */
605         BKE_animsys_evaluate_all_animation(G.main, ctime);
606         
607         for(base= sce->base.first; base; base= base->next) {
608                 ob= base->object;
609                 
610                 object_handle_update(sce, ob);   // bke_object.h
611                 
612                 /* only update layer when an ipo */
613                         // XXX old animation system
614                 //if(ob->ipo && has_ipo_code(ob->ipo, OB_LAY) ) {
615                 //      base->lay= ob->lay;
616                 //}
617         }
618 }
619
620
621 /* applies changes right away, does all sets too */
622 void scene_update_for_newframe(Scene *sce, unsigned int lay)
623 {
624         Scene *scene= sce;
625         
626         /* clear animation overrides */
627         // XXX TODO...
628         
629 #ifndef DISABLE_PYTHON
630         if (G.f & G_DOSCRIPTLINKS) BPY_do_all_scripts(SCRIPT_FRAMECHANGED, 0);
631 #endif
632         /* sets first, we allow per definition current scene to have dependencies on sets */
633         for(sce= sce->set; sce; sce= sce->set)
634                 scene_update(sce, lay);
635
636         scene_update(scene, lay);
637 }
638
639 /* return default layer, also used to patch old files */
640 void scene_add_render_layer(Scene *sce)
641 {
642         SceneRenderLayer *srl;
643         int tot= 1 + BLI_countlist(&sce->r.layers);
644         
645         srl= MEM_callocN(sizeof(SceneRenderLayer), "new render layer");
646         sprintf(srl->name, "%d RenderLayer", tot);
647         BLI_addtail(&sce->r.layers, srl);
648
649         /* note, this is also in render, pipeline.c, to make layer when scenedata doesnt have it */
650         srl->lay= (1<<20) -1;
651         srl->layflag= 0x7FFF;   /* solid ztra halo edge strand */
652         srl->passflag= SCE_PASS_COMBINED|SCE_PASS_Z;
653 }
654
655 void sculptsession_free(Sculpt *sculpt)
656 {
657         SculptSession *ss= sculpt->session;
658         if(ss) {
659                 if(ss->projverts)
660                         MEM_freeN(ss->projverts);
661
662                 if(ss->fmap)
663                         MEM_freeN(ss->fmap);
664
665                 if(ss->fmap_mem)
666                         MEM_freeN(ss->fmap_mem);
667
668                 if(ss->texcache)
669                         MEM_freeN(ss->texcache);
670                 MEM_freeN(ss);
671                 sculpt->session= NULL;
672         }
673 }
674
675 /* render simplification */
676
677 int get_render_subsurf_level(RenderData *r, int lvl)
678 {
679         if(G.rt == 1 && (r->mode & R_SIMPLIFY))
680                 return MIN2(r->simplify_subsurf, lvl);
681         else
682                 return lvl;
683 }
684
685 int get_render_child_particle_number(RenderData *r, int num)
686 {
687         if(G.rt == 1 && (r->mode & R_SIMPLIFY))
688                 return (int)(r->simplify_particles*num);
689         else
690                 return num;
691 }
692
693 int get_render_shadow_samples(RenderData *r, int samples)
694 {
695         if(G.rt == 1 && (r->mode & R_SIMPLIFY) && samples > 0)
696                 return MIN2(r->simplify_shadowsamples, samples);
697         else
698                 return samples;
699 }
700
701 float get_render_aosss_error(RenderData *r, float error)
702 {
703         if(G.rt == 1 && (r->mode & R_SIMPLIFY))
704                 return ((1.0f-r->simplify_aosss)*10.0f + 1.0f)*error;
705         else
706                 return error;
707 }
708