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
  26 #include "util_string.h"
  27 #include "util_thread.h"
  28 #include "util_types.h"
  29 #include "util_vector.h"
  30
  31 CCL_NAMESPACE_BEGIN
  32
  33 class Progress;
  34
  35 enum DeviceType {
  36         DEVICE_NONE,
  37         DEVICE_CPU,
  38         DEVICE_OPENCL,
  39         DEVICE_CUDA,
  40         DEVICE_NETWORK,
  41         DEVICE_MULTI
  42 };
  43
  44 enum MemoryType {
  45         MEM_READ_ONLY,
  46         MEM_WRITE_ONLY,
  47         MEM_READ_WRITE
  48 };
  49
  50 /* Device Task */
  51
  52 class DeviceTask {
  53 public:
  54         typedef enum { PATH_TRACE, TONEMAP, DISPLACE } Type;
  55         Type type;
  56
  57         int x, y, w, h;
  58         device_ptr rng_state;
  59         device_ptr rgba;
  60         device_ptr buffer;
  61         int sample;
  62         int resolution;
  63
  64         device_ptr displace_input;
  65         device_ptr displace_offset;
  66         int displace_x, displace_w;
  67
  68         DeviceTask(Type type = PATH_TRACE);
  69         void split(ThreadQueue<DeviceTask>& tasks, int num);
  70 };
  71
  72 /* Device */
  73
  74 class Device {
  75 protected:
  76         Device() {}
  77
  78         DeviceType device_type;
  79         bool background;
  80
  81 public:
  82         virtual ~Device() {}
  83
  84         DeviceType type() { return device_type; }
  85
  86         /* info */
  87         virtual string description() = 0;
  88
  89         /* regular memory */
  90         virtual void mem_alloc(device_memory& mem, MemoryType type) = 0;
  91         virtual void mem_copy_to(device_memory& mem) = 0;
  92         virtual void mem_copy_from(device_memory& mem,
  93                 size_t offset, size_t size) = 0;
  94         virtual void mem_zero(device_memory& mem) = 0;
  95         virtual void mem_free(device_memory& mem) = 0;
  96
  97         /* constant memory */
  98         virtual void const_copy_to(const char *name, void *host, size_t size) = 0;
  99
 100         /* texture memory */
 101         virtual void tex_alloc(const char *name, device_memory& mem,
 102                 bool interpolation = false, bool periodic = false) {};
 103         virtual void tex_free(device_memory& mem) {};
 104
 105         /* pixel memory */
 106         virtual void pixels_alloc(device_memory& mem);
 107         virtual void pixels_copy_from(device_memory& mem, int y, int w, int h);
 108         virtual void pixels_free(device_memory& mem);
 109
 110         /* open shading language, only for CPU device */
 111         virtual void *osl_memory() { return NULL; }
 112
 113         /* load/compile kernels, must be called before adding tasks */
 114         virtual bool load_kernels() { return true; }
 115
 116         /* tasks */
 117         virtual void task_add(DeviceTask& task) = 0;
 118         virtual void task_wait() = 0;
 119         virtual void task_cancel() = 0;
 120
 121         /* opengl drawing */
 122         virtual void draw_pixels(device_memory& mem, int y, int w, int h,
 123                 int width, int height, bool transparent);
 124
 125 #ifdef WITH_NETWORK
 126         /* networking */
 127         void server_run();
 128 #endif
 129
 130         /* static */
 131         static Device *create(DeviceType type, bool background = true, int threads = 0);
 132
 133         static DeviceType type_from_string(const char *name);
 134         static string string_from_type(DeviceType type);
 135         static vector<DeviceType> available_types();
 136 };
 137
 138 CCL_NAMESPACE_END
 139
 140 #endif /* __DEVICE_H__ */
 141