]> git.sesse.net Git - casparcg/blobdiff - modules/flash/flash.cpp
[flash] Moved template host copying to flash module startup instead from env setup...
[casparcg] / modules / flash / flash.cpp
index 9378a073d09a3fa7682baf37064d6db0d2b3c744..a5d4fcde9108b698da5a4d65717da09542074aab 100644 (file)
-/*\r
-* copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
-*\r
-*  This file is part of CasparCG.\r
-*\r
-*    CasparCG is free software: you can redistribute it and/or modify\r
-*    it under the terms of the GNU General Public License as published by\r
-*    the Free Software Foundation, either version 3 of the License, or\r
-*    (at your option) any later version.\r
-*\r
-*    CasparCG is distributed in the hope that it will be useful,\r
-*    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
-*    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
-*    GNU General Public License for more details.\r
-\r
-*    You should have received a copy of the GNU General Public License\r
-*    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
-*\r
-*/\r
-#include "StdAfx.h"\r
-\r
-#include "flash.h"\r
-\r
-#include "producer/cg_producer.h"\r
-#include "producer/flash_producer.h"\r
-\r
-#include <common/env.h>\r
-\r
-namespace caspar { namespace flash {\r
-\r
-void init()\r
-{\r
-       core::register_producer_factory(create_ct_producer);\r
-}\r
-\r
-std::wstring get_cg_version()\r
-{\r
-       return L"Unknown";\r
-}\r
-\r
-std::wstring get_version()\r
-{              \r
-       std::wstring version = L"Not found";\r
-#ifdef WIN32\r
-       HKEY   hkey;\r
\r
-       DWORD dwType, dwSize;\r
-       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, TEXT("SOFTWARE\\Macromedia\\FlashPlayerActiveX"), 0, KEY_QUERY_VALUE, &hkey) == ERROR_SUCCESS)\r
-       {\r
-               wchar_t ver_str[1024];\r
-\r
-               dwType = REG_SZ;\r
-               dwSize = sizeof(ver_str);\r
-               RegQueryValueEx(hkey, TEXT("Version"), NULL, &dwType, (PBYTE)&ver_str, &dwSize);\r
\r
-               version = ver_str;\r
-\r
-               RegCloseKey(hkey);\r
-       }\r
-#endif\r
-       return version;\r
-}\r
-\r
-}}\r
+/*
+* Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>
+*
+* This file is part of CasparCG (www.casparcg.com).
+*
+* CasparCG is free software: you can redistribute it and/or modify
+* it under the terms of the GNU General Public License as published by
+* the Free Software Foundation, either version 3 of the License, or
+* (at your option) any later version.
+*
+* CasparCG is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU General Public License for more details.
+*
+* You should have received a copy of the GNU General Public License
+* along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
+*
+* Author: Robert Nagy, ronag89@gmail.com
+*/
+
+#include "StdAfx.h"
+
+#include "flash.h"
+#include "util/swf.h"
+
+#include "producer/flash_producer.h"
+
+#include <common/env.h>
+#include <common/os/windows/windows.h>
+
+#include <core/producer/media_info/media_info.h>
+#include <core/producer/media_info/media_info_repository.h>
+#include <core/producer/cg_proxy.h>
+#include <core/system_info_provider.h>
+#include <core/frame/frame_factory.h>
+#include <core/video_format.h>
+#include <core/help/help_sink.h>
+#include <core/help/help_repository.h>
+
+#include <boost/property_tree/ptree.hpp>
+#include <boost/noncopyable.hpp>
+#include <boost/filesystem.hpp>
+
+#include <string>
+#include <future>
+
+namespace caspar { namespace flash {
+
+std::wstring version();
+std::wstring cg_version();
+
+std::wstring get_absolute(const std::wstring& base_folder, const std::wstring& filename)
+{
+       return (boost::filesystem::path(base_folder) / filename).wstring();
+}
+
+class flash_cg_proxy : public core::cg_proxy, boost::noncopyable
+{
+       spl::shared_ptr<core::frame_producer>   flash_producer_;
+       std::wstring                                                    base_folder_;
+public:
+       explicit flash_cg_proxy(const spl::shared_ptr<core::frame_producer>& producer, std::wstring base_folder = env::template_folder())
+               : flash_producer_(producer)
+               , base_folder_(base_folder)
+       {
+       }
+
+       //cg_proxy
+
+       void add(int layer, const std::wstring& template_name, bool play_on_load, const std::wstring& label, const std::wstring& data) override
+       {
+               auto filename = template_name;
+
+               if (filename.size() > 0 && filename[0] == L'/')
+                       filename = filename.substr(1, filename.size() - 1);
+
+               filename = (boost::filesystem::path(base_folder_) / filename).wstring();
+               filename = find_template(filename);
+
+               auto str = (boost::wformat(L"<invoke name=\"Add\" returntype=\"xml\"><arguments><number>%1%</number><string>%2%</string>%3%<string>%4%</string><string><![CDATA[%5%]]></string></arguments></invoke>") % layer % filename % (play_on_load ? L"<true/>" : L"<false/>") % label % data).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking add-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params)).get();
+       }
+
+       void verify_flash_player()
+       {
+               if (flash_producer_->call({ L"?" }).get() == L"0")
+                       CASPAR_THROW_EXCEPTION(expected_user_error() << msg_info("No flash player running on video layer."));
+       }
+
+       void remove(int layer) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"Delete\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array></arguments></invoke>") % layer).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking remove-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params));
+       }
+
+       void play(int layer) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"Play\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array></arguments></invoke>") % layer).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking play-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params));
+       }
+
+       void stop(int layer, unsigned int) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"Stop\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array><number>0</number></arguments></invoke>") % layer).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking stop-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params));
+       }
+
+       void next(int layer) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"Next\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array></arguments></invoke>") % layer).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking next-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params));
+       }
+
+       void update(int layer, const std::wstring& data) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"SetData\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array><string><![CDATA[%2%]]></string></arguments></invoke>") % layer % data).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking update-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               flash_producer_->call(std::move(params));
+       }
+
+       std::wstring invoke(int layer, const std::wstring& label) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"Invoke\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array><string>%2%</string></arguments></invoke>") % layer % label).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking invoke-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               // TODO: because of std::async deferred timed waiting does not work so for now we have to block
+               return flash_producer_->call(std::move(params)).get();
+       }
+
+       std::wstring description(int layer) override
+       {
+               verify_flash_player();
+
+               auto str = (boost::wformat(L"<invoke name=\"GetDescription\" returntype=\"xml\"><arguments><array><property id=\"0\"><number>%1%</number></property></array></arguments></invoke>") % layer).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking description-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               // TODO: because of std::async deferred timed waiting does not work so for now we have to block
+               return flash_producer_->call(std::move(params)).get();
+       }
+
+       std::wstring template_host_info() override
+       {
+               auto str = (boost::wformat(L"<invoke name=\"GetInfo\" returntype=\"xml\"><arguments></arguments></invoke>")).str();
+               CASPAR_LOG(debug) << flash_producer_->print() << " Invoking info-command: " << str;
+               std::vector<std::wstring> params;
+               params.push_back(std::move(str));
+               // TODO: because of std::async deferred timed waiting does not work so for now we have to block
+               return flash_producer_->call(std::move(params)).get();
+       }
+};
+
+void describe_ct_producer(core::help_sink& sink, const core::help_repository& repo)
+{
+       sink.short_description(L"Plays compressed flash templates (.ct files).");
+       sink.syntax(L"[ct_file:string]");
+       sink.para()->text(L"Plays compressed flash templates (.ct files). The file should reside under the media folder.");
+       sink.para()->text(L"A ct file is a zip file containing a flash template (.ft), an XML file with template data and media files.");
+       sink.para()->text(L"Examples:");
+       sink.example(L">> PLAY 1-10 folder/ct_file");
+}
+
+spl::shared_ptr<core::frame_producer> create_ct_producer(
+               const core::frame_producer_dependencies& dependencies,
+               const std::vector<std::wstring>& params)
+{
+       if (params.empty() || !boost::filesystem::exists(get_absolute(env::media_folder(), params.at(0)) + L".ct"))
+               return core::frame_producer::empty();
+
+       auto flash_producer = flash::create_producer(dependencies, {});
+       auto producer = flash_producer;
+       flash_cg_proxy(producer, env::media_folder()).add(0, params.at(0), true, L"", L"");
+
+       return producer;
+}
+
+void copy_template_hosts()
+{
+       try
+       {
+               for (auto it = boost::filesystem::directory_iterator(env::initial_folder()); it != boost::filesystem::directory_iterator(); ++it)
+               {
+                       if (it->path().wstring().find(L".fth") != std::wstring::npos)
+                       {
+                               auto from_path = *it;
+                               auto to_path = boost::filesystem::path(env::template_folder() + L"/" + it->path().filename().wstring());
+
+                               if (boost::filesystem::exists(to_path))
+                                       boost::filesystem::remove(to_path);
+
+                               boost::filesystem::copy_file(from_path, to_path);
+                       }
+               }
+       }
+       catch (...)
+       {
+               CASPAR_LOG_CURRENT_EXCEPTION();
+               CASPAR_LOG(error) << L"Failed to copy template-hosts from initial-path to template-path.";
+       }
+}
+
+void init(core::module_dependencies dependencies)
+{
+       copy_template_hosts();
+
+       dependencies.producer_registry->register_producer_factory(L"Flash Producer (.ct)", create_ct_producer, describe_ct_producer);
+       dependencies.producer_registry->register_producer_factory(L"Flash Producer (.swf)", create_swf_producer, describe_swf_producer);
+       dependencies.media_info_repo->register_extractor([](const std::wstring& file, const std::wstring& extension, core::media_info& info)
+       {
+               if (extension != L".CT" && extension != L".SWF")
+                       return false;
+
+               info.clip_type = L"MOVIE";
+
+               return true;
+       });
+       dependencies.system_info_provider_repo->register_system_info_provider([](boost::property_tree::wptree& info)
+       {
+               info.add(L"system.flash", version());
+       });
+       dependencies.system_info_provider_repo->register_version_provider(L"FLASH", &version);
+       dependencies.system_info_provider_repo->register_version_provider(L"TEMPLATEHOST", &cg_version);
+       dependencies.cg_registry->register_cg_producer(
+                       L"flash",
+                       { L".ft", L".ct" },
+                       [](const std::wstring& filename)
+                       {
+                               return read_template_meta_info(filename);
+                       },
+                       [](const spl::shared_ptr<core::frame_producer>& producer)
+                       {
+                               return spl::make_shared<flash_cg_proxy>(producer);
+                       },
+                       [](const core::frame_producer_dependencies& dependencies, const std::wstring&)
+                       {
+                               return flash::create_producer(dependencies, { });
+                       },
+                       true
+               );
+}
+
+std::wstring cg_version()
+{
+       return L"Unknown";
+}
+
+std::wstring version()
+{
+       std::wstring version = L"Not found";
+#ifdef WIN32
+       HKEY   hkey;
+
+       DWORD dwType, dwSize;
+       if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, TEXT("SOFTWARE\\Macromedia\\FlashPlayerActiveX"), 0, KEY_QUERY_VALUE, &hkey) == ERROR_SUCCESS)
+       {
+               wchar_t ver_str[1024];
+
+               dwType = REG_SZ;
+               dwSize = sizeof(ver_str);
+               RegQueryValueEx(hkey, TEXT("Version"), NULL, &dwType, (PBYTE)&ver_str, &dwSize);
+
+               version = ver_str;
+
+               RegCloseKey(hkey);
+       }
+#endif
+       return version;
+}
+
+}}