X-Git-Url: https://git.sesse.net/?a=blobdiff_plain;f=core%2Fconsumer%2Fframe_consumer.cpp;h=477998ace7cc2c9a2cb20d80e835e12c41642925;hb=9e4b08cde6c6de9e83a3fff42d90affc3cd8e5bc;hp=90989debce4d799ba91c63d9a49eb493d0705931;hpb=435cf4b385c5099270bee44f89c3e2615af30521;p=casparcg diff --git a/core/consumer/frame_consumer.cpp b/core/consumer/frame_consumer.cpp index 90989debc..477998ace 100644 --- a/core/consumer/frame_consumer.cpp +++ b/core/consumer/frame_consumer.cpp @@ -1,266 +1,360 @@ -/* -* Copyright (c) 2011 Sveriges Television AB -* -* 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 . -* -* Author: Robert Nagy, ronag89@gmail.com -*/ - -#include "../StdAfx.h" - -#include "frame_consumer.h" - -#include - -#include -#include - -#include - -namespace caspar { namespace core { - -std::vector g_factories; - -void register_consumer_factory(const consumer_factory_t& factory) -{ - g_factories.push_back(factory); -} - -class destroy_consumer_proxy : public frame_consumer -{ - std::shared_ptr consumer_; -public: - destroy_consumer_proxy(spl::shared_ptr&& consumer) - : consumer_(std::move(consumer)) - { - } - - ~destroy_consumer_proxy() - { - static tbb::atomic counter = tbb::atomic(); - - ++counter; - CASPAR_VERIFY(counter < 32); - - auto consumer = new std::shared_ptr(std::move(consumer_)); - async([=] - { - std::unique_ptr> 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(); - else - CASPAR_LOG(trace) << str << L" Destroying on asynchronous destruction thread."; - } - catch(...){} - - pointer_guard.reset(); - - --counter; - }); - } - - virtual 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);} - virtual std::wstring print() const override {return consumer_->print();} - virtual std::wstring name() const override {return consumer_->name();} - virtual boost::property_tree::wptree info() const override {return consumer_->info();} - virtual bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();} - virtual int buffer_depth() const override {return consumer_->buffer_depth();} - virtual int index() const override {return consumer_->index();} -}; - -class print_consumer_proxy : public frame_consumer -{ - std::shared_ptr consumer_; -public: - print_consumer_proxy(spl::shared_ptr&& 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."; - consumer_.reset(); - CASPAR_LOG(info) << str << L" Uninitialized."; - } - - virtual 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);} - virtual std::wstring print() const override {return consumer_->print();} - virtual std::wstring name() const override {return consumer_->name();} - virtual boost::property_tree::wptree info() const override {return consumer_->info();} - virtual bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();} - virtual int buffer_depth() const override {return consumer_->buffer_depth();} - virtual int index() const override {return consumer_->index();} -}; - -class recover_consumer_proxy : public frame_consumer -{ - std::shared_ptr consumer_; - int channel_index_; - video_format_desc format_desc_; -public: - recover_consumer_proxy(spl::shared_ptr&& consumer) - : consumer_(std::move(consumer)) - { - } - - virtual bool send(const_frame frame) - { - try - { - return consumer_->send(frame); - } - catch(...) - { - CASPAR_LOG_CURRENT_EXCEPTION(); - try - { - consumer_->initialize(format_desc_, channel_index_); - return consumer_->send(frame); - } - catch(...) - { - CASPAR_LOG_CURRENT_EXCEPTION(); - CASPAR_LOG(error) << print() << "Failed to recover consumer."; - return false; - } - } - } - - virtual void initialize(const struct video_format_desc& format_desc, int channel_index) - { - format_desc_ = format_desc; - channel_index_ = channel_index; - return consumer_->initialize(format_desc, channel_index); - } - - virtual std::wstring print() const override {return consumer_->print();} - virtual std::wstring name() const override {return consumer_->name();} - virtual boost::property_tree::wptree info() const override {return consumer_->info();} - virtual bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();} - virtual int buffer_depth() const override {return consumer_->buffer_depth();} - virtual int index() const override {return consumer_->index();} -}; - -// This class is used to guarantee that audio cadence is correct. This is important for NTSC audio. -class cadence_guard : public frame_consumer -{ - spl::shared_ptr consumer_; - std::vector audio_cadence_; - boost::circular_buffer sync_buffer_; -public: - cadence_guard(const spl::shared_ptr& consumer) - : consumer_(consumer) - { - } - - virtual void initialize(const video_format_desc& format_desc, int channel_index) override - { - audio_cadence_ = format_desc.audio_cadence; - sync_buffer_ = boost::circular_buffer(format_desc.audio_cadence.size()); - consumer_->initialize(format_desc, channel_index); - } - - virtual bool send(const_frame frame) override - { - if(audio_cadence_.size() == 1) - return consumer_->send(frame); - - bool result = true; - - if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() == static_cast(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); - } - else - CASPAR_LOG(trace) << print() << L" Syncing audio."; - - sync_buffer_.push_back(static_cast(frame.audio_data().size())); - - return result; - } - - virtual std::wstring print() const override {return consumer_->print();} - virtual std::wstring name() const override {return consumer_->name();} - virtual boost::property_tree::wptree info() const override {return consumer_->info();} - virtual bool has_synchronization_clock() const override {return consumer_->has_synchronization_clock();} - virtual int buffer_depth() const override {return consumer_->buffer_depth();} - virtual int index() const override {return consumer_->index();} -}; - -spl::shared_ptr create_consumer(const std::vector& params) -{ - if(params.empty()) - BOOST_THROW_EXCEPTION(invalid_argument() << arg_name_info("params") << arg_value_info("")); - - auto consumer = frame_consumer::empty(); - std::any_of(g_factories.begin(), g_factories.end(), [&](const consumer_factory_t& factory) -> bool - { - try - { - consumer = factory(params); - } - catch(...) - { - CASPAR_LOG_CURRENT_EXCEPTION(); - } - return consumer != frame_consumer::empty(); - }); - - if(consumer == frame_consumer::empty()) - BOOST_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.")); - - return spl::make_shared( - spl::make_shared( - spl::make_shared( - spl::make_shared( - std::move(consumer))))); -} - -const spl::shared_ptr& frame_consumer::empty() -{ - class empty_frame_consumer : public frame_consumer - { - public: - virtual bool send(const_frame) override {return false;} - virtual void initialize(const video_format_desc&, int) override{} - virtual std::wstring print() const override {return L"empty";} - virtual std::wstring name() const override {return L"empty";} - virtual bool has_synchronization_clock() const override {return false;} - virtual int buffer_depth() const override {return 0;}; - virtual int index() const{return -1;} - virtual boost::property_tree::wptree info() const override - { - boost::property_tree::wptree info; - info.add(L"type", L"empty"); - return info; - } - }; - static spl::shared_ptr consumer = spl::make_shared(); - return consumer; -} - -}} \ No newline at end of file +/* +* Copyright (c) 2011 Sveriges Television AB +* +* 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 . +* +* Author: Robert Nagy, ronag89@gmail.com +*/ + +#include "../StdAfx.h" + +#include "frame_consumer.h" + +#include +#include +#include + +#include +#include +#include + +#include + +#include +#include +#include + +namespace caspar { namespace core { + +struct frame_consumer_registry::impl +{ + std::vector consumer_factories; + std::map preconfigured_consumer_factories; + spl::shared_ptr help_repo; + + impl(spl::shared_ptr help_repo) + : help_repo(std::move(help_repo)) + { + } +}; + +frame_consumer_registry::frame_consumer_registry(spl::shared_ptr help_repo) + : impl_(new impl(std::move(help_repo))) +{ +} + +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) +{ + impl_->preconfigured_consumer_factories.insert(std::make_pair(element_name, factory)); +} + +tbb::atomic& destroy_consumers_in_separate_thread() +{ + static tbb::atomic state; + + return state; +} + +void destroy_consumers_synchronously() +{ + destroy_consumers_in_separate_thread() = false; +} + +class destroy_consumer_proxy : public frame_consumer +{ + std::shared_ptr consumer_; +public: + destroy_consumer_proxy(spl::shared_ptr&& consumer) + : consumer_(std::move(consumer)) + { + destroy_consumers_in_separate_thread() = true; + } + + ~destroy_consumer_proxy() + { + static tbb::atomic 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(std::move(consumer_)); + boost::thread([=] + { + std::unique_ptr> pointer_guard(consumer); + auto str = (*consumer)->print(); + + try + { + 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(debug) << str << L" Destroying on asynchronous destruction thread."; + } + catch(...){} + + pointer_guard.reset(); + + }).detach(); + } + + std::future 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 consumer_; +public: + print_consumer_proxy(spl::shared_ptr&& consumer) + : consumer_(std::move(consumer)) + { + } + + ~print_consumer_proxy() + { + auto str = consumer_->print(); + CASPAR_LOG(debug) << str << L" Uninitializing."; + consumer_.reset(); + CASPAR_LOG(info) << str << L" Uninitialized."; + } + + std::future 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 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&& consumer) + : consumer_(std::move(consumer)) + { + } + + std::future send(const_frame frame) override + { + try + { + return consumer_->send(frame); + } + catch(...) + { + CASPAR_LOG_CURRENT_EXCEPTION(); + try + { + consumer_->initialize(format_desc_, channel_layout_, channel_index_); + return consumer_->send(frame); + } + catch(...) + { + CASPAR_LOG_CURRENT_EXCEPTION(); + CASPAR_LOG(error) << print() << " Failed to recover consumer."; + return make_ready_future(false); + } + } + } + + 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_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();} +}; + +// This class is used to guarantee that audio cadence is correct. This is important for NTSC audio. +class cadence_guard : public frame_consumer +{ + spl::shared_ptr consumer_; + std::vector audio_cadence_; + video_format_desc format_desc_; + audio_channel_layout channel_layout_ = audio_channel_layout::invalid(); + boost::circular_buffer sync_buffer_; +public: + cadence_guard(const spl::shared_ptr& consumer) + : consumer_(consumer) + { + } + + 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(format_desc.audio_cadence.size()); + format_desc_ = format_desc; + channel_layout_ = channel_layout; + consumer_->initialize(format_desc, channel_layout, channel_index); + } + + std::future send(const_frame frame) override + { + if(audio_cadence_.size() == 1) + return consumer_->send(frame); + + std::future result = make_ready_future(true); + + if(boost::range::equal(sync_buffer_, audio_cadence_) && audio_cadence_.front() * channel_layout_.num_channels == static_cast(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); + } + else + CASPAR_LOG(trace) << print() << L" Syncing audio."; + + sync_buffer_.push_back(static_cast(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();} + 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 frame_consumer_registry::create_consumer( + const std::vector& params, interaction_sink* sink, std::vector> channels) const +{ + if(params.empty()) + CASPAR_THROW_EXCEPTION(invalid_argument() << msg_info("params cannot be empty")); + + auto consumer = frame_consumer::empty(); + 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, channels); + } + catch(...) + { + CASPAR_LOG_CURRENT_EXCEPTION(); + } + return consumer != frame_consumer::empty(); + }); + + if(consumer == frame_consumer::empty()) + CASPAR_THROW_EXCEPTION(file_not_found() << msg_info("No match found for supplied commands. Check syntax.")); + + return spl::make_shared( + spl::make_shared( + spl::make_shared( + spl::make_shared( + std::move(consumer))))); +} + +spl::shared_ptr frame_consumer_registry::create_consumer( + const std::wstring& element_name, + const boost::property_tree::wptree& element, + interaction_sink* sink, + std::vector> channels) const +{ + auto& preconfigured_consumer_factories = impl_->preconfigured_consumer_factories; + auto found = preconfigured_consumer_factories.find(element_name); + + 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( + spl::make_shared( + spl::make_shared( + spl::make_shared( + found->second(element, sink, channels))))); +} + +const spl::shared_ptr& frame_consumer::empty() +{ + class empty_frame_consumer : public frame_consumer + { + public: + std::future send(const_frame) override { return make_ready_future(false); } + 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;}; + 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; + info.add(L"type", L"empty"); + return info; + } + }; + static spl::shared_ptr consumer = spl::make_shared(); + return consumer; +} + +}}