git.sesse.net Git - casparcg/blob - modules/bluefish/consumer/bluefish_consumer.cpp

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