]> git.sesse.net Git - casparcg/blobdiff - modules/screen/consumer/screen_consumer.cpp
[screen_consumer] #495 Fixed full screen mode
[casparcg] / modules / screen / consumer / screen_consumer.cpp
index e3053471f316f6ec8e9a4f1147c246d9f8cbb0a0..818bdf12e976c237f25faf6c7f946e444b9790c9 100644 (file)
 #include <common/memory.h>
 #include <common/array.h>
 #include <common/memshfl.h>
+#include <common/memcpy.h>
 #include <common/utf.h>
 #include <common/prec_timer.h>
 #include <common/future.h>
 #include <common/timer.h>
 #include <common/param.h>
+#include <common/os/general_protection_fault.h>
+#include <common/scope_exit.h>
 
 //#include <windows.h>
 
 #include <ffmpeg/producer/filter/filter.h>
+#include <ffmpeg/producer/util/util.h>
 
 #include <core/video_format.h>
 #include <core/frame/frame.h>
 #include <core/consumer/frame_consumer.h>
 #include <core/interaction/interaction_sink.h>
+#include <core/help/help_sink.h>
+#include <core/help/help_repository.h>
 
 #include <boost/circular_buffer.hpp>
 #include <boost/lexical_cast.hpp>
@@ -64,7 +70,7 @@
 #pragma warning (push)
 #pragma warning (disable : 4244)
 #endif
-extern "C" 
+extern "C"
 {
        #define __STDC_CONSTANT_MACROS
        #define __STDC_LIMIT_MACROS
@@ -76,7 +82,7 @@ extern "C"
 #endif
 
 namespace caspar { namespace screen {
-               
+
 enum class stretch
 {
        none,
@@ -93,16 +99,17 @@ struct configuration
                aspect_16_9,
                aspect_invalid,
        };
-               
-       std::wstring    name                            = L"ogl";
+
+       std::wstring    name                            = L"Screen consumer";
        int                             screen_index            = 0;
        screen::stretch stretch                         = screen::stretch::fill;
        bool                    windowed                        = true;
        bool                    auto_deinterlace        = true;
        bool                    key_only                        = false;
        aspect_ratio    aspect                          = aspect_ratio::aspect_invalid;
-       bool                    vsync                           = true;
+       bool                    vsync                           = false;
        bool                    interactive                     = true;
+       bool                    borderless                      = false;
 };
 
 struct screen_consumer : boost::noncopyable
@@ -113,7 +120,7 @@ struct screen_consumer : boost::noncopyable
 
        GLuint                                                                                          texture_                = 0;
        std::vector<GLuint>                                                                     pbos_                   = std::vector<GLuint> { 0, 0 };
-                       
+
        float                                                                                           width_;
        float                                                                                           height_;
        int                                                                                                     screen_x_;
@@ -124,6 +131,8 @@ struct screen_consumer : boost::noncopyable
        int                                                                                                     square_height_  = format_desc_.square_height;
 
        sf::Window                                                                                      window_;
+       tbb::atomic<bool>                                                                       polling_event_;
+       std::int64_t                                                                            pts_;
 
        spl::shared_ptr<diagnostics::graph>                                     graph_;
        caspar::timer                                                                           perf_timer_;
@@ -136,6 +145,7 @@ struct screen_consumer : boost::noncopyable
 
        boost::thread                                                                           thread_;
        tbb::atomic<bool>                                                                       is_running_;
+       tbb::atomic<int64_t>                                                            current_presentation_age_;
 
        ffmpeg::filter                                                                          filter_;
 public:
@@ -143,19 +153,20 @@ public:
                        const configuration& config,
                        const core::video_format_desc& format_desc,
                        int channel_index,
-                       core::interaction_sink* sink) 
+                       core::interaction_sink* sink)
                : config_(config)
                , format_desc_(format_desc)
                , channel_index_(channel_index)
+               , pts_(0)
                , sink_(sink)
                , filter_([&]() -> ffmpeg::filter
-               {                       
-                       const auto sample_aspect_ratio = 
+               {
+                       const auto sample_aspect_ratio =
                                boost::rational<int>(
-                                       format_desc.square_width, 
+                                       format_desc.square_width,
                                        format_desc.square_height) /
                                boost::rational<int>(
-                                       format_desc.width, 
+                                       format_desc.width,
                                        format_desc.height);
 
                        return ffmpeg::filter(
@@ -166,9 +177,9 @@ public:
                                sample_aspect_ratio,
                                AV_PIX_FMT_BGRA,
                                { AV_PIX_FMT_BGRA },
-                               format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "YADIF=1:-1");
+                               format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? "" : "format=pix_fmts=gbrp,YADIF=1:-1");
                }())
