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/utf.h>
34 #include <common/prec_timer.h>
35 #include <common/future.h>
36 #include <common/timer.h>
37 #include <common/param.h>
38 #include <common/os/general_protection_fault.h>
40 //#include <windows.h>
42 #include <ffmpeg/producer/filter/filter.h>
44 #include <core/video_format.h>
45 #include <core/frame/frame.h>
46 #include <core/consumer/frame_consumer.h>
47 #include <core/interaction/interaction_sink.h>
48 #include <core/help/help_sink.h>
49 #include <core/help/help_repository.h>
51 #include <boost/circular_buffer.hpp>
52 #include <boost/lexical_cast.hpp>
53 #include <boost/property_tree/ptree.hpp>
54 #include <boost/thread.hpp>
55 #include <boost/algorithm/string.hpp>
57 #include <tbb/atomic.h>
58 #include <tbb/concurrent_queue.h>
59 #include <tbb/parallel_for.h>
67 #pragma warning (push)
68 #pragma warning (disable : 4244)
72 #define __STDC_CONSTANT_MACROS
73 #define __STDC_LIMIT_MACROS
74 #include <libavcodec/avcodec.h>
75 #include <libavutil/imgutils.h>
81 namespace caspar { namespace screen {
93 enum class aspect_ratio
100 std::wstring name = L"ogl";
101 int screen_index = 0;
102 screen::stretch stretch = screen::stretch::fill;
103 bool windowed = true;
104 bool auto_deinterlace = true;
105 bool key_only = false;
106 aspect_ratio aspect = aspect_ratio::aspect_invalid;
108 bool interactive = true;
109 bool borderless = false;
112 struct screen_consumer : boost::noncopyable
114 const configuration config_;
115 core::video_format_desc format_desc_;
119 std::vector<GLuint> pbos_ = std::vector<GLuint> { 0, 0 };
125 int screen_width_ = format_desc_.width;
126 int screen_height_ = format_desc_.height;
127 int square_width_ = format_desc_.square_width;
128 int square_height_ = format_desc_.square_height;
132 spl::shared_ptr<diagnostics::graph> graph_;
133 caspar::timer perf_timer_;
134 caspar::timer tick_timer_;
136 caspar::prec_timer wait_timer_;
138 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
139 core::interaction_sink* sink_;
141 boost::thread thread_;
142 tbb::atomic<bool> is_running_;
143 tbb::atomic<int64_t> current_presentation_age_;
145 ffmpeg::filter filter_;
148 const configuration& config,
149 const core::video_format_desc& format_desc,
151 core::interaction_sink* sink)
153 , format_desc_(format_desc)
154 , channel_index_(channel_index)
156 , filter_([&]() -> ffmpeg::filter
158 const auto sample_aspect_ratio =
159 boost::rational<int>(
160 format_desc.square_width,
161 format_desc.square_height) /
162 boost::rational<int>(
166 return ffmpeg::filter(
169 boost::rational<int>(format_desc.duration, format_desc.time_scale),
170 boost::rational<int>(format_desc.time_scale, format_desc.duration),
174 format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "YADIF=1:-1");
177 if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
179 // Use default values which are 4:3.
183 if (config_.aspect == configuration::aspect_ratio::aspect_16_9)
184 square_width_ = (format_desc.height*16)/9;
185 else if (config_.aspect == configuration::aspect_ratio::aspect_4_3)
186 square_width_ = (format_desc.height*4)/3;
189 frame_buffer_.set_capacity(1);
191 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
192 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
193 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
194 graph_->set_text(print());
195 diagnostics::register_graph(graph_);
197 /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
198 std::vector<DISPLAY_DEVICE> displayDevices;
199 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
200 displayDevices.push_back(d_device);
202 if(config_.screen_index >= displayDevices.size())
203 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
205 DEVMODE devmode = {};
206 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
207 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
209 screen_x_ = devmode.dmPosition.x;
210 screen_y_ = devmode.dmPosition.y;
211 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
212 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;*/
215 screen_width_ = square_width_;
216 screen_height_ = square_height_;
219 current_presentation_age_ = 0;
220 thread_ = boost::thread([this]{run();});
226 frame_buffer_.try_push(core::const_frame::empty());
232 auto window_style = config_.borderless
235 ? sf::Style::Resize | sf::Style::Close
236 : sf::Style::Fullscreen);
237 window_.create(sf::VideoMode(screen_width_, screen_height_, 32), u8(L"Screen consumer " + channel_and_format()), window_style);
238 window_.setMouseCursorVisible(config_.interactive);
239 window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
240 window_.setSize(sf::Vector2u(screen_width_, screen_height_));
243 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
244 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
246 if(!GLEW_VERSION_2_1)
247 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
249 GL(glEnable(GL_TEXTURE_2D));
250 GL(glDisable(GL_DEPTH_TEST));
251 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
252 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
253 GL(glLoadIdentity());
257 GL(glGenTextures(1, &texture_));
258 GL(glBindTexture(GL_TEXTURE_2D, texture_));
259 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
260 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
261 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
262 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
263 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
264 GL(glBindTexture(GL_TEXTURE_2D, 0));
266 GL(glGenBuffers(2, pbos_.data()));
268 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
269 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
270 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
271 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
272 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
274 window_.setVerticalSyncEnabled(config_.vsync);
278 CASPAR_LOG(info) << print() << " Enabled vsync.";
280 /*auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
281 if(wglSwapIntervalEXT)
285 wglSwapIntervalEXT(1);
286 CASPAR_LOG(info) << print() << " Enabled vsync.";
289 wglSwapIntervalEXT(0);
292 CASPAR_LOG(info) << print() << " Successfully Initialized.";
298 glDeleteTextures(1, &texture_);
300 for (auto& pbo : pbos_)
303 glDeleteBuffers(1, &pbo);
309 ensure_gpf_handler_installed_for_thread("screen-consumer-thread");
320 while(window_.pollEvent(e))
322 if (e.type == sf::Event::Resized)
324 else if (e.type == sf::Event::Closed)
326 else if (config_.interactive && sink_)
330 case sf::Event::MouseMoved:
332 auto& mouse_move = e.mouseMove;
333 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
335 static_cast<double>(mouse_move.x) / screen_width_,
336 static_cast<double>(mouse_move.y) / screen_height_));
339 case sf::Event::MouseButtonPressed:
340 case sf::Event::MouseButtonReleased:
342 auto& mouse_button = e.mouseButton;
343 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
345 static_cast<double>(mouse_button.x) / screen_width_,
346 static_cast<double>(mouse_button.y) / screen_height_,
347 static_cast<int>(mouse_button.button),
348 e.type == sf::Event::MouseButtonPressed));
351 case sf::Event::MouseWheelMoved:
353 auto& wheel_moved = e.mouseWheel;
354 sink_->on_interaction(spl::make_shared<core::mouse_wheel_event>(
356 static_cast<double>(wheel_moved.x) / screen_width_,
357 static_cast<double>(wheel_moved.y) / screen_height_,
365 core::const_frame frame;
366 frame_buffer_.pop(frame);
368 render_and_draw_frame(frame);
370 /*perf_timer_.restart();
372 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
376 current_presentation_age_ = frame.get_age_millis();
377 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
378 tick_timer_.restart();
382 CASPAR_LOG_CURRENT_EXCEPTION();
391 CASPAR_LOG_CURRENT_EXCEPTION();
395 void try_sleep_almost_until_vblank()
397 static const double THRESHOLD = 0.003;
398 double threshold = config_.vsync ? THRESHOLD : 0.0;
400 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
402 wait_timer_.tick(frame_time - threshold);
405 void wait_for_vblank_and_display()
407 try_sleep_almost_until_vblank();
409 // Make sure that the next tick measures the duration from this point in time.
410 wait_timer_.tick(0.0);
413 spl::shared_ptr<AVFrame> get_av_frame()
415 spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
416 avcodec_get_frame_defaults(av_frame.get());
418 av_frame->linesize[0] = format_desc_.width*4;
419 av_frame->format = PIX_FMT_BGRA;
420 av_frame->width = format_desc_.width;
421 av_frame->height = format_desc_.height;
422 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
423 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
428 void render_and_draw_frame(core::const_frame frame)
430 if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
433 if(screen_width_ == 0 && screen_height_ == 0)
436 perf_timer_.restart();
437 auto av_frame = get_av_frame();
438 av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
440 filter_.push(av_frame);
441 auto frames = filter_.poll_all();
446 if (frames.size() == 1)
449 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
451 wait_for_vblank_and_display(); // progressive frame
453 else if (frames.size() == 2)
456 double perf_elapsed = perf_timer_.elapsed();
458 wait_for_vblank_and_display(); // field1
460 perf_timer_.restart();
462 perf_elapsed += perf_timer_.elapsed();
463 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
465 wait_for_vblank_and_display(); // field2
469 void render(spl::shared_ptr<AVFrame> av_frame)
471 GL(glBindTexture(GL_TEXTURE_2D, texture_));
473 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
474 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
476 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
477 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
479 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
484 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
486 for(int n = r.begin(); n != r.end(); ++n)
487 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);
492 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
494 for(int n = r.begin(); n != r.end(); ++n)
495 A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
499 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
502 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
504 GL(glClear(GL_COLOR_BUFFER_BIT));
506 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
507 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
508 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
509 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
512 GL(glBindTexture(GL_TEXTURE_2D, 0));
514 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
518 std::future<bool> send(core::const_frame frame)
520 if(!frame_buffer_.try_push(frame))
521 graph_->set_tag("dropped-frame");
523 return make_ready_future(is_running_.load());
526 std::wstring channel_and_format() const
528 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
531 std::wstring print() const
533 return config_.name + channel_and_format();
536 void calculate_aspect()
540 screen_height_ = window_.getSize().y;
541 screen_width_ = window_.getSize().x;
544 GL(glViewport(0, 0, screen_width_, screen_height_));
546 std::pair<float, float> target_ratio = None();
547 if (config_.stretch == screen::stretch::fill)
548 target_ratio = Fill();
549 else if (config_.stretch == screen::stretch::uniform)
550 target_ratio = Uniform();
551 else if (config_.stretch == screen::stretch::uniform_to_fill)
552 target_ratio = UniformToFill();
554 width_ = target_ratio.first;
555 height_ = target_ratio.second;
558 std::pair<float, float> None()
560 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
561 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
563 return std::make_pair(width, height);
566 std::pair<float, float> Uniform()
568 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
569 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
570 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
572 return std::make_pair(width, height);
575 std::pair<float, float> Fill()
577 return std::make_pair(1.0f, 1.0f);
580 std::pair<float, float> UniformToFill()
582 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
583 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
584 float r_inv = 1.0f/std::min(wr, hr);
586 float width = wr*r_inv;
587 float height = hr*r_inv;
589 return std::make_pair(width, height);
594 struct screen_consumer_proxy : public core::frame_consumer
596 core::monitor::subject monitor_subject_;
597 const configuration config_;
598 std::unique_ptr<screen_consumer> consumer_;
599 core::interaction_sink* sink_;
603 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
611 void initialize(const core::video_format_desc& format_desc, int channel_index) override
614 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
617 int64_t presentation_frame_age_millis() const override
619 return consumer_ ? static_cast<int64_t>(consumer_->current_presentation_age_) : 0;
622 std::future<bool> send(core::const_frame frame) override
624 return consumer_->send(frame);
627 std::wstring print() const override
629 return consumer_ ? consumer_->print() : L"[screen_consumer]";
632 std::wstring name() const override
637 boost::property_tree::wptree info() const override
639 boost::property_tree::wptree info;
640 info.add(L"type", L"screen");
641 info.add(L"key-only", config_.key_only);
642 info.add(L"windowed", config_.windowed);
643 info.add(L"auto-deinterlace", config_.auto_deinterlace);
644 info.add(L"vsync", config_.vsync);
648 bool has_synchronization_clock() const override
653 int buffer_depth() const override
658 int index() const override
660 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
663 core::monitor::subject& monitor_output()
665 return monitor_subject_;
669 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
671 sink.short_description(L"Displays the contents of a channel on screen using OpenGL.");
674 L"{[screen_index:int]|1} "
675 L"{[fullscreen:FULLSCREEN]} "
676 L"{[borderless:BORDERLESS]} "
677 L"{[key_only:KEY_ONLY]} "
678 L"{[non_interactive:NON_INTERACTIVE]} "
679 L"{[no_auto_deinterlace:NO_AUTO_DEINTERLACE]} "
680 L"{NAME [name:string]}");
681 sink.para()->text(L"Displays the contents of a channel on screen using OpenGL.");
683 ->item(L"screen_index", L"Determines which screen the channel should be displayed on. Defaults to 1.")
684 ->item(L"fullscreen", L"If specified opens the window in fullscreen.")
685 ->item(L"borderless", L"Makes the window appear without any window decorations.")
686 ->item(L"key_only", L"Only displays the alpha channel of the video channel if specified.")
687 ->item(L"non_interactive", L"If specified does not send mouse input to producers on the video channel.")
688 ->item(L"no_auto_deinterlace", L"If the video mode of the channel is an interlaced mode, specifying this will turn of deinterlacing.")
689 ->item(L"name", L"Optionally specifies a name of the window to show.");
690 sink.para()->text(L"Examples:");
691 sink.example(L">> ADD 1 SCREEN", L"opens a screen consumer on the default screen.");
692 sink.example(L">> ADD 1 SCREEN 2", L"opens a screen consumer on the screen 2.");
693 sink.example(L">> ADD 1 SCREEN 1 FULLSCREEN", L"opens a screen consumer in fullscreen on screen 1.");
694 sink.example(L">> ADD 1 SCREEN 1 BORDERLESS", L"opens a screen consumer without borders/window decorations on screen 1.");
697 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink* sink)
699 if (params.size() < 1 || !boost::iequals(params.at(0), L"SCREEN"))
700 return core::frame_consumer::empty();
702 configuration config;
704 if (params.size() > 1)
705 config.screen_index = boost::lexical_cast<int>(params.at(1));
707 config.windowed = !contains_param(L"FULLSCREEN", params);
708 config.key_only = contains_param(L"KEY_ONLY", params);
709 config.interactive = !contains_param(L"NON_INTERACTIVE", params);
710 config.auto_deinterlace = !contains_param(L"NO_AUTO_DEINTERLACE", params);
711 config.borderless = contains_param(L"BORDERLESS", params);
713 if (contains_param(L"NAME", params))
714 config.name = get_param(L"NAME", params);
716 return spl::make_shared<screen_consumer_proxy>(config, sink);
719 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink)
721 configuration config;
722 config.name = ptree.get(L"name", config.name);
723 config.screen_index = ptree.get(L"device", config.screen_index + 1) - 1;
724 config.windowed = ptree.get(L"windowed", config.windowed);
725 config.key_only = ptree.get(L"key-only", config.key_only);
726 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
727 config.vsync = ptree.get(L"vsync", config.vsync);
728 config.interactive = ptree.get(L"interactive", config.interactive);
729 config.borderless = ptree.get(L"borderless", config.borderless);
731 auto stretch_str = ptree.get(L"stretch", L"default");
732 if(stretch_str == L"uniform")
733 config.stretch = screen::stretch::uniform;
734 else if(stretch_str == L"uniform_to_fill")
735 config.stretch = screen::stretch::uniform_to_fill;
737 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
738 if(aspect_str == L"16:9")
739 config.aspect = configuration::aspect_ratio::aspect_16_9;
740 else if(aspect_str == L"4:3")
741 config.aspect = configuration::aspect_ratio::aspect_4_3;
743 return spl::make_shared<screen_consumer_proxy>(config, sink);