2 * Copyright (c) 2011 Sveriges Television AB <info@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 "screen_consumer.h"
25 #include <SFML/Window.hpp>
27 #include <common/diagnostics/graph.h>
28 #include <common/gl/gl_check.h>
29 #include <common/log.h>
30 #include <common/memory.h>
31 #include <common/array.h>
32 #include <common/memshfl.h>
33 #include <common/memcpy.h>
34 #include <common/utf.h>
35 #include <common/prec_timer.h>
36 #include <common/future.h>
37 #include <common/timer.h>
38 #include <common/param.h>
39 #include <common/os/general_protection_fault.h>
40 #include <common/scope_exit.h>
42 //#include <windows.h>
44 #include <ffmpeg/producer/filter/filter.h>
45 #include <ffmpeg/producer/util/util.h>
47 #include <core/video_format.h>
48 #include <core/frame/frame.h>
49 #include <core/consumer/frame_consumer.h>
50 #include <core/interaction/interaction_sink.h>
51 #include <core/help/help_sink.h>
52 #include <core/help/help_repository.h>
54 #include <boost/circular_buffer.hpp>
55 #include <boost/lexical_cast.hpp>
56 #include <boost/property_tree/ptree.hpp>
57 #include <boost/thread.hpp>
58 #include <boost/algorithm/string.hpp>
60 #include <tbb/atomic.h>
61 #include <tbb/concurrent_queue.h>
62 #include <tbb/parallel_for.h>
70 #pragma warning (push)
71 #pragma warning (disable : 4244)
75 #define __STDC_CONSTANT_MACROS
76 #define __STDC_LIMIT_MACROS
77 #include <libavcodec/avcodec.h>
78 #include <libavutil/imgutils.h>
84 namespace caspar { namespace screen {
96 enum class aspect_ratio
103 std::wstring name = L"Screen consumer";
104 int screen_index = 0;
105 screen::stretch stretch = screen::stretch::fill;
106 bool windowed = true;
107 bool auto_deinterlace = true;
108 bool key_only = false;
109 aspect_ratio aspect = aspect_ratio::aspect_invalid;
111 bool interactive = true;
112 bool borderless = false;
115 struct screen_consumer : boost::noncopyable
117 const configuration config_;
118 core::video_format_desc format_desc_;
122 std::vector<GLuint> pbos_ = std::vector<GLuint> { 0, 0 };
128 int screen_width_ = format_desc_.width;
129 int screen_height_ = format_desc_.height;
130 int square_width_ = format_desc_.square_width;
131 int square_height_ = format_desc_.square_height;
134 tbb::atomic<bool> polling_event_;
137 spl::shared_ptr<diagnostics::graph> graph_;
138 caspar::timer perf_timer_;
139 caspar::timer tick_timer_;
141 caspar::prec_timer wait_timer_;
143 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
144 core::interaction_sink* sink_;
146 boost::thread thread_;
147 tbb::atomic<bool> is_running_;
148 tbb::atomic<int64_t> current_presentation_age_;
150 ffmpeg::filter filter_;
153 const configuration& config,
154 const core::video_format_desc& format_desc,
156 core::interaction_sink* sink)
158 , format_desc_(format_desc)
159 , channel_index_(channel_index)
162 , filter_([&]() -> ffmpeg::filter
164 const auto sample_aspect_ratio =
165 boost::rational<int>(
166 format_desc.square_width,
167 format_desc.square_height) /
168 boost::rational<int>(
172 return ffmpeg::filter(
175 boost::rational<int>(format_desc.duration, format_desc.time_scale),
176 boost::rational<int>(format_desc.time_scale, format_desc.duration),
180 format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "format=pix_fmts=gbrp,YADIF=1:-1");
183 if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
185 // Use default values which are 4:3.
189 if (config_.aspect == configuration::aspect_ratio::aspect_16_9)
190 square_width_ = (format_desc.height*16)/9;
191 else if (config_.aspect == configuration::aspect_ratio::aspect_4_3)
192 square_width_ = (format_desc.height*4)/3;
195 frame_buffer_.set_capacity(1);
197 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
198 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
199 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
200 graph_->set_text(print());
201 diagnostics::register_graph(graph_);
203 /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
204 std::vector<DISPLAY_DEVICE> displayDevices;
205 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
206 displayDevices.push_back(d_device);
208 if(config_.screen_index >= displayDevices.size())
209 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
211 DEVMODE devmode = {};
212 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
213 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
215 screen_x_ = devmode.dmPosition.x;
216 screen_y_ = devmode.dmPosition.y;
217 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
218 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;*/
221 screen_width_ = square_width_;
222 screen_height_ = square_height_;
224 polling_event_ = false;
226 current_presentation_age_ = 0;
227 thread_ = boost::thread([this]{run();});
233 frame_buffer_.try_push(core::const_frame::empty());
239 auto window_style = config_.borderless
242 ? sf::Style::Resize | sf::Style::Close
243 : sf::Style::Fullscreen);
244 window_.create(sf::VideoMode(screen_width_, screen_height_, 32), u8(print()), window_style);
245 window_.setMouseCursorVisible(config_.interactive);
246 window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
247 window_.setSize(sf::Vector2u(screen_width_, screen_height_));
250 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
251 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
253 if(!GLEW_VERSION_2_1)
254 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
256 GL(glEnable(GL_TEXTURE_2D));
257 GL(glDisable(GL_DEPTH_TEST));
258 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
259 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
260 GL(glLoadIdentity());
264 GL(glGenTextures(1, &texture_));
265 GL(glBindTexture(GL_TEXTURE_2D, texture_));
266 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
267 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
268 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
269 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
270 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
271 GL(glBindTexture(GL_TEXTURE_2D, 0));
273 GL(glGenBuffers(2, pbos_.data()));
275 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
276 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
277 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
278 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
279 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
281 window_.setVerticalSyncEnabled(config_.vsync);
285 CASPAR_LOG(info) << print() << " Enabled vsync.";
292 glDeleteTextures(1, &texture_);
294 for (auto& pbo : pbos_)
297 glDeleteBuffers(1, &pbo);
303 ensure_gpf_handler_installed_for_thread("screen-consumer-thread");
313 auto poll_event = [this](sf::Event& e)
315 polling_event_ = true;
318 polling_event_ = false;
320 return window_.pollEvent(e);
326 if (e.type == sf::Event::Resized)
328 else if (e.type == sf::Event::Closed)
330 else if (config_.interactive && sink_)
334 case sf::Event::MouseMoved:
336 auto& mouse_move = e.mouseMove;
337 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
339 static_cast<double>(mouse_move.x) / screen_width_,
340 static_cast<double>(mouse_move.y) / screen_height_));
343 case sf::Event::MouseButtonPressed:
344 case sf::Event::MouseButtonReleased:
346 auto& mouse_button = e.mouseButton;
347 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
349 static_cast<double>(mouse_button.x) / screen_width_,
350 static_cast<double>(mouse_button.y) / screen_height_,
351 static_cast<int>(mouse_button.button),
352 e.type == sf::Event::MouseButtonPressed));
355 case sf::Event::MouseWheelMoved:
357 auto& wheel_moved = e.mouseWheel;
358 sink_->on_interaction(spl::make_shared<core::mouse_wheel_event>(
360 static_cast<double>(wheel_moved.x) / screen_width_,
361 static_cast<double>(wheel_moved.y) / screen_height_,
369 core::const_frame frame;
370 frame_buffer_.pop(frame);
372 render_and_draw_frame(frame);
374 /*perf_timer_.restart();
376 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
380 current_presentation_age_ = frame.get_age_millis();
381 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
382 tick_timer_.restart();
386 CASPAR_LOG_CURRENT_EXCEPTION();
395 CASPAR_LOG_CURRENT_EXCEPTION();
399 void try_sleep_almost_until_vblank()
401 static const double THRESHOLD = 0.003;
402 double threshold = config_.vsync ? THRESHOLD : 0.0;
404 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
406 wait_timer_.tick(frame_time - threshold);
409 void wait_for_vblank_and_display()
411 try_sleep_almost_until_vblank();
413 // Make sure that the next tick measures the duration from this point in time.
414 wait_timer_.tick(0.0);
417 spl::shared_ptr<AVFrame> get_av_frame()
419 auto av_frame = ffmpeg::create_frame();
421 av_frame->linesize[0] = format_desc_.width*4;
422 av_frame->format = PIX_FMT_BGRA;
423 av_frame->width = format_desc_.width;
424 av_frame->height = format_desc_.height;
425 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
426 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
427 av_frame->pts = pts_++;
432 void render_and_draw_frame(core::const_frame input_frame)
434 if(static_cast<size_t>(input_frame.image_data().size()) != format_desc_.size)
437 if(screen_width_ == 0 && screen_height_ == 0)
440 perf_timer_.restart();
441 auto av_frame = get_av_frame();
442 av_frame->data[0] = const_cast<uint8_t*>(input_frame.image_data().begin());
444 filter_.push(av_frame);
445 auto frame = filter_.poll();
450 if (!filter_.is_double_rate())
452 render(spl::make_shared_ptr(frame));
453 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
455 wait_for_vblank_and_display(); // progressive frame
459 render(spl::make_shared_ptr(frame));
460 double perf_elapsed = perf_timer_.elapsed();
462 wait_for_vblank_and_display(); // field1
464 perf_timer_.restart();
465 frame = filter_.poll();
466 render(spl::make_shared_ptr(frame));
467 perf_elapsed += perf_timer_.elapsed();
468 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
470 wait_for_vblank_and_display(); // field2
474 void render(spl::shared_ptr<AVFrame> av_frame)
476 CASPAR_LOG_CALL(trace) << "screen_consumer::render() <- " << print();
477 GL(glBindTexture(GL_TEXTURE_2D, texture_));
479 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
480 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
482 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
483 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
485 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
490 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
492 for(int n = r.begin(); n != r.end(); ++n)
493 aligned_memshfl(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4, 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);
498 fast_memcpy(ptr, av_frame->data[0], format_desc_.size);
501 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
504 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
506 GL(glClear(GL_COLOR_BUFFER_BIT));
508 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
509 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
510 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
511 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
514 GL(glBindTexture(GL_TEXTURE_2D, 0));
516 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
520 std::future<bool> send(core::const_frame frame)
522 if(!frame_buffer_.try_push(frame) && !polling_event_)
523 graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
525 return make_ready_future(is_running_.load());
528 std::wstring channel_and_format() const
530 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
533 std::wstring print() const
535 return config_.name + L" " + channel_and_format();
538 void calculate_aspect()
542 screen_height_ = window_.getSize().y;
543 screen_width_ = window_.getSize().x;
546 GL(glViewport(0, 0, screen_width_, screen_height_));
548 std::pair<float, float> target_ratio = None();
549 if (config_.stretch == screen::stretch::fill)
550 target_ratio = Fill();
551 else if (config_.stretch == screen::stretch::uniform)
552 target_ratio = Uniform();
553 else if (config_.stretch == screen::stretch::uniform_to_fill)
554 target_ratio = UniformToFill();
556 width_ = target_ratio.first;
557 height_ = target_ratio.second;
560 std::pair<float, float> None()
562 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
563 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
565 return std::make_pair(width, height);
568 std::pair<float, float> Uniform()
570 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
571 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
572 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
574 return std::make_pair(width, height);
577 std::pair<float, float> Fill()
579 return std::make_pair(1.0f, 1.0f);
582 std::pair<float, float> UniformToFill()
584 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
585 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
586 float r_inv = 1.0f/std::min(wr, hr);
588 float width = wr*r_inv;
589 float height = hr*r_inv;
591 return std::make_pair(width, height);
596 struct screen_consumer_proxy : public core::frame_consumer
598 core::monitor::subject monitor_subject_;
599 const configuration config_;
600 std::unique_ptr<screen_consumer> consumer_;
601 core::interaction_sink* sink_;
605 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
613 void initialize(const core::video_format_desc& format_desc, const core::audio_channel_layout&, int channel_index) override
616 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
619 int64_t presentation_frame_age_millis() const override
621 return consumer_ ? static_cast<int64_t>(consumer_->current_presentation_age_) : 0;
624 std::future<bool> send(core::const_frame frame) override
626 return consumer_->send(frame);
629 std::wstring print() const override
631 return consumer_ ? consumer_->print() : L"[screen_consumer]";
634 std::wstring name() const override
639 boost::property_tree::wptree info() const override
641 boost::property_tree::wptree info;
642 info.add(L"type", L"screen");
643 info.add(L"key-only", config_.key_only);
644 info.add(L"windowed", config_.windowed);
645 info.add(L"auto-deinterlace", config_.auto_deinterlace);
646 info.add(L"vsync", config_.vsync);
650 bool has_synchronization_clock() const override
655 int buffer_depth() const override
660 int index() const override
662 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
665 core::monitor::subject& monitor_output()
667 return monitor_subject_;
671 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
673 sink.short_description(L"Displays the contents of a channel on screen using OpenGL.");
676 L"{[screen_index:int]|1} "
677 L"{[fullscreen:FULLSCREEN]} "
678 L"{[borderless:BORDERLESS]} "
679 L"{[key_only:KEY_ONLY]} "
680 L"{[non_interactive:NON_INTERACTIVE]} "
681 L"{[no_auto_deinterlace:NO_AUTO_DEINTERLACE]} "
682 L"{NAME [name:string]}");
683 sink.para()->text(L"Displays the contents of a channel on screen using OpenGL.");
685 ->item(L"screen_index", L"Determines which screen the channel should be displayed on. Defaults to 1.")
686 ->item(L"fullscreen", L"If specified opens the window in fullscreen.")
687 ->item(L"borderless", L"Makes the window appear without any window decorations.")
688 ->item(L"key_only", L"Only displays the alpha channel of the video channel if specified.")
689 ->item(L"non_interactive", L"If specified does not send mouse input to producers on the video channel.")
690 ->item(L"no_auto_deinterlace", L"If the video mode of the channel is an interlaced mode, specifying this will turn of deinterlacing.")
691 ->item(L"name", L"Optionally specifies a name of the window to show.");
692 sink.para()->text(L"Examples:");
693 sink.example(L">> ADD 1 SCREEN", L"opens a screen consumer on the default screen.");
694 sink.example(L">> ADD 1 SCREEN 2", L"opens a screen consumer on the screen 2.");
695 sink.example(L">> ADD 1 SCREEN 1 FULLSCREEN", L"opens a screen consumer in fullscreen on screen 1.");
696 sink.example(L">> ADD 1 SCREEN 1 BORDERLESS", L"opens a screen consumer without borders/window decorations on screen 1.");
699 spl::shared_ptr<core::frame_consumer> create_consumer(
700 const std::vector<std::wstring>& params, core::interaction_sink* sink, std::vector<spl::shared_ptr<core::video_channel>> channels)
702 if (params.size() < 1 || !boost::iequals(params.at(0), L"SCREEN"))
703 return core::frame_consumer::empty();
705 configuration config;
707 if (params.size() > 1)
708 config.screen_index = boost::lexical_cast<int>(params.at(1));
710 config.windowed = !contains_param(L"FULLSCREEN", params);
711 config.key_only = contains_param(L"KEY_ONLY", params);
712 config.interactive = !contains_param(L"NON_INTERACTIVE", params);
713 config.auto_deinterlace = !contains_param(L"NO_AUTO_DEINTERLACE", params);
714 config.borderless = contains_param(L"BORDERLESS", params);
716 if (contains_param(L"NAME", params))
717 config.name = get_param(L"NAME", params);
719 return spl::make_shared<screen_consumer_proxy>(config, sink);
722 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(
723 const boost::property_tree::wptree& ptree, core::interaction_sink* sink, std::vector<spl::shared_ptr<core::video_channel>> channels)
725 configuration config;
726 config.name = ptree.get(L"name", config.name);
727 config.screen_index = ptree.get(L"device", config.screen_index + 1) - 1;
728 config.windowed = ptree.get(L"windowed", config.windowed);
729 config.key_only = ptree.get(L"key-only", config.key_only);
730 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
731 config.vsync = ptree.get(L"vsync", config.vsync);
732 config.interactive = ptree.get(L"interactive", config.interactive);
733 config.borderless = ptree.get(L"borderless", config.borderless);
735 auto stretch_str = ptree.get(L"stretch", L"default");
736 if(stretch_str == L"uniform")
737 config.stretch = screen::stretch::uniform;
738 else if(stretch_str == L"uniform_to_fill")
739 config.stretch = screen::stretch::uniform_to_fill;
741 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
742 if(aspect_str == L"16:9")
743 config.aspect = configuration::aspect_ratio::aspect_16_9;
744 else if(aspect_str == L"4:3")
745 config.aspect = configuration::aspect_ratio::aspect_4_3;
747 return spl::make_shared<screen_consumer_proxy>(config, sink);