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>
37 #include <ffmpeg/producer/filter/filter.h>
39 #include <core/video_format.h>
40 #include <core/frame/frame.h>
41 #include <core/consumer/frame_consumer.h>
42 #include <core/consumer/frame_consumer.h>
44 #include <boost/timer.hpp>
45 #include <boost/circular_buffer.hpp>
46 #include <boost/lexical_cast.hpp>
47 #include <boost/foreach.hpp>
48 #include <boost/property_tree/ptree.hpp>
49 #include <boost/thread.hpp>
51 #include <tbb/atomic.h>
52 #include <tbb/concurrent_queue.h>
53 #include <tbb/parallel_for.h>
55 #include <boost/assign.hpp>
63 #pragma warning (push)
64 #pragma warning (disable : 4244)
68 #define __STDC_CONSTANT_MACROS
69 #define __STDC_LIMIT_MACROS
70 #include <libavcodec/avcodec.h>
71 #include <libavutil/imgutils.h>
77 namespace caspar { namespace screen {
100 bool auto_deinterlace;
111 , auto_deinterlace(true)
113 , aspect(aspect_invalid)
120 struct screen_consumer : boost::noncopyable
122 const configuration config_;
123 core::video_format_desc format_desc_;
127 std::vector<GLuint> pbos_;
140 spl::shared_ptr<diagnostics::graph> graph_;
141 boost::timer perf_timer_;
142 boost::timer tick_timer_;
144 caspar::prec_timer wait_timer_;
146 tbb::concurrent_bounded_queue<core::const_frame> frame_buffer_;
147 core::interaction_sink* sink_;
149 boost::thread thread_;
150 tbb::atomic<bool> is_running_;
152 ffmpeg::filter filter_;
154 screen_consumer(const configuration& config, const core::video_format_desc& format_desc, int channel_index, core::interaction_sink* sink)
156 , format_desc_(format_desc)
157 , channel_index_(channel_index)
160 , screen_width_(format_desc.width)
161 , screen_height_(format_desc.height)
162 , square_width_(format_desc.square_width)
163 , square_height_(format_desc.square_height)
165 , filter_(format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? L"" : L"YADIF=1:-1", boost::assign::list_of(PIX_FMT_BGRA))
167 if(format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_4_3)
169 // Use default values which are 4:3.
173 if(config_.aspect == configuration::aspect_16_9)
174 square_width_ = (format_desc.height*16)/9;
175 else if(config_.aspect == configuration::aspect_4_3)
176 square_width_ = (format_desc.height*4)/3;
179 frame_buffer_.set_capacity(1);
181 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
182 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
183 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
184 graph_->set_text(print());
185 diagnostics::register_graph(graph_);
187 DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
188 std::vector<DISPLAY_DEVICE> displayDevices;
189 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
190 displayDevices.push_back(d_device);
192 if(config_.screen_index >= displayDevices.size())
193 CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
195 DEVMODE devmode = {};
196 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
197 CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
199 screen_x_ = devmode.dmPosition.x;
200 screen_y_ = devmode.dmPosition.y;
201 screen_width_ = config_.windowed ? square_width_ : devmode.dmPelsWidth;
202 screen_height_ = config_.windowed ? square_height_ : devmode.dmPelsHeight;
205 thread_ = boost::thread([this]{run();});
211 frame_buffer_.try_push(core::const_frame::empty());
217 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);
218 window_.ShowMouseCursor(config_.interactive);
219 window_.SetPosition(screen_x_, screen_y_);
220 window_.SetSize(screen_width_, screen_height_);
223 if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
224 CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
226 if(!GLEW_VERSION_2_1)
227 CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
229 GL(glEnable(GL_TEXTURE_2D));
230 GL(glDisable(GL_DEPTH_TEST));
231 GL(glClearColor(0.0, 0.0, 0.0, 0.0));
232 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
233 GL(glLoadIdentity());
237 GL(glGenTextures(1, &texture_));
238 GL(glBindTexture(GL_TEXTURE_2D, texture_));
239 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
240 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));
241 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));
242 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
243 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
244 GL(glBindTexture(GL_TEXTURE_2D, 0));
246 GL(glGenBuffers(2, pbos_.data()));
248 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
249 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
250 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
251 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
252 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
254 auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
255 if(wglSwapIntervalEXT)
259 wglSwapIntervalEXT(1);
260 CASPAR_LOG(info) << print() << " Enabled vsync.";
263 wglSwapIntervalEXT(0);
266 CASPAR_LOG(info) << print() << " Successfully Initialized.";
272 glDeleteTextures(1, &texture_);
274 BOOST_FOREACH(auto& pbo, pbos_)
277 glDeleteBuffers(1, &pbo);
292 while(window_.GetEvent(e))
294 if (e.Type == sf::Event::Resized)
296 else if (e.Type == sf::Event::Closed)
298 else if (config_.interactive && sink_)
302 case sf::Event::MouseMoved:
304 auto& mouse_move = e.MouseMove;
305 sink_->on_interaction(spl::make_shared<core::mouse_move_event>(
307 static_cast<double>(mouse_move.X) / screen_width_,
308 static_cast<double>(mouse_move.Y) / screen_height_));
311 case sf::Event::MouseButtonPressed:
312 case sf::Event::MouseButtonReleased:
314 auto& mouse_button = e.MouseButton;
315 sink_->on_interaction(spl::make_shared<core::mouse_button_event>(
317 static_cast<double>(mouse_button.X) / screen_width_,
318 static_cast<double>(mouse_button.Y) / screen_height_,
319 static_cast<int>(mouse_button.Button),
320 e.Type == sf::Event::MouseButtonPressed));
327 auto frame = core::const_frame::empty();
328 frame_buffer_.pop(frame);
330 render_and_draw_frame(frame);
332 /*perf_timer_.restart();
334 graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
338 graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
339 tick_timer_.restart();
343 CASPAR_LOG_CURRENT_EXCEPTION();
352 CASPAR_LOG_CURRENT_EXCEPTION();
356 void try_sleep_almost_until_vblank()
358 static const double THRESHOLD = 0.003;
359 double threshold = config_.vsync ? THRESHOLD : 0.0;
361 auto frame_time = 1.0 / (format_desc_.fps * format_desc_.field_count);
363 wait_timer_.tick(frame_time - threshold);
366 void wait_for_vblank_and_display()
368 try_sleep_almost_until_vblank();
370 // Make sure that the next tick measures the duration from this point in time.
371 wait_timer_.tick(0.0);
374 spl::shared_ptr<AVFrame> get_av_frame()
376 spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);
377 avcodec_get_frame_defaults(av_frame.get());
379 av_frame->linesize[0] = format_desc_.width*4;
380 av_frame->format = PIX_FMT_BGRA;
381 av_frame->width = format_desc_.width;
382 av_frame->height = format_desc_.height;
383 av_frame->interlaced_frame = format_desc_.field_mode != core::field_mode::progressive;
384 av_frame->top_field_first = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
389 void render_and_draw_frame(core::const_frame frame)
391 if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
394 if(screen_width_ == 0 && screen_height_ == 0)
397 perf_timer_.restart();
398 auto av_frame = get_av_frame();
399 av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
401 filter_.push(av_frame);
402 auto frames = filter_.poll_all();
407 if (frames.size() == 1)
410 graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
412 wait_for_vblank_and_display(); // progressive frame
414 else if (frames.size() == 2)
417 double perf_elapsed = perf_timer_.elapsed();
419 wait_for_vblank_and_display(); // field1
421 perf_timer_.restart();
423 perf_elapsed += perf_timer_.elapsed();
424 graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
426 wait_for_vblank_and_display(); // field2
430 void render(spl::shared_ptr<AVFrame> av_frame)
432 GL(glBindTexture(GL_TEXTURE_2D, texture_));
434 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
435 GL(glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0));
437 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]));
438 GL(glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW));
440 auto ptr = reinterpret_cast<char*>(GL2(glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY)));
445 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
447 for(int n = r.begin(); n != r.end(); ++n)
448 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);
453 tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
455 for(int n = r.begin(); n != r.end(); ++n)
456 A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
460 GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
463 GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
465 GL(glClear(GL_COLOR_BUFFER_BIT));
467 glTexCoord2f(0.0f, 1.0f); glVertex2f(-width_, -height_);
468 glTexCoord2f(1.0f, 1.0f); glVertex2f( width_, -height_);
469 glTexCoord2f(1.0f, 0.0f); glVertex2f( width_, height_);
470 glTexCoord2f(0.0f, 0.0f); glVertex2f(-width_, height_);
473 GL(glBindTexture(GL_TEXTURE_2D, 0));
475 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
479 boost::unique_future<bool> send(core::const_frame frame)
481 if(!frame_buffer_.try_push(frame))
482 graph_->set_tag("dropped-frame");
484 return wrap_as_future(is_running_.load());
487 std::wstring channel_and_format() const
489 return L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";
492 std::wstring print() const
494 return config_.name + channel_and_format();
497 void calculate_aspect()
501 screen_height_ = window_.GetHeight();
502 screen_width_ = window_.GetWidth();
505 GL(glViewport(0, 0, screen_width_, screen_height_));
507 std::pair<float, float> target_ratio = None();
508 if(config_.stretch == fill)
509 target_ratio = Fill();
510 else if(config_.stretch == uniform)
511 target_ratio = Uniform();
512 else if(config_.stretch == uniform_to_fill)
513 target_ratio = UniformToFill();
515 width_ = target_ratio.first;
516 height_ = target_ratio.second;
519 std::pair<float, float> None()
521 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
522 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
524 return std::make_pair(width, height);
527 std::pair<float, float> Uniform()
529 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);
530 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));
531 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);
533 return std::make_pair(width, height);
536 std::pair<float, float> Fill()
538 return std::make_pair(1.0f, 1.0f);
541 std::pair<float, float> UniformToFill()
543 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
544 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);
545 float r_inv = 1.0f/std::min(wr, hr);
547 float width = wr*r_inv;
548 float height = hr*r_inv;
550 return std::make_pair(width, height);
555 struct screen_consumer_proxy : public core::frame_consumer
557 const configuration config_;
558 std::unique_ptr<screen_consumer> consumer_;
559 core::interaction_sink* sink_;
563 screen_consumer_proxy(const configuration& config, core::interaction_sink* sink)
571 void initialize(const core::video_format_desc& format_desc, int channel_index) override
574 consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
577 boost::unique_future<bool> send(core::const_frame frame) override
579 return consumer_->send(frame);
582 std::wstring print() const override
584 return consumer_ ? consumer_->print() : L"[screen_consumer]";
587 std::wstring name() const override
592 boost::property_tree::wptree info() const override
594 boost::property_tree::wptree info;
595 info.add(L"type", L"screen");
596 info.add(L"key-only", config_.key_only);
597 info.add(L"windowed", config_.windowed);
598 info.add(L"auto-deinterlace", config_.auto_deinterlace);
602 bool has_synchronization_clock() const override
607 int buffer_depth() const override
612 int index() const override
614 return 600 + (config_.key_only ? 10 : 0) + config_.screen_index;
617 void subscribe(const monitor::observable::observer_ptr& o) override
621 void unsubscribe(const monitor::observable::observer_ptr& o) override
626 spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)
628 if(params.size() < 1 || params[0] != L"SCREEN")
629 return core::frame_consumer::empty();
631 configuration config;
633 if(params.size() > 1)
634 config.screen_index = boost::lexical_cast<int>(params[1]);
636 config.key_only = std::find(params.begin(), params.end(), L"WINDOWED") != params.end();
637 config.key_only = std::find(params.begin(), params.end(), L"KEY_ONLY") != params.end();
639 auto name_it = std::find(params.begin(), params.end(), L"NAME");
640 if(name_it != params.end() && ++name_it != params.end())
641 config.name = *name_it;
643 return spl::make_shared<screen_consumer_proxy>(config, nullptr);
646 spl::shared_ptr<core::frame_consumer> create_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink)
648 configuration config;
649 config.name = ptree.get(L"name", config.name);
650 config.screen_index = ptree.get(L"device", config.screen_index+1)-1;
651 config.windowed = ptree.get(L"windowed", config.windowed);
652 config.key_only = ptree.get(L"key-only", config.key_only);
653 config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);
654 config.vsync = ptree.get(L"vsync", config.vsync);
656 auto stretch_str = ptree.get(L"stretch", L"default");
657 if(stretch_str == L"uniform")
658 config.stretch = stretch::uniform;
659 else if(stretch_str == L"uniform_to_fill")
660 config.stretch = stretch::uniform_to_fill;
662 auto aspect_str = ptree.get(L"aspect-ratio", L"default");
663 if(aspect_str == L"16:9")
664 config.aspect = configuration::aspect_16_9;
665 else if(aspect_str == L"4:3")
666 config.aspect = configuration::aspect_4_3;
668 return spl::make_shared<screen_consumer_proxy>(config, sink);