FFmpeg
vulkan_shaderc.c
Go to the documentation of this file.
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 #include <shaderc/shaderc.h>
20 
21 #include "libavutil/mem.h"
22 #include "vulkan_spirv.h"
23 
25  FFVulkanShader *shd, uint8_t **data,
26  size_t *size, const char *entrypoint,
27  void **opaque)
28 {
29  int loglevel, err, warn, ret;
30  const char *status, *message;
31  shaderc_compilation_result_t res;
32  static const char *shdc_result[] = {
33  [shaderc_compilation_status_success] = "success",
34  [shaderc_compilation_status_invalid_stage] = "invalid stage",
35  [shaderc_compilation_status_compilation_error] = "error",
36  [shaderc_compilation_status_internal_error] = "internal error",
37  [shaderc_compilation_status_null_result_object] = "no result",
38  [shaderc_compilation_status_invalid_assembly] = "invalid assembly",
39  };
40  static const shaderc_shader_kind shdc_kind[] = {
41  [VK_SHADER_STAGE_VERTEX_BIT] = shaderc_glsl_vertex_shader,
42  [VK_SHADER_STAGE_FRAGMENT_BIT] = shaderc_glsl_fragment_shader,
43  [VK_SHADER_STAGE_COMPUTE_BIT] = shaderc_glsl_compute_shader,
44  [VK_SHADER_STAGE_MESH_BIT_EXT] = shaderc_mesh_shader,
45  [VK_SHADER_STAGE_TASK_BIT_EXT] = shaderc_task_shader,
46  [VK_SHADER_STAGE_RAYGEN_BIT_KHR] = shaderc_raygen_shader,
47  [VK_SHADER_STAGE_ANY_HIT_BIT_KHR] = shaderc_anyhit_shader,
48  [VK_SHADER_STAGE_CLOSEST_HIT_BIT_KHR] = shaderc_closesthit_shader,
49  [VK_SHADER_STAGE_MISS_BIT_KHR] = shaderc_miss_shader,
50  [VK_SHADER_STAGE_INTERSECTION_BIT_KHR] = shaderc_intersection_shader,
51  [VK_SHADER_STAGE_CALLABLE_BIT_KHR] = shaderc_callable_shader,
52  };
53 
54  shaderc_compile_options_t opts = shaderc_compile_options_initialize();
55  *opaque = NULL;
56  if (!opts)
57  return AVERROR(ENOMEM);
58 
59  shaderc_compile_options_set_target_env(opts, shaderc_target_env_vulkan,
60  shaderc_env_version_vulkan_1_3);
61  shaderc_compile_options_set_target_spirv(opts, shaderc_spirv_version_1_6);
62 
63  /* If either extension is set, turn on debug info */
65  shaderc_compile_options_set_generate_debug_info(opts);
66 
67  if (s->extensions & FF_VK_EXT_DEBUG_UTILS)
68  shaderc_compile_options_set_optimization_level(opts,
69  shaderc_optimization_level_zero);
70  else
71  shaderc_compile_options_set_optimization_level(opts,
72  shaderc_optimization_level_performance);
73 
74  res = shaderc_compile_into_spv((shaderc_compiler_t)ctx->priv,
75  shd->src.str, strlen(shd->src.str),
76  shdc_kind[shd->stage],
77  shd->name, entrypoint, opts);
78  shaderc_compile_options_release(opts);
79 
80  ret = shaderc_result_get_compilation_status(res);
81  err = shaderc_result_get_num_errors(res);
82  warn = shaderc_result_get_num_warnings(res);
83  message = shaderc_result_get_error_message(res);
84 
85  if (ret != shaderc_compilation_status_success && !err)
86  err = 1;
87 
88  loglevel = err ? AV_LOG_ERROR : warn ? AV_LOG_WARNING : AV_LOG_VERBOSE;
89 
90  ff_vk_shader_print(s, shd, loglevel);
91  if (message && (err || warn))
92  av_log(s, loglevel, "%s\n", message);
93  status = ret < FF_ARRAY_ELEMS(shdc_result) ? shdc_result[ret] : "unknown";
94  av_log(s, loglevel, "shaderc compile status '%s' (%d errors, %d warnings)\n",
95  status, err, warn);
96 
97  if (err > 0)
98  return AVERROR(EINVAL);
99 
100  *data = (uint8_t *)shaderc_result_get_bytes(res);
101  *size = shaderc_result_get_length(res);
102  *opaque = res;
103 
104  return 0;
105 }
106 
107 static void shdc_shader_free(FFVkSPIRVCompiler *ctx, void **opaque)
108 {
109  if (!opaque || !*opaque)
110  return;
111 
112  shaderc_result_release((shaderc_compilation_result_t)*opaque);
113  *opaque = NULL;
114 }
115 
117 {
119 
120  if (!ctx || !*ctx)
121  return;
122 
123  s = *ctx;
124 
125  shaderc_compiler_release((shaderc_compiler_t)s->priv);
126  av_freep(ctx);
127 }
128 
130 {
131  FFVkSPIRVCompiler *ret = av_mallocz(sizeof(*ret));
132  if (!ret)
133  return NULL;
134 
135  ret->compile_shader = shdc_shader_compile;
136  ret->free_shader = shdc_shader_free;
137  ret->uninit = shdc_uninit;
138 
139  ret->priv = (void *)shaderc_compiler_initialize();
140  if (!ret->priv)
141  av_freep(&ret);
142 
143  return ret;
144 }
AV_LOG_WARNING
#define AV_LOG_WARNING
Something somehow does not look correct.
Definition: log.h:215
AVERROR
Filter the word “frame” indicates either a video frame or a group of audio as stored in an AVFrame structure Format for each input and each output the list of supported formats For video that means pixel format For audio that means channel sample they are references to shared objects When the negotiation mechanism computes the intersection of the formats supported at each end of a all references to both lists are replaced with a reference to the intersection And when a single format is eventually chosen for a link amongst the remaining all references to the list are updated That means that if a filter requires that its input and output have the same format amongst a supported all it has to do is use a reference to the same list of formats query_formats can leave some formats unset and return AVERROR(EAGAIN) to cause the negotiation mechanism toagain later. That can be used by filters with complex requirements to use the format negotiated on one link to set the formats supported on another. Frame references ownership and permissions
message
Definition: api-threadmessage-test.c:47
FFVulkanShader::src
AVBPrint src
Definition: vulkan.h:184
data
const char data[16]
Definition: mxf.c:148
AV_LOG_VERBOSE
#define AV_LOG_VERBOSE
Detailed information.
Definition: log.h:225
AV_LOG_ERROR
#define AV_LOG_ERROR
Something went wrong and cannot losslessly be recovered.
Definition: log.h:209
shdc_shader_free
static void shdc_shader_free(FFVkSPIRVCompiler *ctx, void **opaque)
Definition: vulkan_shaderc.c:107
FF_ARRAY_ELEMS
#define FF_ARRAY_ELEMS(a)
Definition: sinewin_tablegen.c:29
s
#define s(width, name)
Definition: cbs_vp9.c:198
FFVulkanShader::stage
VkPipelineStageFlags stage
Definition: vulkan.h:190
ctx
AVFormatContext * ctx
Definition: movenc.c:49
opts
AVDictionary * opts
Definition: movenc.c:51
NULL
#define NULL
Definition: coverity.c:32
FFVulkanContext
Definition: vulkan.h:263
ff_vk_shaderc_init
FFVkSPIRVCompiler * ff_vk_shaderc_init(void)
Definition: vulkan_shaderc.c:129
size
int size
Definition: twinvq_data.h:10344
FFVulkanShader
Definition: vulkan.h:179
FFVkSPIRVCompiler
Definition: vulkan_spirv.h:27
FF_VK_EXT_RELAXED_EXTENDED_INSTR
#define FF_VK_EXT_RELAXED_EXTENDED_INSTR
Definition: vulkan_functions.h:50
av_mallocz
void * av_mallocz(size_t size)
Allocate a memory block with alignment suitable for all memory accesses (including vectors if availab...
Definition: mem.c:256
vulkan_spirv.h
ret
ret
Definition: filter_design.txt:187
FFVulkanShader::name
const char * name
Definition: vulkan.h:181
status
ov_status_e status
Definition: dnn_backend_openvino.c:100
mem.h
shdc_shader_compile
static int shdc_shader_compile(FFVulkanContext *s, FFVkSPIRVCompiler *ctx, FFVulkanShader *shd, uint8_t **data, size_t *size, const char *entrypoint, void **opaque)
Definition: vulkan_shaderc.c:24
ff_vk_shader_print
void ff_vk_shader_print(void *ctx, FFVulkanShader *shd, int prio)
Output the shader code as logging data, with a specific priority.
Definition: vulkan.c:1501
message
static int FUNC() message(CodedBitstreamContext *ctx, RWContext *rw, SEIRawMessage *current)
Definition: cbs_sei_syntax_template.c:227
av_freep
#define av_freep(p)
Definition: tableprint_vlc.h:34
FF_VK_EXT_DEBUG_UTILS
#define FF_VK_EXT_DEBUG_UTILS
Definition: vulkan_functions.h:36
av_log
#define av_log(a,...)
Definition: tableprint_vlc.h:27
shdc_uninit
static void shdc_uninit(FFVkSPIRVCompiler **ctx)
Definition: vulkan_shaderc.c:116