]> git.sesse.net Git - casparcg/blob - modules/bluefish/consumer/bluefish_consumer.cpp
2.0. Optimized key-only.
[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/memclr.h>\r
32 #include <common/memory/memcpy.h>\r
33 #include <common/memory/memshfl.h>\r
34 #include <common/utility/timer.h>\r
35 \r
36 #include <core/consumer/frame_consumer.h>\r
37 \r
38 #include <tbb/concurrent_queue.h>\r
39 \r
40 #include <boost/timer.hpp>\r
41 \r
42 #include <memory>\r
43 #include <array>\r
44 \r
45 namespace caspar { \r
46                         \r
47 struct bluefish_consumer : boost::noncopyable\r
48 {\r
49         safe_ptr<CBlueVelvet4>                          blue_;\r
50         const unsigned int                                      device_index_;\r
51         const core::video_format_desc           format_desc_;\r
52 \r
53         const std::wstring                                      model_name_;\r
54 \r
55         std::shared_ptr<diagnostics::graph> graph_;\r
56         boost::timer                                            frame_timer_;\r
57         boost::timer                                            tick_timer_;\r
58         boost::timer                                            sync_timer_;    \r
59                         \r
60         unsigned int                                            vid_fmt_;\r
61 \r
62         std::array<blue_dma_buffer_ptr, 4>      reserved_frames_;       \r
63         tbb::concurrent_bounded_queue<std::shared_ptr<core::read_frame>> frame_buffer_;\r
64 \r
65         int                                                                     preroll_count_;\r
66 \r
67         const bool                                                      embedded_audio_;\r
68         const bool                                                      key_only_;\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, bool key_only) \r
73                 : blue_(create_blue(device_index))\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                 , preroll_count_(0)\r
79                 , embedded_audio_(embedded_audio)\r
80                 , key_only_(key_only)\r
81                 , executor_(print())\r
82         {\r
83                 executor_.set_capacity(core::consumer_buffer_depth());\r
84 \r
85                 graph_ = diagnostics::create_graph(narrow(print()));\r
86                 graph_->add_guide("tick-time", 0.5);\r
87                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   \r
88                 graph_->add_guide("frame-time", 0.5f);  \r
89                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));\r
90                 graph_->set_color("sync-time", diagnostics::color(0.5f, 1.0f, 0.2f));\r
91                 graph_->set_color("input-buffer", diagnostics::color(1.0f, 1.0f, 0.0f));\r
92                         \r
93                 //Setting output Video mode\r
94                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MODE, vid_fmt_))) \r
95                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set videomode."));\r
96 \r
97                 //Select Update Mode for output\r
98                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_UPDATE_TYPE, UPD_FMT_FRAME))) \r
99                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set update type."));\r
100         \r
101                 disable_video_output();\r
102 \r
103                 //Enable dual link output\r
104                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT, 1)))\r
105                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to enable dual link."));\r
106 \r
107                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_DUAL_LINK_OUTPUT_SIGNAL_FORMAT_TYPE, Signal_FormatType_4224)))\r
108                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set dual link format type to 4:2:2:4."));\r
109                         \r
110                 //Select output memory format\r
111                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_MEMORY_FORMAT, MEM_FMT_ARGB_PC))) \r
112                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set memory format."));\r
113                 \r
114                 //Select image orientation\r
115                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_IMAGE_ORIENTATION, ImageOrientation_Normal)))\r
116                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set image orientation to normal.");  \r
117 \r
118                 // Select data range\r
119                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_RGB_DATA_RANGE, CGR_RANGE))) \r
120                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set RGB data range to CGR.");        \r
121                 \r
122                 if(BLUE_FAIL(set_card_property(blue_, VIDEO_PREDEFINED_COLOR_MATRIX, vid_fmt_ == VID_FMT_PAL ? MATRIX_601_CGR : MATRIX_709_CGR)))\r
123                         CASPAR_LOG(warning) << print() << TEXT(" Failed to set colormatrix to ") << (vid_fmt_ == VID_FMT_PAL ? TEXT("601 CGR") : TEXT("709 CGR")) << TEXT(".");\r
124 \r
125                 if(!embedded_audio_)\r
126                 {\r
127                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, 0))) \r
128                                 CASPAR_LOG(warning) << TEXT("BLUECARD ERROR: Failed to disable embedded audio.");                       \r
129                         CASPAR_LOG(info) << print() << TEXT(" Disabled embedded-audio.");\r
130                 }\r
131                 else\r
132                 {\r
133                         if(BLUE_FAIL(set_card_property(blue_, EMBEDEDDED_AUDIO_OUTPUT, blue_emb_audio_enable | blue_emb_audio_group1_enable))) \r
134                                 CASPAR_LOG(warning) << print() << TEXT(" Failed to enable embedded audio.");                    \r
135                         CASPAR_LOG(info) << print() << TEXT(" Enabled embedded-audio.");\r
136                 }\r
137                 \r
138                 if (blue_->has_output_key()) \r
139                 {\r
140                         int dummy = TRUE; int v4444 = FALSE; int invert = FALSE; int white = FALSE;\r
141                         blue_->set_output_key(dummy, v4444, invert, white);\r
142                 }\r
143 \r
144                 if(blue_->GetHDCardType(device_index_) != CRD_HD_INVALID) \r
145                         blue_->Set_DownConverterSignalType(vid_fmt_ == VID_FMT_PAL ? SD_SDI : HD_SDI);  \r
146         \r
147                 unsigned long engine_mode = VIDEO_ENGINE_FRAMESTORE;\r
148                 if(BLUE_FAIL(blue_->set_video_engine(engine_mode)))\r
149                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to set video engine."));\r
150 \r
151                 enable_video_output();\r
152                                                 \r
153                 int n = 0;\r
154                 std::generate(reserved_frames_.begin(), reserved_frames_.end(), [&]\r
155                 {\r
156                         return std::make_shared<blue_dma_buffer>(format_desc_.size, n++);\r
157                 });\r
158                                                                 \r
159                 CASPAR_LOG(info) << print() << L" Successfully Initialized.";\r
160         }\r
161 \r
162         ~bluefish_consumer()\r
163         {\r
164                 try\r
165                 {\r
166                         executor_.invoke([&]\r
167                         {\r
168                                 disable_video_output();\r
169                                 blue_->device_detach();         \r
170                         });\r
171                 }\r
172                 catch(...)\r
173                 {\r
174                         CASPAR_LOG_CURRENT_EXCEPTION();\r
175                 }\r
176                 \r
177                 CASPAR_LOG(info) << print() << L" Shutting down.";      \r
178         }\r
179         \r
180         const core::video_format_desc& get_video_format_desc() const\r
181         {\r
182                 return format_desc_;\r
183         }\r
184 \r
185         void enable_video_output()\r
186         {\r
187                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 0)))\r
188                         CASPAR_LOG(error) << print() << TEXT(" Failed to disable video output.");       \r
189         }\r
190 \r
191         void disable_video_output()\r
192         {\r
193                 if(!BLUE_PASS(set_card_property(blue_, VIDEO_BLACKGENERATOR, 1)))\r
194                         CASPAR_LOG(error)<< print() << TEXT(" Failed to disable video output.");                \r
195         }\r
196         \r
197         void send(const safe_ptr<core::read_frame>& frame)\r
198         {       \r
199                 if(preroll_count_ < executor_.capacity())\r
200                 {\r
201                         while(preroll_count_++ < executor_.capacity())\r
202                                 schedule_next_video(make_safe<core::read_frame>());\r
203                 }\r
204                 \r
205                 schedule_next_video(frame);                     \r
206         }\r
207         \r
208         void schedule_next_video(const safe_ptr<core::read_frame>& frame)\r
209         {\r
210                 static std::vector<int16_t> silence(MAX_HANC_BUFFER_SIZE, 0);\r
211                 \r
212                 executor_.begin_invoke([=]\r
213                 {\r
214                         try\r
215                         {\r
216                                 const size_t audio_samples       = format_desc_.audio_samples_per_frame;\r
217                                 const size_t audio_nchannels = format_desc_.audio_channels;\r
218 \r
219                                 frame_timer_.restart();\r
220                                 \r
221                                 // Copy to local buffers\r
222 \r
223                                 if(!frame->image_data().empty())\r
224                                 {\r
225                                         if(key_only_)                                           \r
226                                                 fast_memshfl(reserved_frames_.front()->image_data(), frame->image_data().begin(), frame->image_data().size(), 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);\r
227                                         else\r
228                                                 fast_memcpy(reserved_frames_.front()->image_data(), frame->image_data().begin(), frame->image_data().size());\r
229                                 }\r
230                                 else\r
231                                         fast_memclr(reserved_frames_.front()->image_data(), reserved_frames_.front()->image_size());\r
232                                                                 \r
233                                 // Sync\r
234 \r
235                                 sync_timer_.restart();\r
236                                 unsigned long n_field = 0;\r
237                                 blue_->wait_output_video_synch(UPD_FMT_FRAME, n_field);\r
238                                 graph_->update_value("sync-time", static_cast<float>(sync_timer_.elapsed()*format_desc_.fps*0.5));\r
239 \r
240                                 // Send and display\r
241 \r
242                                 if(embedded_audio_)\r
243                                 {               \r
244                                         auto frame_audio_data = frame->audio_data().empty() ? silence.data() : const_cast<int16_t*>(frame->audio_data().begin());\r
245 \r
246                                         encode_hanc(reinterpret_cast<BLUE_UINT32*>(reserved_frames_.front()->hanc_data()), frame_audio_data, audio_samples, audio_nchannels);\r
247                                                                 \r
248                                         blue_->system_buffer_write_async(const_cast<uint8_t*>(reserved_frames_.front()->image_data()), \r
249                                                                                                         reserved_frames_.front()->image_size(), \r
250                                                                                                         nullptr, \r
251                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
252 \r
253                                         blue_->system_buffer_write_async(reserved_frames_.front()->hanc_data(),\r
254                                                                                                         reserved_frames_.front()->hanc_size(), \r
255                                                                                                         nullptr,                 \r
256                                                                                                         BlueImage_HANC_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_HANC));\r
257 \r
258                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image_HANC(reserved_frames_.front()->id()))))\r
259                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
260                                 }\r
261                                 else\r
262                                 {\r
263                                         blue_->system_buffer_write_async(const_cast<uint8_t*>(reserved_frames_.front()->image_data()),\r
264                                                                                                         reserved_frames_.front()->image_size(), \r
265                                                                                                         nullptr,                 \r
266                                                                                                         BlueImage_DMABuffer(reserved_frames_.front()->id(), BLUE_DATA_IMAGE));\r
267                         \r
268                                         if(BLUE_FAIL(blue_->render_buffer_update(BlueBuffer_Image(reserved_frames_.front()->id()))))\r
269                                                 CASPAR_LOG(warning) << print() << TEXT(" render_buffer_update failed.");\r
270                                 }\r
271 \r
272                                 std::rotate(reserved_frames_.begin(), reserved_frames_.begin() + 1, reserved_frames_.end());\r
273                                 \r
274                                 graph_->update_value("frame-time", static_cast<float>(frame_timer_.elapsed()*format_desc_.fps*0.5));\r
275 \r
276                                 graph_->update_value("tick-time", static_cast<float>(tick_timer_.elapsed()*format_desc_.fps*0.5));\r
277                                 tick_timer_.restart();\r
278                         }\r
279                         catch(...)\r
280                         {\r
281                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
282                         }\r
283                         graph_->set_value("input-buffer", static_cast<double>(executor_.size())/static_cast<double>(executor_.capacity()));\r
284                 });\r
285                 graph_->set_value("input-buffer", static_cast<double>(executor_.size())/static_cast<double>(executor_.capacity()));\r
286         }\r
287 \r
288         void encode_hanc(BLUE_UINT32* hanc_data, void* audio_data, size_t audio_samples, size_t audio_nchannels)\r
289         {       \r
290                 const auto sample_type = AUDIO_CHANNEL_16BIT | AUDIO_CHANNEL_LITTLEENDIAN;\r
291                 const auto emb_audio_flag = blue_emb_audio_enable | blue_emb_audio_group1_enable;\r
292                 \r
293                 hanc_stream_info_struct hanc_stream_info;\r
294                 memset(&hanc_stream_info, 0, sizeof(hanc_stream_info));\r
295                 \r
296                 hanc_stream_info.AudioDBNArray[0] = -1;\r
297                 hanc_stream_info.AudioDBNArray[1] = -1;\r
298                 hanc_stream_info.AudioDBNArray[2] = -1;\r
299                 hanc_stream_info.AudioDBNArray[3] = -1;\r
300                 hanc_stream_info.hanc_data_ptr    = hanc_data;\r
301                 hanc_stream_info.video_mode               = vid_fmt_;           \r
302                 \r
303                 if (!is_epoch_card(*blue_))\r
304                         encode_hanc_frame(&hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);  \r
305                 else\r
306                         encode_hanc_frame_ex(blue_->has_video_cardtype(), &hanc_stream_info, audio_data, audio_nchannels, audio_samples, sample_type, emb_audio_flag);\r
307         }\r
308         \r
309         std::wstring print() const\r
310         {\r
311                 return model_name_ + L" [" + boost::lexical_cast<std::wstring>(device_index_) + L"|" +  format_desc_.name + L"]";\r
312         }\r
313 };\r
314 \r
315 struct bluefish_consumer_proxy : public core::frame_consumer\r
316 {\r
317         std::unique_ptr<bluefish_consumer>      consumer_;\r
318         const size_t                                            device_index_;\r
319         const bool                                                      embedded_audio_;\r
320         const bool                                                      key_only_;\r
321         core::video_format_desc                         format_desc_;\r
322         size_t                                                          fail_count_;\r
323 public:\r
324 \r
325         bluefish_consumer_proxy(size_t device_index, bool embedded_audio, bool key_only)\r
326                 : device_index_(device_index)\r
327                 , embedded_audio_(embedded_audio)\r
328                 , key_only_(key_only)\r
329                 , fail_count_(0)\r
330         {\r
331         }\r
332         \r
333         virtual void initialize(const core::video_format_desc& format_desc)\r
334         {\r
335                 format_desc_ = format_desc;\r
336                 consumer_.reset(new bluefish_consumer(format_desc, device_index_, embedded_audio_, key_only_));\r
337         }\r
338         \r
339         virtual bool send(const safe_ptr<core::read_frame>& frame)\r
340         {\r
341                 if(!consumer_)\r
342                         consumer_.reset(new bluefish_consumer(format_desc_, device_index_, embedded_audio_, key_only_));\r
343 \r
344                 try\r
345                 {\r
346                         consumer_->send(frame);\r
347                         fail_count_ = 0;\r
348                 }\r
349                 catch(...)\r
350                 {\r
351                         consumer_.reset();\r
352 \r
353                         if(fail_count_++ > 3)\r
354                                 return false;  // Outside didn't handle exception properly, just give up.\r
355 \r
356                         throw;\r
357                 }\r
358 \r
359                 return true;\r
360         }\r
361 \r
362         virtual const core::video_format_desc& get_video_format_desc() const\r
363         {\r
364                 return consumer_->get_video_format_desc();\r
365         }\r
366         \r
367         virtual std::wstring print() const\r
368         {\r
369                 if(consumer_)\r
370                         consumer_->print();\r
371 \r
372                 return L"bluefish [" + boost::lexical_cast<std::wstring>(device_index_) + L"]";\r
373         }\r
374 };      \r
375 \r
376 safe_ptr<core::frame_consumer> create_bluefish_consumer(const std::vector<std::wstring>& params)\r
377 {\r
378         if(params.size() < 1 || params[0] != L"BLUEFISH")\r
379                 return core::frame_consumer::empty();\r
380                 \r
381         const auto device_index = params.size() > 1 ? lexical_cast_or_default<int>(params[1], 1) : 1;\r
382 \r
383         const auto embedded_audio = std::find(params.begin(), params.end(), L"EMBEDDED_AUDIO") != params.end();\r
384         const auto key_only               = std::find(params.begin(), params.end(), L"KEY_ONLY")           != params.end();\r
385 \r
386         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
387 }\r
388 \r
389 safe_ptr<core::frame_consumer> create_bluefish_consumer(const boost::property_tree::ptree& ptree) \r
390 {       \r
391         const auto device_index         = ptree.get("device",             1);\r
392         const auto embedded_audio       = ptree.get("embedded-audio", false);\r
393         const auto key_only                     = ptree.get("key-only",           false);\r
394 \r
395         return make_safe<bluefish_consumer_proxy>(device_index, embedded_audio, key_only);\r
396 }\r
397 \r
398 }