]> git.sesse.net Git - casparcg/blobdiff - modules/decklink/producer/decklink_producer.cpp
[ffmpeg] Reimplemented support for playing all audio streams in a clip and treating...
[casparcg] / modules / decklink / producer / decklink_producer.cpp
index e74b1bfa3ed1f558dfd43ea45336aa62fe639bef..0349f5bc15052610f7e14fd8516068aa48e73258 100644 (file)
 #include <common/param.h>
 #include <common/timer.h>
 
+#include <core/frame/audio_channel_layout.h>
 #include <core/frame/frame.h>
 #include <core/frame/draw_frame.h>
 #include <core/frame/frame_transform.h>
 #include <core/frame/frame_factory.h>
 #include <core/producer/frame_producer.h>
+#include <core/producer/framerate/framerate_producer.h>
 #include <core/monitor/monitor.h>
+#include <core/diagnostics/call_context.h>
 #include <core/mixer/audio/audio_mixer.h>
 #include <core/help/help_repository.h>
 #include <core/help/help_sink.h>
 
 #include <boost/algorithm/string.hpp>
 #include <boost/property_tree/ptree.hpp>
+#include <boost/range/adaptor/transformed.hpp>
 
 #if defined(_MSC_VER)
 #pragma warning (push)
 #pragma warning (disable : 4244)
 #endif
