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