]> git.sesse.net Git - casparcg/blob - modules/bluefish/consumer/bluefish_consumer.cpp
2.0.0.2: SET MODE: Does not clear producers.
[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/util.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/utility/timer.h>\r
33 \r
34 #include <tbb/concurrent_queue.h>\r
35 \r
36 #include <boost/timer.hpp>\r
37 \r
38 #include <BlueVelvet4.h>\r
39 #include <BlueHancUtils.h>\r
40 \r
41 #include <memory>\r
42 #include <array>\r
43 \r
44 namespace caspar { \r
45         \r
46 CBlueVelvet4* (*BlueVelvetFactory4)() = nullptr;\r
47 const char*     (*BlueVelvetVersion)() = nullptr;\r
48 BLUE_UINT32 (*encode_hanc_frame)(struct hanc_stream_info_struct * hanc_stream_ptr, void * audio_pcm_ptr,BLUE_UINT32 no_audio_ch,BLUE_UINT32 no_audio_samples,BLUE_UINT32 nTypeOfSample,BLUE_UINT32 emb_audio_flag) = nullptr;\r
49 BLUE_UINT32 (*encode_hanc_frame_ex)(BLUE_UINT32 card_type, struct hanc_stream_info_struct * hanc_stream_ptr, void * audio_pcm_ptr, BLUE_UINT32 no_audio_ch,     BLUE_UINT32 no_audio_samples, BLUE_UINT32 nTypeOfSample, BLUE_UINT32 emb_audio_flag) = nullptr;\r
50 \r
51 void blue_velvet_initialize()\r
52 {\r
53 #ifdef _DEBUG\r
54         auto module = LoadLibrary(L"BlueVelvet3_d.dll");\r
55 #else\r
56         auto module = LoadLibrary(L"BlueVelvet3.dll");\r
57 #endif\r
58         if(!module)\r
59                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("Could not find BlueVelvet3.dll"));\r
60         static std::shared_ptr<void> lib(module, FreeLibrary);\r
61         BlueVelvetFactory4 = reinterpret_cast<decltype(BlueVelvetFactory4)>(GetProcAddress(module, "BlueVelvetFactory4"));\r
62         BlueVelvetVersion = reinterpret_cast<decltype(BlueVelvetVersion)>(GetProcAddress(module, "BlueVelvetVersion"));\r
63 }\r
64 \r
65 void blue_hanc_initialize()\r
66 {\r
67 #ifdef _DEBUG\r
68         auto module = LoadLibrary(L"BlueHancUtils_d.dll");\r
69 #else\r
70         auto module = LoadLibrary(L"BlueHancUtils.dll");\r
71 #endif\r
72         if(!module)\r
73                 BOOST_THROW_EXCEPTION(file_not_found() << msg_info("Could not find BlueHancUtils.dll"));\r
74         static std::shared_ptr<void> lib(module, FreeLibrary);\r
75         encode_hanc_frame = reinterpret_cast<decltype(encode_hanc_frame)>(GetProcAddress(module, "encode_hanc_frame"));\r
76         encode_hanc_frame_ex = reinterpret_cast<decltype(encode_hanc_frame_ex)>(GetProcAddress(module, "encode_hanc_frame_ex"));\r
77 }\r
78 \r
79 void blue_initialize()\r
80 {\r
81         blue_velvet_initialize();\r
82         blue_hanc_initialize();\r
83 }\r
84                 \r
85 struct bluefish_consumer : boost::noncopyable\r
86 {\r
87         std::wstring            model_name_;\r
88         const unsigned int      device_index_;\r
89 \r
90         std::shared_ptr<diagnostics::graph> graph_;\r
91         boost::timer frame_timer_;\r
92         boost::timer tick_timer_;\r
93         boost::timer sync_timer_;\r
94 \r
95         boost::unique_future<void> active_;\r
96                         \r
97         std::shared_ptr<CBlueVelvet4> blue_;\r
98         \r
99         const core::video_format_desc   format_desc_;\r
100                 \r
101         const unsigned long     mem_fmt_;\r
102         const unsigned long     upd_fmt_;\r
103         const unsigned long     res_fmt_; \r
104         unsigned long engine_mode_;\r
105         EVideoMode      vid_fmt_; \r
106         \r
107         std::array<blue_dma_buffer_ptr, 3> reserved_frames_;    \r
108 \r
109         const bool embedded_audio_;\r
110 \r
111         executor executor_;\r
112 public:\r
113         bluefish_consumer(const core::video_format_desc& format_desc, unsigned int device_index, bool embedded_audio) \r
114                 : model_name_(L"BLUEFISH")\r
115                 , device_index_(device_index) \r
116                 , format_desc_(format_desc)\r
117                 , mem_fmt_(MEM_FMT_ARGB_PC)\r
118                 , upd_fmt_(UPD_FMT_FRAME)\r
119                 , res_fmt_(RES_FMT_NORMAL) \r
120                 , engine_mode_(VIDEO_ENGINE_FRAMESTORE)         \r
121                 , vid_fmt_(VID_FMT_INVALID) \r
122                 , embedded_audio_(embedded_audio)\r
123                 , executor_(print())\r
124         {\r
125                 if(!BlueVelvetFactory4 || (embedded_audio_ && (!encode_hanc_frame || !encode_hanc_frame)))\r
126                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info("Bluefish drivers not found."));\r
127                 \r
128                 blue_.reset(BlueVelvetFactory4());\r
129 \r
130                 if(BLUE_FAIL(blue_->device_attach(device_index_, FALSE))) \r
131                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to attach device."));\r
132         \r
133                 int videoCardType = blue_->has_video_cardtype();\r
134                 model_name_ = get_card_desc(videoCardType);\r
135 \r
136                 graph_ = diagnostics::create_graph(narrow(print()));\r
137                 graph_->add_guide("tick-time", 0.5);\r
138                 graph_->set_color("tick-time", diagnostics::color(0.1f, 0.7f, 0.8f));\r
139                 graph_->add_guide("frame-time", 0.5f);  \r
140                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));\r
141                 graph_->add_guide("frame-time", 0.5f);  \r
142                 graph_->set_color("sync-time", diagnostics::color(0.5f, 1.0f, 0.2f));\r
143                         \r
144                 //void* pBlueDevice = blue_attach_to_device(1);\r
145                 //EBlueConnectorPropertySetting video_routing[1];\r
146                 //auto channel = BLUE_VIDEO_OUTPUT_CHANNEL_A;\r
147                 //video_routing[0].channel = channel;   \r
148                 //video_routing[0].propType = BLUE_CONNECTOR_PROP_SINGLE_LINK;\r
149                 //video_routing[0].connector = channel == BLUE_VIDEO_OUTPUT_CHANNEL_A ? BLUE_CONNECTOR_SDI_OUTPUT_A : BLUE_CONNECTOR_SDI_OUTPUT_B;\r
150                 //blue_set_connector_property(pBlueDevice, 1, video_routing);\r
151                 //blue_detach_from_device(&pBlueDevice);\r
152                 \r
153                 auto desiredVideoFormat = vid_fmt_from_video_format(format_desc_.format);\r
154                 int videoModeCount = blue_->count_video_mode();\r
155                 for(int videoModeIndex = 1; videoModeIndex <= videoModeCount; ++videoModeIndex) \r
156                 {\r
157                         EVideoMode videoMode = blue_->enum_video_mode(videoModeIndex);\r
158                         if(videoMode == desiredVideoFormat) \r
159                                 vid_fmt_ = videoMode;                   \r
160                 }\r
161                 if(vid_fmt_ == VID_FMT_INVALID)\r
162                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set videomode."));\r
163                 \r
164                 // Set default video output channel\r
165                 //if(BLUE_FAIL(set_card_property(blue_, DEFAULT_VIDEO_OUTPUT_CHANNEL, channel)))\r
166                 //      CASPAR_LOG(error) << TEXT("BLUECARD ERROR: Failed to set default channel. (device ") << device_index_ << TEXT(")");\r
167 \r
168                 //Setting output Video mode\r
169                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MODE, vid_fmt_))) \r
170                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set videomode."));\r
171 \r
172                 //Select Update Mode for output\r
173                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_UPDATE_TYPE, upd_fmt_))) \r
174                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set update type."));\r
175         \r
176                 disable_video_output();\r
177 \r
178                 //Enable dual link output\r
179                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT, 1)))\r
180                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to enable dual link."));\r
181 \r
182                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT_SIGNAL_FORMAT_TYPE, Signal_FormatType_4224)))\r
183                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set dual link format type to 4:2:2:4."));\r
184                         \r
185                 //Select output memory format\r
186                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MEMORY_FORMAT, mem_fmt_))) \r
187                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set memory format."));\r
188                 \r
189                 //Select image orientation\r
190                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_IMAGE_ORIENTATION, ImageOrientation_Normal)))\r
191                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set image orientation to normal.");  \r
192 \r
193                 // Select data range\r
194                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_RGB_DATA_RANGE, CGR_RANGE))) \r
195                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set RGB data range to CGR.");        \r
196                 \r
197                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_PREDEFINED_COLOR_MATRIX, vid_fmt_ == VID_FMT_PAL ? MATRIX_601_CGR : MATRIX_709_CGR)))\r
198                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set colormatrix to ") << (vid_fmt_ == VID_FMT_PAL ? TEXT("601 CGR") : TEXT("709 CGR")) << TEXT(".");\r
199 \r
200                 if(!embedded_audio_)\r
201                 {\r
202                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, 0))) \r
203                                 CASPAR_LOG(warning) << TEXT("BLUECARD ERROR: Failed to disable embedded audio.");                       \r
204                         CASPAR_LOG(info) << print() << TEXT(" Disabled embedded-audio.");\r
205                 }\r
206                 else\r
207                 {\r
208                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, blue_emb_audio_enable | blue_emb_audio_group1_enable))) \r
209                                 CASPAR_LOG(warning) << print() << TEXT(" Failed to enable embedded audio.");                    \r
210                         CASPAR_LOG(info) << print() << TEXT(" Enabled embedded-audio.");\r
211                 }\r
212                 \r
213                 if (blue_->has_output_key()) \r
214                 {\r
215                         int dummy = TRUE; int v4444 = FALSE; int invert = FALSE; int white = FALSE;\r
216                         blue_->set_output_key(dummy, v4444, invert, white);\r
217                 }\r
218 \r
219                 if(blue_->GetHDCardType(device_index_) != CRD_HD_INVALID) \r
220                         blue_->Set_DownConverterSignalType(vid_fmt_ == VID_FMT_PAL ? SD_SDI : HD_SDI);  \r
221         \r
222                 if(BLUE_FAIL(blue_->set_video_engine(engine_mode_)))\r
223                         BOOST_THROW_EXCEPTION(bluefish_exception() << msg_info(narrow(print()) + " Failed to set video engine."));\r
224 \r
225                 enable_video_output();\r
226                                                 \r
227                 for(size_t n = 0; n < reserved_frames_.size(); ++n)\r
228                         reserved_frames_[n] = std::make_shared<blue_dma_buffer>(format_desc_.size, n);          \r
229 \r
230                 active_ = executor_.begin_invoke([]{});\r
231                                 \r
232                 CASPAR_LOG(info) << print() << L" Successfully Initialized.";\r
233         }\r
234 \r
235         ~bluefish_consumer()\r
236         {\r
237                 executor_.invoke([&]\r
238                 {\r
239                         disable_video_output();\r
240 \r
241                         if(blue_)\r
242                                 blue_->device_detach();         \r
243                 });\r
244                 \r
245                 CASPAR_LOG(info) << print() << L" Shutting down.";      \r
246         }\r
247         \r
248         const core::video_format_desc& get_video_format_desc() const\r
249         {\r
250                 return format_desc_;\r
251         }\r
252 \r
253         void enable_video_output()\r
254         {\r
255                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 0)))\r
256                         CASPAR_LOG(error) << print() << TEXT(" Failed to disable video output.");       \r
257         }\r
258 \r
259         void disable_video_output()\r
260         {\r
261                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 1)))\r
262                         CASPAR_LOG(error)<< print() << TEXT(" Failed to disable video output.");                \r
263         }\r
264 \r
265         void send(const safe_ptr<const core::read_frame>& frame)\r
266         {                       \r
267                 static std::vector<short> silence(MAX_HANC_BUFFER_SIZE, 0);\r
268                                 \r
269                 active_.get();\r
270                 active_ = executor_.begin_invoke([=]\r
271                 {\r
272                         try\r
273                         {\r
274                                 frame_timer_.restart();\r
275 \r
276                                 const size_t audio_samples = static_cast<size_t>(48000.0 / format_desc_.fps);\r
277                                 const size_t audio_nchannels = 2;\r
278                                 \r
279                                 fast_memcpy(reserved_frames_.front()->image_data(), frame->image_data().begin(), frame->image_data().size());\r
280                                 \r
281                                 sync_timer_.restart();\r
282                                 unsigned long n_field = 0;\r
283                                 blue_->wait_output_video_synch(UPD_FMT_FRAME, n_field);\r
284                                 graph_->update_value("sync-time", static_cast<float>(sync_timer_.elapsed()*format_desc_.fps*0.5));\r
285 \r
286                                 if(embedded_audio_)\r
287                                 {               \r
288                                         auto frame_audio_data = frame->audio_data().empty() ? silence.data() : const_cast<short*>(frame->audio_data().begin());\r
289 \r
290                                         encode_hanc(reinterpret_cast<BLUE_UINT32*>(reserved_frames_.front()->hanc_data()), frame_audio_data, audio_samples, audio_nchannels);\r
291                                                                 \r
292                                         blue_->system_buffer_write_async(const_cast<unsigned char*>(reserved_frames_.front()->image_data()), \r
293                                                                                                         reserved_frames_.front()->image_size(), \r
294                                                                                                         nullptr, \r
295                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
296 \r
297                                         blue_->system_buffer_write_async(reserved_frames_.front()->hanc_data(),\r
298                                                                                                         reserved_frames_.front()->hanc_size(), \r
299                                                                                                         nullptr,                 \r
300                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_HANC));\r
301 \r
302                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image_HANC(reserved_frames_.front()->id()))))\r
303                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
304                                 }\r
305                                 else\r
306                                 {\r
307                                         blue_->system_buffer_write_async(const_cast<unsigned char*>(reserved_frames_.front()->image_data()),\r
308                                                                                                         reserved_frames_.front()->image_size(), \r
309                                                                                                         nullptr,                 \r
310                                                                                                         BlueImage_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
311                         \r
312                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image(reserved_frames_.front()->id()))))\r
313                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
314                                 }\r
315 \r
316                                 std::rotate(reserved_frames_.begin(), reserved_frames_.begin() + 1, reserved_frames_.end());\r
317                                 \r
318                                 graph_->update_value("frame-time", static_cast<float>(frame_timer_.elapsed()*format_desc_.fps*0.5));\r
319 \r
320                                 graph_->update_value("tick-time", static_cast<float>(tick_timer_.elapsed()*format_desc_.fps*0.5));\r
321                                 tick_timer_.restart();\r
322                         }\r
323                         catch(...)\r
324                         {\r
325                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
326                         }\r
327                 });\r
328         }\r
329 \r
330         void encode_hanc(BLUE_UINT32* hanc_data, void* audio_data, size_t audio_samples, size_t audio_nchannels)\r
331         {       \r
332                 auto card_type = blue_->has_video_cardtype();\r
333                 auto sample_type = (AUDIO_CHANNEL_16BIT | AUDIO_CHANNEL_LITTLEENDIAN);\r
334                 \r
335                 hanc_stream_info_struct hanc_stream_info;\r
336                 memset(&hanc_stream_info, 0, sizeof(hanc_stream_info));\r
337                 \r
338                 hanc_stream_info.AudioDBNArray[0] = -1;\r
339                 hanc_stream_info.AudioDBNArray[1] = -1;\r
340                 hanc_stream_info.AudioDBNArray[2] = -1;\r
341                 hanc_stream_info.AudioDBNArray[3] = -1;\r
342                 hanc_stream_info.hanc_data_ptr = hanc_data;\r
343                 hanc_stream_info.video_mode = vid_fmt_;\r
344                 \r
345                 auto emb_audio_flag = (blue_emb_audio_enable | blue_emb_audio_group1_enable);\r
346 \r
347                 if (!is_epoch_card(card_type))\r
348                         encode_hanc_frame(&hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);  \r
349                 else\r
350                         encode_hanc_frame_ex(card_type, &hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);\r
351         }\r
352         \r
353         std::wstring print() const\r
354         {\r
355                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" +  format_desc_.name + L"]";\r
356         }\r
357 };\r
358 \r
359 struct bluefish_consumer_proxy : public core::frame_consumer\r
360 {\r
361         std::unique_ptr<bluefish_consumer> consumer_;\r
362         const size_t device_index_;\r
363         const bool embedded_audio_;\r
364         bool key_only_;\r
365 public:\r
366 \r
367         bluefish_consumer_proxy(size_t device_index, bool embedded_audio, bool key_only)\r
368                 : device_index_(device_index)\r
369                 , embedded_audio_(embedded_audio)\r
370                 , key_only_(key_only){}\r
371         \r
372         virtual void initialize(const core::video_format_desc& format_desc)\r
373         {\r
374                 consumer_.reset(new bluefish_consumer(format_desc, device_index_, embedded_audio_));\r
375         }\r
376         \r
377         virtual void send(const safe_ptr<const core::read_frame>& frame)\r
378         {\r
379                 consumer_->send(frame);\r
380         }\r
381 \r
382         virtual const core::video_format_desc& get_video_format_desc() const\r
383         {\r
384                 return consumer_->get_video_format_desc();\r
385         }\r
386         \r
387         virtual std::wstring print() const\r
388         {\r
389                 return consumer_->print();\r
390         }\r
391 \r
392         virtual bool key_only() const\r
393         {\r
394                 return key_only_;\r
395         }\r
396 };      \r
397 \r
398 std::wstring get_bluefish_version()\r
399 {\r
400         try\r
401         {\r
402                 blue_initialize();\r
403         }\r
404         catch(...)\r
405         {\r
406                 return L"Not found";\r
407         }\r
408         if(!BlueVelvetVersion)\r
409                 return L"Unknown";\r
410 \r
411         return widen(std::string(BlueVelvetVersion()));\r
412 }\r
413 \r
414 std::vector<std::wstring> get_bluefish_device_list()\r
415 {\r
416         std::vector<std::wstring> devices;\r
417 \r
418         try\r
419         {               \r
420                 if(!BlueVelvetFactory4)\r
421                         return devices;\r
422 \r
423                 std::shared_ptr<CBlueVelvet4> blue(BlueVelvetFactory4());\r
424 \r
425                 for(int n = 1; BLUE_PASS(blue->device_attach(n, FALSE)); ++n)\r
426                 {                               \r
427                         devices.push_back(std::wstring(get_card_desc(blue->has_video_cardtype())) + L" [" + boost::lexical_cast<std::wstring>(n) + L"]");\r
428                         blue->device_detach();          \r
429                 }\r
430         }\r
431         catch(...){}\r
432 \r
433         return devices;\r
434 }\r
435 \r
436 safe_ptr<core::frame_consumer> create_bluefish_consumer(const std::vector<std::wstring>& params)\r
437 {\r
438         if(params.size() < 1 || params[0] != L"BLUEFISH")\r
439                 return core::frame_consumer::empty();\r
440                 \r
441         int device_index = 1;\r
442         if(params.size() > 1)\r
443                 device_index = lexical_cast_or_default<int>(params[1], 1);\r
444 \r
445         bool embedded_audio = std::find(params.begin(), params.end(), L"EMBEDDED_AUDIO") != params.end();\r
446         bool key_only           = std::find(params.begin(), params.end(), L"KEY_ONLY")           != params.end();\r
447 \r
448         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
449 }\r
450 \r
451 safe_ptr<core::frame_consumer> create_bluefish_consumer(const boost::property_tree::ptree& ptree) \r
452 {       \r
453         auto device_index        = ptree.get("device",             0);\r
454         auto embedded_audio  = ptree.get("embedded-audio", false);\r
455         bool key_only            = ptree.get("key-only",           false);\r
456 \r
457         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
458 }\r
459 \r
460 }