File: egl_main.cpp

package info (click to toggle)
glvis 4.5-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,780 kB
  • sloc: cpp: 35,217; ansic: 5,695; sh: 340; makefile: 301; python: 193
file content (604 lines) | stat: -rw-r--r-- 16,301 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
// Copyright (c) 2010-2026, Lawrence Livermore National Security, LLC. Produced
// at the Lawrence Livermore National Laboratory. All Rights reserved. See files
// LICENSE and NOTICE for details. LLNL-CODE-443271.
//
// This file is part of the GLVis visualization tool and library. For more
// information and source code availability see https://glvis.org.
//
// GLVis is free software; you can redistribute it and/or modify it under the
// terms of the BSD-3 license. We welcome feedback and contributions, see file
// CONTRIBUTING.md for details.

#if defined(GLVIS_USE_EGL) || defined(GLVIS_USE_CGL)

#include <csignal>
#include <iostream>

#include "egl_main.hpp"
#include "../aux_vis.hpp"

#ifdef GLVIS_DEBUG
#define PRINT_DEBUG(s) std::cerr << s
#else
#define PRINT_DEBUG(s) {}
#endif

using namespace std;

struct EglMainThread::CreateWndCmd
{
   EglWindow *wnd;
   int w, h;
   bool legacy_gl;
   promise<Handle> out_handle;
};

struct EglMainThread::ResizeWndCmd
{
   Handle *handle;
   int w, h;
};

struct EglMainThread::DeleteWndCmd
{
   EglWindow *wnd;
   Handle *handle;
};

