]> git.sesse.net Git - casparcg/blobdiff - core/consumer/frame_consumer.cpp
Created a consumer that provides sync to a channel based on the pace of another chann...
[casparcg] / core / consumer / frame_consumer.cpp
index 06c324c8178daeeb3aacd94dd65289c1189b8aa3..477998ace7cc2c9a2cb20d80e835e12c41642925 100644 (file)
 
 #include <common/except.h>
 #include <common/future.h>
+#include <common/os/general_protection_fault.h>
 
 #include <core/video_format.h>
 #include <core/frame/frame.h>
+#include <core/frame/audio_channel_layout.h>
 
 #include <boost/thread.hpp>
 
 #include <map>
 
 namespace caspar { namespace core {
-               
-std::vector<consumer_factory_t> g_consumer_factories;
-std::map<std::wstring, preconfigured_consumer_factory_t> g_preconfigured_consumer_factories;
 
-void register_consumer_factory(const consumer_factory_t& factory)
+struct frame_consumer_registry::impl
+{
+       std::vector<consumer_factory_t>                                                         consumer_factories;
+       std::map<std::wstring, preconfigured_consumer_factory_t>        preconfigured_consumer_factories;
+       spl::shared_ptr<help_repository>                                                        help_repo;
+
+       impl(spl::shared_ptr<help_repository> help_repo)
+               : help_repo(std::move(help_repo))
+       {
+       }
+};
+
+frame_consumer_registry::frame_consumer_registry(spl::shared_ptr<help_repository> help_repo)
+       : impl_(new impl(std::move(help_repo)))
 {
-       g_consumer_factories.push_back(factory);
 }
 
-void register_preconfigured_consumer_factory(
+void frame_consumer_registry::register_consumer_factory(const std::wstring& name, const consumer_factory_t& factory, const help_item_describer& describer)
+{
+       impl_->consumer_factories.push_back(factory);
+       impl_->help_repo->register_item({ L"consumer" }, std::move(name), describer);
+}
+
+void frame_consumer_registry::register_preconfigured_consumer_factory(
                const std::wstring& element_name,
                const preconfigured_consumer_factory_t& factory)
 {
-       g_preconfigured_consumer_factories.insert(std::make_pair(element_name, factory));
+       impl_->preconfigured_consumer_factories.insert(std::make_pair(element_name, factory));
+}
+
+tbb::atomic<bool>& destroy_consumers_in_separate_thread()
+{
+       static tbb::atomic<bool> state;
+
+       return state;
+}
+
+void destroy_consumers_synchronously()
+{
+       destroy_consumers_in_separate_thread() = false;
 }
 
 class destroy_consumer_proxy : public frame_consumer
-{      
+{
        std::shared_ptr<frame_consumer> consumer_;
 public:
-       destroy_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer) 
+       destroy_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
                : consumer_(std::move(consumer))
        {
+               destroy_consumers_in_separate_thread() = true;
        }
 
        ~destroy_consumer_proxy()
-       {               
-               static tbb::atomic<int> counter = tbb::atomic<int>();
-                       
+       {
+               static tbb::atomic<int> counter;
+               static std::once_flag counter_init_once;
+               std::call_once(counter_init_once, []{ counter = 0; });
+
+               if (!destroy_consumers_in_separate_thread())
+                       return;
+
                ++counter;
                CASPAR_VERIFY(counter < 8);
-               
+
                auto consumer = new std::shared_ptr<frame_consumer>(std::move(consumer_));
                boost::thread([=]
                {
                        std::unique_ptr<std::shared_ptr<frame_consumer>> pointer_guard(consumer);
-
                        auto str = (*consumer)->print();
+
                        try
                        {
-                               if(!consumer->unique())
-                                       CASPAR_LOG(trace) << str << L" Not destroyed on asynchronous destruction thread: " << consumer->use_count();
+                               ensure_gpf_handler_installed_for_thread(u8(L"Destroyer: " + str).c_str());
+
+                               if (!consumer->unique())
+                                       CASPAR_LOG(debug) << str << L" Not destroyed on asynchronous destruction thread: " << consumer->use_count();
                                else
-                                       CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread.";
+                                       CASPAR_LOG(debug) << str << L" Destroying on asynchronous destruction thread.";
                        }
                        catch(...){}
 
                        pointer_guard.reset();
 
-                       --counter;
-               }).detach(); 
+               }).detach();
        }
-       
-       std::future<bool> send(const_frame frame) override                                                                                                      {return consumer_->send(std::move(frame));}
-       virtual void initialize(const struct video_format_desc& format_desc, int channel_index) override        {return consumer_->initialize(format_desc, channel_index);}
-       std::wstring print() const override                                                                                                                                     {return consumer_->print();}    
-       std::wstring name() const override                                                                                                                                      {return consumer_->name();}
-       boost::property_tree::wptree info() const override                                                                                                      {return consumer_->info();}
-       bool has_synchronization_clock() const override                                                                                                         {return consumer_->has_synchronization_clock();}
-       int buffer_depth() const override                                                                                                                                       {return consumer_->buffer_depth();}
-       int index() const override                                                                                                                                                      {return consumer_->index();}
-       monitor::subject& monitor_output() override                                                                                                                     {return consumer_->monitor_output();}                                                                           
+
+       std::future<bool> send(const_frame frame) override                                                                                                                                                              {return consumer_->send(std::move(frame));}
+       void initialize(const video_format_desc& format_desc, const audio_channel_layout& channel_layout, int channel_index) override   {return consumer_->initialize(format_desc, channel_layout, channel_index);}
+       std::wstring print() const override                                                                                                                                                                                             {return consumer_->print();}
+       std::wstring name() const override                                                                                                                                                                                              {return consumer_->name();}
+       boost::property_tree::wptree info() const override                                                                                                                                                              {return consumer_->info();}
+       bool has_synchronization_clock() const override                                                                                                                                                                 {return consumer_->has_synchronization_clock();}
+       int buffer_depth() const override                                                                                                                                                                                               {return consumer_->buffer_depth();}
+       int index() const override                                                                                                                                                                                                              {return consumer_->index();}
+       int64_t presentation_frame_age_millis() const override                                                                                                                                                  {return consumer_->presentation_frame_age_millis();}
+       monitor::subject& monitor_output() override                                                                                                                                                                             {return consumer_->monitor_output();}
+       const frame_consumer* unwrapped() const override                                                                                                                                                                {return consumer_->unwrapped();}
 };
 
 class print_consumer_proxy : public frame_consumer
-{      
+{
        std::shared_ptr<frame_consumer> consumer_;
 public:
-       print_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer) 
+       print_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
                : consumer_(std::move(consumer))
        {
-               CASPAR_LOG(info) << consumer_->print() << L" Initialized.";
        }
 
        ~print_consumer_proxy()
-       {               
+       {
                auto str = consumer_->print();
-               CASPAR_LOG(trace) << str << L" Uninitializing.";
+               CASPAR_LOG(debug) << str << L" Uninitializing.";
                consumer_.reset();
                CASPAR_LOG(info) << str << L" Uninitialized.";
        }
-       
-       std::future<bool> send(const_frame frame) override                                                                                                      {return consumer_->send(std::move(frame));}
-       virtual void initialize(const struct video_format_desc& format_desc, int channel_index) override        {return consumer_->initialize(format_desc, channel_index);}
-       std::wstring print() const override                                                                                                                                     {return consumer_->print();}
-       std::wstring name() const override                                                                                                                                      {return consumer_->name();}
-       boost::property_tree::wptree info() const override                                                                                                      {return consumer_->info();}
-       bool has_synchronization_clock() const override                                                                                                         {return consumer_->has_synchronization_clock();}
-       int buffer_depth() const override                                                                                                                                       {return consumer_->buffer_depth();}
-       int index() const override                                                                                                                                                      {return consumer_->index();}
-       monitor::subject& monitor_output() override                                                                                                                     {return consumer_->monitor_output();}                                                                           
+
+       std::future<bool> send(const_frame frame) override                                                                                                                                                              {return consumer_->send(std::move(frame));}
+       void initialize(const video_format_desc& format_desc, const audio_channel_layout& channel_layout, int channel_index) override
+       {
+               consumer_->initialize(format_desc, channel_layout, channel_index);
+               CASPAR_LOG(info) << consumer_->print() << L" Initialized.";
+       }
+       std::wstring print() const override                                                                                                                                                                                             {return consumer_->print();}
+       std::wstring name() const override                                                                                                                                                                                              {return consumer_->name();}
+       boost::property_tree::wptree info() const override                                                                                                                                                              {return consumer_->info();}
+       bool has_synchronization_clock() const override                                                                                                                                                                 {return consumer_->has_synchronization_clock();}
+       int buffer_depth() const override                                                                                                                                                                                               {return consumer_->buffer_depth();}
+       int index() const override                                                                                                                                                                                                              {return consumer_->index();}
+       int64_t presentation_frame_age_millis() const override                                                                                                                                                  {return consumer_->presentation_frame_age_millis();}
+       monitor::subject& monitor_output() override                                                                                                                                                                             {return consumer_->monitor_output();}
+       const frame_consumer* unwrapped() const override                                                                                                                                                                {return consumer_->unwrapped();}
 };
 
 class recover_consumer_proxy : public frame_consumer
-{      
+{
        std::shared_ptr<frame_consumer> consumer_;
        int                                                             channel_index_  = -1;
        video_format_desc                               format_desc_;
+       audio_channel_layout                    channel_layout_ = audio_channel_layout::invalid();
 public:
-       recover_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer) 
+       recover_consumer_proxy(spl::shared_ptr<frame_consumer>&& consumer)
                : consumer_(std::move(consumer))
        {
        }
-       
-       virtual std::future<bool> send(const_frame frame)                                       
+
+       std::future<bool> send(const_frame frame) override
        {
                try
                {
@@ -151,7 +195,7 @@ public:
                        CASPAR_LOG_CURRENT_EXCEPTION();
                        try
                        {
-                               consumer_->initialize(format_desc_, channel_index_);
+                               consumer_->initialize(format_desc_, channel_layout_, channel_index_);
                                return consumer_->send(frame);
                        }
                        catch(...)
@@ -163,11 +207,12 @@ public:
                }
        }
 
-       virtual void initialize(const struct video_format_desc& format_desc, int channel_index)         
+       void initialize(const video_format_desc& format_desc, const audio_channel_layout& channel_layout, int channel_index) override
        {
                format_desc_    = format_desc;
+               channel_layout_ = channel_layout;
                channel_index_  = channel_index;
-               return consumer_->initialize(format_desc, channel_index);
+               return consumer_->initialize(format_desc, channel_layout, channel_index);
        }
 
        std::wstring print() const override                                                                             {return consumer_->print();}
@@ -176,7 +221,9 @@ public:
        bool has_synchronization_clock() const override                                                 {return consumer_->has_synchronization_clock();}
        int buffer_depth() const override                                                                               {return consumer_->buffer_depth();}
        int index() const override                                                                                              {return consumer_->index();}
-       monitor::subject& monitor_output() override                                                             {return consumer_->monitor_output();}                                                                           
+       int64_t presentation_frame_age_millis() const override                                  {return consumer_->presentation_frame_age_millis();}
+       monitor::subject& monitor_output() override                                                             {return consumer_->monitor_output();}
+       const frame_consumer* unwrapped() const override                                                {return consumer_->unwrapped();}
 };
 
 // This class is used to guarantee that audio cadence is correct. This is important for NTSC audio.
@@ -185,30 +232,32 @@ class cadence_guard : public frame_consumer
        spl::shared_ptr<frame_consumer>         consumer_;
        std::vector<int>                                        audio_cadence_;
        video_format_desc                                       format_desc_;
+       audio_channel_layout                            channel_layout_ = audio_channel_layout::invalid();
        boost::circular_buffer<std::size_t>     sync_buffer_;
 public:
        cadence_guard(const spl::shared_ptr<frame_consumer>& consumer)
                : consumer_(consumer)
        {
        }
-       
-       void initialize(const video_format_desc& format_desc, int channel_index) override
+
+       void initialize(const video_format_desc& format_desc, const audio_channel_layout& channel_layout, int channel_index) override
        {
                audio_cadence_  = format_desc.audio_cadence;
                sync_buffer_    = boost::circular_buffer<std::size_t>(format_desc.audio_cadence.size());
                format_desc_    = format_desc;
-               consumer_->initialize(format_desc, channel_index);
+               channel_layout_ = channel_layout;
+               consumer_->initialize(format_desc, channel_layout, channel_index);
        }
 
        std::future<bool> send(const_frame frame) override
-       {               
+       {
                if(audio_cadence_.size() == 1)
                        return consumer_->send(frame);
 
                std::future<bool> result = make_ready_future(true);
-               
-               if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() * format_desc_.audio_channels == static_cast<int>(frame.audio_data().size())) 
-               {       
+
+               if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() * channel_layout_.num_channels == static_cast<int>(frame.audio_data().size()))
+               {
                        // Audio sent so far is in sync, now we can send the next chunk.
                        result = consumer_->send(frame);
                        boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
@@ -216,32 +265,35 @@ public:
                else
                        CASPAR_LOG(trace) << print() << L" Syncing audio.";
 
-               sync_buffer_.push_back(static_cast<int>(frame.audio_data().size() / format_desc_.audio_channels));
-               
+               sync_buffer_.push_back(static_cast<int>(frame.audio_data().size() / channel_layout_.num_channels));
+
                return std::move(result);
        }
-       
+
        std::wstring print() const override                                                                             {return consumer_->print();}
        std::wstring name() const override                                                                              {return consumer_->name();}
        boost::property_tree::wptree info() const override                                              {return consumer_->info();}
        bool has_synchronization_clock() const override                                                 {return consumer_->has_synchronization_clock();}
        int buffer_depth() const override                                                                               {return consumer_->buffer_depth();}
        int index() const override                                                                                              {return consumer_->index();}
-       monitor::subject& monitor_output() override                                                             {return consumer_->monitor_output();}                                                                           
+       int64_t presentation_frame_age_millis() const override                                  {return consumer_->presentation_frame_age_millis();}
+       monitor::subject& monitor_output() override                                                             {return consumer_->monitor_output();}
+       const frame_consumer* unwrapped() const override                                                {return consumer_->unwrapped();}
 };
 
-spl::shared_ptr<core::frame_consumer> create_consumer(
-               const std::vector<std::wstring>& params, interaction_sink* sink)
+spl::shared_ptr<core::frame_consumer> frame_consumer_registry::create_consumer(
+               const std::vector<std::wstring>& params, interaction_sink* sink, std::vector<spl::shared_ptr<video_channel>> channels) const
 {
        if(params.empty())
-               CASPAR_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info(""));
-       
+               CASPAR_THROW_EXCEPTION(invalid_argument() << msg_info("params cannot be empty"));
+
        auto consumer = frame_consumer::empty();
-       std::any_of(g_consumer_factories.begin(), g_consumer_factories.end(), [&](const consumer_factory_t& factory) -> bool
+       auto& consumer_factories = impl_->consumer_factories;
+       std::any_of(consumer_factories.begin(), consumer_factories.end(), [&](const consumer_factory_t& factory) -> bool
                {
                        try
                        {
-                               consumer = factory(params, sink);
+                               consumer = factory(params, sink, channels);
                        }
                        catch(...)
                        {
@@ -260,22 +312,24 @@ spl::shared_ptr<core::frame_consumer> create_consumer(
                           std::move(consumer)))));
 }
 
-spl::shared_ptr<frame_consumer> create_consumer(
+spl::shared_ptr<frame_consumer> frame_consumer_registry::create_consumer(
                const std::wstring& element_name,
                const boost::property_tree::wptree& element,
-               interaction_sink* sink)
+               interaction_sink* sink,
+               std::vector<spl::shared_ptr<video_channel>> channels) const
 {
-       auto found = g_preconfigured_consumer_factories.find(element_name);
+       auto& preconfigured_consumer_factories = impl_->preconfigured_consumer_factories;
+       auto found = preconfigured_consumer_factories.find(element_name);
 
-       if (found == g_preconfigured_consumer_factories.end())
-               CASPAR_THROW_EXCEPTION(file_not_found()
+       if (found == preconfigured_consumer_factories.end())
+               CASPAR_THROW_EXCEPTION(user_error()
                        << msg_info(L"No consumer factory registered for element name " + element_name));
 
        return spl::make_shared<destroy_consumer_proxy>(
                        spl::make_shared<print_consumer_proxy>(
                                        spl::make_shared<recover_consumer_proxy>(
                                                        spl::make_shared<cadence_guard>(
-                                                                       found->second(element, sink)))));
+                                                                       found->second(element, sink, channels)))));
 }
 
 const spl::shared_ptr<frame_consumer>& frame_consumer::empty()
@@ -284,13 +338,14 @@ const spl::shared_ptr<frame_consumer>& frame_consumer::empty()
        {
        public:
                std::future<bool> send(const_frame) override { return make_ready_future(false); }
-               void initialize(const video_format_desc&, int) override{}
+               void initialize(const video_format_desc&, const audio_channel_layout&, int) override{}
                std::wstring print() const override {return L"empty";}
                std::wstring name() const override {return L"empty";}
                bool has_synchronization_clock() const override {return false;}
                int buffer_depth() const override {return 0;};
-               virtual int index() const{return -1;}
-               monitor::subject& monitor_output() override {static monitor::subject monitor_subject(""); return monitor_subject;}                                                                              
+               int index() const override {return -1;}
+               int64_t presentation_frame_age_millis() const override {return -1;}
+               monitor::subject& monitor_output() override {static monitor::subject monitor_subject(""); return monitor_subject;}
                boost::property_tree::wptree info() const override
                {
                        boost::property_tree::wptree info;