Definition at line 45 of file opencl.h.

Definition at line 47 of file opencl.h.

Definition at line 49 of file opencl.h.

Definition at line 51 of file opencl.h.

Get OpenCL device list.

It must be freed with av_opencl_free_device_list().

Parameters

device_list pointer to OpenCL environment device list, should be released by av_opencl_free_device_list()

Returns

>=0 on success, a negative error code in case of failure

Definition at line 300 of file opencl.c.

Referenced by opt_opencl_bench().

Free OpenCL device list.

Parameters

device_list pointer to OpenCL environment device list created by av_opencl_get_device_list()

Definition at line 318 of file opencl.c.

Referenced by opt_opencl_bench().

Set option in the global OpenCL context.

This options affect the operation performed by the next av_opencl_init() operation.

The currently accepted options are:

• platform: set index of platform in device list
• device: set index of device in device list

See reference "OpenCL Specification Version: 1.2 chapter 5.6.4".

Parameters

key option key

val option value

Returns

>=0 on success, a negative error code in case of failure

See Also

av_opencl_get_option()

Definition at line 324 of file opencl.c.

Referenced by opt_opencl().

Get option value from the global OpenCL context.

Parameters

key option key

out_val pointer to location where option value will be written, must be freed with av_freep()

Returns

>=0 on success, a negative error code in case of failure

See Also

av_opencl_set_option()

Definition at line 337 of file opencl.c.

Free option values of the global OpenCL context.

Definition at line 346 of file opencl.c.

Allocate OpenCL external environment.

It must be freed with av_opencl_free_external_env().

Returns

pointer to allocated OpenCL external environment

Definition at line 354 of file opencl.c.

Referenced by av_opencl_benchmark().

Free OpenCL external environment.

Parameters

ext_opencl_env pointer to OpenCL external environment created by av_opencl_alloc_external_env()

Definition at line 364 of file opencl.c.

Referenced by av_opencl_benchmark().

Get OpenCL error string.

Parameters

status OpenCL error code

Returns

OpenCL error string

Definition at line 169 of file opencl.c.

Referenced by av_opencl_buffer_create(), av_opencl_buffer_read(), av_opencl_buffer_read_image(), av_opencl_buffer_release(), av_opencl_buffer_write(), av_opencl_buffer_write_image(), av_opencl_compile(), av_opencl_uninit(), ff_opencl_apply_unsharp(), ff_opencl_set_parameter(), ff_opencl_transform(), get_device_list(), and init_opencl_env().

Register kernel code.

The registered kernel code is stored in a global context, and compiled in the runtime environment when av_opencl_init() is called.

Parameters

kernel_code kernel code to be compiled in the OpenCL runtime environment

Returns

>=0 on success, a negative error code in case of failure

Definition at line 369 of file opencl.c.

Initialize the run time OpenCL environment.

Parameters

ext_opencl_env external OpenCL environment, created by an application program, ignored if set to NULL

Returns

>=0 on success, a negative error code in case of failure

Definition at line 554 of file opencl.c.

Referenced by ff_opencl_deshake_init(), and ff_opencl_unsharp_init().

compile specific OpenCL kernel source

Parameters

program_name pointer to a program name used for identification

build_opts pointer to a string that describes the preprocessor build options to be used for building the program

Returns

a cl_program object

Definition at line 394 of file opencl.c.

Referenced by ff_opencl_deshake_init(), and ff_opencl_unsharp_init().

get OpenCL command queue

Returns

a cl_command_queue object

Definition at line 443 of file opencl.c.

Referenced by ff_opencl_deshake_init(), and ff_opencl_unsharp_init().

Create OpenCL buffer.

The buffer is used to save the data used or created by an OpenCL kernel. The created buffer must be released with av_opencl_buffer_release().

See clCreateBuffer() function reference for more information about the parameters.

Parameters

cl_buf pointer to OpenCL buffer

cl_buf_size size in bytes of the OpenCL buffer to create

flags flags used to control buffer attributes

host_ptr host pointer of the OpenCL buffer

Returns

>=0 on success, a negative error code in case of failure

Definition at line 611 of file opencl.c.

Referenced by ff_opencl_deshake_process_inout_buf(), ff_opencl_unsharp_init(), and ff_opencl_unsharp_process_inout_buf().

Write OpenCL buffer with data from src_buf.

Parameters

dst_cl_buf pointer to OpenCL destination buffer

src_buf pointer to source buffer

buf_size size in bytes of the source and destination buffers

Returns

>=0 on success, a negative error code in case of failure

Definition at line 635 of file opencl.c.

Referenced by compute_mask_matrix().

Read data from OpenCL buffer to memory buffer.

Parameters

dst_buf pointer to destination buffer (CPU memory)

src_cl_buf pointer to source OpenCL buffer

buf_size size in bytes of the source and destination buffers

Returns

>=0 on success, a negative error code in case of failure

Definition at line 658 of file opencl.c.

Write image data from memory to OpenCL buffer.

The source must be an array of pointers to image plane buffers.

Parameters

dst_cl_buf pointer to destination OpenCL buffer

dst_cl_buf_size size in bytes of OpenCL buffer

dst_cl_buf_offset the offset of the OpenCL buffer start position

src_data array of pointers to source plane buffers

src_plane_sizes array of sizes in bytes of the source plane buffers

src_plane_num number of source image planes

Returns

>=0 on success, a negative error code in case of failure

Definition at line 681 of file opencl.c.

Referenced by ff_opencl_deshake_process_inout_buf(), and ff_opencl_unsharp_process_inout_buf().

Read image data from OpenCL buffer.

Parameters

dst_data array of pointers to destination plane buffers

dst_plane_sizes array of pointers to destination plane buffers

dst_plane_num number of destination image planes

src_cl_buf pointer to source OpenCL buffer

src_cl_buf_size size in bytes of OpenCL buffer

Returns

>=0 on success, a negative error code in case of failure

Definition at line 722 of file opencl.c.

Referenced by ff_opencl_apply_unsharp(), and ff_opencl_transform().

Release OpenCL buffer.

Parameters

cl_buf pointer to OpenCL buffer to release, which was previously filled with av_opencl_buffer_create()

Definition at line 622 of file opencl.c.

Referenced by ff_opencl_deshake_uninit(), and ff_opencl_unsharp_uninit().

Release OpenCL environment.

The OpenCL environment is effectively released only if all the created kernels had been released with av_opencl_release_kernel().

Definition at line 579 of file opencl.c.

Referenced by ff_opencl_deshake_uninit(), and ff_opencl_unsharp_uninit().

Benchmark an OpenCL device with a user defined callback function.

This function sets up an external OpenCL environment including context and command queue on the device then tears it down in the end. The callback function should perform the rest of the work.

Parameters

device pointer to the OpenCL device to be used

platform cl_platform_id handle to which the device belongs to

benchmark callback function to perform the benchmark, return a negative value in case of failure

Returns

the score passed from the callback function, a negative error code in case of failure

Definition at line 765 of file opencl.c.

Referenced by opt_opencl_bench().