2 * Copyright 2013 Sveriges Television AB http://casparcg.com/
4 * This file is part of CasparCG (www.casparcg.com).
6 * CasparCG is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * CasparCG is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with CasparCG. If not, see <http://www.gnu.org/licenses/>.
19 * Author: Robert Nagy, ronag89@gmail.com
22 #include "html_producer.h"
24 #include <core/video_format.h>
26 #include <core/monitor/monitor.h>
27 #include <core/frame/draw_frame.h>
28 #include <core/frame/frame_factory.h>
29 #include <core/producer/frame_producer.h>
30 #include <core/interaction/interaction_event.h>
31 #include <core/frame/frame.h>
32 #include <core/frame/pixel_format.h>
33 #include <core/frame/geometry.h>
34 #include <core/help/help_repository.h>
35 #include <core/help/help_sink.h>
37 #include <common/assert.h>
38 #include <common/env.h>
39 #include <common/executor.h>
40 #include <common/lock.h>
41 #include <common/future.h>
42 #include <common/diagnostics/graph.h>
43 #include <common/prec_timer.h>
44 #include <common/linq.h>
45 #include <common/os/filesystem.h>
47 #include <boost/algorithm/string/predicate.hpp>
48 #include <boost/filesystem.hpp>
49 #include <boost/timer.hpp>
50 #include <boost/log/trivial.hpp>
51 #include <boost/property_tree/ptree.hpp>
53 #include <tbb/atomic.h>
54 #include <tbb/concurrent_queue.h>
57 #pragma warning(disable: 4458)
60 #include <cef_client.h>
61 #include <cef_render_handler.h>
70 #pragma comment (lib, "libcef.lib")
71 #pragma comment (lib, "libcef_dll_wrapper.lib")
73 namespace caspar { namespace html {
77 , public CefRenderHandler
78 , public CefLifeSpanHandler
79 , public CefLoadHandler
82 spl::shared_ptr<diagnostics::graph> graph_;
83 boost::timer tick_timer_;
84 boost::timer frame_timer_;
85 boost::timer paint_timer_;
87 spl::shared_ptr<core::frame_factory> frame_factory_;
88 core::video_format_desc format_desc_;
89 tbb::concurrent_queue<std::wstring> javascript_before_load_;
90 tbb::atomic<bool> loaded_;
91 tbb::atomic<bool> removed_;
92 tbb::atomic<bool> animation_frame_requested_;
93 std::queue<core::draw_frame> frames_;
94 mutable boost::mutex frames_mutex_;
96 core::draw_frame last_frame_;
97 core::draw_frame last_progressive_frame_;
98 mutable boost::mutex last_frame_mutex_;
100 CefRefPtr<CefBrowser> browser_;
107 spl::shared_ptr<core::frame_factory> frame_factory,
108 const core::video_format_desc& format_desc,
109 const std::wstring& url)
111 , frame_factory_(std::move(frame_factory))
112 , format_desc_(format_desc)
113 , last_frame_(core::draw_frame::empty())
114 , last_progressive_frame_(core::draw_frame::empty())
115 , executor_(L"html_producer")
117 graph_->set_color("browser-tick-time", diagnostics::color(0.1f, 1.0f, 0.1f));
118 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
119 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.9f));
120 graph_->set_text(print());
121 diagnostics::register_graph(graph_);
125 animation_frame_requested_ = false;
126 executor_.begin_invoke([&]{ update(); });
129 core::draw_frame receive()
131 auto frame = last_frame();
132 executor_.begin_invoke([&]{ update(); });
136 core::draw_frame last_frame() const
138 return lock(last_frame_mutex_, [&]
144 void execute_javascript(const std::wstring& javascript)
148 javascript_before_load_.push(javascript);
152 execute_queued_javascript();
153 do_execute_javascript(javascript);
157 CefRefPtr<CefBrowserHost> get_browser_host()
159 return browser_->GetHost();
164 if (!animation_frame_requested_)
165 CASPAR_LOG(warning) << print()
166 << " window.requestAnimationFrame() never called. "
167 << "Animations might have been laggy";
171 if (browser_ != nullptr)
173 browser_->GetHost()->CloseBrowser(true);
184 bool is_removed() const
191 bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect &rect)
193 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
195 rect = CefRect(0, 0, format_desc_.square_width, format_desc_.square_height);
200 CefRefPtr<CefBrowser> browser,
201 PaintElementType type,
202 const RectList &dirtyRects,
207 graph_->set_value("browser-tick-time", paint_timer_.elapsed()
209 * format_desc_.field_count
211 paint_timer_.restart();
212 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
214 boost::timer copy_timer;
215 core::pixel_format_desc pixel_desc;
216 pixel_desc.format = core::pixel_format::bgra;
217 pixel_desc.planes.push_back(
218 core::pixel_format_desc::plane(width, height, 4));
219 auto frame = frame_factory_->create_frame(this, pixel_desc);
220 A_memcpy(frame.image_data().begin(), buffer, width * height * 4);
222 lock(frames_mutex_, [&]
224 frames_.push(core::draw_frame(std::move(frame)));
226 size_t max_in_queue = format_desc_.field_count;
228 while (frames_.size() > max_in_queue)
231 graph_->set_tag("dropped-frame");
234 graph_->set_value("copy-time", copy_timer.elapsed()
236 * format_desc_.field_count
240 void OnAfterCreated(CefRefPtr<CefBrowser> browser) override
242 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
247 void OnBeforeClose(CefRefPtr<CefBrowser> browser) override
249 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
254 bool DoClose(CefRefPtr<CefBrowser> browser) override
256 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
261 CefRefPtr<CefRenderHandler> GetRenderHandler() override
266 CefRefPtr<CefLifeSpanHandler> GetLifeSpanHandler() override
271 CefRefPtr<CefLoadHandler> GetLoadHandler() override {
276 CefRefPtr<CefBrowser> browser,
277 CefRefPtr<CefFrame> frame,
278 int httpStatusCode) override
281 execute_queued_javascript();
284 bool OnProcessMessageReceived(
285 CefRefPtr<CefBrowser> browser,
286 CefProcessId source_process,
287 CefRefPtr<CefProcessMessage> message) override
289 auto name = message->GetName().ToString();
291 if (name == ANIMATION_FRAME_REQUESTED_MESSAGE_NAME)
294 << print() << L" Requested animation frame";
295 animation_frame_requested_ = true;
299 else if (name == REMOVE_MESSAGE_NAME)
305 else if (name == LOG_MESSAGE_NAME)
307 auto args = message->GetArgumentList();
309 static_cast<boost::log::trivial::severity_level>(args->GetInt(0));
310 auto msg = args->GetString(1).ToWString();
312 BOOST_LOG_STREAM_WITH_PARAMS(
314 (boost::log::keywords::severity = severity))
315 << print() << L" [renderer_process] " << msg;
321 void invoke_requested_animation_frames()
324 browser_->SendProcessMessage(
325 CefProcessId::PID_RENDERER,
326 CefProcessMessage::Create(TICK_MESSAGE_NAME));
327 graph_->set_value("tick-time", tick_timer_.elapsed()
329 * format_desc_.field_count
331 tick_timer_.restart();
334 bool try_pop(core::draw_frame& result)
336 return lock(frames_mutex_, [&]() -> bool
338 if (!frames_.empty())
340 result = std::move(frames_.front());
350 core::draw_frame pop()
352 core::draw_frame frame;
356 CASPAR_THROW_EXCEPTION(caspar_exception() << msg_info(u8(print()) + " No frame in buffer"));
364 invoke_requested_animation_frames();
369 auto num_frames = lock(frames_mutex_, [&]
371 return frames_.size();
374 if (num_frames >= format_desc_.field_count)
376 if (format_desc_.field_mode != core::field_mode::progressive)
380 executor_.yield(caspar::task_priority::lowest_priority);
381 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
382 invoke_requested_animation_frames();
386 lock(last_frame_mutex_, [&]
388 last_progressive_frame_ = frame2;
389 last_frame_ = core::draw_frame::interlace(frame1, frame2, format_desc_.field_mode);
396 lock(last_frame_mutex_, [&]
402 else if (num_frames == 1) // Interlaced but only one frame
403 { // available. Probably the last frame
404 // of some animation sequence.
407 lock(last_frame_mutex_, [&]
409 last_progressive_frame_ = frame;
413 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
414 invoke_requested_animation_frames();
418 graph_->set_tag("late-frame");
420 if (format_desc_.field_mode != core::field_mode::progressive)
422 lock(last_frame_mutex_, [&]
424 last_frame_ = last_progressive_frame_;
427 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
428 invoke_requested_animation_frames();
433 void do_execute_javascript(const std::wstring& javascript)
435 html::begin_invoke([=]
437 if (browser_ != nullptr)
438 browser_->GetMainFrame()->ExecuteJavaScript(u8(javascript).c_str(), browser_->GetMainFrame()->GetURL(), 0);
442 void execute_queued_javascript()
444 std::wstring javascript;
446 while (javascript_before_load_.try_pop(javascript))
447 do_execute_javascript(javascript);
450 std::wstring print() const
452 return L"html[" + url_ + L"]";
455 IMPLEMENT_REFCOUNTING(html_client);
459 : public core::frame_producer_base
461 core::monitor::subject monitor_subject_;
462 const std::wstring url_;
463 core::constraints constraints_;
465 CefRefPtr<html_client> client_;
469 const spl::shared_ptr<core::frame_factory>& frame_factory,
470 const core::video_format_desc& format_desc,
471 const std::wstring& url)
474 constraints_.width.set(format_desc.square_width);
475 constraints_.height.set(format_desc.square_height);
479 client_ = new html_client(frame_factory, format_desc, url_);
481 CefWindowInfo window_info;
483 window_info.SetTransparentPainting(true);
484 window_info.SetAsOffScreen(nullptr);
485 //window_info.SetAsWindowless(nullptr, true);
487 CefBrowserSettings browser_settings;
488 browser_settings.web_security = cef_state_t::STATE_DISABLED;
489 CefBrowserHost::CreateBrowser(window_info, client_.get(), url, browser_settings, nullptr);
501 std::wstring name() const override
506 void on_interaction(const core::interaction_event::ptr& event) override
508 if (core::is<core::mouse_move_event>(event))
510 auto move = core::as<core::mouse_move_event>(event);
511 int x = static_cast<int>(move->x * constraints_.width.get());
512 int y = static_cast<int>(move->y * constraints_.height.get());
517 client_->get_browser_host()->SendMouseMoveEvent(e, false);
519 else if (core::is<core::mouse_button_event>(event))
521 auto button = core::as<core::mouse_button_event>(event);
522 int x = static_cast<int>(button->x * constraints_.width.get());
523 int y = static_cast<int>(button->y * constraints_.height.get());
528 client_->get_browser_host()->SendMouseClickEvent(
530 static_cast<CefBrowserHost::MouseButtonType>(button->button),
534 else if (core::is<core::mouse_wheel_event>(event))
536 auto wheel = core::as<core::mouse_wheel_event>(event);
537 int x = static_cast<int>(wheel->x * constraints_.width.get());
538 int y = static_cast<int>(wheel->y * constraints_.height.get());
543 static const int WHEEL_TICKS_AMPLIFICATION = 40;
544 client_->get_browser_host()->SendMouseWheelEvent(
547 wheel->ticks_delta * WHEEL_TICKS_AMPLIFICATION); // delta_y
551 bool collides(double x, double y) const override
556 core::draw_frame receive_impl() override
560 if (client_->is_removed())
563 return core::draw_frame::empty();
566 return client_->receive();
569 return core::draw_frame::empty();
572 std::future<std::wstring> call(const std::vector<std::wstring>& params) override
575 return make_ready_future(std::wstring(L""));
577 auto javascript = params.at(0);
579 client_->execute_javascript(javascript);
581 return make_ready_future(std::wstring(L""));
584 std::wstring print() const override
586 return L"html[" + url_ + L"]";
589 boost::property_tree::wptree info() const override
591 boost::property_tree::wptree info;
592 info.add(L"type", L"html-producer");
596 core::constraints& pixel_constraints() override
601 core::monitor::subject& monitor_output()
603 return monitor_subject_;
607 void describe_producer(core::help_sink& sink, const core::help_repository& repo)
609 sink.short_description(L"Renders a web page in real time.");
610 sink.syntax(L"{[html_filename:string]},{[HTML] [url:string]}");
611 sink.para()->text(L"Embeds an actual web browser and renders the content in realtime.");
613 ->text(L"HTML content can either be stored locally under the ")->code(L"templates")
614 ->text(L" folder or fetched directly via an URL. If a .html file is found with the name ")
615 ->code(L"html_filename")->text(L" under the ")->code(L"templates")->text(L" folder it will be rendered. If the ")
616 ->code(L"[HTML] url")->text(L" syntax is used instead, the URL will be loaded.");
617 sink.para()->text(L"Examples:");
618 sink.example(L">> PLAY 1-10 [HTML] http://www.casparcg.com");
619 sink.example(L">> PLAY 1-10 folder/html_file");
622 spl::shared_ptr<core::frame_producer> create_producer(
623 const core::frame_producer_dependencies& dependencies,
624 const std::vector<std::wstring>& params)
626 const auto filename = env::template_folder() + params.at(0) + L".html";
627 const auto found_filename = find_case_insensitive(filename);
629 if (!found_filename && !boost::iequals(params.at(0), L"[HTML]"))
630 return core::frame_producer::empty();
632 const auto url = found_filename
633 ? L"file://" + *found_filename
636 if (!boost::algorithm::contains(url, ".") || boost::algorithm::ends_with(url, "_A") || boost::algorithm::ends_with(url, "_ALPHA"))
637 return core::frame_producer::empty();
639 return core::create_destroy_proxy(spl::make_shared<html_producer>(
640 dependencies.frame_factory,
641 dependencies.format_desc,