]> git.sesse.net Git - casparcg/blob - modules/bluefish/consumer/bluefish_consumer.cpp
2.0.0.2: - bluefish: Refactored and improved error handling. Fixed a bug where server...
[casparcg] / modules / bluefish / consumer / bluefish_consumer.cpp
1 /*\r
2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
3 *\r
4 *  This file is part of CasparCG.\r
5 *\r
6 *    CasparCG is free software: you can redistribute it and/or modify\r
7 *    it under the terms of the GNU General Public License as published by\r
8 *    the Free Software Foundation, either version 3 of the License, or\r
9 *    (at your option) any later version.\r
10 *\r
11 *    CasparCG is distributed in the hope that it will be useful,\r
12 *    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
13 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
14 *    GNU General Public License for more details.\r
15 \r
16 *    You should have received a copy of the GNU General Public License\r
17 *    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
18 *\r
19 */\r
20  \r
21 #include "../StdAfx.h"\r
22 \r
23 #include "bluefish_consumer.h"\r
24 #include "../util/blue_velvet.h"\r
25 #include "../util/memory.h"\r
26 \r
27 #include <core/mixer/read_frame.h>\r
28 \r
29 #include <common/concurrency/executor.h>\r
30 #include <common/diagnostics/graph.h>\r
31 #include <common/memory/memcpy.h>\r
32 #include <common/memory/memclr.h>\r
33 #include <common/utility/timer.h>\r
34 \r
35 #include <tbb/concurrent_queue.h>\r
36 \r
37 #include <boost/timer.hpp>\r
38 \r
39 #include <memory>\r
40 #include <array>\r
41 \r
42 namespace caspar { \r
43                         \r
44 struct bluefish_consumer : boost::noncopyable\r
45 {\r
46         safe_ptr<CBlueVelvet4>                          blue_;\r
47         const unsigned int                                      device_index_;\r
48         const core::video_format_desc           format_desc_;\r
49 \r
50         const std::wstring                                      model_name_;\r
51 \r
52         std::shared_ptr<diagnostics::graph> graph_;\r
53         boost::timer                                            frame_timer_;\r
54         boost::timer                                            tick_timer_;\r
55         boost::timer                                            sync_timer_;    \r
56                 \r
57         const EVideoMode                                        vid_fmt_; \r
58         const EMemoryFormat                                     mem_fmt_;\r
59         const EUpdateMethod                                     upd_fmt_;\r
60         const EResoFormat                                       res_fmt_; \r
61         EEngineMode                                                     engine_mode_;\r
62         \r
63         std::array<blue_dma_buffer_ptr, 4> reserved_frames_;    \r
64         tbb::concurrent_bounded_queue<std::shared_ptr<const core::read_frame>> frame_buffer_;\r
65 \r
66         int preroll_count_;\r
67 \r
68         const bool embedded_audio_;\r
69         \r
70         executor executor_;\r
71 public:\r
72         bluefish_consumer(const core::video_format_desc& format_desc, unsigned int device_index, bool embedded_audio) \r
73                 : blue_(create_blue())\r
74                 , device_index_(device_index)\r
75                 , format_desc_(format_desc) \r
76                 , model_name_(get_card_desc(*blue_))\r
77                 , vid_fmt_(get_video_mode(*blue_, format_desc)) \r
78                 , mem_fmt_(MEM_FMT_ARGB_PC)\r
79                 , upd_fmt_(UPD_FMT_FRAME)\r
80                 , res_fmt_(RES_FMT_NORMAL) \r
81                 , engine_mode_(VIDEO_ENGINE_FRAMESTORE) \r
82                 , preroll_count_(0)\r
83                 , embedded_audio_(embedded_audio)\r
84                 , executor_(print())\r
85         {\r
86                 if(BLUE_FAIL(blue_->device_attach(device_index, FALSE))) \r
87                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info("Failed to attach device."));\r
88 \r
89                 executor_.set_capacity(CONSUMER_BUFFER_DEPTH);\r
90 \r
91                 graph_ = diagnostics::create_graph(narrow(print()));\r
92                 graph_->add_guide("tick-time", 0.5);\r
93                 graph_->set_color("tick-time", diagnostics::color(0.1f, 0.7f, 0.8f));\r
94                 graph_->add_guide("frame-time", 0.5f);  \r
95                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));\r
96                 graph_->set_color("sync-time", diagnostics::color(0.5f, 1.0f, 0.2f));\r
97                 graph_->set_color("input-buffer", diagnostics::color(1.0f, 1.0f, 0.0f));\r
98                         \r
99                 //Setting output Video mode\r
100                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MODE, vid_fmt_))) \r
101                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set videomode."));\r
102 \r
103                 //Select Update Mode for output\r
104                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_UPDATE_TYPE, upd_fmt_))) \r
105                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set update type."));\r
106         \r
107                 disable_video_output();\r
108 \r
109                 //Enable dual link output\r
110                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT, 1)))\r
111                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to enable dual link."));\r
112 \r
113                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT_SIGNAL_FORMAT_TYPE, Signal_FormatType_4224)))\r
114                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set dual link format type to 4:2:2:4."));\r
115                         \r
116                 //Select output memory format\r
117                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MEMORY_FORMAT, mem_fmt_))) \r
118                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set memory format."));\r
119                 \r
120                 //Select image orientation\r
121                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_IMAGE_ORIENTATION, ImageOrientation_Normal)))\r
122                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set image orientation to normal.");  \r
123 \r
124                 // Select data range\r
125                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_RGB_DATA_RANGE, CGR_RANGE))) \r
126                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set RGB data range to CGR.");        \r
127                 \r
128                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_PREDEFINED_COLOR_MATRIX, vid_fmt_ == VID_FMT_PAL ? MATRIX_601_CGR : MATRIX_709_CGR)))\r
129                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set colormatrix to ") << (vid_fmt_ == VID_FMT_PAL ? TEXT("601 CGR") : TEXT("709 CGR")) << TEXT(".");\r
130 \r
131                 if(!embedded_audio_)\r
132                 {\r
133                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, 0))) \r
134                                 CASPAR_LOG(warning) << TEXT("BLUECARD ERROR: Failed to disable embedded audio.");                       \r
135                         CASPAR_LOG(info) << print() << TEXT(" Disabled embedded-audio.");\r
136                 }\r
137                 else\r
138                 {\r
139                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, blue_emb_audio_enable | blue_emb_audio_group1_enable))) \r
140                                 CASPAR_LOG(warning) << print() << TEXT(" Failed to enable embedded audio.");                    \r
141                         CASPAR_LOG(info) << print() << TEXT(" Enabled embedded-audio.");\r
142                 }\r
143                 \r
144                 if (blue_->has_output_key()) \r
145                 {\r
146                         int dummy = TRUE; int v4444 = FALSE; int invert = FALSE; int white = FALSE;\r
147                         blue_->set_output_key(dummy, v4444, invert, white);\r
148                 }\r
149 \r
150                 if(blue_->GetHDCardType(device_index_) != CRD_HD_INVALID) \r
151                         blue_->Set_DownConverterSignalType(vid_fmt_ == VID_FMT_PAL ? SD_SDI : HD_SDI);  \r
152         \r
153                 if(BLUE_FAIL(blue_->set_video_engine(*reinterpret_cast<unsigned long*>(&engine_mode_))))\r
154                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set video engine."));\r
155 \r
156                 enable_video_output();\r
157                                                 \r
158                 int n = 0;\r
159                 std::generate(reserved_frames_.begin(), reserved_frames_.end(), [&]\r
160                 {\r
161                         return std::make_shared<blue_dma_buffer>(format_desc_.size, n++);\r
162                 });\r
163                                                                 \r
164                 CASPAR_LOG(info) << print() << L" Successfully Initialized.";\r
165         }\r
166 \r
167         ~bluefish_consumer()\r
168         {\r
169                 executor_.invoke([&]\r
170                 {\r
171                         disable_video_output();\r
172                         blue_->device_detach();         \r
173                 });\r
174                 \r
175                 CASPAR_LOG(info) << print() << L" Shutting down.";      \r
176         }\r
177         \r
178         const core::video_format_desc& get_video_format_desc() const\r
179         {\r
180                 return format_desc_;\r
181         }\r
182 \r
183         void enable_video_output()\r
184         {\r
185                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 0)))\r
186                         CASPAR_LOG(error) << print() << TEXT(" Failed to disable video output.");       \r
187         }\r
188 \r
189         void disable_video_output()\r
190         {\r
191                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 1)))\r
192                         CASPAR_LOG(error)<< print() << TEXT(" Failed to disable video output.");                \r
193         }\r
194         \r
195         void send(const safe_ptr<const core::read_frame>& frame)\r
196         {       \r
197                 if(preroll_count_ < executor_.capacity())\r
198                 {\r
199                         while(preroll_count_++ < executor_.capacity())\r
200                                 schedule_next_video(make_safe<core::read_frame>());\r
201                 }\r
202                 \r
203                 schedule_next_video(frame);                     \r
204         }\r
205         \r
206         void schedule_next_video(const safe_ptr<const core::read_frame>& frame)\r
207         {\r
208                 static std::vector<int16_t> silence(MAX_HANC_BUFFER_SIZE, 0);\r
209                 \r
210                 executor_.begin_invoke([=]\r
211                 {\r
212                         try\r
213                         {\r
214                                 const size_t audio_samples       = format_desc_.audio_samples_per_frame;\r
215                                 const size_t audio_nchannels = format_desc_.audio_channels;\r
216 \r
217                                 frame_timer_.restart();\r
218                                 \r
219                                 // Copy to local buffers\r
220 \r
221                                 if(!frame->image_data().empty())\r
222                                         fast_memcpy(reserved_frames_.front()->image_data(), frame->image_data().begin(), frame->image_data().size());\r
223                                 else\r
224                                         fast_memclr(reserved_frames_.front()->image_data(), reserved_frames_.front()->image_size());\r
225 \r
226                                 // Sync\r
227 \r
228                                 sync_timer_.restart();\r
229                                 unsigned long n_field = 0;\r
230                                 blue_->wait_output_video_synch(UPD_FMT_FRAME, n_field);\r
231                                 graph_->update_value("sync-time", static_cast<float>(sync_timer_.elapsed()*format_desc_.fps*0.5));\r
232 \r
233                                 // Send and display\r
234 \r
235                                 if(embedded_audio_)\r
236                                 {               \r
237                                         auto frame_audio_data = frame->audio_data().empty() ? silence.data() : const_cast<int16_t*>(frame->audio_data().begin());\r
238 \r
239                                         encode_hanc(reinterpret_cast<BLUE_UINT32*>(reserved_frames_.front()->hanc_data()), frame_audio_data, audio_samples, audio_nchannels);\r
240                                                                 \r
241                                         blue_->system_buffer_write_async(const_cast<uint8_t*>(reserved_frames_.front()->image_data()), \r
242                                                                                                         reserved_frames_.front()->image_size(), \r
243                                                                                                         nullptr, \r
244                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
245 \r
246                                         blue_->system_buffer_write_async(reserved_frames_.front()->hanc_data(),\r
247                                                                                                         reserved_frames_.front()->hanc_size(), \r
248                                                                                                         nullptr,                 \r
249                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_HANC));\r
250 \r
251                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image_HANC(reserved_frames_.front()->id()))))\r
252                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
253                                 }\r
254                                 else\r
255                                 {\r
256                                         blue_->system_buffer_write_async(const_cast<uint8_t*>(reserved_frames_.front()->image_data()),\r
257                                                                                                         reserved_frames_.front()->image_size(), \r
258                                                                                                         nullptr,                 \r
259                                                                                                         BlueImage_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
260                         \r
261                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image(reserved_frames_.front()->id()))))\r
262                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
263                                 }\r
264 \r
265                                 std::rotate(reserved_frames_.begin(), reserved_frames_.begin() + 1, reserved_frames_.end());\r
266                                 \r
267                                 graph_->update_value("frame-time", static_cast<float>(frame_timer_.elapsed()*format_desc_.fps*0.5));\r
268 \r
269                                 graph_->update_value("tick-time", static_cast<float>(tick_timer_.elapsed()*format_desc_.fps*0.5));\r
270                                 tick_timer_.restart();\r
271                         }\r
272                         catch(...)\r
273                         {\r
274                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
275                         }\r
276                         graph_->set_value("input-buffer", static_cast<double>(executor_.size())/static_cast<double>(executor_.capacity()));\r
277                 });\r
278                 graph_->set_value("input-buffer", static_cast<double>(executor_.size())/static_cast<double>(executor_.capacity()));\r
279         }\r
280 \r
281         void encode_hanc(BLUE_UINT32* hanc_data, void* audio_data, size_t audio_samples, size_t audio_nchannels)\r
282         {       \r
283                 static const auto sample_type = AUDIO_CHANNEL_16BIT | AUDIO_CHANNEL_LITTLEENDIAN;\r
284                 static const auto emb_audio_flag = blue_emb_audio_enable | blue_emb_audio_group1_enable;\r
285                 \r
286                 hanc_stream_info_struct hanc_stream_info;\r
287                 memset(&hanc_stream_info, 0, sizeof(hanc_stream_info));\r
288                 \r
289                 hanc_stream_info.AudioDBNArray[0] = -1;\r
290                 hanc_stream_info.AudioDBNArray[1] = -1;\r
291                 hanc_stream_info.AudioDBNArray[2] = -1;\r
292                 hanc_stream_info.AudioDBNArray[3] = -1;\r
293                 hanc_stream_info.hanc_data_ptr    = hanc_data;\r
294                 hanc_stream_info.video_mode               = vid_fmt_;           \r
295                 \r
296                 if (!is_epoch_card(*blue_))\r
297                         encode_hanc_frame(&hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);  \r
298                 else\r
299                         encode_hanc_frame_ex(blue_->has_video_cardtype(), &hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);\r
300         }\r
301         \r
302         std::wstring print() const\r
303         {\r
304                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" +  format_desc_.name + L"]";\r
305         }\r
306 };\r
307 \r
308 struct bluefish_consumer_proxy : public core::frame_consumer\r
309 {\r
310         std::unique_ptr<bluefish_consumer>      consumer_;\r
311         const size_t                                            device_index_;\r
312         const bool                                                      embedded_audio_;\r
313         const bool                                                      key_only_;\r
314 public:\r
315 \r
316         bluefish_consumer_proxy(size_t device_index, bool embedded_audio, bool key_only)\r
317                 : device_index_(device_index)\r
318                 , embedded_audio_(embedded_audio)\r
319                 , key_only_(key_only){}\r
320         \r
321         virtual void initialize(const core::video_format_desc& format_desc)\r
322         {\r
323                 consumer_.reset(new bluefish_consumer(format_desc, device_index_, embedded_audio_));\r
324         }\r
325         \r
326         virtual void send(const safe_ptr<const core::read_frame>& frame)\r
327         {\r
328                 consumer_->send(frame);\r
329         }\r
330 \r
331         virtual const core::video_format_desc& get_video_format_desc() const\r
332         {\r
333                 return consumer_->get_video_format_desc();\r
334         }\r
335         \r
336         virtual std::wstring print() const\r
337         {\r
338                 return consumer_->print();\r
339         }\r
340 \r
341         virtual bool key_only() const\r
342         {\r
343                 return key_only_;\r
344         }\r
345 };      \r
346 \r
347 safe_ptr<core::frame_consumer> create_bluefish_consumer(const std::vector<std::wstring>& params)\r
348 {\r
349         if(params.size() < 1 || params[0] != L"BLUEFISH")\r
350                 return core::frame_consumer::empty();\r
351                 \r
352         const auto device_index = params.size() > 1 ? lexical_cast_or_default<int>(params[1], 1) : 1;\r
353 \r
354         const auto embedded_audio = std::find(params.begin(), params.end(), L"EMBEDDED_AUDIO") != params.end();\r
355         const auto key_only               = std::find(params.begin(), params.end(), L"KEY_ONLY")           != params.end();\r
356 \r
357         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
358 }\r
359 \r
360 safe_ptr<core::frame_consumer> create_bluefish_consumer(const boost::property_tree::ptree& ptree) \r
361 {       \r
362         const auto device_index         = ptree.get("device",             1);\r
363         const auto embedded_audio       = ptree.get("embedded-audio", false);\r
364         const auto key_only                     = ptree.get("key-only",           false);\r
365 \r
366         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
367 }\r
368 \r
369 }