src/media/audio/services/device_registry/validate.h

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef SRC_MEDIA_AUDIO_SERVICES_DEVICE_REGISTRY_VALIDATE_H_
#define SRC_MEDIA_AUDIO_SERVICES_DEVICE_REGISTRY_VALIDATE_H_

#include <fidl/fuchsia.audio.device/cpp/common_types.h>
#include <fidl/fuchsia.audio.device/cpp/natural_types.h>
#include <fidl/fuchsia.hardware.audio.signalprocessing/cpp/natural_types.h>
#include <fidl/fuchsia.hardware.audio/cpp/fidl.h>

#include <unordered_map>

#include "src/media/audio/services/device_registry/basic_types.h"

namespace media_audio {

// TODO(https://fxbug.dev/42068183): official frame-rate limits/expectations for audio devices.
constexpr uint32_t kMinSupportedDaiFrameRate = 1000;
constexpr uint32_t kMaxSupportedDaiFrameRate = 192000 * 8 * 64;
constexpr uint8_t kMaxSupportedDaiFormatBitsPerSlot = 64;

// We define these here only temporarily, as we do not publish frame-rate limits for audio devices.
// TODO(https://fxbug.dev/42068183): official frame-rate limits/expectations for audio devices.
const uint32_t kMinSupportedRingBufferFrameRate = 1000;
const uint32_t kMaxSupportedRingBufferFrameRate = 192000;

// Utility functions to validate direct responses from audio drivers.
bool ClientIsValidForDeviceType(const fuchsia_audio_device::DeviceType& device_type,
                                const fuchsia_audio_device::DriverClient& driver_client);

std::vector<fuchsia_audio_device::PcmFormatSet> TranslateRingBufferFormatSets(
    const std::vector<fuchsia_hardware_audio::SupportedFormats>& ring_buffer_format_sets);

bool ValidateStreamProperties(
    const fuchsia_hardware_audio::StreamProperties& stream_props,
    std::optional<const fuchsia_hardware_audio::GainState> gain_state = std::nullopt,
    std::optional<const fuchsia_hardware_audio::PlugState> plug_state = std::nullopt);
bool ValidateGainState(
    const fuchsia_hardware_audio::GainState& gain_state,
    std::optional<const fuchsia_hardware_audio::StreamProperties> stream_props = std::nullopt);
bool ValidatePlugState(const fuchsia_hardware_audio::PlugState& plug_state,
                       std::optional<fuchsia_hardware_audio::PlugDetectCapabilities>
                           plug_detect_capabilities = std::nullopt);

bool ValidateCodecProperties(
    const fuchsia_hardware_audio::CodecProperties& codec_props,
    std::optional<const fuchsia_hardware_audio::PlugState> plug_state = std::nullopt);
bool ValidateCodecFormatInfo(const fuchsia_hardware_audio::CodecFormatInfo& format_info);

bool ValidateCompositeProperties(
    const fuchsia_hardware_audio::CompositeProperties& composite_props);

bool ValidateDeviceInfo(const fuchsia_audio_device::Info& device_info);

bool ValidateElements(
    const std::vector<fuchsia_hardware_audio_signalprocessing::Element>& elements);
bool ValidateElement(const fuchsia_hardware_audio_signalprocessing::Element& element);
bool ValidateElementState(
    const fuchsia_hardware_audio_signalprocessing::ElementState& element_state,
    const fuchsia_hardware_audio_signalprocessing::Element& element);

bool ValidateTopologies(
    const std::vector<fuchsia_hardware_audio_signalprocessing::Topology>& topologies,
    const std::unordered_map<ElementId, ElementRecord>& element_map);
bool ValidateTopology(const fuchsia_hardware_audio_signalprocessing::Topology& topology,
                      const std::unordered_map<ElementId, ElementRecord>& element_map);

bool ValidateRingBufferFormatSets(
    const std::vector<fuchsia_hardware_audio::SupportedFormats>& ring_buffer_format_sets);
bool ValidateRingBufferFormat(const fuchsia_hardware_audio::Format& ring_buffer_format);
bool ValidateSampleFormatCompatibility(uint8_t bytes_per_sample,
                                       fuchsia_hardware_audio::SampleFormat sample_format);

bool ValidateDaiFormatSets(
    const std::vector<fuchsia_hardware_audio::DaiSupportedFormats>& dai_format_sets);
bool ValidateDaiFormat(const fuchsia_hardware_audio::DaiFormat& dai_format);

bool ValidateRingBufferProperties(const fuchsia_hardware_audio::RingBufferProperties& rb_props);
bool ValidateRingBufferVmo(const zx::vmo& vmo, uint32_t num_frames,
                           const fuchsia_hardware_audio::Format& format);
bool ValidateDelayInfo(const fuchsia_hardware_audio::DelayInfo& delay_info);

}  // namespace media_audio

#endif  // SRC_MEDIA_AUDIO_SERVICES_DEVICE_REGISTRY_VALIDATE_H_