xbmc/cores/VideoPlayer/VideoRenderers/RenderCapture.h

   1 /*
   2  *  Copyright (C) 2005-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 "threads/Event.h"
  12
  13 enum ECAPTURESTATE
  14 {
  15   CAPTURESTATE_WORKING,
  16   CAPTURESTATE_NEEDSRENDER,
  17   CAPTURESTATE_NEEDSREADOUT,
  18   CAPTURESTATE_DONE,
  19   CAPTURESTATE_FAILED,
  20   CAPTURESTATE_NEEDSDELETE
  21 };
  22
  23 class CRenderCapture
  24 {
  25   public:
  26     CRenderCapture() = default;
  27     virtual ~CRenderCapture() = default;
  28
  29     virtual void BeginRender() = 0;
  30     virtual void EndRender() = 0;
  31
  32     virtual void ReadOut() {}
  33     virtual void* GetRenderBuffer() { return m_pixels; }
  34
  35     /* \brief Called by the rendermanager to set the state, should not be called by anything else */
  36     void SetState(ECAPTURESTATE state) { m_state = state; }
  37
  38     /* \brief Called by the rendermanager to get the state, should not be called by anything else */
  39     ECAPTURESTATE GetState() { return m_state;}
  40
  41     /* \brief Called by the rendermanager to set the userstate, should not be called by anything else */
  42     void SetUserState(ECAPTURESTATE state) { m_userState = state; }
  43
  44     /* \brief Called by the code requesting the capture
  45        \return CAPTURESTATE_WORKING when the capture is in progress,
  46        CAPTURESTATE_DONE when the capture has succeeded,
  47        CAPTURESTATE_FAILED when the capture has failed
  48     */
  49     ECAPTURESTATE GetUserState() { return m_userState; }
  50
  51     /* \brief The internal event will be set when the rendermanager has captured and read a videoframe, or when it has failed
  52        \return A reference to m_event
  53     */
  54     CEvent& GetEvent() { return m_event; }
  55
  56     /* \brief Called by the rendermanager to set the flags, should not be called by anything else */
  57     void SetFlags(int flags) { m_flags = flags; }
  58
  59     /* \brief Called by the rendermanager to get the flags, should not be called by anything else */
  60     int GetFlags() { return m_flags; }
  61
  62     /* \brief Called by the rendermanager to set the width, should not be called by anything else */
  63     void  SetWidth(unsigned int width) { m_width = width; }
  64
  65     /* \brief Called by the rendermanager to set the height, should not be called by anything else */
  66     void SetHeight(unsigned int height) { m_height = height; }
  67
  68     /* \brief Called by the code requesting the capture to get the width */
  69     unsigned int GetWidth() { return m_width; }
  70
  71     /* \brief Called by the code requesting the capture to get the height */
  72     unsigned int GetHeight() { return m_height; }
  73
  74     /* \brief Called by the code requesting the capture to get the buffer where the videoframe is stored,
  75        the format is BGRA, this buffer is only valid when GetUserState returns CAPTURESTATE_DONE.
  76        The size of the buffer is GetWidth() * GetHeight() * 4.
  77     */
  78     uint8_t*  GetPixels() const { return m_pixels; }
  79
  80     /* \brief Called by the rendermanager to know if the capture is readout async (using dma for example),
  81        should not be called by anything else.
  82     */
  83     bool  IsAsync() { return m_asyncSupported; }
  84
  85   protected:
  86     bool UseOcclusionQuery();
  87
  88     ECAPTURESTATE m_state{CAPTURESTATE_FAILED}; //state for the rendermanager
  89     ECAPTURESTATE m_userState{CAPTURESTATE_FAILED}; //state for the thread that wants the capture
  90     int m_flags{0};
  91     CEvent m_event;
  92
  93     uint8_t* m_pixels{nullptr};
  94     unsigned int m_width{0};
  95     unsigned int m_height{0};
  96     unsigned int m_bufferSize{0};
  97
  98     // this is set after the first render
  99     bool m_asyncSupported{false};
 100     bool m_asyncChecked{false};
 101 };
 102