1 /*
2 * This file is part of FFmpeg.
3 *
4 * FFmpeg is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * FFmpeg 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 GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with FFmpeg; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
17 */
18
19 #ifndef AVFILTER_OPENCL_H
20 #define AVFILTER_OPENCL_H
21
22 // The intended target is OpenCL 1.2, so disable warnings for APIs
23 // deprecated after that. This primarily applies to clCreateCommandQueue(),
24 // we can't use the replacement clCreateCommandQueueWithProperties() because
25 // it was introduced in OpenCL 2.0.
26 #define CL_USE_DEPRECATED_OPENCL_1_2_APIS
27
33
35
38
42
44
49
50 // Groups together information about a kernel argument
55
56 /**
57 * set argument to specific Kernel.
58 * This macro relies on usage of local label "fail" and variables:
59 * avctx, cle and err.
60 */
61 #define CL_SET_KERNEL_ARG(kernel, arg_num, type, arg) \
62 cle = clSetKernelArg(kernel, arg_num, sizeof(type), arg); \
63 if (cle != CL_SUCCESS) { \
64 av_log(avctx, AV_LOG_ERROR, "Failed to set kernel " \
65 "argument %d: error %d.\n", arg_num, cle); \
66 err = AVERROR(EIO); \
67 goto fail; \
68 }
69
70 /**
71 * A helper macro to handle OpenCL errors. It will assign errcode to
72 * variable err, log error msg, and jump to fail label on error.
73 */
74 #define CL_FAIL_ON_ERROR(errcode, ...) do { \
75 if (cle != CL_SUCCESS) { \
76 av_log(avctx, AV_LOG_ERROR, __VA_ARGS__); \
77 err = errcode; \
78 goto fail; \
79 } \
80 } while(0)
81
82 /**
83 * Create a kernel with the given name.
84 *
85 * The kernel variable in the context structure must have a name of the form
86 * kernel_<kernel_name>.
87 *
88 * The OpenCLFilterContext variable in the context structure must be named ocf.
89 *
90 * Requires the presence of a local cl_int variable named cle and a fail label for error
91 * handling.
92 */
93 #define CL_CREATE_KERNEL(ctx, kernel_name) do { \
94 ctx->kernel_ ## kernel_name = clCreateKernel(ctx->ocf.program, #kernel_name, &cle); \
95 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create %s kernel: %d.\n", #kernel_name, cle); \
96 } while(0)
97
98 /**
99 * release an OpenCL Kernel
100 */
101 #define CL_RELEASE_KERNEL(k) \
102 do { \
103 if (k) { \
104 cle = clReleaseKernel(k); \
105 if (cle != CL_SUCCESS) \
106 av_log(avctx, AV_LOG_ERROR, "Failed to release " \
107 "OpenCL kernel: %d.\n", cle); \
108 } \
109 } while(0)
110
111 /**
112 * release an OpenCL Memory Object
113 */
114 #define CL_RELEASE_MEMORY(m) \
115 do { \
116 if (m) { \
117 cle = clReleaseMemObject(m); \
118 if (cle != CL_SUCCESS) \
119 av_log(avctx, AV_LOG_ERROR, "Failed to release " \
120 "OpenCL memory: %d.\n", cle); \
121 } \
122 } while(0)
123
124 /**
125 * release an OpenCL Command Queue
126 */
127 #define CL_RELEASE_QUEUE(q) \
128 do { \
129 if (q) { \
130 cle = clReleaseCommandQueue(q); \
131 if (cle != CL_SUCCESS) \
132 av_log(avctx, AV_LOG_ERROR, "Failed to release " \
133 "OpenCL command queue: %d.\n", cle); \
134 } \
135 } while(0)
136
137 /**
138 * Enqueue a kernel with the given information.
139 *
140 * Kernel arguments are provided as KernelArg structures and are set in the order
141 * that they are passed.
142 *
143 * Requires the presence of a local cl_int variable named cle and a fail label for error
144 * handling.
145 */
146 #define CL_ENQUEUE_KERNEL_WITH_ARGS(queue, kernel, global_work_size, local_work_size, event, ...) \
147 do { \
148 OpenCLKernelArg args[] = {__VA_ARGS__}; \
149 for (int i = 0; i < FF_ARRAY_ELEMS(args); i++) { \
150 cle = clSetKernelArg(kernel, i, args[i].arg_size, args[i].arg_val); \
151 if (cle != CL_SUCCESS) { \
152 av_log(avctx, AV_LOG_ERROR, "Failed to set kernel " \
153 "argument %d: error %d.\n", i, cle); \
154 err = AVERROR(EIO); \
155 goto fail; \
156 } \
157 } \
158 \
159 cle = clEnqueueNDRangeKernel( \
160 queue, \
161 kernel, \
162 FF_ARRAY_ELEMS(global_work_size), \
163 NULL, \
164 global_work_size, \
165 local_work_size, \
166 0, \
167 NULL, \
168 event \
169 ); \
170 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to enqueue kernel: %d.\n", cle); \
171 } while (0)
172
173 /**
174 * Uses the above macro to enqueue the given kernel and then additionally runs it to
175 * completion via clFinish.
176 *
177 * Requires the presence of a local cl_int variable named cle and a fail label for error
178 * handling.
179 */
180 #define CL_RUN_KERNEL_WITH_ARGS(queue, kernel, global_work_size, local_work_size, event, ...) do { \
181 CL_ENQUEUE_KERNEL_WITH_ARGS( \
182 queue, kernel, global_work_size, local_work_size, event, __VA_ARGS__ \
183 ); \
184 \
185 cle = clFinish(queue); \
186 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to finish command queue: %d.\n", cle); \
187 } while (0)
188
189 /**
190 * Create a buffer with the given information.
191 *
192 * The buffer variable in the context structure must be named <buffer_name>.
193 *
194 * Requires the presence of a local cl_int variable named cle and a fail label for error
195 * handling.
196 */
197 #define CL_CREATE_BUFFER_FLAGS(ctx, buffer_name, flags, size, host_ptr) do { \
198 ctx->buffer_name = clCreateBuffer( \
199 ctx->ocf.hwctx->context, \
200 flags, \
201 size, \
202 host_ptr, \
203 &cle \
204 ); \
205 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to create buffer %s: %d.\n", #buffer_name, cle); \
206 } while(0)
207
208 /**
209 * Perform a blocking write to a buffer.
210 *
211 * Requires the presence of a local cl_int variable named cle and a fail label for error
212 * handling.
213 */
214 #define CL_BLOCKING_WRITE_BUFFER(queue, buffer, size, host_ptr, event) do { \
215 cle = clEnqueueWriteBuffer( \
216 queue, \
217 buffer, \
218 CL_TRUE, \
219 0, \
220 size, \
221 host_ptr, \
222 0, \
223 NULL, \
224 event \
225 ); \
226 CL_FAIL_ON_ERROR(AVERROR(EIO), "Failed to write buffer to device: %d.\n", cle); \
227 } while(0)
228
229 /**
230 * Create a buffer with the given information.
231 *
232 * The buffer variable in the context structure must be named <buffer_name>.
233 *
234 * Requires the presence of a local cl_int variable named cle and a fail label for error
235 * handling.
236 */
237 #define CL_CREATE_BUFFER(ctx, buffer_name, size) CL_CREATE_BUFFER_FLAGS(ctx, buffer_name, 0, size, NULL)
238
239 /**
240 * Check that the input link contains a suitable hardware frames
241 * context and extract the device from it.
242 */
244
245 /**
246 * Create a suitable hardware frames context for the output.
247 */
249
250 /**
251 * Initialise an OpenCL filter context.
252 */
254
255 /**
256 * Uninitialise an OpenCL filter context.
257 */
259
260 /**
261 * Load a new OpenCL program from strings in memory.
262 *
263 * Creates a new program and compiles it for the current device.
264 * Will log any build errors if compilation fails.
265 */
267 const char **program_source_array,
268 int nb_strings);
269
270 /**
271 * Load a new OpenCL program from a file.
272 *
273 * Same as ff_opencl_filter_load_program(), but from a file.
274 */
276 const char *filename);
277
278 /**
279 * Find the work size needed needed for a given plane of an image.
280 */
282 size_t *work_size,
284 int block_alignment);
285 /**
286 * Print a 3x3 matrix into a buffer as __constant array, which could
287 * be included in an OpenCL program.
288 */
289
291 double mat[3][3]);
292
293 /**
294 * Gets the command start and end times for the given event and returns the
295 * difference (the time that the event took).
296 */
298
299 #endif /* AVFILTER_OPENCL_H */