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