git.sesse.net Git - casparcg/blob - core/producer/frame_producer.h

   1 /*\r
   2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 *  This file is part of CasparCG.\r
   5 *\r
   6 *    CasparCG is free software: you can redistribute it and/or modify\r
   7 *    it under the terms of the GNU General Public License as published by\r
   8 *    the Free Software Foundation, either version 3 of the License, or\r
   9 *    (at your option) any later version.\r
  10 *\r
  11 *    CasparCG is distributed in the hope that it will be useful,\r
  12 *    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 *    GNU General Public License for more details.\r
  15 \r
  16 *    You should have received a copy of the GNU General Public License\r
  17 *    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 */\r
  20 #pragma once\r
  21 \r
  22 #include "../processor/draw_frame.h"\r
  23 #include "../processor/frame_processor_device.h"\r
  24 #include "../../common/utility/safe_ptr.h"\r
  25 \r
  26 #include <boost/noncopyable.hpp>\r
  27 \r
  28 #include <memory>\r
  29 \r
  30 namespace caspar { namespace core {\r
  31         \r
  32 class frame_producer : boost::noncopyable\r
  33 {\r
  34 public:\r
  35         virtual ~frame_producer(){}     \r
  36 \r
  37         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  38         /// \fn virtual draw_frame :::receive() = 0;\r
  39         ///\r
  40         /// \brief      Renders a frame.\r
  41         ///             \r
  42         /// \note       This function is run in through the tbb task_schedular and shall be *non blocking*.\r
  43         ///\r
  44         /// \return     The frame. \r
  45         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  46         virtual safe_ptr<draw_frame> receive() = 0;\r
  47 \r
  48         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  49         /// \fn virtual std::shared_ptr<frame_producer> :::get_following_producer() const\r
  50         ///\r
  51         /// \brief      Gets the producer which will replace the current producer on EOF. \r
  52         ///\r
  53         /// \return     The following producer, or nullptr if there is no following producer. \r
  54         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  55         virtual safe_ptr<frame_producer> get_following_producer() const {return frame_producer::empty();}\r
  56         \r
  57         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  58         /// \fn virtual void :::set_leading_producer(const std::shared_ptr<frame_producer>& producer)\r
  59         ///\r
  60         /// \brief      Sets the producer which was run before the current producer. \r
  61         ///\r
  62         /// \param      producer        The leading producer.\r
  63         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  64         virtual void set_leading_producer(const safe_ptr<frame_producer>& /*producer*/) {}\r
  65         \r
  66         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  67         /// \fn virtual void :::initialize(const frame_processor_device_ptr& frame_processor) = 0;\r
  68         ///\r
  69         /// \brief      Provides the frame frame_processor used to create frames and initializes the producer. \r
  70         ///\r
  71         /// \param      frame_processor The frame frame_processor. \r
  72         ////////////////////////////////////////////////////////////////////////////////////////////////////\r
  73         virtual void initialize(const frame_processor_device_ptr& frame_processor) = 0;\r
  74 \r
  75         static safe_ptr<frame_producer> empty();\r
  76 \r
  77         virtual std::wstring print() const = 0;\r
  78 };\r
  79 \r
  80 inline std::wostream& operator<<(std::wostream& out, const frame_producer& producer);\r
  81 \r
  82 }}\r