FFmpeg
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
opencl.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2012 Peng Gao <peng@multicorewareinc.com>
3  * Copyright (C) 2012 Li Cao <li@multicorewareinc.com>
4  * Copyright (C) 2012 Wei Gao <weigao@multicorewareinc.com>
5  * Copyright (C) 2013 Lenny Wang <lwanghpc@gmail.com>
6  *
7  * This file is part of FFmpeg.
8  *
9  * FFmpeg is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Lesser General Public
11  * License as published by the Free Software Foundation; either
12  * version 2.1 of the License, or (at your option) any later version.
13  *
14  * FFmpeg is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17  * Lesser General Public License for more details.
18  *
19  * You should have received a copy of the GNU Lesser General Public
20  * License along with FFmpeg; if not, write to the Free Software
21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22  */
23 
24 /**
25  * @file
26  * OpenCL wrapper
27  *
28  * This interface is considered still experimental and its API and ABI may
29  * change without prior notice.
30  */
31 
32 #ifndef LIBAVUTIL_OPENCL_H
33 #define LIBAVUTIL_OPENCL_H
34 
35 #ifdef __APPLE__
36 #include <OpenCL/cl.h>
37 #else
38 #include <CL/cl.h>
39 #endif
40 #include <stdint.h>
41 #include "dict.h"
42 
43 #include "libavutil/version.h"
44 
45 #define AV_OPENCL_KERNEL( ... )# __VA_ARGS__
46 
47 #define AV_OPENCL_MAX_KERNEL_NAME_SIZE 150
48 
49 #define AV_OPENCL_MAX_DEVICE_NAME_SIZE 100
50 
51 #define AV_OPENCL_MAX_PLATFORM_NAME_SIZE 100
52 
53 typedef struct {
55  char device_name[AV_OPENCL_MAX_DEVICE_NAME_SIZE];
56  cl_device_id device_id;
58 
59 typedef struct {
60  cl_platform_id platform_id;
61  char platform_name[AV_OPENCL_MAX_PLATFORM_NAME_SIZE];
65 
66 typedef struct {
70 
71 typedef struct {
72  cl_platform_id platform_id;
73  cl_device_type device_type;
74  cl_context context;
75  cl_device_id device_id;
76  cl_command_queue command_queue;
79 
80 /**
81  * Get OpenCL device list.
82  *
83  * It must be freed with av_opencl_free_device_list().
84  *
85  * @param device_list pointer to OpenCL environment device list,
86  * should be released by av_opencl_free_device_list()
87  *
88  * @return >=0 on success, a negative error code in case of failure
89  */
91 
92 /**
93  * Free OpenCL device list.
94  *
95  * @param device_list pointer to OpenCL environment device list
96  * created by av_opencl_get_device_list()
97  */
99 
100 /**
101  * Set option in the global OpenCL context.
102  *
103  * This options affect the operation performed by the next
104  * av_opencl_init() operation.
105  *
106  * The currently accepted options are:
107  * - platform: set index of platform in device list
108  * - device: set index of device in device list
109  *
110  * See reference "OpenCL Specification Version: 1.2 chapter 5.6.4".
111  *
112  * @param key option key
113  * @param val option value
114  * @return >=0 on success, a negative error code in case of failure
115  * @see av_opencl_get_option()
116  */
117 int av_opencl_set_option(const char *key, const char *val);
118 
119 /**
120  * Get option value from the global OpenCL context.
121  *
122  * @param key option key
123  * @param out_val pointer to location where option value will be
124  * written, must be freed with av_freep()
125  * @return >=0 on success, a negative error code in case of failure
126  * @see av_opencl_set_option()
127  */
128 int av_opencl_get_option(const char *key, uint8_t **out_val);
129 
130 /**
131  * Free option values of the global OpenCL context.
132  *
133  */
134 void av_opencl_free_option(void);
135 
136 /**
137  * Allocate OpenCL external environment.
138  *
139  * It must be freed with av_opencl_free_external_env().
140  *
141  * @return pointer to allocated OpenCL external environment
142  */
144 
145 /**
146  * Free OpenCL external environment.
147  *
148  * @param ext_opencl_env pointer to OpenCL external environment
149  * created by av_opencl_alloc_external_env()
150  */
151 void av_opencl_free_external_env(AVOpenCLExternalEnv **ext_opencl_env);
152 
153 /**
154  * Get OpenCL error string.
155  *
156  * @param status OpenCL error code
157  * @return OpenCL error string
158  */
159 const char *av_opencl_errstr(cl_int status);
160 
161 /**
162  * Register kernel code.
163  *
164  * The registered kernel code is stored in a global context, and compiled
165  * in the runtime environment when av_opencl_init() is called.
166  *
167  * @param kernel_code kernel code to be compiled in the OpenCL runtime environment
168  * @return >=0 on success, a negative error code in case of failure
169  */
170 int av_opencl_register_kernel_code(const char *kernel_code);
171 
172 /**
173  * Initialize the run time OpenCL environment
174  *
175  * @param ext_opencl_env external OpenCL environment, created by an
176  * application program, ignored if set to NULL
177  * @return >=0 on success, a negative error code in case of failure
178  */
179 int av_opencl_init(AVOpenCLExternalEnv *ext_opencl_env);
180 
181 /**
182  * compile specific OpenCL kernel source
183  *
184  * @param program_name pointer to a program name used for identification
185  * @param build_opts pointer to a string that describes the preprocessor
186  * build options to be used for building the program
187  * @return a cl_program object
188  */
189 cl_program av_opencl_compile(const char *program_name, const char* build_opts);
190 
191 /**
192  * get OpenCL command queue
193  *
194  * @return a cl_command_queue object
195  */
196 cl_command_queue av_opencl_get_command_queue(void);
197 
198 /**
199  * Create OpenCL buffer.
200  *
201  * The buffer is used to save the data used or created by an OpenCL
202  * kernel.
203  * The created buffer must be released with av_opencl_buffer_release().
204  *
205  * See clCreateBuffer() function reference for more information about
206  * the parameters.
207  *
208  * @param cl_buf pointer to OpenCL buffer
209  * @param cl_buf_size size in bytes of the OpenCL buffer to create
210  * @param flags flags used to control buffer attributes
211  * @param host_ptr host pointer of the OpenCL buffer
212  * @return >=0 on success, a negative error code in case of failure
213  */
214 int av_opencl_buffer_create(cl_mem *cl_buf, size_t cl_buf_size, int flags, void *host_ptr);
215 
216 /**
217  * Write OpenCL buffer with data from src_buf.
218  *
219  * @param dst_cl_buf pointer to OpenCL destination buffer
220  * @param src_buf pointer to source buffer
221  * @param buf_size size in bytes of the source and destination buffers
222  * @return >=0 on success, a negative error code in case of failure
223  */
224 int av_opencl_buffer_write(cl_mem dst_cl_buf, uint8_t *src_buf, size_t buf_size);
225 
226 /**
227  * Read data from OpenCL buffer to memory buffer.
228  *
229  * @param dst_buf pointer to destination buffer (CPU memory)
230  * @param src_cl_buf pointer to source OpenCL buffer
231  * @param buf_size size in bytes of the source and destination buffers
232  * @return >=0 on success, a negative error code in case of failure
233  */
234 int av_opencl_buffer_read(uint8_t *dst_buf, cl_mem src_cl_buf, size_t buf_size);
235 
236 /**
237  * Write image data from memory to OpenCL buffer.
238  *
239  * The source must be an array of pointers to image plane buffers.
240  *
241  * @param dst_cl_buf pointer to destination OpenCL buffer
242  * @param dst_cl_buf_size size in bytes of OpenCL buffer
243  * @param dst_cl_buf_offset the offset of the OpenCL buffer start position
244  * @param src_data array of pointers to source plane buffers
245  * @param src_plane_sizes array of sizes in bytes of the source plane buffers
246  * @param src_plane_num number of source image planes
247  * @return >=0 on success, a negative error code in case of failure
248  */
249 int av_opencl_buffer_write_image(cl_mem dst_cl_buf, size_t cl_buffer_size, int dst_cl_offset,
250  uint8_t **src_data, int *plane_size, int plane_num);
251 
252 /**
253  * Read image data from OpenCL buffer.
254  *
255  * @param dst_data array of pointers to destination plane buffers
256  * @param dst_plane_sizes array of pointers to destination plane buffers
257  * @param dst_plane_num number of destination image planes
258  * @param src_cl_buf pointer to source OpenCL buffer
259  * @param src_cl_buf_size size in bytes of OpenCL buffer
260  * @return >=0 on success, a negative error code in case of failure
261  */
262 int av_opencl_buffer_read_image(uint8_t **dst_data, int *plane_size, int plane_num,
263  cl_mem src_cl_buf, size_t cl_buffer_size);
264 
265 /**
266  * Release OpenCL buffer.
267  *
268  * @param cl_buf pointer to OpenCL buffer to release, which was
269  * previously filled with av_opencl_buffer_create()
270  */
271 void av_opencl_buffer_release(cl_mem *cl_buf);
272 
273 /**
274  * Release OpenCL environment.
275  *
276  * The OpenCL environment is effectively released only if all the created
277  * kernels had been released with av_opencl_release_kernel().
278  */
279 void av_opencl_uninit(void);
280 
281 /**
282  * Benchmark an OpenCL device with a user defined callback function. This function
283  * sets up an external OpenCL environment including context and command queue on
284  * the device then tears it down in the end. The callback function should perform
285  * the rest of the work.
286  *
287  * @param device pointer to the OpenCL device to be used
288  * @param platform cl_platform_id handle to which the device belongs to
289  * @param benchmark callback function to perform the benchmark, return a
290  * negative value in case of failure
291  * @return the score passed from the callback function, a negative error code in case
292  * of failure
293  */
294 int64_t av_opencl_benchmark(AVOpenCLDeviceNode *device, cl_platform_id platform,
295  int64_t (*benchmark)(AVOpenCLExternalEnv *ext_opencl_env));
296 
297 #endif /* LIBAVUTIL_OPENCL_H */