bool EglMainThread::CreateWndImpl(CreateWndCmd &cmd)
{
   const int multisamples = GetMultisample();
   Handle new_handle;

#ifdef GLVIS_USE_EGL
   // 1. Select an appropriate configuration
   EGLint configAttribs[] =
   {
      EGL_SAMPLE_BUFFERS, (multisamples > 0)?(1):(0), // must be first
      EGL_SAMPLES, multisamples,
      EGL_SURFACE_TYPE, EGL_PBUFFER_BIT,
      EGL_COLOR_BUFFER_TYPE, EGL_RGB_BUFFER,
      EGL_BLUE_SIZE, 8,
      EGL_GREEN_SIZE, 8,
      EGL_RED_SIZE, 8,
      EGL_ALPHA_SIZE, 8,
      EGL_DEPTH_SIZE, 24,
      EGL_CONFORMANT, EGL_OPENGL_BIT,
      EGL_RENDERABLE_TYPE, EGL_OPENGL_BIT,
      EGL_NONE
   };

   EGLint numConfigs;

   if (multisamples > 0)
   {
      if (!eglChooseConfig(disp, configAttribs, NULL, 0, &numConfigs) ||
          numConfigs < 1)
      {
         std::cerr << "EGL with multisampling is not supported, turning it off" <<
                   std::endl;
         // turn off multisampling
         configAttribs[1] = 0;
      }
   }

   if (!eglChooseConfig(disp, configAttribs, &new_handle.eglCfg, 1, &numConfigs) ||
       numConfigs < 1)
   {
      std::cerr << "Cannot find working EGL configuration!" << std::endl;
      return false;
   }

   // 2. Create a surface
   const EGLint pbufferAttribs[] =
   {
      EGL_WIDTH, cmd.w,
      EGL_HEIGHT, cmd.h,
      EGL_NONE
   };

   new_handle.surf = eglCreatePbufferSurface(disp, new_handle.eglCfg,
                                             pbufferAttribs);
   if (new_handle.surf == EGL_NO_SURFACE)
   {
      std::cerr << "Cannot create a pixel buffer, error: " << eglGetError() <<
                std::endl;
      return false;
   }
#endif
#ifdef GLVIS_USE_CGL
   vector<CGLPixelFormatAttribute> pixAttrs =
   {
      kCGLPFASampleBuffers, CGLPixelFormatAttribute((multisamples > 0)?(1):(0)), // must be first
      kCGLPFASamples,       CGLPixelFormatAttribute(multisamples),
      kCGLPFAColorSize,     CGLPixelFormatAttribute(24),
      kCGLPFAAlphaSize,     CGLPixelFormatAttribute(8),
      kCGLPFADepthSize,     CGLPixelFormatAttribute(24),
      kCGLPFAAccelerated, // must be last
      CGLPixelFormatAttribute(0)
   };

   if (cmd.legacy_gl)
   {
      // insert legacy OpenGL compatibility requirement
      auto it = (pixAttrs.end() -= 2);
      pixAttrs.insert(it, {kCGLPFAOpenGLProfile, CGLPixelFormatAttribute(kCGLOGLPVersion_Legacy)});
   }

   GLint numConfigs;
   CGLError err = CGLChoosePixelFormat(pixAttrs.data(), &new_handle.pix,
                                       &numConfigs);
   if (multisamples > 0 && (err != kCGLNoError || numConfigs < 1))
   {
      std::cerr << "CGL with multisampling is not supported, turning it off" <<
                std::endl;
      pixAttrs[1] = CGLPixelFormatAttribute(0);
      err = CGLChoosePixelFormat(pixAttrs.data(), &new_handle.pix, &numConfigs);
   }
   if (err != kCGLNoError || numConfigs < 1)
   {
      std::cerr << "CGL with hardware acceleration not supported, turning it off" <<
                std::endl;
      pixAttrs.pop_back();
      pixAttrs.back() = CGLPixelFormatAttribute(0);
      err = CGLChoosePixelFormat(pixAttrs.data(), &new_handle.pix, &numConfigs);
   }
   if (err != kCGLNoError || numConfigs < 1)
   {
      std::cerr << "Cannot set up CGL pixel format configuration, error: "
                << CGLErrorString(err) << std::endl;
      return false;
   }

   CGLContextObj ctx;
   err = CGLCreateContext(new_handle.pix, nullptr, &ctx);
   if (err != kCGLNoError)
   {
      std::cerr << "Cannot create an OpenGL context, error: "
                << CGLErrorString(err) << std::endl;
      return false;
   }
   new_handle.ctx.reset(ctx);
#endif // GLVIS_USE_CGL

   windows.push_back(cmd.wnd);
   if (num_windows < 0)
   {
      num_windows = 1;
   }
   else
   {
      num_windows++;
   }
   cmd.out_handle.set_value(std::move(new_handle));

   return true;
}

bool EglMainThread::ResizeWndImpl(ResizeWndCmd &cmd)
{
#ifdef GLVIS_USE_EGL
   const EGLint pbufferAttribs[] =
   {
      EGL_WIDTH, cmd.w,
      EGL_HEIGHT, cmd.h,
      EGL_NONE
   };

   EGLSurface surf_new = eglCreatePbufferSurface(disp, cmd.handle->eglCfg,
                                                 pbufferAttribs);
   if (surf_new == EGL_NO_SURFACE)
   {
      std::cerr << "Cannot create a pixel buffer, error: " << eglGetError() <<
                std::endl;
      return false;
   }

   if (!eglDestroySurface(disp, cmd.handle->surf))
   {
      std::cerr << "Cannot destroy surface, error: " << eglGetError() << std::endl;
      return false;
   }

   cmd.handle->surf = surf_new;
#endif
   return true;
}

