Path: blob/master/thirdparty/basis_universal/encoder/basisu_opencl.cpp
9902 views
// basisu_opencl.cpp1// Copyright (C) 2019-2024 Binomial LLC. All Rights Reserved.2//3// Licensed under the Apache License, Version 2.0 (the "License");4// you may not use this file except in compliance with the License.5// You may obtain a copy of the License at6//7// http://www.apache.org/licenses/LICENSE-2.08//9// Unless required by applicable law or agreed to in writing, software10// distributed under the License is distributed on an "AS IS" BASIS,11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.12// See the License for the specific language governing permissions and13// limitations under the License.14#include "basisu_opencl.h"1516// If 1, the kernel source code will come from encoders/ocl_kernels.h. Otherwise, it will be read from the "ocl_kernels.cl" file in the current directory (for development).17#define BASISU_USE_OCL_KERNELS_HEADER (1)18#define BASISU_OCL_KERNELS_FILENAME "ocl_kernels.cl"1920#if BASISU_SUPPORT_OPENCL2122#include "basisu_enc.h"2324// We only use OpenCL v1.2 or less.25#define CL_TARGET_OPENCL_VERSION 1202627#ifdef __APPLE__28#include <OpenCL/opencl.h>29#else30#include <CL/cl.h>31#endif3233#define BASISU_OPENCL_ASSERT_ON_ANY_ERRORS (1)3435namespace basisu36{37#if BASISU_USE_OCL_KERNELS_HEADER38#include "basisu_ocl_kernels.h"39#endif4041static void ocl_error_printf(const char* pFmt, ...)42{43va_list args;44va_start(args, pFmt);45error_vprintf(pFmt, args);46va_end(args);4748#if BASISU_OPENCL_ASSERT_ON_ANY_ERRORS49assert(0);50#endif51}5253class ocl54{55public:56ocl()57{58memset(&m_dev_fp_config, 0, sizeof(m_dev_fp_config));5960m_ocl_mutex.lock();61m_ocl_mutex.unlock();62}6364~ocl()65{66}6768bool is_initialized() const { return m_device_id != nullptr; }6970cl_device_id get_device_id() const { return m_device_id; }71cl_context get_context() const { return m_context; }72cl_command_queue get_command_queue() { return m_command_queue; }73cl_program get_program() const { return m_program; }7475bool init(bool force_serialization)76{77deinit();7879interval_timer tm;80tm.start();8182cl_uint num_platforms = 0;83cl_int ret = clGetPlatformIDs(0, NULL, &num_platforms);84if (ret != CL_SUCCESS)85{86ocl_error_printf("ocl::init: clGetPlatformIDs() failed with %i\n", ret);87return false;88}8990if ((!num_platforms) || (num_platforms > INT_MAX))91{92ocl_error_printf("ocl::init: clGetPlatformIDs() returned an invalid number of num_platforms\n");93return false;94}9596std::vector<cl_platform_id> platforms(num_platforms);9798ret = clGetPlatformIDs(num_platforms, platforms.data(), NULL);99if (ret != CL_SUCCESS)100{101ocl_error_printf("ocl::init: clGetPlatformIDs() failed\n");102return false;103}104105cl_uint num_devices = 0;106ret = clGetDeviceIDs(platforms[0], CL_DEVICE_TYPE_GPU, 1, &m_device_id, &num_devices);107108if (ret == CL_DEVICE_NOT_FOUND)109{110ocl_error_printf("ocl::init: Couldn't get any GPU device ID's, trying CL_DEVICE_TYPE_CPU\n");111112ret = clGetDeviceIDs(platforms[0], CL_DEVICE_TYPE_CPU, 1, &m_device_id, &num_devices);113}114115if (ret != CL_SUCCESS)116{117ocl_error_printf("ocl::init: Unable to get any device ID's\n");118119m_device_id = nullptr;120return false;121}122123ret = clGetDeviceInfo(m_device_id,124CL_DEVICE_SINGLE_FP_CONFIG,125sizeof(m_dev_fp_config),126&m_dev_fp_config,127nullptr);128if (ret != CL_SUCCESS)129{130ocl_error_printf("ocl::init: clGetDeviceInfo() failed\n");131return false;132}133134char plat_vers[256];135size_t rv = 0;136ret = clGetPlatformInfo(platforms[0], CL_PLATFORM_VERSION, sizeof(plat_vers), plat_vers, &rv);137if (ret == CL_SUCCESS)138printf("OpenCL platform version: \"%s\"\n", plat_vers);139140// Serialize CL calls with the AMD driver to avoid lockups when multiple command queues per thread are used. This sucks, but what can we do?141m_use_mutex = (strstr(plat_vers, "AMD") != nullptr) || force_serialization;142143printf("Serializing OpenCL calls across threads: %u\n", (uint32_t)m_use_mutex);144145m_context = clCreateContext(nullptr, 1, &m_device_id, nullptr, nullptr, &ret);146if (ret != CL_SUCCESS)147{148ocl_error_printf("ocl::init: clCreateContext() failed\n");149150m_device_id = nullptr;151m_context = nullptr;152return false;153}154155m_command_queue = clCreateCommandQueue(m_context, m_device_id, 0, &ret);156if (ret != CL_SUCCESS)157{158ocl_error_printf("ocl::init: clCreateCommandQueue() failed\n");159160deinit();161return false;162}163164printf("OpenCL init time: %3.3f secs\n", tm.get_elapsed_secs());165166return true;167}168169bool deinit()170{171if (m_program)172{173clReleaseProgram(m_program);174m_program = nullptr;175}176177if (m_command_queue)178{179clReleaseCommandQueue(m_command_queue);180m_command_queue = nullptr;181}182183if (m_context)184{185clReleaseContext(m_context);186m_context = nullptr;187}188189m_device_id = nullptr;190191return true;192}193194cl_command_queue create_command_queue()195{196cl_serializer serializer(this);197198cl_int ret = 0;199cl_command_queue p = clCreateCommandQueue(m_context, m_device_id, 0, &ret);200if (ret != CL_SUCCESS)201return nullptr;202203return p;204}205206void destroy_command_queue(cl_command_queue p)207{208if (p)209{210cl_serializer serializer(this);211212clReleaseCommandQueue(p);213}214}215216bool init_program(const char* pSrc, size_t src_size)217{218cl_int ret;219220if (m_program != nullptr)221{222clReleaseProgram(m_program);223m_program = nullptr;224}225226m_program = clCreateProgramWithSource(m_context, 1, (const char**)&pSrc, (const size_t*)&src_size, &ret);227if (ret != CL_SUCCESS)228{229ocl_error_printf("ocl::init_program: clCreateProgramWithSource() failed!\n");230return false;231}232233std::string options;234if (m_dev_fp_config & CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT)235{236options += "-cl-fp32-correctly-rounded-divide-sqrt";237}238239options += " -cl-std=CL1.2";240//options += " -cl-opt-disable";241//options += " -cl-mad-enable";242//options += " -cl-fast-relaxed-math";243244ret = clBuildProgram(m_program, 1, &m_device_id,245options.size() ? options.c_str() : nullptr, // options246nullptr, // notify247nullptr); // user_data248249if (ret != CL_SUCCESS)250{251const cl_int build_program_result = ret;252253size_t ret_val_size;254ret = clGetProgramBuildInfo(m_program, m_device_id, CL_PROGRAM_BUILD_LOG, 0, NULL, &ret_val_size);255if (ret != CL_SUCCESS)256{257ocl_error_printf("ocl::init_program: clGetProgramBuildInfo() failed!\n");258return false;259}260261std::vector<char> build_log(ret_val_size + 1);262263ret = clGetProgramBuildInfo(m_program, m_device_id, CL_PROGRAM_BUILD_LOG, ret_val_size, build_log.data(), NULL);264265ocl_error_printf("\nclBuildProgram() failed with error %i:\n%s", build_program_result, build_log.data());266267return false;268}269270return true;271}272273cl_kernel create_kernel(const char* pName)274{275if (!m_program)276return nullptr;277278cl_serializer serializer(this);279280cl_int ret;281cl_kernel kernel = clCreateKernel(m_program, pName, &ret);282if (ret != CL_SUCCESS)283{284ocl_error_printf("ocl::create_kernel: clCreateKernel() failed!\n");285return nullptr;286}287288return kernel;289}290291bool destroy_kernel(cl_kernel k)292{293if (k)294{295cl_serializer serializer(this);296297cl_int ret = clReleaseKernel(k);298if (ret != CL_SUCCESS)299{300ocl_error_printf("ocl::destroy_kernel: clReleaseKernel() failed!\n");301return false;302}303}304return true;305}306307cl_mem alloc_read_buffer(size_t size)308{309cl_serializer serializer(this);310311cl_int ret;312cl_mem obj = clCreateBuffer(m_context, CL_MEM_READ_ONLY, size, NULL, &ret);313if (ret != CL_SUCCESS)314{315ocl_error_printf("ocl::alloc_read_buffer: clCreateBuffer() failed!\n");316return nullptr;317}318319return obj;320}321322cl_mem alloc_and_init_read_buffer(cl_command_queue command_queue, const void *pInit, size_t size)323{324cl_serializer serializer(this);325326cl_int ret;327cl_mem obj = clCreateBuffer(m_context, CL_MEM_READ_ONLY, size, NULL, &ret);328if (ret != CL_SUCCESS)329{330ocl_error_printf("ocl::alloc_and_init_read_buffer: clCreateBuffer() failed!\n");331return nullptr;332}333334#if 0335if (!write_to_buffer(command_queue, obj, pInit, size))336{337destroy_buffer(obj);338return nullptr;339}340#else341ret = clEnqueueWriteBuffer(command_queue, obj, CL_TRUE, 0, size, pInit, 0, NULL, NULL);342if (ret != CL_SUCCESS)343{344ocl_error_printf("ocl::alloc_and_init_read_buffer: clEnqueueWriteBuffer() failed!\n");345return nullptr;346}347#endif348349return obj;350}351352cl_mem alloc_write_buffer(size_t size)353{354cl_serializer serializer(this);355356cl_int ret;357cl_mem obj = clCreateBuffer(m_context, CL_MEM_WRITE_ONLY, size, NULL, &ret);358if (ret != CL_SUCCESS)359{360ocl_error_printf("ocl::alloc_write_buffer: clCreateBuffer() failed!\n");361return nullptr;362}363364return obj;365}366367bool destroy_buffer(cl_mem buf)368{369if (buf)370{371cl_serializer serializer(this);372373cl_int ret = clReleaseMemObject(buf);374if (ret != CL_SUCCESS)375{376ocl_error_printf("ocl::destroy_buffer: clReleaseMemObject() failed!\n");377return false;378}379}380381return true;382}383384bool write_to_buffer(cl_command_queue command_queue, cl_mem clmem, const void* d, const size_t m)385{386cl_serializer serializer(this);387388cl_int ret = clEnqueueWriteBuffer(command_queue, clmem, CL_TRUE, 0, m, d, 0, NULL, NULL);389if (ret != CL_SUCCESS)390{391ocl_error_printf("ocl::write_to_buffer: clEnqueueWriteBuffer() failed!\n");392return false;393}394395return true;396}397398bool read_from_buffer(cl_command_queue command_queue, const cl_mem clmem, void* d, size_t m)399{400cl_serializer serializer(this);401402cl_int ret = clEnqueueReadBuffer(command_queue, clmem, CL_TRUE, 0, m, d, 0, NULL, NULL);403if (ret != CL_SUCCESS)404{405ocl_error_printf("ocl::read_from_buffer: clEnqueueReadBuffer() failed!\n");406return false;407}408409return true;410}411412cl_mem create_read_image_u8(uint32_t width, uint32_t height, const void* pPixels, uint32_t bytes_per_pixel, bool normalized)413{414cl_image_format fmt = get_image_format(bytes_per_pixel, normalized);415416cl_image_desc desc;417memset(&desc, 0, sizeof(desc));418desc.image_type = CL_MEM_OBJECT_IMAGE2D;419desc.image_width = width;420desc.image_height = height;421desc.image_row_pitch = width * bytes_per_pixel;422423cl_serializer serializer(this);424425cl_int ret;426cl_mem img = clCreateImage(m_context, CL_MEM_READ_ONLY | CL_MEM_COPY_HOST_PTR, &fmt, &desc, (void*)pPixels, &ret);427if (ret != CL_SUCCESS)428{429ocl_error_printf("ocl::create_read_image_u8: clCreateImage() failed!\n");430return nullptr;431}432433return img;434}435436cl_mem create_write_image_u8(uint32_t width, uint32_t height, uint32_t bytes_per_pixel, bool normalized)437{438cl_image_format fmt = get_image_format(bytes_per_pixel, normalized);439440cl_image_desc desc;441memset(&desc, 0, sizeof(desc));442desc.image_type = CL_MEM_OBJECT_IMAGE2D;443desc.image_width = width;444desc.image_height = height;445446cl_serializer serializer(this);447448cl_int ret;449cl_mem img = clCreateImage(m_context, CL_MEM_WRITE_ONLY, &fmt, &desc, nullptr, &ret);450if (ret != CL_SUCCESS)451{452ocl_error_printf("ocl::create_write_image_u8: clCreateImage() failed!\n");453return nullptr;454}455456return img;457}458459bool read_from_image(cl_command_queue command_queue, cl_mem img, void* pPixels, uint32_t ofs_x, uint32_t ofs_y, uint32_t width, uint32_t height)460{461cl_serializer serializer(this);462463size_t origin[3] = { ofs_x, ofs_y, 0 }, region[3] = { width, height, 1 };464465cl_int err = clEnqueueReadImage(command_queue, img, CL_TRUE, origin, region, 0, 0, pPixels, 0, NULL, NULL);466if (err != CL_SUCCESS)467{468ocl_error_printf("ocl::read_from_image: clEnqueueReadImage() failed!\n");469return false;470}471472return true;473}474475bool run_1D(cl_command_queue command_queue, const cl_kernel kernel, size_t num_items)476{477cl_serializer serializer(this);478479cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,4801, // work_dim481nullptr, // global_work_offset482&num_items, // global_work_size483nullptr, // local_work_size4840, // num_events_in_wait_list485nullptr, // event_wait_list486nullptr // event487);488489if (ret != CL_SUCCESS)490{491ocl_error_printf("ocl::run_1D: clEnqueueNDRangeKernel() failed!\n");492return false;493}494495return true;496}497498bool run_2D(cl_command_queue command_queue, const cl_kernel kernel, size_t width, size_t height)499{500cl_serializer serializer(this);501502size_t num_global_items[2] = { width, height };503//size_t num_local_items[2] = { 1, 1 };504505cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,5062, // work_dim507nullptr, // global_work_offset508num_global_items, // global_work_size509nullptr, // local_work_size5100, // num_events_in_wait_list511nullptr, // event_wait_list512nullptr // event513);514515if (ret != CL_SUCCESS)516{517ocl_error_printf("ocl::run_2D: clEnqueueNDRangeKernel() failed!\n");518return false;519}520521return true;522}523524bool run_2D(cl_command_queue command_queue, const cl_kernel kernel, size_t ofs_x, size_t ofs_y, size_t width, size_t height)525{526cl_serializer serializer(this);527528size_t global_ofs[2] = { ofs_x, ofs_y };529size_t num_global_items[2] = { width, height };530//size_t num_local_items[2] = { 1, 1 };531532cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,5332, // work_dim534global_ofs, // global_work_offset535num_global_items, // global_work_size536nullptr, // local_work_size5370, // num_events_in_wait_list538nullptr, // event_wait_list539nullptr // event540);541542if (ret != CL_SUCCESS)543{544ocl_error_printf("ocl::run_2D: clEnqueueNDRangeKernel() failed!\n");545return false;546}547548return true;549}550551void flush(cl_command_queue command_queue)552{553cl_serializer serializer(this);554555clFlush(command_queue);556clFinish(command_queue);557}558559template<typename T>560bool set_kernel_arg(cl_kernel kernel, uint32_t index, const T& obj)561{562cl_serializer serializer(this);563564cl_int ret = clSetKernelArg(kernel, index, sizeof(T), (void*)&obj);565if (ret != CL_SUCCESS)566{567ocl_error_printf("ocl::set_kernel_arg: clSetKernelArg() failed!\n");568return false;569}570return true;571}572573template<typename T>574bool set_kernel_args(cl_kernel kernel, const T& obj1)575{576cl_serializer serializer(this);577578cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1);579if (ret != CL_SUCCESS)580{581ocl_error_printf("ocl::set_kernel_arg: clSetKernelArg() failed!\n");582return false;583}584return true;585}586587#define BASISU_CHECK_ERR if (ret != CL_SUCCESS) { ocl_error_printf("ocl::set_kernel_args: clSetKernelArg() failed!\n"); return false; }588589template<typename T, typename U>590bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2)591{592cl_serializer serializer(this);593cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR594ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR595return true;596}597598template<typename T, typename U, typename V>599bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3)600{601cl_serializer serializer(this);602cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR603ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR604ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR605return true;606}607608template<typename T, typename U, typename V, typename W>609bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4)610{611cl_serializer serializer(this);612cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR613ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR614ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR615ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR616return true;617}618619template<typename T, typename U, typename V, typename W, typename X>620bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5)621{622cl_serializer serializer(this);623cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR624ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR625ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR626ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR627ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR628return true;629}630631template<typename T, typename U, typename V, typename W, typename X, typename Y>632bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5, const Y& obj6)633{634cl_serializer serializer(this);635cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR636ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR637ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR638ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR639ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR640ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR641return true;642}643644template<typename T, typename U, typename V, typename W, typename X, typename Y, typename Z>645bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5, const Y& obj6, const Z& obj7)646{647cl_serializer serializer(this);648cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR649ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR650ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR651ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR652ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR653ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR654ret = clSetKernelArg(kernel, 6, sizeof(Z), (void*)&obj7); BASISU_CHECK_ERR655return true;656}657658template<typename T, typename U, typename V, typename W, typename X, typename Y, typename Z, typename A>659bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5, const Y& obj6, const Z& obj7, const A& obj8)660{661cl_serializer serializer(this);662cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR663ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR664ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR665ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR666ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR667ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR668ret = clSetKernelArg(kernel, 6, sizeof(Z), (void*)&obj7); BASISU_CHECK_ERR669ret = clSetKernelArg(kernel, 7, sizeof(A), (void*)&obj8); BASISU_CHECK_ERR670return true;671}672#undef BASISU_CHECK_ERR673674private:675cl_device_id m_device_id = nullptr;676cl_context m_context = nullptr;677cl_command_queue m_command_queue = nullptr;678cl_program m_program = nullptr;679cl_device_fp_config m_dev_fp_config;680681bool m_use_mutex = false;682std::mutex m_ocl_mutex;683684// This helper object is used to optionally serialize all calls to the CL driver after initialization.685// Currently this is only used to work around race conditions in the Windows AMD driver.686struct cl_serializer687{688inline cl_serializer(const cl_serializer&);689cl_serializer& operator= (const cl_serializer&);690691inline cl_serializer(ocl *p) : m_p(p)692{693if (m_p->m_use_mutex)694m_p->m_ocl_mutex.lock();695}696697inline ~cl_serializer()698{699if (m_p->m_use_mutex)700m_p->m_ocl_mutex.unlock();701}702703private:704ocl* m_p;705};706707cl_image_format get_image_format(uint32_t bytes_per_pixel, bool normalized)708{709cl_image_format fmt;710switch (bytes_per_pixel)711{712case 1: fmt.image_channel_order = CL_LUMINANCE; break;713case 2: fmt.image_channel_order = CL_RG; break;714case 3: fmt.image_channel_order = CL_RGB; break;715case 4: fmt.image_channel_order = CL_RGBA; break;716default: assert(0); fmt.image_channel_order = CL_LUMINANCE; break;717}718719fmt.image_channel_data_type = normalized ? CL_UNORM_INT8 : CL_UNSIGNED_INT8;720return fmt;721}722};723724// Library blobal state725ocl g_ocl;726727bool opencl_init(bool force_serialization)728{729if (g_ocl.is_initialized())730{731assert(0);732return false;733}734735if (!g_ocl.init(force_serialization))736{737ocl_error_printf("opencl_init: Failed initializing OpenCL\n");738return false;739}740741const char* pKernel_src = nullptr;742size_t kernel_src_size = 0;743uint8_vec kernel_src;744745#if BASISU_USE_OCL_KERNELS_HEADER746pKernel_src = reinterpret_cast<const char*>(ocl_kernels_cl);747kernel_src_size = ocl_kernels_cl_len;748#else749if (!read_file_to_vec(BASISU_OCL_KERNELS_FILENAME, kernel_src))750{751ocl_error_printf("opencl_init: Cannot read OpenCL kernel source file \"%s\"\n", BASISU_OCL_KERNELS_FILENAME);752g_ocl.deinit();753return false;754}755756pKernel_src = (char*)kernel_src.data();757kernel_src_size = kernel_src.size();758#endif759760if (!kernel_src_size)761{762ocl_error_printf("opencl_init: Invalid OpenCL kernel source file \"%s\"\n", BASISU_OCL_KERNELS_FILENAME);763g_ocl.deinit();764return false;765}766767if (!g_ocl.init_program(pKernel_src, kernel_src_size))768{769ocl_error_printf("opencl_init: Failed compiling OpenCL program\n");770g_ocl.deinit();771return false;772}773774printf("OpenCL support initialized successfully\n");775776return true;777}778779void opencl_deinit()780{781g_ocl.deinit();782}783784bool opencl_is_available()785{786return g_ocl.is_initialized();787}788789struct opencl_context790{791size_t m_ocl_total_pixel_blocks;792cl_mem m_ocl_pixel_blocks;793794cl_command_queue m_command_queue;795796cl_kernel m_ocl_encode_etc1s_blocks_kernel;797cl_kernel m_ocl_refine_endpoint_clusterization_kernel;798cl_kernel m_ocl_encode_etc1s_from_pixel_cluster_kernel;799cl_kernel m_ocl_find_optimal_selector_clusters_for_each_block_kernel;800cl_kernel m_ocl_determine_selectors_kernel;801};802803opencl_context_ptr opencl_create_context()804{805if (!opencl_is_available())806{807ocl_error_printf("opencl_create_context: OpenCL not initialized\n");808assert(0);809return nullptr;810}811812interval_timer tm;813tm.start();814815opencl_context* pContext = static_cast<opencl_context * >(calloc(sizeof(opencl_context), 1));816if (!pContext)817return nullptr;818819// To avoid driver bugs in some drivers - serialize this. Likely not necessary, we don't know.820// https://community.intel.com/t5/OpenCL-for-CPU/Bug-report-clCreateKernelsInProgram-is-not-thread-safe/td-p/1159771821822pContext->m_command_queue = g_ocl.create_command_queue();823if (!pContext->m_command_queue)824{825ocl_error_printf("opencl_create_context: Failed creating OpenCL command queue!\n");826opencl_destroy_context(pContext);827return nullptr;828}829830pContext->m_ocl_encode_etc1s_blocks_kernel = g_ocl.create_kernel("encode_etc1s_blocks");831if (!pContext->m_ocl_encode_etc1s_blocks_kernel)832{833ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel encode_etc1s_block\n");834opencl_destroy_context(pContext);835return nullptr;836}837838pContext->m_ocl_refine_endpoint_clusterization_kernel = g_ocl.create_kernel("refine_endpoint_clusterization");839if (!pContext->m_ocl_refine_endpoint_clusterization_kernel)840{841ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel refine_endpoint_clusterization\n");842opencl_destroy_context(pContext);843return nullptr;844}845846pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel = g_ocl.create_kernel("encode_etc1s_from_pixel_cluster");847if (!pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel)848{849ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel encode_etc1s_from_pixel_cluster\n");850opencl_destroy_context(pContext);851return nullptr;852}853854pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel = g_ocl.create_kernel("find_optimal_selector_clusters_for_each_block");855if (!pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel)856{857ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel find_optimal_selector_clusters_for_each_block\n");858opencl_destroy_context(pContext);859return nullptr;860}861862pContext->m_ocl_determine_selectors_kernel = g_ocl.create_kernel("determine_selectors");863if (!pContext->m_ocl_determine_selectors_kernel)864{865ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel determine_selectors\n");866opencl_destroy_context(pContext);867return nullptr;868}869870debug_printf("opencl_create_context: Elapsed time: %f secs\n", tm.get_elapsed_secs());871872return pContext;873}874875void opencl_destroy_context(opencl_context_ptr pContext)876{877if (!pContext)878return;879880interval_timer tm;881tm.start();882883g_ocl.destroy_buffer(pContext->m_ocl_pixel_blocks);884885g_ocl.destroy_kernel(pContext->m_ocl_determine_selectors_kernel);886g_ocl.destroy_kernel(pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel);887g_ocl.destroy_kernel(pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel);888g_ocl.destroy_kernel(pContext->m_ocl_encode_etc1s_blocks_kernel);889g_ocl.destroy_kernel(pContext->m_ocl_refine_endpoint_clusterization_kernel);890891g_ocl.destroy_command_queue(pContext->m_command_queue);892893memset(pContext, 0, sizeof(opencl_context));894895free(pContext);896897debug_printf("opencl_destroy_context: Elapsed time: %f secs\n", tm.get_elapsed_secs());898}899900#pragma pack(push, 1)901struct cl_encode_etc1s_param_struct902{903int m_total_blocks;904int m_perceptual;905int m_total_perms;906};907#pragma pack(pop)908909bool opencl_set_pixel_blocks(opencl_context_ptr pContext, size_t total_blocks, const cl_pixel_block* pPixel_blocks)910{911if (!opencl_is_available())912return false;913914if (pContext->m_ocl_pixel_blocks)915{916g_ocl.destroy_buffer(pContext->m_ocl_pixel_blocks);917pContext->m_ocl_pixel_blocks = nullptr;918}919920pContext->m_ocl_pixel_blocks = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixel_blocks, sizeof(cl_pixel_block) * total_blocks);921if (!pContext->m_ocl_pixel_blocks)922return false;923924pContext->m_ocl_total_pixel_blocks = total_blocks;925926return true;927}928929bool opencl_encode_etc1s_blocks(opencl_context_ptr pContext, etc_block* pOutput_blocks, bool perceptual, uint32_t total_perms)930{931if (!opencl_is_available())932return false;933934interval_timer tm;935tm.start();936937assert(pContext->m_ocl_pixel_blocks);938if (!pContext->m_ocl_pixel_blocks)939return false;940941assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);942943cl_encode_etc1s_param_struct ps;944ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;945ps.m_perceptual = perceptual;946ps.m_total_perms = total_perms;947948bool status = false;949950cl_mem vars = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue , &ps, sizeof(ps));951cl_mem block_buf = g_ocl.alloc_write_buffer(sizeof(etc_block) * pContext->m_ocl_total_pixel_blocks);952953if (!vars || !block_buf)954goto exit;955956if (!g_ocl.set_kernel_args(pContext->m_ocl_encode_etc1s_blocks_kernel, vars, pContext->m_ocl_pixel_blocks, block_buf))957goto exit;958959if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_encode_etc1s_blocks_kernel, pContext->m_ocl_total_pixel_blocks, 1))960goto exit;961962if (!g_ocl.read_from_buffer(pContext->m_command_queue, block_buf, pOutput_blocks, pContext->m_ocl_total_pixel_blocks * sizeof(etc_block)))963goto exit;964965status = true;966967debug_printf("opencl_encode_etc1s_blocks: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());968969exit:970g_ocl.destroy_buffer(block_buf);971g_ocl.destroy_buffer(vars);972973return status;974}975976bool opencl_encode_etc1s_pixel_clusters(977opencl_context_ptr pContext,978etc_block* pOutput_blocks,979uint32_t total_clusters,980const cl_pixel_cluster* pClusters,981uint64_t total_pixels,982const color_rgba* pPixels, const uint32_t* pPixel_weights,983bool perceptual, uint32_t total_perms)984{985if (!opencl_is_available())986return false;987988interval_timer tm;989tm.start();990991cl_encode_etc1s_param_struct ps;992ps.m_total_blocks = total_clusters;993ps.m_perceptual = perceptual;994ps.m_total_perms = total_perms;995996bool status = false;997998if (sizeof(size_t) == sizeof(uint32_t))999{1000if ( ((sizeof(cl_pixel_cluster) * total_clusters) > UINT32_MAX) ||1001((sizeof(color_rgba) * total_pixels) > UINT32_MAX) ||1002((sizeof(uint32_t) * total_pixels) > UINT32_MAX) )1003{1004return false;1005}1006}10071008cl_mem vars = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue , &ps, sizeof(ps));1009cl_mem input_clusters = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pClusters, (size_t)(sizeof(cl_pixel_cluster) * total_clusters));1010cl_mem input_pixels = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixels, (size_t)(sizeof(color_rgba) * total_pixels));1011cl_mem weights_buf = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixel_weights, (size_t)(sizeof(uint32_t) * total_pixels));1012cl_mem block_buf = g_ocl.alloc_write_buffer(sizeof(etc_block) * total_clusters);10131014if (!vars || !input_clusters || !input_pixels || !weights_buf || !block_buf)1015goto exit;10161017if (!g_ocl.set_kernel_args(pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel, vars, input_clusters, input_pixels, weights_buf, block_buf))1018goto exit;10191020if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel, total_clusters, 1))1021goto exit;10221023if (!g_ocl.read_from_buffer(pContext->m_command_queue, block_buf, pOutput_blocks, sizeof(etc_block) * total_clusters))1024goto exit;10251026status = true;10271028debug_printf("opencl_encode_etc1s_pixel_clusters: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());10291030exit:1031g_ocl.destroy_buffer(block_buf);1032g_ocl.destroy_buffer(weights_buf);1033g_ocl.destroy_buffer(input_pixels);1034g_ocl.destroy_buffer(input_clusters);1035g_ocl.destroy_buffer(vars);10361037return status;1038}10391040#pragma pack(push, 1)1041struct cl_rec_param_struct1042{1043int m_total_blocks;1044int m_perceptual;1045};1046#pragma pack(pop)10471048bool opencl_refine_endpoint_clusterization(1049opencl_context_ptr pContext,1050const cl_block_info_struct* pPixel_block_info,1051uint32_t total_clusters,1052const cl_endpoint_cluster_struct* pCluster_info,1053const uint32_t* pSorted_block_indices,1054uint32_t* pOutput_cluster_indices,1055bool perceptual)1056{1057if (!opencl_is_available())1058return false;10591060interval_timer tm;1061tm.start();10621063assert(pContext->m_ocl_pixel_blocks);1064if (!pContext->m_ocl_pixel_blocks)1065return false;10661067assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);10681069cl_rec_param_struct ps;1070ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1071ps.m_perceptual = perceptual;10721073bool status = false;10741075cl_mem pixel_block_info = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixel_block_info, sizeof(cl_block_info_struct) * pContext->m_ocl_total_pixel_blocks);1076cl_mem cluster_info = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pCluster_info, sizeof(cl_endpoint_cluster_struct) * total_clusters);1077cl_mem sorted_block_indices = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pSorted_block_indices, sizeof(uint32_t) * pContext->m_ocl_total_pixel_blocks);1078cl_mem output_buf = g_ocl.alloc_write_buffer(sizeof(uint32_t) * pContext->m_ocl_total_pixel_blocks);10791080if (!pixel_block_info || !cluster_info || !sorted_block_indices || !output_buf)1081goto exit;10821083if (!g_ocl.set_kernel_args(pContext->m_ocl_refine_endpoint_clusterization_kernel, ps, pContext->m_ocl_pixel_blocks, pixel_block_info, cluster_info, sorted_block_indices, output_buf))1084goto exit;10851086if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_refine_endpoint_clusterization_kernel, pContext->m_ocl_total_pixel_blocks, 1))1087goto exit;10881089if (!g_ocl.read_from_buffer(pContext->m_command_queue, output_buf, pOutput_cluster_indices, pContext->m_ocl_total_pixel_blocks * sizeof(uint32_t)))1090goto exit;10911092debug_printf("opencl_refine_endpoint_clusterization: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());10931094status = true;10951096exit:1097g_ocl.destroy_buffer(pixel_block_info);1098g_ocl.destroy_buffer(cluster_info);1099g_ocl.destroy_buffer(sorted_block_indices);1100g_ocl.destroy_buffer(output_buf);11011102return status;1103}11041105bool opencl_find_optimal_selector_clusters_for_each_block(1106opencl_context_ptr pContext,1107const fosc_block_struct* pInput_block_info, // one per block1108uint32_t total_input_selectors,1109const fosc_selector_struct* pInput_selectors,1110const uint32_t* pSelector_cluster_indices,1111uint32_t* pOutput_selector_cluster_indices, // one per block1112bool perceptual)1113{1114if (!opencl_is_available())1115return false;11161117interval_timer tm;1118tm.start();11191120assert(pContext->m_ocl_pixel_blocks);1121if (!pContext->m_ocl_pixel_blocks)1122return false;11231124assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);11251126fosc_param_struct ps;1127ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1128ps.m_perceptual = perceptual;11291130bool status = false;11311132cl_mem input_block_info = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pInput_block_info, sizeof(fosc_block_struct) * pContext->m_ocl_total_pixel_blocks);1133cl_mem input_selectors = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pInput_selectors, sizeof(fosc_selector_struct) * total_input_selectors);1134cl_mem selector_cluster_indices = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pSelector_cluster_indices, sizeof(uint32_t) * total_input_selectors);1135cl_mem output_selector_cluster_indices = g_ocl.alloc_write_buffer(sizeof(uint32_t) * pContext->m_ocl_total_pixel_blocks);11361137if (!input_block_info || !input_selectors || !selector_cluster_indices || !output_selector_cluster_indices)1138goto exit;11391140if (!g_ocl.set_kernel_args(pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel, ps, pContext->m_ocl_pixel_blocks, input_block_info, input_selectors, selector_cluster_indices, output_selector_cluster_indices))1141goto exit;11421143if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel, pContext->m_ocl_total_pixel_blocks, 1))1144goto exit;11451146if (!g_ocl.read_from_buffer(pContext->m_command_queue, output_selector_cluster_indices, pOutput_selector_cluster_indices, pContext->m_ocl_total_pixel_blocks * sizeof(uint32_t)))1147goto exit;11481149debug_printf("opencl_find_optimal_selector_clusters_for_each_block: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());11501151status = true;11521153exit:1154g_ocl.destroy_buffer(input_block_info);1155g_ocl.destroy_buffer(input_selectors);1156g_ocl.destroy_buffer(selector_cluster_indices);1157g_ocl.destroy_buffer(output_selector_cluster_indices);11581159return status;1160}11611162bool opencl_determine_selectors(1163opencl_context_ptr pContext,1164const color_rgba* pInput_etc_color5_and_inten,1165etc_block* pOutput_blocks,1166bool perceptual)1167{1168if (!opencl_is_available())1169return false;11701171interval_timer tm;1172tm.start();11731174assert(pContext->m_ocl_pixel_blocks);1175if (!pContext->m_ocl_pixel_blocks)1176return false;11771178assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);11791180ds_param_struct ps;1181ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1182ps.m_perceptual = perceptual;11831184bool status = false;11851186cl_mem input_etc_color5_intens = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pInput_etc_color5_and_inten, sizeof(color_rgba) * pContext->m_ocl_total_pixel_blocks);1187cl_mem output_blocks = g_ocl.alloc_write_buffer(sizeof(etc_block) * pContext->m_ocl_total_pixel_blocks);11881189if (!input_etc_color5_intens || !output_blocks)1190goto exit;11911192if (!g_ocl.set_kernel_args(pContext->m_ocl_determine_selectors_kernel, ps, pContext->m_ocl_pixel_blocks, input_etc_color5_intens, output_blocks))1193goto exit;11941195if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_determine_selectors_kernel, pContext->m_ocl_total_pixel_blocks, 1))1196goto exit;11971198if (!g_ocl.read_from_buffer(pContext->m_command_queue, output_blocks, pOutput_blocks, pContext->m_ocl_total_pixel_blocks * sizeof(etc_block)))1199goto exit;12001201debug_printf("opencl_determine_selectors: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());12021203status = true;12041205exit:1206g_ocl.destroy_buffer(input_etc_color5_intens);1207g_ocl.destroy_buffer(output_blocks);12081209return status;1210}12111212#else1213namespace basisu1214{1215// No OpenCL support - all dummy functions that return false;1216bool opencl_init(bool force_serialization)1217{1218BASISU_NOTE_UNUSED(force_serialization);12191220return false;1221}12221223void opencl_deinit()1224{1225}12261227bool opencl_is_available()1228{1229return false;1230}12311232opencl_context_ptr opencl_create_context()1233{1234return nullptr;1235}12361237void opencl_destroy_context(opencl_context_ptr context)1238{1239BASISU_NOTE_UNUSED(context);1240}12411242bool opencl_set_pixel_blocks(opencl_context_ptr pContext, size_t total_blocks, const cl_pixel_block* pPixel_blocks)1243{1244BASISU_NOTE_UNUSED(pContext);1245BASISU_NOTE_UNUSED(total_blocks);1246BASISU_NOTE_UNUSED(pPixel_blocks);12471248return false;1249}12501251bool opencl_encode_etc1s_blocks(opencl_context_ptr pContext, etc_block* pOutput_blocks, bool perceptual, uint32_t total_perms)1252{1253BASISU_NOTE_UNUSED(pContext);1254BASISU_NOTE_UNUSED(pOutput_blocks);1255BASISU_NOTE_UNUSED(perceptual);1256BASISU_NOTE_UNUSED(total_perms);12571258return false;1259}12601261bool opencl_encode_etc1s_pixel_clusters(1262opencl_context_ptr pContext,1263etc_block* pOutput_blocks,1264uint32_t total_clusters,1265const cl_pixel_cluster* pClusters,1266uint64_t total_pixels,1267const color_rgba* pPixels, const uint32_t *pPixel_weights,1268bool perceptual, uint32_t total_perms)1269{1270BASISU_NOTE_UNUSED(pContext);1271BASISU_NOTE_UNUSED(pOutput_blocks);1272BASISU_NOTE_UNUSED(total_clusters);1273BASISU_NOTE_UNUSED(pClusters);1274BASISU_NOTE_UNUSED(total_pixels);1275BASISU_NOTE_UNUSED(pPixels);1276BASISU_NOTE_UNUSED(pPixel_weights);1277BASISU_NOTE_UNUSED(perceptual);1278BASISU_NOTE_UNUSED(total_perms);12791280return false;1281}12821283bool opencl_refine_endpoint_clusterization(1284opencl_context_ptr pContext,1285const cl_block_info_struct* pPixel_block_info,1286uint32_t total_clusters,1287const cl_endpoint_cluster_struct* pCluster_info,1288const uint32_t* pSorted_block_indices,1289uint32_t* pOutput_cluster_indices,1290bool perceptual)1291{1292BASISU_NOTE_UNUSED(pContext);1293BASISU_NOTE_UNUSED(pPixel_block_info);1294BASISU_NOTE_UNUSED(total_clusters);1295BASISU_NOTE_UNUSED(pCluster_info);1296BASISU_NOTE_UNUSED(pSorted_block_indices);1297BASISU_NOTE_UNUSED(pOutput_cluster_indices);1298BASISU_NOTE_UNUSED(perceptual);12991300return false;1301}13021303bool opencl_find_optimal_selector_clusters_for_each_block(1304opencl_context_ptr pContext,1305const fosc_block_struct* pInput_block_info, // one per block1306uint32_t total_input_selectors,1307const fosc_selector_struct* pInput_selectors,1308const uint32_t* pSelector_cluster_indices,1309uint32_t* pOutput_selector_cluster_indices, // one per block1310bool perceptual)1311{1312BASISU_NOTE_UNUSED(pContext);1313BASISU_NOTE_UNUSED(pInput_block_info);1314BASISU_NOTE_UNUSED(total_input_selectors);1315BASISU_NOTE_UNUSED(pInput_selectors);1316BASISU_NOTE_UNUSED(pSelector_cluster_indices);1317BASISU_NOTE_UNUSED(pOutput_selector_cluster_indices);1318BASISU_NOTE_UNUSED(perceptual);13191320return false;1321}13221323bool opencl_determine_selectors(1324opencl_context_ptr pContext,1325const color_rgba* pInput_etc_color5_and_inten,1326etc_block* pOutput_blocks,1327bool perceptual)1328{1329BASISU_NOTE_UNUSED(pContext);1330BASISU_NOTE_UNUSED(pInput_etc_color5_and_inten);1331BASISU_NOTE_UNUSED(pOutput_blocks);1332BASISU_NOTE_UNUSED(perceptual);13331334return false;1335}13361337#endif // BASISU_SUPPORT_OPENCL13381339} // namespace basisu134013411342