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>
38 //#include <windows.h>
40 #include <ffmpeg/producer/filter/filter.h>
42 #include <core/video_format.h>
43 #include <core/frame/frame.h>
44 #include <core/consumer/frame_consumer.h>
45 #include <core/interaction/interaction_sink.h>
47 #include <boost/circular_buffer.hpp>
48 #include <boost/lexical_cast.hpp>
49 #include <boost/property_tree/ptree.hpp>
50 #include <boost/thread.hpp>
52 #include <tbb/atomic.h>
53 #include <tbb/concurrent_queue.h>
54 #include <tbb/parallel_for.h>
62 #pragma warning (push)
63 #pragma warning (disable : 4244)
67 #define __STDC_CONSTANT_MACROS
68 #define __STDC_LIMIT_MACROS
69 #include <libavcodec/avcodec.h>
70 #include <libavutil/imgutils.h>
76 namespace caspar { namespace screen {
88 enum class aspect_ratio
95 std::wstring name = L"ogl";
97 screen::stretch stretch = screen::stretch::fill;
99 bool auto_deinterlace = true;
100 bool key_only = false;
101 aspect_ratio aspect = aspect_ratio::aspect_invalid;
103 bool interactive = true;
106 struct screen_consumer : boost::noncopyable
108 const configuration config_;
109 core::video_format_desc format_desc_;
113 std::vector<GLuint> pbos_ = std::vector<GLuint> { 0, 0 };
119 int screen_width_ = format_desc_.width;
120 int screen_height_ = format_desc_.height;
121 int square_width_ = format_desc_.square_width;
122 int square_height_ = format_desc_.square_height;
126 spl::shared_ptr<diagnostics::graph> graph_;
127 caspar::timer perf_timer_;
128 caspar::timer tick_timer_;
130 caspar::prec_timer wait_timer_;
132 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
133 core::interaction_sink* sink_;
135 boost::thread thread_;
136 tbb::atomic<bool> is_running_;
138 ffmpeg::filter filter_;
141 const configuration& config,
142 const core::video_format_desc& format_desc,
144 core::interaction_sink* sink)
146 , format_desc_(format_desc)
147 , channel_index_(channel_index)
149 , filter_([&]() -> ffmpeg::filter
151 const auto sample_aspect_ratio =
152 boost::rational<int>(
153 format_desc.square_width,
154 format_desc.square_height) /
155 boost::rational<int>(
159 return ffmpeg::filter(
162 boost::rational<int>(format_desc.duration, format_desc.time_scale),
163 boost::rational<int>(format_desc.time_scale, format_desc.duration),
167 format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "YADIF=1:-1");
170 if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
172 // Use default values which are 4:3.
176 if (config_.aspect == configuration::aspect_ratio::aspect_16_9)
177 square_width_ = (format_desc.height*16)/9;
178 else if (config_.aspect == configuration::aspect_ratio::aspect_4_3)
179 square_width_ = (format_desc.height*4)/3;
182 frame_buffer_.set_capacity(1);
184 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
185 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
186 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
187 graph_->set_text(print());
188 diagnostics::register_graph(graph_);
190 /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
191 std::vector<DISPLAY_DEVICE> displayDevices;
192 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
193 displayDevices.push_back(d_device);
195 if(config_.screen_index >= displayDevices.size())
196 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
198 DEVMODE devmode = {};
199 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
200 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
202 screen_x_ = devmode.dmPosition.x;
203 screen_y_ = devmode.dmPosition.y;
204 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
205 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;*/
208 screen_width_ = square_width_;
209 screen_height_ = square_height_;
212 thread_ = boost::thread([this]{run();});
218 frame_buffer_.try_push(core::const_frame::empty());
224 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);
225 window_.setMouseCursorVisible(config_.interactive);
226 window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
227 window_.setSize(sf::Vector2u(screen_width_, screen_height_));
230 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
231 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
233 if(!GLEW_VERSION_2_1)
234 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
236 GL(glEnable(GL_TEXTURE_2D));
237 GL(glDisable(GL_DEPTH_TEST));
238 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
239 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
240 GL(glLoadIdentity());
244 GL(glGenTextures(1, &texture_));
245 GL(glBindTexture(GL_TEXTURE_2D, texture_));
246 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
247 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
248 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
249 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
250 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
251 GL(glBindTexture(GL_TEXTURE_2D, 0));
253 GL(glGenBuffers(2, pbos_.data()));
255 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
256 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
257 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
258 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
259 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
261 window_.setVerticalSyncEnabled(config_.vsync);
265 CASPAR_LOG(info) << print() << " Enabled vsync.";
267 /*auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
268 if(wglSwapIntervalEXT)
272 wglSwapIntervalEXT(1);
273 CASPAR_LOG(info) << print() << " Enabled vsync.";
276 wglSwapIntervalEXT(0);
279 CASPAR_LOG(info) << print() << " Successfully Initialized.";
285 glDeleteTextures(1, &texture_);
287 for (auto& pbo : pbos_)
290 glDeleteBuffers(1, &pbo);
305 while(window_.pollEvent(e))
307 if (e.type == sf::Event::Resized)
309 else if (e.type == sf::Event::Closed)
311 else if (config_.interactive && sink_)
315 case sf::Event::MouseMoved:
317 auto& mouse_move = e.mouseMove;
318 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
320 static_cast<double>(mouse_move.x) / screen_width_,
321 static_cast<double>(mouse_move.y) / screen_height_));
324 case sf::Event::MouseButtonPressed:
325 case sf::Event::MouseButtonReleased:
327 auto& mouse_button = e.mouseButton;
328 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
330 static_cast<double>(mouse_button.x) / screen_width_,
331 static_cast<double>(mouse_button.y) / screen_height_,
332 static_cast<int>(mouse_button.button),
333 e.type == sf::Event::MouseButtonPressed));
336 case sf::Event::MouseWheelMoved:
338 auto& wheel_moved = e.mouseWheel;
339 sink_->on_interaction(spl::make_shared<core::mouse_wheel_event>(
341 static_cast<double>(wheel_moved.x) / screen_width_,
342 static_cast<double>(wheel_moved.y) / screen_height_,
350 auto frame = core::const_frame::empty();
351 frame_buffer_.pop(frame);
353 render_and_draw_frame(frame);
355 /*perf_timer_.restart();
357 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
361 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
362 tick_timer_.restart();
366 CASPAR_LOG_CURRENT_EXCEPTION();
375 CASPAR_LOG_CURRENT_EXCEPTION();
379 void try_sleep_almost_until_vblank()
381 static const double THRESHOLD = 0.003;
382 double threshold = config_.vsync ? THRESHOLD : 0.0;
384 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
386 wait_timer_.tick(frame_time - threshold);
389 void wait_for_vblank_and_display()
391 try_sleep_almost_until_vblank();
393 // Make sure that the next tick measures the duration from this point in time.
394 wait_timer_.tick(0.0);
397 spl::shared_ptr<AVFrame> get_av_frame()
399 spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
400 avcodec_get_frame_defaults(av_frame.get());
402 av_frame->linesize[0] = format_desc_.width*4;
403 av_frame->format = PIX_FMT_BGRA;
404 av_frame->width = format_desc_.width;
405 av_frame->height = format_desc_.height;
406 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
407 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
412 void render_and_draw_frame(core::const_frame frame)
414 if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
417 if(screen_width_ == 0 && screen_height_ == 0)
420 perf_timer_.restart();
421 auto av_frame = get_av_frame();
422 av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
424 filter_.push(av_frame);
425 auto frames = filter_.poll_all();
430 if (frames.size() == 1)
433 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
435 wait_for_vblank_and_display(); // progressive frame
437 else if (frames.size() == 2)
440 double perf_elapsed = perf_timer_.elapsed();
442 wait_for_vblank_and_display(); // field1
444 perf_timer_.restart();
446 perf_elapsed += perf_timer_.elapsed();
447 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
449 wait_for_vblank_and_display(); // field2
453 void render(spl::shared_ptr<AVFrame> av_frame)
455 GL(glBindTexture(GL_TEXTURE_2D, texture_));
457 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
458 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
460 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
461 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
463 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
468 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
470 for(int n = r.begin(); n != r.end(); ++n)
471 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);
476 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
478 for(int n = r.begin(); n != r.end(); ++n)
479 A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
483 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
486 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
488 GL(glClear(GL_COLOR_BUFFER_BIT));
490 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
491 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
492 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
493 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
496 GL(glBindTexture(GL_TEXTURE_2D, 0));
498 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
502 std::future<bool> send(core::const_frame frame)
504 if(!frame_buffer_.try_push(frame))
505 graph_->set_tag("dropped-frame");
507 return make_ready_future(is_running_.load());
510 std::wstring channel_and_format() const
512 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
515 std::wstring print() const
517 return config_.name + channel_and_format();
520 void calculate_aspect()
524 screen_height_ = window_.getSize().y;
525 screen_width_ = window_.getSize().x;
528 GL(glViewport(0, 0, screen_width_, screen_height_));
530 std::pair<float, float> target_ratio = None();
531 if (config_.stretch == screen::stretch::fill)
532 target_ratio = Fill();
533 else if (config_.stretch == screen::stretch::uniform)
534 target_ratio = Uniform();
535 else if (config_.stretch == screen::stretch::uniform_to_fill)
536 target_ratio = UniformToFill();
538 width_ = target_ratio.first;
539 height_ = target_ratio.second;
542 std::pair<float, float> None()
544 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
545 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
547 return std::make_pair(width, height);
550 std::pair<float, float> Uniform()
552 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
553 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
554 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
556 return std::make_pair(width, height);
559 std::pair<float, float> Fill()
561 return std::make_pair(1.0f, 1.0f);
564 std::pair<float, float> UniformToFill()
566 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
567 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
568 float r_inv = 1.0f/std::min(wr, hr);
570 float width = wr*r_inv;
571 float height = hr*r_inv;
573 return std::make_pair(width, height);
578 struct screen_consumer_proxy : public core::frame_consumer
580 core::monitor::subject monitor_subject_;
581 const configuration config_;
582 std::unique_ptr<screen_consumer> consumer_;
583 core::interaction_sink* sink_;
587 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
595 void initialize(const core::video_format_desc& format_desc, int channel_index) override
598 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
601 std::future<bool> send(core::const_frame frame) override
603 return consumer_->send(frame);
606 std::wstring print() const override
608 return consumer_ ? consumer_->print() : L"[screen_consumer]";
611 std::wstring name() const override
616 boost::property_tree::wptree info() const override
618 boost::property_tree::wptree info;
619 info.add(L"type", L"screen");
620 info.add(L"key-only", config_.key_only);
621 info.add(L"windowed", config_.windowed);
622 info.add(L"auto-deinterlace", config_.auto_deinterlace);
626 bool has_synchronization_clock() const override
631 int buffer_depth() const override
636 int index() const override
638 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
641 core::monitor::subject& monitor_output()
643 return monitor_subject_;
647 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink* sink)
649 if(params.size() < 1 || params[0] != L"SCREEN")
650 return core::frame_consumer::empty();
652 configuration config;
654 if(params.size() > 1)
655 config.screen_index = boost::lexical_cast<int>(params[1]);
657 config.windowed = std::find(params.begin(), params.end(), L"FULLSCREEN") == params.end();
658 config.key_only = std::find(params.begin(), params.end(), L"KEY_ONLY") != params.end();
659 config.interactive = std::find(params.begin(), params.end(), L"NON_INTERACTIVE") == params.end();
661 auto name_it = std::find(params.begin(), params.end(), L"NAME");
662 if(name_it != params.end() && ++name_it != params.end())
663 config.name = *name_it;
665 return spl::make_shared<screen_consumer_proxy>(config, sink);
668 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink)
670 configuration config;
671 config.name = ptree.get(L"name", config.name);
672 config.screen_index = ptree.get(L"device", config.screen_index+1)-1;
673 config.windowed = ptree.get(L"windowed", config.windowed);
674 config.key_only = ptree.get(L"key-only", config.key_only);
675 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
676 config.vsync = ptree.get(L"vsync", config.vsync);
677 config.interactive = ptree.get(L"interactive", config.interactive);
679 auto stretch_str = ptree.get(L"stretch", L"default");
680 if(stretch_str == L"uniform")
681 config.stretch = screen::stretch::uniform;
682 else if(stretch_str == L"uniform_to_fill")
683 config.stretch = screen::stretch::uniform_to_fill;
685 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
686 if(aspect_str == L"16:9")
687 config.aspect = configuration::aspect_ratio::aspect_16_9;
688 else if(aspect_str == L"4:3")
689 config.aspect = configuration::aspect_ratio::aspect_4_3;
691 return spl::make_shared<screen_consumer_proxy>(config, sink);