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

   1 /*\r
   2 * Copyright 2013 Sveriges Television AB http://casparcg.com/\r
   3 *\r
   4 * This file is part of CasparCG (www.casparcg.com).\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 * Author: Robert Nagy, ronag89@gmail.com\r
  20 */\r
  21 \r
  22 #pragma once\r
  23 \r
  24 #include "../monitor/monitor.h"\r
  25 \r
  26 #include <common/memory/safe_ptr.h>\r
  27 #include <common/exception/exceptions.h>\r
  28 \r
  29 #include <boost/noncopyable.hpp>\r
  30 \r
  31 #include <algorithm>\r
  32 #include <functional>\r
  33 #include <string>\r
  34 #include <vector>\r
  35 #include <stdint.h>\r
  36 #include <numeric>\r
  37 \r
  38 #include <boost/thread/future.hpp>\r
  39 #include <boost/property_tree/ptree_fwd.hpp>\r
  40 \r
  41 namespace caspar { \r
  42         \r
  43 class executor;\r
  44         \r
  45 namespace core {\r
  46 \r
  47 class basic_frame;\r
  48 class parameters;\r
  49 struct frame_factory;\r
  50 \r
  51 struct frame_producer : boost::noncopyable\r
  52 {\r
  53 public:\r
  54         enum hints\r
  55         {\r
  56                 NO_HINT = 0,\r
  57                 ALPHA_HINT = 1,\r
  58                 DEINTERLACE_HINT\r
  59         };\r
  60 \r
  61         virtual ~frame_producer(){}     \r
  62 \r
  63         virtual std::wstring print() const = 0; // nothrow\r
  64         virtual boost::property_tree::wptree info() const = 0;\r
  65 \r
  66         virtual boost::unique_future<std::wstring> call(const std::wstring&) \r
  67         {\r
  68                 BOOST_THROW_EXCEPTION(not_supported());\r
  69         }\r
  70 \r
  71         virtual safe_ptr<frame_producer> get_following_producer() const {return frame_producer::empty();}  // nothrow\r
  72         virtual void set_leading_producer(const safe_ptr<frame_producer>&) {}  // nothrow\r
  73                 \r
  74         virtual uint32_t nb_frames() const {return std::numeric_limits<uint32_t>::max();}\r
  75         \r
  76         virtual safe_ptr<basic_frame> receive(int hints) = 0;\r
  77         virtual safe_ptr<core::basic_frame> last_frame() const = 0;\r
  78         virtual safe_ptr<basic_frame> create_thumbnail_frame();\r
  79 \r
  80         static const safe_ptr<frame_producer>& empty(); // nothrow\r
  81 \r
  82         virtual monitor::source& monitor_output() = 0;\r
  83 };\r
  84 \r
  85 safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int hints);\r
  86 \r
  87 typedef std::function<safe_ptr<core::frame_producer>(const safe_ptr<frame_factory>&, const core::parameters& params)> producer_factory_t;\r
  88 void register_producer_factory(const producer_factory_t& factory); // Not thread-safe.\r
  89 void register_thumbnail_producer_factory(const producer_factory_t& factory); // Not thread-safe.\r
  90 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>&, const core::parameters& params);\r
  91 safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>&, const std::wstring& params);\r
  92 safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer);\r
  93 safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer);\r
  94 safe_ptr<core::frame_producer> create_thumbnail_producer(const safe_ptr<frame_factory>& factory, const std::wstring& media_file);\r
  95 void destroy_producers_synchronously();\r
  96 \r
  97 }}\r