Project import generated by Copybara.
GitOrigin-RevId: f4b1fe3f15810450fb6539e733f6a260d3ee082c
This commit is contained in:
MediaPipe Team
@@ -180,15 +180,66 @@ cc_library(
|
||||
],
|
||||
)
|
||||
|
||||
mediapipe_proto_library(
|
||||
name = "field_data_proto",
|
||||
srcs = ["field_data.proto"],
|
||||
visibility = ["//visibility:public"],
|
||||
deps = ["@com_google_protobuf//:any_proto"],
|
||||
)
|
||||
|
||||
cc_library(
|
||||
name = "options_field_util",
|
||||
srcs = ["options_field_util.cc"],
|
||||
hdrs = ["options_field_util.h"],
|
||||
visibility = ["//mediapipe/framework:mediapipe_internal"],
|
||||
deps = [
|
||||
":field_data_cc_proto",
|
||||
":name_util",
|
||||
":options_registry",
|
||||
":proto_util_lite",
|
||||
"//mediapipe/framework:calculator_cc_proto",
|
||||
"//mediapipe/framework:packet",
|
||||
"//mediapipe/framework:packet_type",
|
||||
"//mediapipe/framework/port:advanced_proto",
|
||||
"//mediapipe/framework/port:any_proto",
|
||||
"//mediapipe/framework/port:status",
|
||||
"@com_google_absl//absl/status",
|
||||
"@com_google_absl//absl/strings",
|
||||
],
|
||||
)
|
||||
|
||||
cc_library(
|
||||
name = "options_syntax_util",
|
||||
srcs = ["options_syntax_util.cc"],
|
||||
hdrs = ["options_syntax_util.h"],
|
||||
visibility = ["//mediapipe/framework:mediapipe_internal"],
|
||||
deps = [
|
||||
":name_util",
|
||||
":options_field_util",
|
||||
":options_registry",
|
||||
"//mediapipe/framework:calculator_cc_proto",
|
||||
"//mediapipe/framework:packet",
|
||||
"//mediapipe/framework:packet_type",
|
||||
"//mediapipe/framework/port:advanced_proto",
|
||||
"//mediapipe/framework/port:any_proto",
|
||||
"//mediapipe/framework/port:status",
|
||||
"@com_google_absl//absl/strings",
|
||||
],
|
||||
)
|
||||
|
||||
cc_library(
|
||||
name = "options_util",
|
||||
srcs = ["options_util.cc"],
|
||||
hdrs = ["options_util.h"],
|
||||
visibility = ["//mediapipe/framework:mediapipe_internal"],
|
||||
deps = [
|
||||
":options_field_util",
|
||||
":options_map",
|
||||
":options_registry",
|
||||
":options_syntax_util",
|
||||
":proto_util_lite",
|
||||
"//mediapipe/framework:calculator_cc_proto",
|
||||
"//mediapipe/framework:calculator_context",
|
||||
"//mediapipe/framework:collection",
|
||||
"//mediapipe/framework:input_stream_shard",
|
||||
"//mediapipe/framework:output_side_packet",
|
||||
@@ -199,7 +250,7 @@ cc_library(
|
||||
"//mediapipe/framework/port:advanced_proto",
|
||||
"//mediapipe/framework/port:any_proto",
|
||||
"//mediapipe/framework/port:status",
|
||||
"//mediapipe/framework/tool:type_util",
|
||||
"//mediapipe/framework/tool:name_util",
|
||||
"@com_google_absl//absl/strings",
|
||||
],
|
||||
)
|
||||
@@ -227,6 +278,8 @@ cc_library(
|
||||
"//mediapipe/framework/deps:registration",
|
||||
"//mediapipe/framework/port:advanced_proto",
|
||||
"//mediapipe/framework/port:logging",
|
||||
"@com_google_absl//absl/container:flat_hash_map",
|
||||
"@com_google_absl//absl/synchronization",
|
||||
],
|
||||
)
|
||||
|
||||
@@ -246,11 +299,13 @@ mediapipe_cc_test(
|
||||
"//mediapipe/framework:calculator_framework",
|
||||
"//mediapipe/framework:calculator_runner",
|
||||
"//mediapipe/framework:validated_graph_config",
|
||||
"//mediapipe/framework/deps:message_matchers",
|
||||
"//mediapipe/framework/port:gtest_main",
|
||||
"//mediapipe/framework/port:parse_text_proto",
|
||||
"//mediapipe/framework/port:status",
|
||||
"//mediapipe/framework/testdata:night_light_calculator_options_lib",
|
||||
"//mediapipe/framework/tool:node_chain_subgraph_options_lib",
|
||||
"//mediapipe/framework/tool:options_syntax_util",
|
||||
"//mediapipe/util:header_util",
|
||||
],
|
||||
)
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
// Copyright 2019 The MediaPipe Authors.
|
||||
//
|
||||
// Licensed under the Apache License, Version 2.0 (the "License");
|
||||
// you may not use this file except in compliance with the License.
|
||||
// You may obtain a copy of the License at
|
||||
//
|
||||
// http://www.apache.org/licenses/LICENSE-2.0
|
||||
//
|
||||
// Unless required by applicable law or agreed to in writing, software
|
||||
// distributed under the License is distributed on an "AS IS" BASIS,
|
||||
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
// See the License for the specific language governing permissions and
|
||||
// limitations under the License.
|
||||
//
|
||||
// Forked from mediapipe/framework/tool/source.proto.
|
||||
// The forked proto must remain identical to the original proto and should be
|
||||
// ONLY used by mediapipe open source project.
|
||||
|
||||
syntax = "proto2";
|
||||
|
||||
package mediapipe;
|
||||
|
||||
// `MessageData`, like protobuf.Any, contains an arbitrary serialized protbuf
|
||||
// along with a URL that describes the type of the serialized message.
|
||||
message MessageData {
|
||||
// A URL/resource name that identifies the type of serialized protbuf.
|
||||
optional string type_url = 1;
|
||||
|
||||
// Must be a valid serialized protocol buffer of the above specified type.
|
||||
optional bytes value = 2;
|
||||
}
|
||||
|
||||
// Data for one Protobuf field or one MediaPipe packet.
|
||||
message FieldData {
|
||||
oneof value {
|
||||
sint32 int32_value = 1;
|
||||
sint64 int64_value = 2;
|
||||
uint32 uint32_value = 3;
|
||||
uint64 uint64_value = 4;
|
||||
double double_value = 5;
|
||||
float float_value = 6;
|
||||
bool bool_value = 7;
|
||||
sint32 enum_value = 8;
|
||||
string string_value = 9;
|
||||
MessageData message_value = 10;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,495 @@
|
||||
|
||||
#include "mediapipe/framework/tool/options_field_util.h"
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <tuple>
|
||||
#include <vector>
|
||||
|
||||
#include "absl/status/status.h"
|
||||
#include "absl/strings/str_cat.h"
|
||||
#include "mediapipe/framework/packet.h"
|
||||
#include "mediapipe/framework/packet_type.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
#include "mediapipe/framework/port/any_proto.h"
|
||||
#include "mediapipe/framework/port/canonical_errors.h"
|
||||
#include "mediapipe/framework/port/status.h"
|
||||
#include "mediapipe/framework/tool/name_util.h"
|
||||
#include "mediapipe/framework/tool/proto_util_lite.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
namespace options_field_util {
|
||||
|
||||
using ::mediapipe::proto_ns::internal::WireFormatLite;
|
||||
using FieldType = WireFormatLite::FieldType;
|
||||
using ::mediapipe::proto_ns::io::ArrayInputStream;
|
||||
using ::mediapipe::proto_ns::io::CodedInputStream;
|
||||
using ::mediapipe::proto_ns::io::CodedOutputStream;
|
||||
using ::mediapipe::proto_ns::io::StringOutputStream;
|
||||
|
||||
// Utility functions for OptionsFieldUtil.
|
||||
namespace {
|
||||
|
||||
// Converts a FieldDescriptor::Type to the corresponding FieldType.
|
||||
FieldType AsFieldType(proto_ns::FieldDescriptorProto::Type type) {
|
||||
return static_cast<FieldType>(type);
|
||||
}
|
||||
|
||||
absl::Status WriteValue(const FieldData& value, FieldType field_type,
|
||||
std::string* field_bytes) {
|
||||
StringOutputStream sos(field_bytes);
|
||||
CodedOutputStream out(&sos);
|
||||
switch (field_type) {
|
||||
case WireFormatLite::TYPE_INT32:
|
||||
WireFormatLite::WriteInt32NoTag(value.int32_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_SINT32:
|
||||
WireFormatLite::WriteSInt32NoTag(value.int32_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_INT64:
|
||||
WireFormatLite::WriteInt64NoTag(value.int64_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_SINT64:
|
||||
WireFormatLite::WriteSInt64NoTag(value.int64_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_UINT32:
|
||||
WireFormatLite::WriteUInt32NoTag(value.uint32_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_UINT64:
|
||||
WireFormatLite::WriteUInt64NoTag(value.uint64_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_DOUBLE:
|
||||
WireFormatLite::WriteDoubleNoTag(value.uint64_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_FLOAT:
|
||||
WireFormatLite::WriteFloatNoTag(value.float_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_BOOL:
|
||||
WireFormatLite::WriteBoolNoTag(value.bool_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_ENUM:
|
||||
WireFormatLite::WriteEnumNoTag(value.enum_value(), &out);
|
||||
break;
|
||||
case WireFormatLite::TYPE_STRING:
|
||||
out.WriteString(value.string_value());
|
||||
break;
|
||||
case WireFormatLite::TYPE_MESSAGE:
|
||||
out.WriteString(value.message_value().value());
|
||||
break;
|
||||
default:
|
||||
return absl::UnimplementedError(
|
||||
absl::StrCat("Cannot write type: ", field_type));
|
||||
}
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
// Serializes a packet value.
|
||||
absl::Status WriteField(const FieldData& packet, const FieldDescriptor* field,
|
||||
std::string* result) {
|
||||
FieldType field_type = AsFieldType(field->type());
|
||||
return WriteValue(packet, field_type, result);
|
||||
}
|
||||
|
||||
template <typename ValueT, FieldType kFieldType>
|
||||
static ValueT ReadValue(absl::string_view field_bytes, absl::Status* status) {
|
||||
ArrayInputStream ais(field_bytes.data(), field_bytes.size());
|
||||
CodedInputStream input(&ais);
|
||||
ValueT result;
|
||||
if (!WireFormatLite::ReadPrimitive<ValueT, kFieldType>(&input, &result)) {
|
||||
status->Update(mediapipe::InvalidArgumentError(absl::StrCat(
|
||||
"Bad serialized value: ", MediaPipeTypeStringOrDemangled<ValueT>(),
|
||||
".")));
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
absl::Status ReadValue(absl::string_view field_bytes, FieldType field_type,
|
||||
absl::string_view message_type, FieldData* result) {
|
||||
absl::Status status;
|
||||
result->Clear();
|
||||
switch (field_type) {
|
||||
case WireFormatLite::TYPE_INT32:
|
||||
result->set_int32_value(
|
||||
ReadValue<int32, WireFormatLite::TYPE_INT32>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_SINT32:
|
||||
result->set_int32_value(
|
||||
ReadValue<int32, WireFormatLite::TYPE_SINT32>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_INT64:
|
||||
result->set_int64_value(
|
||||
ReadValue<int64, WireFormatLite::TYPE_INT64>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_SINT64:
|
||||
result->set_int64_value(
|
||||
ReadValue<int64, WireFormatLite::TYPE_SINT64>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_UINT32:
|
||||
result->set_uint32_value(
|
||||
ReadValue<uint32, WireFormatLite::TYPE_UINT32>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_UINT64:
|
||||
result->set_uint64_value(
|
||||
ReadValue<uint32, WireFormatLite::TYPE_UINT32>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_DOUBLE:
|
||||
result->set_double_value(
|
||||
ReadValue<double, WireFormatLite::TYPE_DOUBLE>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_FLOAT:
|
||||
result->set_float_value(
|
||||
ReadValue<float, WireFormatLite::TYPE_FLOAT>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_BOOL:
|
||||
result->set_bool_value(
|
||||
ReadValue<bool, WireFormatLite::TYPE_BOOL>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_ENUM:
|
||||
result->set_enum_value(
|
||||
ReadValue<int32, WireFormatLite::TYPE_ENUM>(field_bytes, &status));
|
||||
break;
|
||||
case WireFormatLite::TYPE_STRING:
|
||||
result->set_string_value(std::string(field_bytes));
|
||||
break;
|
||||
case WireFormatLite::TYPE_MESSAGE:
|
||||
result->mutable_message_value()->set_value(std::string(field_bytes));
|
||||
result->mutable_message_value()->set_type_url(TypeUrl(message_type));
|
||||
break;
|
||||
default:
|
||||
status = absl::UnimplementedError(
|
||||
absl::StrCat("Cannot read type: ", field_type));
|
||||
break;
|
||||
}
|
||||
return status;
|
||||
}
|
||||
|
||||
// Deserializes a packet from a protobuf field.
|
||||
absl::Status ReadField(absl::string_view bytes, const FieldDescriptor* field,
|
||||
FieldData* result) {
|
||||
FieldType field_type = AsFieldType(field->type());
|
||||
std::string message_type = (field_type == WireFormatLite::TYPE_MESSAGE)
|
||||
? field->message_type()->full_name()
|
||||
: "";
|
||||
return ReadValue(bytes, field_type, message_type, result);
|
||||
}
|
||||
|
||||
// Converts a chain of fields and indexes into field-numbers and indexes.
|
||||
ProtoUtilLite::ProtoPath AsProtoPath(const FieldPath& field_path) {
|
||||
ProtoUtilLite::ProtoPath result;
|
||||
for (auto field : field_path) {
|
||||
result.push_back({field.first->number(), field.second});
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
// Returns the options protobuf for a subgraph.
|
||||
// TODO: Ensure that this works with multiple options protobufs.
|
||||
absl::Status GetOptionsMessage(
|
||||
const proto_ns::RepeatedPtrField<mediapipe::protobuf::Any>& options_any,
|
||||
const proto_ns::MessageLite& options_ext, FieldData* result) {
|
||||
// Read the "graph_options" or "node_options" field.
|
||||
for (const auto& options : options_any) {
|
||||
if (options.type_url().empty()) {
|
||||
continue;
|
||||
}
|
||||
result->mutable_message_value()->set_type_url(options.type_url());
|
||||
result->mutable_message_value()->set_value(std::string(options.value()));
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
// Read the "options" field.
|
||||
FieldData message_data;
|
||||
*message_data.mutable_message_value()->mutable_value() =
|
||||
options_ext.SerializeAsString();
|
||||
message_data.mutable_message_value()->set_type_url(options_ext.GetTypeName());
|
||||
std::vector<const FieldDescriptor*> ext_fields;
|
||||
OptionsRegistry::FindAllExtensions(options_ext.GetTypeName(), &ext_fields);
|
||||
for (auto ext_field : ext_fields) {
|
||||
absl::Status status = GetField({{ext_field, 0}}, message_data, result);
|
||||
if (!status.ok()) {
|
||||
return status;
|
||||
}
|
||||
if (result->has_message_value()) {
|
||||
return status;
|
||||
}
|
||||
}
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
// Sets a protobuf in a repeated protobuf::Any field.
|
||||
void SetOptionsMessage(
|
||||
const FieldData& node_options,
|
||||
proto_ns::RepeatedPtrField<mediapipe::protobuf::Any>* result) {
|
||||
protobuf::Any* options_any = nullptr;
|
||||
for (auto& any : *result) {
|
||||
if (any.type_url() == node_options.message_value().type_url()) {
|
||||
options_any = &any;
|
||||
}
|
||||
}
|
||||
if (!options_any) {
|
||||
options_any = result->Add();
|
||||
options_any->set_type_url(node_options.message_value().type_url());
|
||||
}
|
||||
*options_any->mutable_value() = node_options.message_value().value();
|
||||
}
|
||||
|
||||
} // anonymous namespace
|
||||
|
||||
// Deserializes a packet containing a MessageLite value.
|
||||
absl::Status ReadMessage(const std::string& value, const std::string& type_name,
|
||||
Packet* result) {
|
||||
auto packet = packet_internal::PacketFromDynamicProto(type_name, value);
|
||||
if (packet.ok()) {
|
||||
*result = *packet;
|
||||
}
|
||||
return packet.status();
|
||||
}
|
||||
|
||||
// Merge two options FieldData values.
|
||||
absl::Status MergeOptionsMessages(const FieldData& base, const FieldData& over,
|
||||
FieldData* result) {
|
||||
absl::Status status;
|
||||
if (over.value_case() == FieldData::VALUE_NOT_SET) {
|
||||
*result = base;
|
||||
return status;
|
||||
}
|
||||
if (base.value_case() == FieldData::VALUE_NOT_SET) {
|
||||
*result = over;
|
||||
return status;
|
||||
}
|
||||
if (over.value_case() != base.value_case()) {
|
||||
return absl::InvalidArgumentError(absl::StrCat(
|
||||
"Cannot merge field data with data types: ", base.value_case(), ", ",
|
||||
over.value_case()));
|
||||
}
|
||||
if (over.message_value().type_url() != base.message_value().type_url()) {
|
||||
return absl::InvalidArgumentError(
|
||||
absl::StrCat("Cannot merge field data with message types: ",
|
||||
base.message_value().type_url(), ", ",
|
||||
over.message_value().type_url()));
|
||||
}
|
||||
absl::Cord merged_value;
|
||||
merged_value.Append(base.message_value().value());
|
||||
merged_value.Append(over.message_value().value());
|
||||
result->mutable_message_value()->set_type_url(
|
||||
base.message_value().type_url());
|
||||
result->mutable_message_value()->set_value(std::string(merged_value));
|
||||
return status;
|
||||
}
|
||||
|
||||
// Writes a FieldData value into protobuf field.
|
||||
absl::Status SetField(const FieldPath& field_path, const FieldData& value,
|
||||
FieldData* message_data) {
|
||||
if (field_path.empty()) {
|
||||
*message_data->mutable_message_value() = value.message_value();
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
ProtoUtilLite proto_util;
|
||||
const FieldDescriptor* field = field_path.back().first;
|
||||
FieldType field_type = AsFieldType(field->type());
|
||||
std::string field_value;
|
||||
MP_RETURN_IF_ERROR(WriteField(value, field, &field_value));
|
||||
ProtoUtilLite::ProtoPath proto_path = AsProtoPath(field_path);
|
||||
std::string* message_bytes =
|
||||
message_data->mutable_message_value()->mutable_value();
|
||||
int field_count;
|
||||
MP_RETURN_IF_ERROR(proto_util.GetFieldCount(*message_bytes, proto_path,
|
||||
field_type, &field_count));
|
||||
MP_RETURN_IF_ERROR(
|
||||
proto_util.ReplaceFieldRange(message_bytes, AsProtoPath(field_path),
|
||||
field_count, field_type, {field_value}));
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
// Merges a packet value into nested protobuf Message.
|
||||
absl::Status MergeField(const FieldPath& field_path, const FieldData& value,
|
||||
FieldData* message_data) {
|
||||
absl::Status status;
|
||||
FieldType field_type = field_path.empty()
|
||||
? FieldType::TYPE_MESSAGE
|
||||
: AsFieldType(field_path.back().first->type());
|
||||
std::string message_type =
|
||||
(value.has_message_value())
|
||||
? ParseTypeUrl(std::string(value.message_value().type_url()))
|
||||
: "";
|
||||
FieldData v = value;
|
||||
if (field_type == FieldType::TYPE_MESSAGE) {
|
||||
FieldData b;
|
||||
status.Update(GetField(field_path, *message_data, &b));
|
||||
status.Update(MergeOptionsMessages(b, v, &v));
|
||||
}
|
||||
status.Update(SetField(field_path, v, message_data));
|
||||
return status;
|
||||
}
|
||||
|
||||
// Reads a packet value from a protobuf field.
|
||||
absl::Status GetField(const FieldPath& field_path,
|
||||
const FieldData& message_data, FieldData* result) {
|
||||
if (field_path.empty()) {
|
||||
*result->mutable_message_value() = message_data.message_value();
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
ProtoUtilLite proto_util;
|
||||
const FieldDescriptor* field = field_path.back().first;
|
||||
FieldType field_type = AsFieldType(field->type());
|
||||
std::vector<std::string> field_values;
|
||||
ProtoUtilLite::ProtoPath proto_path = AsProtoPath(field_path);
|
||||
const std::string& message_bytes = message_data.message_value().value();
|
||||
int field_count;
|
||||
MP_RETURN_IF_ERROR(proto_util.GetFieldCount(message_bytes, proto_path,
|
||||
field_type, &field_count));
|
||||
if (field_count == 0) {
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
MP_RETURN_IF_ERROR(proto_util.GetFieldRange(message_bytes, proto_path, 1,
|
||||
field_type, &field_values));
|
||||
MP_RETURN_IF_ERROR(ReadField(field_values.front(), field, result));
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
// Returns the options protobuf for a graph.
|
||||
absl::Status GetOptionsMessage(const CalculatorGraphConfig& config,
|
||||
FieldData* result) {
|
||||
return GetOptionsMessage(config.graph_options(), config.options(), result);
|
||||
}
|
||||
|
||||
// Returns the options protobuf for a node.
|
||||
absl::Status GetOptionsMessage(const CalculatorGraphConfig::Node& node,
|
||||
FieldData* result) {
|
||||
return GetOptionsMessage(node.node_options(), node.options(), result);
|
||||
}
|
||||
|
||||
// Sets the node_options field in a Node, and clears the options field.
|
||||
void SetOptionsMessage(const FieldData& node_options,
|
||||
CalculatorGraphConfig::Node* node) {
|
||||
SetOptionsMessage(node_options, node->mutable_node_options());
|
||||
node->clear_options();
|
||||
}
|
||||
|
||||
// Represents a protobuf enum value stored in a Packet.
|
||||
struct ProtoEnum {
|
||||
ProtoEnum(int32 v) : value(v) {}
|
||||
int32 value;
|
||||
};
|
||||
|
||||
absl::Status AsPacket(const FieldData& data, Packet* result) {
|
||||
switch (data.value_case()) {
|
||||
case FieldData::ValueCase::kInt32Value:
|
||||
*result = MakePacket<int32>(data.int32_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kInt64Value:
|
||||
*result = MakePacket<int64>(data.int64_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kUint32Value:
|
||||
*result = MakePacket<uint32>(data.uint32_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kUint64Value:
|
||||
*result = MakePacket<uint64>(data.uint64_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kDoubleValue:
|
||||
*result = MakePacket<double>(data.double_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kFloatValue:
|
||||
*result = MakePacket<float>(data.float_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kBoolValue:
|
||||
*result = MakePacket<bool>(data.bool_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kEnumValue:
|
||||
*result = MakePacket<ProtoEnum>(data.enum_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kStringValue:
|
||||
*result = MakePacket<std::string>(data.string_value());
|
||||
break;
|
||||
case FieldData::ValueCase::kMessageValue: {
|
||||
auto r = packet_internal::PacketFromDynamicProto(
|
||||
ParseTypeUrl(std::string(data.message_value().type_url())),
|
||||
std::string(data.message_value().value()));
|
||||
if (!r.ok()) {
|
||||
return r.status();
|
||||
}
|
||||
*result = r.value();
|
||||
break;
|
||||
}
|
||||
case FieldData::VALUE_NOT_SET:
|
||||
*result = Packet();
|
||||
}
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
absl::Status AsFieldData(Packet packet, FieldData* result) {
|
||||
static const auto* kTypeIds = new std::map<size_t, int32>{
|
||||
{tool::GetTypeHash<int32>(), WireFormatLite::CPPTYPE_INT32},
|
||||
{tool::GetTypeHash<int64>(), WireFormatLite::CPPTYPE_INT64},
|
||||
{tool::GetTypeHash<uint32>(), WireFormatLite::CPPTYPE_UINT32},
|
||||
{tool::GetTypeHash<uint64>(), WireFormatLite::CPPTYPE_UINT64},
|
||||
{tool::GetTypeHash<double>(), WireFormatLite::CPPTYPE_DOUBLE},
|
||||
{tool::GetTypeHash<float>(), WireFormatLite::CPPTYPE_FLOAT},
|
||||
{tool::GetTypeHash<bool>(), WireFormatLite::CPPTYPE_BOOL},
|
||||
{tool::GetTypeHash<ProtoEnum>(), WireFormatLite::CPPTYPE_ENUM},
|
||||
{tool::GetTypeHash<std::string>(), WireFormatLite::CPPTYPE_STRING},
|
||||
};
|
||||
|
||||
if (packet.ValidateAsProtoMessageLite().ok()) {
|
||||
result->mutable_message_value()->set_value(
|
||||
packet.GetProtoMessageLite().SerializeAsString());
|
||||
result->mutable_message_value()->set_type_url(
|
||||
TypeUrl(packet.GetProtoMessageLite().GetTypeName()));
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
if (kTypeIds->count(packet.GetTypeId()) == 0) {
|
||||
return absl::UnimplementedError(absl::StrCat(
|
||||
"Cannot construct FieldData for: ", packet.DebugTypeName()));
|
||||
}
|
||||
|
||||
switch (kTypeIds->at(packet.GetTypeId())) {
|
||||
case WireFormatLite::CPPTYPE_INT32:
|
||||
result->set_int32_value(packet.Get<int32>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_INT64:
|
||||
result->set_int64_value(packet.Get<int64>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_UINT32:
|
||||
result->set_uint32_value(packet.Get<uint32>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_UINT64:
|
||||
result->set_uint64_value(packet.Get<uint64>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_DOUBLE:
|
||||
result->set_double_value(packet.Get<double>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_FLOAT:
|
||||
result->set_float_value(packet.Get<float>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_BOOL:
|
||||
result->set_bool_value(packet.Get<bool>());
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_ENUM:
|
||||
result->set_enum_value(packet.Get<ProtoEnum>().value);
|
||||
break;
|
||||
case WireFormatLite::CPPTYPE_STRING:
|
||||
result->set_string_value(packet.Get<std::string>());
|
||||
break;
|
||||
}
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
std::string TypeUrl(absl::string_view type_name) {
|
||||
constexpr std::string_view kTypeUrlPrefix = "type.googleapis.com/";
|
||||
return absl::StrCat(std::string(kTypeUrlPrefix), std::string(type_name));
|
||||
}
|
||||
|
||||
std::string ParseTypeUrl(absl::string_view type_url) {
|
||||
constexpr std::string_view kTypeUrlPrefix = "type.googleapis.com/";
|
||||
if (std::string(type_url).rfind(kTypeUrlPrefix, 0) == 0) {
|
||||
return std::string(
|
||||
type_url.substr(kTypeUrlPrefix.length(), std::string::npos));
|
||||
}
|
||||
return std::string(type_url);
|
||||
}
|
||||
|
||||
} // namespace options_field_util
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
@@ -0,0 +1,73 @@
|
||||
#ifndef MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_FIELD_UTIL_H_
|
||||
#define MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_FIELD_UTIL_H_
|
||||
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "mediapipe/framework/calculator.pb.h"
|
||||
#include "mediapipe/framework/packet.h"
|
||||
#include "mediapipe/framework/packet_type.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
#include "mediapipe/framework/port/proto_ns.h"
|
||||
#include "mediapipe/framework/tool/field_data.pb.h"
|
||||
#include "mediapipe/framework/tool/options_registry.h"
|
||||
|
||||
namespace mediapipe {
|
||||
|
||||
namespace tool {
|
||||
|
||||
// Utility to read and write Packet data from protobuf fields.
|
||||
namespace options_field_util {
|
||||
|
||||
// A chain of nested fields and indexes.
|
||||
using FieldPath = std::vector<std::pair<const FieldDescriptor*, int>>;
|
||||
|
||||
// Writes a field value into protobuf field.
|
||||
absl::Status SetField(const FieldPath& field_path, const FieldData& value,
|
||||
FieldData* message_data);
|
||||
|
||||
// Reads a field value from a protobuf field.
|
||||
absl::Status GetField(const FieldPath& field_path,
|
||||
const FieldData& message_data, FieldData* result);
|
||||
|
||||
// Merges a field value into nested protobuf Message.
|
||||
absl::Status MergeField(const FieldPath& field_path, const FieldData& value,
|
||||
FieldData* message_data);
|
||||
|
||||
// Deserializes a packet containing a MessageLite value.
|
||||
absl::Status ReadMessage(const std::string& value, const std::string& type_name,
|
||||
Packet* result);
|
||||
|
||||
// Merge two options protobuf field values.
|
||||
absl::Status MergeOptionsMessages(const FieldData& base, const FieldData& over,
|
||||
FieldData* result);
|
||||
|
||||
// Returns the options protobuf for a graph.
|
||||
absl::Status GetOptionsMessage(const CalculatorGraphConfig& config,
|
||||
FieldData* result);
|
||||
|
||||
// Returns the options protobuf for a node.
|
||||
absl::Status GetOptionsMessage(const CalculatorGraphConfig::Node& node,
|
||||
FieldData* result);
|
||||
|
||||
// Sets the node_options field in a Node, and clears the options field.
|
||||
void SetOptionsMessage(const FieldData& node_options,
|
||||
CalculatorGraphConfig::Node* node);
|
||||
|
||||
// Constructs a Packet for a FieldData proto.
|
||||
absl::Status AsPacket(const FieldData& data, Packet* result);
|
||||
|
||||
// Constructs a FieldData proto for a Packet.
|
||||
absl::Status AsFieldData(Packet packet, FieldData* result);
|
||||
|
||||
// Returns the protobuf type-url for a protobuf type-name.
|
||||
std::string TypeUrl(absl::string_view type_name);
|
||||
|
||||
// Returns the protobuf type-name for a protobuf type-url.
|
||||
std::string ParseTypeUrl(absl::string_view type_url);
|
||||
|
||||
} // namespace options_field_util
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
|
||||
#endif // MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_FIELD_UTIL_H_
|
||||
@@ -1,47 +1,112 @@
|
||||
#include "mediapipe/framework/tool/options_registry.h"
|
||||
|
||||
#include "absl/synchronization/mutex.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
|
||||
proto_ns::DescriptorPool* OptionsRegistry::options_descriptor_pool() {
|
||||
static proto_ns::DescriptorPool* result = new proto_ns::DescriptorPool();
|
||||
return result;
|
||||
namespace {
|
||||
|
||||
// Returns a canonical message type name, with any leading "." removed.
|
||||
std::string CanonicalTypeName(const std::string& type_name) {
|
||||
return (type_name.rfind('.', 0) == 0) ? type_name.substr(1) : type_name;
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
RegistrationToken OptionsRegistry::Register(
|
||||
const proto_ns::FileDescriptorSet& files) {
|
||||
absl::MutexLock lock(&mutex());
|
||||
for (auto& file : files.file()) {
|
||||
options_descriptor_pool()->BuildFile(file);
|
||||
for (auto& message_type : file.message_type()) {
|
||||
Register(message_type, file.package());
|
||||
}
|
||||
}
|
||||
return RegistrationToken([]() {});
|
||||
}
|
||||
|
||||
const proto_ns::Descriptor* OptionsRegistry::GetProtobufDescriptor(
|
||||
const std::string& type_name) {
|
||||
const proto_ns::Descriptor* result =
|
||||
proto_ns::DescriptorPool::generated_pool()->FindMessageTypeByName(
|
||||
type_name);
|
||||
if (!result) {
|
||||
result = options_descriptor_pool()->FindMessageTypeByName(type_name);
|
||||
void OptionsRegistry::Register(const proto_ns::DescriptorProto& message_type,
|
||||
const std::string& parent_name) {
|
||||
auto full_name = absl::StrCat(parent_name, ".", message_type.name());
|
||||
descriptors()[full_name] = Descriptor(message_type, full_name);
|
||||
for (auto& nested : message_type.nested_type()) {
|
||||
Register(nested, full_name);
|
||||
}
|
||||
return result;
|
||||
for (auto& extension : message_type.extension()) {
|
||||
extensions()[CanonicalTypeName(extension.extendee())].push_back(
|
||||
FieldDescriptor(extension));
|
||||
}
|
||||
}
|
||||
|
||||
const Descriptor* OptionsRegistry::GetProtobufDescriptor(
|
||||
const std::string& type_name) {
|
||||
absl::ReaderMutexLock lock(&mutex());
|
||||
auto it = descriptors().find(CanonicalTypeName(type_name));
|
||||
return (it == descriptors().end()) ? nullptr : &it->second;
|
||||
}
|
||||
|
||||
void OptionsRegistry::FindAllExtensions(
|
||||
const proto_ns::Descriptor& extendee,
|
||||
std::vector<const proto_ns::FieldDescriptor*>* result) {
|
||||
using proto_ns::DescriptorPool;
|
||||
std::vector<const proto_ns::FieldDescriptor*> extensions;
|
||||
DescriptorPool::generated_pool()->FindAllExtensions(&extendee, &extensions);
|
||||
options_descriptor_pool()->FindAllExtensions(&extendee, &extensions);
|
||||
absl::flat_hash_set<int> numbers;
|
||||
for (const proto_ns::FieldDescriptor* extension : extensions) {
|
||||
bool inserted = numbers.insert(extension->number()).second;
|
||||
if (inserted) {
|
||||
result->push_back(extension);
|
||||
absl::string_view extendee, std::vector<const FieldDescriptor*>* result) {
|
||||
absl::ReaderMutexLock lock(&mutex());
|
||||
result->clear();
|
||||
if (extensions().count(extendee) > 0) {
|
||||
for (const FieldDescriptor& field : extensions().at(extendee)) {
|
||||
result->push_back(&field);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
absl::flat_hash_map<std::string, Descriptor>& OptionsRegistry::descriptors() {
|
||||
static auto* descriptors = new absl::flat_hash_map<std::string, Descriptor>();
|
||||
return *descriptors;
|
||||
}
|
||||
|
||||
absl::flat_hash_map<std::string, std::vector<FieldDescriptor>>&
|
||||
OptionsRegistry::extensions() {
|
||||
static auto* extensions =
|
||||
new absl::flat_hash_map<std::string, std::vector<FieldDescriptor>>();
|
||||
return *extensions;
|
||||
}
|
||||
|
||||
absl::Mutex& OptionsRegistry::mutex() {
|
||||
static auto* mutex = new absl::Mutex();
|
||||
return *mutex;
|
||||
}
|
||||
|
||||
Descriptor::Descriptor(const proto_ns::DescriptorProto& proto,
|
||||
const std::string& full_name)
|
||||
: full_name_(full_name) {
|
||||
for (auto& field : proto.field()) {
|
||||
fields_[field.name()] = FieldDescriptor(field);
|
||||
}
|
||||
}
|
||||
|
||||
const std::string& Descriptor::full_name() const { return full_name_; }
|
||||
|
||||
const FieldDescriptor* Descriptor::FindFieldByName(
|
||||
const std::string& name) const {
|
||||
auto it = fields_.find(name);
|
||||
return (it != fields_.end()) ? &it->second : nullptr;
|
||||
}
|
||||
|
||||
FieldDescriptor::FieldDescriptor(const proto_ns::FieldDescriptorProto& proto) {
|
||||
name_ = proto.name();
|
||||
message_type_ = CanonicalTypeName(proto.type_name());
|
||||
type_ = proto.type();
|
||||
number_ = proto.number();
|
||||
}
|
||||
|
||||
const std::string& FieldDescriptor::name() const { return name_; }
|
||||
|
||||
int FieldDescriptor::number() const { return number_; }
|
||||
|
||||
proto_ns::FieldDescriptorProto::Type FieldDescriptor::type() const {
|
||||
return type_;
|
||||
}
|
||||
|
||||
const Descriptor* FieldDescriptor::message_type() const {
|
||||
return OptionsRegistry::GetProtobufDescriptor(message_type_);
|
||||
}
|
||||
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
|
||||
@@ -1,12 +1,16 @@
|
||||
#ifndef MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_REGISTRY_H_
|
||||
#define MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_REGISTRY_H_
|
||||
|
||||
#include "absl/container/flat_hash_map.h"
|
||||
#include "mediapipe/framework/deps/registration.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
|
||||
class Descriptor;
|
||||
class FieldDescriptor;
|
||||
|
||||
// A static registry that stores descriptors for protobufs used in MediaPipe
|
||||
// calculator options. Lite-proto builds do not normally include descriptors.
|
||||
// These registered descriptors allow individual protobuf fields to be
|
||||
@@ -17,23 +21,60 @@ class OptionsRegistry {
|
||||
static RegistrationToken Register(const proto_ns::FileDescriptorSet& files);
|
||||
|
||||
// Finds the descriptor for a protobuf.
|
||||
static const proto_ns::Descriptor* GetProtobufDescriptor(
|
||||
const std::string& type_name);
|
||||
static const Descriptor* GetProtobufDescriptor(const std::string& type_name);
|
||||
|
||||
// Returns all known proto2 extensions to a type.
|
||||
static void FindAllExtensions(
|
||||
const proto_ns::Descriptor& extendee,
|
||||
std::vector<const proto_ns::FieldDescriptor*>* result);
|
||||
static void FindAllExtensions(absl::string_view extendee,
|
||||
std::vector<const FieldDescriptor*>* result);
|
||||
|
||||
private:
|
||||
// Stores the descriptors for each options protobuf type.
|
||||
static proto_ns::DescriptorPool* options_descriptor_pool();
|
||||
// Registers protobuf descriptors a MessageLite and nested types.
|
||||
static void Register(const proto_ns::DescriptorProto& message_type,
|
||||
const std::string& parent_name);
|
||||
|
||||
static absl::flat_hash_map<std::string, Descriptor>& descriptors();
|
||||
static absl::flat_hash_map<std::string, std::vector<FieldDescriptor>>&
|
||||
extensions();
|
||||
static absl::Mutex& mutex();
|
||||
|
||||
// Registers the descriptors for each options protobuf type.
|
||||
template <class MessageT>
|
||||
static const RegistrationToken registration_token;
|
||||
};
|
||||
|
||||
// A custom implementation proto_ns::Descriptor. This implementation
|
||||
// avoids a code size problem introduced by proto_ns::FieldDescriptor.
|
||||
class Descriptor {
|
||||
public:
|
||||
Descriptor() {}
|
||||
Descriptor(const proto_ns::DescriptorProto& proto,
|
||||
const std::string& full_name);
|
||||
const std::string& full_name() const;
|
||||
const FieldDescriptor* FindFieldByName(const std::string& name) const;
|
||||
|
||||
private:
|
||||
std::string full_name_;
|
||||
absl::flat_hash_map<std::string, FieldDescriptor> fields_;
|
||||
};
|
||||
|
||||
// A custom implementation proto_ns::FieldDescriptor. This implementation
|
||||
// avoids a code size problem introduced by proto_ns::FieldDescriptor.
|
||||
class FieldDescriptor {
|
||||
public:
|
||||
FieldDescriptor() {}
|
||||
FieldDescriptor(const proto_ns::FieldDescriptorProto& proto);
|
||||
const std::string& name() const;
|
||||
int number() const;
|
||||
proto_ns::FieldDescriptorProto::Type type() const;
|
||||
const Descriptor* message_type() const;
|
||||
|
||||
private:
|
||||
std::string name_;
|
||||
std::string message_type_;
|
||||
proto_ns::FieldDescriptorProto::Type type_;
|
||||
int number_;
|
||||
};
|
||||
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
|
||||
|
||||
@@ -0,0 +1,143 @@
|
||||
#include "mediapipe/framework/tool/options_syntax_util.h"
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <tuple>
|
||||
#include <vector>
|
||||
|
||||
#include "absl/strings/str_cat.h"
|
||||
#include "mediapipe/framework/packet.h"
|
||||
#include "mediapipe/framework/packet_type.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
#include "mediapipe/framework/port/any_proto.h"
|
||||
#include "mediapipe/framework/port/status.h"
|
||||
#include "mediapipe/framework/tool/name_util.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
|
||||
// Helper functions for parsing the graph options syntax.
|
||||
class OptionsSyntaxUtil::OptionsSyntaxHelper {
|
||||
public:
|
||||
// The usual graph options syntax tokens.
|
||||
OptionsSyntaxHelper() : syntax_{"OPTIONS", "options", "/"} {}
|
||||
|
||||
// Returns the tag name for an option protobuf field.
|
||||
std::string OptionFieldTag(const std::string& name) { return name; }
|
||||
|
||||
// Returns the packet name for an option protobuf field.
|
||||
absl::string_view OptionFieldPacket(absl::string_view name) { return name; }
|
||||
|
||||
// Returns the option protobuf field name for a tag or packet name.
|
||||
absl::string_view OptionFieldName(absl::string_view name) { return name; }
|
||||
|
||||
// Returns the field-path for an option stream-tag.
|
||||
FieldPath OptionFieldPath(const std::string& tag,
|
||||
const Descriptor* descriptor) {
|
||||
int prefix = syntax_.tag_name.length() + syntax_.separator.length();
|
||||
std::string suffix = tag.substr(prefix);
|
||||
std::vector<absl::string_view> name_tags =
|
||||
absl::StrSplit(suffix, syntax_.separator);
|
||||
FieldPath result;
|
||||
for (absl::string_view name_tag : name_tags) {
|
||||
if (name_tag.empty()) {
|
||||
continue;
|
||||
}
|
||||
absl::string_view option_name = OptionFieldName(name_tag);
|
||||
int index;
|
||||
if (absl::SimpleAtoi(option_name, &index)) {
|
||||
result.back().second = index;
|
||||
} else {
|
||||
auto field = descriptor->FindFieldByName(std::string(option_name));
|
||||
descriptor = field ? field->message_type() : nullptr;
|
||||
result.push_back({std::move(field), 0});
|
||||
}
|
||||
}
|
||||
return result;
|
||||
}
|
||||
|
||||
// Returns the option field name for a graph options packet name.
|
||||
std::string GraphOptionFieldName(const std::string& graph_option_name) {
|
||||
int prefix = syntax_.packet_name.length() + syntax_.separator.length();
|
||||
std::string result = graph_option_name;
|
||||
result.erase(0, prefix);
|
||||
return result;
|
||||
}
|
||||
|
||||
// Returns the graph options packet name for an option field name.
|
||||
std::string GraphOptionName(const std::string& option_name) {
|
||||
std::string packet_prefix =
|
||||
syntax_.packet_name + absl::AsciiStrToLower(syntax_.separator);
|
||||
return absl::StrCat(packet_prefix, option_name);
|
||||
}
|
||||
|
||||
// Returns the tag name for a graph option.
|
||||
std::string OptionTagName(const std::string& option_name) {
|
||||
return absl::StrCat(syntax_.tag_name, syntax_.separator,
|
||||
OptionFieldTag(option_name));
|
||||
}
|
||||
|
||||
// Converts slash-separated field names into a tag name.
|
||||
std::string OptionFieldsTag(const std::string& option_names) {
|
||||
std::string tag_prefix = syntax_.tag_name + syntax_.separator;
|
||||
std::vector<absl::string_view> names = absl::StrSplit(option_names, '/');
|
||||
if (!names.empty() && names[0] == syntax_.tag_name) {
|
||||
names.erase(names.begin());
|
||||
}
|
||||
if (!names.empty() && names[0] == syntax_.packet_name) {
|
||||
names.erase(names.begin());
|
||||
}
|
||||
std::string result;
|
||||
std::string sep = "";
|
||||
for (absl::string_view v : names) {
|
||||
absl::StrAppend(&result, sep, OptionFieldTag(std::string(v)));
|
||||
sep = syntax_.separator;
|
||||
}
|
||||
result = tag_prefix + result;
|
||||
return result;
|
||||
}
|
||||
|
||||
// Token definitions for the graph options syntax.
|
||||
struct OptionsSyntax {
|
||||
// The tag name for an options protobuf.
|
||||
std::string tag_name;
|
||||
// The packet name for an options protobuf.
|
||||
std::string packet_name;
|
||||
// The separator between nested options fields.
|
||||
std::string separator;
|
||||
};
|
||||
|
||||
OptionsSyntax syntax_;
|
||||
}; // class OptionsSyntaxHelper
|
||||
|
||||
OptionsSyntaxUtil::OptionsSyntaxUtil()
|
||||
: syntax_helper_(std::make_unique<OptionsSyntaxHelper>()) {}
|
||||
|
||||
OptionsSyntaxUtil::OptionsSyntaxUtil(const std::string& tag_name)
|
||||
: OptionsSyntaxUtil() {
|
||||
syntax_helper_->syntax_.tag_name = tag_name;
|
||||
}
|
||||
|
||||
OptionsSyntaxUtil::OptionsSyntaxUtil(const std::string& tag_name,
|
||||
const std::string& packet_name,
|
||||
const std::string& separator)
|
||||
: OptionsSyntaxUtil() {
|
||||
syntax_helper_->syntax_.tag_name = tag_name;
|
||||
syntax_helper_->syntax_.packet_name = packet_name;
|
||||
syntax_helper_->syntax_.separator = separator;
|
||||
}
|
||||
|
||||
OptionsSyntaxUtil::~OptionsSyntaxUtil() {}
|
||||
|
||||
std::string OptionsSyntaxUtil::OptionFieldsTag(
|
||||
const std::string& option_names) {
|
||||
return syntax_helper_->OptionFieldsTag(option_names);
|
||||
}
|
||||
|
||||
OptionsSyntaxUtil::FieldPath OptionsSyntaxUtil::OptionFieldPath(
|
||||
const std::string& tag, const Descriptor* descriptor) {
|
||||
return syntax_helper_->OptionFieldPath(tag, descriptor);
|
||||
}
|
||||
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
@@ -0,0 +1,45 @@
|
||||
#ifndef MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_SYNTAX_UTIL_H_
|
||||
#define MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_SYNTAX_UTIL_H_
|
||||
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
#include "mediapipe/framework/calculator.pb.h"
|
||||
#include "mediapipe/framework/packet.h"
|
||||
#include "mediapipe/framework/packet_type.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
#include "mediapipe/framework/port/proto_ns.h"
|
||||
#include "mediapipe/framework/tool/options_field_util.h"
|
||||
#include "mediapipe/framework/tool/options_registry.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
|
||||
// Utility to parse the graph options syntax used in "option_value",
|
||||
// "side_packet", and "stream".
|
||||
class OptionsSyntaxUtil {
|
||||
public:
|
||||
using FieldPath = options_field_util::FieldPath;
|
||||
OptionsSyntaxUtil();
|
||||
OptionsSyntaxUtil(const std::string& tag_name);
|
||||
OptionsSyntaxUtil(const std::string& tag_name, const std::string& packet_name,
|
||||
const std::string& separator);
|
||||
~OptionsSyntaxUtil();
|
||||
|
||||
// Converts slash-separated field names into a tag name.
|
||||
std::string OptionFieldsTag(const std::string& option_names);
|
||||
|
||||
// Returns the field-path for an option stream-tag.
|
||||
FieldPath OptionFieldPath(const std::string& tag,
|
||||
const Descriptor* descriptor);
|
||||
|
||||
private:
|
||||
class OptionsSyntaxHelper;
|
||||
std::unique_ptr<OptionsSyntaxHelper> syntax_helper_;
|
||||
};
|
||||
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
|
||||
#endif // MEDIAPIPE_FRAMEWORK_TOOL_OPTIONS_SYNTAX_UTIL_H_
|
||||
@@ -1,16 +1,82 @@
|
||||
|
||||
#include "mediapipe/framework/tool/options_util.h"
|
||||
|
||||
#include "mediapipe/framework/port/proto_ns.h"
|
||||
#include <memory>
|
||||
#include <string>
|
||||
#include <variant>
|
||||
|
||||
#include "absl/strings/ascii.h"
|
||||
#include "absl/strings/str_cat.h"
|
||||
#include "mediapipe/framework/calculator_context.h"
|
||||
#include "mediapipe/framework/input_stream_shard.h"
|
||||
#include "mediapipe/framework/output_side_packet.h"
|
||||
#include "mediapipe/framework/packet.h"
|
||||
#include "mediapipe/framework/packet_set.h"
|
||||
#include "mediapipe/framework/packet_type.h"
|
||||
#include "mediapipe/framework/port/advanced_proto_inc.h"
|
||||
#include "mediapipe/framework/port/status.h"
|
||||
#include "mediapipe/framework/tool/name_util.h"
|
||||
#include "mediapipe/framework/tool/options_field_util.h"
|
||||
#include "mediapipe/framework/tool/options_registry.h"
|
||||
#include "mediapipe/framework/tool/options_syntax_util.h"
|
||||
#include "mediapipe/framework/tool/proto_util_lite.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace tool {
|
||||
|
||||
// TODO: Return registered protobuf Descriptors when available.
|
||||
const proto_ns::Descriptor* GetProtobufDescriptor(
|
||||
const std::string& type_name) {
|
||||
return proto_ns::DescriptorPool::generated_pool()->FindMessageTypeByName(
|
||||
type_name);
|
||||
// Copy literal options from graph_options to node_options.
|
||||
absl::Status CopyLiteralOptions(CalculatorGraphConfig::Node parent_node,
|
||||
CalculatorGraphConfig* config) {
|
||||
Status status;
|
||||
FieldData config_options, parent_node_options, graph_options;
|
||||
status.Update(
|
||||
options_field_util::GetOptionsMessage(*config, &config_options));
|
||||
status.Update(
|
||||
options_field_util::GetOptionsMessage(parent_node, &parent_node_options));
|
||||
status.Update(options_field_util::MergeOptionsMessages(
|
||||
config_options, parent_node_options, &graph_options));
|
||||
const Descriptor* options_descriptor =
|
||||
OptionsRegistry::GetProtobufDescriptor(options_field_util::ParseTypeUrl(
|
||||
std::string(graph_options.message_value().type_url())));
|
||||
if (!options_descriptor) {
|
||||
return status;
|
||||
}
|
||||
|
||||
OptionsSyntaxUtil syntax_util;
|
||||
for (auto& node : *config->mutable_node()) {
|
||||
FieldData node_data;
|
||||
status.Update(options_field_util::GetOptionsMessage(node, &node_data));
|
||||
if (!node_data.has_message_value() || node.option_value_size() == 0) {
|
||||
continue;
|
||||
}
|
||||
const Descriptor* node_options_descriptor =
|
||||
OptionsRegistry::GetProtobufDescriptor(options_field_util::ParseTypeUrl(
|
||||
std::string(node_data.message_value().type_url())));
|
||||
if (!node_options_descriptor) {
|
||||
continue;
|
||||
}
|
||||
for (const std::string& option_def : node.option_value()) {
|
||||
std::vector<std::string> tag_and_name = absl::StrSplit(option_def, ':');
|
||||
std::string graph_tag = syntax_util.OptionFieldsTag(tag_and_name[1]);
|
||||
std::string node_tag = syntax_util.OptionFieldsTag(tag_and_name[0]);
|
||||
FieldData packet_data;
|
||||
status.Update(options_field_util::GetField(
|
||||
syntax_util.OptionFieldPath(graph_tag, options_descriptor),
|
||||
graph_options, &packet_data));
|
||||
status.Update(options_field_util::MergeField(
|
||||
syntax_util.OptionFieldPath(node_tag, node_options_descriptor),
|
||||
packet_data, &node_data));
|
||||
}
|
||||
options_field_util::SetOptionsMessage(node_data, &node);
|
||||
}
|
||||
return status;
|
||||
}
|
||||
|
||||
// Makes all configuration modifications needed for graph options.
|
||||
absl::Status DefineGraphOptions(const CalculatorGraphConfig::Node& parent_node,
|
||||
CalculatorGraphConfig* config) {
|
||||
MP_RETURN_IF_ERROR(CopyLiteralOptions(parent_node, config));
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
} // namespace tool
|
||||
|
||||
@@ -21,7 +21,6 @@
|
||||
#include "mediapipe/framework/packet_set.h"
|
||||
#include "mediapipe/framework/port/any_proto.h"
|
||||
#include "mediapipe/framework/tool/options_map.h"
|
||||
#include "mediapipe/framework/tool/type_util.h"
|
||||
|
||||
namespace mediapipe {
|
||||
|
||||
@@ -75,8 +74,9 @@ inline T RetrieveOptions(const T& base, const InputStreamShardSet& stream_set,
|
||||
return base;
|
||||
}
|
||||
|
||||
// Finds the descriptor for a protobuf.
|
||||
const proto_ns::Descriptor* GetProtobufDescriptor(const std::string& type_name);
|
||||
// Copy literal options from enclosing graphs.
|
||||
absl::Status DefineGraphOptions(const CalculatorGraphConfig::Node& parent_node,
|
||||
CalculatorGraphConfig* config);
|
||||
|
||||
} // namespace tool
|
||||
} // namespace mediapipe
|
||||
|
||||
@@ -16,15 +16,41 @@
|
||||
#include <vector>
|
||||
|
||||
#include "mediapipe/framework/calculator_framework.h"
|
||||
#include "mediapipe/framework/deps/message_matchers.h"
|
||||
#include "mediapipe/framework/port/gtest.h"
|
||||
#include "mediapipe/framework/port/parse_text_proto.h"
|
||||
#include "mediapipe/framework/port/status_matchers.h"
|
||||
#include "mediapipe/framework/testdata/night_light_calculator.pb.h"
|
||||
#include "mediapipe/framework/tool/node_chain_subgraph.pb.h"
|
||||
#include "mediapipe/framework/tool/options_registry.h"
|
||||
#include "mediapipe/framework/tool/options_syntax_util.h"
|
||||
|
||||
namespace mediapipe {
|
||||
namespace {
|
||||
|
||||
using ::mediapipe::proto_ns::FieldDescriptorProto;
|
||||
using FieldType = ::mediapipe::proto_ns::FieldDescriptorProto::Type;
|
||||
|
||||
// A test Calculator using DeclareOptions and DefineOptions.
|
||||
class NightLightCalculator : public CalculatorBase {
|
||||
public:
|
||||
static absl::Status GetContract(CalculatorContract* cc) {
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
absl::Status Open(CalculatorContext* cc) final {
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
absl::Status Process(CalculatorContext* cc) final {
|
||||
return mediapipe::OkStatus();
|
||||
}
|
||||
|
||||
private:
|
||||
NightLightCalculatorOptions options_;
|
||||
};
|
||||
REGISTER_CALCULATOR(NightLightCalculator);
|
||||
|
||||
// Tests for calculator and graph options.
|
||||
//
|
||||
class OptionsUtilTest : public ::testing::Test {
|
||||
@@ -35,21 +61,108 @@ class OptionsUtilTest : public ::testing::Test {
|
||||
|
||||
// Retrieves the description of a protobuf.
|
||||
TEST_F(OptionsUtilTest, GetProtobufDescriptor) {
|
||||
const proto_ns::Descriptor* descriptor =
|
||||
tool::GetProtobufDescriptor("mediapipe.CalculatorGraphConfig");
|
||||
#ifndef MEDIAPIPE_MOBILE
|
||||
const tool::Descriptor* descriptor =
|
||||
tool::OptionsRegistry::GetProtobufDescriptor(
|
||||
"mediapipe.CalculatorGraphConfig");
|
||||
EXPECT_NE(nullptr, descriptor);
|
||||
#else
|
||||
EXPECT_EQ(nullptr, descriptor);
|
||||
#endif
|
||||
}
|
||||
|
||||
// Retrieves the description of a protobuf from the OptionsRegistry.
|
||||
// Shows a calculator node deriving options from graph options.
|
||||
// The subgraph specifies "graph_options" as "NodeChainSubgraphOptions".
|
||||
// The calculator specifies "node_options as "NightLightCalculatorOptions".
|
||||
TEST_F(OptionsUtilTest, CopyLiteralOptions) {
|
||||
CalculatorGraphConfig subgraph_config;
|
||||
|
||||
auto node = subgraph_config.add_node();
|
||||
*node->mutable_calculator() = "NightLightCalculator";
|
||||
*node->add_option_value() = "num_lights:options/chain_length";
|
||||
|
||||
// The options framework requires at least an empty options protobuf
|
||||
// as an indication the options protobuf type expected by the node.
|
||||
NightLightCalculatorOptions node_options;
|
||||
node->add_node_options()->PackFrom(node_options);
|
||||
|
||||
NodeChainSubgraphOptions options;
|
||||
options.set_chain_length(8);
|
||||
subgraph_config.add_graph_options()->PackFrom(options);
|
||||
subgraph_config.set_type("NightSubgraph");
|
||||
|
||||
CalculatorGraphConfig graph_config;
|
||||
node = graph_config.add_node();
|
||||
*node->mutable_calculator() = "NightSubgraph";
|
||||
|
||||
CalculatorGraph graph;
|
||||
graph_config.set_num_threads(4);
|
||||
MP_EXPECT_OK(graph.Initialize({subgraph_config, graph_config}, {}, {}));
|
||||
|
||||
CalculatorGraphConfig expanded_config = graph.Config();
|
||||
expanded_config.clear_executor();
|
||||
CalculatorGraphConfig::Node actual_node;
|
||||
actual_node = expanded_config.node(0);
|
||||
|
||||
CalculatorGraphConfig::Node expected_node;
|
||||
expected_node.set_name("nightsubgraph__NightLightCalculator");
|
||||
expected_node.set_calculator("NightLightCalculator");
|
||||
NightLightCalculatorOptions expected_node_options;
|
||||
expected_node_options.add_num_lights(8);
|
||||
expected_node.add_node_options()->PackFrom(expected_node_options);
|
||||
*expected_node.add_option_value() = "num_lights:options/chain_length";
|
||||
EXPECT_THAT(actual_node, EqualsProto(expected_node));
|
||||
|
||||
MP_EXPECT_OK(graph.StartRun({}));
|
||||
MP_EXPECT_OK(graph.CloseAllPacketSources());
|
||||
MP_EXPECT_OK(graph.WaitUntilDone());
|
||||
|
||||
// Ensure static protobuf packet registration.
|
||||
MakePacket<NodeChainSubgraphOptions>();
|
||||
MakePacket<NightLightCalculatorOptions>();
|
||||
}
|
||||
|
||||
// Retrieves the description of a protobuf message and a nested protobuf message
|
||||
// from the OptionsRegistry.
|
||||
TEST_F(OptionsUtilTest, GetProtobufDescriptorRegistered) {
|
||||
const proto_ns::Descriptor* descriptor =
|
||||
const tool::Descriptor* options_descriptor =
|
||||
tool::OptionsRegistry::GetProtobufDescriptor(
|
||||
"mediapipe.NightLightCalculatorOptions");
|
||||
EXPECT_NE(nullptr, descriptor);
|
||||
EXPECT_NE(nullptr, options_descriptor);
|
||||
const tool::Descriptor* bundle_descriptor =
|
||||
tool::OptionsRegistry::GetProtobufDescriptor(
|
||||
"mediapipe.NightLightCalculatorOptions.LightBundle");
|
||||
EXPECT_NE(nullptr, bundle_descriptor);
|
||||
EXPECT_EQ(options_descriptor->full_name(),
|
||||
"mediapipe.NightLightCalculatorOptions");
|
||||
const tool::FieldDescriptor* bundle_field =
|
||||
options_descriptor->FindFieldByName("bundle");
|
||||
EXPECT_EQ(bundle_field->message_type(), bundle_descriptor);
|
||||
}
|
||||
|
||||
// Constructs the FieldPath for a nested node-option.
|
||||
TEST_F(OptionsUtilTest, OptionsSyntaxUtil) {
|
||||
const tool::Descriptor* descriptor =
|
||||
tool::OptionsRegistry::GetProtobufDescriptor(
|
||||
"mediapipe.NightLightCalculatorOptions");
|
||||
std::string tag;
|
||||
tool::OptionsSyntaxUtil::FieldPath field_path;
|
||||
{
|
||||
// The default tag syntax.
|
||||
tool::OptionsSyntaxUtil syntax_util;
|
||||
tag = syntax_util.OptionFieldsTag("options/sub_options/num_lights");
|
||||
EXPECT_EQ(tag, "OPTIONS/sub_options/num_lights");
|
||||
field_path = syntax_util.OptionFieldPath(tag, descriptor);
|
||||
EXPECT_EQ(field_path.size(), 2);
|
||||
EXPECT_EQ(field_path[0].first->name(), "sub_options");
|
||||
EXPECT_EQ(field_path[1].first->name(), "num_lights");
|
||||
}
|
||||
{
|
||||
// A tag syntax with a text-coded separator.
|
||||
tool::OptionsSyntaxUtil syntax_util("OPTIONS", "options", "_Z0Z_");
|
||||
tag = syntax_util.OptionFieldsTag("options/sub_options/num_lights");
|
||||
EXPECT_EQ(tag, "OPTIONS_Z0Z_sub_options_Z0Z_num_lights");
|
||||
field_path = syntax_util.OptionFieldPath(tag, descriptor);
|
||||
EXPECT_EQ(field_path.size(), 2);
|
||||
EXPECT_EQ(field_path[0].first->name(), "sub_options");
|
||||
EXPECT_EQ(field_path[1].first->name(), "num_lights");
|
||||
}
|
||||
}
|
||||
|
||||
} // namespace
|
||||
|
||||
@@ -196,6 +196,27 @@ absl::Status ProtoUtilLite::GetFieldRange(
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
// Returns the number of field values in a repeated protobuf field.
|
||||
absl::Status ProtoUtilLite::GetFieldCount(const FieldValue& message,
|
||||
ProtoPath proto_path,
|
||||
FieldType field_type,
|
||||
int* field_count) {
|
||||
int field_id, index;
|
||||
std::tie(field_id, index) = proto_path.back();
|
||||
proto_path.pop_back();
|
||||
std::vector<std::string> parent;
|
||||
if (proto_path.empty()) {
|
||||
parent.push_back(std::string(message));
|
||||
} else {
|
||||
MP_RETURN_IF_ERROR(ProtoUtilLite::GetFieldRange(
|
||||
message, proto_path, 1, WireFormatLite::TYPE_MESSAGE, &parent));
|
||||
}
|
||||
FieldAccess access(field_id, field_type);
|
||||
MP_RETURN_IF_ERROR(access.SetMessage(parent[0]));
|
||||
*field_count = access.mutable_field_values()->size();
|
||||
return absl::OkStatus();
|
||||
}
|
||||
|
||||
// If ok, returns OkStatus, otherwise returns InvalidArgumentError.
|
||||
template <typename T>
|
||||
absl::Status SyntaxStatus(bool ok, const std::string& text, T* result) {
|
||||
|
||||
@@ -75,6 +75,11 @@ class ProtoUtilLite {
|
||||
FieldType field_type,
|
||||
std::vector<FieldValue>* field_values);
|
||||
|
||||
// Returns the number of field values in a repeated protobuf field.
|
||||
static absl::Status GetFieldCount(const FieldValue& message,
|
||||
ProtoPath proto_path, FieldType field_type,
|
||||
int* field_count);
|
||||
|
||||
// Serialize one or more protobuf field values from text.
|
||||
static absl::Status Serialize(const std::vector<std::string>& text_values,
|
||||
FieldType field_type,
|
||||
|
||||
@@ -278,6 +278,8 @@ absl::Status ExpandSubgraphs(CalculatorGraphConfig* config,
|
||||
graph_registry =
|
||||
graph_registry ? graph_registry : &GraphRegistry::global_graph_registry;
|
||||
RET_CHECK(config);
|
||||
MP_RETURN_IF_ERROR(mediapipe::tool::DefineGraphOptions(
|
||||
CalculatorGraphConfig::Node(), config));
|
||||
auto* nodes = config->mutable_node();
|
||||
while (1) {
|
||||
auto subgraph_nodes_start = std::stable_partition(
|
||||
@@ -297,6 +299,7 @@ absl::Status ExpandSubgraphs(CalculatorGraphConfig* config,
|
||||
ASSIGN_OR_RETURN(auto subgraph, graph_registry->CreateByName(
|
||||
config->package(), node.calculator(),
|
||||
&subgraph_context));
|
||||
MP_RETURN_IF_ERROR(mediapipe::tool::DefineGraphOptions(node, &subgraph));
|
||||
MP_RETURN_IF_ERROR(PrefixNames(node_name, &subgraph));
|
||||
MP_RETURN_IF_ERROR(ConnectSubgraphStreams(node, &subgraph));
|
||||
subgraphs.push_back(subgraph);
|
||||
|
||||
Reference in New Issue
Block a user