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_COMMON_MEDIA_FRAME_WRITERV2_H_
      21              : #define FIREBOLT_RIALTO_COMMON_MEDIA_FRAME_WRITERV2_H_
      22              : 
      23              : #include "ByteWriter.h"
      24              : #include "IMediaFrameWriter.h"
      25              : #include "metadata.pb.h"
      26              : #include <memory>
      27              : #include <vector>
      28              : 
      29              : namespace firebolt::rialto::common
      30              : {
      31              : /**
      32              :  * @brief The definition of the MediaFrameWriterV2.
      33              :  */
      34              : class MediaFrameWriterV2 : public IMediaFrameWriter
      35              : {
      36              : public:
      37              :     /**
      38              :      * @brief The constructor.
      39              :      *
      40              :      * @param[in] shmBuffer     : The shared buffer pointer.
      41              :      * @param[in] shmInfo       : The information for populating the shared memory.
      42              :      */
      43              :     MediaFrameWriterV2(uint8_t *shmBuffer, const std::shared_ptr<MediaPlayerShmInfo> &shmInfo);
      44              : 
      45              :     /**
      46              :      * @brief Virtual destructor.
      47              :      */
      48           42 :     virtual ~MediaFrameWriterV2() = default;
      49              : 
      50              :     /**
      51              :      * @brief Write the frame data.
      52              :      *
      53              :      * @param[in] data  : Media Segment data.
      54              :      *
      55              :      * @retval true on success.
      56              :      */
      57              :     AddSegmentStatus writeFrame(const std::unique_ptr<IMediaPipeline::MediaSegment> &data) override;
      58              : 
      59              :     /**
      60              :      * @brief Gets number of written frames
      61              :      *
      62              :      * @retval number of written frames
      63              :      */
      64            8 :     uint32_t getNumFrames() override { return m_numFrames; }
      65              : 
      66              : private:
      67              :     /**
      68              :      * @brief Builds metadata proto object
      69              :      *
      70              :      * @param[in] data  : Media Segment data.
      71              :      *
      72              :      * @warning Method may throw!
      73              :      *
      74              :      * @retval MediaSegmentMetadata proto object
      75              :      */
      76              :     MediaSegmentMetadata buildMetadata(const std::unique_ptr<IMediaPipeline::MediaSegment> &data) const;
      77              : 
      78              : private:
      79              :     /**
      80              :      * @brief ByteWriter object.
      81              :      */
      82              :     ByteWriter m_byteWriter;
      83              : 
      84              :     /**
      85              :      * @brief Pointer to the shared memory buffer.
      86              :      */
      87              :     uint8_t *m_shmBuffer;
      88              : 
      89              :     /**
      90              :      * @brief The maximum amout of data that can be written.
      91              :      */
      92              :     const uint32_t m_kMaxBytes;
      93              : 
      94              :     /**
      95              :      * @brief The amount of media bytes written to the shared buffer.
      96              :      */
      97              :     uint32_t m_bytesWritten;
      98              : 
      99              :     /**
     100              :      * @brief The offset of the shared memory to write the data.
     101              :      */
     102              :     uint32_t m_dataOffset;
     103              : 
     104              :     /**
     105              :      * @brief Number of frames written.
     106              :      */
     107              :     uint32_t m_numFrames;
     108              : };
     109              : } // namespace firebolt::rialto::common
     110              : 
     111              : #endif // FIREBOLT_RIALTO_COMMON_MEDIA_FRAME_WRITERV2_H_