bool EglMainThread::DeleteWndImpl(DeleteWndCmd &cmd)
{
#ifdef GLVIS_USE_EGL
   if (cmd.handle->ctx != EGL_NO_CONTEXT)
   {
      if (!eglDestroyContext(disp, cmd.handle->ctx))
      {
         std::cerr << "Cannot destroy context, error: " << eglGetError() << std::endl;
         return false;
      }
      cmd.handle->ctx = EGL_NO_CONTEXT;
   }

   if (cmd.handle->surf != EGL_NO_SURFACE)
   {
      if (!eglDestroySurface(disp, cmd.handle->surf))
      {
         std::cerr << "Cannot destroy surface, error: " << eglGetError() << std::endl;
         return false;
      }
      cmd.handle->surf = EGL_NO_SURFACE;
   }
#endif
#ifdef GLVIS_USE_CGL
   if (cmd.handle->isInitialized())
   {
      glDeleteFramebuffers(1, &cmd.handle->buf_frame);
      glDeleteRenderbuffers(1, &cmd.handle->buf_color);
      glDeleteRenderbuffers(1, &cmd.handle->buf_depth);
   }
   if (cmd.handle->pix)
   {
      CGLError err = CGLDestroyPixelFormat(cmd.handle->pix);
      if (err != kCGLNoError)
      {
         std::cerr << "Cannot destroy pixel format, error: "
                   << CGLErrorString(err) << std::endl;
         return false;
      }
      cmd.handle->pix = nullptr;
   }
#endif
   windows.remove(cmd.wnd);
   num_windows--;

   return true;
}

void EglMainThread::QueueWndCmd(CtrlCmd cmd, bool sync)
{
   future<void> wait_complete;
   if (sync)
   {
      wait_complete = cmd.finished.get_future();
   }
   // queue up our event
   {
      lock_guard<mutex> req_lock{window_cmd_mtx};
      window_cmds.emplace_back(std::move(cmd));
   }
   // wake up the main thread to handle our event
   events_available.notify_all();

   if (sync) { wait_complete.get(); }
}

void EglMainThread::InterruptHandler(int param)
{
   EglMainThread::Get().Terminate();
}

EglMainThread::EglMainThread()
{
#ifdef GLVIS_USE_EGL
   if (disp != EGL_NO_DISPLAY)
   {
      return;
   }

   // Initialize EGL
   disp = eglGetDisplay(EGL_DEFAULT_DISPLAY);
   if (disp == EGL_NO_DISPLAY)
   {
      std::cerr << "FATAL: Failed to get an EGL display: " << eglGetError() <<
                std::endl;
      return;
   }

   EGLint major, minor;

   if (!eglInitialize(disp, &major, &minor))
   {
      std::cerr << "FATAL: Failed to initialize EGL: " << eglGetError() << std::endl;
      return;
   }

   std::cout << "Using EGL " << major << "." << minor << std::endl;
#endif
#ifdef GLVIS_USE_CGL
   GLint major, minor;
   CGLGetVersion(&major, &minor);
   std::cout << "Using CGL " << major << "." << minor << std::endl;
#endif
}

EglMainThread::~EglMainThread()
{
#ifdef GLVIS_USE_EGL
   eglTerminate(disp);
#endif
}

EglMainThread &EglMainThread::Get()
{
   static EglMainThread singleton;
   return singleton;
}

