1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
|
// Copyright 2025 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/optimization_guide/core/model_execution/multimodal_message.h"
#include <cstddef>
#include <optional>
#include <tuple>
#include <utility>
#include "base/check_op.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/notreached.h"
#include "components/optimization_guide/core/model_execution/on_device_model_execution_proto_descriptors.h"
#include "components/optimization_guide/proto/descriptors.pb.h"
#include "components/optimization_guide/proto/model_quality_metadata.pb.h"
#include "services/on_device_model/ml/chrome_ml_audio_buffer.h"
#include "third_party/skia/include/core/SkBitmap.h"
namespace optimization_guide {
using ::google::protobuf::MessageLite;
MultimodalMessageData::MultimodalMessageData() = default;
MultimodalMessageData::MultimodalMessageData(const MultimodalMessageData&) =
default;
MultimodalMessageData::MultimodalMessageData(MultimodalMessageData&&) = default;
MultimodalMessageData& MultimodalMessageData::operator=(
const MultimodalMessageData&) = default;
MultimodalMessageData& MultimodalMessageData::operator=(
MultimodalMessageData&&) = default;
MultimodalMessageData::~MultimodalMessageData() = default;
RepeatedMultimodalMessageData::RepeatedMultimodalMessageData() = default;
RepeatedMultimodalMessageData::RepeatedMultimodalMessageData(
const RepeatedMultimodalMessageData&) = default;
RepeatedMultimodalMessageData::RepeatedMultimodalMessageData(
RepeatedMultimodalMessageData&&) = default;
RepeatedMultimodalMessageData& RepeatedMultimodalMessageData::operator=(
const RepeatedMultimodalMessageData&) = default;
RepeatedMultimodalMessageData& RepeatedMultimodalMessageData::operator=(
RepeatedMultimodalMessageData&&) = default;
RepeatedMultimodalMessageData::~RepeatedMultimodalMessageData() = default;
MultimodalMessageEditView::MultimodalMessageEditView(
MessageLite& message,
MultimodalMessageData& overlay)
: message_(message), overlay_(overlay) {}
MultimodalMessageEditView::~MultimodalMessageEditView() = default;
void MultimodalMessageEditView::MarkPending(int tag, bool pending) {
if (pending) {
overlay_->pending.insert(tag);
} else {
overlay_->pending.erase(tag);
}
}
void MultimodalMessageEditView::Set(int tag, const std::string& v) {
ProtoStatus status = SetProtoField(&message_.get(), tag, v);
CHECK_EQ(status, ProtoStatus::kOk);
}
void MultimodalMessageEditView::Set(int tag, SkBitmap v) {
MessageLite* nested_message = GetProtoMutableMessage(&message_.get(), tag);
CHECK(nested_message);
CHECK_EQ(nested_message->GetTypeName(), "optimization_guide.proto.Media");
overlay_->images[tag] = std::move(v);
}
void MultimodalMessageEditView::Set(int tag, ml::AudioBuffer v) {
MessageLite* nested_message = GetProtoMutableMessage(&message_.get(), tag);
CHECK(nested_message);
CHECK_EQ(nested_message->GetTypeName(), "optimization_guide.proto.Media");
overlay_->audio[tag] = std::move(v);
}
MultimodalMessageEditView MultimodalMessageEditView::GetMutableMessage(
int tag) {
MessageLite* nested_message = GetProtoMutableMessage(&message_.get(), tag);
return MultimodalMessageEditView(*nested_message, overlay_->nested[tag]);
}
RepeatedMultimodalMessageEditView
MultimodalMessageEditView::MutableRepeatedField(int tag) {
return RepeatedMultimodalMessageEditView(*message_, tag,
overlay_->repeated[tag]);
}
void MultimodalMessageEditView::CheckTypeAndMergeFrom(
const MessageLite& other) {
message_->CheckTypeAndMergeFrom(other);
}
MultimodalMessageReadView::MultimodalMessageReadView(
const MessageLite& message,
const MultimodalMessageData* overlay)
: message_(message), overlay_(overlay) {}
MultimodalMessageReadView::MultimodalMessageReadView(const MessageLite& message)
: message_(message), overlay_(nullptr) {}
MultimodalMessageReadView::~MultimodalMessageReadView() = default;
bool MultimodalMessageReadView::IsPending(
const proto::ProtoField& proto_field) const {
std::optional<MultimodalMessageReadView> parent = *this;
for (int i = 0; i < proto_field.proto_descriptors_size() - 1; i++) {
if (!parent->overlay_) {
return false;
}
int32_t tag = proto_field.proto_descriptors(i).tag_number();
if (parent->overlay_->pending.contains(tag)) {
return true;
}
parent = parent->GetNested(proto_field.proto_descriptors(i).tag_number());
if (!parent) {
return false;
}
}
int32_t tag =
proto_field.proto_descriptors(proto_field.proto_descriptors_size() - 1)
.tag_number();
return parent->overlay_ && parent->overlay_->pending.contains(tag);
}
// Get the type of multimodal content for a field.
MultimodalType MultimodalMessageReadView::GetMultimodalType(
const proto::ProtoField& proto_field) const {
std::optional<MultimodalMessageReadView> parent =
GetEnclosingMessage(proto_field);
if (!parent) {
return MultimodalType::kNone;
}
int32_t leaf_tag =
proto_field.proto_descriptors(proto_field.proto_descriptors_size() - 1)
.tag_number();
if (parent->overlay_->images.contains(leaf_tag)) {
return MultimodalType::kImage;
}
if (parent->overlay_->audio.contains(leaf_tag)) {
return MultimodalType::kAudio;
}
return MultimodalType::kNone;
}
const SkBitmap* MultimodalMessageReadView::GetImage(
const proto::ProtoField& proto_field) const {
CHECK_GE(proto_field.proto_descriptors_size(), 1);
std::optional<MultimodalMessageReadView> parent =
GetEnclosingMessage(proto_field);
if (!parent || !parent->overlay_) {
// Either proto_field is not a reference to a known Media field,
// or the field state was defined by an 'initial' message, and can't contain
// an image.
return nullptr;
}
int32_t leaf_tag =
proto_field.proto_descriptors(proto_field.proto_descriptors_size() - 1)
.tag_number();
auto it = parent->overlay_->images.find(leaf_tag);
if (it == parent->overlay_->images.end()) {
return nullptr;
}
return &it->second;
}
const ml::AudioBuffer* MultimodalMessageReadView::GetAudio(
const proto::ProtoField& proto_field) const {
CHECK_GE(proto_field.proto_descriptors_size(), 1);
std::optional<MultimodalMessageReadView> parent =
GetEnclosingMessage(proto_field);
if (!parent || !parent->overlay_) {
// Either proto_field is not a reference to a known Media field,
// or the field state was defined by an 'initial' message, and can't contain
// audio.
return nullptr;
}
int32_t leaf_tag =
proto_field.proto_descriptors(proto_field.proto_descriptors_size() - 1)
.tag_number();
auto it = parent->overlay_->audio.find(leaf_tag);
if (it == parent->overlay_->audio.end()) {
return nullptr;
}
return &it->second;
}
std::optional<proto::Value> MultimodalMessageReadView::GetValue(
const proto::ProtoField& proto_field) const {
return GetProtoValue(*message_, proto_field);
}
std::optional<RepeatedMultimodalMessageReadView>
MultimodalMessageReadView::GetRepeated(
const proto::ProtoField& proto_field) const {
CHECK_GE(proto_field.proto_descriptors_size(), 1);
std::optional<MultimodalMessageReadView> parent =
GetEnclosingMessage(proto_field);
if (!parent) {
// 'proto_field' does not reference a known message field.
return std::nullopt;
}
int32_t leaf_tag =
proto_field.proto_descriptors(proto_field.proto_descriptors_size() - 1)
.tag_number();
if (!parent->overlay_) {
return RepeatedMultimodalMessageReadView(*parent->message_, leaf_tag,
nullptr);
}
auto it = parent->overlay_->repeated.find(leaf_tag);
if (it == parent->overlay_->repeated.end()) {
return RepeatedMultimodalMessageReadView(*parent->message_, leaf_tag,
nullptr);
}
return RepeatedMultimodalMessageReadView(*parent->message_, leaf_tag,
&it->second);
}
std::optional<MultimodalMessageReadView> MultimodalMessageReadView::GetNested(
int32_t tag) const {
const MessageLite* child = GetProtoMessage(&message_.get(), tag);
if (!child) {
// 'tag' does not reference a known message field.
return std::nullopt;
}
if (!overlay_) {
return MultimodalMessageReadView(*child, nullptr);
}
auto it = overlay_->nested.find(tag);
if (it == overlay_->nested.end()) {
return MultimodalMessageReadView(*child, nullptr);
}
return MultimodalMessageReadView(*child, &it->second);
}
std::optional<MultimodalMessageReadView>
MultimodalMessageReadView::GetEnclosingMessage(
const proto::ProtoField& proto_field) const {
std::optional<MultimodalMessageReadView> parent = *this;
for (int i = 0; i < proto_field.proto_descriptors_size() - 1; i++) {
parent = parent->GetNested(proto_field.proto_descriptors(i).tag_number());
if (!parent) {
return std::nullopt;
}
}
return parent;
}
RepeatedMultimodalMessageEditView::RepeatedMultimodalMessageEditView(
MessageLite& parent,
int32_t tag,
RepeatedMultimodalMessageData& overlay)
: parent_(parent), tag_(tag), overlay_(overlay) {}
RepeatedMultimodalMessageEditView::~RepeatedMultimodalMessageEditView() =
default;
MultimodalMessageEditView RepeatedMultimodalMessageEditView::Add() {
int new_size = AddProtoMessage(&parent_.get(), tag_);
CHECK_GT(new_size, 0); // Zero implies an unsupported message / invalid tag.
return Get(new_size - 1);
}
MultimodalMessageEditView RepeatedMultimodalMessageEditView::Add(
const MessageLite& initial_message) {
MultimodalMessageEditView result = Add();
result.CheckTypeAndMergeFrom(initial_message);
return result;
}
MultimodalMessageEditView RepeatedMultimodalMessageEditView::Get(int n) {
MessageLite* message =
GetProtoMutableRepeatedMessage(&parent_.get(), tag_, n);
CHECK(message);
// Overlays vector may be shorter than the actual field (due to elements
// being appended in an initial message, or a merge). This will default
// initialize overlays for all of those elements, plus one for the element
// being retrieved.
if (static_cast<size_t>(n) >= overlay_->overlays.size()) {
overlay_->overlays.resize(n + 1);
}
return MultimodalMessageEditView(*message, overlay_->overlays[n]);
}
void RepeatedMultimodalMessageEditView::MarkIncomplete(bool incomplete) {
overlay_->incomplete = incomplete;
}
RepeatedMultimodalMessageReadView::RepeatedMultimodalMessageReadView(
const MessageLite& parent,
int32_t tag,
const RepeatedMultimodalMessageData* overlay)
: parent_(parent), tag_(tag), overlay_(overlay) {}
RepeatedMultimodalMessageReadView::~RepeatedMultimodalMessageReadView() =
default;
int RepeatedMultimodalMessageReadView::Size() const {
return GetProtoRepeatedSize(&parent_.get(), tag_);
}
MultimodalMessageReadView RepeatedMultimodalMessageReadView::Get(int n) const {
MessageLite* message = GetProtoMutableRepeatedMessage(
const_cast<MessageLite*>(&parent_.get()), tag_, n);
CHECK(message);
if (!overlay_ || static_cast<size_t>(n) >= overlay_->overlays.size()) {
// Either this field has no overlays, or messages were appended by a merge
// and have no overlays.
return MultimodalMessageReadView(*message, nullptr);
}
return MultimodalMessageReadView(*message, &overlay_->overlays[n]);
}
bool RepeatedMultimodalMessageReadView::IsIncomplete() const {
return overlay_ && overlay_->incomplete;
}
MultimodalMessage::MultimodalMessage() = default;
MultimodalMessage::MultimodalMessage(const MessageLite& initial_message)
: message_(initial_message.New()) {
message_->CheckTypeAndMergeFrom(initial_message);
}
MultimodalMessage::~MultimodalMessage() = default;
MultimodalMessage::MultimodalMessage(MultimodalMessage&&) = default;
MultimodalMessage& MultimodalMessage::operator=(MultimodalMessage&&) = default;
MultimodalMessage MultimodalMessage::Clone() {
MultimodalMessage result;
if (message_) {
result = MultimodalMessage(*message_);
}
result.overlay_ = overlay_;
return result;
}
MultimodalMessage MultimodalMessage::Merge(const MessageLite& other) {
if (!message_) {
return MultimodalMessage(other);
}
MultimodalMessage result = Clone();
result.edit().CheckTypeAndMergeFrom(other);
return result;
}
const MessageLite& MultimodalMessage::BuildProtoMessage() {
// TODO(holte): Actually fill in media fields.
return *message_;
}
} // namespace optimization_guide
|