src/media/audio/lib/clock/testing/clock_test.h

// Copyright 2020 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_LIB_CLOCK_TESTING_CLOCK_TEST_H_
#define SRC_MEDIA_AUDIO_LIB_CLOCK_TESTING_CLOCK_TEST_H_

#include <lib/fpromise/result.h>
#include <lib/zx/clock.h>

#include <optional>

#include "src/media/audio/lib/clock/clock.h"
#include "src/media/audio/lib/clock/synthetic_clock_realm.h"

namespace media::audio::clock::testing {

// Clock should have rights DUPLICATE, TRANSFER, READ; clock should not have WRITE
void VerifyReadOnlyRights(const zx::clock& ref_clock);
void VerifyReadOnlyRights(const ::media_audio::Clock& audio_clock);

void VerifyAdvances(const zx::clock& ref_clock);
void VerifyAdvances(const ::media_audio::Clock& audio_clock);
void VerifyAdvances(const ::media_audio::Clock& audio_clock,
                    ::media_audio::SyntheticClockRealm& clock_realm);

void VerifyCannotBeRateAdjusted(const zx::clock& ref_clock);
void VerifyCannotBeRateAdjusted(const ::media_audio::Clock& audio_clock);

void VerifyCanBeRateAdjusted(const zx::clock& ref_clock);
void VerifyCanBeRateAdjusted(const ::media_audio::Clock& audio_clock);

void VerifyIsSystemMonotonic(const zx::clock& clock);
void VerifyIsSystemMonotonic(const ::media_audio::Clock& audio_clock);

void VerifyIsNotSystemMonotonic(const zx::clock& clock);
void VerifyIsNotSystemMonotonic(const ::media_audio::Clock& audio_clock);

struct ClockProperties {
  std::optional<zx::time> start_val = std::nullopt;
  std::optional<int32_t> rate_adjust_ppm = std::nullopt;
  std::optional<zx::duration> synthetic_offset_from_mono = std::nullopt;
};

fpromise::result<zx::clock, zx_status_t> CreateCustomClock(ClockProperties props);
fpromise::result<zx::duration, zx_status_t> GetOffsetFromMonotonic(const zx::clock& clock);

}  // namespace media::audio::clock::testing

#endif  // SRC_MEDIA_AUDIO_LIB_CLOCK_TESTING_CLOCK_TEST_H_