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>
35 #include <common/assert.h>
36 #include <common/env.h>
37 #include <common/executor.h>
38 #include <common/lock.h>
39 #include <common/future.h>
40 #include <common/diagnostics/graph.h>
41 #include <common/prec_timer.h>
42 #include <common/linq.h>
43 #include <common/os/filesystem.h>
45 #include <boost/algorithm/string/predicate.hpp>
46 #include <boost/filesystem.hpp>
47 #include <boost/timer.hpp>
48 #include <boost/log/trivial.hpp>
49 #include <boost/property_tree/ptree.hpp>
51 #include <tbb/atomic.h>
52 #include <tbb/concurrent_queue.h>
56 #include <cef_client.h>
57 #include <cef_render_handler.h>
65 #pragma comment (lib, "libcef.lib")
66 #pragma comment (lib, "libcef_dll_wrapper.lib")
73 , public CefRenderHandler
74 , public CefLifeSpanHandler
75 , public CefLoadHandler
78 spl::shared_ptr<diagnostics::graph> graph_;
79 boost::timer tick_timer_;
80 boost::timer frame_timer_;
81 boost::timer paint_timer_;
83 spl::shared_ptr<core::frame_factory> frame_factory_;
84 core::video_format_desc format_desc_;
85 tbb::concurrent_queue<std::wstring> javascript_before_load_;
86 tbb::atomic<bool> loaded_;
87 tbb::atomic<bool> removed_;
88 tbb::atomic<bool> animation_frame_requested_;
89 std::queue<core::draw_frame> frames_;
90 mutable boost::mutex frames_mutex_;
92 core::draw_frame last_frame_;
93 core::draw_frame last_progressive_frame_;
94 mutable boost::mutex last_frame_mutex_;
96 CefRefPtr<CefBrowser> browser_;
103 spl::shared_ptr<core::frame_factory> frame_factory,
104 const core::video_format_desc& format_desc,
105 const std::wstring& url)
107 , frame_factory_(std::move(frame_factory))
108 , format_desc_(format_desc)
109 , last_frame_(core::draw_frame::empty())
110 , last_progressive_frame_(core::draw_frame::empty())
111 , executor_(L"html_producer")
113 graph_->set_color("browser-tick-time", diagnostics::color(0.1f, 1.0f, 0.1f));
114 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
115 graph_->set_color("late-frame", diagnostics::color(0.6f, 0.3f, 0.9f));
116 graph_->set_text(print());
117 diagnostics::register_graph(graph_);
121 animation_frame_requested_ = false;
122 executor_.begin_invoke([&]{ update(); });
125 core::draw_frame receive()
127 auto frame = last_frame();
128 executor_.begin_invoke([&]{ update(); });
132 core::draw_frame last_frame() const
134 return lock(last_frame_mutex_, [&]
140 void execute_javascript(const std::wstring& javascript)
144 javascript_before_load_.push(javascript);
148 execute_queued_javascript();
149 do_execute_javascript(javascript);
153 CefRefPtr<CefBrowserHost> get_browser_host()
155 return browser_->GetHost();
160 if (!animation_frame_requested_)
161 CASPAR_LOG(warning) << print()
162 << " window.requestAnimationFrame() never called. "
163 << "Animations might have been laggy";
167 if (browser_ != nullptr)
169 browser_->GetHost()->CloseBrowser(true);
180 bool is_removed() const
187 bool GetViewRect(CefRefPtr<CefBrowser> browser, CefRect &rect)
189 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
191 rect = CefRect(0, 0, format_desc_.square_width, format_desc_.square_height);
196 CefRefPtr<CefBrowser> browser,
197 PaintElementType type,
198 const RectList &dirtyRects,
203 graph_->set_value("browser-tick-time", paint_timer_.elapsed()
205 * format_desc_.field_count
207 paint_timer_.restart();
208 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
210 boost::timer copy_timer;
211 core::pixel_format_desc pixel_desc;
212 pixel_desc.format = core::pixel_format::bgra;
213 pixel_desc.planes.push_back(
214 core::pixel_format_desc::plane(width, height, 4));
215 auto frame = frame_factory_->create_frame(this, pixel_desc);
216 A_memcpy(frame.image_data().begin(), buffer, width * height * 4);
218 lock(frames_mutex_, [&]
220 frames_.push(core::draw_frame(std::move(frame)));
222 size_t max_in_queue = format_desc_.field_count;
224 while (frames_.size() > max_in_queue)
227 graph_->set_tag("dropped-frame");
230 graph_->set_value("copy-time", copy_timer.elapsed()
232 * format_desc_.field_count
236 void OnAfterCreated(CefRefPtr<CefBrowser> browser) override
238 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
243 void OnBeforeClose(CefRefPtr<CefBrowser> browser) override
245 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
250 bool DoClose(CefRefPtr<CefBrowser> browser) override
252 CASPAR_ASSERT(CefCurrentlyOn(TID_UI));
257 CefRefPtr<CefRenderHandler> GetRenderHandler() override
262 CefRefPtr<CefLifeSpanHandler> GetLifeSpanHandler() override
267 CefRefPtr<CefLoadHandler> GetLoadHandler() override {
272 CefRefPtr<CefBrowser> browser,
273 CefRefPtr<CefFrame> frame,
274 int httpStatusCode) override
277 execute_queued_javascript();
280 bool OnProcessMessageReceived(
281 CefRefPtr<CefBrowser> browser,
282 CefProcessId source_process,
283 CefRefPtr<CefProcessMessage> message) override
285 auto name = message->GetName().ToString();
287 if (name == ANIMATION_FRAME_REQUESTED_MESSAGE_NAME)
290 << print() << L" Requested animation frame";
291 animation_frame_requested_ = true;
295 else if (name == REMOVE_MESSAGE_NAME)
301 else if (name == LOG_MESSAGE_NAME)
303 auto args = message->GetArgumentList();
305 static_cast<boost::log::trivial::severity_level>(args->GetInt(0));
306 auto msg = args->GetString(1).ToWString();
308 BOOST_LOG_STREAM_WITH_PARAMS(
310 (boost::log::keywords::severity = severity))
311 << print() << L" [renderer_process] " << msg;
317 void invoke_requested_animation_frames()
320 browser_->SendProcessMessage(
321 CefProcessId::PID_RENDERER,
322 CefProcessMessage::Create(TICK_MESSAGE_NAME));
323 graph_->set_value("tick-time", tick_timer_.elapsed()
325 * format_desc_.field_count
327 tick_timer_.restart();
330 bool try_pop(core::draw_frame& result)
332 return lock(frames_mutex_, [&]() -> bool
334 if (!frames_.empty())
336 result = std::move(frames_.front());
346 core::draw_frame pop()
348 core::draw_frame frame;
352 BOOST_THROW_EXCEPTION(caspar_exception() << msg_info(u8(print()) + " No frame in buffer"));
360 invoke_requested_animation_frames();
365 auto num_frames = lock(frames_mutex_, [&]
367 return frames_.size();
370 if (num_frames >= format_desc_.field_count)
372 if (format_desc_.field_mode != core::field_mode::progressive)
376 executor_.yield(caspar::task_priority::lowest_priority);
377 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
378 invoke_requested_animation_frames();
382 lock(last_frame_mutex_, [&]
384 last_progressive_frame_ = frame2;
385 last_frame_ = core::draw_frame::interlace(frame1, frame2, format_desc_.field_mode);
392 lock(last_frame_mutex_, [&]
398 else if (num_frames == 1) // Interlaced but only one frame
399 { // available. Probably the last frame
400 // of some animation sequence.
403 lock(last_frame_mutex_, [&]
405 last_progressive_frame_ = frame;
409 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
410 invoke_requested_animation_frames();
414 graph_->set_tag("late-frame");
416 if (format_desc_.field_mode != core::field_mode::progressive)
418 lock(last_frame_mutex_, [&]
420 last_frame_ = last_progressive_frame_;
423 timer.tick(1.0 / (format_desc_.fps * format_desc_.field_count));
424 invoke_requested_animation_frames();
429 void do_execute_javascript(const std::wstring& javascript)
431 html::begin_invoke([=]
433 if (browser_ != nullptr)
434 browser_->GetMainFrame()->ExecuteJavaScript(u8(javascript).c_str(), browser_->GetMainFrame()->GetURL(), 0);
438 void execute_queued_javascript()
440 std::wstring javascript;
442 while (javascript_before_load_.try_pop(javascript))
443 do_execute_javascript(javascript);
446 std::wstring print() const
448 return L"html[" + url_ + L"]";
451 IMPLEMENT_REFCOUNTING(html_client);
455 : public core::frame_producer_base
457 core::monitor::subject monitor_subject_;
458 const std::wstring url_;
459 core::constraints constraints_;
461 CefRefPtr<html_client> client_;
465 const spl::shared_ptr<core::frame_factory>& frame_factory,
466 const core::video_format_desc& format_desc,
467 const std::wstring& url)
470 constraints_.width.set(format_desc.square_width);
471 constraints_.height.set(format_desc.square_height);
475 client_ = new html_client(frame_factory, format_desc, url_);
477 CefWindowInfo window_info;
479 window_info.SetTransparentPainting(true);
480 window_info.SetAsOffScreen(nullptr);
481 //window_info.SetAsWindowless(nullptr, true);
483 CefBrowserSettings browser_settings;
484 CefBrowserHost::CreateBrowser(window_info, client_.get(), url, browser_settings, nullptr);
496 std::wstring name() const override
501 void on_interaction(const core::interaction_event::ptr& event) override
503 if (core::is<core::mouse_move_event>(event))
505 auto move = core::as<core::mouse_move_event>(event);
506 int x = static_cast<int>(move->x * constraints_.width.get());
507 int y = static_cast<int>(move->y * constraints_.height.get());
512 client_->get_browser_host()->SendMouseMoveEvent(e, false);
514 else if (core::is<core::mouse_button_event>(event))
516 auto button = core::as<core::mouse_button_event>(event);
517 int x = static_cast<int>(button->x * constraints_.width.get());
518 int y = static_cast<int>(button->y * constraints_.height.get());
523 client_->get_browser_host()->SendMouseClickEvent(
525 static_cast<CefBrowserHost::MouseButtonType>(button->button),
529 else if (core::is<core::mouse_wheel_event>(event))
531 auto wheel = core::as<core::mouse_wheel_event>(event);
532 int x = static_cast<int>(wheel->x * constraints_.width.get());
533 int y = static_cast<int>(wheel->y * constraints_.height.get());
538 static const int WHEEL_TICKS_AMPLIFICATION = 40;
539 client_->get_browser_host()->SendMouseWheelEvent(
542 wheel->ticks_delta * WHEEL_TICKS_AMPLIFICATION); // delta_y
546 bool collides(double x, double y) const override
551 core::draw_frame receive_impl() override
555 if (client_->is_removed())
558 return core::draw_frame::empty();
561 return client_->receive();
564 return core::draw_frame::empty();
567 std::future<std::wstring> call(const std::vector<std::wstring>& params) override
570 return make_ready_future(std::wstring(L""));
572 auto javascript = params.at(0);
574 client_->execute_javascript(javascript);
576 return make_ready_future(std::wstring(L""));
579 std::wstring print() const override
581 return L"html[" + url_ + L"]";
584 boost::property_tree::wptree info() const override
586 boost::property_tree::wptree info;
587 info.add(L"type", L"html-producer");
591 core::constraints& pixel_constraints() override
596 core::monitor::subject& monitor_output()
598 return monitor_subject_;
602 spl::shared_ptr<core::frame_producer> create_producer(
603 const spl::shared_ptr<core::frame_factory>& frame_factory,
604 const core::video_format_desc& format_desc,
605 const std::vector<std::wstring>& params)
607 const auto filename = env::template_folder() + params.at(0) + L".html";
608 const auto found_filename = find_case_insensitive(filename);
610 if (!found_filename && !boost::iequals(params.at(0), L"[HTML]"))
611 return core::frame_producer::empty();
613 const auto url = found_filename
614 ? L"file://" + *found_filename
617 if (!boost::algorithm::contains(url, ".") || boost::algorithm::ends_with(url, "_A") || boost::algorithm::ends_with(url, "_ALPHA"))
618 return core::frame_producer::empty();
620 return core::create_destroy_proxy(spl::make_shared<html_producer>(