Refactoring of tiles opencl implementation:
[blender.git] / source / blender / compositor / intern / COM_OpenCLDevice.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  * Contributor: 
19  *              Jeroen Bakker 
20  *              Monique Dewanchand
21  */
22
23 class OpenCLDevice;
24
25 #ifndef _COM_OpenCLDevice_h
26 #define _COM_OpenCLDevice_h
27
28 #include "COM_Device.h"
29 #include "OCL_opencl.h"
30 #include "COM_WorkScheduler.h"
31
32 /**
33  * @brief device representing an GPU OpenCL device.
34  * an instance of this class represents a single cl_device
35  */
36 class OpenCLDevice : public Device {
37 private:
38         /**
39          * @brief opencl context
40          */
41         cl_context context;
42         
43         /**
44          * @brief opencl device
45          */
46         cl_device_id device;
47         
48         /**
49          * @brief opencl program
50          */
51         cl_program program;
52         
53         /**
54          * @brief opencl command queue
55          */
56         cl_command_queue queue;
57
58         /**
59          * @brief opencl vendor ID
60          */
61         cl_int vendorID;
62
63 public:
64         /**
65          * @brief constructor with opencl device
66          * @param context
67          * @param device
68          * @param program
69          * @param vendorID
70          */
71         OpenCLDevice(cl_context context, cl_device_id device, cl_program program, cl_int vendorId);
72         
73         
74         /**
75          * @brief initialize the device
76          * During initialization the OpenCL cl_command_queue is created
77          * the command queue is stored in the field queue.
78          * @see queue
79          */
80         bool initialize();
81         
82         /**
83          * @brief deinitialize the device
84          * During deintiialization the command queue is cleared
85          */
86         void deinitialize();
87         
88         /**
89          * @brief execute a WorkPackage
90          * @param work the WorkPackage to execute
91          */
92         void execute(WorkPackage *work);
93
94         cl_context getContext(){return this->context;}
95
96         cl_command_queue getQueue(){return this->queue;}
97
98         cl_mem COM_clAttachMemoryBufferToKernelParameter(cl_kernel kernel, int parameterIndex, int offsetIndex, list<cl_mem> *cleanup, MemoryBuffer **inputMemoryBuffers, SocketReader *reader);
99         void COM_clAttachMemoryBufferOffsetToKernelParameter(cl_kernel kernel, int offsetIndex, MemoryBuffer *memoryBuffers);
100         void COM_clAttachOutputMemoryBufferToKernelParameter(cl_kernel kernel, int parameterIndex, cl_mem clOutputMemoryBuffer);
101         void COM_clAttachSizeToKernelParameter(cl_kernel kernel, int offsetIndex, NodeOperation* operation);
102         void COM_clEnqueueRange(cl_kernel kernel, MemoryBuffer *outputMemoryBuffer);
103         void COM_clEnqueueRange(cl_kernel kernel, MemoryBuffer *outputMemoryBuffer, int offsetIndex, NodeOperation* operation);
104         cl_kernel COM_clCreateKernel(const char *kernelname, list<cl_kernel> *clKernelsToCleanUp);
105 };
106
107 #endif