EglMainThread::Handle EglMainThread::CreateWindow(EglWindow *caller, int w,
                                                  int h, bool legacy_gl)
{
   CtrlCmd cmd;
   cmd.type = CtrlCmdType::Create;

   CreateWndCmd crt_cmd;
   cmd.create_cmd = &crt_cmd;

   crt_cmd.wnd = caller;
   crt_cmd.w = w;
   crt_cmd.h = h;
   crt_cmd.legacy_gl = legacy_gl;

   auto res_handle = crt_cmd.out_handle.get_future();

   QueueWndCmd(std::move(cmd), false);

   Handle out_hnd = res_handle.get();

#ifdef GLVIS_USE_EGL
   if (out_hnd.surf == EGL_NO_SURFACE)
   {
      return out_hnd;
   }

   // 3. Bind the API
   if (!eglBindAPI(EGL_OPENGL_API))
   {
      std::cerr << "Cannot bind OpenGL API, error: " << eglGetError() << std::endl;
      return out_hnd;
   }

   // 4. Create a context and make it current
   if (legacy_gl)
   {
      // Try and probe for a core/compatibility context. Needed for Mac OS X,
      // which will only support OpenGL 2.1 if you don't create a core context.
      PRINT_DEBUG("Opening OpenGL core profile context..." << std::flush);
      const EGLint attrListCore[] =
      {
         EGL_CONTEXT_OPENGL_PROFILE_MASK, EGL_CONTEXT_OPENGL_CORE_PROFILE_BIT,
         EGL_NONE
      };
      out_hnd.ctx = eglCreateContext(disp, out_hnd.eglCfg, EGL_NO_CONTEXT,
                                     attrListCore);
      if (out_hnd.ctx == EGL_NO_CONTEXT)
      {
         PRINT_DEBUG("failed." << std::endl);
         PRINT_DEBUG("Opening OpenGL compatibility profile context..." << std::flush);
         const EGLint attrListCompat[] =
         {
            EGL_CONTEXT_OPENGL_PROFILE_MASK, EGL_CONTEXT_OPENGL_COMPATIBILITY_PROFILE_BIT,
            EGL_NONE
         };
         out_hnd.ctx = eglCreateContext(disp, out_hnd.eglCfg, EGL_NO_CONTEXT,
                                        attrListCompat);
         if (out_hnd.ctx == EGL_NO_CONTEXT)
         {
            PRINT_DEBUG("failed." << std::endl);
         }
         else
         {
            PRINT_DEBUG("success!" << std::endl);
         }
      }
      else
      {
         PRINT_DEBUG("success!" << std::endl);
      }
   }

   if (out_hnd.ctx == EGL_NO_CONTEXT)
   {
      PRINT_DEBUG("Opening OpenGL context with no flags..." << std::flush);
      out_hnd.ctx = eglCreateContext(disp, out_hnd.eglCfg, EGL_NO_CONTEXT,
                                     NULL);
      if (out_hnd.ctx == EGL_NO_CONTEXT)
      {
         PRINT_DEBUG("failed." << std::endl);
         std::cerr << "Cannot create an EGL context, error: " << eglGetError() <<
                   std::endl;

         return out_hnd;
      }
      else
      {
         PRINT_DEBUG("success!" << std::endl);
      }
   }

   if (!eglMakeCurrent(disp, out_hnd.surf, out_hnd.surf, out_hnd.ctx))
   {
      std::cerr << "Cannot set the EGL context as current, error: " << eglGetError()
                << std::endl;

      return out_hnd;
   }
#endif // GLVIS_USE_EGL
#ifdef GLVIS_USE_CGL
   if (!out_hnd.isInitialized()) { return out_hnd; }
   CGLError err = CGLSetCurrentContext(out_hnd.ctx.get());
   if (err != kCGLNoError) { return out_hnd; }
   // initialize GLEW before using any OpenGL functions
   caller->initGLEW(legacy_gl);
   glGenFramebuffers(1, &out_hnd.buf_frame);
   glGenRenderbuffers(1, &out_hnd.buf_color);
   glGenRenderbuffers(1, &out_hnd.buf_depth);
   ResizeWindow(out_hnd, w, h);
#endif
   return out_hnd;
}

void EglMainThread::ResizeWindow(Handle &handle, int w, int h)
{
   if (!handle.isInitialized()) { return; }

#ifdef GLVIS_USE_EGL
   CtrlCmd cmd;
   cmd.type = CtrlCmdType::Resize;

   ResizeWndCmd res_cmd;
   cmd.resize_cmd = &res_cmd;

   res_cmd.handle = &handle;
   res_cmd.w = w;
   res_cmd.h = h;

   QueueWndCmd(std::move(cmd), true);

   if (!eglMakeCurrent(disp, handle.surf, handle.surf, handle.ctx))
   {
      std::cerr << "Cannot set the EGL context as current, error: " << eglGetError()
                << std::endl;
      return;
   }
#endif
#ifdef GLVIS_USE_CGL
   glBindRenderbuffer(GL_RENDERBUFFER, handle.buf_color);
   glRenderbufferStorage(GL_RENDERBUFFER, GL_RGBA8, w, h);
   glBindRenderbuffer(GL_RENDERBUFFER, handle.buf_depth);
   glRenderbufferStorage(GL_RENDERBUFFER, GL_DEPTH_COMPONENT24, w, h);
   glBindFramebuffer(GL_FRAMEBUFFER, handle.buf_frame);
   glFramebufferRenderbuffer(GL_DRAW_FRAMEBUFFER, GL_COLOR_ATTACHMENT0,
                             GL_RENDERBUFFER, handle.buf_color);
   glFramebufferRenderbuffer(GL_DRAW_FRAMEBUFFER, GL_DEPTH_ATTACHMENT,
                             GL_RENDERBUFFER, handle.buf_depth);
   if (glGetError() != GL_NO_ERROR ||
       glCheckFramebufferStatus(GL_FRAMEBUFFER) != GL_FRAMEBUFFER_COMPLETE)
   {
      std::cerr << "Cannot resize the framebuffer!" << std::endl;
   }
#endif
}

