git.sesse.net Git - casparcg/blob - modules/flash/producer/flash_producer.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 #if defined(_MSC_VER)\r
  24 #pragma warning (disable : 4146)\r
  25 #pragma warning (disable : 4244)\r
  26 #endif\r
  27 \r
  28 #include "flash_producer.h"\r
  29 #include "FlashAxContainer.h"\r
  30 \r
  31 #include <core/video_format.h>\r
  32 \r
  33 #include <core/producer/frame/basic_frame.h>\r
  34 #include <core/producer/frame/frame_factory.h>\r
  35 #include <core/mixer/write_frame.h>\r
  36 \r
  37 #include <common/env.h>\r
  38 #include <common/concurrency/com_context.h>\r
  39 #include <common/diagnostics/graph.h>\r
  40 #include <common/memory/memcpy.h>\r
  41 #include <common/memory/memclr.h>\r
  42 #include <common/utility/timer.h>\r
  43 \r
  44 #include <boost/filesystem.hpp>\r
  45 #include <boost/thread.hpp>\r
  46 #include <boost/timer.hpp>\r
  47 \r
  48 #include <functional>\r
  49 \r
  50 #include <tbb/spin_mutex.h>\r
  51 \r
  52 namespace caspar { namespace flash {\r
  53                 \r
  54 class bitmap\r
  55 {\r
  56 public:\r
  57         bitmap(size_t width, size_t height)\r
  58                 : bmp_data_(nullptr)\r
  59                 , hdc_(CreateCompatibleDC(0), DeleteDC)\r
  60         {       \r
  61                 BITMAPINFO info;\r
  62                 memset(&info, 0, sizeof(BITMAPINFO));\r
  63                 info.bmiHeader.biBitCount = 32;\r
  64                 info.bmiHeader.biCompression = BI_RGB;\r
  65                 info.bmiHeader.biHeight = -height;\r
  66                 info.bmiHeader.biPlanes = 1;\r
  67                 info.bmiHeader.biSize = sizeof(BITMAPINFO);\r
  68                 info.bmiHeader.biWidth = width;\r
  69 \r
  70                 bmp_.reset(CreateDIBSection(static_cast<HDC>(hdc_.get()), &info, DIB_RGB_COLORS, reinterpret_cast<void**>(&bmp_data_), 0, 0), DeleteObject);\r
  71                 SelectObject(static_cast<HDC>(hdc_.get()), bmp_.get()); \r
  72 \r
  73                 if(!bmp_data_)\r
  74                         BOOST_THROW_EXCEPTION(std::bad_alloc());\r
  75         }\r
  76 \r
  77         operator HDC() {return static_cast<HDC>(hdc_.get());}\r
  78 \r
  79         BYTE* data() { return bmp_data_;}\r
  80         const BYTE* data() const { return bmp_data_;}\r
  81 \r
  82 private:\r
  83         BYTE* bmp_data_;        \r
  84         std::shared_ptr<void> hdc_;\r
  85         std::shared_ptr<void> bmp_;\r
  86 };\r
  87 \r
  88 struct template_host\r
  89 {\r
  90         std::string  field_mode;\r
  91         std::string  filename;\r
  92         size_t           width;\r
  93         size_t           height;\r
  94 };\r
  95 \r
  96 template_host get_template_host(const core::video_format_desc& desc)\r
  97 {\r
  98         try\r
  99         {\r
 100                 std::vector<template_host> template_hosts;\r
 101                 BOOST_FOREACH(auto& xml_mapping, env::properties().get_child("configuration.producers.template-hosts"))\r
 102                 {\r
 103                         try\r
 104                         {\r
 105                                 template_host template_host;\r
 106                                 template_host.field_mode                = xml_mapping.second.get("video-mode", narrow(desc.name));\r
 107                                 template_host.filename                  = xml_mapping.second.get("filename", "cg.fth");\r
 108                                 template_host.width                             = xml_mapping.second.get("width", desc.width);\r
 109                                 template_host.height                    = xml_mapping.second.get("height", desc.height);\r
 110                                 template_hosts.push_back(template_host);\r
 111                         }\r
 112                         catch(...){}\r
 113                 }\r
 114 \r
 115                 auto template_host_it = boost::find_if(template_hosts, [&](template_host template_host){return template_host.field_mode == narrow(desc.name);});\r
 116                 if(template_host_it == template_hosts.end())\r
 117                         template_host_it = boost::find_if(template_hosts, [&](template_host template_host){return template_host.field_mode == "";});\r
 118 \r
 119                 if(template_host_it != template_hosts.end())\r
 120                         return *template_host_it;\r
 121         }\r
 122         catch(...)\r
 123         {\r
 124                 CASPAR_LOG(info) << L" Found no correct template-host configuration. Using cg.fth.";\r
 125         }\r
 126 \r
 127         template_host template_host;\r
 128         template_host.filename = "cg.fth";\r
 129         template_host.width = desc.width;\r
 130         template_host.height = desc.height;\r
 131         return template_host;\r
 132 }\r
 133 \r
 134 class flash_renderer\r
 135 {       \r
 136         const std::wstring filename_;\r
 137 \r
 138         const std::shared_ptr<core::frame_factory> frame_factory_;\r
 139         \r
 140         CComObject<caspar::flash::FlashAxContainer>* ax_;\r
 141         safe_ptr<core::basic_frame> head_;\r
 142         bitmap bmp_;\r
 143         \r
 144         safe_ptr<diagnostics::graph> graph_;\r
 145         boost::timer frame_timer_;\r
 146         boost::timer tick_timer_;\r
 147 \r
 148         high_prec_timer timer_;\r
 149 \r
 150         const size_t width_;\r
 151         const size_t height_;\r
 152         \r
 153 public:\r
 154         flash_renderer(const safe_ptr<diagnostics::graph>& graph, const std::shared_ptr<core::frame_factory>& frame_factory, const std::wstring& filename, int width, int height) \r
 155                 : graph_(graph)\r
 156                 , filename_(filename)\r
 157                 , frame_factory_(frame_factory)\r
 158                 , ax_(nullptr)\r
 159                 , head_(core::basic_frame::empty())\r
 160                 , bmp_(width, height)\r
 161                 , width_(width)\r
 162                 , height_(height)\r
 163         {               \r
 164                 graph_->add_guide("frame-time", 0.5f);\r
 165                 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));\r
 166                 graph_->add_guide("tick-time", 0.5);\r
 167                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));\r
 168                 graph_->set_color("param", diagnostics::color(1.0f, 0.5f, 0.0f));       \r
 169                 graph_->set_color("skip-sync", diagnostics::color(0.8f, 0.3f, 0.2f));                   \r
 170                 \r
 171                 if(FAILED(CComObject<caspar::flash::FlashAxContainer>::CreateInstance(&ax_)))\r
 172                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to create FlashAxContainer"));\r
 173                 \r
 174                 ax_->set_print([this]{return L"flash_renderer";});\r
 175 \r
 176                 if(FAILED(ax_->CreateAxControl()))\r
 177                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to Create FlashAxControl"));\r
 178                 \r
 179                 CComPtr<IShockwaveFlash> spFlash;\r
 180                 if(FAILED(ax_->QueryControl(&spFlash)))\r
 181                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to Query FlashAxControl"));\r
 182                                                                                                 \r
 183                 if(FAILED(spFlash->put_Playing(true)) )\r
 184                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to start playing Flash"));\r
 185 \r
 186                 if(FAILED(spFlash->put_Movie(CComBSTR(filename.c_str()))))\r
 187                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to Load Template Host"));\r
 188                                                                                 \r
 189                 if(FAILED(spFlash->put_ScaleMode(2)))  //Exact fit. Scale without respect to the aspect ratio.\r
 190                         BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(narrow(print()) + " Failed to Set Scale Mode"));\r
 191                                                 \r
 192                 ax_->SetSize(width_, height_);          \r
 193         \r
 194                 CASPAR_LOG(info) << print() << L" Thread started.";\r
 195                 CASPAR_LOG(info) << print() << L" Successfully initialized with template-host: " << filename << L" width: " << width_ << L" height: " << height_ << L".";\r
 196         }\r
 197 \r
 198         ~flash_renderer()\r
 199         {               \r
 200                 if(ax_)\r
 201                 {\r
 202                         ax_->DestroyAxControl();\r
 203                         ax_->Release();\r
 204                 }\r
 205                 CASPAR_LOG(info) << print() << L" Thread ended.";\r
 206         }\r
 207         \r
 208         void param(const std::wstring& param)\r
 209         {               \r
 210                 if(!ax_->FlashCall(param))\r
 211                         CASPAR_LOG(warning) << print() << L" Flash call failed:" << param;//BOOST_THROW_EXCEPTION(invalid_operation() << msg_info("Flash function call failed.") << arg_name_info("param") << arg_value_info(narrow(param)));\r
 212                 graph_->add_tag("param");\r
 213         }\r
 214         \r
 215         safe_ptr<core::basic_frame> render_frame(bool has_underflow)\r
 216         {\r
 217                 float frame_time = 1.0f/ax_->GetFPS();\r
 218 \r
 219                 graph_->update_value("tick-time", static_cast<float>(tick_timer_.elapsed()/frame_time)*0.5f);\r
 220                 tick_timer_.restart();\r
 221 \r
 222                 if(ax_->IsEmpty())\r
 223                         return core::basic_frame::empty();              \r
 224                 \r
 225                 if(!has_underflow)                      \r
 226                         timer_.tick(frame_time); // This will block the thread.\r
 227                 else\r
 228                         graph_->add_tag("skip-sync");\r
 229                         \r
 230                 frame_timer_.restart();\r
 231 \r
 232                 ax_->Tick();\r
 233                 if(ax_->InvalidRect())\r
 234                 {                       \r
 235                         fast_memclr(bmp_.data(), width_*height_*4);\r
 236                         ax_->DrawControl(bmp_);\r
 237                 \r
 238                         auto frame = frame_factory_->create_frame(this, width_, height_);\r
 239                         fast_memcpy(frame->image_data().begin(), bmp_.data(), width_*height_*4);\r
 240                         frame->commit();\r
 241                         head_ = frame;\r
 242                 }               \r
 243                                 \r
 244                 graph_->update_value("frame-time", static_cast<float>(frame_timer_.elapsed()/frame_time)*0.5f);\r
 245                 return head_;\r
 246         }\r
 247 \r
 248         bool is_empty() const\r
 249         {\r
 250                 return ax_->IsEmpty();\r
 251         }\r
 252 \r
 253         double fps() const\r
 254         {\r
 255                 return ax_->GetFPS();   \r
 256         }\r
 257         \r
 258         std::wstring print()\r
 259         {\r
 260                 return L"flash[" + boost::filesystem::wpath(filename_).filename() + L"]";               \r
 261         }\r
 262 };\r
 263 \r
 264 struct flash_producer : public core::frame_producer\r
 265 {       \r
 266         const std::wstring filename_;   \r
 267         const safe_ptr<core::frame_factory> frame_factory_;\r
 268 \r
 269         tbb::atomic<int> fps_;\r
 270 \r
 271         std::shared_ptr<diagnostics::graph> graph_;\r
 272 \r
 273         tbb::concurrent_bounded_queue<safe_ptr<core::basic_frame>> frame_buffer_;\r
 274 \r
 275         mutable tbb::spin_mutex         last_frame_mutex_;\r
 276         safe_ptr<core::basic_frame>     last_frame_;\r
 277                                 \r
 278         com_context<flash_renderer> context_;   \r
 279 \r
 280         int width_;\r
 281         int height_;\r
 282 public:\r
 283         flash_producer(const safe_ptr<core::frame_factory>& frame_factory, const std::wstring& filename, size_t width, size_t height) \r
 284                 : filename_(filename)           \r
 285                 , frame_factory_(frame_factory)\r
 286                 , context_(L"flash_producer")\r
 287                 , last_frame_(core::basic_frame::empty())\r
 288                 , width_(width > 0 ? width : frame_factory->get_video_format_desc().width)\r
 289                 , height_(height > 0 ? height : frame_factory->get_video_format_desc().height)\r
 290         {       \r
 291                 if(!boost::filesystem::exists(filename))\r
 292                         BOOST_THROW_EXCEPTION(file_not_found() << boost::errinfo_file_name(narrow(filename)));  \r
 293 \r
 294                 fps_ = 0;\r
 295 \r
 296                 graph_ = diagnostics::create_graph(narrow(print()));\r
 297                 graph_->set_color("output-buffer-count", diagnostics::color(1.0f, 1.0f, 0.0f));          \r
 298                 graph_->set_color("underflow", diagnostics::color(0.6f, 0.3f, 0.9f));   \r
 299                 \r
 300                 frame_buffer_.set_capacity(frame_factory_->get_video_format_desc().fps > 30.0 ? 2 : 1);\r
 301 \r
 302                 initialize();                           \r
 303         }\r
 304 \r
 305         ~flash_producer()\r
 306         {\r
 307                 frame_buffer_.clear();\r
 308         }\r
 309 \r
 310         // frame_producer\r
 311                 \r
 312         virtual safe_ptr<core::basic_frame> receive(int)\r
 313         {                               \r
 314                 graph_->set_value("output-buffer-count", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));\r
 315 \r
 316                 auto frame = core::basic_frame::late();\r
 317                 if(!frame_buffer_.try_pop(frame) && context_)\r
 318                         graph_->add_tag("underflow");\r
 319 \r
 320                 return frame;\r
 321         }\r
 322 \r
 323         virtual safe_ptr<core::basic_frame> last_frame() const\r
 324         {\r
 325                 tbb::spin_mutex::scoped_lock lock(last_frame_mutex_);\r
 326                 return last_frame_;\r
 327         }               \r
 328         \r
 329         virtual void param(const std::wstring& param) \r
 330         {       \r
 331                 context_.begin_invoke([=]\r
 332                 {\r
 333                         if(!context_)\r
 334                                 initialize();\r
 335 \r
 336                         try\r
 337                         {\r
 338                                 context_->param(param); \r
 339 \r
 340                                 //const auto& format_desc = frame_factory_->get_video_format_desc();\r
 341                                 //if(abs(context_->fps() - format_desc.fps) > 0.01 && abs(context_->fps()/2.0 - format_desc.fps) > 0.01)\r
 342                                 //      CASPAR_LOG(warning) << print() << " Invalid frame-rate: " << context_->fps() << L". Should be either " << format_desc.fps << L" or " << format_desc.fps*2.0 << L".";\r
 343                         }\r
 344                         catch(...)\r
 345                         {\r
 346                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 347                                 context_.reset(nullptr);\r
 348                                 frame_buffer_.push(core::basic_frame::empty());\r
 349                         }\r
 350                 });\r
 351         }\r
 352                 \r
 353         virtual std::wstring print() const\r
 354         { \r
 355                 return L"flash[" + boost::filesystem::wpath(filename_).filename() + L"|" + boost::lexical_cast<std::wstring>(fps_) + L"]";              \r
 356         }       \r
 357 \r
 358         // flash_producer\r
 359 \r
 360         void initialize()\r
 361         {\r
 362                 context_.reset([&]{return new flash_renderer(safe_ptr<diagnostics::graph>(graph_), frame_factory_, filename_, width_, height_);});\r
 363                 while(frame_buffer_.try_push(core::basic_frame::empty())){}             \r
 364                 render(context_.get());\r
 365         }\r
 366 \r
 367         safe_ptr<core::basic_frame> render_frame()\r
 368         {\r
 369                 auto frame = context_->render_frame(frame_buffer_.size() < frame_buffer_.capacity());           \r
 370                 tbb::spin_mutex::scoped_lock lock(last_frame_mutex_);\r
 371                 last_frame_ = make_safe<core::basic_frame>(frame);\r
 372                 return frame;\r
 373         }\r
 374 \r
 375         void render(const flash_renderer* renderer)\r
 376         {               \r
 377                 context_.begin_invoke([=]\r
 378                 {\r
 379                         if(context_.get() != renderer) // Since initialize will start a new recursive call make sure the recursive calls are only for a specific instance.\r
 380                                 return;\r
 381 \r
 382                         try\r
 383                         {               \r
 384                                 const auto& format_desc = frame_factory_->get_video_format_desc();\r
 385 \r
 386                                 if(abs(context_->fps()/2.0 - format_desc.fps) < 2.0) // flash == 2 * format -> interlace\r
 387                                 {\r
 388                                         auto frame1 = render_frame();\r
 389                                         auto frame2 = render_frame();\r
 390                                         frame_buffer_.push(core::basic_frame::interlace(frame1, frame2, format_desc.field_mode));\r
 391                                 }\r
 392                                 else if(abs(context_->fps()- format_desc.fps/2.0) < 2.0) // format == 2 * flash -> duplicate\r
 393                                 {\r
 394                                         auto frame = render_frame();\r
 395                                         frame_buffer_.push(frame);\r
 396                                         frame_buffer_.push(frame);\r
 397                                 }\r
 398                                 else //if(abs(renderer_->fps() - format_desc_.fps) < 0.1) // format == flash -> simple\r
 399                                 {\r
 400                                         auto frame = render_frame();\r
 401                                         frame_buffer_.push(frame);\r
 402                                 }\r
 403 \r
 404                                 if(context_->is_empty())\r
 405                                 {\r
 406                                         context_.reset(nullptr);\r
 407                                         return;\r
 408                                 }\r
 409 \r
 410                                 graph_->set_value("output-buffer-count", static_cast<float>(frame_buffer_.size())/static_cast<float>(frame_buffer_.capacity()));        \r
 411                                 fps_.fetch_and_store(static_cast<int>(context_->fps()*100.0));                          \r
 412                                 graph_->update_text(narrow(print()));\r
 413 \r
 414                                 render(renderer);\r
 415                         }\r
 416                         catch(...)\r
 417                         {\r
 418                                 CASPAR_LOG_CURRENT_EXCEPTION();\r
 419                                 context_.reset(nullptr);\r
 420                                 frame_buffer_.push(core::basic_frame::empty());\r
 421                         }\r
 422                 });\r
 423         }\r
 424 };\r
 425 \r
 426 safe_ptr<core::frame_producer> create_producer(const safe_ptr<core::frame_factory>& frame_factory, const std::vector<std::wstring>& params)\r
 427 {\r
 428         auto template_host = get_template_host(frame_factory->get_video_format_desc());\r
 429         \r
 430         return make_safe<flash_producer>(frame_factory, env::template_folder() + L"\\" + widen(template_host.filename), template_host.width, template_host.height);\r
 431 }\r
 432 \r
 433 std::wstring find_template(const std::wstring& template_name)\r
 434 {\r
 435         if(boost::filesystem::exists(template_name + L".ft")) \r
 436                 return template_name + L".ft";\r
 437         \r
 438         if(boost::filesystem::exists(template_name + L".ct"))\r
 439                 return template_name + L".ct";\r
 440 \r
 441         return L"";\r
 442 }\r
 443 \r
 444 }}