]> git.sesse.net Git - casparcg/blob - modules/ogl/consumer/ogl_consumer.cpp
Warn for screen-index instead of throw.
[casparcg] / modules / ogl / consumer / ogl_consumer.cpp
1 /*\r
2 * Copyright (c) 2011 Sveriges Television AB <info@casparcg.com>\r
3 *\r
4 * This file is part of CasparCG (www.casparcg.com).\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 * Author: Robert Nagy, ronag89@gmail.com\r
20 */\r
21 \r
22 #include "ogl_consumer.h"\r
23 \r
24 #include <GL/glew.h>\r
25 #include <SFML/Window.hpp>\r
26 \r
27 #include <common/diagnostics/graph.h>\r
28 #include <common/gl/gl_check.h>\r
29 #include <common/log/log.h>\r
30 #include <common/memory/safe_ptr.h>\r
31 #include <common/memory/memcpy.h>\r
32 #include <common/memory/memshfl.h>\r
33 #include <common/utility/timer.h>\r
34 #include <common/utility/string.h>\r
35 \r
36 #include <ffmpeg/producer/filter/filter.h>\r
37 \r
38 #include <core/video_format.h>\r
39 #include <core/mixer/read_frame.h>\r
40 #include <core/consumer/frame_consumer.h>\r
41 \r
42 #include <boost/timer.hpp>\r
43 #include <boost/circular_buffer.hpp>\r
44 #include <boost/foreach.hpp>\r
45 #include <boost/thread.hpp>\r
46 #include <boost/property_tree/ptree.hpp>\r
47 \r
48 #include <tbb/atomic.h>\r
49 #include <tbb/concurrent_queue.h>\r
50 \r
51 #include <boost/assign.hpp>\r
52 \r
53 #include <algorithm>\r
54 #include <vector>\r
55 \r
56 #if defined(_MSC_VER)\r
57 #pragma warning (push)\r
58 #pragma warning (disable : 4244)\r
59 #endif\r
60 extern "C" \r
61 {\r
62         #define __STDC_CONSTANT_MACROS\r
63         #define __STDC_LIMIT_MACROS\r
64         #include <libavcodec/avcodec.h>\r
65         #include <libavutil/imgutils.h>\r
66 }\r
67 #if defined(_MSC_VER)\r
68 #pragma warning (pop)\r
69 #endif\r
70 \r
71 namespace caspar { namespace ogl {\r
72                 \r
73 enum stretch\r
74 {\r
75         none,\r
76         uniform,\r
77         fill,\r
78         uniform_to_fill\r
79 };\r
80 \r
81 struct configuration\r
82 {\r
83         std::wstring    name;\r
84         size_t                  screen_index;\r
85         stretch                 stretch;\r
86         bool                    windowed;\r
87         bool                    auto_deinterlace;\r
88         bool                    key_only;\r
89 \r
90         configuration()\r
91                 : name(L"ogl")\r
92                 , screen_index(0)\r
93                 , stretch(fill)\r
94                 , windowed(true)\r
95                 , auto_deinterlace(true)\r
96                 , key_only(false)\r
97         {\r
98         }\r
99 };\r
100 \r
101 struct ogl_consumer : boost::noncopyable\r
102 {               \r
103         const configuration             config_;\r
104         core::video_format_desc format_desc_;\r
105         int                                             channel_index_;\r
106 \r
107         GLuint                                  texture_;\r
108         std::vector<GLuint>             pbos_;\r
109         \r
110         float                                   width_;\r
111         float                                   height_;        \r
112         unsigned int                    screen_x_;\r
113         unsigned int                    screen_y_;\r
114         unsigned int                    screen_width_;\r
115         unsigned int                    screen_height_;\r
116         size_t                                  square_width_;\r
117         size_t                                  square_height_;                         \r
118         \r
119         sf::Window                              window_;\r
120         \r
121         safe_ptr<diagnostics::graph>    graph_;\r
122         boost::timer                                    perf_timer_;\r
123         boost::timer                                    tick_timer_;\r
124 \r
125         tbb::concurrent_bounded_queue<safe_ptr<core::read_frame>>       frame_buffer_;\r
126 \r
127         boost::thread                   thread_;\r
128         tbb::atomic<bool>               is_running_;\r
129         \r
130         ffmpeg::filter                  filter_;\r
131 public:\r
132         ogl_consumer(const configuration& config, const core::video_format_desc& format_desc, int channel_index) \r
133                 : config_(config)\r
134                 , format_desc_(format_desc)\r
135                 , channel_index_(channel_index)\r
136                 , texture_(0)\r
137                 , pbos_(2, 0)   \r
138                 , screen_width_(format_desc.width)\r
139                 , screen_height_(format_desc.height)\r
140                 , square_width_(format_desc.square_width)\r
141                 , square_height_(format_desc.square_height)\r
142                 , filter_(format_desc.field_mode == core::field_mode::progressive || !config.auto_deinterlace ? L"" : L"YADIF=0:-1", boost::assign::list_of(PIX_FMT_BGRA))\r
143         {               \r
144                 frame_buffer_.set_capacity(2);\r
145                 \r
146                 graph_->add_guide("tick-time", 0.5);\r
147                 graph_->set_color("tick-time", diagnostics::color(0.0f, 0.6f, 0.9f));   \r
148                 graph_->set_color("frame-time", diagnostics::color(0.1f, 1.0f, 0.1f));\r
149                 graph_->set_color("dropped-frame", diagnostics::color(0.3f, 0.6f, 0.3f));\r
150                 graph_->set_text(print());\r
151                 diagnostics::register_graph(graph_);\r
152                                                                         \r
153                 DISPLAY_DEVICE d_device = {sizeof(d_device), 0};                        \r
154                 std::vector<DISPLAY_DEVICE> displayDevices;\r
155                 for(int n = 0; EnumDisplayDevices(NULL, n, &d_device, NULL); ++n)\r
156                         displayDevices.push_back(d_device);\r
157 \r
158                 if(config_.screen_index >= displayDevices.size())\r
159                         CASPAR_LOG(warning) << print() << L" Invalid screen-index: " << config_.screen_index;\r
160                 \r
161                 DEVMODE devmode = {};\r
162                 if(!EnumDisplaySettings(displayDevices[config_.screen_index].DeviceName, ENUM_CURRENT_SETTINGS, &devmode))\r
163                         CASPAR_LOG(warning) << print() << L" Could not find display settings for screen-index: " << config_.screen_index;\r
164                 \r
165                 screen_x_               = devmode.dmPosition.x;\r
166                 screen_y_               = devmode.dmPosition.y;\r
167                 screen_width_   = config_.windowed ? square_width_ : devmode.dmPelsWidth;\r
168                 screen_height_  = config_.windowed ? square_height_ : devmode.dmPelsHeight;\r
169                 \r
170                 is_running_ = true;\r
171                 thread_ = boost::thread([this]{run();});\r
172         }\r
173         \r
174         ~ogl_consumer()\r
175         {\r
176                 is_running_ = false;\r
177                 frame_buffer_.try_push(make_safe<core::read_frame>());\r
178                 thread_.join();\r
179         }\r
180 \r
181         void init()\r
182         {\r
183                 if(!GLEW_VERSION_2_1)\r
184                         BOOST_THROW_EXCEPTION(not_supported() << msg_info("Missing OpenGL 2.1 support."));\r
185 \r
186                 window_.Create(sf::VideoMode(screen_width_, screen_height_, 32), narrow(print()), config_.windowed ? sf::Style::Resize | sf::Style::Close : sf::Style::Fullscreen);\r
187                 window_.ShowMouseCursor(false);\r
188                 window_.SetPosition(screen_x_, screen_y_);\r
189                 window_.SetSize(screen_width_, screen_height_);\r
190                 window_.SetActive();\r
191                 GL(glEnable(GL_TEXTURE_2D));\r
192                 GL(glDisable(GL_DEPTH_TEST));           \r
193                 GL(glClearColor(0.0, 0.0, 0.0, 0.0));\r
194                 GL(glViewport(0, 0, format_desc_.width, format_desc_.height));\r
195                 GL(glLoadIdentity());\r
196                                 \r
197                 calculate_aspect();\r
198                         \r
199                 GL(glGenTextures(1, &texture_));\r
200                 GL(glBindTexture(GL_TEXTURE_2D, texture_));\r
201                 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_LINEAR));\r
202                 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_LINEAR));\r
203                 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP));\r
204                 GL(glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP));\r
205                 GL(glTexImage2D(GL_TEXTURE_2D, 0, GL_RGBA8, format_desc_.width, format_desc_.height, 0, GL_BGRA, GL_UNSIGNED_BYTE, 0));\r
206                 GL(glBindTexture(GL_TEXTURE_2D, 0));\r
207                                         \r
208                 GL(glGenBuffers(2, pbos_.data()));\r
209                         \r
210                 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[0]);\r
211                 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
212                 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, pbos_[1]);\r
213                 glBufferDataARB(GL_PIXEL_UNPACK_BUFFER_ARB, format_desc_.size, 0, GL_STREAM_DRAW_ARB);\r
214                 glBindBufferARB(GL_PIXEL_UNPACK_BUFFER_ARB, 0);\r
215 \r
216                 CASPAR_LOG(info) << print() << " Successfully Initialized.";\r
217         }\r
218 \r
219         void uninit()\r
220         {               \r
221                 if(texture_)\r
222                         glDeleteTextures(1, &texture_);\r
223 \r
224                 BOOST_FOREACH(auto& pbo, pbos_)\r
225                 {\r
226                         if(pbo)\r
227                                 glDeleteBuffers(1, &pbo);\r
228                 }\r
229         }\r
230 \r
231         void run()\r
232         {\r
233                 try\r
234                 {\r
235                         init();\r
236 \r
237                         while(is_running_)\r
238                         {                       \r
239                                 try\r
240                                 {\r
241 \r
242                                         sf::Event e;            \r
243                                         while(window_.GetEvent(e))\r
244                                         {\r
245                                                 if(e.Type == sf::Event::Resized)\r
246                                                         calculate_aspect();\r
247                                                 else if(e.Type == sf::Event::Closed)\r
248                                                         is_running_ = false;\r
249                                         }\r
250                         \r
251                                         safe_ptr<core::read_frame> frame;\r
252                                         frame_buffer_.pop(frame);\r
253                                         \r
254                                         perf_timer_.restart();\r
255                                         render(frame);\r
256                                         graph_->update_value("frame-time", perf_timer_.elapsed()*format_desc_.fps*0.5); \r
257 \r
258                                         window_.Display();\r
259                                         \r
260                                         graph_->update_value("tick-time", tick_timer_.elapsed()*format_desc_.fps*0.5);  \r
261                                         tick_timer_.restart();\r
262                                 }\r
263                                 catch(...)\r
264                                 {\r
265                                         CASPAR_LOG_CURRENT_EXCEPTION();\r
266                                         is_running_ = false;\r
267                                 }\r
268                         }\r
269 \r
270                         uninit();\r
271                 }\r
272                 catch(...)\r
273                 {\r
274                         CASPAR_LOG_CURRENT_EXCEPTION();\r
275                 }\r
276         }\r
277         \r
278         safe_ptr<AVFrame> get_av_frame()\r
279         {               \r
280                 safe_ptr<AVFrame> av_frame(avcodec_alloc_frame(), av_free);     \r
281                 avcodec_get_frame_defaults(av_frame.get());\r
282                                                 \r
283                 av_frame->linesize[0]           = format_desc_.width*4;                 \r
284                 av_frame->format                        = PIX_FMT_BGRA;\r
285                 av_frame->width                         = format_desc_.width;\r
286                 av_frame->height                        = format_desc_.height;\r
287                 av_frame->interlaced_frame      = format_desc_.field_mode != core::field_mode::progressive;\r
288                 av_frame->top_field_first       = format_desc_.field_mode == core::field_mode::upper ? 1 : 0;\r
289 \r
290                 return av_frame;\r
291         }\r
292 \r
293         void render(const safe_ptr<core::read_frame>& frame)\r
294         {                       \r
295                 if(static_cast<size_t>(frame->image_data().size()) != format_desc_.size)\r
296                         return;\r
297                                         \r
298                 auto av_frame = get_av_frame();\r
299                 av_frame->data[0] = const_cast<uint8_t*>(frame->image_data().begin());\r
300 \r
301                 filter_.push(av_frame);\r
302                 auto frames = filter_.poll_all();\r
303 \r
304                 if(frames.empty())\r
305                         return;\r
306 \r
307                 av_frame = frames[0];\r
308 \r
309                 if(av_frame->linesize[0] != static_cast<int>(format_desc_.width*4))\r
310                 {\r
311                         const uint8_t *src_data[4] = {0};\r
312                         memcpy(const_cast<uint8_t**>(&src_data[0]), av_frame->data, 4);\r
313                         const int src_linesizes[4] = {0};\r
314                         memcpy(const_cast<int*>(&src_linesizes[0]), av_frame->linesize, 4);\r
315 \r
316                         auto av_frame2 = get_av_frame();\r
317                         av_image_alloc(av_frame2->data, av_frame2->linesize, av_frame2->width, av_frame2->height, PIX_FMT_BGRA, 16);\r
318                         av_frame = safe_ptr<AVFrame>(av_frame2.get(), [=](AVFrame*)\r
319                         {\r
320                                 av_freep(&av_frame2->data[0]);\r
321                         });\r
322 \r
323                         av_image_copy(av_frame2->data, av_frame2->linesize, src_data, src_linesizes, PIX_FMT_BGRA, av_frame2->width, av_frame2->height);\r
324                 }\r
325 \r
326                 glBindTexture(GL_TEXTURE_2D, texture_);\r
327 \r
328                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[0]);\r
329                 glTexSubImage2D(GL_TEXTURE_2D, 0, 0, 0, format_desc_.width, format_desc_.height, GL_BGRA, GL_UNSIGNED_BYTE, 0);\r
330 \r
331                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, pbos_[1]);\r
332                 glBufferData(GL_PIXEL_UNPACK_BUFFER, format_desc_.size, 0, GL_STREAM_DRAW);\r
333 \r
334                 auto ptr = glMapBuffer(GL_PIXEL_UNPACK_BUFFER, GL_WRITE_ONLY);\r
335                 if(ptr)\r
336                 {\r
337                         if(config_.key_only)\r
338                                 fast_memshfl(reinterpret_cast<char*>(ptr), av_frame->data[0], frame->image_data().size(), 0x0F0F0F0F, 0x0B0B0B0B, 0x07070707, 0x03030303);\r
339                         else\r
340                                 fast_memcpy(reinterpret_cast<char*>(ptr), av_frame->data[0], frame->image_data().size());\r
341 \r
342                         glUnmapBuffer(GL_PIXEL_UNPACK_BUFFER); // release the mapped buffer\r
343                 }\r
344 \r
345                 glBindBuffer(GL_PIXEL_UNPACK_BUFFER, 0);\r
346                                 \r
347                 GL(glClear(GL_COLOR_BUFFER_BIT));                       \r
348                 glBegin(GL_QUADS);\r
349                                 glTexCoord2f(0.0f,        1.0f);        glVertex2f(-width_, -height_);\r
350                                 glTexCoord2f(1.0f,        1.0f);        glVertex2f( width_, -height_);\r
351                                 glTexCoord2f(1.0f,        0.0f);        glVertex2f( width_,  height_);\r
352                                 glTexCoord2f(0.0f,        0.0f);        glVertex2f(-width_,  height_);\r
353                 glEnd();\r
354                 \r
355                 glBindTexture(GL_TEXTURE_2D, 0);\r
356 \r
357                 std::rotate(pbos_.begin(), pbos_.begin() + 1, pbos_.end());\r
358         }\r
359 \r
360         bool send(const safe_ptr<core::read_frame>& frame)\r
361         {\r
362                 if(!frame_buffer_.try_push(frame))\r
363                         graph_->add_tag("dropped-frame");\r
364                 return is_running_;\r
365         }\r
366                 \r
367         std::wstring print() const\r
368         {       \r
369                 return config_.name + L"[" + boost::lexical_cast<std::wstring>(channel_index_) + L"|" + format_desc_.name + L"]";\r
370         }\r
371         \r
372         void calculate_aspect()\r
373         {\r
374                 if(config_.windowed)\r
375                 {\r
376                         screen_height_ = window_.GetHeight();\r
377                         screen_width_ = window_.GetWidth();\r
378                 }\r
379                 \r
380                 GL(glViewport(0, 0, screen_width_, screen_height_));\r
381 \r
382                 std::pair<float, float> target_ratio = None();\r
383                 if(config_.stretch == fill)\r
384                         target_ratio = Fill();\r
385                 else if(config_.stretch == uniform)\r
386                         target_ratio = Uniform();\r
387                 else if(config_.stretch == uniform_to_fill)\r
388                         target_ratio = UniformToFill();\r
389 \r
390                 width_ = target_ratio.first;\r
391                 height_ = target_ratio.second;\r
392         }\r
393                 \r
394         std::pair<float, float> None()\r
395         {\r
396                 float width = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
397                 float height = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
398 \r
399                 return std::make_pair(width, height);\r
400         }\r
401 \r
402         std::pair<float, float> Uniform()\r
403         {\r
404                 float aspect = static_cast<float>(square_width_)/static_cast<float>(square_height_);\r
405                 float width = std::min(1.0f, static_cast<float>(screen_height_)*aspect/static_cast<float>(screen_width_));\r
406                 float height = static_cast<float>(screen_width_*width)/static_cast<float>(screen_height_*aspect);\r
407 \r
408                 return std::make_pair(width, height);\r
409         }\r
410 \r
411         std::pair<float, float> Fill()\r
412         {\r
413                 return std::make_pair(1.0f, 1.0f);\r
414         }\r
415 \r
416         std::pair<float, float> UniformToFill()\r
417         {\r
418                 float wr = static_cast<float>(square_width_)/static_cast<float>(screen_width_);\r
419                 float hr = static_cast<float>(square_height_)/static_cast<float>(screen_height_);\r
420                 float r_inv = 1.0f/std::min(wr, hr);\r
421 \r
422                 float width = wr*r_inv;\r
423                 float height = hr*r_inv;\r
424 \r
425                 return std::make_pair(width, height);\r
426         }\r
427 };\r
428 \r
429 \r
430 struct ogl_consumer_proxy : public core::frame_consumer\r
431 {\r
432         const configuration config_;\r
433         std::unique_ptr<ogl_consumer> consumer_;\r
434 \r
435 public:\r
436 \r
437         ogl_consumer_proxy(const configuration& config)\r
438                 : config_(config){}\r
439         \r
440         ~ogl_consumer_proxy()\r
441         {\r
442                 if(consumer_)\r
443                 {\r
444                         auto str = print();\r
445                         consumer_.reset();\r
446                         CASPAR_LOG(info) << str << L" Successfully Uninitialized.";     \r
447                 }\r
448         }\r
449 \r
450         // frame_consumer\r
451 \r
452         virtual void initialize(const core::video_format_desc& format_desc, int channel_index) override\r
453         {\r
454                 consumer_.reset();\r
455                 consumer_.reset(new ogl_consumer(config_, format_desc, channel_index));\r
456                 CASPAR_LOG(info) << print() << L" Successfully Initialized.";   \r
457         }\r
458         \r
459         virtual bool send(const safe_ptr<core::read_frame>& frame) override\r
460         {\r
461                 return consumer_->send(frame);\r
462         }\r
463         \r
464         virtual std::wstring print() const override\r
465         {\r
466                 return consumer_ ? consumer_->print() : L"[ogl_consumer]";\r
467         }\r
468 \r
469         virtual boost::property_tree::wptree info() const override\r
470         {\r
471                 boost::property_tree::wptree info;\r
472                 info.add(L"type", L"ogl-consumer");\r
473                 info.add(L"key-only", config_.key_only);\r
474                 info.add(L"windowed", config_.windowed);\r
475                 info.add(L"auto-deinterlace", config_.auto_deinterlace);\r
476                 return info;\r
477         }\r
478 \r
479         virtual bool has_synchronization_clock() const override\r
480         {\r
481                 return false;\r
482         }\r
483         \r
484         virtual size_t buffer_depth() const override\r
485         {\r
486                 return 1;\r
487         }\r
488 \r
489         virtual int index() const override\r
490         {\r
491                 return 600;\r
492         }\r
493 };      \r
494 \r
495 safe_ptr<core::frame_consumer> create_consumer(const std::vector<std::wstring>& params)\r
496 {\r
497         if(params.size() < 1 || params[0] != L"SCREEN")\r
498                 return core::frame_consumer::empty();\r
499         \r
500         configuration config;\r
501                 \r
502         if(params.size() > 1) \r
503                 config.screen_index = lexical_cast_or_default<int>(params[2], config.screen_index);\r
504 \r
505         if(params.size() > 2) \r
506                 config.windowed = lexical_cast_or_default<bool>(params[3], config.windowed);\r
507 \r
508         config.key_only = std::find(params.begin(), params.end(), L"KEY_ONLY") != params.end();\r
509 \r
510         return make_safe<ogl_consumer_proxy>(config);\r
511 }\r
512 \r
513 safe_ptr<core::frame_consumer> create_consumer(const boost::property_tree::wptree& ptree) \r
514 {\r
515         configuration config;\r
516         config.name                             = ptree.get(L"name",     config.name);\r
517         config.screen_index             = ptree.get(L"device",   config.screen_index+1)-1;\r
518         config.windowed                 = ptree.get(L"windowed", config.windowed);\r
519         config.key_only                 = ptree.get(L"key-only", config.key_only);\r
520         config.auto_deinterlace = ptree.get(L"auto-deinterlace", config.auto_deinterlace);\r
521         \r
522         auto stretch_str = ptree.get(L"stretch", L"default");\r
523         if(stretch_str == L"uniform")\r
524                 config.stretch = stretch::uniform;\r
525         else if(stretch_str == L"uniform_to_fill")\r
526                 config.stretch = stretch::uniform_to_fill;\r
527         \r
528         return make_safe<ogl_consumer_proxy>(config);\r
529 }\r
530 \r
531 }}