-extern "C" 
+extern "C"
 {
        #define __STDC_CONSTANT_MACROS
        #define __STDC_LIMIT_MACROS
@@ -71,9 +75,35 @@ extern "C"
 #include <functional>
 
 namespace caspar { namespace decklink {
-               
+core::audio_channel_layout get_adjusted_channel_layout(core::audio_channel_layout layout)
+{
+       if (layout.num_channels <= 2)
+               layout.num_channels = 2;
+       else if (layout.num_channels <= 8)
+               layout.num_channels = 8;
+       else
+               layout.num_channels = 16;
+
+       return layout;
+}
+
+template <typename T>
+std::wstring to_string(const T& cadence)
+{
+       return boost::join(cadence | boost::adaptors::transformed([](size_t i) { return boost::lexical_cast<std::wstring>(i); }), L", ");
+}
+
+ffmpeg::audio_input_pad create_input_pad(const core::video_format_desc& in_format, int num_channels)
+{
+       return ffmpeg::audio_input_pad(
+                       boost::rational<int>(1, in_format.audio_sample_rate),
+                       in_format.audio_sample_rate,
+                       AVSampleFormat::AV_SAMPLE_FMT_S32,
+                       av_get_default_channel_layout(num_channels));
+}
+
 class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
-{      
+{
        const int                                                                               device_index_;
        core::monitor::subject                                                  monitor_subject_;
        spl::shared_ptr<diagnostics::graph>                             graph_;
@@ -82,75 +112,94 @@ class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
        com_ptr<IDeckLink>                                                              decklink_                       = get_device(device_index_);
        com_iface_ptr<IDeckLinkInput>                                   input_                          = iface_cast<IDeckLinkInput>(decklink_);
        com_iface_ptr<IDeckLinkAttributes>                              attributes_                     = iface_cast<IDeckLinkAttributes>(decklink_);
-       
+
        const std::wstring                                                              model_name_                     = get_model_name(decklink_);
        const std::wstring                                                              filter_;
-       
+
        core::video_format_desc                                                 in_format_desc_;
        core::video_format_desc                                                 out_format_desc_;
-       std::vector<int>                                                                audio_cadence_          = out_format_desc_.audio_cadence;
+       std::vector<int>                                                                audio_cadence_          = in_format_desc_.audio_cadence;
        boost::circular_buffer<size_t>                                  sync_buffer_            { audio_cadence_.size() };
        spl::shared_ptr<core::frame_factory>                    frame_factory_;
-       ffmpeg::frame_muxer                                                             muxer_                          { in_format_desc_.fps, frame_factory_, out_format_desc_, filter_ };
-                       
+       core::audio_channel_layout                                              channel_layout_;
+       ffmpeg::frame_muxer                                                             muxer_                          {
+                                                                                                                                                       in_format_desc_.framerate,
+                                                                                                                                                       { create_input_pad(in_format_desc_, channel_layout_.num_channels) },
+                                                                                                                                                       frame_factory_,
+                                                                                                                                                       out_format_desc_,
+                                                                                                                                                       channel_layout_,
+                                                                                                                                                       filter_,
+                                                                                                                                                       ffmpeg::filter::is_deinterlacing(filter_)
+                                                                                                                                               };
+
        core::constraints                                                               constraints_            { in_format_desc_.width, in_format_desc_.height };
 
        tbb::concurrent_bounded_queue<core::draw_frame> frame_buffer_;
+       core::draw_frame                                                                last_frame_                     = core::draw_frame::empty();
 
-       std::exception_ptr                                                              exception_;             
+       std::exception_ptr                                                              exception_;
 
 public:
        decklink_producer(
-                       const core::video_format_desc& in_format_desc, 
-                       int device_index, 
-                       const spl::shared_ptr<core::frame_factory>& frame_factory, 
-                       const core::video_format_desc& out_format_desc, 
+                       const core::video_format_desc& in_format_desc,
+                       int device_index,
+                       const spl::shared_ptr<core::frame_factory>& frame_factory,
+                       const core::video_format_desc& out_format_desc,
+                       const core::audio_channel_layout& channel_layout,
                        const std::wstring& filter)
                : device_index_(device_index)
                , filter_(filter)
                , in_format_desc_(in_format_desc)
                , out_format_desc_(out_format_desc)
                , frame_factory_(frame_factory)
-       {       
-               frame_buffer_.set_capacity(2);
-               
-               graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   
+               , channel_layout_(get_adjusted_channel_layout(channel_layout))
+       {
+               frame_buffer_.set_capacity(4);
+
+               graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
                graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
                graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));
                graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
                graph_->set_color("output-buffer", diagnostics::color(0.0f, 1.0f, 0.0f));
                graph_->set_text(print());
                diagnostics::register_graph(graph_);
-               
-               auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault);
-               
+
+               bool will_attempt_dma;
+               auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault, will_attempt_dma);
+
                // NOTE: bmdFormat8BitARGB is currently not supported by any decklink card. (2011-05-08)
-               if(FAILED(input_->EnableVideoInput(display_mode, bmdFormat8BitYUV, 0))) 
-                       CASPAR_THROW_EXCEPTION(caspar_exception() 
+               if(FAILED(input_->EnableVideoInput(display_mode, bmdFormat8BitYUV, 0)))
+                       CASPAR_THROW_EXCEPTION(caspar_exception()
                                                                        << msg_info(print() + L" Could not enable video input.")
                                                                        << boost::errinfo_api_function("EnableVideoInput"));
 
-               if(FAILED(input_->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType32bitInteger, static_cast<int>(in_format_desc.audio_channels)))) 
-                       CASPAR_THROW_EXCEPTION(caspar_exception() 
+               if(FAILED(input_->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType32bitInteger, static_cast<int>(channel_layout_.num_channels))))
+                       CASPAR_THROW_EXCEPTION(caspar_exception()
                                                                        << msg_info(print() + L" Could not enable audio input.")
                                                                        << boost::errinfo_api_function("EnableAudioInput"));
-                       
+
                if (FAILED(input_->SetCallback(this)) != S_OK)
-                       CASPAR_THROW_EXCEPTION(caspar_exception() 
+                       CASPAR_THROW_EXCEPTION(caspar_exception()
                                                                        << msg_info(print() + L" Failed to set input callback.")
                                                                        << boost::errinfo_api_function("SetCallback"));
-                       
+
                if(FAILED(input_->StartStreams()))
-                       CASPAR_THROW_EXCEPTION(caspar_exception() 
+                       CASPAR_THROW_EXCEPTION(caspar_exception()
                                                                        << msg_info(print() + L" Failed to start input stream.")
                                                                        << boost::errinfo_api_function("StartStreams"));
 
+               // Wait for first frame until returning or give up after 2 seconds.
+               caspar::timer timeout_timer;
+
+               while (frame_buffer_.size() < 1 && timeout_timer.elapsed() < 2.0)
+                       boost::this_thread::sleep_for(boost::chrono::milliseconds(1));
+
                CASPAR_LOG(info) << print() << L" Initialized";
        }
 
        ~decklink_producer()
        {
-               if(input_ != nullptr) 
+               if(input_ != nullptr)
                {
                        input_->StopStreams();
                        input_->DisableVideoInput();
@@ -165,14 +214,15 @@ public:
        virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}
        virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}
        virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}
-               
+
        virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents /*notificationEvents*/, IDeckLinkDisplayMode* newDisplayMode, BMDDetectedVideoInputFormatFlags /*detectedSignalFlags*/)
        {
                return S_OK;
        }
 
        virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame* video, IDeckLinkAudioInputPacket* audio)
-       {       
+       {
+               ensure_gpf_handler_installed_for_thread("decklink-VideoInputFrameArrived");
                if(!video)
                        return S_OK;
 
@@ -182,23 +232,24 @@ public:
                        tick_timer_.restart();
 
                        caspar::timer frame_timer;
-                       
+
                        // Video
 
                        void* video_bytes = nullptr;
                        if(FAILED(video->GetBytes(&video_bytes)) || !video_bytes)
                                return S_OK;
-                       
+
                        auto video_frame = ffmpeg::create_frame();
-                                               
+
                        video_frame->data[0]                    = reinterpret_cast<uint8_t*>(video_bytes);
-                       video_frame->linesize[0]                = video->GetRowBytes();                 
+                       video_frame->linesize[0]                = video->GetRowBytes();
                        video_frame->format                             = PIX_FMT_UYVY422;
                        video_frame->width                              = video->GetWidth();
                        video_frame->height                             = video->GetHeight();
                        video_frame->interlaced_frame   = in_format_desc_.field_mode != core::field_mode::progressive;
                        video_frame->top_field_first    = in_format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
-                               
+                       video_frame->key_frame                  = 1;
+
                        monitor_subject_
                                        << core::monitor::message("/file/name")                                 % model_name_
                                        << core::monitor::message("/file/path")                                 % device_index_
@@ -212,55 +263,57 @@ public:
 
                        // Audio
 
-                       void* audio_bytes = nullptr;
-                       if(FAILED(audio->GetBytes(&audio_bytes)) || !audio_bytes)
-                               return S_OK;
-                       
-                       auto audio_frame = ffmpeg::create_frame();
-
-                       audio_frame->data[0]            = reinterpret_cast<uint8_t*>(audio_bytes);
-                       audio_frame->linesize[0]        = audio->GetSampleFrameCount()*out_format_desc_.audio_channels*sizeof(int32_t);
-                       audio_frame->nb_samples         = audio->GetSampleFrameCount();
-                       audio_frame->format                     = AV_SAMPLE_FMT_S32;
-                                               
+                       std::shared_ptr<core::mutable_audio_buffer>     audio_buffer;
+                       void*                                                                           audio_bytes             = nullptr;
+
+                       // It is assumed that audio is always equal or ahead of video.
+                       if (audio && SUCCEEDED(audio->GetBytes(&audio_bytes)) && audio_bytes)
+                       {
+                               auto sample_frame_count = audio->GetSampleFrameCount();
+                               auto audio_data = reinterpret_cast<int32_t*>(audio_bytes);
+
+                               audio_buffer = std::make_shared<core::mutable_audio_buffer>(
+                                       audio_data,
+                                       audio_data + sample_frame_count * channel_layout_.num_channels);
+                       }
+                       else
+                               audio_buffer = std::make_shared<core::mutable_audio_buffer>(audio_cadence_.front() * channel_layout_.num_channels, 0);
+
                        // Note: Uses 1 step rotated cadence for 1001 modes (1602, 1602, 1601, 1602, 1601)
                        // This cadence fills the audio mixer most optimally.
 
-                       sync_buffer_.push_back(audio->GetSampleFrameCount());           
+                       sync_buffer_.push_back(audio_buffer->size() / channel_layout_.num_channels);
                        if(!boost::range::equal(sync_buffer_, audio_cadence_))
                        {
-                               CASPAR_LOG(trace) << print() << L" Syncing audio.";
+                               CASPAR_LOG(trace) << print() << L" Syncing audio. Expected cadence: " << to_string(audio_cadence_) << L" Got cadence: " << to_string(sync_buffer_);
                                return S_OK;
                        }
                        boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
-                       
+
                        // PUSH
 
-                       muxer_.push_video(video_frame); 
-                       muxer_.push_audio(audio_frame);                                                                                 
-                       
+                       muxer_.push({ audio_buffer });
+                       muxer_.push(static_cast<std::shared_ptr<AVFrame>>(video_frame));
+
                        // POLL
 
-                       auto frame = core::draw_frame::late();
-                       if(!muxer_.empty())
+                       for (auto frame = muxer_.poll(); frame != core::draw_frame::empty(); frame = muxer_.poll())
                        {
-                               frame = std::move(muxer_.front());
-                               muxer_.pop();
-
-                               if(!frame_buffer_.try_push(frame))
+                               if (!frame_buffer_.try_push(frame))
                                {
                                        auto dummy = core::draw_frame::empty();
                                        frame_buffer_.try_pop(dummy);
+
                                        frame_buffer_.try_push(frame);
-                                               
-                                       graph_->set_tag("dropped-frame");
+
+                                       graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
                                }
                        }
-                       
-                       graph_->set_value("frame-time", frame_timer.elapsed()*out_format_desc_.fps*0.5);        
+
+                       graph_->set_value("frame-time", frame_timer.elapsed()*out_format_desc_.fps*0.5);
                        monitor_subject_ << core::monitor::message("/profiler/time") % frame_timer.elapsed() % out_format_desc_.fps;
 
-                       graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));      
+                       graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));
                        monitor_subject_ << core::monitor::message("/buffer") % frame_buffer_.size() % frame_buffer_.capacity();
                }
                catch(...)
