add BLI_strcpy_rlen, replace strcat, which was used in misleading way.
[blender.git] / intern / cycles / device / device.h
1 /*
2  * Copyright 2011, Blender Foundation.
3  *
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.
8  *
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.
13  *
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.
17  */
18
19 #ifndef __DEVICE_H__
20 #define __DEVICE_H__
21
22 #include <stdlib.h>
23
24 #include "device_memory.h"
25 #include "device_task.h"
26
27 #include "util_list.h"
28 #include "util_stats.h"
29 #include "util_string.h"
30 #include "util_thread.h"
31 #include "util_types.h"
32 #include "util_vector.h"
33
34 CCL_NAMESPACE_BEGIN
35
36 class Progress;
37 class RenderTile;
38
39 /* Device Types */
40
41 enum DeviceType {
42         DEVICE_NONE,
43         DEVICE_CPU,
44         DEVICE_OPENCL,
45         DEVICE_CUDA,
46         DEVICE_NETWORK,
47         DEVICE_MULTI
48 };
49
50 class DeviceInfo {
51 public:
52         DeviceType type;
53         string description;
54         string id;
55         int num;
56         bool display_device;
57         bool advanced_shading;
58         bool pack_images;
59         vector<DeviceInfo> multi_devices;
60
61         DeviceInfo()
62         {
63                 type = DEVICE_CPU;
64                 id = "CPU";
65                 num = 0;
66                 display_device = false;
67                 advanced_shading = true;
68                 pack_images = false;
69         }
70 };
71
72 /* Device */
73
74 class Device {
75 protected:
76         Device(Stats &stats_) : stats(stats_) {}
77
78         bool background;
79         string error_msg;
80
81 public:
82         virtual ~Device() {}
83
84         /* info */
85         DeviceInfo info;
86         virtual const string& error_message() { return error_msg; }
87         bool have_error() { return !error_message().empty(); }
88
89         /* statistics */
90         Stats &stats;
91
92         /* regular memory */
93         virtual void mem_alloc(device_memory& mem, MemoryType type) = 0;
94         virtual void mem_copy_to(device_memory& mem) = 0;
95         virtual void mem_copy_from(device_memory& mem,
96                 int y, int w, int h, int elem) = 0;
97         virtual void mem_zero(device_memory& mem) = 0;
98         virtual void mem_free(device_memory& mem) = 0;
99
100         /* constant memory */
101         virtual void const_copy_to(const char *name, void *host, size_t size) = 0;
102
103         /* texture memory */
104         virtual void tex_alloc(const char *name, device_memory& mem,
105                 bool interpolation = false, bool periodic = false) {};
106         virtual void tex_free(device_memory& mem) {};
107
108         /* pixel memory */
109         virtual void pixels_alloc(device_memory& mem);
110         virtual void pixels_copy_from(device_memory& mem, int y, int w, int h);
111         virtual void pixels_free(device_memory& mem);
112
113         /* open shading language, only for CPU device */
114         virtual void *osl_memory() { return NULL; }
115
116         /* load/compile kernels, must be called before adding tasks */ 
117         virtual bool load_kernels(bool experimental) { return true; }
118
119         /* tasks */
120         virtual void task_add(DeviceTask& task) = 0;
121         virtual void task_wait() = 0;
122         virtual void task_cancel() = 0;
123         
124         /* opengl drawing */
125         virtual void draw_pixels(device_memory& mem, int y, int w, int h,
126                 int dy, int width, int height, bool transparent);
127
128 #ifdef WITH_NETWORK
129         /* networking */
130         void server_run();
131 #endif
132
133         /* multi device */
134         virtual void map_tile(Device *sub_device, RenderTile& tile) {}
135         virtual int device_number(Device *sub_device) { return 0; }
136
137         /* static */
138         static Device *create(DeviceInfo& info, Stats &stats, bool background = true);
139
140         static DeviceType type_from_string(const char *name);
141         static string string_from_type(DeviceType type);
142         static vector<DeviceType>& available_types();
143         static vector<DeviceInfo>& available_devices();
144 };
145
146 CCL_NAMESPACE_END
147
148 #endif /* __DEVICE_H__ */
149