2 * Copyright 2011, Blender Foundation.
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.
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.
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.
28 #include "integrator.h"
36 #include "subd_mesh.h"
37 #include "subd_patch.h"
38 #include "subd_split.h"
40 #include "util_debug.h"
41 #include "util_foreach.h"
42 #include "util_path.h"
43 #include "util_transform.h"
46 #include "cycles_xml.h"
50 /* XML reading state */
53 Scene *scene; /* scene pointer */
54 Transform tfm; /* current transform state */
55 bool smooth; /* smooth normal state */
56 int shader; /* current shader */
57 string base; /* base path to current file*/
58 float dicing_rate; /* current dicing rate */
59 Mesh::DisplacementMethod displacement_method;
62 /* Attribute Reading */
64 static bool xml_read_bool(bool *value, pugi::xml_node node, const char *name)
66 pugi::xml_attribute attr = node.attribute(name);
69 *value = (string_iequals(attr.value(), "true")) || (atoi(attr.value()) != 0);
76 static bool xml_read_int(int *value, pugi::xml_node node, const char *name)
78 pugi::xml_attribute attr = node.attribute(name);
81 *value = atoi(attr.value());
88 static bool xml_read_int_array(vector<int>& value, pugi::xml_node node, const char *name)
90 pugi::xml_attribute attr = node.attribute(name);
93 vector<string> tokens;
94 string_split(tokens, attr.value());
96 foreach(const string& token, tokens)
97 value.push_back(atoi(token.c_str()));
105 static bool xml_read_float(float *value, pugi::xml_node node, const char *name)
107 pugi::xml_attribute attr = node.attribute(name);
110 *value = atof(attr.value());
117 static bool xml_read_float_array(vector<float>& value, pugi::xml_node node, const char *name)
119 pugi::xml_attribute attr = node.attribute(name);
122 vector<string> tokens;
123 string_split(tokens, attr.value());
125 foreach(const string& token, tokens)
126 value.push_back(atof(token.c_str()));
134 static bool xml_read_float3(float3 *value, pugi::xml_node node, const char *name)
138 if(xml_read_float_array(array, node, name) && array.size() == 3) {
139 *value = make_float3(array[0], array[1], array[2]);
146 static bool xml_read_float3_array(vector<float3>& value, pugi::xml_node node, const char *name)
150 if(xml_read_float_array(array, node, name)) {
151 for(size_t i = 0; i < array.size(); i += 3)
152 value.push_back(make_float3(array[i+0], array[i+1], array[i+2]));
160 static bool xml_read_float4(float4 *value, pugi::xml_node node, const char *name)
164 if(xml_read_float_array(array, node, name) && array.size() == 4) {
165 *value = make_float4(array[0], array[1], array[2], array[3]);
172 static bool xml_read_string(string *str, pugi::xml_node node, const char *name)
174 pugi::xml_attribute attr = node.attribute(name);
184 static bool xml_read_ustring(ustring *str, pugi::xml_node node, const char *name)
186 pugi::xml_attribute attr = node.attribute(name);
189 *str = ustring(attr.value());
196 static bool xml_equal_string(pugi::xml_node node, const char *name, const char *value)
198 pugi::xml_attribute attr = node.attribute(name);
201 return string_iequals(attr.value(), value);
206 static bool xml_read_enum(ustring *str, ShaderEnum& enm, pugi::xml_node node, const char *name)
208 pugi::xml_attribute attr = node.attribute(name);
211 ustring ustr(attr.value());
213 if(enm.exists(ustr)) {
218 fprintf(stderr, "Unknown value \"%s\" for attribute \"%s\".\n", ustr.c_str(), name);
226 static void xml_read_film(const XMLReadState& state, pugi::xml_node node)
228 Camera *cam = state.scene->camera;
230 xml_read_int(&cam->width, node, "width");
231 xml_read_int(&cam->height, node, "height");
233 float aspect = (float)cam->width/(float)cam->height;
235 if(cam->width >= cam->height) {
244 cam->bottom = -1.0f/aspect;
245 cam->top = 1.0f/aspect;
248 cam->need_update = true;
254 static void xml_read_integrator(const XMLReadState& state, pugi::xml_node node)
256 Integrator *integrator = state.scene->integrator;
258 xml_read_int(&integrator->min_bounce, node, "min_bounce");
259 xml_read_int(&integrator->max_bounce, node, "max_bounce");
260 xml_read_bool(&integrator->no_caustics, node, "no_caustics");
261 xml_read_float(&integrator->blur_caustics, node, "blur_caustics");
266 static void xml_read_camera(const XMLReadState& state, pugi::xml_node node)
268 Camera *cam = state.scene->camera;
270 if(xml_read_float(&cam->fov, node, "fov"))
271 cam->fov *= M_PI/180.0f;
273 xml_read_float(&cam->nearclip, node, "nearclip");
274 xml_read_float(&cam->farclip, node, "farclip");
275 xml_read_float(&cam->aperturesize, node, "aperturesize"); // 0.5*focallength/fstop
276 xml_read_float(&cam->focaldistance, node, "focaldistance");
277 xml_read_float(&cam->shutteropen, node, "shutteropen");
278 xml_read_float(&cam->shutterclose, node, "shutterclose");
280 if(xml_equal_string(node, "type", "orthographic"))
282 else if(xml_equal_string(node, "type", "perspective"))
285 cam->matrix = state.tfm;
287 cam->need_update = true;
293 static string xml_socket_name(const char *name)
298 while((i = sname.find(" ")) != string::npos)
299 sname.replace(i, 1, "");
304 static void xml_read_shader_graph(const XMLReadState& state, Shader *shader, pugi::xml_node graph_node)
306 ShaderGraph *graph = new ShaderGraph();
308 map<string, ShaderNode*> nodemap;
310 nodemap["output"] = graph->output();
312 for(pugi::xml_node node = graph_node.first_child(); node; node = node.next_sibling()) {
313 ShaderNode *snode = NULL;
315 if(string_iequals(node.name(), "image_texture")) {
316 ImageTextureNode *img = new ImageTextureNode();
318 xml_read_string(&img->filename, node, "src");
319 img->filename = path_join(state.base, img->filename);
323 else if(string_iequals(node.name(), "environment_texture")) {
324 EnvironmentTextureNode *env = new EnvironmentTextureNode();
326 xml_read_string(&env->filename, node, "src");
327 env->filename = path_join(state.base, env->filename);
331 else if(string_iequals(node.name(), "sky_texture")) {
332 SkyTextureNode *sky = new SkyTextureNode();
334 xml_read_float3(&sky->sun_direction, node, "sun_direction");
335 xml_read_float(&sky->turbidity, node, "turbidity");
339 else if(string_iequals(node.name(), "noise_texture")) {
340 snode = new NoiseTextureNode();
342 else if(string_iequals(node.name(), "gradient_texture")) {
343 GradientTextureNode *blend = new GradientTextureNode();
344 xml_read_enum(&blend->type, GradientTextureNode::type_enum, node, "type");
347 else if(string_iequals(node.name(), "voronoi_texture")) {
348 VoronoiTextureNode *voronoi = new VoronoiTextureNode();
349 xml_read_enum(&voronoi->coloring, VoronoiTextureNode::coloring_enum, node, "coloring");
352 else if(string_iequals(node.name(), "musgrave_texture")) {
353 MusgraveTextureNode *musgrave = new MusgraveTextureNode();
354 xml_read_enum(&musgrave->type, MusgraveTextureNode::type_enum, node, "type");
357 else if(string_iequals(node.name(), "magic_texture")) {
358 MagicTextureNode *magic = new MagicTextureNode();
359 xml_read_int(&magic->depth, node, "depth");
362 else if(string_iequals(node.name(), "noise_texture")) {
363 NoiseTextureNode *dist = new NoiseTextureNode();
366 else if(string_iequals(node.name(), "wave_texture")) {
367 WaveTextureNode *wood = new WaveTextureNode();
368 xml_read_enum(&wood->type, WaveTextureNode::type_enum, node, "type");
371 else if(string_iequals(node.name(), "mapping")) {
372 snode = new MappingNode();
374 else if(string_iequals(node.name(), "ward_bsdf")) {
375 snode = new WardBsdfNode();
377 else if(string_iequals(node.name(), "diffuse_bsdf")) {
378 snode = new DiffuseBsdfNode();
380 else if(string_iequals(node.name(), "translucent_bsdf")) {
381 snode = new TranslucentBsdfNode();
383 else if(string_iequals(node.name(), "transparent_bsdf")) {
384 snode = new TransparentBsdfNode();
386 else if(string_iequals(node.name(), "velvet_bsdf")) {
387 snode = new VelvetBsdfNode();
389 else if(string_iequals(node.name(), "glossy_bsdf")) {
390 GlossyBsdfNode *glossy = new GlossyBsdfNode();
391 xml_read_enum(&glossy->distribution, GlossyBsdfNode::distribution_enum, node, "distribution");
394 else if(string_iequals(node.name(), "glass_bsdf")) {
395 GlassBsdfNode *diel = new GlassBsdfNode();
396 xml_read_enum(&diel->distribution, GlassBsdfNode::distribution_enum, node, "distribution");
399 else if(string_iequals(node.name(), "emission")) {
400 EmissionNode *emission = new EmissionNode();
401 xml_read_bool(&emission->total_power, node, "total_power");
404 else if(string_iequals(node.name(), "background")) {
405 snode = new BackgroundNode();
407 else if(string_iequals(node.name(), "transparent_volume")) {
408 snode = new TransparentVolumeNode();
410 else if(string_iequals(node.name(), "isotropic_volume")) {
411 snode = new IsotropicVolumeNode();
413 else if(string_iequals(node.name(), "geometry")) {
414 snode = new GeometryNode();
416 else if(string_iequals(node.name(), "texture_coordinate")) {
417 snode = new TextureCoordinateNode();
419 else if(string_iequals(node.name(), "lightPath")) {
420 snode = new LightPathNode();
422 else if(string_iequals(node.name(), "value")) {
423 ValueNode *value = new ValueNode();
424 xml_read_float(&value->value, node, "value");
427 else if(string_iequals(node.name(), "color")) {
428 ColorNode *color = new ColorNode();
429 xml_read_float3(&color->value, node, "value");
432 else if(string_iequals(node.name(), "mix_closure")) {
433 snode = new MixClosureNode();
435 else if(string_iequals(node.name(), "add_closure")) {
436 snode = new AddClosureNode();
438 else if(string_iequals(node.name(), "invert")) {
439 snode = new InvertNode();
441 else if(string_iequals(node.name(), "mix")) {
442 MixNode *mix = new MixNode();
443 xml_read_enum(&mix->type, MixNode::type_enum, node, "type");
446 else if(string_iequals(node.name(), "combine_rgb")) {
447 snode = new CombineRGBNode();
449 else if(string_iequals(node.name(), "separate_rgb")) {
450 snode = new SeparateRGBNode();
452 else if(string_iequals(node.name(), "hsv")) {
453 snode = new HSVNode();
455 else if(string_iequals(node.name(), "attribute")) {
456 AttributeNode *attr = new AttributeNode();
457 xml_read_ustring(&attr->attribute, node, "attribute");
460 else if(string_iequals(node.name(), "camera")) {
461 snode = new CameraNode();
463 else if(string_iequals(node.name(), "fresnel")) {
464 snode = new FresnelNode();
466 else if(string_iequals(node.name(), "math")) {
467 MathNode *math = new MathNode();
468 xml_read_enum(&math->type, MathNode::type_enum, node, "type");
471 else if(string_iequals(node.name(), "vector_math")) {
472 VectorMathNode *vmath = new VectorMathNode();
473 xml_read_enum(&vmath->type, VectorMathNode::type_enum, node, "type");
476 else if(string_iequals(node.name(), "connect")) {
478 vector<string> from_tokens, to_tokens;
480 string_split(from_tokens, node.attribute("from").value());
481 string_split(to_tokens, node.attribute("to").value());
483 if(from_tokens.size() == 2 && to_tokens.size() == 2) {
484 /* find nodes and sockets */
485 ShaderOutput *output = NULL;
486 ShaderInput *input = NULL;
488 if(nodemap.find(from_tokens[0]) != nodemap.end()) {
489 ShaderNode *fromnode = nodemap[from_tokens[0]];
491 foreach(ShaderOutput *out, fromnode->outputs)
492 if(string_iequals(xml_socket_name(out->name), from_tokens[1]))
496 fprintf(stderr, "Unknown output socket name \"%s\" on \"%s\".\n", from_tokens[1].c_str(), from_tokens[0].c_str());
499 fprintf(stderr, "Unknown shader node name \"%s\".\n", from_tokens[0].c_str());
501 if(nodemap.find(to_tokens[0]) != nodemap.end()) {
502 ShaderNode *tonode = nodemap[to_tokens[0]];
504 foreach(ShaderInput *in, tonode->inputs)
505 if(string_iequals(xml_socket_name(in->name), to_tokens[1]))
509 fprintf(stderr, "Unknown input socket name \"%s\" on \"%s\".\n", to_tokens[1].c_str(), to_tokens[0].c_str());
512 fprintf(stderr, "Unknown shader node name \"%s\".\n", to_tokens[0].c_str());
516 graph->connect(output, input);
519 fprintf(stderr, "Invalid from or to value for connect node.\n");
522 fprintf(stderr, "Unknown shader node \"%s\".\n", node.name());
528 /* add to map for name lookups */
530 xml_read_string(&name, node, "name");
532 nodemap[name] = snode;
534 /* read input values */
535 for(pugi::xml_attribute attr = node.first_attribute(); attr; attr = attr.next_attribute()) {
536 foreach(ShaderInput *in, snode->inputs) {
537 if(string_iequals(in->name, attr.name())) {
539 case SHADER_SOCKET_FLOAT:
540 xml_read_float(&in->value.x, node, attr.name());
542 case SHADER_SOCKET_COLOR:
543 case SHADER_SOCKET_VECTOR:
544 case SHADER_SOCKET_POINT:
545 case SHADER_SOCKET_NORMAL:
546 xml_read_float3(&in->value, node, attr.name());
557 shader->set_graph(graph);
558 shader->tag_update(state.scene);
561 static void xml_read_shader(const XMLReadState& state, pugi::xml_node node)
563 Shader *shader = new Shader();
564 xml_read_string(&shader->name, node, "name");
565 xml_read_shader_graph(state, shader, node);
566 state.scene->shaders.push_back(shader);
571 static void xml_read_background(const XMLReadState& state, pugi::xml_node node)
573 Shader *shader = state.scene->shaders[state.scene->default_background];
575 xml_read_shader_graph(state, shader, node);
580 static Mesh *xml_add_mesh(Scene *scene, const Transform& tfm)
583 Mesh *mesh = new Mesh();
584 scene->meshes.push_back(mesh);
587 Object *object = new Object();
590 scene->objects.push_back(object);
595 static void xml_read_mesh(const XMLReadState& state, pugi::xml_node node)
598 Mesh *mesh = xml_add_mesh(state.scene, state.tfm);
599 mesh->used_shaders.push_back(state.shader);
602 int shader = state.shader;
603 bool smooth = state.smooth;
605 mesh->displacement_method = state.displacement_method;
607 /* read vertices and polygons, RIB style */
609 vector<int> verts, nverts;
611 xml_read_float3_array(P, node, "P");
612 xml_read_int_array(verts, node, "verts");
613 xml_read_int_array(nverts, node, "nverts");
615 if(xml_equal_string(node, "subdivision", "catmull-clark")) {
616 /* create subd mesh */
619 /* create subd vertices */
620 for(size_t i = 0; i < P.size(); i++)
621 sdmesh.add_vert(P[i]);
623 /* create subd faces */
624 int index_offset = 0;
626 for(size_t i = 0; i < nverts.size(); i++) {
628 int v0 = verts[index_offset + 0];
629 int v1 = verts[index_offset + 1];
630 int v2 = verts[index_offset + 2];
631 int v3 = verts[index_offset + 3];
633 sdmesh.add_face(v0, v1, v2, v3);
636 for(int j = 0; j < nverts[i]-2; j++) {
637 int v0 = verts[index_offset];
638 int v1 = verts[index_offset + j + 1];
639 int v2 = verts[index_offset + j + 2];;
641 sdmesh.add_face(v0, v1, v2);
645 index_offset += nverts[i];
648 /* finalize subd mesh */
649 sdmesh.link_boundary();
653 //dsplit.camera = state.scene->camera;
654 //dsplit.dicing_rate = 5.0f;
655 dsplit.dicing_rate = state.dicing_rate;
656 xml_read_float(&dsplit.dicing_rate, node, "dicing_rate");
657 sdmesh.tesselate(&dsplit, false, mesh, shader, smooth);
660 /* create vertices */
663 /* create triangles */
664 int index_offset = 0;
666 for(size_t i = 0; i < nverts.size(); i++) {
667 for(int j = 0; j < nverts[i]-2; j++) {
668 int v0 = verts[index_offset];
669 int v1 = verts[index_offset + j + 1];
670 int v2 = verts[index_offset + j + 2];
672 assert(v0 < (int)P.size());
673 assert(v1 < (int)P.size());
674 assert(v2 < (int)P.size());
676 mesh->add_triangle(v0, v1, v2, shader, smooth);
679 index_offset += nverts[i];
683 /* temporary for test compatibility */
684 mesh->attributes.remove(Attribute::STD_VERTEX_NORMAL);
689 static void xml_read_patch(const XMLReadState& state, pugi::xml_node node)
695 xml_read_float3_array(P, node, "P");
697 if(xml_equal_string(node, "type", "bilinear")) {
700 LinearQuadPatch *bpatch = new LinearQuadPatch();
702 for(int i = 0; i < 4; i++)
703 P[i] = transform(&state.tfm, P[i]);
704 memcpy(bpatch->hull, &P[0], sizeof(bpatch->hull));
709 fprintf(stderr, "Invalid number of control points for bilinear patch.\n");
711 else if(xml_equal_string(node, "type", "bicubic")) {
714 BicubicPatch *bpatch = new BicubicPatch();
716 for(int i = 0; i < 16; i++)
717 P[i] = transform(&state.tfm, P[i]);
718 memcpy(bpatch->hull, &P[0], sizeof(bpatch->hull));
723 fprintf(stderr, "Invalid number of control points for bicubic patch.\n");
726 fprintf(stderr, "Unknown patch type.\n");
730 Mesh *mesh = xml_add_mesh(state.scene, transform_identity());
732 mesh->used_shaders.push_back(state.shader);
736 //dsplit.camera = state.scene->camera;
737 //dsplit.dicing_rate = 5.0f;
738 dsplit.dicing_rate = state.dicing_rate;
739 xml_read_float(&dsplit.dicing_rate, node, "dicing_rate");
740 dsplit.split_quad(mesh, patch, state.shader, state.smooth);
744 /* temporary for test compatibility */
745 mesh->attributes.remove(Attribute::STD_VERTEX_NORMAL);
751 static void xml_read_light(const XMLReadState& state, pugi::xml_node node)
753 Light *light = new Light();
754 light->shader = state.shader;
755 xml_read_float3(&light->co, node, "P");
756 light->co = transform(&state.tfm, light->co);
758 state.scene->lights.push_back(light);
763 static void xml_read_transform(pugi::xml_node node, Transform& tfm)
765 if(node.attribute("matrix")) {
766 vector<float> matrix;
767 if(xml_read_float_array(matrix, node, "matrix") && matrix.size() == 16)
768 tfm = tfm * transform_transpose((*(Transform*)&matrix[0]));
771 if(node.attribute("translate")) {
772 float3 translate = make_float3(0.0f, 0.0f, 0.0f);
773 xml_read_float3(&translate, node, "translate");
774 tfm = tfm * transform_translate(translate);
777 if(node.attribute("rotate")) {
778 float4 rotate = make_float4(0.0f, 0.0f, 0.0f, 0.0f);
779 xml_read_float4(&rotate, node, "rotate");
780 tfm = tfm * transform_rotate(rotate.x*M_PI/180.0f, make_float3(rotate.y, rotate.z, rotate.w));
783 if(node.attribute("scale")) {
784 float3 scale = make_float3(0.0f, 0.0f, 0.0f);
785 xml_read_float3(&scale, node, "scale");
786 tfm = tfm * transform_scale(scale);
792 static void xml_read_state(XMLReadState& state, pugi::xml_node node)
797 if(xml_read_string(&shadername, node, "shader")) {
801 foreach(Shader *shader, state.scene->shaders) {
802 if(shader->name == shadername) {
812 fprintf(stderr, "Unknown shader \"%s\".\n", shadername.c_str());
815 xml_read_float(&state.dicing_rate, node, "dicing_rate");
817 /* read smooth/flat */
818 if(xml_equal_string(node, "interpolation", "smooth"))
820 else if(xml_equal_string(node, "interpolation", "flat"))
821 state.smooth = false;
823 /* read displacement method */
824 if(xml_equal_string(node, "displacement_method", "true"))
825 state.displacement_method = Mesh::DISPLACE_TRUE;
826 else if(xml_equal_string(node, "displacement_method", "bump"))
827 state.displacement_method = Mesh::DISPLACE_BUMP;
828 else if(xml_equal_string(node, "displacement_method", "both"))
829 state.displacement_method = Mesh::DISPLACE_BOTH;
834 static void xml_read_include(const XMLReadState& state, const string& src);
836 static void xml_read_scene(const XMLReadState& state, pugi::xml_node scene_node)
838 for(pugi::xml_node node = scene_node.first_child(); node; node = node.next_sibling()) {
839 if(string_iequals(node.name(), "film")) {
840 xml_read_film(state, node);
842 else if(string_iequals(node.name(), "integrator")) {
843 xml_read_integrator(state, node);
845 else if(string_iequals(node.name(), "camera")) {
846 xml_read_camera(state, node);
848 else if(string_iequals(node.name(), "shader")) {
849 xml_read_shader(state, node);
851 else if(string_iequals(node.name(), "background")) {
852 xml_read_background(state, node);
854 else if(string_iequals(node.name(), "mesh")) {
855 xml_read_mesh(state, node);
857 else if(string_iequals(node.name(), "patch")) {
858 xml_read_patch(state, node);
860 else if(string_iequals(node.name(), "light")) {
861 xml_read_light(state, node);
863 else if(string_iequals(node.name(), "transform")) {
864 XMLReadState substate = state;
866 xml_read_transform(node, substate.tfm);
867 xml_read_scene(substate, node);
869 else if(string_iequals(node.name(), "state")) {
870 XMLReadState substate = state;
872 xml_read_state(substate, node);
873 xml_read_scene(substate, node);
875 else if(string_iequals(node.name(), "include")) {
878 if(xml_read_string(&src, node, "src"))
879 xml_read_include(state, src);
882 fprintf(stderr, "Unknown node \"%s\".\n", node.name());
888 static void xml_read_include(const XMLReadState& state, const string& src)
890 /* open XML document */
891 pugi::xml_document doc;
892 pugi::xml_parse_result parse_result;
894 string path = path_join(state.base, src);
895 parse_result = doc.load_file(path.c_str());
898 XMLReadState substate = state;
899 substate.base = path_dirname(path);
901 xml_read_scene(substate, doc);
904 fprintf(stderr, "%s read error: %s\n", src.c_str(), parse_result.description());
909 void xml_read_file(Scene *scene, const char *filepath)
914 state.tfm = transform_identity();
915 state.shader = scene->default_surface;
916 state.smooth = false;
917 state.dicing_rate = 0.1f;
918 state.base = path_dirname(filepath);
920 xml_read_include(state, path_filename(filepath));
922 scene->params.bvh_type = SceneParams::BVH_STATIC;