blob: c98929adf248cdb89ced1a5b9bb058188ba2bd8d [file] [log] [blame]
/*
* Copyright (C) 2018 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(ENCRYPTED_MEDIA)
#include "CDMKeyStatus.h"
#include "CDMMessageType.h"
#include "CDMSessionType.h"
#include <wtf/CompletionHandler.h>
#include <wtf/RefCounted.h>
#include <wtf/Vector.h>
#include <wtf/WeakPtr.h>
#if !RELEASE_LOG_DISABLED
namespace WTF {
class Logger;
}
#endif
namespace WebCore {
class SharedBuffer;
class CDMInstanceSessionClient : public CanMakeWeakPtr<CDMInstanceSessionClient> {
public:
virtual ~CDMInstanceSessionClient() = default;
using KeyStatus = CDMKeyStatus;
using KeyStatusVector = Vector<std::pair<Ref<SharedBuffer>, KeyStatus>>;
virtual void updateKeyStatuses(KeyStatusVector&&) = 0;
virtual void sendMessage(CDMMessageType, Ref<SharedBuffer>&& message) = 0;
virtual void sessionIdChanged(const String&) = 0;
using PlatformDisplayID = uint32_t;
virtual PlatformDisplayID displayID() = 0;
};
class CDMInstanceSession : public RefCounted<CDMInstanceSession> {
public:
virtual ~CDMInstanceSession() = default;
using KeyStatus = CDMKeyStatus;
using LicenseType = CDMSessionType;
using MessageType = CDMMessageType;
#if !RELEASE_LOG_DISABLED
virtual void setLogIdentifier(const void*) { }
#endif
virtual void setClient(WeakPtr<CDMInstanceSessionClient>&&) { }
virtual void clearClient() { }
enum SuccessValue {
Failed,
Succeeded,
};
using LicenseCallback = CompletionHandler<void(Ref<SharedBuffer>&& message, const String& sessionId, bool needsIndividualization, SuccessValue succeeded)>;
virtual void requestLicense(LicenseType, const AtomString& initDataType, Ref<SharedBuffer>&& initData, LicenseCallback&&) = 0;
using KeyStatusVector = CDMInstanceSessionClient::KeyStatusVector;
using Message = std::pair<MessageType, Ref<SharedBuffer>>;
using LicenseUpdateCallback = CompletionHandler<void(bool sessionWasClosed, std::optional<KeyStatusVector>&& changedKeys, std::optional<double>&& changedExpiration, std::optional<Message>&& message, SuccessValue succeeded)>;
virtual void updateLicense(const String& sessionId, LicenseType, Ref<SharedBuffer>&& response, LicenseUpdateCallback&&) = 0;
enum class SessionLoadFailure : uint8_t {
None,
NoSessionData,
MismatchedSessionType,
QuotaExceeded,
Other,
};
using LoadSessionCallback = CompletionHandler<void(std::optional<KeyStatusVector>&&, std::optional<double>&&, std::optional<Message>&&, SuccessValue, SessionLoadFailure)>;
virtual void loadSession(LicenseType, const String& sessionId, const String& origin, LoadSessionCallback&&) = 0;
using CloseSessionCallback = CompletionHandler<void()>;
virtual void closeSession(const String& sessionId, CloseSessionCallback&&) = 0;
using RemoveSessionDataCallback = CompletionHandler<void(KeyStatusVector&&, RefPtr<SharedBuffer>&&, SuccessValue)>;
virtual void removeSessionData(const String& sessionId, LicenseType, RemoveSessionDataCallback&&) = 0;
virtual void storeRecordOfKeyUsage(const String& sessionId) = 0;
using PlatformDisplayID = uint32_t;
virtual void displayChanged(PlatformDisplayID) { }
};
} // namespace WebCore
#define SPECIALIZE_TYPE_TRAITS_CDM_INSTANCE(ToValueTypeName, ImplementationTypeName) \
SPECIALIZE_TYPE_TRAITS_BEGIN(ToValueTypeName) \
static bool isType(const WebCore::CDMInstance& instance) { return instance.implementationType() == ImplementationTypeName; } \
SPECIALIZE_TYPE_TRAITS_END()
#endif