File: WindowWin32.cpp

package info (click to toggle)
pd-vstplugin 0.6.1-1~exp1
  • links: PTS, VCS
  • area: main
  • in suites:
  • size: 2,008 kB
  • sloc: cpp: 22,783; lisp: 2,860; makefile: 37; sh: 26
file content (664 lines) | stat: -rw-r--r-- 19,258 bytes parent folder | download | duplicates (2)
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
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
#include "WindowWin32.h"

#include "PluginDesc.h"
#include "Log.h"
#include "FileUtils.h"
#include "MiscUtils.h"

#include <cassert>
#include <cstring>

namespace vst {

static DWORD gParentProcessId = 0;

void setParentProcess(int pid) {
    gParentProcessId = pid;
}

namespace UIThread {

static thread_local bool gCurrentThreadUI = false;

// NB: this check must *not* implicitly create the event loop!
bool isCurrentThread() {
    return gCurrentThreadUI;
}

void setup() {
    // HACK: this tells the EventLoop constructor that it shouldn't create an UI thread
    gCurrentThreadUI = true;
    Win32::EventLoop::instance();
}

void run() {
    Win32::EventLoop::instance().run();
}

void quit() {
    Win32::EventLoop::instance().quit();
}

bool available() { return true; }

void poll(){}

bool sync(){
    return Win32::EventLoop::instance().sync();
}

bool callSync(Callback cb, void *user){
    return Win32::EventLoop::instance().callSync(cb, user);
}

bool callAsync(Callback cb, void *user){
    return Win32::EventLoop::instance().callAsync(cb, user);
}

int32_t addPollFunction(PollFunction fn, void *context){
    return Win32::EventLoop::instance().addPollFunction(fn, context);
}

void removePollFunction(int32_t handle){
    return Win32::EventLoop::instance().removePollFunction(handle);
}

} // UIThread

namespace Win32 {

/*/////////////////// EventLoop //////////////////////*/

EventLoop& EventLoop::instance(){
    static EventLoop thread;
    return thread;
}

// NOTE: we use a window procedure to make sure that events are also processed
// during a modal loop!
LRESULT WINAPI EventLoop::procedure(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam){
    auto self = (EventLoop *)GetWindowLongPtr(hWnd, GWLP_USERDATA);

    switch (msg) {
    case WM_CALL:
    {
        // LOG_DEBUG("WM_CALL");
        auto cb = (UIThread::Callback)wParam;
        auto data = (void *)lParam;
        if (cb) {
            cb(data);
        }
        return true;
    }
    case WM_SYNC:
        // LOG_DEBUG("WM_SYNC");
        assert(self != nullptr);
        self->event_.set();
        return true;
    case WM_TIMER:
        // LOG_DEBUG("WM_TIMER");
        assert(self != nullptr);
        self->handleTimer(wParam);
        return true;
    default:
        LOG_DEBUG("Win32: root window received message " << msg);
        return DefWindowProcW(hWnd, msg, wParam, lParam);
    }
}

EventLoop::EventLoop(){
    LOG_DEBUG("Win32: setup EventLoop");
    // setup window classes
    WNDCLASSEXW wcex;
    // 1. root window class
    memset(&wcex, 0, sizeof(WNDCLASSEXW));
    wcex.cbSize = sizeof(WNDCLASSEXW);
    wcex.lpfnWndProc = EventLoop::procedure;
    wcex.lpszClassName =  VST_ROOT_CLASS_NAME;
    if (!RegisterClassExW(&wcex)){
        LOG_WARNING("Win32: couldn't register root window class!");
    } else {
        LOG_DEBUG("Win32: registered root window class!");
    }
    // 2. editor window class
    memset(&wcex, 0, sizeof(WNDCLASSEXW));
    wcex.cbSize = sizeof(WNDCLASSEXW);
    wcex.lpfnWndProc = Window::procedure;
    wcex.lpszClassName =  VST_EDITOR_CLASS_NAME;
    wcex.hIcon = getIcon();
    if (!RegisterClassExW(&wcex)){
        LOG_WARNING("Win32: couldn't register editor window class!");
    } else {
        LOG_DEBUG("Win32: registered editor window class!");
    }

    if (UIThread::isCurrentThread()) {
        initUIThread();
    } else {
        // create UI thread
        LOG_DEBUG("Win32: start UI thread");
        thread_ = std::thread([this](){
            initUIThread();
            event_.set(); // notify constructor
            run();
        });
    #if !JOIN_UI_THREAD
        thread_.detach();
    #endif
        // wait for thread to create message queue
        LOG_DEBUG("Win32: wait for event");
        event_.wait();
    }

    LOG_DEBUG("Win32: EventLoop ready");
}

EventLoop::~EventLoop() {
#if JOIN_UI_THREAD
    if (thread_.joinable()) {
        if (postMessage(WM_QUIT)) {
            thread_.join();
            LOG_DEBUG("Win32: joined UI thread");
        } else {
            LOG_DEBUG("Win32: couldn't post quit message!");
            thread_.detach();
        }
    }
#endif
    LOG_DEBUG("Win32: EventLoop quit");
}

void EventLoop::run() {
    assert(UIThread::isCurrentThread());
    LOG_DEBUG("Win32: start message loop");
    MSG msg;
    DWORD ret;
    while ((ret = GetMessage(&msg, NULL, 0, 0)) > 0) {
#if 0
        if (!(msg.hwnd == hwnd && msg.message == WM_TIMER)) {
            LOG_DEBUG("dispatch message " << msg.message);
        }
#endif
        TranslateMessage(&msg);
        DispatchMessage(&msg);
    }
    if (ret < 0) {
        LOG_ERROR("Win32: GetMessage() failed (" << GetLastError() << ")");
    }
    LOG_DEBUG("Win32: quit message loop");

    DestroyWindow(hwnd_);

    // let's be nice
    CoUninitialize();
}

void EventLoop::quit() {
    if (!postMessage(WM_QUIT)) {
        LOG_ERROR("Win32: could not post WM_QUIT message!");
    }
}

void EventLoop::initUIThread() {
    setThreadPriority(Priority::Low);

    // some plugin UIs (e.g. VSTGUI) need COM!
    CoInitialize(nullptr);

    UIThread::gCurrentThreadUI = true;
    // invisible window for postMessage()!
    // also creates the message queue
    hwnd_ = CreateWindowW(
          VST_ROOT_CLASS_NAME, L"Untitled",
          0, CW_USEDEFAULT, 0, CW_USEDEFAULT, 0,
          NULL, NULL, NULL, NULL
    );
    if (hwnd_ == NULL) {
        throw Error(Error::SystemError, "Win32: could not create root window!");
    }
    SetWindowLongPtr(hwnd_, GWLP_USERDATA, (LONG_PTR)this);
}

// IMPORTANT: do not use PostThreadMessage() because the message
// would be eaten by a modal loop! Instead, we send the message
// to an invisible window.
bool EventLoop::postMessage(UINT msg, void *data1, void *data2){
    return PostMessage(hwnd_, msg, (WPARAM)data1, (LPARAM)data2);
}

bool EventLoop::callAsync(UIThread::Callback cb, void *user){
    if (UIThread::isCurrentThread()){
        cb(user);
        return true;
    } else {
        return postMessage(WM_CALL, (void *)cb, user);
    }
}

// IMPORTANT: it might be tempting to use SendMessage, as it will
// block until the window procedure has completely. However, messages
// sent with SendMessage() are not necessarily delivered in the same
// order as with PostMessage()! For example, if the UI thread blocks
// in DispatchMessage() and you call PostMessage(), followed by
// SendMessage(), the two message might be dispatched in the opposite
// order! This can lead to weird and hard to find bugs, e.g. a Window
// getting closed after the plugin has been destroyed.
//
// Instead we use a dedicated WM_SYNC message together with a
// SyncCondition to guarantee that callAsync() and callSync() are
// always executed in sequence.
bool EventLoop::callSync(UIThread::Callback cb, void *user){
    if (UIThread::isCurrentThread()){
        cb(user);
        return true;
    } else {
        // This must never be called concurrently!
        std::lock_guard lock(mutex_);
        if (!postMessage(WM_CALL, (void *)cb, user)) {
            return false;
        }
        if (!postMessage(WM_SYNC)) {
            return false;
        }
        LOG_DEBUG("Win32: wait for sync event...");
        event_.wait();
        LOG_DEBUG("Win32: synchronized");
        return true;
    }
}

bool EventLoop::sync(){
    if (UIThread::isCurrentThread()){
        return true;
    } else {
        // This must never be called concurrently!
        std::lock_guard lock(mutex_);
        if (!postMessage(WM_SYNC)) {
            return false;
        }
        LOG_DEBUG("Win32: wait for sync event...");
        event_.wait();
        LOG_DEBUG("Win32: synchronized");
        return true;
    }
}

void EventLoop::handleTimer(UINT_PTR id) {
    if (id == pollTimerID) {
        doPoll(); // call poll functions
    } else {
        LOG_DEBUG("Win32: unknown timer " << id);
    }
}

void EventLoop::startPolling() {
    SetTimer(hwnd_, pollTimerID, updateIntervalMillis, NULL);
}

void EventLoop::stopPolling() {
    KillTimer(hwnd_, pollTimerID);
}

HICON EventLoop::getIcon() {
#ifndef __WINE__
    // On Wine, for some reason, QueryFullProcessImageName() would silently truncate
    // the path name after a certain number of characters...
    // NOTE: Wine also requires to link explicitly to "shell32" for 'ExtractIconW'!
    // Generally, the question is whether the icon is actually useful on Linux;
    // with Gnome, at least, it doesn't seem so, but I need to test other desktops.
    wchar_t exeFileName[MAX_PATH];
    exeFileName[0] = 0;
    // 1) first try to get icon from the (parent) process
    if (gParentProcessId != 0) {
        // get file path of parent process
        auto hProcess = OpenProcess(PROCESS_QUERY_INFORMATION | PROCESS_VM_READ,
                                    FALSE, gParentProcessId);
        if (hProcess){
            DWORD size = MAX_PATH;
            if (!QueryFullProcessImageNameW(hProcess, 0, exeFileName, &size)) {
                LOG_ERROR("QueryFullProcessImageName() failed: " << errorMessage(GetLastError()));
            }
        } else {
            LOG_ERROR("OpenProcess() failed: " << errorMessage(GetLastError()));
        }
        CloseHandle(hProcess);
    } else {
        // get file path of this process
        if (GetModuleFileNameW(NULL, exeFileName, MAX_PATH) == 0) {
            LOG_ERROR("GetModuleFileName() failed: " << errorMessage(GetLastError()));
        }
    }
    auto hIcon = ExtractIconW(NULL, exeFileName, 0);
    if ((uintptr_t)hIcon > 1) {
        LOG_DEBUG("Win32: extracted icon from " << shorten(exeFileName));
        return hIcon;
    } else {
        LOG_DEBUG("Win32: could not extract icon from " << shorten(exeFileName));
    }
    // 2) try to get icon from our plugin DLL
    auto hInstance = (HINSTANCE)getModuleHandle();
    if (hInstance) {
        // a) we are inside the DLL
        if (GetModuleFileNameW(hInstance, exeFileName, MAX_PATH) != 0) {
            hIcon = ExtractIconW(NULL, exeFileName, 0);
            if ((uintptr_t)hIcon > 1) {
                LOG_DEBUG("Win32: extracted icon from " << shorten(exeFileName));
                return hIcon;
            } else {
                LOG_DEBUG("Win32: could not extract icon from " << shorten(exeFileName));
            }
        } else {
            LOG_ERROR("GetModuleFileName() failed: " << errorMessage(GetLastError()));
        }
    } else {
        // b) we are inside the host process
        std::vector<std::string> pluginPaths = {
            getModuleDirectory() + "\\vstplugin~.dll", // for now assume the default extension
            getModuleDirectory() + "\\VSTPlugin.scx",
            getModuleDirectory() + "\\VSTPlugin_supernova.scx"
        };
        for (auto& path : pluginPaths) {
            if (pathExists(path)) {
                hIcon = ExtractIconW(NULL, widen(path).c_str(), 0);
                if ((uintptr_t)hIcon > 1) {
                    return hIcon;
                    LOG_DEBUG("Win32: extracted icon from " << path);
                    break;
                } else {
                    LOG_DEBUG("Win32: could not extract icon from " << path);
                }
            }
        }
    }
#endif
    return (HICON)0;
}

/*///////////////////////// Window ///////////////////////////*/

Window::Window(IPlugin& plugin)
    : plugin_(&plugin) {}

Window::~Window(){
    doClose();
}

bool Window::canResize() const {
    return plugin_->info().editorResizable();
}

LRESULT WINAPI Window::procedure(HWND hWnd, UINT msg, WPARAM wParam, LPARAM lParam){
    auto window = (Window *)GetWindowLongPtr(hWnd, GWLP_USERDATA);

    switch (msg){
    case WM_CLOSE: // intercept close event!
    {
        if (window){
            window->doClose();
        } else {
            LOG_ERROR("Win32: bug GetWindowLongPtr");
        }
        return true;
    }
    case WM_SIZING:
    {
        LOG_DEBUG("Win32: WM_SIZING");
        if (window){
            window->onSizing(*(RECT *)lParam);
        } else {
            LOG_ERROR("Win32: bug GetWindowLongPtr");
        }
        return true;
    }
    case WM_SIZE:
    {
        LOG_DEBUG("Win32: WM_SIZE");
        if (wParam == SIZE_MAXIMIZED || wParam == SIZE_RESTORED){
            if (window){
                window->onSize(LOWORD(lParam), HIWORD(lParam));
            } else {
                LOG_ERROR("Win32: bug GetWindowLongPtr");
            }
        }
        return true;
    }
    default:
        return DefWindowProcW(hWnd, msg, wParam, lParam);
    }
}

void CALLBACK Window::updateEditor(HWND hwnd, UINT msg, UINT_PTR id, DWORD time){
    auto window = (Window *)GetWindowLongPtr(hwnd, GWLP_USERDATA);
    if (window){
        window->plugin_->updateEditor();
        // LOG_DEBUG("update editor");
    } else {
        LOG_ERROR("Win32: bug GetWindowLongPtr");
    }
}

void Window::open(){
    EventLoop::instance().callAsync([](void *x){
        static_cast<Window *>(x)->doOpen();
    }, this);
}

void Window::doOpen(){
    LOG_DEBUG("Win32: open window");
    if (hwnd_){
        // just show the window
        ShowWindow(hwnd_, SW_MINIMIZE);
        ShowWindow(hwnd_, SW_RESTORE);
        BringWindowToTop(hwnd_);
        LOG_DEBUG("Win32: restore");
        return;
    }

    // no maximize box if plugin view can't be resized
    DWORD dwStyle = canResize() ?
                WS_OVERLAPPEDWINDOW :
                (WS_OVERLAPPED | WS_CAPTION | WS_SYSMENU | WS_MINIMIZEBOX);
    // already set 'hwnd_' in the beginning because openEditor()
    // might implicitly call setSize()!
    hwnd_ = CreateWindowW(
          VST_EDITOR_CLASS_NAME, L"Untitled",
          dwStyle, CW_USEDEFAULT, 0, CW_USEDEFAULT, 0,
          NULL, NULL, NULL, NULL
    );
    LOG_DEBUG("Win32: created Window");
    // set window title
    SetWindowTextW(hwnd_, widen(plugin_->info().name).c_str());
    // set user data
    SetWindowLongPtr(hwnd_, GWLP_USERDATA, (LONG_PTR)this);

    // set window coordinates
    bool didOpen = false;
    if (rect_.valid()){
        LOG_DEBUG("Win32: restore editor rect");
        // restore from cached rect
        // NOTE: restoring the size doesn't work if openEditor()
        // calls setSize() in turn! I've tried various workarounds,
        // like setting a flag and bashing the size in setSize(),
        // but they all cause weirdness...
    } else {
        // get window dimensions from plugin
        Rect r;
        if (!plugin_->getEditorRect(r)){
            // HACK for plugins which don't report the window size
            // without the editor being opened
            LOG_DEBUG("Win32: couldn't get editor rect!");
            plugin_->openEditor(hwnd_);
            plugin_->getEditorRect(r);
            didOpen = true;
        }
        LOG_DEBUG("Win32: editor size: " << r.w << " * " << r.h);
        rect_.w = r.w;
        rect_.h = r.h;
        adjustSize_ = true; // !
    }

    updateFrame();

    // open VST editor
    if (!didOpen){
        plugin_->openEditor(hwnd_);
    }

    // show window
#if 0
    SetForegroundWindow(hwnd_);
    ShowWindow(hwnd_, SW_SHOW);
    BringWindowToTop(hwnd_);
#else
    ShowWindow(hwnd_, SW_MINIMIZE);
    ShowWindow(hwnd_, SW_RESTORE);
#endif

    SetTimer(hwnd_, timerID, EventLoop::updateIntervalMillis, &updateEditor);

    LOG_DEBUG("Win32: setup Window done");
}

void Window::close(){
    EventLoop::instance().callAsync([](void *x){
        static_cast<Window *>(x)->doClose();
    }, this);
}

void Window::doClose(){
    LOG_DEBUG("Win32: close window");
    if (hwnd_){
        RECT rc;
        if (GetWindowRect(hwnd_, &rc)){
            // cache position and size
            rect_.x = rc.left;
            rect_.y = rc.top;
            rect_.w = rc.right - rc.left;
            rect_.h = rc.bottom - rc.top;
            adjustSize_ = false; // !
        }

        KillTimer(hwnd_, timerID);

        plugin_->closeEditor();

        DestroyWindow(hwnd_);
        hwnd_ = NULL;
        LOG_DEBUG("Win32: destroyed Window");
    }
}

void Window::setPos(int x, int y){
    EventLoop::instance().callAsync([](void *user){
        auto cmd = static_cast<Command *>(user);
        auto owner = cmd->owner;
        // update position
        owner->rect_.x = cmd->x;
        owner->rect_.y = cmd->y;
        if (owner->hwnd_){
            owner->updateFrame();
        }
        delete cmd;
    }, new Command { this, x, y });
}

// client rect size!
void Window::setSize(int w, int h){
    LOG_DEBUG("Win32: setSize: " << w << ", " << h);
    EventLoop::instance().callAsync([](void *user){
        auto cmd = static_cast<Command *>(user);
        auto owner = cmd->owner;
        if (owner->canResize()){
            // update and adjust size
            owner->rect_.w = cmd->x;
            owner->rect_.h = cmd->y;
            owner->adjustSize_ = true; // !
            if (owner->hwnd_){
                owner->saveCurrentPosition(); // !
                owner->updateFrame();
            }
        }

        delete cmd;
    }, new Command { this, w, h });
}

// client rect size!
void Window::resize(int w, int h){
    LOG_DEBUG("Win32: resized by plugin: " << w << ", " << h);
    // should only be called if the window is open
    if (hwnd_){
        saveCurrentPosition(); // !
        // update and adjust size
        rect_.w = w;
        rect_.h = h;
        adjustSize_ = true; // !
        updateFrame();
    }
}

void Window::saveCurrentPosition(){
    // get actual position
    RECT rc;
    if (GetWindowRect(hwnd_, &rc)){
        rect_.x = rc.left;
        rect_.y = rc.top;
    }
}

void Window::updateFrame(){
    if (adjustSize_){
        // adjust window dimensions for borders and menu
        const auto style = GetWindowLongPtr(hwnd_, GWL_STYLE);
        const auto exStyle = GetWindowLongPtr(hwnd_, GWL_EXSTYLE);
        const BOOL fMenu = GetMenu(hwnd_) != nullptr;
        RECT rc = { rect_.x, rect_.y, rect_.x + rect_.w, rect_.y + rect_.h };
        AdjustWindowRectEx(&rc, style, fMenu, exStyle);
        rect_.w = rc.right - rc.left;
        rect_.h = rc.bottom - rc.top;
        adjustSize_ = false;
    }
    LOG_DEBUG("Win32: update frame, pos: " << rect_.x << ", " << rect_.y
              << ", size: " << rect_.w << ", " << rect_.h);
    MoveWindow(hwnd_, rect_.x, rect_.y, rect_.w, rect_.h, TRUE);
}

void Window::update(){
    if (hwnd_){
        InvalidateRect(hwnd_, nullptr, FALSE);
    }
}

void Window::onSizing(RECT& newRect){
    // only called when resizing is enabled!
#if 0
    RECT rc;
    if (GetClientRect(hwnd_, &rc)){
        int dw = rect_.w - (rc.right - rc.left);
        int dh = rect_.h - (rc.bottom - rc.top);
        int w = rect_.w - dw;
        int h = rect_.h - dh;
        // validate requested size
        window->plugin()->checkEditorSize(w, w);
        // TODO: adjust window size
        // editor is resized by WM_SIZE (see Window::procedure)
    }
#endif
}

// client rect size!
void Window::onSize(int w, int h){
    plugin_->resizeEditor(w, h);
    rect_.w = w;
    rect_.h = h;
    adjustSize_ = true;
    LOG_DEBUG("Win32: size changed: " << w << ", " << h);
}

} // Win32

IWindow::ptr IWindow::create(IPlugin &plugin){
    return std::make_unique<Win32::Window>(plugin);
}

} // vst