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>
39 //#include <windows.h>
41 #include <ffmpeg/producer/filter/filter.h>
43 #include <core/video_format.h>
44 #include <core/frame/frame.h>
45 #include <core/consumer/frame_consumer.h>
46 #include <core/interaction/interaction_sink.h>
48 #include <boost/circular_buffer.hpp>
49 #include <boost/lexical_cast.hpp>
50 #include <boost/property_tree/ptree.hpp>
51 #include <boost/thread.hpp>
52 #include <boost/algorithm/string.hpp>
54 #include <tbb/atomic.h>
55 #include <tbb/concurrent_queue.h>
56 #include <tbb/parallel_for.h>
64 #pragma warning (push)
65 #pragma warning (disable : 4244)
69 #define __STDC_CONSTANT_MACROS
70 #define __STDC_LIMIT_MACROS
71 #include <libavcodec/avcodec.h>
72 #include <libavutil/imgutils.h>
78 namespace caspar { namespace screen {
90 enum class aspect_ratio
97 std::wstring name = L"ogl";
99 screen::stretch stretch = screen::stretch::fill;
100 bool windowed = true;
101 bool auto_deinterlace = true;
102 bool key_only = false;
103 aspect_ratio aspect = aspect_ratio::aspect_invalid;
105 bool interactive = true;
108 struct screen_consumer : boost::noncopyable
110 const configuration config_;
111 core::video_format_desc format_desc_;
115 std::vector<GLuint> pbos_ = std::vector<GLuint> { 0, 0 };
121 int screen_width_ = format_desc_.width;
122 int screen_height_ = format_desc_.height;
123 int square_width_ = format_desc_.square_width;
124 int square_height_ = format_desc_.square_height;
128 spl::shared_ptr<diagnostics::graph> graph_;
129 caspar::timer perf_timer_;
130 caspar::timer tick_timer_;
132 caspar::prec_timer wait_timer_;
134 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
135 core::interaction_sink* sink_;
137 boost::thread thread_;
138 tbb::atomic<bool> is_running_;
140 ffmpeg::filter filter_;
143 const configuration& config,
144 const core::video_format_desc& format_desc,
146 core::interaction_sink* sink)
148 , format_desc_(format_desc)
149 , channel_index_(channel_index)
151 , filter_([&]() -> ffmpeg::filter
153 const auto sample_aspect_ratio =
154 boost::rational<int>(
155 format_desc.square_width,
156 format_desc.square_height) /
157 boost::rational<int>(
161 return ffmpeg::filter(
164 boost::rational<int>(format_desc.duration, format_desc.time_scale),
165 boost::rational<int>(format_desc.time_scale, format_desc.duration),
169 format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "YADIF=1:-1");
172 if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
174 // Use default values which are 4:3.
178 if (config_.aspect == configuration::aspect_ratio::aspect_16_9)
179 square_width_ = (format_desc.height*16)/9;
180 else if (config_.aspect == configuration::aspect_ratio::aspect_4_3)
181 square_width_ = (format_desc.height*4)/3;
184 frame_buffer_.set_capacity(1);
186 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
187 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
188 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
189 graph_->set_text(print());
190 diagnostics::register_graph(graph_);
192 /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
193 std::vector<DISPLAY_DEVICE> displayDevices;
194 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
195 displayDevices.push_back(d_device);
197 if(config_.screen_index >= displayDevices.size())
198 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
200 DEVMODE devmode = {};
201 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
202 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
204 screen_x_ = devmode.dmPosition.x;
205 screen_y_ = devmode.dmPosition.y;
206 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
207 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;*/
210 screen_width_ = square_width_;
211 screen_height_ = square_height_;
214 thread_ = boost::thread([this]{run();});
220 frame_buffer_.try_push(core::const_frame::empty());
226 window_.create(sf::VideoMode(screen_width_, screen_height_, 32), u8(L"Screen consumer " + channel_and_format()), config_.windowed ? sf::Style::Resize | sf::Style::Close : sf::Style::Fullscreen);
227 window_.setMouseCursorVisible(config_.interactive);
228 window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
229 window_.setSize(sf::Vector2u(screen_width_, screen_height_));
232 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
233 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
235 if(!GLEW_VERSION_2_1)
236 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
238 GL(glEnable(GL_TEXTURE_2D));
239 GL(glDisable(GL_DEPTH_TEST));
240 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
241 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
242 GL(glLoadIdentity());
246 GL(glGenTextures(1, &texture_));
247 GL(glBindTexture(GL_TEXTURE_2D, texture_));
248 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
249 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
250 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
251 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
252 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
253 GL(glBindTexture(GL_TEXTURE_2D, 0));
255 GL(glGenBuffers(2, pbos_.data()));
257 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
258 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
259 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
260 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
261 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
263 window_.setVerticalSyncEnabled(config_.vsync);
267 CASPAR_LOG(info) << print() << " Enabled vsync.";
269 /*auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
270 if(wglSwapIntervalEXT)
274 wglSwapIntervalEXT(1);
275 CASPAR_LOG(info) << print() << " Enabled vsync.";
278 wglSwapIntervalEXT(0);
281 CASPAR_LOG(info) << print() << " Successfully Initialized.";
287 glDeleteTextures(1, &texture_);
289 for (auto& pbo : pbos_)
292 glDeleteBuffers(1, &pbo);
307 while(window_.pollEvent(e))
309 if (e.type == sf::Event::Resized)
311 else if (e.type == sf::Event::Closed)
313 else if (config_.interactive && sink_)
317 case sf::Event::MouseMoved:
319 auto& mouse_move = e.mouseMove;
320 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
322 static_cast<double>(mouse_move.x) / screen_width_,
323 static_cast<double>(mouse_move.y) / screen_height_));
326 case sf::Event::MouseButtonPressed:
327 case sf::Event::MouseButtonReleased:
329 auto& mouse_button = e.mouseButton;
330 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
332 static_cast<double>(mouse_button.x) / screen_width_,
333 static_cast<double>(mouse_button.y) / screen_height_,
334 static_cast<int>(mouse_button.button),
335 e.type == sf::Event::MouseButtonPressed));
338 case sf::Event::MouseWheelMoved:
340 auto& wheel_moved = e.mouseWheel;
341 sink_->on_interaction(spl::make_shared<core::mouse_wheel_event>(
343 static_cast<double>(wheel_moved.x) / screen_width_,
344 static_cast<double>(wheel_moved.y) / screen_height_,
352 auto frame = core::const_frame::empty();
353 frame_buffer_.pop(frame);
355 render_and_draw_frame(frame);
357 /*perf_timer_.restart();
359 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
363 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
364 tick_timer_.restart();
368 CASPAR_LOG_CURRENT_EXCEPTION();
377 CASPAR_LOG_CURRENT_EXCEPTION();
381 void try_sleep_almost_until_vblank()
383 static const double THRESHOLD = 0.003;
384 double threshold = config_.vsync ? THRESHOLD : 0.0;
386 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
388 wait_timer_.tick(frame_time - threshold);
391 void wait_for_vblank_and_display()
393 try_sleep_almost_until_vblank();
395 // Make sure that the next tick measures the duration from this point in time.
396 wait_timer_.tick(0.0);
399 spl::shared_ptr<AVFrame> get_av_frame()
401 spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
402 avcodec_get_frame_defaults(av_frame.get());
404 av_frame->linesize[0] = format_desc_.width*4;
405 av_frame->format = PIX_FMT_BGRA;
406 av_frame->width = format_desc_.width;
407 av_frame->height = format_desc_.height;
408 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
409 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
414 void render_and_draw_frame(core::const_frame frame)
416 if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
419 if(screen_width_ == 0 && screen_height_ == 0)
422 perf_timer_.restart();
423 auto av_frame = get_av_frame();
424 av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
426 filter_.push(av_frame);
427 auto frames = filter_.poll_all();
432 if (frames.size() == 1)
435 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
437 wait_for_vblank_and_display(); // progressive frame
439 else if (frames.size() == 2)
442 double perf_elapsed = perf_timer_.elapsed();
444 wait_for_vblank_and_display(); // field1
446 perf_timer_.restart();
448 perf_elapsed += perf_timer_.elapsed();
449 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
451 wait_for_vblank_and_display(); // field2
455 void render(spl::shared_ptr<AVFrame> av_frame)
457 GL(glBindTexture(GL_TEXTURE_2D, texture_));
459 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
460 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
462 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
463 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
465 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
470 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
472 for(int n = r.begin(); n != r.end(); ++n)
473 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);
478 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
480 for(int n = r.begin(); n != r.end(); ++n)
481 A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
485 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
488 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
490 GL(glClear(GL_COLOR_BUFFER_BIT));
492 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
493 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
494 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
495 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
498 GL(glBindTexture(GL_TEXTURE_2D, 0));
500 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
504 std::future<bool> send(core::const_frame frame)
506 if(!frame_buffer_.try_push(frame))
507 graph_->set_tag("dropped-frame");
509 return make_ready_future(is_running_.load());
512 std::wstring channel_and_format() const
514 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
517 std::wstring print() const
519 return config_.name + channel_and_format();
522 void calculate_aspect()
526 screen_height_ = window_.getSize().y;
527 screen_width_ = window_.getSize().x;
530 GL(glViewport(0, 0, screen_width_, screen_height_));
532 std::pair<float, float> target_ratio = None();
533 if (config_.stretch == screen::stretch::fill)
534 target_ratio = Fill();
535 else if (config_.stretch == screen::stretch::uniform)
536 target_ratio = Uniform();
537 else if (config_.stretch == screen::stretch::uniform_to_fill)
538 target_ratio = UniformToFill();
540 width_ = target_ratio.first;
541 height_ = target_ratio.second;
544 std::pair<float, float> None()
546 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
547 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
549 return std::make_pair(width, height);
552 std::pair<float, float> Uniform()
554 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
555 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
556 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
558 return std::make_pair(width, height);
561 std::pair<float, float> Fill()
563 return std::make_pair(1.0f, 1.0f);
566 std::pair<float, float> UniformToFill()
568 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
569 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
570 float r_inv = 1.0f/std::min(wr, hr);
572 float width = wr*r_inv;
573 float height = hr*r_inv;
575 return std::make_pair(width, height);
580 struct screen_consumer_proxy : public core::frame_consumer
582 core::monitor::subject monitor_subject_;
583 const configuration config_;
584 std::unique_ptr<screen_consumer> consumer_;
585 core::interaction_sink* sink_;
589 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
597 void initialize(const core::video_format_desc& format_desc, int channel_index) override
600 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
603 std::future<bool> send(core::const_frame frame) override
605 return consumer_->send(frame);
608 std::wstring print() const override
610 return consumer_ ? consumer_->print() : L"[screen_consumer]";
613 std::wstring name() const override
618 boost::property_tree::wptree info() const override
620 boost::property_tree::wptree info;
621 info.add(L"type", L"screen");
622 info.add(L"key-only", config_.key_only);
623 info.add(L"windowed", config_.windowed);
624 info.add(L"auto-deinterlace", config_.auto_deinterlace);
628 bool has_synchronization_clock() const override
633 int buffer_depth() const override
638 int index() const override
640 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
643 core::monitor::subject& monitor_output()
645 return monitor_subject_;
649 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink* sink)
651 if (params.size() < 1 || !boost::iequals(params.at(0), L"SCREEN"))
652 return core::frame_consumer::empty();
654 configuration config;
656 if (params.size() > 1)
657 config.screen_index = boost::lexical_cast<int>(params.at(1));
659 config.windowed = !contains_param(L"FULLSCREEN", params);
660 config.key_only = contains_param(L"KEY_ONLY", params);
661 config.interactive = !contains_param(L"NON_INTERACTIVE", params);
662 config.auto_deinterlace = !contains_param(L"NO_AUTO_DEINTERLACE", params);
664 if (contains_param(L"NAME", params))
665 config.name = get_param(L"NAME", params);
667 return spl::make_shared<screen_consumer_proxy>(config, sink);
670 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink)
672 configuration config;
673 config.name = ptree.get(L"name", config.name);
674 config.screen_index = ptree.get(L"device", config.screen_index + 1) - 1;
675 config.windowed = ptree.get(L"windowed", config.windowed);
676 config.key_only = ptree.get(L"key-only", config.key_only);
677 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
678 config.vsync = ptree.get(L"vsync", config.vsync);
679 config.interactive = ptree.get(L"interactive", config.interactive);
681 auto stretch_str = ptree.get(L"stretch", L"default");
682 if(stretch_str == L"uniform")
683 config.stretch = screen::stretch::uniform;
684 else if(stretch_str == L"uniform_to_fill")
685 config.stretch = screen::stretch::uniform_to_fill;
687 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
688 if(aspect_str == L"16:9")
689 config.aspect = configuration::aspect_ratio::aspect_16_9;
690 else if(aspect_str == L"4:3")
691 config.aspect = configuration::aspect_ratio::aspect_4_3;
693 return spl::make_shared<screen_consumer_proxy>(config, sink);