-       {               
+       {
                if (format_desc_.format == core::video_format::ntsc && config_.aspect == configuration::aspect_ratio::aspect_4_3)
                {
                        // Use default values which are 4:3.
@@ -182,13 +193,13 @@ public:
                }
 
                frame_buffer_.set_capacity(1);
-               
-               graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   
+
+               graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));
                graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));
                graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));
                graph_->set_text(print());
                diagnostics::register_graph(graph_);
-                                                                       
+
                /*DISPLAY_DEVICE d_device = {sizeof(d_device), 0};
                std::vector<DISPLAY_DEVICE> displayDevices;
                for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)
@@ -196,11 +207,11 @@ public:
 
                if(config_.screen_index >= displayDevices.size())
                        CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;
-               
+
                DEVMODE devmode = {};
                if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))
                        CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;
-               
+
                screen_x_               = devmode.dmPosition.x;
                screen_y_               = devmode.dmPosition.y;
                screen_width_   = config_.windowed ? square_width_ : devmode.dmPelsWidth;
@@ -209,11 +220,13 @@ public:
                screen_y_               = 0;
                screen_width_   = square_width_;
                screen_height_  = square_height_;
-               
+
+               polling_event_ = false;
                is_running_ = true;
+               current_presentation_age_ = 0;
                thread_ = boost::thread([this]{run();});
        }
-       
+
        ~screen_consumer()
        {
                is_running_ = false;
@@ -223,12 +236,27 @@ public:
 
        void init()
        {
-               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);
+               auto window_style = config_.borderless
+                       ? sf::Style::None
+                       : (config_.windowed
+                               ? sf::Style::Resize | sf::Style::Close
+                               : sf::Style::Fullscreen);
+               window_.create(sf::VideoMode::getDesktopMode(), u8(print()), window_style);
+
+               if (config_.windowed)
+               {
+                       window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
+                       window_.setSize(sf::Vector2u(screen_width_, screen_height_));
+               }
+               else
+               {
+                       screen_width_   = window_.getSize().x;
+                       screen_height_  = window_.getSize().y;
+               }
+
                window_.setMouseCursorVisible(config_.interactive);
-               window_.setPosition(sf::Vector2i(screen_x_, screen_y_));
-               window_.setSize(sf::Vector2u(screen_width_, screen_height_));
                window_.setActive();
-               
+
                if(!GLEW_VERSION_2_1 && glewInit() != GLEW_OK)
                        CASPAR_THROW_EXCEPTION(gl::ogl_exception() << msg_info("Failed to initialize GLEW."));
 
@@ -236,13 +264,13 @@ public:
                        CASPAR_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));
 
                GL(glEnable(GL_TEXTURE_2D));
-               GL(glDisable(GL_DEPTH_TEST));           
+               GL(glDisable(GL_DEPTH_TEST));
                GL(glClearColor(0.0, 0.0, 0.0, 0.0));
                GL(glViewport(0, 0, format_desc_.width, format_desc_.height));
                GL(glLoadIdentity());
-                               
+
                calculate_aspect();
-                       
+
                GL(glGenTextures(1, &texture_));
                GL(glBindTexture(GL_TEXTURE_2D, texture_));
                GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));
@@ -251,38 +279,25 @@ public:
                GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));
                GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));
                GL(glBindTexture(GL_TEXTURE_2D, 0));
-                                       
+
                GL(glGenBuffers(2, pbos_.data()));
-                       
+
                glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);
                glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
                glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);
                glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);
                glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
-               
+
                window_.setVerticalSyncEnabled(config_.vsync);
 
                if (config_.vsync)
                {
                        CASPAR_LOG(info) << print() << " Enabled vsync.";
                }
-               /*auto wglSwapIntervalEXT = reinterpret_cast<void(APIENTRY*)(int)>(wglGetProcAddress("wglSwapIntervalEXT"));
-               if(wglSwapIntervalEXT)
-               {
-                       if(config_.vsync)
-                       {
-                               wglSwapIntervalEXT(1);
-                               CASPAR_LOG(info) << print() << " Enabled vsync.";
-                       }
-                       else
-                               wglSwapIntervalEXT(0);
-               }*/
-
-               CASPAR_LOG(info) << print() << " Successfully Initialized.";
        }
 
        void uninit()
