]> git.sesse.net Git - casparcg/blobdiff - core/producer/frame_producer.h
2.1.0: Refactoring.
[casparcg] / core / producer / frame_producer.h
index 9189c69fcb0c978c849870cfbec42f01f3da489c..b6c5963a1eca27392c43cbab157cdcf60bcf8dc4 100644 (file)
@@ -1,86 +1,83 @@
 /*\r
-* copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
 *\r
-*  This file is part of CasparCG.\r
+* This file is part of CasparCG (www.casparcg.com).\r
 *\r
-*    CasparCG is free software: you can redistribute it and/or modify\r
-*    it under the terms of the GNU General Public License as published by\r
-*    the Free Software Foundation, either version 3 of the License, or\r
-*    (at your option) any later version.\r
+* CasparCG is free software: you can redistribute it and/or modify\r
+* it under the terms of the GNU General Public License as published by\r
+* the Free Software Foundation, either version 3 of the License, or\r
+* (at your option) any later version.\r
 *\r
-*    CasparCG is distributed in the hope that it will be useful,\r
-*    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-*    GNU General Public License for more details.\r
-\r
-*    You should have received a copy of the GNU General Public License\r
-*    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
+* CasparCG is distributed in the hope that it will be useful,\r
+* but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
+* GNU General Public License for more details.\r
+*\r
+* You should have received a copy of the GNU General Public License\r
+* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.\r
 *\r
+* Author: Robert Nagy, ronag89@gmail.com\r
 */\r
+\r
 #pragma once\r
 \r
-#include "../frame/frame_fwd.h"\r
-#include "../frame/gpu_frame.h"\r
-#include "../frame/frame_factory.h"\r
+#include <common/forward.h>\r
+#include <common/memory/safe_ptr.h>\r
+#include <common/enum_class.h>\r
+\r
+#include <stdint.h>\r
+#include <limits>\r
+#include <functional>\r
+#include <string>\r
+#include <type_traits>\r
+#include <vector>\r
 \r
 #include <boost/noncopyable.hpp>\r
+#include <boost/property_tree/ptree_fwd.hpp>\r
 \r
-#include <memory>\r
+FORWARD1(caspar, class executor);\r
+FORWARD1(boost, template<typename T> class unique_future);\r
 \r
 namespace caspar { namespace core {\r
        \r
-class frame_producer : boost::noncopyable\r
+struct frame_producer : boost::noncopyable\r
 {\r
-public:\r
-       virtual ~frame_producer(){}     \r
+       struct flags_def\r
+       {\r
+               enum type\r
+               {\r
+                       none            = 0,\r
+                       alpha_only      = 2,\r
+                       deinterlace     = 4,\r
+               };\r
+       };\r
+       typedef enum_class<flags_def> flags;\r
 \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       /// \fn virtual gpu_frame_ptr :::render_frame() = 0;\r
-       ///\r
-       /// \brief      Renders a frame.\r
-       ///             \r
-       /// \note       This function is run in through the tbb task_schedular and shall be *non blocking*.\r
-       ///\r
-       /// \return     The frame. \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       virtual gpu_frame_ptr render_frame() = 0;\r
+       virtual ~frame_producer(){}     \r
 \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       /// \fn virtual std::shared_ptr<frame_producer> :::get_following_producer() const\r
-       ///\r
-       /// \brief      Gets the producer which will replace the current producer on EOF. \r
-       ///\r
-       /// \return     The following producer, or nullptr if there is no following producer. \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       virtual std::shared_ptr<frame_producer> get_following_producer() const { return nullptr; }\r
+       virtual std::wstring print() const = 0; // nothrow\r
+       virtual boost::property_tree::wptree info() const = 0;\r
 \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       /// \fn virtual void :::set_leading_producer(const std::shared_ptr<frame_producer>& producer)\r
-       ///\r
-       /// \brief      Sets the producer which was run before the current producer. \r
-       ///\r
-       /// \param      producer        The leading producer.\r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       virtual void set_leading_producer(const std::shared_ptr<frame_producer>& /*producer*/) {}\r
+       virtual boost::unique_future<std::wstring> call(const std::wstring&);\r
 \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       /// \fn virtual const frame_format_desc& :::get_frame_format_desc() const = 0;\r
-       ///\r
-       /// \brief      Gets the frame format description. \r
-       ///\r
-       /// \return     The frame format description. \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       virtual const frame_format_desc& get_frame_format_desc() const = 0;\r
+       virtual safe_ptr<frame_producer> get_following_producer() const {return frame_producer::empty();}  // nothrow\r
+       virtual void set_leading_producer(const safe_ptr<frame_producer>&) {}  // nothrow\r
+               \r
+       virtual uint32_t nb_frames() const {return std::numeric_limits<uint32_t>::max();}\r
+       \r
+       virtual safe_ptr<class draw_frame> receive(int flags) = 0;\r
+       virtual safe_ptr<class draw_frame> last_frame() const = 0;\r
 \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       /// \fn virtual void :::initialize(const frame_factory_ptr& factory) = 0;\r
-       ///\r
-       /// \brief      Provides the frame factory used to create frames and initializes the producer. \r
-       ///\r
-       /// \param      factory The frame factory. \r
-       ////////////////////////////////////////////////////////////////////////////////////////////////////\r
-       virtual void initialize(const frame_factory_ptr& factory) = 0;\r
+       static const safe_ptr<frame_producer>& empty(); // nothrow\r
 };\r
-typedef std::shared_ptr<frame_producer> frame_producer_ptr;\r
 \r
-}}
\ No newline at end of file
+safe_ptr<class draw_frame> receive_and_follow(safe_ptr<frame_producer>& producer, int flags);\r
+\r
+typedef std::function<safe_ptr<core::frame_producer>(const safe_ptr<struct frame_factory>&, const std::vector<std::wstring>&)> producer_factory_t;\r
+void register_producer_factory(const producer_factory_t& factory); // Not thread-safe.\r
+safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>&, const std::vector<std::wstring>& params);\r
+safe_ptr<core::frame_producer> create_producer(const safe_ptr<frame_factory>&, const std::wstring& params);\r
+safe_ptr<core::frame_producer> create_producer_destroy_proxy(safe_ptr<core::frame_producer> producer);\r
+safe_ptr<core::frame_producer> create_producer_print_proxy(safe_ptr<core::frame_producer> producer);\r
+               \r
+}}\r