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