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

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