1 /*
2 * Copyright (c) 2024 Huawei Device Co., Ltd.
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 at
6 *
7 * http://www.apache.org/licenses/LICENSE-2.0
8 *
9 * Unless required by applicable law or agreed to in writing, software
10 * 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 and
13 * limitations under the License.
14 */
15
16 #include "vertex_input_declaration_loader.h"
17
18 #include <algorithm>
19
20 #include <core/io/intf_file_manager.h>
21 #include <core/namespace.h>
22 #include <render/device/pipeline_state_desc.h>
23
24 #include "json_format_serialization.h"
25 #include "json_util.h"
26 #include "util/log.h"
27
28 using namespace BASE_NS;
29 using namespace CORE_NS;
30
31 RENDER_BEGIN_NAMESPACE()
32 // clang-format off
33 CORE_JSON_SERIALIZE_ENUM(VertexInputRate,
34 {
35 { CORE_VERTEX_INPUT_RATE_VERTEX, "vertex" },
36 { CORE_VERTEX_INPUT_RATE_INSTANCE, "instance" },
37 })
38 // clang-format on
39 void FromJson(const json::value& jsonData, JsonContext<VertexInputDeclaration::VertexInputBindingDescription>& context)
40 {
41 SafeGetJsonValue(jsonData, "binding", context.error, context.data.binding);
42 SafeGetJsonValue(jsonData, "stride", context.error, context.data.stride);
43 SafeGetJsonEnum(jsonData, "vertexInputRate", context.error, context.data.vertexInputRate);
44 }
45
FromJson(const json::value & jsonData,JsonContext<VertexInputDeclaration::VertexInputAttributeDescription> & context)46 void FromJson(
47 const json::value& jsonData, JsonContext<VertexInputDeclaration::VertexInputAttributeDescription>& context)
48 {
49 SafeGetJsonValue(jsonData, "location", context.error, context.data.location);
50 SafeGetJsonValue(jsonData, "binding", context.error, context.data.binding);
51 SafeGetJsonEnum(jsonData, "format", context.error, context.data.format);
52 SafeGetJsonValue(jsonData, "offset", context.error, context.data.offset);
53 }
54
55 namespace {
LoadState(const json::value & jsonData,const string_view uri,VertexInputDeclarationData & vertexInputDeclarationData_)56 VertexInputDeclarationLoader::LoadResult LoadState(
57 const json::value& jsonData, const string_view uri, VertexInputDeclarationData& vertexInputDeclarationData_)
58 {
59 VertexInputDeclarationLoader::LoadResult result;
60
61 vector<VertexInputDeclaration::VertexInputBindingDescription> bindings;
62 vector<VertexInputDeclaration::VertexInputAttributeDescription> attributes;
63
64 ParseArray<decltype(bindings)::value_type>(jsonData, "vertexInputBindingDescriptions", bindings, result);
65 ParseArray<decltype(attributes)::value_type>(jsonData, "vertexInputAttributeDescriptions", attributes, result);
66
67 if (result.success) {
68 PLUGIN_ASSERT(bindings.size() <= PipelineStateConstants::MAX_VERTEX_BUFFER_COUNT);
69 PLUGIN_ASSERT(attributes.size() <= PipelineStateConstants::MAX_VERTEX_BUFFER_COUNT);
70
71 vertexInputDeclarationData_.bindingDescriptionCount =
72 std::min(static_cast<uint32_t>(bindings.size()), PipelineStateConstants::MAX_VERTEX_BUFFER_COUNT);
73 vertexInputDeclarationData_.attributeDescriptionCount =
74 std::min(static_cast<uint32_t>(attributes.size()), PipelineStateConstants::MAX_VERTEX_BUFFER_COUNT);
75
76 for (uint32_t idx = 0; idx < vertexInputDeclarationData_.bindingDescriptionCount; ++idx) {
77 vertexInputDeclarationData_.bindingDescriptions[idx] = bindings[idx];
78 }
79 for (uint32_t idx = 0; idx < vertexInputDeclarationData_.attributeDescriptionCount; ++idx) {
80 vertexInputDeclarationData_.attributeDescriptions[idx] = attributes[idx];
81 if (vertexInputDeclarationData_.attributeDescriptions[idx].format == Format::BASE_FORMAT_UNDEFINED) {
82 result.success = false;
83 result.error += "undefined format for vertex input attribute\n";
84 PLUGIN_LOG_E("undefined format in vertex input attribute (%u), in %s", idx, uri.data());
85 }
86 }
87 }
88
89 return result;
90 }
91
Load(const json::value & jsonData,const string_view uri,VertexInputDeclarationData & vertexInputDeclarationData_)92 VertexInputDeclarationLoader::LoadResult Load(
93 const json::value& jsonData, const string_view uri, VertexInputDeclarationData& vertexInputDeclarationData_)
94 {
95 VertexInputDeclarationLoader::LoadResult result;
96
97 #if (RENDER_VALIDATION_ENABLED == 1)
98 {
99 string name;
100 SafeGetJsonValue(jsonData, "name", result.error, name);
101 if (!name.empty()) {
102 PLUGIN_LOG_W("RENDER_VALIDATION: name not supported in vertex input declaration json");
103 }
104 }
105 #endif
106 if (const json::value* stateIter = jsonData.find("vertexInputState"); stateIter) {
107 result = LoadState(*stateIter, uri, vertexInputDeclarationData_);
108 } else {
109 result.error += "vertex input state not found\n";
110 result.success = false;
111 }
112
113 return result;
114 }
115 } // namespace
116
GetUri() const117 string_view VertexInputDeclarationLoader::GetUri() const
118 {
119 return uri_;
120 }
121
GetVertexInputDeclarationView() const122 VertexInputDeclarationView VertexInputDeclarationLoader::GetVertexInputDeclarationView() const
123 {
124 return {
125 array_view<const VertexInputDeclaration::VertexInputBindingDescription>(
126 vertexInputDeclarationData_.bindingDescriptions, vertexInputDeclarationData_.bindingDescriptionCount),
127 array_view<const VertexInputDeclaration::VertexInputAttributeDescription>(
128 vertexInputDeclarationData_.attributeDescriptions, vertexInputDeclarationData_.attributeDescriptionCount),
129 };
130 }
131
Load(const string_view jsonString)132 VertexInputDeclarationLoader::LoadResult VertexInputDeclarationLoader::Load(const string_view jsonString)
133 {
134 VertexInputDeclarationLoader::LoadResult result;
135 const auto json = json::parse(jsonString.data());
136 if (json) {
137 result = RENDER_NS::Load(json, uri_, vertexInputDeclarationData_);
138 } else {
139 result.success = false;
140 result.error = "Invalid json file.";
141 }
142
143 return result;
144 }
145
Load(IFileManager & fileManager,const string_view uri)146 VertexInputDeclarationLoader::LoadResult VertexInputDeclarationLoader::Load(
147 IFileManager& fileManager, const string_view uri)
148 {
149 uri_ = uri;
150 LoadResult result;
151
152 IFile::Ptr file = fileManager.OpenFile(uri);
153 if (!file) {
154 PLUGIN_LOG_E("Error loading '%s'", string(uri).c_str());
155 return LoadResult("Failed to open file.");
156 }
157
158 const uint64_t byteLength = file->GetLength();
159
160 string raw;
161 raw.resize(static_cast<size_t>(byteLength));
162
163 if (file->Read(raw.data(), byteLength) != byteLength) {
164 PLUGIN_LOG_E("Error loading '%s'", string(uri).c_str());
165 return LoadResult("Failed to read file.");
166 }
167
168 return Load(string_view(raw));
169 }
170
171 RENDER_END_NAMESPACE()
172