@@ -271,53 +324,68 @@ public:
 
                return S_OK;
        }
-       
+
        core::draw_frame get_frame()
        {
                if(exception_ != nullptr)
                        std::rethrow_exception(exception_);
-               
-               core::draw_frame frame = core::draw_frame::late();
-               if(!frame_buffer_.try_pop(frame))
-                       graph_->set_tag("late-frame");
-               graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));      
+
+               core::draw_frame frame = last_frame_;
+
+               if (!frame_buffer_.try_pop(frame))
+                       graph_->set_tag(diagnostics::tag_severity::WARNING, "late-frame");
+               else
+                       last_frame_ = frame;
+
+               graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size()) / static_cast<float>(frame_buffer_.capacity()));
+
                return frame;
        }
-       
+
        std::wstring print() const
        {
                return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" + in_format_desc_.name + L"]";
        }
 
+       boost::rational<int> get_out_framerate() const
+       {
+               return muxer_.out_framerate();
+       }
+
        core::monitor::subject& monitor_output()
        {
                return monitor_subject_;
        }
 };
-       
+
 class decklink_producer_proxy : public core::frame_producer_base
-{              
+{
        std::unique_ptr<decklink_producer>      producer_;
        const uint32_t                                          length_;
        executor                                                        executor_;
 public:
-       explicit decklink_producer_proxy(const core::video_format_desc& in_format_desc,
-                                                                        const spl::shared_ptr<core::frame_factory>& frame_factory, 
-                                                                        const core::video_format_desc& out_format_desc, 
-                                                                        int device_index,
-                                                                        const std::wstring& filter_str, uint32_t length)
+       explicit decklink_producer_proxy(
+                       const core::video_format_desc& in_format_desc,
+                       const spl::shared_ptr<core::frame_factory>& frame_factory,
+                       const core::video_format_desc& out_format_desc,
+                       const core::audio_channel_layout& channel_layout,
+                       int device_index,
+                       const std::wstring& filter_str,
+                       uint32_t length)
                : executor_(L"decklink_producer[" + boost::lexical_cast<std::wstring>(device_index) + L"]")
                , length_(length)
        {
+               auto ctx = core::diagnostics::call_context::for_thread();
                executor_.invoke([=]
                {
+                       core::diagnostics::call_context::for_thread() = ctx;
                        com_initialize();
-                       producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, filter_str));
+                       producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, channel_layout, filter_str));
                });
        }
 
        ~decklink_producer_proxy()
