xbmc/cores/RetroPlayer/streams/IRetroPlayerStream.h

   1 /*
   2  *  Copyright (C) 2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "RetroPlayerStreamTypes.h"
  12
  13 namespace KODI
  14 {
  15 namespace RETRO
  16 {
  17
  18 struct StreamProperties
  19 {
  20 };
  21
  22 struct StreamBuffer
  23 {
  24 };
  25
  26 struct StreamPacket
  27 {
  28 };
  29
  30 class IRetroPlayerStream
  31 {
  32 public:
  33   virtual ~IRetroPlayerStream() = default;
  34
  35   /*!
  36    * \brief Open a stream
  37    *
  38    * \return True if the stream was opened, false otherwise
  39    */
  40   virtual bool OpenStream(const StreamProperties& properties) = 0;
  41
  42   /*!
  43    * \brief Get a buffer for zero-copy stream data
  44    *
  45    * \param width The framebuffer width, or 0 for no width specified
  46    * \param height The framebuffer height, or 0 for no height specified
  47    * \param[out] buffer The buffer, or unmodified if false is returned
  48    *
  49    * \return True if a buffer was returned, false otherwise
  50    */
  51   virtual bool GetStreamBuffer(unsigned int width, unsigned int height, StreamBuffer& buffer) = 0;
  52
  53   /*!
  54    * \brief Add a data packet to a stream
  55    *
  56    * \param packet The data packet
  57    */
  58   virtual void AddStreamData(const StreamPacket& packet) = 0;
  59
  60   /*!
  61    * \brief Close the stream
  62    */
  63   virtual void CloseStream() = 0;
  64 };
  65
  66 } // namespace RETRO
  67 } // namespace KODI