]> 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 0a11c106076fbc3fb631cc22c41cb3db277b0902..a5d4fcde9108b698da5a4d65717da09542074aab 100644 (file)
@@ -35,6 +35,8 @@
 #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>
@@ -77,16 +79,24 @@ public:
                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(info) << flash_producer_->print() << " Invoking add-command: " << 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));
+               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(info) << flash_producer_->print() << " Invoking remove-command: " << 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));
@@ -94,8 +104,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking play-command: " << 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));
@@ -103,8 +115,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking stop-command: " << 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));
@@ -112,8 +126,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking next-command: " << 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));
@@ -121,8 +137,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking update-command: " << 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));
@@ -130,8 +148,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking invoke-command: " << 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
@@ -140,8 +160,10 @@ public:
 
        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(info) << flash_producer_->print() << " Invoking description-command: " << 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
@@ -151,7 +173,7 @@ public:
        std::wstring template_host_info() override
        {
                auto str = (boost::wformat(L"<invoke name=\"GetInfo\" returntype=\"xml\"><arguments></arguments></invoke>")).str();
-               CASPAR_LOG(info) << flash_producer_->print() << " Invoking info-command: " << 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
@@ -159,25 +181,61 @@ public:
        }
 };
 
+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 spl::shared_ptr<core::frame_factory> frame_factory,
-               const core::video_format_desc& format_desc,
+               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(frame_factory, format_desc, {});
+       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)
 {
-       core::register_producer_factory(create_ct_producer);
-       core::register_producer_factory(create_swf_producer);
+       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")
@@ -198,15 +256,15 @@ void init(core::module_dependencies dependencies)
                        { L".ft", L".ct" },
                        [](const std::wstring& filename)
                        {
-                               return read_template_meta_info(get_absolute(env::template_folder(), filename) + L".ft");
+                               return read_template_meta_info(filename);
                        },
                        [](const spl::shared_ptr<core::frame_producer>& producer)
                        {
                                return spl::make_shared<flash_cg_proxy>(producer);
                        },
-                       [](const spl::shared_ptr<core::frame_factory>& ff, const core::video_format_desc& f, const std::wstring&)
+                       [](const core::frame_producer_dependencies& dependencies, const std::wstring&)
                        {
-                               return flash::create_producer(ff, f, { });
+                               return flash::create_producer(dependencies, { });
                        },
                        true
                );
@@ -218,11 +276,11 @@ std::wstring cg_version()
 }
 
 std::wstring version()
-{              
+{
        std::wstring version = L"Not found";
-#ifdef WIN32 
+#ifdef WIN32
        HKEY   hkey;
+
        DWORD dwType, dwSize;
        if(RegOpenKeyEx(HKEY_LOCAL_MACHINE, TEXT("SOFTWARE\\Macromedia\\FlashPlayerActiveX"), 0, KEY_QUERY_VALUE, &hkey) == ERROR_SUCCESS)
        {
@@ -231,7 +289,7 @@ std::wstring version()
                dwType = REG_SZ;
                dwSize = sizeof(ver_str);
                RegQueryValueEx(hkey, TEXT("Version"), NULL, &dwType, (PBYTE)&ver_str, &dwSize);
+
                version = ver_str;
 
                RegCloseKey(hkey);