]> git.sesse.net Git - casparcg/blob - modules/decklink/producer/decklink_producer.cpp
Refactored to use range based for instead of BOOST_FOREACH
[casparcg] / modules / decklink / producer / decklink_producer.cpp
1 /*
2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
3 *
4 * This file is part of CasparCG (www.casparcg.com).
5 *
6 * CasparCG is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
10 *
11 * CasparCG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
18 *
19 * Author: Robert Nagy, ronag89@gmail.com
20 */
21
22 #include "../stdafx.h"
23
24 #include "decklink_producer.h"
25
26 #include "../interop/DeckLinkAPI_h.h"
27 #include "../util/util.h"
28
29 #include "../../ffmpeg/producer/filter/filter.h"
30 #include "../../ffmpeg/producer/util/util.h"
31 #include "../../ffmpeg/producer/muxer/frame_muxer.h"
32 #include "../../ffmpeg/producer/muxer/display_mode.h"
33
34 #include <common/executor.h>
35 #include <common/diagnostics/graph.h>
36 #include <common/except.h>
37 #include <common/log.h>
38 #include <common/param.h>
39
40 #include <core/frame/frame.h>
41 #include <core/frame/draw_frame.h>
42 #include <core/frame/frame_transform.h>
43 #include <core/frame/frame_factory.h>
44 #include <core/monitor/monitor.h>
45 #include <core/mixer/audio/audio_mixer.h>
46
47 #include <tbb/concurrent_queue.h>
48
49 #include <boost/algorithm/string.hpp>
50 #include <boost/property_tree/ptree.hpp>
51 #include <boost/timer.hpp>
52
53 #if defined(_MSC_VER)
54 #pragma warning (push)
55 #pragma warning (disable : 4244)
56 #endif
57 extern "C" 
58 {
59         #define __STDC_CONSTANT_MACROS
60         #define __STDC_LIMIT_MACROS
61         #include <libavcodec/avcodec.h>
62 }
63 #if defined(_MSC_VER)
64 #pragma warning (pop)
65 #endif
66
67 #pragma warning(push)
68 #pragma warning(disable : 4996)
69
70         #include <atlbase.h>
71
72         #include <atlcom.h>
73         #include <atlhost.h>
74
75 #pragma warning(push)
76
77 #include <functional>
78
79 namespace caspar { namespace decklink {
80                 
81 class decklink_producer : boost::noncopyable, public IDeckLinkInputCallback
82 {       
83         core::monitor::subject                                                  monitor_subject_;
84         spl::shared_ptr<diagnostics::graph>                             graph_;
85         boost::timer                                                                    tick_timer_;
86
87         CComPtr<IDeckLink>                                                              decklink_;
88         CComQIPtr<IDeckLinkInput>                                               input_;
89         CComQIPtr<IDeckLinkAttributes >                                 attributes_;
90         
91         const std::wstring                                                              model_name_;
92         const int                                                                               device_index_;
93         const std::wstring                                                              filter_;
94         
95         std::vector<int>                                                                audio_cadence_;
96         boost::circular_buffer<size_t>                                  sync_buffer_;
97         ffmpeg::frame_muxer                                                             muxer_;
98                         
99         spl::shared_ptr<core::frame_factory>                    frame_factory_;
100         core::video_format_desc                                                 in_format_desc_;
101         core::video_format_desc                                                 out_format_desc_;
102         core::constraints                                                               constraints_;
103
104         tbb::concurrent_bounded_queue<core::draw_frame> frame_buffer_;
105
106         std::exception_ptr                                                              exception_;             
107
108 public:
109         decklink_producer(const core::video_format_desc& in_format_desc, 
110                                           int device_index, 
111                                           const spl::shared_ptr<core::frame_factory>& frame_factory, 
112                                           const core::video_format_desc& out_format_desc, 
113                                           const std::wstring& filter)
114                 : decklink_(get_device(device_index))
115                 , input_(decklink_)
116                 , attributes_(decklink_)
117                 , model_name_(get_model_name(decklink_))
118                 , device_index_(device_index)
119                 , filter_(filter)
120                 , in_format_desc_(in_format_desc)
121                 , out_format_desc_(out_format_desc)
122                 , constraints_(in_format_desc.width, in_format_desc.height)
123                 , muxer_(in_format_desc.fps, frame_factory, out_format_desc, filter)
124                 , audio_cadence_(out_format_desc.audio_cadence)
125                 , sync_buffer_(out_format_desc.audio_cadence.size())
126                 , frame_factory_(frame_factory)
127         {       
128                 frame_buffer_.set_capacity(2);
129                 
130                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   
131                 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.3f));
132                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));
133                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
134                 graph_->set_color("output-buffer", diagnostics::color(0.0f, 1.0f, 0.0f));
135                 graph_->set_text(print());
136                 diagnostics::register_graph(graph_);
137                 
138                 auto display_mode = get_display_mode(input_, in_format_desc.format, bmdFormat8BitYUV, bmdVideoInputFlagDefault);
139                 
140                 // NOTE: bmdFormat8BitARGB is currently not supported by any decklink card. (2011-05-08)
141                 if(FAILED(input_->EnableVideoInput(display_mode, bmdFormat8BitYUV, 0))) 
142                         CASPAR_THROW_EXCEPTION(caspar_exception() 
143                                                                         << msg_info(print() + L" Could not enable video input.")
144                                                                         << boost::errinfo_api_function("EnableVideoInput"));
145
146                 if(FAILED(input_->EnableAudioInput(bmdAudioSampleRate48kHz, bmdAudioSampleType32bitInteger, static_cast<int>(in_format_desc.audio_channels)))) 
147                         CASPAR_THROW_EXCEPTION(caspar_exception() 
148                                                                         << msg_info(print() + L" Could not enable audio input.")
149                                                                         << boost::errinfo_api_function("EnableAudioInput"));
150                         
151                 if (FAILED(input_->SetCallback(this)) != S_OK)
152                         CASPAR_THROW_EXCEPTION(caspar_exception() 
153                                                                         << msg_info(print() + L" Failed to set input callback.")
154                                                                         << boost::errinfo_api_function("SetCallback"));
155                         
156                 if(FAILED(input_->StartStreams()))
157                         CASPAR_THROW_EXCEPTION(caspar_exception() 
158                                                                         << msg_info(print() + L" Failed to start input stream.")
159                                                                         << boost::errinfo_api_function("StartStreams"));
160
161                 CASPAR_LOG(info) << print() << L" Initialized";
162         }
163
164         ~decklink_producer()
165         {
166                 if(input_ != nullptr) 
167                 {
168                         input_->StopStreams();
169                         input_->DisableVideoInput();
170                 }
171         }
172
173         core::constraints& pixel_constraints()
174         {
175                 return constraints_;
176         }
177
178         virtual HRESULT STDMETHODCALLTYPE       QueryInterface (REFIID, LPVOID*)        {return E_NOINTERFACE;}
179         virtual ULONG STDMETHODCALLTYPE         AddRef ()                                                       {return 1;}
180         virtual ULONG STDMETHODCALLTYPE         Release ()                                                      {return 1;}
181                 
182         virtual HRESULT STDMETHODCALLTYPE VideoInputFormatChanged(BMDVideoInputFormatChangedEvents /*notificationEvents*/, IDeckLinkDisplayMode* newDisplayMode, BMDDetectedVideoInputFormatFlags /*detectedSignalFlags*/)
183         {
184                 return S_OK;
185         }
186
187         virtual HRESULT STDMETHODCALLTYPE VideoInputFrameArrived(IDeckLinkVideoInputFrame* video, IDeckLinkAudioInputPacket* audio)
188         {       
189                 if(!video)
190                         return S_OK;
191
192                 try
193                 {
194                         graph_->set_value("tick-time", tick_timer_.elapsed()*out_format_desc_.fps*0.5);
195                         tick_timer_.restart();
196
197                         boost::timer frame_timer;       
198                         
199                         // Video
200
201                         void* video_bytes = nullptr;
202                         if(FAILED(video->GetBytes(&video_bytes)) || !video_bytes)
203                                 return S_OK;
204                         
205                         auto video_frame = ffmpeg::create_frame();
206                                                 
207                         video_frame->data[0]                    = reinterpret_cast<uint8_t*>(video_bytes);
208                         video_frame->linesize[0]                = video->GetRowBytes();                 
209                         video_frame->format                             = PIX_FMT_UYVY422;
210                         video_frame->width                              = video->GetWidth();
211                         video_frame->height                             = video->GetHeight();
212                         video_frame->interlaced_frame   = in_format_desc_.field_mode != core::field_mode::progressive;
213                         video_frame->top_field_first    = in_format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
214                                 
215                         monitor_subject_
216                                         << core::monitor::message("/file/name")                                 % model_name_
217                                         << core::monitor::message("/file/path")                                 % device_index_
218                                         << core::monitor::message("/file/video/width")                  % video->GetWidth()
219                                         << core::monitor::message("/file/video/height")                 % video->GetHeight()
220                                         << core::monitor::message("/file/video/field")                  % u8(!video_frame->interlaced_frame ? "progressive" : (video_frame->top_field_first ? "upper" : "lower"))
221                                         << core::monitor::message("/file/audio/sample-rate")    % 48000
222                                         << core::monitor::message("/file/audio/channels")               % 2
223                                         << core::monitor::message("/file/audio/format")                 % u8(av_get_sample_fmt_name(AV_SAMPLE_FMT_S32))
224                                         << core::monitor::message("/file/fps")                                  % in_format_desc_.fps;
225
226                         // Audio
227
228                         void* audio_bytes = nullptr;
229                         if(FAILED(audio->GetBytes(&audio_bytes)) || !audio_bytes)
230                                 return S_OK;
231                         
232                         auto audio_frame = ffmpeg::create_frame();
233
234                         audio_frame->data[0]            = reinterpret_cast<uint8_t*>(audio_bytes);
235                         audio_frame->linesize[0]        = audio->GetSampleFrameCount()*out_format_desc_.audio_channels*sizeof(int32_t);
236                         audio_frame->nb_samples         = audio->GetSampleFrameCount();
237                         audio_frame->format                     = AV_SAMPLE_FMT_S32;
238                                                 
239                         // Note: Uses 1 step rotated cadence for 1001 modes (1602, 1602, 1601, 1602, 1601)
240                         // This cadence fills the audio mixer most optimally.
241
242                         sync_buffer_.push_back(audio->GetSampleFrameCount());           
243                         if(!boost::range::equal(sync_buffer_, audio_cadence_))
244                         {
245                                 CASPAR_LOG(trace) << print() << L" Syncing audio.";
246                                 return S_OK;
247                         }
248                         boost::range::rotate(audio_cadence_, std::begin(audio_cadence_)+1);
249                         
250                         // PUSH
251
252                         muxer_.push_video(video_frame); 
253                         muxer_.push_audio(audio_frame);                                                                                 
254                         
255                         // POLL
256
257                         auto frame = core::draw_frame::late();
258                         if(!muxer_.empty())
259                         {
260                                 frame = std::move(muxer_.front());
261                                 muxer_.pop();
262
263                                 if(!frame_buffer_.try_push(frame))
264                                 {
265                                         auto dummy = core::draw_frame::empty();
266                                         frame_buffer_.try_pop(dummy);
267                                         frame_buffer_.try_push(frame);
268                                                 
269                                         graph_->set_tag("dropped-frame");
270                                 }
271                         }
272                         
273                         graph_->set_value("frame-time", frame_timer.elapsed()*out_format_desc_.fps*0.5);        
274                         monitor_subject_ << core::monitor::message("/profiler/time") % frame_timer.elapsed() % out_format_desc_.fps;
275
276                         graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));      
277                         monitor_subject_ << core::monitor::message("/buffer") % frame_buffer_.size() % frame_buffer_.capacity();
278                 }
279                 catch(...)
280                 {
281                         exception_ = std::current_exception();
282                         return E_FAIL;
283                 }
284
285                 return S_OK;
286         }
287         
288         core::draw_frame get_frame()
289         {
290                 if(exception_ != nullptr)
291                         std::rethrow_exception(exception_);
292                 
293                 core::draw_frame frame = core::draw_frame::late();
294                 if(!frame_buffer_.try_pop(frame))
295                         graph_->set_tag("late-frame");
296                 graph_->set_value("output-buffer", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));      
297                 return frame;
298         }
299         
300         std::wstring print() const
301         {
302                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" + in_format_desc_.name + L"]";
303         }
304
305         core::monitor::subject& monitor_output()
306         {
307                 return monitor_subject_;
308         }
309 };
310         
311 class decklink_producer_proxy : public core::frame_producer_base
312 {               
313         std::unique_ptr<decklink_producer>      producer_;
314         const uint32_t                                          length_;
315         executor                                                        executor_;
316 public:
317         explicit decklink_producer_proxy(const core::video_format_desc& in_format_desc,
318                                                                          const spl::shared_ptr<core::frame_factory>& frame_factory, 
319                                                                          const core::video_format_desc& out_format_desc, 
320                                                                          int device_index,
321                                                                          const std::wstring& filter_str, uint32_t length)
322                 : executor_(L"decklink_producer[" + boost::lexical_cast<std::wstring>(device_index) + L"]")
323                 , length_(length)
324         {
325                 executor_.invoke([=]
326                 {
327                         CoInitialize(nullptr);
328                         producer_.reset(new decklink_producer(in_format_desc, device_index, frame_factory, out_format_desc, filter_str));
329                 });
330         }
331
332         ~decklink_producer_proxy()
333         {               
334                 executor_.invoke([=]
335                 {
336                         producer_.reset();
337                         CoUninitialize();
338                 });
339         }
340
341         core::monitor::subject& monitor_output()
342         {
343                 return producer_->monitor_output();
344         }
345         
346         // frame_producer
347                                 
348         core::draw_frame receive_impl() override
349         {               
350                 return producer_->get_frame();
351         }
352
353         core::constraints& pixel_constraints() override
354         {
355                 return producer_->pixel_constraints();
356         }
357                         
358         uint32_t nb_frames() const override
359         {
360                 return length_;
361         }
362         
363         std::wstring print() const override
364         {
365                 return producer_->print();
366         }
367         
368         std::wstring name() const override
369         {
370                 return L"decklink";
371         }
372
373         boost::property_tree::wptree info() const override
374         {
375                 boost::property_tree::wptree info;
376                 info.add(L"type", L"decklink");
377                 return info;
378         }
379 };
380
381 spl::shared_ptr<core::frame_producer> create_producer(const spl::shared_ptr<core::frame_factory>& frame_factory, const core::video_format_desc& out_format_desc, const std::vector<std::wstring>& params)
382 {
383         if(params.empty() || !boost::iequals(params[0], "decklink"))
384                 return core::frame_producer::empty();
385
386         auto device_index       = get_param(L"DEVICE", params, -1);
387         if(device_index == -1)
388                 device_index = boost::lexical_cast<int>(params.at(1));
389         
390         auto filter_str         = get_param(L"FILTER", params);         
391         auto length                     = get_param(L"LENGTH", params, std::numeric_limits<uint32_t>::max());   
392         auto in_format_desc = core::video_format_desc(get_param(L"FORMAT", params, L"INVALID"));
393                 
394         if(in_format_desc.format == core::video_format::invalid)
395                 in_format_desc = out_format_desc;
396                         
397         return create_destroy_proxy(spl::make_shared<decklink_producer_proxy>(in_format_desc, frame_factory, out_format_desc, device_index, filter_str, length));
398 }
399
400 }}