-       {               
+       {
                if(texture_)
                        glDeleteTextures(1, &texture_);
 
@@ -295,16 +310,28 @@ public:
 
        void run()
        {
+               ensure_gpf_handler_installed_for_thread("screen-consumer-thread");
+
                try
                {
                        init();
 
                        while(is_running_)
-                       {                       
+                       {
                                try
                                {
-                                       sf::Event e;            
-                                       while(window_.pollEvent(e))
+                                       auto poll_event = [this](sf::Event& e)
+                                       {
+                                               polling_event_ = true;
+                                               CASPAR_SCOPE_EXIT
+                                               {
+                                                       polling_event_ = false;
+                                               };
+                                               return window_.pollEvent(e);
+                                       };
+
+                                       sf::Event e;
+                                       while(poll_event(e))
                                        {
                                                if (e.type == sf::Event::Resized)
                                                        calculate_aspect();
@@ -348,19 +375,20 @@ public:
                                                        }
                                                }
                                        }
-                       
-                                       auto frame = core::const_frame::empty();
+
+                                       core::const_frame frame;
                                        frame_buffer_.pop(frame);
 
                                        render_and_draw_frame(frame);
-                                       
+
                                        /*perf_timer_.restart();
                                        render(frame);
-                                       graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);    
+                                       graph_->set_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5);
 
                                        window_.Display();*/
 
-                                       graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);     
+                                       current_presentation_age_ = frame.get_age_millis();
+                                       graph_->set_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);
                                        tick_timer_.restart();
                                }
                                catch(...)
@@ -397,54 +425,55 @@ public:
        }
 
        spl::shared_ptr<AVFrame> get_av_frame()
-       {               
-               spl::shared_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);      
-               avcodec_get_frame_defaults(av_frame.get());
-                                               
-               av_frame->linesize[0]           = format_desc_.width*4;                 
+       {
+               auto av_frame = ffmpeg::create_frame();
+
+               av_frame->linesize[0]           = format_desc_.width*4;
                av_frame->format                        = PIX_FMT_BGRA;
                av_frame->width                         = format_desc_.width;
                av_frame->height                        = format_desc_.height;
                av_frame->interlaced_frame      = format_desc_.field_mode != core::field_mode::progressive;
                av_frame->top_field_first       = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;
+               av_frame->pts                           = pts_++;
 
                return av_frame;
        }
 
-       void render_and_draw_frame(core::const_frame frame)
+       void render_and_draw_frame(core::const_frame input_frame)
        {
-               if(static_cast<size_t>(frame.image_data().size()) != format_desc_.size)
+               if(static_cast<size_t>(input_frame.image_data().size()) != format_desc_.size)
                        return;
 
                if(screen_width_ == 0 && screen_height_ == 0)
                        return;
-                                       
+
                perf_timer_.restart();
                auto av_frame = get_av_frame();
-               av_frame->data[0] = const_cast<uint8_t*>(frame.image_data().begin());
+               av_frame->data[0] = const_cast<uint8_t*>(input_frame.image_data().begin());
 
                filter_.push(av_frame);
-               auto frames = filter_.poll_all();
+               auto frame = filter_.poll();
 
-               if (frames.empty())
+               if (!frame)
                        return;
 
-               if (frames.size() == 1)
+               if (!filter_.is_double_rate())
                {
-                       render(frames[0]);
+                       render(spl::make_shared_ptr(frame));
                        graph_->set_value("frame-time", perf_timer_.elapsed() * format_desc_.fps * 0.5);
 
                        wait_for_vblank_and_display(); // progressive frame
                }
-               else if (frames.size() == 2)
+               else
                {
-                       render(frames[0]);
+                       render(spl::make_shared_ptr(frame));
                        double perf_elapsed = perf_timer_.elapsed();
 
                        wait_for_vblank_and_display(); // field1
 
                        perf_timer_.restart();
-                       render(frames[1]);
+                       frame = filter_.poll();
+                       render(spl::make_shared_ptr(frame));
                        perf_elapsed += perf_timer_.elapsed();
                        graph_->set_value("frame-time", perf_elapsed * format_desc_.fps * 0.5);
 
@@ -454,6 +483,7 @@ public:
 
        void render(spl::shared_ptr<AVFrame> av_frame)
        {
+               CASPAR_LOG_CALL(trace) << "screen_consumer::render() <- " << print();
                GL(glBindTexture(GL_TEXTURE_2D, texture_));
 
                GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]));
@@ -474,27 +504,23 @@ public:
                                });
                        }
                        else
