git.sesse.net Git - casparcg/blob - modules/ogl/consumer/ogl_consumer.cpp

   1 /*\r
   2 * copyright (c) 2010 Sveriges Television AB <info@casparcg.com>\r
   3 *\r
   4 *  This file is part of CasparCG.\r
   5 *\r
   6 *    CasparCG is free software: you can redistribute it and/or modify\r
   7 *    it under the terms of the GNU General Public License as published by\r
   8 *    the Free Software Foundation, either version 3 of the License, or\r
   9 *    (at your option) any later version.\r
  10 *\r
  11 *    CasparCG is distributed in the hope that it will be useful,\r
  12 *    but WITHOUT ANY WARRANTY; without even the implied warranty of\r
  13 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\r
  14 *    GNU General Public License for more details.\r
  15 \r
  16 *    You should have received a copy of the GNU General Public License\r
  17 *    along with CasparCG.  If not, see <http://www.gnu.org/licenses/>.\r
  18 *\r
  19 */\r
  20 \r
  21 #define NOMINMAX\r
  22 #define WIN32_LEAN_AND_MEAN\r
  23 \r
  24 #include <windows.h>\r
  25 #include <GL/glew.h>\r
  26 #include <SFML/Window.hpp>\r
  27 \r
  28 #include "ogl_consumer.h"\r
  29 \r
  30 #include <common/gl/gl_check.h>\r
  31 #include <common/concurrency/executor.h>\r
  32 #include <common/memory/safe_ptr.h>\r
  33 #include <common/memory/memcpy.h>\r
  34 #include <common/diagnostics/graph.h>\r
  35 #include <common/utility/timer.h>\r
  36 \r
  37 #include <core/video_format.h>\r
  38 #include <core/mixer/read_frame.h>\r
  39 #include <core/consumer/frame_consumer.h>\r
  40 \r
  41 #include <boost/timer.hpp>\r
  42 #include <boost/circular_buffer.hpp>\r
  43 \r
  44 #include <algorithm>\r
  45 #include <array>\r
  46 \r
  47 namespace caspar {\r
  48                 \r
  49 enum stretch\r
  50 {\r
  51         none,\r
  52         uniform,\r
  53         fill,\r
  54         uniform_to_fill\r
  55 };\r
  56 \r
  57 struct ogl_consumer : boost::noncopyable\r
  58 {               \r
  59         float                                   width_;\r
  60         float                                   height_;\r
  61 \r
  62         GLuint                                  texture_;\r
  63         std::array<GLuint, 2>   pbos_;\r
  64 \r
  65         const bool                              windowed_;\r
  66         unsigned int                    screen_width_;\r
  67         unsigned int                    screen_height_;\r
  68         const unsigned int              screen_index_;\r
  69                                 \r
  70         const stretch                   stretch_;\r
  71         core::video_format_desc format_desc_;\r
  72         \r
  73         sf::Window                              window_;\r
  74         \r
  75         safe_ptr<diagnostics::graph> graph_;\r
  76         boost::timer                    perf_timer_;\r
  77 \r
  78         size_t                                  square_width_;\r
  79         size_t                                  square_height_;\r
  80 \r
  81         boost::circular_buffer<safe_ptr<core::read_frame>>                      input_buffer_;\r
  82         tbb::concurrent_bounded_queue<safe_ptr<core::read_frame>>       frame_buffer_;\r
  83 \r
  84         executor                                executor_;\r
  85 public:\r
  86         ogl_consumer(unsigned int screen_index, stretch stretch, bool windowed, const core::video_format_desc& format_desc) \r
  87                 : stretch_(stretch)\r
  88                 , windowed_(windowed)\r
  89                 , texture_(0)\r
  90                 , screen_index_(screen_index)\r
  91                 , format_desc_(format_desc_)\r
  92                 , graph_(diagnostics::create_graph(narrow(print())))\r
  93                 , input_buffer_(core::consumer_buffer_depth()-1)\r
  94                 , executor_(print())\r
  95         {               \r
  96                 frame_buffer_.set_capacity(2);\r
  97 \r
  98                 graph_->add_guide("frame-time", 0.5);\r
  99                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));\r
 100                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));\r
 101                 \r
 102                 format_desc_ = format_desc;\r
 103 \r
 104                 square_width_ = format_desc_.width;\r
 105                 square_height_ = format_desc_.height;\r
 106                                                 \r
 107                 if(format_desc_.format == core::video_format::pal)\r
 108                 {\r
 109                         square_width_ = 768;\r
 110                         square_height_ = 576;\r
 111                 }\r
 112                 else if(format_desc_.format == core::video_format::ntsc)\r
 113                 {\r
 114                         square_width_ = 720;\r
 115                         square_height_ = 547;\r
 116                 }\r
 117 \r
 118                 screen_width_ = format_desc.width;\r
 119                 screen_height_ = format_desc.height;\r
 120 #ifdef _WIN32\r
 121                 DISPLAY_DEVICE d_device;                        \r
 122                 memset(&d_device, 0, sizeof(d_device));\r
 123                 d_device.cb = sizeof(d_device);\r
 124 \r
 125                 std::vector<DISPLAY_DEVICE> displayDevices;\r
 126                 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)\r
 127                 {\r
 128                         displayDevices.push_back(d_device);\r
 129                         memset(&d_device, 0, sizeof(d_device));\r
 130                         d_device.cb = sizeof(d_device);\r
 131                 }\r
 132 \r
 133                 if(screen_index_ >= displayDevices.size())\r
 134                         BOOST_THROW_EXCEPTION(out_of_range() << arg_name_info("screen_index_") << msg_info(narrow(print())));\r
 135                 \r
 136                 DEVMODE devmode;\r
 137                 memset(&devmode, 0, sizeof(devmode));\r
 138                 \r
 139                 if(!EnumDisplaySettings(displayDevices[screen_index_].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))\r
 140                         BOOST_THROW_EXCEPTION(invalid_operation() << arg_name_info("screen_index") << msg_info(narrow(print()) + " EnumDisplaySettings"));\r
 141                 \r
 142                 screen_width_ = windowed_ ? square_width_ : devmode.dmPelsWidth;\r
 143                 screen_height_ = windowed_ ? square_height_ : devmode.dmPelsHeight;\r
 144 #else\r
 145                 if(!windowed)\r
 146                         BOOST_THROW_EXCEPTION(not_supported() << msg_info(narrow(print() + " doesn't support non-Win32 fullscreen"));\r
 147 \r
 148                 if(screen_index != 0)\r
 149                         CASPAR_LOG(warning) << print() << " only supports screen_index=0 for non-Win32";\r
 150 #endif          \r
 151                 executor_.invoke([=]\r
 152                 {\r
 153                         if(!GLEW_VERSION_2_1)\r
 154                                 BOOST_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));\r
 155 \r
 156                         window_.Create(sf::VideoMode(screen_width_, screen_height_, 32), narrow(print()), windowed_ ? sf::Style::Resize : sf::Style::Fullscreen);\r
 157                         window_.ShowMouseCursor(false);\r
 158                         window_.SetPosition(devmode.dmPosition.x, devmode.dmPosition.y);\r
 159                         window_.SetSize(screen_width_, screen_height_);\r
 160                         window_.SetActive();\r
 161                         GL(glEnable(GL_TEXTURE_2D));\r
 162                         GL(glDisable(GL_DEPTH_TEST));           \r
 163                         GL(glClearColor(0.0, 0.0, 0.0, 0.0));\r
 164                         GL(glViewport(0, 0, format_desc_.width, format_desc_.height));\r
 165                         glLoadIdentity();\r
 166                                 \r
 167                         calculate_aspect();\r
 168                         \r
 169                         glGenTextures(1, &texture_);\r
 170                         glBindTexture(GL_TEXTURE_2D, texture_);\r
 171                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);\r
 172                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);\r
 173                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP);\r
 174                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP);\r
 175                         glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0);\r
 176                         glBindTexture(GL_TEXTURE_2D, 0);\r
 177                         \r
 178                         GL(glGenBuffers(2, pbos_.data()));\r
 179                         \r
 180                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);\r
 181                         glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
 182                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);\r
 183                         glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
 184                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);\r
 185                 });\r
 186                 CASPAR_LOG(info) << print() << " Sucessfully Initialized.";\r
 187 \r
 188                 executor_.begin_invoke([this]{tick();});\r
 189         }\r
 190 \r
 191         ~ogl_consumer()\r
 192         {\r
 193                 executor_.stop();\r
 194                 frame_buffer_.push(make_safe<core::read_frame>());\r
 195         }\r
 196         \r
 197         const core::video_format_desc& get_video_format_desc() const\r
 198         {\r
 199                 return format_desc_;\r
 200         }\r
 201 \r
 202         void calculate_aspect()\r
 203         {\r
 204                 if(windowed_)\r
 205                 {\r
 206                         screen_height_ = window_.GetHeight();\r
 207                         screen_width_ = window_.GetWidth();\r
 208                 }\r
 209                 \r
 210                 GL(glViewport(0, 0, screen_width_, screen_height_));\r
 211 \r
 212                 std::pair<float, float> target_ratio = None();\r
 213                 if(stretch_ == fill)\r
 214                         target_ratio = Fill();\r
 215                 else if(stretch_ == uniform)\r
 216                         target_ratio = Uniform();\r
 217                 else if(stretch_ == uniform_to_fill)\r
 218                         target_ratio = UniformToFill();\r
 219 \r
 220                 width_ = target_ratio.first;\r
 221                 height_ = target_ratio.second;\r
 222         }\r
 223                 \r
 224         std::pair<float, float> None()\r
 225         {\r
 226                 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
 227                 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
 228 \r
 229                 return std::make_pair(width, height);\r
 230         }\r
 231 \r
 232         std::pair<float, float> Uniform()\r
 233         {\r
 234                 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);\r
 235                 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));\r
 236                 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);\r
 237 \r
 238                 return std::make_pair(width, height);\r
 239         }\r
 240 \r
 241         std::pair<float, float> Fill()\r
 242         {\r
 243                 return std::make_pair(1.0f, 1.0f);\r
 244         }\r
 245 \r
 246         std::pair<float, float> UniformToFill()\r
 247         {\r
 248                 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
 249                 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
 250                 float r_inv = 1.0f/std::min(wr, hr);\r
 251 \r
 252                 float width = wr*r_inv;\r
 253                 float height = hr*r_inv;\r
 254 \r
 255                 return std::make_pair(width, height);\r
 256         }\r
 257 \r
 258         void render(const safe_ptr<core::read_frame>& frame)\r
 259         {                       \r
 260                 glBindTexture(GL_TEXTURE_2D, texture_);\r
 261 \r
 262                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]);\r
 263                 glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0);\r
 264 \r
 265                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]);\r
 266                 glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW);\r
 267 \r
 268                 auto ptr = glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY);\r
 269                 if(ptr)\r
 270                 {\r
 271                         fast_memcpy(reinterpret_cast<char*>(ptr), frame->image_data().begin(), frame->image_data().size());\r
 272                         glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER); // release the mapped buffer\r
 273                 }\r
 274 \r
 275                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0);\r
 276                                 \r
 277                 GL(glClear(GL_COLOR_BUFFER_BIT));                       \r
 278                 glBegin(GL_QUADS);\r
 279                                 glTexCoord2f(0.0f,        1.0f);        glVertex2f(-width_, -height_);\r
 280                                 glTexCoord2f(1.0f,        1.0f);        glVertex2f( width_, -height_);\r
 281                                 glTexCoord2f(1.0f,        0.0f);        glVertex2f( width_,  height_);\r
 282                                 glTexCoord2f(0.0f,        0.0f);        glVertex2f(-width_,  height_);\r
 283                 glEnd();\r
 284                 \r
 285                 glBindTexture(GL_TEXTURE_2D, 0);\r
 286 \r
 287                 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());\r
 288         }\r
 289 \r
 290         void send(const safe_ptr<core::read_frame>& frame)\r
 291         {\r
 292                 input_buffer_.push_back(frame);\r
 293 \r
 294                 if(input_buffer_.full())\r
 295                 {\r
 296                         if(!frame_buffer_.try_push(input_buffer_.front()))\r
 297                                 graph_->add_tag("dropped-frame");\r
 298                 }\r
 299         }\r
 300                 \r
 301         std::wstring print() const\r
 302         {       \r
 303                 return  L"ogl[" + boost::lexical_cast<std::wstring>(screen_index_) + L"|" + format_desc_.name + L"]";\r
 304         }\r
 305 \r
 306         void tick()\r
 307         {\r
 308                 try\r
 309                 {\r
 310                         perf_timer_.restart();\r
 311                         sf::Event e;\r
 312                 \r
 313                         safe_ptr<core::read_frame> frame;\r
 314 \r
 315                         while(window_.GetEvent(e))\r
 316                         {\r
 317                                 if(e.Type == sf::Event::Resized)\r
 318                                         calculate_aspect();\r
 319                         }\r
 320 \r
 321                         frame_buffer_.pop(frame);\r
 322 \r
 323                         if(!frame->image_data().empty())\r
 324                                 render(frame);\r
 325 \r
 326                         window_.Display();\r
 327                         graph_->update_value("frame-time", static_cast<float>(perf_timer_.elapsed()*format_desc_.fps*0.5));     \r
 328                 }\r
 329                 catch(...)\r
 330                 {\r
 331                         CASPAR_LOG_CURRENT_EXCEPTION();\r
 332                 }\r
 333                 executor_.begin_invoke([=]{tick();});\r
 334         }\r
 335 };\r
 336 \r
 337 \r
 338 struct ogl_consumer_proxy : public core::frame_consumer\r
 339 {\r
 340         size_t screen_index_;\r
 341         caspar::stretch stretch_;\r
 342         bool windowed_;\r
 343         bool key_only_;\r
 344 \r
 345         std::unique_ptr<ogl_consumer> consumer_;\r
 346 \r
 347 public:\r
 348 \r
 349         ogl_consumer_proxy(size_t screen_index, stretch stretch, bool windowed, bool key_only)\r
 350                 : screen_index_(screen_index)\r
 351                 , stretch_(stretch)\r
 352                 , windowed_(windowed)\r
 353                 , key_only_(key_only){}\r
 354         \r
 355         virtual void initialize(const core::video_format_desc& format_desc)\r
 356         {\r
 357                 consumer_.reset(new ogl_consumer(screen_index_, stretch_, windowed_, format_desc));\r
 358         }\r
 359         \r
 360         virtual bool send(const safe_ptr<core::read_frame>& frame)\r
 361         {\r
 362                 consumer_->send(frame);\r
 363                 return true;\r
 364         }\r
 365         \r
 366         virtual std::wstring print() const\r
 367         {\r
 368                 return consumer_->print();\r
 369         }\r
 370 \r
 371         virtual bool key_only() const\r
 372         {\r
 373                 return key_only_;\r
 374         }\r
 375 \r
 376         virtual bool has_synchronization_clock() const \r
 377         {\r
 378                 return false;\r
 379         }\r
 380 \r
 381         virtual const core::video_format_desc& get_video_format_desc() const\r
 382         {\r
 383                 return consumer_->get_video_format_desc();\r
 384         }\r
 385 };      \r
 386 \r
 387 safe_ptr<core::frame_consumer> create_ogl_consumer(const std::vector<std::wstring>& params)\r
 388 {\r
 389         if(params.size() < 1 || params[0] != L"SCREEN")\r
 390                 return core::frame_consumer::empty();\r
 391         \r
 392         size_t screen_index = 0;\r
 393         stretch stretch = stretch::fill;\r
 394         bool windowed = true;\r
 395         \r
 396         if(params.size() > 1) \r
 397                 screen_index = lexical_cast_or_default<int>(params[2], screen_index);\r
 398 \r
 399         if(params.size() > 2) \r
 400                 windowed = lexical_cast_or_default<bool>(params[3], windowed);\r
 401 \r
 402         bool key_only = std::find(params.begin(), params.end(), L"KEY_ONLY") != params.end();\r
 403 \r
 404         return make_safe<ogl_consumer_proxy>(screen_index, stretch, windowed, key_only);\r
 405 }\r
 406 \r
 407 safe_ptr<core::frame_consumer> create_ogl_consumer(const boost::property_tree::ptree& ptree) \r
 408 {\r
 409         size_t screen_index = ptree.get("device", 0);\r
 410         bool windowed =ptree.get("windowed", true);\r
 411         \r
 412         stretch stretch = stretch::fill;\r
 413         auto key_str = ptree.get("stretch", "default");\r
 414         if(key_str == "uniform")\r
 415                 stretch = stretch::uniform;\r
 416         else if(key_str == "uniform_to_fill")\r
 417                 stretch = stretch::uniform_to_fill;\r
 418 \r
 419         bool key_only = ptree.get("key-only", false);\r
 420 \r
 421         return make_safe<ogl_consumer_proxy>(screen_index, stretch, windowed, key_only);\r
 422 }\r
 423 \r
 424 }