Path: blob/master/thirdparty/basis_universal/encoder/basisu_opencl.cpp
20897 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#ifndef BASISU_OPENCL_ASSERT_ON_ANY_ERRORS34#define BASISU_OPENCL_ASSERT_ON_ANY_ERRORS (0)35#endif3637namespace basisu38{39#if BASISU_USE_OCL_KERNELS_HEADER40#include "basisu_ocl_kernels.h"41#endif4243static void ocl_error_printf(const char* pFmt, ...)44{45va_list args;46va_start(args, pFmt);47error_vprintf(pFmt, args);48va_end(args);4950#if BASISU_OPENCL_ASSERT_ON_ANY_ERRORS51assert(0);52#endif53}5455class ocl56{57public:58ocl()59{60memset(&m_dev_fp_config, 0, sizeof(m_dev_fp_config));6162m_ocl_mutex.lock();63m_ocl_mutex.unlock();64}6566~ocl()67{68}6970bool is_initialized() const { return m_device_id != nullptr; }7172cl_device_id get_device_id() const { return m_device_id; }73cl_context get_context() const { return m_context; }74cl_command_queue get_command_queue() { return m_command_queue; }75cl_program get_program() const { return m_program; }7677bool init(bool force_serialization)78{79deinit();8081interval_timer tm;82tm.start();8384cl_uint num_platforms = 0;85cl_int ret = clGetPlatformIDs(0, NULL, &num_platforms);86if (ret != CL_SUCCESS)87{88ocl_error_printf("ocl::init: clGetPlatformIDs() failed with %i\n", ret);89return false;90}9192if ((!num_platforms) || (num_platforms > INT_MAX))93{94ocl_error_printf("ocl::init: clGetPlatformIDs() returned an invalid number of num_platforms\n");95return false;96}9798std::vector<cl_platform_id> platforms(num_platforms);99100ret = clGetPlatformIDs(num_platforms, platforms.data(), NULL);101if (ret != CL_SUCCESS)102{103ocl_error_printf("ocl::init: clGetPlatformIDs() failed\n");104return false;105}106107cl_uint num_devices = 0;108ret = clGetDeviceIDs(platforms[0], CL_DEVICE_TYPE_GPU, 1, &m_device_id, &num_devices);109110if (ret == CL_DEVICE_NOT_FOUND)111{112ocl_error_printf("ocl::init: Couldn't get any GPU device ID's, trying CL_DEVICE_TYPE_CPU\n");113114ret = clGetDeviceIDs(platforms[0], CL_DEVICE_TYPE_CPU, 1, &m_device_id, &num_devices);115}116117if (ret != CL_SUCCESS)118{119ocl_error_printf("ocl::init: Unable to get any device ID's\n");120121m_device_id = nullptr;122return false;123}124125ret = clGetDeviceInfo(m_device_id,126CL_DEVICE_SINGLE_FP_CONFIG,127sizeof(m_dev_fp_config),128&m_dev_fp_config,129nullptr);130if (ret != CL_SUCCESS)131{132ocl_error_printf("ocl::init: clGetDeviceInfo() failed\n");133return false;134}135136char plat_vers[256];137size_t rv = 0;138ret = clGetPlatformInfo(platforms[0], CL_PLATFORM_VERSION, sizeof(plat_vers), plat_vers, &rv);139if (ret == CL_SUCCESS)140printf("OpenCL platform version: \"%s\"\n", plat_vers);141142// 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?143m_use_mutex = (strstr(plat_vers, "AMD") != nullptr) || force_serialization;144145printf("Serializing OpenCL calls across threads: %u\n", (uint32_t)m_use_mutex);146147m_context = clCreateContext(nullptr, 1, &m_device_id, nullptr, nullptr, &ret);148if (ret != CL_SUCCESS)149{150ocl_error_printf("ocl::init: clCreateContext() failed\n");151152m_device_id = nullptr;153m_context = nullptr;154return false;155}156157m_command_queue = clCreateCommandQueue(m_context, m_device_id, 0, &ret);158if (ret != CL_SUCCESS)159{160ocl_error_printf("ocl::init: clCreateCommandQueue() failed\n");161162deinit();163return false;164}165166printf("OpenCL init time: %3.3f secs\n", tm.get_elapsed_secs());167168return true;169}170171bool deinit()172{173if (m_program)174{175clReleaseProgram(m_program);176m_program = nullptr;177}178179if (m_command_queue)180{181clReleaseCommandQueue(m_command_queue);182m_command_queue = nullptr;183}184185if (m_context)186{187clReleaseContext(m_context);188m_context = nullptr;189}190191m_device_id = nullptr;192193return true;194}195196cl_command_queue create_command_queue()197{198cl_serializer serializer(this);199200cl_int ret = 0;201cl_command_queue p = clCreateCommandQueue(m_context, m_device_id, 0, &ret);202if (ret != CL_SUCCESS)203return nullptr;204205return p;206}207208void destroy_command_queue(cl_command_queue p)209{210if (p)211{212cl_serializer serializer(this);213214clReleaseCommandQueue(p);215}216}217218bool init_program(const char* pSrc, size_t src_size)219{220cl_int ret;221222if (m_program != nullptr)223{224clReleaseProgram(m_program);225m_program = nullptr;226}227228m_program = clCreateProgramWithSource(m_context, 1, (const char**)&pSrc, (const size_t*)&src_size, &ret);229if (ret != CL_SUCCESS)230{231ocl_error_printf("ocl::init_program: clCreateProgramWithSource() failed!\n");232return false;233}234235std::string options;236if (m_dev_fp_config & CL_FP_CORRECTLY_ROUNDED_DIVIDE_SQRT)237{238options += "-cl-fp32-correctly-rounded-divide-sqrt";239}240241options += " -cl-std=CL1.2";242//options += " -cl-opt-disable";243//options += " -cl-mad-enable";244//options += " -cl-fast-relaxed-math";245246ret = clBuildProgram(m_program, 1, &m_device_id,247options.size() ? options.c_str() : nullptr, // options248nullptr, // notify249nullptr); // user_data250251if (ret != CL_SUCCESS)252{253const cl_int build_program_result = ret;254255size_t ret_val_size;256ret = clGetProgramBuildInfo(m_program, m_device_id, CL_PROGRAM_BUILD_LOG, 0, NULL, &ret_val_size);257if (ret != CL_SUCCESS)258{259ocl_error_printf("ocl::init_program: clGetProgramBuildInfo() failed!\n");260return false;261}262263std::vector<char> build_log(ret_val_size + 1);264265ret = clGetProgramBuildInfo(m_program, m_device_id, CL_PROGRAM_BUILD_LOG, ret_val_size, build_log.data(), NULL);266267ocl_error_printf("\nclBuildProgram() failed with error %i:\n%s", build_program_result, build_log.data());268269return false;270}271272return true;273}274275cl_kernel create_kernel(const char* pName)276{277if (!m_program)278return nullptr;279280cl_serializer serializer(this);281282cl_int ret;283cl_kernel kernel = clCreateKernel(m_program, pName, &ret);284if (ret != CL_SUCCESS)285{286ocl_error_printf("ocl::create_kernel: clCreateKernel() failed!\n");287return nullptr;288}289290return kernel;291}292293bool destroy_kernel(cl_kernel k)294{295if (k)296{297cl_serializer serializer(this);298299cl_int ret = clReleaseKernel(k);300if (ret != CL_SUCCESS)301{302ocl_error_printf("ocl::destroy_kernel: clReleaseKernel() failed!\n");303return false;304}305}306return true;307}308309cl_mem alloc_read_buffer(size_t size)310{311cl_serializer serializer(this);312313cl_int ret;314cl_mem obj = clCreateBuffer(m_context, CL_MEM_READ_ONLY, size, NULL, &ret);315if (ret != CL_SUCCESS)316{317ocl_error_printf("ocl::alloc_read_buffer: clCreateBuffer() failed!\n");318return nullptr;319}320321return obj;322}323324cl_mem alloc_and_init_read_buffer(cl_command_queue command_queue, const void *pInit, size_t size)325{326cl_serializer serializer(this);327328cl_int ret;329cl_mem obj = clCreateBuffer(m_context, CL_MEM_READ_ONLY, size, NULL, &ret);330if (ret != CL_SUCCESS)331{332ocl_error_printf("ocl::alloc_and_init_read_buffer: clCreateBuffer() failed!\n");333return nullptr;334}335336#if 0337if (!write_to_buffer(command_queue, obj, pInit, size))338{339destroy_buffer(obj);340return nullptr;341}342#else343ret = clEnqueueWriteBuffer(command_queue, obj, CL_TRUE, 0, size, pInit, 0, NULL, NULL);344if (ret != CL_SUCCESS)345{346ocl_error_printf("ocl::alloc_and_init_read_buffer: clEnqueueWriteBuffer() failed!\n");347return nullptr;348}349#endif350351return obj;352}353354cl_mem alloc_write_buffer(size_t size)355{356cl_serializer serializer(this);357358cl_int ret;359cl_mem obj = clCreateBuffer(m_context, CL_MEM_WRITE_ONLY, size, NULL, &ret);360if (ret != CL_SUCCESS)361{362ocl_error_printf("ocl::alloc_write_buffer: clCreateBuffer() failed!\n");363return nullptr;364}365366return obj;367}368369bool destroy_buffer(cl_mem buf)370{371if (buf)372{373cl_serializer serializer(this);374375cl_int ret = clReleaseMemObject(buf);376if (ret != CL_SUCCESS)377{378ocl_error_printf("ocl::destroy_buffer: clReleaseMemObject() failed!\n");379return false;380}381}382383return true;384}385386bool write_to_buffer(cl_command_queue command_queue, cl_mem clmem, const void* d, const size_t m)387{388cl_serializer serializer(this);389390cl_int ret = clEnqueueWriteBuffer(command_queue, clmem, CL_TRUE, 0, m, d, 0, NULL, NULL);391if (ret != CL_SUCCESS)392{393ocl_error_printf("ocl::write_to_buffer: clEnqueueWriteBuffer() failed!\n");394return false;395}396397return true;398}399400bool read_from_buffer(cl_command_queue command_queue, const cl_mem clmem, void* d, size_t m)401{402cl_serializer serializer(this);403404cl_int ret = clEnqueueReadBuffer(command_queue, clmem, CL_TRUE, 0, m, d, 0, NULL, NULL);405if (ret != CL_SUCCESS)406{407ocl_error_printf("ocl::read_from_buffer: clEnqueueReadBuffer() failed!\n");408return false;409}410411return true;412}413414cl_mem create_read_image_u8(uint32_t width, uint32_t height, const void* pPixels, uint32_t bytes_per_pixel, bool normalized)415{416cl_image_format fmt = get_image_format(bytes_per_pixel, normalized);417418cl_image_desc desc;419memset(&desc, 0, sizeof(desc));420desc.image_type = CL_MEM_OBJECT_IMAGE2D;421desc.image_width = width;422desc.image_height = height;423desc.image_row_pitch = width * bytes_per_pixel;424425cl_serializer serializer(this);426427cl_int ret;428cl_mem img = clCreateImage(m_context, CL_MEM_READ_ONLY | CL_MEM_COPY_HOST_PTR, &fmt, &desc, (void*)pPixels, &ret);429if (ret != CL_SUCCESS)430{431ocl_error_printf("ocl::create_read_image_u8: clCreateImage() failed!\n");432return nullptr;433}434435return img;436}437438cl_mem create_write_image_u8(uint32_t width, uint32_t height, uint32_t bytes_per_pixel, bool normalized)439{440cl_image_format fmt = get_image_format(bytes_per_pixel, normalized);441442cl_image_desc desc;443memset(&desc, 0, sizeof(desc));444desc.image_type = CL_MEM_OBJECT_IMAGE2D;445desc.image_width = width;446desc.image_height = height;447448cl_serializer serializer(this);449450cl_int ret;451cl_mem img = clCreateImage(m_context, CL_MEM_WRITE_ONLY, &fmt, &desc, nullptr, &ret);452if (ret != CL_SUCCESS)453{454ocl_error_printf("ocl::create_write_image_u8: clCreateImage() failed!\n");455return nullptr;456}457458return img;459}460461bool 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)462{463cl_serializer serializer(this);464465size_t origin[3] = { ofs_x, ofs_y, 0 }, region[3] = { width, height, 1 };466467cl_int err = clEnqueueReadImage(command_queue, img, CL_TRUE, origin, region, 0, 0, pPixels, 0, NULL, NULL);468if (err != CL_SUCCESS)469{470ocl_error_printf("ocl::read_from_image: clEnqueueReadImage() failed!\n");471return false;472}473474return true;475}476477bool run_1D(cl_command_queue command_queue, const cl_kernel kernel, size_t num_items)478{479cl_serializer serializer(this);480481cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,4821, // work_dim483nullptr, // global_work_offset484&num_items, // global_work_size485nullptr, // local_work_size4860, // num_events_in_wait_list487nullptr, // event_wait_list488nullptr // event489);490491if (ret != CL_SUCCESS)492{493ocl_error_printf("ocl::run_1D: clEnqueueNDRangeKernel() failed!\n");494return false;495}496497return true;498}499500bool run_2D(cl_command_queue command_queue, const cl_kernel kernel, size_t width, size_t height)501{502cl_serializer serializer(this);503504size_t num_global_items[2] = { width, height };505//size_t num_local_items[2] = { 1, 1 };506507cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,5082, // work_dim509nullptr, // global_work_offset510num_global_items, // global_work_size511nullptr, // local_work_size5120, // num_events_in_wait_list513nullptr, // event_wait_list514nullptr // event515);516517if (ret != CL_SUCCESS)518{519ocl_error_printf("ocl::run_2D: clEnqueueNDRangeKernel() failed!\n");520return false;521}522523return true;524}525526bool 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)527{528cl_serializer serializer(this);529530size_t global_ofs[2] = { ofs_x, ofs_y };531size_t num_global_items[2] = { width, height };532//size_t num_local_items[2] = { 1, 1 };533534cl_int ret = clEnqueueNDRangeKernel(command_queue, kernel,5352, // work_dim536global_ofs, // global_work_offset537num_global_items, // global_work_size538nullptr, // local_work_size5390, // num_events_in_wait_list540nullptr, // event_wait_list541nullptr // event542);543544if (ret != CL_SUCCESS)545{546ocl_error_printf("ocl::run_2D: clEnqueueNDRangeKernel() failed!\n");547return false;548}549550return true;551}552553void flush(cl_command_queue command_queue)554{555cl_serializer serializer(this);556557clFlush(command_queue);558clFinish(command_queue);559}560561template<typename T>562bool set_kernel_arg(cl_kernel kernel, uint32_t index, const T& obj)563{564cl_serializer serializer(this);565566cl_int ret = clSetKernelArg(kernel, index, sizeof(T), (void*)&obj);567if (ret != CL_SUCCESS)568{569ocl_error_printf("ocl::set_kernel_arg: clSetKernelArg() failed!\n");570return false;571}572return true;573}574575template<typename T>576bool set_kernel_args(cl_kernel kernel, const T& obj1)577{578cl_serializer serializer(this);579580cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1);581if (ret != CL_SUCCESS)582{583ocl_error_printf("ocl::set_kernel_arg: clSetKernelArg() failed!\n");584return false;585}586return true;587}588589#define BASISU_CHECK_ERR if (ret != CL_SUCCESS) { ocl_error_printf("ocl::set_kernel_args: clSetKernelArg() failed!\n"); return false; }590591template<typename T, typename U>592bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2)593{594cl_serializer serializer(this);595cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR596ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR597return true;598}599600template<typename T, typename U, typename V>601bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3)602{603cl_serializer serializer(this);604cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR605ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR606ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR607return true;608}609610template<typename T, typename U, typename V, typename W>611bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4)612{613cl_serializer serializer(this);614cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR615ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR616ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR617ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR618return true;619}620621template<typename T, typename U, typename V, typename W, typename X>622bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5)623{624cl_serializer serializer(this);625cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR626ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR627ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR628ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR629ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR630return true;631}632633template<typename T, typename U, typename V, typename W, typename X, typename Y>634bool set_kernel_args(cl_kernel kernel, const T& obj1, const U& obj2, const V& obj3, const W& obj4, const X& obj5, const Y& obj6)635{636cl_serializer serializer(this);637cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR638ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR639ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR640ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR641ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR642ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR643return true;644}645646template<typename T, typename U, typename V, typename W, typename X, typename Y, typename Z>647bool 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)648{649cl_serializer serializer(this);650cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR651ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR652ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR653ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR654ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR655ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR656ret = clSetKernelArg(kernel, 6, sizeof(Z), (void*)&obj7); BASISU_CHECK_ERR657return true;658}659660template<typename T, typename U, typename V, typename W, typename X, typename Y, typename Z, typename A>661bool 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)662{663cl_serializer serializer(this);664cl_int ret = clSetKernelArg(kernel, 0, sizeof(T), (void*)&obj1); BASISU_CHECK_ERR665ret = clSetKernelArg(kernel, 1, sizeof(U), (void*)&obj2); BASISU_CHECK_ERR666ret = clSetKernelArg(kernel, 2, sizeof(V), (void*)&obj3); BASISU_CHECK_ERR667ret = clSetKernelArg(kernel, 3, sizeof(W), (void*)&obj4); BASISU_CHECK_ERR668ret = clSetKernelArg(kernel, 4, sizeof(X), (void*)&obj5); BASISU_CHECK_ERR669ret = clSetKernelArg(kernel, 5, sizeof(Y), (void*)&obj6); BASISU_CHECK_ERR670ret = clSetKernelArg(kernel, 6, sizeof(Z), (void*)&obj7); BASISU_CHECK_ERR671ret = clSetKernelArg(kernel, 7, sizeof(A), (void*)&obj8); BASISU_CHECK_ERR672return true;673}674#undef BASISU_CHECK_ERR675676private:677cl_device_id m_device_id = nullptr;678cl_context m_context = nullptr;679cl_command_queue m_command_queue = nullptr;680cl_program m_program = nullptr;681cl_device_fp_config m_dev_fp_config;682683bool m_use_mutex = false;684std::mutex m_ocl_mutex;685686// This helper object is used to optionally serialize all calls to the CL driver after initialization.687// Currently this is only used to work around race conditions in the Windows AMD driver.688struct cl_serializer689{690inline cl_serializer(const cl_serializer&);691cl_serializer& operator= (const cl_serializer&);692693inline cl_serializer(ocl *p) : m_p(p)694{695if (m_p->m_use_mutex)696m_p->m_ocl_mutex.lock();697}698699inline ~cl_serializer()700{701if (m_p->m_use_mutex)702m_p->m_ocl_mutex.unlock();703}704705private:706ocl* m_p;707};708709cl_image_format get_image_format(uint32_t bytes_per_pixel, bool normalized)710{711cl_image_format fmt;712switch (bytes_per_pixel)713{714case 1: fmt.image_channel_order = CL_LUMINANCE; break;715case 2: fmt.image_channel_order = CL_RG; break;716case 3: fmt.image_channel_order = CL_RGB; break;717case 4: fmt.image_channel_order = CL_RGBA; break;718default: assert(0); fmt.image_channel_order = CL_LUMINANCE; break;719}720721fmt.image_channel_data_type = normalized ? CL_UNORM_INT8 : CL_UNSIGNED_INT8;722return fmt;723}724};725726// Library blobal state727ocl g_ocl;728729bool opencl_init(bool force_serialization)730{731if (g_ocl.is_initialized())732{733assert(0);734return false;735}736737if (!g_ocl.init(force_serialization))738{739ocl_error_printf("opencl_init: Failed initializing OpenCL\n");740return false;741}742743const char* pKernel_src = nullptr;744size_t kernel_src_size = 0;745uint8_vec kernel_src;746747#if BASISU_USE_OCL_KERNELS_HEADER748pKernel_src = reinterpret_cast<const char*>(ocl_kernels_cl);749kernel_src_size = ocl_kernels_cl_len;750#else751if (!read_file_to_vec(BASISU_OCL_KERNELS_FILENAME, kernel_src))752{753ocl_error_printf("opencl_init: Cannot read OpenCL kernel source file \"%s\"\n", BASISU_OCL_KERNELS_FILENAME);754g_ocl.deinit();755return false;756}757758pKernel_src = (char*)kernel_src.data();759kernel_src_size = kernel_src.size();760#endif761762if (!kernel_src_size)763{764ocl_error_printf("opencl_init: Invalid OpenCL kernel source file \"%s\"\n", BASISU_OCL_KERNELS_FILENAME);765g_ocl.deinit();766return false;767}768769if (!g_ocl.init_program(pKernel_src, kernel_src_size))770{771ocl_error_printf("opencl_init: Failed compiling OpenCL program\n");772g_ocl.deinit();773return false;774}775776printf("OpenCL support initialized successfully\n");777778return true;779}780781void opencl_deinit()782{783g_ocl.deinit();784}785786bool opencl_is_available()787{788return g_ocl.is_initialized();789}790791struct opencl_context792{793size_t m_ocl_total_pixel_blocks;794cl_mem m_ocl_pixel_blocks;795796cl_command_queue m_command_queue;797798cl_kernel m_ocl_encode_etc1s_blocks_kernel;799cl_kernel m_ocl_refine_endpoint_clusterization_kernel;800cl_kernel m_ocl_encode_etc1s_from_pixel_cluster_kernel;801cl_kernel m_ocl_find_optimal_selector_clusters_for_each_block_kernel;802cl_kernel m_ocl_determine_selectors_kernel;803};804805opencl_context_ptr opencl_create_context()806{807if (!opencl_is_available())808{809ocl_error_printf("opencl_create_context: OpenCL not initialized\n");810assert(0);811return nullptr;812}813814interval_timer tm;815tm.start();816817opencl_context* pContext = static_cast<opencl_context * >(calloc(sizeof(opencl_context), 1));818if (!pContext)819return nullptr;820821// To avoid driver bugs in some drivers - serialize this. Likely not necessary, we don't know.822// https://community.intel.com/t5/OpenCL-for-CPU/Bug-report-clCreateKernelsInProgram-is-not-thread-safe/td-p/1159771823824pContext->m_command_queue = g_ocl.create_command_queue();825if (!pContext->m_command_queue)826{827ocl_error_printf("opencl_create_context: Failed creating OpenCL command queue!\n");828opencl_destroy_context(pContext);829return nullptr;830}831832pContext->m_ocl_encode_etc1s_blocks_kernel = g_ocl.create_kernel("encode_etc1s_blocks");833if (!pContext->m_ocl_encode_etc1s_blocks_kernel)834{835ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel encode_etc1s_block\n");836opencl_destroy_context(pContext);837return nullptr;838}839840pContext->m_ocl_refine_endpoint_clusterization_kernel = g_ocl.create_kernel("refine_endpoint_clusterization");841if (!pContext->m_ocl_refine_endpoint_clusterization_kernel)842{843ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel refine_endpoint_clusterization\n");844opencl_destroy_context(pContext);845return nullptr;846}847848pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel = g_ocl.create_kernel("encode_etc1s_from_pixel_cluster");849if (!pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel)850{851ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel encode_etc1s_from_pixel_cluster\n");852opencl_destroy_context(pContext);853return nullptr;854}855856pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel = g_ocl.create_kernel("find_optimal_selector_clusters_for_each_block");857if (!pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel)858{859ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel find_optimal_selector_clusters_for_each_block\n");860opencl_destroy_context(pContext);861return nullptr;862}863864pContext->m_ocl_determine_selectors_kernel = g_ocl.create_kernel("determine_selectors");865if (!pContext->m_ocl_determine_selectors_kernel)866{867ocl_error_printf("opencl_create_context: Failed creating OpenCL kernel determine_selectors\n");868opencl_destroy_context(pContext);869return nullptr;870}871872debug_printf("opencl_create_context: Elapsed time: %f secs\n", tm.get_elapsed_secs());873874return pContext;875}876877void opencl_destroy_context(opencl_context_ptr pContext)878{879if (!pContext)880return;881882interval_timer tm;883tm.start();884885g_ocl.destroy_buffer(pContext->m_ocl_pixel_blocks);886887g_ocl.destroy_kernel(pContext->m_ocl_determine_selectors_kernel);888g_ocl.destroy_kernel(pContext->m_ocl_find_optimal_selector_clusters_for_each_block_kernel);889g_ocl.destroy_kernel(pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel);890g_ocl.destroy_kernel(pContext->m_ocl_encode_etc1s_blocks_kernel);891g_ocl.destroy_kernel(pContext->m_ocl_refine_endpoint_clusterization_kernel);892893g_ocl.destroy_command_queue(pContext->m_command_queue);894895memset(pContext, 0, sizeof(opencl_context));896897free(pContext);898899debug_printf("opencl_destroy_context: Elapsed time: %f secs\n", tm.get_elapsed_secs());900}901902#pragma pack(push, 1)903struct cl_encode_etc1s_param_struct904{905int m_total_blocks;906int m_perceptual;907int m_total_perms;908};909#pragma pack(pop)910911bool opencl_set_pixel_blocks(opencl_context_ptr pContext, size_t total_blocks, const cl_pixel_block* pPixel_blocks)912{913if (!opencl_is_available())914return false;915916if (pContext->m_ocl_pixel_blocks)917{918g_ocl.destroy_buffer(pContext->m_ocl_pixel_blocks);919pContext->m_ocl_pixel_blocks = nullptr;920}921922pContext->m_ocl_pixel_blocks = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixel_blocks, sizeof(cl_pixel_block) * total_blocks);923if (!pContext->m_ocl_pixel_blocks)924return false;925926pContext->m_ocl_total_pixel_blocks = total_blocks;927928return true;929}930931bool opencl_encode_etc1s_blocks(opencl_context_ptr pContext, etc_block* pOutput_blocks, bool perceptual, uint32_t total_perms)932{933if (!opencl_is_available())934return false;935936interval_timer tm;937tm.start();938939assert(pContext->m_ocl_pixel_blocks);940if (!pContext->m_ocl_pixel_blocks)941return false;942943assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);944945cl_encode_etc1s_param_struct ps;946ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;947ps.m_perceptual = perceptual;948ps.m_total_perms = total_perms;949950bool status = false;951952cl_mem vars = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue , &ps, sizeof(ps));953cl_mem block_buf = g_ocl.alloc_write_buffer(sizeof(etc_block) * pContext->m_ocl_total_pixel_blocks);954955if (!vars || !block_buf)956goto exit;957958if (!g_ocl.set_kernel_args(pContext->m_ocl_encode_etc1s_blocks_kernel, vars, pContext->m_ocl_pixel_blocks, block_buf))959goto exit;960961if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_encode_etc1s_blocks_kernel, pContext->m_ocl_total_pixel_blocks, 1))962goto exit;963964if (!g_ocl.read_from_buffer(pContext->m_command_queue, block_buf, pOutput_blocks, pContext->m_ocl_total_pixel_blocks * sizeof(etc_block)))965goto exit;966967status = true;968969debug_printf("opencl_encode_etc1s_blocks: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());970971exit:972g_ocl.destroy_buffer(block_buf);973g_ocl.destroy_buffer(vars);974975return status;976}977978bool opencl_encode_etc1s_pixel_clusters(979opencl_context_ptr pContext,980etc_block* pOutput_blocks,981uint32_t total_clusters,982const cl_pixel_cluster* pClusters,983uint64_t total_pixels,984const color_rgba* pPixels, const uint32_t* pPixel_weights,985bool perceptual, uint32_t total_perms)986{987if (!opencl_is_available())988return false;989990interval_timer tm;991tm.start();992993cl_encode_etc1s_param_struct ps;994ps.m_total_blocks = total_clusters;995ps.m_perceptual = perceptual;996ps.m_total_perms = total_perms;997998bool status = false;9991000if (sizeof(size_t) == sizeof(uint32_t))1001{1002if ( ((sizeof(cl_pixel_cluster) * total_clusters) > UINT32_MAX) ||1003((sizeof(color_rgba) * total_pixels) > UINT32_MAX) ||1004((sizeof(uint32_t) * total_pixels) > UINT32_MAX) )1005{1006return false;1007}1008}10091010cl_mem vars = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue , &ps, sizeof(ps));1011cl_mem input_clusters = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pClusters, (size_t)(sizeof(cl_pixel_cluster) * total_clusters));1012cl_mem input_pixels = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixels, (size_t)(sizeof(color_rgba) * total_pixels));1013cl_mem weights_buf = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pPixel_weights, (size_t)(sizeof(uint32_t) * total_pixels));1014cl_mem block_buf = g_ocl.alloc_write_buffer(sizeof(etc_block) * total_clusters);10151016if (!vars || !input_clusters || !input_pixels || !weights_buf || !block_buf)1017goto exit;10181019if (!g_ocl.set_kernel_args(pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel, vars, input_clusters, input_pixels, weights_buf, block_buf))1020goto exit;10211022if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_encode_etc1s_from_pixel_cluster_kernel, total_clusters, 1))1023goto exit;10241025if (!g_ocl.read_from_buffer(pContext->m_command_queue, block_buf, pOutput_blocks, sizeof(etc_block) * total_clusters))1026goto exit;10271028status = true;10291030debug_printf("opencl_encode_etc1s_pixel_clusters: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());10311032exit:1033g_ocl.destroy_buffer(block_buf);1034g_ocl.destroy_buffer(weights_buf);1035g_ocl.destroy_buffer(input_pixels);1036g_ocl.destroy_buffer(input_clusters);1037g_ocl.destroy_buffer(vars);10381039return status;1040}10411042#pragma pack(push, 1)1043struct cl_rec_param_struct1044{1045int m_total_blocks;1046int m_perceptual;1047};1048#pragma pack(pop)10491050bool opencl_refine_endpoint_clusterization(1051opencl_context_ptr pContext,1052const cl_block_info_struct* pPixel_block_info,1053uint32_t total_clusters,1054const cl_endpoint_cluster_struct* pCluster_info,1055const uint32_t* pSorted_block_indices,1056uint32_t* pOutput_cluster_indices,1057bool perceptual)1058{1059if (!opencl_is_available())1060return false;10611062interval_timer tm;1063tm.start();10641065assert(pContext->m_ocl_pixel_blocks);1066if (!pContext->m_ocl_pixel_blocks)1067return false;10681069assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);10701071cl_rec_param_struct ps;1072ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1073ps.m_perceptual = perceptual;10741075bool status = false;10761077cl_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);1078cl_mem cluster_info = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pCluster_info, sizeof(cl_endpoint_cluster_struct) * total_clusters);1079cl_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);1080cl_mem output_buf = g_ocl.alloc_write_buffer(sizeof(uint32_t) * pContext->m_ocl_total_pixel_blocks);10811082if (!pixel_block_info || !cluster_info || !sorted_block_indices || !output_buf)1083goto exit;10841085if (!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))1086goto exit;10871088if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_refine_endpoint_clusterization_kernel, pContext->m_ocl_total_pixel_blocks, 1))1089goto exit;10901091if (!g_ocl.read_from_buffer(pContext->m_command_queue, output_buf, pOutput_cluster_indices, pContext->m_ocl_total_pixel_blocks * sizeof(uint32_t)))1092goto exit;10931094debug_printf("opencl_refine_endpoint_clusterization: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());10951096status = true;10971098exit:1099g_ocl.destroy_buffer(pixel_block_info);1100g_ocl.destroy_buffer(cluster_info);1101g_ocl.destroy_buffer(sorted_block_indices);1102g_ocl.destroy_buffer(output_buf);11031104return status;1105}11061107bool opencl_find_optimal_selector_clusters_for_each_block(1108opencl_context_ptr pContext,1109const fosc_block_struct* pInput_block_info, // one per block1110uint32_t total_input_selectors,1111const fosc_selector_struct* pInput_selectors,1112const uint32_t* pSelector_cluster_indices,1113uint32_t* pOutput_selector_cluster_indices, // one per block1114bool perceptual)1115{1116if (!opencl_is_available())1117return false;11181119interval_timer tm;1120tm.start();11211122assert(pContext->m_ocl_pixel_blocks);1123if (!pContext->m_ocl_pixel_blocks)1124return false;11251126assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);11271128fosc_param_struct ps;1129ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1130ps.m_perceptual = perceptual;11311132bool status = false;11331134cl_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);1135cl_mem input_selectors = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pInput_selectors, sizeof(fosc_selector_struct) * total_input_selectors);1136cl_mem selector_cluster_indices = g_ocl.alloc_and_init_read_buffer(pContext->m_command_queue, pSelector_cluster_indices, sizeof(uint32_t) * total_input_selectors);1137cl_mem output_selector_cluster_indices = g_ocl.alloc_write_buffer(sizeof(uint32_t) * pContext->m_ocl_total_pixel_blocks);11381139if (!input_block_info || !input_selectors || !selector_cluster_indices || !output_selector_cluster_indices)1140goto exit;11411142if (!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))1143goto exit;11441145if (!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))1146goto exit;11471148if (!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)))1149goto exit;11501151debug_printf("opencl_find_optimal_selector_clusters_for_each_block: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());11521153status = true;11541155exit:1156g_ocl.destroy_buffer(input_block_info);1157g_ocl.destroy_buffer(input_selectors);1158g_ocl.destroy_buffer(selector_cluster_indices);1159g_ocl.destroy_buffer(output_selector_cluster_indices);11601161return status;1162}11631164bool opencl_determine_selectors(1165opencl_context_ptr pContext,1166const color_rgba* pInput_etc_color5_and_inten,1167etc_block* pOutput_blocks,1168bool perceptual)1169{1170if (!opencl_is_available())1171return false;11721173interval_timer tm;1174tm.start();11751176assert(pContext->m_ocl_pixel_blocks);1177if (!pContext->m_ocl_pixel_blocks)1178return false;11791180assert(pContext->m_ocl_total_pixel_blocks <= INT_MAX);11811182ds_param_struct ps;1183ps.m_total_blocks = (int)pContext->m_ocl_total_pixel_blocks;1184ps.m_perceptual = perceptual;11851186bool status = false;11871188cl_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);1189cl_mem output_blocks = g_ocl.alloc_write_buffer(sizeof(etc_block) * pContext->m_ocl_total_pixel_blocks);11901191if (!input_etc_color5_intens || !output_blocks)1192goto exit;11931194if (!g_ocl.set_kernel_args(pContext->m_ocl_determine_selectors_kernel, ps, pContext->m_ocl_pixel_blocks, input_etc_color5_intens, output_blocks))1195goto exit;11961197if (!g_ocl.run_2D(pContext->m_command_queue, pContext->m_ocl_determine_selectors_kernel, pContext->m_ocl_total_pixel_blocks, 1))1198goto exit;11991200if (!g_ocl.read_from_buffer(pContext->m_command_queue, output_blocks, pOutput_blocks, pContext->m_ocl_total_pixel_blocks * sizeof(etc_block)))1201goto exit;12021203debug_printf("opencl_determine_selectors: Elapsed time: %3.3f secs\n", tm.get_elapsed_secs());12041205status = true;12061207exit:1208g_ocl.destroy_buffer(input_etc_color5_intens);1209g_ocl.destroy_buffer(output_blocks);12101211return status;1212}12131214#else1215namespace basisu1216{1217// No OpenCL support - all dummy functions that return false;1218bool opencl_init(bool force_serialization)1219{1220BASISU_NOTE_UNUSED(force_serialization);12211222return false;1223}12241225void opencl_deinit()1226{1227}12281229bool opencl_is_available()1230{1231return false;1232}12331234opencl_context_ptr opencl_create_context()1235{1236return nullptr;1237}12381239void opencl_destroy_context(opencl_context_ptr context)1240{1241BASISU_NOTE_UNUSED(context);1242}12431244bool opencl_set_pixel_blocks(opencl_context_ptr pContext, size_t total_blocks, const cl_pixel_block* pPixel_blocks)1245{1246BASISU_NOTE_UNUSED(pContext);1247BASISU_NOTE_UNUSED(total_blocks);1248BASISU_NOTE_UNUSED(pPixel_blocks);12491250return false;1251}12521253bool opencl_encode_etc1s_blocks(opencl_context_ptr pContext, etc_block* pOutput_blocks, bool perceptual, uint32_t total_perms)1254{1255BASISU_NOTE_UNUSED(pContext);1256BASISU_NOTE_UNUSED(pOutput_blocks);1257BASISU_NOTE_UNUSED(perceptual);1258BASISU_NOTE_UNUSED(total_perms);12591260return false;1261}12621263bool opencl_encode_etc1s_pixel_clusters(1264opencl_context_ptr pContext,1265etc_block* pOutput_blocks,1266uint32_t total_clusters,1267const cl_pixel_cluster* pClusters,1268uint64_t total_pixels,1269const color_rgba* pPixels, const uint32_t *pPixel_weights,1270bool perceptual, uint32_t total_perms)1271{1272BASISU_NOTE_UNUSED(pContext);1273BASISU_NOTE_UNUSED(pOutput_blocks);1274BASISU_NOTE_UNUSED(total_clusters);1275BASISU_NOTE_UNUSED(pClusters);1276BASISU_NOTE_UNUSED(total_pixels);1277BASISU_NOTE_UNUSED(pPixels);1278BASISU_NOTE_UNUSED(pPixel_weights);1279BASISU_NOTE_UNUSED(perceptual);1280BASISU_NOTE_UNUSED(total_perms);12811282return false;1283}12841285bool opencl_refine_endpoint_clusterization(1286opencl_context_ptr pContext,1287const cl_block_info_struct* pPixel_block_info,1288uint32_t total_clusters,1289const cl_endpoint_cluster_struct* pCluster_info,1290const uint32_t* pSorted_block_indices,1291uint32_t* pOutput_cluster_indices,1292bool perceptual)1293{1294BASISU_NOTE_UNUSED(pContext);1295BASISU_NOTE_UNUSED(pPixel_block_info);1296BASISU_NOTE_UNUSED(total_clusters);1297BASISU_NOTE_UNUSED(pCluster_info);1298BASISU_NOTE_UNUSED(pSorted_block_indices);1299BASISU_NOTE_UNUSED(pOutput_cluster_indices);1300BASISU_NOTE_UNUSED(perceptual);13011302return false;1303}13041305bool opencl_find_optimal_selector_clusters_for_each_block(1306opencl_context_ptr pContext,1307const fosc_block_struct* pInput_block_info, // one per block1308uint32_t total_input_selectors,1309const fosc_selector_struct* pInput_selectors,1310const uint32_t* pSelector_cluster_indices,1311uint32_t* pOutput_selector_cluster_indices, // one per block1312bool perceptual)1313{1314BASISU_NOTE_UNUSED(pContext);1315BASISU_NOTE_UNUSED(pInput_block_info);1316BASISU_NOTE_UNUSED(total_input_selectors);1317BASISU_NOTE_UNUSED(pInput_selectors);1318BASISU_NOTE_UNUSED(pSelector_cluster_indices);1319BASISU_NOTE_UNUSED(pOutput_selector_cluster_indices);1320BASISU_NOTE_UNUSED(perceptual);13211322return false;1323}13241325bool opencl_determine_selectors(1326opencl_context_ptr pContext,1327const color_rgba* pInput_etc_color5_and_inten,1328etc_block* pOutput_blocks,1329bool perceptual)1330{1331BASISU_NOTE_UNUSED(pContext);1332BASISU_NOTE_UNUSED(pInput_etc_color5_and_inten);1333BASISU_NOTE_UNUSED(pOutput_blocks);1334BASISU_NOTE_UNUSED(perceptual);13351336return false;1337}13381339#endif // BASISU_SUPPORT_OPENCL13401341} // namespace basisu134213431344