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>
47 #include <core/help/help_sink.h>
48 #include <core/help/help_repository.h>
50 #include <boost/circular_buffer.hpp>
51 #include <boost/lexical_cast.hpp>
52 #include <boost/property_tree/ptree.hpp>
53 #include <boost/thread.hpp>
54 #include <boost/algorithm/string.hpp>
56 #include <tbb/atomic.h>
57 #include <tbb/concurrent_queue.h>
58 #include <tbb/parallel_for.h>
66 #pragma warning (push)
67 #pragma warning (disable : 4244)
71 #define __STDC_CONSTANT_MACROS
72 #define __STDC_LIMIT_MACROS
73 #include <libavcodec/avcodec.h>
74 #include <libavutil/imgutils.h>
80 namespace caspar { namespace screen {
92 enum class aspect_ratio
99 std::wstring name = L"ogl";
100 int screen_index = 0;
101 screen::stretch stretch = screen::stretch::fill;
102 bool windowed = true;
103 bool auto_deinterlace = true;
104 bool key_only = false;
105 aspect_ratio aspect = aspect_ratio::aspect_invalid;
107 bool interactive = true;
110 struct screen_consumer : boost::noncopyable
112 const configuration config_;
113 core::video_format_desc format_desc_;
117 std::vector<GLuint> pbos_ = std::vector<GLuint> { 0, 0 };
123 int screen_width_ = format_desc_.width;
124 int screen_height_ = format_desc_.height;
125 int square_width_ = format_desc_.square_width;
126 int square_height_ = format_desc_.square_height;
130 spl::shared_ptr<diagnostics::graph> graph_;
131 caspar::timer perf_timer_;
132 caspar::timer tick_timer_;
134 caspar::prec_timer wait_timer_;
136 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
137 core::interaction_sink* sink_;
139 boost::thread thread_;
140 tbb::atomic<bool> is_running_;
142 ffmpeg::filter filter_;
145 const configuration& config,
146 const core::video_format_desc& format_desc,
148 core::interaction_sink* sink)
150 , format_desc_(format_desc)
151 , channel_index_(channel_index)
153 , filter_([&]() -> ffmpeg::filter
155 const auto sample_aspect_ratio =
156 boost::rational<int>(
157 format_desc.square_width,
158 format_desc.square_height) /
159 boost::rational<int>(
163 return ffmpeg::filter(
166 boost::rational<int>(format_desc.duration, format_desc.time_scale),
167 boost::rational<int>(format_desc.time_scale, format_desc.duration),
171 format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "YADIF=1:-1");
174 if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
176 // Use default values which are 4:3.
180 if (config_.aspect == configuration::aspect_ratio::aspect_16_9)
181 square_width_ = (format_desc.height*16)/9;
182 else if (config_.aspect == configuration::aspect_ratio::aspect_4_3)
183 square_width_ = (format_desc.height*4)/3;
186 frame_buffer_.set_capacity(1);
188 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
189 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
190 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
191 graph_->set_text(print());
192 diagnostics::register_graph(graph_);
194 /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
195 std::vector<DISPLAY_DEVICE> displayDevices;
196 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
197 displayDevices.push_back(d_device);
199 if(config_.screen_index >= displayDevices.size())
200 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
202 DEVMODE devmode = {};
203 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
204 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
206 screen_x_ = devmode.dmPosition.x;
207 screen_y_ = devmode.dmPosition.y;
208 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
209 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;*/
212 screen_width_ = square_width_;
213 screen_height_ = square_height_;
216 thread_ = boost::thread([this]{run();});
222 frame_buffer_.try_push(core::const_frame::empty());
228 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);
229 window_.setMouseCursorVisible(config_.interactive);
230 window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
231 window_.setSize(sf::Vector2u(screen_width_, screen_height_));
234 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
235 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
237 if(!GLEW_VERSION_2_1)
238 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
240 GL(glEnable(GL_TEXTURE_2D));
241 GL(glDisable(GL_DEPTH_TEST));
242 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
243 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
244 GL(glLoadIdentity());
248 GL(glGenTextures(1, &texture_));
249 GL(glBindTexture(GL_TEXTURE_2D, texture_));
250 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
251 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
252 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
253 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
254 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
255 GL(glBindTexture(GL_TEXTURE_2D, 0));
257 GL(glGenBuffers(2, pbos_.data()));
259 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
260 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
261 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
262 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
263 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
265 window_.setVerticalSyncEnabled(config_.vsync);
269 CASPAR_LOG(info) << print() << " Enabled vsync.";
271 /*auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
272 if(wglSwapIntervalEXT)
276 wglSwapIntervalEXT(1);
277 CASPAR_LOG(info) << print() << " Enabled vsync.";
280 wglSwapIntervalEXT(0);
283 CASPAR_LOG(info) << print() << " Successfully Initialized.";
289 glDeleteTextures(1, &texture_);
291 for (auto& pbo : pbos_)
294 glDeleteBuffers(1, &pbo);
309 while(window_.pollEvent(e))
311 if (e.type == sf::Event::Resized)
313 else if (e.type == sf::Event::Closed)
315 else if (config_.interactive && sink_)
319 case sf::Event::MouseMoved:
321 auto& mouse_move = e.mouseMove;
322 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
324 static_cast<double>(mouse_move.x) / screen_width_,
325 static_cast<double>(mouse_move.y) / screen_height_));
328 case sf::Event::MouseButtonPressed:
329 case sf::Event::MouseButtonReleased:
331 auto& mouse_button = e.mouseButton;
332 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
334 static_cast<double>(mouse_button.x) / screen_width_,
335 static_cast<double>(mouse_button.y) / screen_height_,
336 static_cast<int>(mouse_button.button),
337 e.type == sf::Event::MouseButtonPressed));
340 case sf::Event::MouseWheelMoved:
342 auto& wheel_moved = e.mouseWheel;
343 sink_->on_interaction(spl::make_shared<core::mouse_wheel_event>(
345 static_cast<double>(wheel_moved.x) / screen_width_,
346 static_cast<double>(wheel_moved.y) / screen_height_,
354 auto frame = core::const_frame::empty();
355 frame_buffer_.pop(frame);
357 render_and_draw_frame(frame);
359 /*perf_timer_.restart();
361 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
365 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
366 tick_timer_.restart();
370 CASPAR_LOG_CURRENT_EXCEPTION();
379 CASPAR_LOG_CURRENT_EXCEPTION();
383 void try_sleep_almost_until_vblank()
385 static const double THRESHOLD = 0.003;
386 double threshold = config_.vsync ? THRESHOLD : 0.0;
388 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
390 wait_timer_.tick(frame_time - threshold);
393 void wait_for_vblank_and_display()
395 try_sleep_almost_until_vblank();
397 // Make sure that the next tick measures the duration from this point in time.
398 wait_timer_.tick(0.0);
401 spl::shared_ptr<AVFrame> get_av_frame()
403 spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
404 avcodec_get_frame_defaults(av_frame.get());
406 av_frame->linesize[0] = format_desc_.width*4;
407 av_frame->format = PIX_FMT_BGRA;
408 av_frame->width = format_desc_.width;
409 av_frame->height = format_desc_.height;
410 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
411 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
416 void render_and_draw_frame(core::const_frame frame)
418 if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
421 if(screen_width_ == 0 && screen_height_ == 0)
424 perf_timer_.restart();
425 auto av_frame = get_av_frame();
426 av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
428 filter_.push(av_frame);
429 auto frames = filter_.poll_all();
434 if (frames.size() == 1)
437 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
439 wait_for_vblank_and_display(); // progressive frame
441 else if (frames.size() == 2)
444 double perf_elapsed = perf_timer_.elapsed();
446 wait_for_vblank_and_display(); // field1
448 perf_timer_.restart();
450 perf_elapsed += perf_timer_.elapsed();
451 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
453 wait_for_vblank_and_display(); // field2
457 void render(spl::shared_ptr<AVFrame> av_frame)
459 GL(glBindTexture(GL_TEXTURE_2D, texture_));
461 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
462 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
464 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
465 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
467 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
472 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
474 for(int n = r.begin(); n != r.end(); ++n)
475 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);
480 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
482 for(int n = r.begin(); n != r.end(); ++n)
483 A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
487 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
490 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
492 GL(glClear(GL_COLOR_BUFFER_BIT));
494 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
495 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
496 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
497 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
500 GL(glBindTexture(GL_TEXTURE_2D, 0));
502 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
506 std::future<bool> send(core::const_frame frame)
508 if(!frame_buffer_.try_push(frame))
509 graph_->set_tag("dropped-frame");
511 return make_ready_future(is_running_.load());
514 std::wstring channel_and_format() const
516 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
519 std::wstring print() const
521 return config_.name + channel_and_format();
524 void calculate_aspect()
528 screen_height_ = window_.getSize().y;
529 screen_width_ = window_.getSize().x;
532 GL(glViewport(0, 0, screen_width_, screen_height_));
534 std::pair<float, float> target_ratio = None();
535 if (config_.stretch == screen::stretch::fill)
536 target_ratio = Fill();
537 else if (config_.stretch == screen::stretch::uniform)
538 target_ratio = Uniform();
539 else if (config_.stretch == screen::stretch::uniform_to_fill)
540 target_ratio = UniformToFill();
542 width_ = target_ratio.first;
543 height_ = target_ratio.second;
546 std::pair<float, float> None()
548 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
549 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
551 return std::make_pair(width, height);
554 std::pair<float, float> Uniform()
556 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
557 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
558 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
560 return std::make_pair(width, height);
563 std::pair<float, float> Fill()
565 return std::make_pair(1.0f, 1.0f);
568 std::pair<float, float> UniformToFill()
570 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
571 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
572 float r_inv = 1.0f/std::min(wr, hr);
574 float width = wr*r_inv;
575 float height = hr*r_inv;
577 return std::make_pair(width, height);
582 struct screen_consumer_proxy : public core::frame_consumer
584 core::monitor::subject monitor_subject_;
585 const configuration config_;
586 std::unique_ptr<screen_consumer> consumer_;
587 core::interaction_sink* sink_;
591 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
599 void initialize(const core::video_format_desc& format_desc, int channel_index) override
602 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
605 std::future<bool> send(core::const_frame frame) override
607 return consumer_->send(frame);
610 std::wstring print() const override
612 return consumer_ ? consumer_->print() : L"[screen_consumer]";
615 std::wstring name() const override
620 boost::property_tree::wptree info() const override
622 boost::property_tree::wptree info;
623 info.add(L"type", L"screen");
624 info.add(L"key-only", config_.key_only);
625 info.add(L"windowed", config_.windowed);
626 info.add(L"auto-deinterlace", config_.auto_deinterlace);
630 bool has_synchronization_clock() const override
635 int buffer_depth() const override
640 int index() const override
642 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
645 core::monitor::subject& monitor_output()
647 return monitor_subject_;
651 void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
653 sink.short_description(L"Displays the contents of a channel on screen using OpenGL.");
656 L"{[screen_index:int]|1} "
657 L"{[fullscreen:FULLSCREEN]} "
658 L"{[key_only:KEY_ONLY]} "
659 L"{[non_interactive:NON_INTERACTIVE]} "
660 L"{[no_auto_deinterlace:NO_AUTO_DEINTERLACE]} "
661 L"{NAME [name:string]}");
662 sink.para()->text(L"Displays the contents of a channel on screen using OpenGL.");
664 ->item(L"screen_index", L"Determines which screen the channel should be displayed on. Defaults to 1.")
665 ->item(L"fullscreen", L"If specified opens the window in fullscreen.")
666 ->item(L"key_only", L"Only displays the alpha channel of the video channel if specified.")
667 ->item(L"non_interactive", L"If specified does not send mouse input to producers on the video channel.")
668 ->item(L"no_auto_deinterlace", L"If the video mode of the channel is an interlaced mode, specifying this will turn of deinterlacing.")
669 ->item(L"name", L"Optionally specifies a name of the window to show.");
670 sink.para()->text(L"Examples:");
671 sink.example(L">> ADD 1 SCREEN", L"opens a screen consumer on the default screen.");
672 sink.example(L">> ADD 1 SCREEN 2", L"opens a screen consumer on the screen 2.");
673 sink.example(L">> ADD 1 SCREEN 1 FULLSCREEN", L"opens a screen consumer in fullscreen on screen 1.");
676 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink* sink)
678 if (params.size() < 1 || !boost::iequals(params.at(0), L"SCREEN"))
679 return core::frame_consumer::empty();
681 configuration config;
683 if (params.size() > 1)
684 config.screen_index = boost::lexical_cast<int>(params.at(1));
686 config.windowed = !contains_param(L"FULLSCREEN", params);
687 config.key_only = contains_param(L"KEY_ONLY", params);
688 config.interactive = !contains_param(L"NON_INTERACTIVE", params);
689 config.auto_deinterlace = !contains_param(L"NO_AUTO_DEINTERLACE", params);
691 if (contains_param(L"NAME", params))
692 config.name = get_param(L"NAME", params);
694 return spl::make_shared<screen_consumer_proxy>(config, sink);
697 spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink)
699 configuration config;
700 config.name = ptree.get(L"name", config.name);
701 config.screen_index = ptree.get(L"device", config.screen_index + 1) - 1;
702 config.windowed = ptree.get(L"windowed", config.windowed);
703 config.key_only = ptree.get(L"key-only", config.key_only);
704 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
705 config.vsync = ptree.get(L"vsync", config.vsync);
706 config.interactive = ptree.get(L"interactive", config.interactive);
708 auto stretch_str = ptree.get(L"stretch", L"default");
709 if(stretch_str == L"uniform")
710 config.stretch = screen::stretch::uniform;
711 else if(stretch_str == L"uniform_to_fill")
712 config.stretch = screen::stretch::uniform_to_fill;
714 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
715 if(aspect_str == L"16:9")
716 config.aspect = configuration::aspect_ratio::aspect_16_9;
717 else if(aspect_str == L"4:3")
718 config.aspect = configuration::aspect_ratio::aspect_4_3;
720 return spl::make_shared<screen_consumer_proxy>(config, sink);