Cycles: Optimize storage of QBVH node by one float4
[blender-staging.git] / intern / cycles / bvh / bvh.h
1 /*
2  * Adapted from code copyright 2009-2010 NVIDIA Corporation
3  * Modifications Copyright 2011, Blender Foundation.
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 #ifndef __BVH_H__
19 #define __BVH_H__
20
21 #include "bvh_params.h"
22
23 #include "util_string.h"
24 #include "util_types.h"
25 #include "util_vector.h"
26
27 CCL_NAMESPACE_BEGIN
28
29 class BVHNode;
30 struct BVHStackEntry;
31 class BVHParams;
32 class BoundBox;
33 class CacheData;
34 class LeafNode;
35 class Object;
36 class Progress;
37
38 #define BVH_NODE_SIZE   4
39 #define BVH_QNODE_SIZE  7
40 #define BVH_ALIGN               4096
41 #define TRI_NODE_SIZE   3
42
43 /* Packed BVH
44  *
45  * BVH stored as it will be used for traversal on the rendering device. */
46
47 struct PackedBVH {
48         /* BVH nodes storage, one node is 4x int4, and contains two bounding boxes,
49          * and child, triangle or object indexes depending on the node type */
50         array<int4> nodes; 
51         /* object index to BVH node index mapping for instances */
52         array<int> object_node; 
53         /* precomputed triangle intersection data, one triangle is 4x float4 */
54         array<float4> tri_woop;
55         /* primitive type - triangle or strand */
56         array<int> prim_type;
57         /* visibility visibilitys for primitives */
58         array<uint> prim_visibility;
59         /* mapping from BVH primitive index to true primitive index, as primitives
60          * may be duplicated due to spatial splits. -1 for instances. */
61         array<int> prim_index;
62         /* mapping from BVH primitive index, to the object id of that primitive. */
63         array<int> prim_object;
64         /* quick array to lookup if a node is a leaf, not used for traversal, only
65          * for instance BVH merging  */
66         array<int> is_leaf;
67
68         /* index of the root node. */
69         int root_index;
70
71         /* surface area heuristic, for building top level BVH */
72         float SAH;
73
74         PackedBVH()
75         {
76                 root_index = 0;
77                 SAH = 0.0f;
78         }
79 };
80
81 /* BVH */
82
83 class BVH
84 {
85 public:
86         PackedBVH pack;
87         BVHParams params;
88         vector<Object*> objects;
89         string cache_filename;
90
91         static BVH *create(const BVHParams& params, const vector<Object*>& objects);
92         virtual ~BVH() {}
93
94         void build(Progress& progress);
95         void refit(Progress& progress);
96
97         void clear_cache_except();
98
99 protected:
100         BVH(const BVHParams& params, const vector<Object*>& objects);
101
102         /* cache */
103         bool cache_read(CacheData& key);
104         void cache_write(CacheData& key);
105
106         /* triangles and strands*/
107         void pack_primitives();
108         void pack_triangle(int idx, float4 woop[3]);
109         void pack_curve_segment(int idx, float4 woop[3]);
110
111         /* merge instance BVH's */
112         void pack_instances(size_t nodes_size);
113
114         /* for subclasses to implement */
115         virtual void pack_nodes(const array<int>& prims, const BVHNode *root) = 0;
116         virtual void refit_nodes() = 0;
117 };
118
119 /* Regular BVH
120  *
121  * Typical BVH with each node having two children. */
122
123 class RegularBVH : public BVH {
124 protected:
125         /* constructor */
126         friend class BVH;
127         RegularBVH(const BVHParams& params, const vector<Object*>& objects);
128
129         /* pack */
130         void pack_nodes(const array<int>& prims, const BVHNode *root);
131         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
132         void pack_inner(const BVHStackEntry& e, const BVHStackEntry& e0, const BVHStackEntry& e1);
133         void pack_node(int idx, const BoundBox& b0, const BoundBox& b1, int c0, int c1, uint visibility0, uint visibility1);
134
135         /* refit */
136         void refit_nodes();
137         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
138 };
139
140 /* QBVH
141  *
142  * Quad BVH, with each node having four children, to use with SIMD instructions. */
143
144 class QBVH : public BVH {
145 protected:
146         /* constructor */
147         friend class BVH;
148         QBVH(const BVHParams& params, const vector<Object*>& objects);
149
150         /* pack */
151         void pack_nodes(const array<int>& prims, const BVHNode *root);
152         void pack_leaf(const BVHStackEntry& e, const LeafNode *leaf);
153         void pack_inner(const BVHStackEntry& e, const BVHStackEntry *en, int num);
154
155         /* refit */
156         void refit_nodes();
157         void refit_node(int idx, bool leaf, BoundBox& bbox, uint& visibility);
158 };
159
160 CCL_NAMESPACE_END
161
162 #endif /* __BVH_H__ */
163