void EglMainThread::DeleteWindow(EglWindow *caller, Handle &handle)
{
   if (!handle.isInitialized()) { return; }

   CtrlCmd cmd;
   cmd.type = CtrlCmdType::Delete;

   DeleteWndCmd del_cmd;
   cmd.delete_cmd = &del_cmd;

   del_cmd.wnd = caller;
   del_cmd.handle = &handle;

   QueueWndCmd(std::move(cmd), true);
}

void EglMainThread::Terminate()
{
   CtrlCmd cmd;
   cmd.type = CtrlCmdType::Terminate;

   // queue to the front to get priority
   {
      lock_guard<mutex> req_lock{window_cmd_mtx};
      window_cmds.emplace_front(std::move(cmd));
   }
   // wake up the main thread to handle our event
   events_available.notify_all();
}

void EglMainThread::MainLoop(bool server)
{
   server_mode = server;
   bool terminating = false;

   // set up interrupt handler for graceful closing
   signal(SIGINT, InterruptHandler);

   while (true)
   {
      bool events_pending = false;
      {
         lock_guard<mutex> evt_guard{window_cmd_mtx};
         events_pending = !window_cmds.empty();
      }
      if (events_pending)
      {
         do
         {
            CtrlCmd cmd;
            // Fetch next event from the queue
            {
               lock_guard<mutex> evt_guard{window_cmd_mtx};
               cmd = std::move(window_cmds.front());
               window_cmds.pop_front();
               events_pending = !window_cmds.empty();
               // Skip non-delete events if terminating
               if (terminating && cmd.type != CtrlCmdType::Delete)
               {
                  continue;
               }
            }

            switch (cmd.type)
            {
               case CtrlCmdType::Create:
                  if (!CreateWndImpl(*cmd.create_cmd))
                  {
                     terminating = true;
                  }
                  break;
               case CtrlCmdType::Resize:
                  if (!ResizeWndImpl(*cmd.resize_cmd))
                  {
                     terminating = true;
                  }
                  break;
               case CtrlCmdType::Delete:
                  if (!DeleteWndImpl(*cmd.delete_cmd))
                  {
                     terminating = true;
                  }
                  break;
               case CtrlCmdType::Terminate:
                  // do not wait for windows to open
                  if (num_windows < 0) { num_windows = 0; }
                  terminating = true;
                  break;
            }

            // Signal completion of the command, in case worker thread is waiting.
            cmd.finished.set_value();
         }
         while (events_pending);
      }

      if (num_windows == 0)
      {
         if (!server_mode || terminating)
         {
            break;
         }
      }

      if (terminating)
      {
         for (EglWindow *wnd : windows)
         {
            wnd->signalQuit();
         }
      }

      {
         unique_lock<mutex> event_lock{window_cmd_mtx};
         events_available.wait(event_lock, [this]()
         {
            // Sleep until events from windows can be handled
            return !window_cmds.empty();
         });
      }
   }
}

#endif // GLVIS_USE_EGL || GLVIS_USE_CGL