Line data    Source code

       1              : /*
       2              :  * If not stated otherwise in this file or this component's LICENSE file the
       3              :  * following copyright and licenses apply:
       4              :  *
       5              :  * Copyright 2022 Sky UK
       6              :  *
       7              :  * Licensed under the Apache License, Version 2.0 (the "License");
       8              :  * you may not use this file except in compliance with the License.
       9              :  * You may obtain a copy of the License at
      10              :  *
      11              :  * http://www.apache.org/licenses/LICENSE-2.0
      12              :  *
      13              :  * Unless required by applicable law or agreed to in writing, software
      14              :  * distributed under the License is distributed on an "AS IS" BASIS,
      15              :  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      16              :  * See the License for the specific language governing permissions and
      17              :  * limitations under the License.
      18              :  */
      19              : 
      20              : #ifndef FIREBOLT_RIALTO_I_MEDIA_KEYS_CAPABILITIES_H_
      21              : #define FIREBOLT_RIALTO_I_MEDIA_KEYS_CAPABILITIES_H_
      22              : 
      23              : /**
      24              :  * @file IMediaKeysCapabilities.h
      25              :  *
      26              :  * The definition of the IMediaKeysCapabilities interface.
      27              :  */
      28              : 
      29              : #include <memory>
      30              : #include <string>
      31              : #include <vector>
      32              : 
      33              : namespace firebolt::rialto
      34              : {
      35              : class IMediaKeysCapabilities;
      36              : 
      37              : /**
      38              :  * @brief IMediaKeysCapabilities factory class, for getting the IMediaKeysCapabilities singleton object.
      39              :  */
      40              : class IMediaKeysCapabilitiesFactory
      41              : {
      42              : public:
      43           92 :     IMediaKeysCapabilitiesFactory() = default;
      44           92 :     virtual ~IMediaKeysCapabilitiesFactory() = default;
      45              : 
      46              :     /**
      47              :      * @brief Gets the IMediaKeysCapabilitiesFactory instance.
      48              :      *
      49              :      * @retval the factory instance or null on error.
      50              :      */
      51              :     static std::shared_ptr<IMediaKeysCapabilitiesFactory> createFactory();
      52              : 
      53              :     /**
      54              :      * @brief Gets the IMediaKeysCapabilities singleton object.
      55              :      *
      56              :      * @retval the MediaKeysCapabilities instance or null on error.
      57              :      */
      58              :     virtual std::shared_ptr<IMediaKeysCapabilities> getMediaKeysCapabilities() const = 0;
      59              : };
      60              : 
      61              : /**
      62              :  * @brief The definition of the IMediaKeysCapabilities interface.
      63              :  *
      64              :  * This interface defines the public API of Rialto for querying EME decryption capabilities.
      65              :  * It should be implemented by both Rialto Client & Rialto Server.
      66              :  */
      67              : class IMediaKeysCapabilities
      68              : {
      69              : public:
      70          143 :     IMediaKeysCapabilities() = default;
      71          143 :     virtual ~IMediaKeysCapabilities() = default;
      72              : 
      73              :     IMediaKeysCapabilities(const IMediaKeysCapabilities &) = delete;
      74              :     IMediaKeysCapabilities &operator=(const IMediaKeysCapabilities &) = delete;
      75              :     IMediaKeysCapabilities(IMediaKeysCapabilities &&) = delete;
      76              :     IMediaKeysCapabilities &operator=(IMediaKeysCapabilities &&) = delete;
      77              : 
      78              :     /**
      79              :      * @brief Returns the EME key systems supported by Rialto
      80              :      *
      81              :      * @retval The supported key systems.
      82              :      */
      83              :     virtual std::vector<std::string> getSupportedKeySystems() = 0;
      84              : 
      85              :     /**
      86              :      * @brief Indicates if the specified key system is supported.
      87              :      *
      88              :      * This method should be called to ensure that the specified key
      89              :      * system is supported by Rialto.
      90              :      *
      91              :      * @param[in] keySystem : The key system.
      92              :      *
      93              :      * @retval true if supported.
      94              :      */
      95              :     virtual bool supportsKeySystem(const std::string &keySystem) = 0;
      96              : 
      97              :     /**
      98              :      * @brief Returns version of supported key system
      99              :      *
     100              :      * @param[in] keySystem    : The key system.
     101              :      * @param[out] version     : The supported version of the key system
     102              :      *
     103              :      * @retval true if operation was successful
     104              :      */
     105              :     virtual bool getSupportedKeySystemVersion(const std::string &keySystem, std::string &version) = 0;
     106              : 
     107              :     /**
     108              :      * @brief Gets support server certificate.
     109              :      *
     110              :      * Some DRMs (e.g. WideVine) use a system-wide server certificate. This method
     111              :      * gets if system has support for that certificate.
     112              :      *
     113              :      * @param[in] keySystem    : The key system.
     114              :      *
     115              :      * @retval true if server certificate is supported
     116              :      */
     117              :     virtual bool isServerCertificateSupported(const std::string &keySystem) = 0;
     118              : };
     119              : 
     120              : }; // namespace firebolt::rialto
     121              : 
     122              : #endif // FIREBOLT_RIALTO_I_MEDIA_KEYS_CAPABILITIES_H_