]> git.sesse.net Git - casparcg/blob - modules/ogl/consumer/ogl_consumer.cpp
2.0. Reduced frame latency by 3 frames.
[casparcg] / 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 \r
23 #include <windows.h>\r
24 #include <Glee.h>\r
25 #include <SFML/Window.hpp>\r
26 \r
27 #include "ogl_consumer.h"\r
28 \r
29 #include <core/video_format.h>\r
30 #include <core/mixer/read_frame.h>\r
31 \r
32 #include <common/gl/gl_check.h>\r
33 #include <common/concurrency/executor.h>\r
34 #include <common/memory/safe_ptr.h>\r
35 #include <common/memory/memcpy.h>\r
36 #include <common/diagnostics/graph.h>\r
37 #include <common/utility/timer.h>\r
38 \r
39 #include <boost/timer.hpp>\r
40 #include <boost/circular_buffer.hpp>\r
41 \r
42 #include <algorithm>\r
43 #include <array>\r
44 \r
45 namespace caspar {\r
46                 \r
47 enum stretch\r
48 {\r
49         none,\r
50         uniform,\r
51         fill,\r
52         uniform_to_fill\r
53 };\r
54 \r
55 struct ogl_consumer : boost::noncopyable\r
56 {               \r
57         float                                   width_;\r
58         float                                   height_;\r
59 \r
60         GLuint                                  texture_;\r
61         std::array<GLuint, 2>   pbos_;\r
62 \r
63         const bool                              windowed_;\r
64         unsigned int                    screen_width_;\r
65         unsigned int                    screen_height_;\r
66         const unsigned int              screen_index_;\r
67                                 \r
68         const stretch                   stretch_;\r
69         core::video_format_desc format_desc_;\r
70         \r
71         sf::Window                              window_;\r
72         \r
73         safe_ptr<diagnostics::graph> graph_;\r
74         boost::timer                    perf_timer_;\r
75 \r
76         size_t                                  square_width_;\r
77         size_t                                  square_height_;\r
78 \r
79         boost::circular_buffer<safe_ptr<core::read_frame>> frame_buffer_;\r
80 \r
81         executor                                executor_;\r
82 public:\r
83         ogl_consumer(unsigned int screen_index, stretch stretch, bool windowed, const core::video_format_desc& format_desc) \r
84                 : stretch_(stretch)\r
85                 , windowed_(windowed)\r
86                 , texture_(0)\r
87                 , screen_index_(screen_index)\r
88                 , format_desc_(format_desc_)\r
89                 , graph_(diagnostics::create_graph(narrow(print())))\r
90                 , frame_buffer_(CONSUMER_BUFFER_DEPTH)\r
91                 , executor_(print())\r
92         {               \r
93                 graph_->add_guide("frame-time", 0.5);\r
94                 graph_->set_color("frame-time", diagnostics::color(1.0f, 0.0f, 0.0f));\r
95                 \r
96                 format_desc_ = format_desc;\r
97 \r
98                 square_width_ = format_desc_.width;\r
99                 square_height_ = format_desc_.height;\r
100                                                 \r
101                 if(format_desc_.format == core::video_format::pal)\r
102                 {\r
103                         square_width_ = 768;\r
104                         square_height_ = 576;\r
105                 }\r
106                 else if(format_desc_.format == core::video_format::ntsc)\r
107                 {\r
108                         square_width_ = 720;\r
109                         square_height_ = 547;\r
110                 }\r
111 \r
112                 screen_width_ = format_desc.width;\r
113                 screen_height_ = format_desc.height;\r
114 #ifdef _WIN32\r
115                 DISPLAY_DEVICE d_device;                        \r
116                 memset(&d_device, 0, sizeof(d_device));\r
117                 d_device.cb = sizeof(d_device);\r
118 \r
119                 std::vector<DISPLAY_DEVICE> displayDevices;\r
120                 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)\r
121                 {\r
122                         displayDevices.push_back(d_device);\r
123                         memset(&d_device, 0, sizeof(d_device));\r
124                         d_device.cb = sizeof(d_device);\r
125                 }\r
126 \r
127                 if(screen_index_ >= displayDevices.size())\r
128                         BOOST_THROW_EXCEPTION(out_of_range() << arg_name_info("screen_index_") << msg_info(narrow(print())));\r
129                 \r
130                 DEVMODE devmode;\r
131                 memset(&devmode, 0, sizeof(devmode));\r
132                 \r
133                 if(!EnumDisplaySettings(displayDevices[screen_index_].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))\r
134                         BOOST_THROW_EXCEPTION(invalid_operation() << arg_name_info("screen_index") << msg_info(narrow(print()) + " EnumDisplaySettings"));\r
135                 \r
136                 screen_width_ = windowed_ ? square_width_ : devmode.dmPelsWidth;\r
137                 screen_height_ = windowed_ ? square_height_ : devmode.dmPelsHeight;\r
138 #else\r
139                 if(!windowed)\r
140                         BOOST_THROW_EXCEPTION(not_supported() << msg_info(narrow(print() + " doesn't support non-Win32 fullscreen"));\r
141 \r
142                 if(screen_index != 0)\r
143                         CASPAR_LOG(warning) << print() << " only supports screen_index=0 for non-Win32";\r
144 #endif          \r
145                 executor_.invoke([=]\r
146                 {\r
147                         if(!GLEE_VERSION_2_1)\r
148                                 BOOST_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));\r
149 \r
150                         window_.Create(sf::VideoMode(screen_width_, screen_height_, 32), narrow(print()), windowed_ ? sf::Style::Resize : sf::Style::Fullscreen);\r
151                         window_.ShowMouseCursor(false);\r
152                         window_.SetPosition(devmode.dmPosition.x, devmode.dmPosition.y);\r
153                         window_.SetSize(screen_width_, screen_height_);\r
154                         window_.SetActive();\r
155                         GL(glEnable(GL_TEXTURE_2D));\r
156                         GL(glDisable(GL_DEPTH_TEST));           \r
157                         GL(glClearColor(0.0, 0.0, 0.0, 0.0));\r
158                         GL(glViewport(0, 0, format_desc_.width, format_desc_.height));\r
159                         glLoadIdentity();\r
160                                 \r
161                         calculate_aspect();\r
162                         \r
163                         glGenTextures(1, &texture_);\r
164                         glBindTexture(GL_TEXTURE_2D, texture_);\r
165                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);\r
166                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);\r
167                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP);\r
168                         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP);\r
169                         glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0);\r
170                         glBindTexture(GL_TEXTURE_2D, 0);\r
171                         \r
172                         GL(glGenBuffers(2, pbos_.data()));\r
173                         \r
174                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);\r
175                         glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
176                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);\r
177                         glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
178                         glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);\r
179                 });\r
180                 CASPAR_LOG(info) << print() << " Sucessfully Initialized.";\r
181         }\r
182         \r
183         const core::video_format_desc& get_video_format_desc() const\r
184         {\r
185                 return format_desc_;\r
186         }\r
187 \r
188         void calculate_aspect()\r
189         {\r
190                 if(windowed_)\r
191                 {\r
192                         screen_height_ = window_.GetHeight();\r
193                         screen_width_ = window_.GetWidth();\r
194                 }\r
195                 \r
196                 GL(glViewport(0, 0, screen_width_, screen_height_));\r
197 \r
198                 std::pair<float, float> target_ratio = None();\r
199                 if(stretch_ == fill)\r
200                         target_ratio = Fill();\r
201                 else if(stretch_ == uniform)\r
202                         target_ratio = Uniform();\r
203                 else if(stretch_ == uniform_to_fill)\r
204                         target_ratio = UniformToFill();\r
205 \r
206                 width_ = target_ratio.first;\r
207                 height_ = target_ratio.second;\r
208         }\r
209                 \r
210         std::pair<float, float> None()\r
211         {\r
212                 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
213                 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
214 \r
215                 return std::make_pair(width, height);\r
216         }\r
217 \r
218         std::pair<float, float> Uniform()\r
219         {\r
220                 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);\r
221                 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));\r
222                 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);\r
223 \r
224                 return std::make_pair(width, height);\r
225         }\r
226 \r
227         std::pair<float, float> Fill()\r
228         {\r
229                 return std::make_pair(1.0f, 1.0f);\r
230         }\r
231 \r
232         std::pair<float, float> UniformToFill()\r
233         {\r
234                 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
235                 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
236                 float r_inv = 1.0f/std::min(wr, hr);\r
237 \r
238                 float width = wr*r_inv;\r
239                 float height = hr*r_inv;\r
240 \r
241                 return std::make_pair(width, height);\r
242         }\r
243 \r
244         void render(const safe_ptr<core::read_frame>& frame)\r
245         {                       \r
246                 glBindTexture(GL_TEXTURE_2D, texture_);\r
247 \r
248                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]);\r
249                 glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0);\r
250 \r
251                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]);\r
252                 glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW);\r
253 \r
254                 auto ptr = glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY);\r
255                 if(ptr)\r
256                 {\r
257                         fast_memcpy(reinterpret_cast<char*>(ptr), frame->image_data().begin(), frame->image_data().size());\r
258                         glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER); // release the mapped buffer\r
259                 }\r
260 \r
261                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0);\r
262                                 \r
263                 GL(glClear(GL_COLOR_BUFFER_BIT));                       \r
264                 glBegin(GL_QUADS);\r
265                                 glTexCoord2f(0.0f,        1.0f);        glVertex2f(-width_, -height_);\r
266                                 glTexCoord2f(1.0f,        1.0f);        glVertex2f( width_, -height_);\r
267                                 glTexCoord2f(1.0f,        0.0f);        glVertex2f( width_,  height_);\r
268                                 glTexCoord2f(0.0f,        0.0f);        glVertex2f(-width_,  height_);\r
269                 glEnd();\r
270                 \r
271                 glBindTexture(GL_TEXTURE_2D, 0);\r
272 \r
273                 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());\r
274         }\r
275 \r
276         void send(const safe_ptr<core::read_frame>& frame)\r
277         {\r
278                 frame_buffer_.push_back(frame);\r
279 \r
280                 if(frame_buffer_.full())\r
281                         do_send(frame_buffer_.front());\r
282         }\r
283                 \r
284         void do_send(const safe_ptr<core::read_frame>& frame)\r
285         {               \r
286                 executor_.try_begin_invoke([=]\r
287                 {\r
288                         perf_timer_.restart();\r
289                         sf::Event e;\r
290                         while(window_.GetEvent(e))\r
291                         {\r
292                                 if(e.Type == sf::Event::Resized)\r
293                                          calculate_aspect();\r
294                         }\r
295                         render(frame);\r
296                         window_.Display();\r
297                         graph_->update_value("frame-time", static_cast<float>(perf_timer_.elapsed()*format_desc_.fps*0.5));\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         size_t buffer_depth() const{return 2;}\r
307 };\r
308 \r
309 \r
310 struct ogl_consumer_proxy : public core::frame_consumer\r
311 {\r
312         size_t screen_index_;\r
313         caspar::stretch stretch_;\r
314         bool windowed_;\r
315         bool key_only_;\r
316 \r
317         std::unique_ptr<ogl_consumer> consumer_;\r
318 \r
319 public:\r
320 \r
321         ogl_consumer_proxy(size_t screen_index, stretch stretch, bool windowed, bool key_only)\r
322                 : screen_index_(screen_index)\r
323                 , stretch_(stretch)\r
324                 , windowed_(windowed)\r
325                 , key_only_(key_only){}\r
326         \r
327         virtual void initialize(const core::video_format_desc& format_desc)\r
328         {\r
329                 consumer_.reset(new ogl_consumer(screen_index_, stretch_, windowed_, format_desc));\r
330         }\r
331         \r
332         virtual void send(const safe_ptr<core::read_frame>& frame)\r
333         {\r
334                 consumer_->send(frame);\r
335         }\r
336         \r
337         virtual std::wstring print() const\r
338         {\r
339                 return consumer_->print();\r
340         }\r
341 \r
342         virtual bool key_only() const\r
343         {\r
344                 return key_only_;\r
345         }\r
346 \r
347         virtual bool has_synchronization_clock() const \r
348         {\r
349                 return false;\r
350         }\r
351 \r
352         virtual const core::video_format_desc& get_video_format_desc() const\r
353         {\r
354                 return consumer_->get_video_format_desc();\r
355         }\r
356 };      \r
357 \r
358 safe_ptr<core::frame_consumer> create_ogl_consumer(const std::vector<std::wstring>& params)\r
359 {\r
360         if(params.size() < 1 || params[0] != L"SCREEN")\r
361                 return core::frame_consumer::empty();\r
362         \r
363         size_t screen_index = 0;\r
364         stretch stretch = stretch::fill;\r
365         bool windowed = true;\r
366         \r
367         if(params.size() > 1) \r
368                 screen_index = lexical_cast_or_default<int>(params[2], screen_index);\r
369 \r
370         if(params.size() > 2) \r
371                 windowed = lexical_cast_or_default<bool>(params[3], windowed);\r
372 \r
373         bool key_only = std::find(params.begin(), params.end(), L"KEY_ONLY") != params.end();\r
374 \r
375         return make_safe<ogl_consumer_proxy>(screen_index, stretch, windowed, key_only);\r
376 }\r
377 \r
378 safe_ptr<core::frame_consumer> create_ogl_consumer(const boost::property_tree::ptree& ptree) \r
379 {\r
380         size_t screen_index = ptree.get("device", 0);\r
381         bool windowed =ptree.get("windowed", true);\r
382         \r
383         stretch stretch = stretch::fill;\r
384         auto key_str = ptree.get("stretch", "default");\r
385         if(key_str == "uniform")\r
386                 stretch = stretch::uniform;\r
387         else if(key_str == "uniform_to_fill")\r
388                 stretch = stretch::uniform_to_fill;\r
389 \r
390         bool key_only = ptree.get("key-only", false);\r
391 \r
392         return make_safe<ogl_consumer_proxy>(screen_index, stretch, windowed, key_only);\r
393 }\r
394 \r
395 }