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
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
|
// Copyright 2021 The Mumble Developers. All rights reserved.
// Use of this source code is governed by a BSD-style license
// that can be found in the LICENSE file at the root of the
// Mumble source tree or at <https://www.mumble.info/LICENSE>.
#include "Plugin.h"
#include "API.h"
#include "Version.h"
#include <QMutexLocker>
#include <QWriteLocker>
#include <cstring>
// initialize the static ID counter
plugin_id_t Plugin::s_nextID = 1;
QMutex Plugin::s_idLock;
void assertPluginLoaded(const Plugin *plugin) {
// don't throw and exception in release build
if (!plugin->isLoaded()) {
#ifdef QT_DEBUG
throw std::runtime_error("Attempting to access plugin but it is not loaded!");
#else
qWarning("Plugin assertion failed: Assumed plugin with ID %d to be loaded but it wasn't!", plugin->getID());
#endif
}
}
Plugin::Plugin(QString path, bool isBuiltIn, QObject *p)
: QObject(p), m_lib(path), m_pluginPath(path), m_pluginIsLoaded(false), m_pluginLock(QReadWriteLock::NonRecursive),
m_pluginFnc(), m_isBuiltIn(isBuiltIn), m_positionalDataIsEnabled(true), m_positionalDataIsActive(false),
m_mayMonitorKeyboard(false) {
// See if the plugin is loadable in the first place unless it is a built-in plugin
m_pluginIsValid = isBuiltIn || m_lib.load();
if (!m_pluginIsValid) {
// throw an exception to indicate that the plugin isn't valid
throw PluginError("Unable to load the specified library");
}
// aquire id-lock in order to assign an ID to this plugin
QMutexLocker lock(&Plugin::s_idLock);
m_pluginID = Plugin::s_nextID;
Plugin::s_nextID++;
}
Plugin::~Plugin() {
if (isLoaded()) {
shutdown();
}
if (m_lib.isLoaded()) {
m_lib.unload();
}
}
QString Plugin::extractWrappedString(MumbleStringWrapper wrapper) const {
QString wrappedString = QString::fromUtf8(wrapper.data, wrapper.size);
if (wrapper.needsReleasing) {
releaseResource(static_cast< const void * >(wrapper.data));
}
return wrappedString;
}
bool Plugin::doInitialize() {
resolveFunctionPointers();
return m_pluginIsValid;
}
void Plugin::resolveFunctionPointers() {
if (isValid()) {
// The corresponding library was loaded -> try to locate all API functions and provide defaults for
// the missing ones
QWriteLocker lock(&m_pluginLock);
// resolve the mandatory functions first
m_pluginFnc.init = reinterpret_cast< decltype(MumblePluginFunctions::init) >(m_lib.resolve("mumble_init"));
m_pluginFnc.shutdown =
reinterpret_cast< decltype(MumblePluginFunctions::shutdown) >(m_lib.resolve("mumble_shutdown"));
m_pluginFnc.getName =
reinterpret_cast< decltype(MumblePluginFunctions::getName) >(m_lib.resolve("mumble_getName"));
m_pluginFnc.getAPIVersion =
reinterpret_cast< decltype(MumblePluginFunctions::getAPIVersion) >(m_lib.resolve("mumble_getAPIVersion"));
m_pluginFnc.registerAPIFunctions = reinterpret_cast< decltype(MumblePluginFunctions::registerAPIFunctions) >(
m_lib.resolve("mumble_registerAPIFunctions"));
m_pluginFnc.releaseResource = reinterpret_cast< decltype(MumblePluginFunctions::releaseResource) >(
m_lib.resolve("mumble_releaseResource"));
// validate that all those functions are available in the loaded lib
m_pluginIsValid = m_pluginFnc.init && m_pluginFnc.shutdown && m_pluginFnc.getName && m_pluginFnc.getAPIVersion
&& m_pluginFnc.registerAPIFunctions && m_pluginFnc.releaseResource;
if (!m_pluginIsValid) {
// Don't bother trying to resolve any other functions
#ifdef MUMBLE_PLUGIN_DEBUG
# define CHECK_AND_LOG(name) \
if (!m_pluginFnc.name) { \
qDebug("\t\"%s\" is missing the %s() function", qPrintable(m_pluginPath), "mumble_" #name); \
}
CHECK_AND_LOG(init);
CHECK_AND_LOG(shutdown);
CHECK_AND_LOG(getName);
CHECK_AND_LOG(getAPIVersion);
CHECK_AND_LOG(registerAPIFunctions);
CHECK_AND_LOG(releaseResource);
# undef CHECK_AND_LOG
#endif
return;
}
// The mandatory functions are there, now see if any optional functions are implemented as well
m_pluginFnc.setMumbleInfo =
reinterpret_cast< decltype(MumblePluginFunctions::setMumbleInfo) >(m_lib.resolve("mumble_setMumbleInfo"));
m_pluginFnc.getVersion =
reinterpret_cast< decltype(MumblePluginFunctions::getVersion) >(m_lib.resolve("mumble_getVersion"));
m_pluginFnc.getAuthor =
reinterpret_cast< decltype(MumblePluginFunctions::getAuthor) >(m_lib.resolve("mumble_getAuthor"));
m_pluginFnc.getDescription =
reinterpret_cast< decltype(MumblePluginFunctions::getDescription) >(m_lib.resolve("mumble_getDescription"));
m_pluginFnc.getFeatures =
reinterpret_cast< decltype(MumblePluginFunctions::getFeatures) >(m_lib.resolve("mumble_getFeatures"));
m_pluginFnc.deactivateFeatures = reinterpret_cast< decltype(MumblePluginFunctions::deactivateFeatures) >(
m_lib.resolve("mumble_deactivateFeatures"));
m_pluginFnc.initPositionalData = reinterpret_cast< decltype(MumblePluginFunctions::initPositionalData) >(
m_lib.resolve("mumble_initPositionalData"));
m_pluginFnc.fetchPositionalData = reinterpret_cast< decltype(MumblePluginFunctions::fetchPositionalData) >(
m_lib.resolve("mumble_fetchPositionalData"));
m_pluginFnc.shutdownPositionalData =
reinterpret_cast< decltype(MumblePluginFunctions::shutdownPositionalData) >(
m_lib.resolve("mumble_shutdownPositionalData"));
m_pluginFnc.onServerConnected = reinterpret_cast< decltype(MumblePluginFunctions::onServerConnected) >(
m_lib.resolve("mumble_onServerConnected"));
m_pluginFnc.onServerDisconnected = reinterpret_cast< decltype(MumblePluginFunctions::onServerDisconnected) >(
m_lib.resolve("mumble_onServerDisconnected"));
m_pluginFnc.onChannelEntered = reinterpret_cast< decltype(MumblePluginFunctions::onChannelEntered) >(
m_lib.resolve("mumble_onChannelEntered"));
m_pluginFnc.onChannelExited = reinterpret_cast< decltype(MumblePluginFunctions::onChannelExited) >(
m_lib.resolve("mumble_onChannelExited"));
m_pluginFnc.onUserTalkingStateChanged =
reinterpret_cast< decltype(MumblePluginFunctions::onUserTalkingStateChanged) >(
m_lib.resolve("mumble_onUserTalkingStateChanged"));
m_pluginFnc.onReceiveData =
reinterpret_cast< decltype(MumblePluginFunctions::onReceiveData) >(m_lib.resolve("mumble_onReceiveData"));
m_pluginFnc.onAudioInput =
reinterpret_cast< decltype(MumblePluginFunctions::onAudioInput) >(m_lib.resolve("mumble_onAudioInput"));
m_pluginFnc.onAudioSourceFetched = reinterpret_cast< decltype(MumblePluginFunctions::onAudioSourceFetched) >(
m_lib.resolve("mumble_onAudioSourceFetched"));
m_pluginFnc.onAudioOutputAboutToPlay =
reinterpret_cast< decltype(MumblePluginFunctions::onAudioOutputAboutToPlay) >(
m_lib.resolve("mumble_onAudioOutputAboutToPlay"));
m_pluginFnc.onServerSynchronized = reinterpret_cast< decltype(MumblePluginFunctions::onServerSynchronized) >(
m_lib.resolve("mumble_onServerSynchronized"));
m_pluginFnc.onUserAdded =
reinterpret_cast< decltype(MumblePluginFunctions::onUserAdded) >(m_lib.resolve("mumble_onUserAdded"));
m_pluginFnc.onUserRemoved =
reinterpret_cast< decltype(MumblePluginFunctions::onUserRemoved) >(m_lib.resolve("mumble_onUserRemoved"));
m_pluginFnc.onChannelAdded =
reinterpret_cast< decltype(MumblePluginFunctions::onChannelAdded) >(m_lib.resolve("mumble_onChannelAdded"));
m_pluginFnc.onChannelRemoved = reinterpret_cast< decltype(MumblePluginFunctions::onChannelRemoved) >(
m_lib.resolve("mumble_onChannelRemoved"));
m_pluginFnc.onChannelRenamed = reinterpret_cast< decltype(MumblePluginFunctions::onChannelRenamed) >(
m_lib.resolve("mumble_onChannelRenamed"));
m_pluginFnc.onKeyEvent =
reinterpret_cast< decltype(MumblePluginFunctions::onKeyEvent) >(m_lib.resolve("mumble_onKeyEvent"));
m_pluginFnc.hasUpdate =
reinterpret_cast< decltype(MumblePluginFunctions::hasUpdate) >(m_lib.resolve("mumble_hasUpdate"));
m_pluginFnc.getUpdateDownloadURL = reinterpret_cast< decltype(MumblePluginFunctions::getUpdateDownloadURL) >(
m_lib.resolve("mumble_getUpdateDownloadURL"));
#ifdef MUMBLE_PLUGIN_DEBUG
# define CHECK_AND_LOG(name) \
qDebug("\t" \
"mumble_" #name ": %s", \
(m_pluginFnc.name == nullptr ? "no" : "yes"))
qDebug(">>>> Found optional functions for plugin \"%s\"", qUtf8Printable(m_pluginPath));
CHECK_AND_LOG(setMumbleInfo);
CHECK_AND_LOG(getVersion);
CHECK_AND_LOG(getAuthor);
CHECK_AND_LOG(getDescription);
CHECK_AND_LOG(getFeatures);
CHECK_AND_LOG(deactivateFeatures);
CHECK_AND_LOG(initPositionalData);
CHECK_AND_LOG(fetchPositionalData);
CHECK_AND_LOG(shutdownPositionalData);
CHECK_AND_LOG(onServerConnected);
CHECK_AND_LOG(onServerDisconnected);
CHECK_AND_LOG(onChannelEntered);
CHECK_AND_LOG(onChannelExited);
CHECK_AND_LOG(onUserTalkingStateChanged);
CHECK_AND_LOG(onReceiveData);
CHECK_AND_LOG(onAudioInput);
CHECK_AND_LOG(onAudioSourceFetched);
CHECK_AND_LOG(onAudioOutputAboutToPlay);
CHECK_AND_LOG(onServerSynchronized);
CHECK_AND_LOG(onUserAdded);
CHECK_AND_LOG(onUserRemoved);
CHECK_AND_LOG(onChannelAdded);
CHECK_AND_LOG(onChannelRemoved);
CHECK_AND_LOG(onChannelRenamed);
CHECK_AND_LOG(onKeyEvent);
CHECK_AND_LOG(hasUpdate);
CHECK_AND_LOG(getUpdateDownloadURL);
qDebug("<<<<");
#endif
// If positional audio is to be supported, all three corresponding functions have to be implemented
// For PA it is all or nothing
if (!(m_pluginFnc.initPositionalData && m_pluginFnc.fetchPositionalData && m_pluginFnc.shutdownPositionalData)
&& (m_pluginFnc.initPositionalData || m_pluginFnc.fetchPositionalData
|| m_pluginFnc.shutdownPositionalData)) {
m_pluginFnc.initPositionalData = nullptr;
m_pluginFnc.fetchPositionalData = nullptr;
m_pluginFnc.shutdownPositionalData = nullptr;
#ifdef MUMBLE_PLUGIN_DEBUG
qDebug("\t\"%s\" has only partially implemented positional data functions -> deactivating all of them",
qPrintable(m_pluginPath));
#endif
}
}
}
bool Plugin::isValid() const {
PluginReadLocker lock(&m_pluginLock);
return m_pluginIsValid;
}
bool Plugin::isLoaded() const {
PluginReadLocker lock(&m_pluginLock);
return m_pluginIsLoaded;
}
plugin_id_t Plugin::getID() const {
PluginReadLocker lock(&m_pluginLock);
return m_pluginID;
}
bool Plugin::isBuiltInPlugin() const {
PluginReadLocker lock(&m_pluginLock);
return m_isBuiltIn;
}
QString Plugin::getFilePath() const {
PluginReadLocker lock(&m_pluginLock);
return m_pluginPath;
}
bool Plugin::isPositionalDataEnabled() const {
PluginReadLocker lock(&m_pluginLock);
return m_positionalDataIsEnabled;
}
void Plugin::enablePositionalData(bool enable) {
QWriteLocker lock(&m_pluginLock);
m_positionalDataIsEnabled = enable;
}
bool Plugin::isPositionalDataActive() const {
PluginReadLocker lock(&m_pluginLock);
return m_positionalDataIsActive;
}
void Plugin::allowKeyboardMonitoring(bool allow) {
QWriteLocker lock(&m_pluginLock);
m_mayMonitorKeyboard = allow;
}
bool Plugin::isKeyboardMonitoringAllowed() const {
PluginReadLocker lock(&m_pluginLock);
return m_mayMonitorKeyboard;
}
mumble_error_t Plugin::init() {
{
QReadLocker lock(&m_pluginLock);
if (m_pluginIsLoaded) {
return MUMBLE_STATUS_OK;
}
}
//////////////////////////////
// Step 1: Introduce ourselves (inform the plugin about Mumble's (API) version
// Get Mumble version
int mumbleMajor, mumbleMinor, mumblePatch;
Version::get(&mumbleMajor, &mumbleMinor, &mumblePatch);
// Require API version 1.0.0 as the minimal supported one
setMumbleInfo({ mumbleMajor, mumbleMinor, mumblePatch }, MUMBLE_PLUGIN_API_VERSION, { 1, 0, 0 });
//////////////////////////////
// Step 2: Provide the API functions to the plugin
const mumble_version_t apiVersion = getAPIVersion();
if (apiVersion >= mumble_version_t({ 1, 0, 0 }) && apiVersion < mumble_version_t({ 1, 2, 0 })) {
MumbleAPI_v_1_0_x api = API::getMumbleAPI_v_1_0_x();
registerAPIFunctions(&api);
} else {
// The API version could not be obtained -> this is an invalid plugin that shouldn't have been loaded in the
// first place
qWarning("Unable to obtain requested MumbleAPI version");
return MUMBLE_EC_INVALID_API_VERSION;
}
//////////////////////////////
// Step 3: Actually try to load the plugin
mumble_error_t retStatus;
if (m_pluginFnc.init) {
retStatus = m_pluginFnc.init(m_pluginID);
} else {
retStatus = MUMBLE_EC_GENERIC_ERROR;
}
{
QWriteLocker lock(&m_pluginLock);
m_pluginIsLoaded = retStatus == MUMBLE_STATUS_OK;
}
return retStatus;
}
void Plugin::shutdown() {
bool posDataActive;
{
QReadLocker rLock(&m_pluginLock);
if (!m_pluginIsLoaded) {
return;
}
posDataActive = m_positionalDataIsActive;
}
if (posDataActive) {
shutdownPositionalData();
}
if (m_pluginFnc.shutdown) {
m_pluginFnc.shutdown();
}
{
QWriteLocker lock(&m_pluginLock);
m_pluginIsLoaded = false;
}
}
QString Plugin::getName() const {
if (m_pluginFnc.getName) {
return extractWrappedString(m_pluginFnc.getName());
} else {
return QString::fromLatin1("Unknown plugin");
}
}
mumble_version_t Plugin::getAPIVersion() const {
if (m_pluginFnc.getAPIVersion) {
return m_pluginFnc.getAPIVersion();
} else {
return MUMBLE_VERSION_UNKNOWN;
}
}
void Plugin::registerAPIFunctions(void *api) const {
if (m_pluginFnc.registerAPIFunctions) {
m_pluginFnc.registerAPIFunctions(api);
}
}
void Plugin::releaseResource(const void *pointer) const {
if (m_pluginFnc.releaseResource) {
m_pluginFnc.releaseResource(pointer);
}
}
void Plugin::setMumbleInfo(mumble_version_t mumbleVersion, mumble_version_t mumbleAPIVersion,
mumble_version_t minimalExpectedAPIVersion) const {
if (m_pluginFnc.setMumbleInfo) {
m_pluginFnc.setMumbleInfo(mumbleVersion, mumbleAPIVersion, minimalExpectedAPIVersion);
}
}
mumble_version_t Plugin::getVersion() const {
if (m_pluginFnc.getVersion) {
return m_pluginFnc.getVersion();
} else {
return MUMBLE_VERSION_UNKNOWN;
}
}
QString Plugin::getAuthor() const {
if (m_pluginFnc.getAuthor) {
return extractWrappedString(m_pluginFnc.getAuthor());
} else {
return QString::fromLatin1("Unknown");
}
}
QString Plugin::getDescription() const {
if (m_pluginFnc.getDescription) {
return extractWrappedString(m_pluginFnc.getDescription());
} else {
return QString::fromLatin1("No description provided");
}
}
uint32_t Plugin::getFeatures() const {
if (m_pluginFnc.getFeatures) {
return m_pluginFnc.getFeatures();
} else {
return MUMBLE_FEATURE_NONE;
}
}
uint32_t Plugin::deactivateFeatures(uint32_t features) const {
assertPluginLoaded(this);
if (m_pluginFnc.deactivateFeatures) {
return m_pluginFnc.deactivateFeatures(features);
} else {
return features;
}
}
bool Plugin::showAboutDialog(QWidget *parent) const {
assertPluginLoaded(this);
Q_UNUSED(parent);
return false;
}
bool Plugin::showConfigDialog(QWidget *parent) const {
assertPluginLoaded(this);
Q_UNUSED(parent);
return false;
}
uint8_t Plugin::initPositionalData(const char *const *programNames, const uint64_t *programPIDs, size_t programCount) {
assertPluginLoaded(this);
if (m_pluginFnc.initPositionalData) {
uint8_t returnCode = m_pluginFnc.initPositionalData(programNames, programPIDs, programCount);
{
QWriteLocker lock(&m_pluginLock);
m_positionalDataIsActive = returnCode == MUMBLE_PDEC_OK;
}
return returnCode;
} else {
return MUMBLE_PDEC_ERROR_PERM;
}
}
bool Plugin::fetchPositionalData(Position3D &avatarPos, Vector3D &avatarDir, Vector3D &avatarAxis,
Position3D &cameraPos, Vector3D &cameraDir, Vector3D &cameraAxis, QString &context,
QString &identity) const {
assertPluginLoaded(this);
if (m_pluginFnc.fetchPositionalData) {
const char *contextPtr = "";
const char *identityPtr = "";
bool retStatus = m_pluginFnc.fetchPositionalData(
static_cast< float * >(avatarPos), static_cast< float * >(avatarDir), static_cast< float * >(avatarAxis),
static_cast< float * >(cameraPos), static_cast< float * >(cameraDir), static_cast< float * >(cameraAxis),
&contextPtr, &identityPtr);
context = QString::fromUtf8(contextPtr);
identity = QString::fromUtf8(identityPtr);
return retStatus;
} else {
avatarPos.toZero();
avatarDir.toZero();
avatarAxis.toZero();
cameraPos.toZero();
cameraDir.toZero();
cameraAxis.toZero();
context = QString();
identity = QString();
return false;
}
}
void Plugin::shutdownPositionalData() {
assertPluginLoaded(this);
if (m_pluginFnc.shutdownPositionalData) {
m_positionalDataIsActive = false;
m_pluginFnc.shutdownPositionalData();
}
}
void Plugin::onServerConnected(mumble_connection_t connection) const {
assertPluginLoaded(this);
if (m_pluginFnc.onServerConnected) {
m_pluginFnc.onServerConnected(connection);
}
}
void Plugin::onServerDisconnected(mumble_connection_t connection) const {
assertPluginLoaded(this);
if (m_pluginFnc.onServerDisconnected) {
m_pluginFnc.onServerDisconnected(connection);
}
}
void Plugin::onChannelEntered(mumble_connection_t connection, mumble_userid_t userID,
mumble_channelid_t previousChannelID, mumble_channelid_t newChannelID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onChannelEntered) {
m_pluginFnc.onChannelEntered(connection, userID, previousChannelID, newChannelID);
}
}
void Plugin::onChannelExited(mumble_connection_t connection, mumble_userid_t userID,
mumble_channelid_t channelID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onChannelExited) {
m_pluginFnc.onChannelExited(connection, userID, channelID);
}
}
void Plugin::onUserTalkingStateChanged(mumble_connection_t connection, mumble_userid_t userID,
mumble_talking_state_t talkingState) const {
assertPluginLoaded(this);
if (m_pluginFnc.onUserTalkingStateChanged) {
m_pluginFnc.onUserTalkingStateChanged(connection, userID, talkingState);
}
}
bool Plugin::onReceiveData(mumble_connection_t connection, mumble_userid_t sender, const uint8_t *data,
size_t dataLength, const char *dataID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onReceiveData) {
return m_pluginFnc.onReceiveData(connection, sender, data, dataLength, dataID);
} else {
return false;
}
}
bool Plugin::onAudioInput(short *inputPCM, uint32_t sampleCount, uint16_t channelCount, uint32_t sampleRate,
bool isSpeech) const {
assertPluginLoaded(this);
if (m_pluginFnc.onAudioInput) {
return m_pluginFnc.onAudioInput(inputPCM, sampleCount, channelCount, sampleRate, isSpeech);
} else {
return false;
}
}
bool Plugin::onAudioSourceFetched(float *outputPCM, uint32_t sampleCount, uint16_t channelCount, uint32_t sampleRate,
bool isSpeech, mumble_userid_t userID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onAudioSourceFetched) {
return m_pluginFnc.onAudioSourceFetched(outputPCM, sampleCount, channelCount, sampleRate, isSpeech, userID);
} else {
return false;
}
}
bool Plugin::onAudioOutputAboutToPlay(float *outputPCM, uint32_t sampleCount, uint16_t channelCount,
uint32_t sampleRate) const {
assertPluginLoaded(this);
if (m_pluginFnc.onAudioOutputAboutToPlay) {
return m_pluginFnc.onAudioOutputAboutToPlay(outputPCM, sampleCount, channelCount, sampleRate);
} else {
return false;
}
}
void Plugin::onServerSynchronized(mumble_connection_t connection) const {
assertPluginLoaded(this);
if (m_pluginFnc.onServerSynchronized) {
m_pluginFnc.onServerSynchronized(connection);
}
}
void Plugin::onUserAdded(mumble_connection_t connection, mumble_userid_t userID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onUserAdded) {
m_pluginFnc.onUserAdded(connection, userID);
}
}
void Plugin::onUserRemoved(mumble_connection_t connection, mumble_userid_t userID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onUserRemoved) {
m_pluginFnc.onUserRemoved(connection, userID);
}
}
void Plugin::onChannelAdded(mumble_connection_t connection, mumble_channelid_t channelID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onChannelAdded) {
m_pluginFnc.onChannelAdded(connection, channelID);
}
}
void Plugin::onChannelRemoved(mumble_connection_t connection, mumble_channelid_t channelID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onChannelRemoved) {
m_pluginFnc.onChannelRemoved(connection, channelID);
}
}
void Plugin::onChannelRenamed(mumble_connection_t connection, mumble_channelid_t channelID) const {
assertPluginLoaded(this);
if (m_pluginFnc.onChannelRenamed) {
m_pluginFnc.onChannelRenamed(connection, channelID);
}
}
void Plugin::onKeyEvent(mumble_keycode_t keyCode, bool wasPress) const {
assertPluginLoaded(this);
if (!m_mayMonitorKeyboard) {
// Keyboard monitoring is forbidden for this plugin
return;
}
if (m_pluginFnc.onKeyEvent) {
m_pluginFnc.onKeyEvent(keyCode, wasPress);
}
}
bool Plugin::hasUpdate() const {
if (m_pluginFnc.hasUpdate) {
return m_pluginFnc.hasUpdate();
} else {
// A plugin that doesn't implement this function is assumed to never know about
// any potential updates
return false;
}
}
QUrl Plugin::getUpdateDownloadURL() const {
if (m_pluginFnc.getUpdateDownloadURL) {
return QUrl(extractWrappedString(m_pluginFnc.getUpdateDownloadURL()));
} else {
// Return an empty URL as a fallback
return QUrl();
}
}
bool Plugin::providesAboutDialog() const {
return false;
}
bool Plugin::providesConfigDialog() const {
return false;
}
/////////////////// Implementation of the PluginReadLocker /////////////////////////
PluginReadLocker::PluginReadLocker(QReadWriteLock *lock) : m_lock(lock), m_unlocked(false) {
relock();
}
void PluginReadLocker::unlock() {
if (!m_lock) {
// do nothgin for nullptr
return;
}
m_unlocked = true;
m_lock->unlock();
}
void PluginReadLocker::relock() {
if (!m_lock) {
// do nothing for a nullptr
return;
}
// First try to lock for read-access
if (!m_lock->tryLockForRead()) {
// if that fails, we'll try to lock for write-access
// That will only succeed in the case that the current thread holds the write-access to this lock already which
// caused the previous attempt to lock for reading to fail (by design of the QtReadWriteLock). As we are in the
// thread with the write-access, it means that this threads has asked for read-access on top of it which we will
// grant (in contrast of QtReadLocker) because if you have the permission to change something you surely should
// have permission to read it. This assumes that the thread won't try to read data it temporarily has corrupted.
if (!m_lock->tryLockForWrite()) {
// If we couldn't lock for write at this point, it means another thread has write-access granted by the lock
// so we'll have to wait in order to gain regular read-access as would be with QtReadLocker
m_lock->lockForRead();
}
}
m_unlocked = false;
}
PluginReadLocker::~PluginReadLocker() {
if (m_lock && !m_unlocked) {
// unlock the lock if it isn't nullptr
m_lock->unlock();
}
}
|