Source/WebCore/testing/MockMediaDeviceRoute.h

/*
 * Copyright (C) 2025 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#if ENABLE(WIRELESS_PLAYBACK_MEDIA_PLAYER)

#include "MockMediaDeviceRouteURLCallback.h"
#include <wtf/Ref.h>
#include <wtf/RefCounted.h>
#include <wtf/RetainPtr.h>
#include <wtf/TZoneMalloc.h>
#include <wtf/Vector.h>
#include <wtf/text/WTFString.h>

OBJC_CLASS WebMockMediaDeviceRoute;
OBJC_PROTOCOL(WebMediaDevicePlatformRoute);

namespace WebCore {

class MockMediaDeviceRoute : public RefCounted<MockMediaDeviceRoute> {
    WTF_MAKE_TZONE_ALLOCATED(MockMediaDeviceRoute);
public:
    struct TimeRange {
        double start;
        double duration;
    };

    static Ref<MockMediaDeviceRoute> create();

    WebMediaDevicePlatformRoute *platformRoute() const;

    void setURLCallback(MockMediaDeviceRouteURLCallback*);

    String deviceName() const;
    void setDeviceName(const String&);

    String protocolTypeIdentifier() const;
    void setProtocolTypeIdentifier(const String&);

    String routeName() const;

    bool connected() const;

    bool ready() const;
    void setReady(bool);

    bool playing() const;
    void setPlaying(bool);

    bool hasPlaybackError() const;
    void setHasPlaybackError(bool);

    struct AudioOption {
        String displayName;
        String identifier;
        String extendedLanguageTag;
    };
    Vector<AudioOption> audioOptions() const;
    void setAudioOptions(const Vector<AudioOption>&);

    float playbackRate() const;
    void setPlaybackRate(float);

    float currentPlaybackPosition() const;
    void setCurrentPlaybackPosition(float);

    TimeRange timeRange() const;
    void setTimeRange(const TimeRange&);

    float volume() const;
    void setVolume(float);

    bool muted() const;
    void setMuted(bool);

    String lastSeekTolerance() const;

private:
    MockMediaDeviceRoute();

    RetainPtr<WebMockMediaDeviceRoute> m_platformRoute;
};

} // namespace WebCore

#endif // ENABLE(WIRELESS_PLAYBACK_MEDIA_PLAYER)