]> git.sesse.net Git - casparcg/blobdiff - core/producer/frame_producer.h
[version.tmpl] Changed tag to Beta 1
[casparcg] / core / producer / frame_producer.h
index 17a4e3c75d5092bc15b447dff319871d0225f447..cf7fb402ac8f6a7e4d42a70b50d9e13a850301c8 100644 (file)
-/*\r
-* copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
-*\r
-*  This file is part of CasparCG.\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
-*\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
-*/\r
-#pragma once\r
-\r
-#include "frame/frame_factory.h"\r
-\r
-#include <common/memory/safe_ptr.h>\r
-\r
-#include <boost/noncopyable.hpp>\r
-\r
-#include <functional>\r
-#include <string>\r
-#include <vector>\r
-\r
-namespace caspar { namespace core {\r
-\r
-class basic_frame;\r
-\r
-class frame_producer : boost::noncopyable\r
-{\r
-public:\r
-       frame_producer();\r
-       virtual ~frame_producer(){}     \r
-\r
-       virtual std::wstring print() const = 0; // nothrow\r
-\r
-       virtual void param(const std::wstring&){}\r
-\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
-       static const safe_ptr<frame_producer>& empty(); // nothrow\r
-\r
-       safe_ptr<core::basic_frame> last_frame() const {return last_frame_;}\r
-       \r
-private:\r
-       friend safe_ptr<basic_frame> receive(const safe_ptr<frame_producer>& producer);\r
-\r
-       virtual safe_ptr<basic_frame> receive() = 0;\r
-\r
-       safe_ptr<basic_frame> receive_save_last();\r
-\r
-       safe_ptr<core::basic_frame> last_frame_;\r
-};\r
-\r
-safe_ptr<basic_frame> receive(const safe_ptr<frame_producer>& producer);\r
-safe_ptr<basic_frame> receive_and_follow(safe_ptr<frame_producer>& producer);\r
-safe_ptr<basic_frame> receive_and_follow_w_last(safe_ptr<frame_producer>& producer);\r
-\r
-typedef std::function<safe_ptr<core::frame_producer>(const safe_ptr<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
-\r
-\r
-}}\r
+/*
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
+*
+* This file is part of CasparCG (www.casparcg.com).
+*
+* CasparCG is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* CasparCG is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
+*
+* Author: Robert Nagy, ronag89@gmail.com
+*/
+
+#pragma once
+
+#include "../monitor/monitor.h"
+#include "../fwd.h"
+#include "../interaction/interaction_sink.h"
+#include "../help/help_repository.h"
+#include "binding.h"
+
+#include <common/forward.h>
+#include <common/future_fwd.h>
+#include <common/memory.h>
+
+#include <cstdint>
+#include <limits>
+#include <functional>
+#include <string>
+#include <type_traits>
+#include <vector>
+
+#include <boost/property_tree/ptree_fwd.hpp>
+
+FORWARD1(caspar, class executor);
+
+namespace caspar { namespace core {
+
+class variable;
+
+struct constraints
+{
+       binding<double> width;
+       binding<double> height;
+
+       constraints(double width, double height);
+       constraints();
+};
+       
+// Interface
+class frame_producer : public interaction_sink
+{
+       frame_producer(const frame_producer&);
+       frame_producer& operator=(const frame_producer&);
+public:
+
+       // Static Members
+       
+       static const spl::shared_ptr<frame_producer>& empty();
+
+       // Constructors
+
+       frame_producer(){}
+       virtual ~frame_producer(){}     
+
+       // Methods      
+
+       virtual draw_frame                                                      receive() = 0;
+       virtual std::future<std::wstring>                       call(const std::vector<std::wstring>& params) = 0;
+       virtual variable&                                                       get_variable(const std::wstring& name) = 0;
+       virtual const std::vector<std::wstring>&        get_variables() const = 0;
+       
+       // monitor::observable
+
+       virtual monitor::subject& monitor_output() = 0;
+
+       // interaction_sink
+       virtual void on_interaction(const interaction_event::ptr& event) override { }
+       virtual bool collides(double x, double y) const override { return false; }
+
+       // Properties
+       
+
+       virtual void                                                            paused(bool value) = 0;
+       virtual std::wstring                                            print() const = 0;
+       virtual std::wstring                                            name() const = 0;
+       virtual boost::property_tree::wptree            info() const = 0;
+       virtual uint32_t                                                        nb_frames() const = 0;
+       virtual uint32_t                                                        frame_number() const = 0;
+       virtual draw_frame                                                      last_frame() = 0;
+       virtual constraints&                                            pixel_constraints() = 0;
+       virtual void                                                            leading_producer(const spl::shared_ptr<frame_producer>&) {}  
+};
+
+class frame_producer_base : public frame_producer
+{
+public:
+       frame_producer_base();
+       virtual ~frame_producer_base(){}        
+
+       // Methods      
+
+       virtual std::future<std::wstring>                       call(const std::vector<std::wstring>& params) override;
+       virtual variable&                                                       get_variable(const std::wstring& name) override;
+       virtual const std::vector<std::wstring>&        get_variables() const override;
+       
+       // monitor::observable
+       
+       // Properties
+       
+       void                                            paused(bool value) override;    
+       uint32_t                                        nb_frames() const override;
+       uint32_t                                        frame_number() const override;
+       virtual draw_frame                      last_frame() override;
+
+private:
+       virtual draw_frame                      receive() override;
+       virtual draw_frame                      receive_impl() = 0;
+
+       struct impl;
+       friend struct impl;
+       std::shared_ptr<impl> impl_;
+};
+
+class frame_producer_registry;
+
+struct frame_producer_dependencies
+{
+       spl::shared_ptr<core::frame_factory>                    frame_factory;
+       std::vector<spl::shared_ptr<video_channel>>             channels;
+       video_format_desc                                                               format_desc;
+       spl::shared_ptr<const frame_producer_registry>  producer_registry;
+
+       frame_producer_dependencies(
+                       const spl::shared_ptr<core::frame_factory>& frame_factory,
+                       const std::vector<spl::shared_ptr<video_channel>>& channels,
+                       const video_format_desc& format_desc,
+                       const spl::shared_ptr<const frame_producer_registry> producer_registry);
+};
+
+typedef std::function<spl::shared_ptr<core::frame_producer>(const frame_producer_dependencies&, const std::vector<std::wstring>&)> producer_factory_t;
+typedef std::function<draw_frame (const frame_producer_dependencies&, const std::wstring&)> thumbnail_producer_t;
+
+class frame_producer_registry : boost::noncopyable
+{
+public:
+       frame_producer_registry(spl::shared_ptr<help_repository> help_repo);
+       void register_producer_factory(std::wstring name, const producer_factory_t& factory, const help_item_describer& describer); // Not thread-safe.
+       void register_thumbnail_producer(const thumbnail_producer_t& thumbnail_producer); // Not thread-safe.
+       spl::shared_ptr<core::frame_producer> create_producer(const frame_producer_dependencies&, const std::vector<std::wstring>& params) const;
+       spl::shared_ptr<core::frame_producer> create_producer(const frame_producer_dependencies&, const std::wstring& params) const;
+       draw_frame create_thumbnail(const frame_producer_dependencies&, const std::wstring& media_file) const;
+private:
+       struct impl;
+       spl::shared_ptr<impl> impl_;
+};
+
+spl::shared_ptr<core::frame_producer> create_destroy_proxy(spl::shared_ptr<core::frame_producer> producer);
+void destroy_producers_synchronously();
+
+}}