-                       {       
-                               tbb::parallel_for(tbb::blocked_range<int>(0, format_desc_.height), [&](const tbb::blocked_range<int>& r)
-                               {
-                                       for(int n = r.begin(); n != r.end(); ++n)
-                                               A_memcpy(ptr+n*format_desc_.width*4, av_frame->data[0]+n*av_frame->linesize[0], format_desc_.width*4);
-                               });
+                       {
+                               fast_memcpy(ptr, av_frame->data[0], format_desc_.size);
                        }
-                       
+
                        GL(glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER)); // release the mapped buffer
                }
 
                GL(glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0));
-                               
-               GL(glClear(GL_COLOR_BUFFER_BIT));                       
+
+               GL(glClear(GL_COLOR_BUFFER_BIT));
                glBegin(GL_QUADS);
                                glTexCoord2f(0.0f,        1.0f);        glVertex2f(-width_, -height_);
                                glTexCoord2f(1.0f,        1.0f);        glVertex2f( width_, -height_);
                                glTexCoord2f(1.0f,        0.0f);        glVertex2f( width_,  height_);
                                glTexCoord2f(0.0f,        0.0f);        glVertex2f(-width_,  height_);
                glEnd();
-               
+
                GL(glBindTexture(GL_TEXTURE_2D, 0));
 
                std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());
@@ -503,8 +529,8 @@ public:
 
        std::future<bool> send(core::const_frame frame)
        {
-               if(!frame_buffer_.try_push(frame))
-                       graph_->set_tag("dropped-frame");
+               if(!frame_buffer_.try_push(frame) && !polling_event_)
+                       graph_->set_tag(diagnostics::tag_severity::WARNING, "dropped-frame");
 
                return make_ready_future(is_running_.load());
        }
@@ -515,10 +541,10 @@ public:
        }
 
        std::wstring print() const
-       {       
-               return config_.name + channel_and_format();
+       {
+               return config_.name + L" " + channel_and_format();
        }
-       
+
        void calculate_aspect()
        {
                if(config_.windowed)
@@ -526,7 +552,7 @@ public:
                        screen_height_ = window_.getSize().y;
                        screen_width_ = window_.getSize().x;
                }
-               
+
                GL(glViewport(0, 0, screen_width_, screen_height_));
 
                std::pair<float, float> target_ratio = None();
@@ -540,7 +566,7 @@ public:
                width_ = target_ratio.first;
                height_ = target_ratio.second;
        }
-               
+
        std::pair<float, float> None()
        {
                float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);
@@ -591,20 +617,25 @@ public:
                , sink_(sink)
        {
        }
-       
+
        // frame_consumer
 
-       void initialize(const core::video_format_desc& format_desc, int channel_index) override
+       void initialize(const core::video_format_desc& format_desc, const core::audio_channel_layout&, int channel_index) override
        {
                consumer_.reset();
                consumer_.reset(new screen_consumer(config_, format_desc, channel_index, sink_));
        }
-       
+
+       int64_t presentation_frame_age_millis() const override
+       {
+               return consumer_ ? static_cast<int64_t>(consumer_->current_presentation_age_) : 0;
+       }
+
        std::future<bool> send(core::const_frame frame) override
        {
                return consumer_->send(frame);
        }
-       
+
        std::wstring print() const override
        {
                return consumer_ ? consumer_->print() : L"[screen_consumer]";
@@ -622,6 +653,7 @@ public:
                info.add(L"key-only", config_.key_only);
                info.add(L"windowed", config_.windowed);
                info.add(L"auto-deinterlace", config_.auto_deinterlace);
+               info.add(L"vsync", config_.vsync);
                return info;
        }
 
@@ -629,7 +661,7 @@ public:
        {
                return false;
        }
