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