-       {               
+       {
                executor_.invoke([=]
                {
                        producer_.reset();
@@ -329,11 +397,11 @@ public:
        {
                return producer_->monitor_output();
        }
-       
+
        // frame_producer
-                               
+
        core::draw_frame receive_impl() override
-       {               
+       {
                return producer_->get_frame();
        }
 
@@ -341,17 +409,17 @@ public:
        {
                return producer_->pixel_constraints();
        }
-                       
+
        uint32_t nb_frames() const override
        {
                return length_;
        }
-       
+
        std::wstring print() const override
        {
                return producer_->print();
        }
-       
+
        std::wstring name() const override
        {
                return L"decklink";
@@ -363,22 +431,29 @@ public:
                info.add(L"type", L"decklink");
                return info;
        }
+
+       boost::rational<int> get_out_framerate() const
+       {
+               return producer_->get_out_framerate();
+       }
 };
 
 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
 {
        sink.short_description(L"Allows video sources to be input from BlackMagic Design cards.");
-       sink.syntax(L"DECKLINK [device:int],DEVICE [device:int] {FILTER [filter:string]} {LENGTH [length:int]} {FORMAT [format:string]}");
+       sink.syntax(L"DECKLINK [device:int],DEVICE [device:int] {FILTER [filter:string]} {LENGTH [length:int]} {FORMAT [format:string]} {CHANNEL_LAYOUT [channel_layout:string]}");
        sink.para()->text(L"Allows video sources to be input from BlackMagic Design cards. Parameters:");
        sink.definitions()
                ->item(L"device", L"The decklink device to stream the input from. See the Blackmagic control panel for the order of devices in your system.")
                ->item(L"filter", L"If specified, sets an FFmpeg video filter to use.")
                ->item(L"length", L"Optionally specify a limit on how many frames to produce.")
-               ->item(L"format", L"Specifies what video format to expect on the incoming SDI/HDMI signal. If not specified the video format of the channel is assumed.");
+               ->item(L"format", L"Specifies what video format to expect on the incoming SDI/HDMI signal. If not specified the video format of the channel is assumed.")
+               ->item(L"channel_layout", L"Specifies what audio channel layout to expect on the incoming SDI/HDMI signal. If not specified, stereo is assumed.");
        sink.para()->text(L"Examples:");
        sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2", L"Play using decklink device 2 expecting the video signal to have the same video format as the channel.");
        sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 FORMAT PAL FILTER yadif=1:-1", L"Play using decklink device 2 expecting the video signal to be in PAL and deinterlace it.");
        sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 LENGTH 1000", L"Play using decklink device 2 but only produce 1000 frames.");
+       sink.example(L">> PLAY 1-10 DECKLINK DEVICE 2 CHANNEL_LAYOUT smpte", L"Play using decklink device 2 and expect smpte surround sound.");
 }
 
 spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer_dependencies& dependencies, const std::vector<std::wstring>& params)
@@ -389,15 +464,48 @@ spl::shared_ptr<core::frame_producer> create_producer(const core::frame_producer
        auto device_index       = get_param(L"DEVICE", params, -1);
        if(device_index == -1)
                device_index = boost::lexical_cast<int>(params.at(1));
-       
-       auto filter_str         = get_param(L"FILTER", params);         
-       auto length                     = get_param(L"LENGTH", params, std::numeric_limits<uint32_t>::max());   
+
+       auto filter_str         = get_param(L"FILTER", params);
+       auto length                     = get_param(L"LENGTH", params, std::numeric_limits<uint32_t>::max());
        auto in_format_desc = core::video_format_desc(get_param(L"FORMAT", params, L"INVALID"));
-               
+
        if(in_format_desc.format == core::video_format::invalid)
                in_format_desc = dependencies.format_desc;
-                       
-       return create_destroy_proxy(spl::make_shared<decklink_producer_proxy>(in_format_desc, dependencies.frame_factory, dependencies.format_desc, device_index, filter_str, length));
-}
 
+       auto channel_layout_spec        = get_param(L"CHANNEL_LAYOUT", params);
+       auto channel_layout                     = *core::audio_channel_layout_repository::get_default()->get_layout(L"stereo");
+
+       if (!channel_layout_spec.empty())
+       {
+               auto found_layout = core::audio_channel_layout_repository::get_default()->get_layout(channel_layout_spec);
+
+               if (!found_layout)
+                       CASPAR_THROW_EXCEPTION(user_error() << msg_info(L"Channel layout not found."));
+
+               channel_layout = *found_layout;
+       }
+
+       boost::ireplace_all(filter_str, L"DEINTERLACE_BOB",     L"YADIF=1:-1");
+       boost::ireplace_all(filter_str, L"DEINTERLACE_LQ",      L"SEPARATEFIELDS");
+       boost::ireplace_all(filter_str, L"DEINTERLACE",         L"YADIF=0:-1");
+
+       auto producer = spl::make_shared<decklink_producer_proxy>(
+                       in_format_desc,
+                       dependencies.frame_factory,
+                       dependencies.format_desc,
+                       channel_layout,
+                       device_index,
+                       filter_str,
+                       length);
+
+       auto get_source_framerate       = [=] { return producer->get_out_framerate(); };
+       auto target_framerate           = dependencies.format_desc.framerate;
+
+       return core::create_destroy_proxy(core::create_framerate_producer(
+                       producer,
+                       get_source_framerate,
+                       target_framerate,
+                       dependencies.format_desc.field_mode,
+                       dependencies.format_desc.audio_cadence));
+}
 }}