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_PIPELINE_CAPABILITIES_H_
      21              : #define FIREBOLT_RIALTO_I_MEDIA_PIPELINE_CAPABILITIES_H_
      22              : 
      23              : /**
      24              :  * @file IMediaPipelineCapabilities.h
      25              :  *
      26              :  * The definition of the IMediaPipelineCapabilities interface.
      27              :  */
      28              : 
      29              : #include "MediaCommon.h"
      30              : #include <memory>
      31              : #include <string>
      32              : #include <vector>
      33              : 
      34              : namespace firebolt::rialto
      35              : {
      36              : class IMediaPipelineCapabilities;
      37              : 
      38              : /**
      39              :  * @brief IMediaPipelineCapabilities factory class, for getting the IMediaPipelineCapabilities object.
      40              :  */
      41              : class IMediaPipelineCapabilitiesFactory
      42              : {
      43              : public:
      44          129 :     IMediaPipelineCapabilitiesFactory() = default;
      45          129 :     virtual ~IMediaPipelineCapabilitiesFactory() = default;
      46              : 
      47              :     /**
      48              :      * @brief Gets the IMediaPipelineCapabilitiesFactory instance.
      49              :      *
      50              :      * @retval the factory instance or null on error.
      51              :      */
      52              :     static std::shared_ptr<IMediaPipelineCapabilitiesFactory> createFactory();
      53              : 
      54              :     /**
      55              :      * @brief Creates the IMediaPipelineCapabilities object.
      56              :      *
      57              :      * @retval the MediaPipelineCapabilities instance or null on error.
      58              :      */
      59              :     virtual std::unique_ptr<IMediaPipelineCapabilities> createMediaPipelineCapabilities() const = 0;
      60              : };
      61              : 
      62              : /**
      63              :  * @brief The definition of the IMediaPipelineCapabilities interface.
      64              :  *
      65              :  * This interface defines the public API of Rialto for querying EME decryption capabilities.
      66              :  * It should be implemented by both Rialto Client & Rialto Server.
      67              :  */
      68              : class IMediaPipelineCapabilities
      69              : {
      70              : public:
      71          158 :     IMediaPipelineCapabilities() = default;
      72          158 :     virtual ~IMediaPipelineCapabilities() = default;
      73              : 
      74              :     IMediaPipelineCapabilities(const IMediaPipelineCapabilities &) = delete;
      75              :     IMediaPipelineCapabilities &operator=(const IMediaPipelineCapabilities &) = delete;
      76              :     IMediaPipelineCapabilities(IMediaPipelineCapabilities &&) = delete;
      77              :     IMediaPipelineCapabilities &operator=(IMediaPipelineCapabilities &&) = delete;
      78              : 
      79              :     /**
      80              :      * @brief Returns the MSE mime types supported by Rialto for \a sourceType
      81              :      *
      82              :      * @param[in] sourceType : source type
      83              :      *
      84              :      * @retval The supported mime types.
      85              :      */
      86              :     virtual std::vector<std::string> getSupportedMimeTypes(MediaSourceType sourceType) = 0;
      87              : 
      88              :     /**
      89              :      * @brief Indicates if the specified mime type is supported.
      90              :      *
      91              :      * This method should be called to ensure that the specified mime
      92              :      * type is supported by Rialto.
      93              :      *
      94              :      * @param[in] mimeType : The mime type to check.
      95              :      *
      96              :      * @retval true if supported.
      97              :      */
      98              :     virtual bool isMimeTypeSupported(const std::string &mimeType) = 0;
      99              : 
     100              :     /**
     101              :      * @brief  Check sinks and decoders for supported properties
     102              :      *
     103              :      * @param[in] mediaType     : The media type to search. If set to UNKNOWN then both AUDIO and VIDEO are searched
     104              :      * @param[in] propertyNames : A vector of property names to look for
     105              :      *
     106              :      * @retval Returns the subset of propertyNames that are supported by the mediaType
     107              :      */
     108              :     virtual std::vector<std::string> getSupportedProperties(MediaSourceType mediaType,
     109              :                                                             const std::vector<std::string> &propertyNames) = 0;
     110              : };
     111              : 
     112              : }; // namespace firebolt::rialto
     113              : 
     114              : #endif // FIREBOLT_RIALTO_I_MEDIA_PIPELINE_CAPABILITIES_H_