-       
+
        int buffer_depth() const override
        {
                return 1;
@@ -644,22 +676,52 @@ public:
        {
                return monitor_subject_;
        }
-};     
+};
+
+void describe_consumer(core::help_sink& sink, const core::help_repository& repo)
+{
+       sink.short_description(L"Displays the contents of a channel on screen using OpenGL.");
+       sink.syntax(
+                       L"SCREEN "
+                       L"{[screen_index:int]|1} "
+                       L"{[fullscreen:FULLSCREEN]} "
+                       L"{[borderless:BORDERLESS]} "
+                       L"{[key_only:KEY_ONLY]} "
+                       L"{[non_interactive:NON_INTERACTIVE]} "
+                       L"{[no_auto_deinterlace:NO_AUTO_DEINTERLACE]} "
+                       L"{NAME [name:string]}");
+       sink.para()->text(L"Displays the contents of a channel on screen using OpenGL.");
+       sink.definitions()
+               ->item(L"screen_index", L"Determines which screen the channel should be displayed on. Defaults to 1.")
+               ->item(L"fullscreen", L"If specified opens the window in fullscreen.")
+               ->item(L"borderless", L"Makes the window appear without any window decorations.")
+               ->item(L"key_only", L"Only displays the alpha channel of the video channel if specified.")
+               ->item(L"non_interactive", L"If specified does not send mouse input to producers on the video channel.")
+               ->item(L"no_auto_deinterlace", L"If the video mode of the channel is an interlaced mode, specifying this will turn of deinterlacing.")
+               ->item(L"name", L"Optionally specifies a name of the window to show.");
+       sink.para()->text(L"Examples:");
+       sink.example(L">> ADD 1 SCREEN", L"opens a screen consumer on the default screen.");
+       sink.example(L">> ADD 1 SCREEN 2", L"opens a screen consumer on the screen 2.");
+       sink.example(L">> ADD 1 SCREEN 1 FULLSCREEN", L"opens a screen consumer in fullscreen on screen 1.");
+       sink.example(L">> ADD 1 SCREEN 1 BORDERLESS", L"opens a screen consumer without borders/window decorations on screen 1.");
+}
 
-spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params, core::interaction_sink* sink)
+spl::shared_ptr<core::frame_consumer> create_consumer(
+               const std::vector<std::wstring>& params, core::interaction_sink* sink, std::vector<spl::shared_ptr<core::video_channel>> channels)
 {
        if (params.size() < 1 || !boost::iequals(params.at(0), L"SCREEN"))
                return core::frame_consumer::empty();
-       
+
        configuration config;
-               
+
        if (params.size() > 1)
                config.screen_index = boost::lexical_cast<int>(params.at(1));
-               
+
        config.windowed                 = !contains_param(L"FULLSCREEN", params);
        config.key_only                 =  contains_param(L"KEY_ONLY", params);
        config.interactive              = !contains_param(L"NON_INTERACTIVE", params);
        config.auto_deinterlace = !contains_param(L"NO_AUTO_DEINTERLACE", params);
+       config.borderless               =  contains_param(L"BORDERLESS", params);
 
        if (contains_param(L"NAME", params))
                config.name = get_param(L"NAME", params);
@@ -667,7 +729,8 @@ spl::shared_ptr<core::frame_consumer> create_consumer(const std::vector<std::wst
        return spl::make_shared<screen_consumer_proxy>(config, sink);
 }
 
-spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost::property_tree::wptree& ptree, core::interaction_sink* sink) 
+spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(
+               const boost::property_tree::wptree& ptree, core::interaction_sink* sink, std::vector<spl::shared_ptr<core::video_channel>> channels)
 {
        configuration config;
        config.name                             = ptree.get(L"name",                            config.name);
@@ -677,6 +740,7 @@ spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost:
        config.auto_deinterlace = ptree.get(L"auto-deinterlace",        config.auto_deinterlace);
        config.vsync                    = ptree.get(L"vsync",                           config.vsync);
        config.interactive              = ptree.get(L"interactive",                     config.interactive);
+       config.borderless               = ptree.get(L"borderless",                      config.borderless);
 
        auto stretch_str = ptree.get(L"stretch", L"default");
        if(stretch_str == L"uniform")
@@ -689,7 +753,7 @@ spl::shared_ptr<core::frame_consumer> create_preconfigured_consumer(const boost:
                config.aspect = configuration::aspect_ratio::aspect_16_9;
        else if(aspect_str == L"4:3")
                config.aspect = configuration::aspect_ratio::aspect_4_3;
-       
+
        return spl::make_shared<screen_consumer_proxy>(config, sink);
 }