From 2e792e8125b5636a31a2649ca9628b189f3a1ae8 Mon Sep 17 00:00:00 2001 From: =?utf8?q?IOhannes=20m=20zm=C3=B6lnig=20=28Debian/GNU=29?= Date: Fri, 17 May 2024 08:28:06 +0200 Subject: [PATCH 1/1] Import jacktrip_2.3.0+ds.orig.tar.xz [dgit import orig jacktrip_2.3.0+ds.orig.tar.xz] --- .clang-format | 184 ++ .clang-format-ignore | 4 + .clang-tidy | 1 + .clang-tidy-ignore | 4 + .dockerignore | 8 + .mailmap | 35 + .pre-commit-config.yaml | 9 + CMakeLists.txt | 291 ++ Dockerfile | 68 + Doxyfile | 2603 +++++++++++++++ LICENSE.md | 27 + LICENSES/AVC.txt | 10 + LICENSES/GPL-3.0.txt | 674 ++++ LICENSES/LGPL-3.0-only.txt | 165 + LICENSES/MIT.txt | 23 + QJackTrip.kdev4 | 3 + README.md | 9 + build | 204 ++ build-aux/flatpak/org.jacktrip.JackTrip.json | 41 + build-aux/flatpak/pypi-dependencies.json | 40 + build-aux/flatpak/requirements.txt | 2 + build-aux/flatpak/update_pip_deps.sh | 3 + cross/x86_mingw64.txt | 20 + cross/x86_mingw64_static.txt | 24 + docs/About/CHANGELOG.md | 10 + docs/About/Contributors.md | 93 + docs/About/License.md | 18 + docs/About/Resources.md | 22 + docs/Build/CrossCompile.md | 19 + docs/Build/Linux.md | 179 ++ docs/Build/Mac.md | 114 + docs/Build/Meson_build.md | 83 + docs/Build/Windows.md | 84 + docs/CustomJackServerName.md | 8 + docs/DevTools/Formatting.md | 76 + docs/DevTools/StaticAnalysis.md | 48 + docs/Documentation/MkDocs.md | 25 + docs/Install.md | 62 + docs/VirtualStudio.md | 26 + docs/assets/jacktrip.svg | 10 + docs/changelog.yml | 515 +++ docs/images/jacktrip_hubclient_basic.png | Bin 0 -> 125606 bytes docs/images/jacktrip_hubclient_plugins.png | Bin 0 -> 131263 bytes docs/images/jacktrip_hubserver_basic.png | Bin 0 -> 164286 bytes docs/images/jacktrip_hubserver_jitter.png | Bin 0 -> 152438 bytes docs/images/jacktrip_virtual_studio.png | Bin 0 -> 196096 bytes docs/index.md | 36 + docs/requirements.txt | 2 + documentation/documentation.cpp | 58 + documentation/footer.html | 17 + documentation/header.html | 56 + documentation/img/jack_main_settings.jpg | Bin 0 -> 113741 bytes documentation/img/jack_routing.png | Bin 0 -> 57002 bytes documentation/img/qjackctl.png | Bin 0 -> 21890 bytes externals/Simple-FFT/LICENSE.md | 21 + externals/Simple-FFT/README.md | 98 + .../include/simple_fft/check_fft.hpp | 571 ++++ .../include/simple_fft/copy_array.hpp | 173 + .../include/simple_fft/error_handling.hpp | 64 + externals/Simple-FFT/include/simple_fft/fft.h | 98 + .../Simple-FFT/include/simple_fft/fft.hpp | 162 + .../include/simple_fft/fft_impl.hpp | 515 +++ .../include/simple_fft/fft_settings.h | 26 + faust-src/Makefile | 106 + faust-src/Makefile.compile | 15 + faust-src/Makefile.headers | 27 + faust-src/Makefile.ladspacompile | 22 + faust-src/Makefile.mspcompile | 44 + faust-src/Makefile.pdcompile | 45 + faust-src/Makefile.qcompile | 17 + faust-src/Makefile.qtcompile | 49 + faust-src/Makefile.sccompile | 41 + faust-src/Makefile.svg | 12 + faust-src/Makefile.vstcompile | 31 + faust-src/README-Limiter.md | 23 + faust-src/compressor-limiter-test.dsp | 2 + faust-src/compressordsp.dsp | 73 + faust-src/faust2header.cpp | 21 + faust-src/freeverbdsp.dsp | 45 + faust-src/freeverbmonodsp.dsp | 2 + faust-src/limiterdsp.dsp | 11 + faust-src/limitertest.dsp | 7 + faust-src/meterdsp.dsp | 19 + faust-src/minimal.cpp | 104 + faust-src/monitordsp.dsp | 15 + faust-src/net-ks.dsp | 29 + faust-src/tests/compressor-limiter-test.dsp | 21 + faust-src/tests/compressor2dsp.dsp | 82 + faust-src/tonedsp.dsp | 17 + faust-src/volumedsp.dsp | 14 + faust-src/zitarevdsp.dsp | 106 + faust-src/zitarevmonodsp.dsp | 2 + jacktrip.pro | 432 +++ jacktrip_and_rtaudio.pro | 14 + linux/README.md | 42 + linux/add_changelog_to_metainfo.py | 23 + linux/container/README.md | 69 + linux/container/jacktrip.service | 33 + linux/icons/jacktrip-symbolic.svg | 7 + linux/icons/jacktrip.svg | 10 + linux/icons/jacktrip_48x48.png | Bin 0 -> 1944 bytes linux/icons/jacktrip_48x48_alt.png | Bin 0 -> 692 bytes linux/icons/jacktrip_alt.svg | 96 + linux/meson.build | 33 + linux/org.jacktrip.JackTrip.desktop.in | 10 + .../org.jacktrip.JackTrip.metainfo.xml.in.in | 83 + macos/Info_novs.plist | 54 + .../JackTrip.app_template/Contents/Info.plist | 67 + macos/JackTrip.app_template/Contents/PkgInfo | 1 + .../Contents/Resources/jacktrip.icns | Bin 0 -> 127612 bytes macos/assemble_app.sh | 280 ++ macos/entitlements.plist | 20 + macos/jacktrip.iconset/icon_128x128.png | Bin 0 -> 3854 bytes macos/jacktrip.iconset/icon_128x128@2x.png | Bin 0 -> 7165 bytes macos/jacktrip.iconset/icon_16x16.png | Bin 0 -> 1151 bytes macos/jacktrip.iconset/icon_16x16@2x.png | Bin 0 -> 1524 bytes macos/jacktrip.iconset/icon_256x256.png | Bin 0 -> 6960 bytes macos/jacktrip.iconset/icon_256x256@2x.png | Bin 0 -> 13496 bytes macos/jacktrip.iconset/icon_32x32.png | Bin 0 -> 1569 bytes macos/jacktrip.iconset/icon_32x32@2x.png | Bin 0 -> 2240 bytes macos/jacktrip.iconset/icon_512x512.png | Bin 0 -> 13211 bytes macos/jacktrip.iconset/icon_512x512@2x.png | Bin 0 -> 29395 bytes macos/jacktrip_alt.icns | Bin 0 -> 67558 bytes macos/jacktrip_alt.iconset/icon_128x128.png | Bin 0 -> 1626 bytes .../jacktrip_alt.iconset/icon_128x128@2x.png | Bin 0 -> 2975 bytes macos/jacktrip_alt.iconset/icon_16x16.png | Bin 0 -> 259 bytes macos/jacktrip_alt.iconset/icon_16x16@2x.png | Bin 0 -> 450 bytes macos/jacktrip_alt.iconset/icon_256x256.png | Bin 0 -> 2975 bytes .../jacktrip_alt.iconset/icon_256x256@2x.png | Bin 0 -> 5799 bytes macos/jacktrip_alt.iconset/icon_32x32.png | Bin 0 -> 450 bytes macos/jacktrip_alt.iconset/icon_32x32@2x.png | Bin 0 -> 844 bytes macos/jacktrip_alt.iconset/icon_512x512.png | Bin 0 -> 5799 bytes .../jacktrip_alt.iconset/icon_512x512@2x.png | Bin 0 -> 13273 bytes macos/meson_native_minversion_10.13.ini | 10 + macos/meson_native_minversion_10.14.ini | 10 + macos/meson_native_universal.ini | 10 + macos/meson_native_universal_10.13.ini | 11 + macos/meson_native_universal_10.14.ini | 11 + macos/package/JackTrip.pkgproj_template | 1182 +++++++ macos/package/postinstall.sh | 10 + macos/sign-stuff.sh | 62 + meson.build | 367 +++ meson_options.txt | 12 + mkdocs.yml | 45 + releases/edge/mac-manifests.json | 565 ++++ releases/edge/win-manifests.json | 565 ++++ releases/stable/linux-manifests.json | 215 ++ releases/stable/mac-manifests.json | 255 ++ releases/stable/win-manifests.json | 255 ++ rtaudio.pro | 35 + scripts/README.md | 12 + scripts/hubMode/art.sh | 36 + scripts/hubMode/startJacktripHubClient.sh | 43 + scripts/hubMode/startJacktripHubServer.sh | 14 + .../test_hub_mode_server_and_client.sh | 71 + scripts/slork/die.bin | 14 + scripts/slork/feedjack-cleanslate.bin | 9 + scripts/slork/feedjack-client.bin | 81 + scripts/slork/feedjack-clientconnect.bin | 46 + .../feedjack-launch-n-jacktrip-servers.bin | 35 + .../feedjack-launch-one-jacktrip-client.bin | 41 + .../feedjack-launchjack-even-without-motu.bin | 5 + scripts/slork/feedjack-launchjack.bin | 32 + .../slork/feedjack-remotespeakerconnect.bin | 12 + scripts/slork/feedjack-server.bin | 31 + scripts/slork/feedjack-serverconnect.bin | 41 + scripts/test/client_connection_test.sh | 44 + scripts/test/version_test.sh | 17 + scripts/update_manifests.sh | 20 + scripts/utility/generate_auth.sh | 18 + .../utility/record_jack_receiving_ports.sh | 36 + src/Analyzer.cpp | 349 ++ src/Analyzer.h | 125 + src/AudioInterface.cpp | 891 +++++ src/AudioInterface.h | 378 +++ src/AudioTester.cpp | 254 ++ src/AudioTester.h | 232 ++ src/Auth.cpp | 484 +++ src/Auth.h | 95 + src/Compressor.cpp | 122 + src/Compressor.h | 94 + src/CompressorPresets.h | 77 + src/DataProtocol.cpp | 80 + src/DataProtocol.h | 235 ++ src/Effects.h | 713 ++++ src/JMess.cpp | 168 + src/JMess.h | 72 + src/JTApplication.h | 66 + src/JackAudioInterface.cpp | 383 +++ src/JackAudioInterface.h | 199 ++ src/JackTrip.cpp | 1582 +++++++++ src/JackTrip.h | 743 +++++ src/JackTripWorker.cpp | 378 +++ src/JackTripWorker.h | 193 ++ src/JitterBuffer.cpp | 387 +++ src/JitterBuffer.h | 98 + src/Limiter.cpp | 136 + src/Limiter.h | 150 + src/LoopBack.cpp | 57 + src/LoopBack.h | 68 + src/Meter.cpp | 195 ++ src/Meter.h | 99 + src/Monitor.cpp | 144 + src/Monitor.h | 84 + src/PacketHeader.cpp | 356 ++ src/PacketHeader.h | 328 ++ src/Patcher.cpp | 200 ++ src/Patcher.h | 82 + src/ProcessPlugin.cpp | 31 + src/ProcessPlugin.h | 120 + src/QtStaticPlugins.cpp | 4 + src/Regulator.cpp | 1092 +++++++ src/Regulator.h | 443 +++ src/Reverb.cpp | 155 + src/Reverb.h | 85 + src/RingBuffer.cpp | 321 ++ src/RingBuffer.h | 183 ++ src/RingBufferWavetable.h | 68 + src/RtAudioInterface.cpp | 785 +++++ src/RtAudioInterface.h | 160 + src/Settings.cpp | 1297 ++++++++ src/Settings.h | 200 ++ src/SslServer.cpp | 64 + src/SslServer.h | 61 + src/StereoToMono.cpp | 78 + src/StereoToMono.h | 70 + src/Tone.cpp | 115 + src/Tone.h | 78 + src/UdpDataProtocol.cpp | 1069 ++++++ src/UdpDataProtocol.h | 247 ++ src/UdpHubListener.cpp | 674 ++++ src/UdpHubListener.h | 274 ++ src/Volume.cpp | 133 + src/Volume.h | 81 + src/WaitFreeFrameBuffer.h | 87 + src/WaitFreeRingBuffer.h | 158 + src/build | 20 + src/compressordsp.h | 2256 +++++++++++++ src/dblsqd/feed.cpp | 333 ++ src/dblsqd/feed.h | 67 + src/dblsqd/release.cpp | 143 + src/dblsqd/release.h | 44 + src/dblsqd/semver.cpp | 88 + src/dblsqd/semver.h | 34 + src/dblsqd/update_dialog.cpp | 694 ++++ src/dblsqd/update_dialog.h | 106 + src/dblsqd/update_dialog.ui | 402 +++ src/freeverbdsp.h | 2563 +++++++++++++++ src/freeverbmonodsp.h | 2558 +++++++++++++++ src/gui/AppIcon.qml | 29 + src/gui/AudioInterfaceMode.h | 88 + src/gui/AudioSettings.qml | 803 +++++ src/gui/Browse.qml | 328 ++ src/gui/ChangeDevices.qml | 115 + src/gui/Connected.qml | 85 + src/gui/CreateStudio.qml | 124 + src/gui/DeviceControls.qml | 197 ++ src/gui/DeviceControlsGroup.qml | 383 +++ src/gui/DeviceRefreshButton.qml | 38 + src/gui/DeviceWarning.qml | 58 + src/gui/Failed.qml | 79 + src/gui/FeedbackSurvey.qml | 421 +++ src/gui/FirstLaunch.qml | 128 + src/gui/Footer.qml | 180 ++ src/gui/InfoTooltip.qml | 63 + src/gui/JTOriginal.png | Bin 0 -> 46081 bytes src/gui/JTVS.png | Bin 0 -> 196096 bytes src/gui/LearnMoreButton.qml | 30 + src/gui/Login.qml | 351 ++ src/gui/Meter.qml | 53 + src/gui/MeterBars.qml | 49 + src/gui/NoNap.h | 45 + src/gui/NoNap.mm | 58 + src/gui/Permissions.qml | 202 ++ src/gui/Poppins-Bold.ttf | Bin 0 -> 153944 bytes src/gui/Poppins-Regular.ttf | Bin 0 -> 158240 bytes src/gui/Prompt.svg | 9 + src/gui/Recommendations.qml | 564 ++++ src/gui/SectionHeading.qml | 163 + src/gui/Settings.qml | 781 +++++ src/gui/Setup.qml | 201 ++ src/gui/Studio.qml | 402 +++ src/gui/VolumeSlider.qml | 122 + src/gui/Web.qml | 10 + src/gui/WebEngine.qml | 121 + src/gui/WebNull.qml | 12 + src/gui/WebSocketTransport.cpp | 95 + src/gui/WebSocketTransport.h | 61 + src/gui/WebView.qml | 23 + src/gui/about.cpp | 104 + src/gui/about.h | 56 + src/gui/about.png | Bin 0 -> 3716 bytes src/gui/about.ui | 154 + src/gui/about@2x.png | Bin 0 -> 7344 bytes src/gui/alt/Jacktrip.ai | 1014 ++++++ src/gui/alt/about.png | Bin 0 -> 1626 bytes src/gui/alt/about@2x.png | Bin 0 -> 2975 bytes src/gui/alt/icon.png | Bin 0 -> 450 bytes src/gui/check.svg | 1 + src/gui/close.svg | 1 + src/gui/cog.svg | 3 + src/gui/ethernet.svg | 3 + src/gui/expand_less.svg | 3 + src/gui/expand_more.svg | 3 + src/gui/externalMic.svg | 1 + src/gui/flags/AE.svg | 1 + src/gui/flags/AU.svg | 1 + src/gui/flags/BE.svg | 1 + src/gui/flags/BR.svg | 1 + src/gui/flags/CA.svg | 1 + src/gui/flags/CH.svg | 1 + src/gui/flags/DE.svg | 1 + src/gui/flags/FR.svg | 1 + src/gui/flags/GB.svg | 1 + src/gui/flags/HK.svg | 1 + src/gui/flags/ID.svg | 1 + src/gui/flags/IT.svg | 1 + src/gui/flags/JP.svg | 1 + src/gui/flags/RO.svg | 1 + src/gui/flags/SE.svg | 1 + src/gui/flags/SG.svg | 1 + src/gui/flags/TW.svg | 1 + src/gui/flags/US.svg | 1 + src/gui/flags/ZA.svg | 1 + src/gui/headphones.svg | 1 + src/gui/help.svg | 1 + src/gui/icon.png | Bin 0 -> 1555 bytes src/gui/jacktrip white.png | Bin 0 -> 11229 bytes src/gui/jacktrip.png | Bin 0 -> 12135 bytes src/gui/join.svg | 3 + src/gui/language.svg | 3 + src/gui/leave.svg | 3 + src/gui/logo.svg | 3 + src/gui/loud.svg | 4 + src/gui/manage.svg | 1 + src/gui/messageDialog.cpp | 190 ++ src/gui/messageDialog.h | 75 + src/gui/messageDialog.ui | 28 + src/gui/mic.svg | 1 + src/gui/micoff.svg | 1 + src/gui/network.svg | 4 + src/gui/networkCheck.svg | 1 + src/gui/private.svg | 3 + src/gui/public.svg | 3 + src/gui/qjacktrip.cpp | 2046 ++++++++++++ src/gui/qjacktrip.h | 176 + src/gui/qjacktrip.qrc | 98 + src/gui/qjacktrip.ui | 2006 ++++++++++++ src/gui/qjacktrip_novs.qrc | 7 + src/gui/quiet.svg | 4 + src/gui/refresh.svg | 3 + src/gui/sentiment_very_dissatisfied.svg | 3 + src/gui/share.svg | 1 + src/gui/speed.svg | 4 + src/gui/star.svg | 1 + src/gui/start.svg | 1 + src/gui/textbuf.cpp | 69 + src/gui/textbuf.h | 66 + src/gui/video.svg | 1 + src/gui/virtualstudio.cpp | 1638 ++++++++++ src/gui/virtualstudio.h | 344 ++ src/gui/vs.qml | 312 ++ src/gui/vsApi.cpp | 163 + src/gui/vsApi.h | 89 + src/gui/vsAudio.cpp | 1420 ++++++++ src/gui/vsAudio.h | 454 +++ src/gui/vsAuth.cpp | 298 ++ src/gui/vsAuth.h | 133 + src/gui/vsConstants.h | 51 + src/gui/vsDeeplink.cpp | 212 ++ src/gui/vsDeeplink.h | 113 + src/gui/vsDevice.cpp | 601 ++++ src/gui/vsDevice.h | 122 + src/gui/vsDeviceCodeFlow.cpp | 249 ++ src/gui/vsDeviceCodeFlow.h | 109 + src/gui/vsMacPermissions.h | 64 + src/gui/vsMacPermissions.mm | 104 + src/gui/vsPermissions.cpp | 68 + src/gui/vsPermissions.h | 70 + src/gui/vsPing.cpp | 82 + src/gui/vsPing.h | 84 + src/gui/vsPinger.cpp | 317 ++ src/gui/vsPinger.h | 122 + src/gui/vsQmlClipboard.h | 26 + src/gui/vsQuickView.cpp | 68 + src/gui/vsQuickView.h | 64 + src/gui/vsServerInfo.cpp | 321 ++ src/gui/vsServerInfo.h | 164 + src/gui/vsWebSocket.cpp | 146 + src/gui/vsWebSocket.h | 81 + src/gui/vuMeter.cpp | 78 + src/gui/vuMeter.h | 60 + src/gui/warning.svg | 1 + src/gui/wedge.svg | 51 + src/gui/wedge_inactive.svg | 51 + src/jacktrip_globals.cpp | 180 ++ src/jacktrip_globals.h | 146 + src/jacktrip_types.h | 87 + src/limiterdsp.h | 2134 ++++++++++++ src/main.cpp | 540 ++++ src/makeXcodeproj.sh | 1 + src/meterdsp.h | 2062 ++++++++++++ src/monitordsp.h | 2224 +++++++++++++ src/stereotomonodsp.h | 2177 +++++++++++++ src/tonedsp.h | 2407 ++++++++++++++ src/volumedsp.h | 2092 ++++++++++++ src/zitarevdsp.h | 2853 ++++++++++++++++ src/zitarevmonodsp.h | 2860 +++++++++++++++++ .../rtaudio-coreaudio-stream-channels.patch | 11 + ...dio-remove-input-disconnect-listener.patch | 11 + subprojects/rtaudio.wrap | 9 + subprojects/wingetopt.wrap | 6 + tests/jacktrip_tests.cpp | 94 + win/CodeSignTool/CodeSignTool.sh | 1 + .../conf/code_sign_tool.properties | 4 + win/CodeSignTool/conf/log4j2.xml | 28 + win/build_installer.bat | 79 + win/dialog.bmp | Bin 0 -> 615320 bytes win/dialog_alt.bmp | Bin 0 -> 615402 bytes win/getCsv.sh | 2 + win/jack.pc | 11 + win/jacktrip.exe.manifest | 9 + win/jacktrip.ico | Bin 0 -> 91111 bytes win/jacktrip.wxs | 54 + win/jacktrip_alt.ico | Bin 0 -> 93096 bytes win/meson.build | 36 + win/qjacktrip.rc | 6 + win/qt5.wxs | 1845 +++++++++++ win/qt6-noguids.wxs | 2226 +++++++++++++ win/qt6.wxs | 2203 +++++++++++++ 430 files changed, 89405 insertions(+) create mode 100644 .clang-format create mode 100644 .clang-format-ignore create mode 100644 .clang-tidy create mode 100644 .clang-tidy-ignore create mode 100644 .dockerignore create mode 100644 .mailmap create mode 100644 .pre-commit-config.yaml create mode 100644 CMakeLists.txt create mode 100644 Dockerfile create mode 100644 Doxyfile create mode 100644 LICENSE.md create mode 100644 LICENSES/AVC.txt create mode 100644 LICENSES/GPL-3.0.txt create mode 100644 LICENSES/LGPL-3.0-only.txt create mode 100644 LICENSES/MIT.txt create mode 100644 QJackTrip.kdev4 create mode 100644 README.md create mode 100755 build create mode 100644 build-aux/flatpak/org.jacktrip.JackTrip.json create mode 100644 build-aux/flatpak/pypi-dependencies.json create mode 100644 build-aux/flatpak/requirements.txt create mode 100755 build-aux/flatpak/update_pip_deps.sh create mode 100644 cross/x86_mingw64.txt create mode 100644 cross/x86_mingw64_static.txt create mode 100644 docs/About/CHANGELOG.md create mode 100644 docs/About/Contributors.md create mode 100644 docs/About/License.md create mode 100644 docs/About/Resources.md create mode 100644 docs/Build/CrossCompile.md create mode 100644 docs/Build/Linux.md create mode 100644 docs/Build/Mac.md create mode 100644 docs/Build/Meson_build.md create mode 100644 docs/Build/Windows.md create mode 100644 docs/CustomJackServerName.md create mode 100644 docs/DevTools/Formatting.md create mode 100644 docs/DevTools/StaticAnalysis.md create mode 100644 docs/Documentation/MkDocs.md create mode 100644 docs/Install.md create mode 100644 docs/VirtualStudio.md create mode 100644 docs/assets/jacktrip.svg create mode 100644 docs/changelog.yml create mode 100644 docs/images/jacktrip_hubclient_basic.png create mode 100644 docs/images/jacktrip_hubclient_plugins.png create mode 100644 docs/images/jacktrip_hubserver_basic.png create mode 100644 docs/images/jacktrip_hubserver_jitter.png create mode 100644 docs/images/jacktrip_virtual_studio.png create mode 100644 docs/index.md create mode 100644 docs/requirements.txt create mode 100644 documentation/documentation.cpp create mode 100644 documentation/footer.html create mode 100644 documentation/header.html create mode 100644 documentation/img/jack_main_settings.jpg create mode 100644 documentation/img/jack_routing.png create mode 100644 documentation/img/qjackctl.png create mode 100644 externals/Simple-FFT/LICENSE.md create mode 100644 externals/Simple-FFT/README.md create mode 100644 externals/Simple-FFT/include/simple_fft/check_fft.hpp create mode 100644 externals/Simple-FFT/include/simple_fft/copy_array.hpp create mode 100644 externals/Simple-FFT/include/simple_fft/error_handling.hpp create mode 100644 externals/Simple-FFT/include/simple_fft/fft.h create mode 100644 externals/Simple-FFT/include/simple_fft/fft.hpp create mode 100644 externals/Simple-FFT/include/simple_fft/fft_impl.hpp create mode 100644 externals/Simple-FFT/include/simple_fft/fft_settings.h create mode 100644 faust-src/Makefile create mode 100644 faust-src/Makefile.compile create mode 100644 faust-src/Makefile.headers create mode 100644 faust-src/Makefile.ladspacompile create mode 100644 faust-src/Makefile.mspcompile create mode 100644 faust-src/Makefile.pdcompile create mode 100644 faust-src/Makefile.qcompile create mode 100644 faust-src/Makefile.qtcompile create mode 100644 faust-src/Makefile.sccompile create mode 100644 faust-src/Makefile.svg create mode 100644 faust-src/Makefile.vstcompile create mode 100644 faust-src/README-Limiter.md create mode 100644 faust-src/compressor-limiter-test.dsp create mode 100644 faust-src/compressordsp.dsp create mode 100644 faust-src/faust2header.cpp create mode 100644 faust-src/freeverbdsp.dsp create mode 100644 faust-src/freeverbmonodsp.dsp create mode 100644 faust-src/limiterdsp.dsp create mode 100644 faust-src/limitertest.dsp create mode 100644 faust-src/meterdsp.dsp create mode 100644 faust-src/minimal.cpp create mode 100644 faust-src/monitordsp.dsp create mode 100644 faust-src/net-ks.dsp create mode 100644 faust-src/tests/compressor-limiter-test.dsp create mode 100644 faust-src/tests/compressor2dsp.dsp create mode 100644 faust-src/tonedsp.dsp create mode 100644 faust-src/volumedsp.dsp create mode 100644 faust-src/zitarevdsp.dsp create mode 100644 faust-src/zitarevmonodsp.dsp create mode 100644 jacktrip.pro create mode 100644 jacktrip_and_rtaudio.pro create mode 100644 linux/README.md create mode 100755 linux/add_changelog_to_metainfo.py create mode 100644 linux/container/README.md create mode 100644 linux/container/jacktrip.service create mode 100644 linux/icons/jacktrip-symbolic.svg create mode 100644 linux/icons/jacktrip.svg create mode 100644 linux/icons/jacktrip_48x48.png create mode 100644 linux/icons/jacktrip_48x48_alt.png create mode 100644 linux/icons/jacktrip_alt.svg create mode 100644 linux/meson.build create mode 100644 linux/org.jacktrip.JackTrip.desktop.in create mode 100644 linux/org.jacktrip.JackTrip.metainfo.xml.in.in create mode 100644 macos/Info_novs.plist create mode 100644 macos/JackTrip.app_template/Contents/Info.plist create mode 100644 macos/JackTrip.app_template/Contents/PkgInfo create mode 100644 macos/JackTrip.app_template/Contents/Resources/jacktrip.icns create mode 100755 macos/assemble_app.sh create mode 100644 macos/entitlements.plist create mode 100644 macos/jacktrip.iconset/icon_128x128.png create mode 100644 macos/jacktrip.iconset/icon_128x128@2x.png create mode 100644 macos/jacktrip.iconset/icon_16x16.png create mode 100644 macos/jacktrip.iconset/icon_16x16@2x.png create mode 100644 macos/jacktrip.iconset/icon_256x256.png create mode 100644 macos/jacktrip.iconset/icon_256x256@2x.png create mode 100644 macos/jacktrip.iconset/icon_32x32.png create mode 100644 macos/jacktrip.iconset/icon_32x32@2x.png create mode 100644 macos/jacktrip.iconset/icon_512x512.png create mode 100644 macos/jacktrip.iconset/icon_512x512@2x.png create mode 100644 macos/jacktrip_alt.icns create mode 100644 macos/jacktrip_alt.iconset/icon_128x128.png create mode 100644 macos/jacktrip_alt.iconset/icon_128x128@2x.png create mode 100644 macos/jacktrip_alt.iconset/icon_16x16.png create mode 100644 macos/jacktrip_alt.iconset/icon_16x16@2x.png create mode 100644 macos/jacktrip_alt.iconset/icon_256x256.png create mode 100644 macos/jacktrip_alt.iconset/icon_256x256@2x.png create mode 100644 macos/jacktrip_alt.iconset/icon_32x32.png create mode 100644 macos/jacktrip_alt.iconset/icon_32x32@2x.png create mode 100644 macos/jacktrip_alt.iconset/icon_512x512.png create mode 100644 macos/jacktrip_alt.iconset/icon_512x512@2x.png create mode 100644 macos/meson_native_minversion_10.13.ini create mode 100644 macos/meson_native_minversion_10.14.ini create mode 100644 macos/meson_native_universal.ini create mode 100644 macos/meson_native_universal_10.13.ini create mode 100644 macos/meson_native_universal_10.14.ini create mode 100644 macos/package/JackTrip.pkgproj_template create mode 100755 macos/package/postinstall.sh create mode 100755 macos/sign-stuff.sh create mode 100644 meson.build create mode 100644 meson_options.txt create mode 100644 mkdocs.yml create mode 100644 releases/edge/mac-manifests.json create mode 100644 releases/edge/win-manifests.json create mode 100644 releases/stable/linux-manifests.json create mode 100644 releases/stable/mac-manifests.json create mode 100644 releases/stable/win-manifests.json create mode 100644 rtaudio.pro create mode 100644 scripts/README.md create mode 100755 scripts/hubMode/art.sh create mode 100755 scripts/hubMode/startJacktripHubClient.sh create mode 100755 scripts/hubMode/startJacktripHubServer.sh create mode 100755 scripts/hubMode/test_hub_mode_server_and_client.sh create mode 100644 scripts/slork/die.bin create mode 100644 scripts/slork/feedjack-cleanslate.bin create mode 100644 scripts/slork/feedjack-client.bin create mode 100644 scripts/slork/feedjack-clientconnect.bin create mode 100644 scripts/slork/feedjack-launch-n-jacktrip-servers.bin create mode 100644 scripts/slork/feedjack-launch-one-jacktrip-client.bin create mode 100644 scripts/slork/feedjack-launchjack-even-without-motu.bin create mode 100644 scripts/slork/feedjack-launchjack.bin create mode 100644 scripts/slork/feedjack-remotespeakerconnect.bin create mode 100644 scripts/slork/feedjack-server.bin create mode 100644 scripts/slork/feedjack-serverconnect.bin create mode 100755 scripts/test/client_connection_test.sh create mode 100755 scripts/test/version_test.sh create mode 100755 scripts/update_manifests.sh create mode 100755 scripts/utility/generate_auth.sh create mode 100755 scripts/utility/record_jack_receiving_ports.sh create mode 100644 src/Analyzer.cpp create mode 100644 src/Analyzer.h create mode 100644 src/AudioInterface.cpp create mode 100644 src/AudioInterface.h create mode 100644 src/AudioTester.cpp create mode 100644 src/AudioTester.h create mode 100644 src/Auth.cpp create mode 100644 src/Auth.h create mode 100644 src/Compressor.cpp create mode 100644 src/Compressor.h create mode 100644 src/CompressorPresets.h create mode 100644 src/DataProtocol.cpp create mode 100644 src/DataProtocol.h create mode 100644 src/Effects.h create mode 100644 src/JMess.cpp create mode 100644 src/JMess.h create mode 100644 src/JTApplication.h create mode 100644 src/JackAudioInterface.cpp create mode 100644 src/JackAudioInterface.h create mode 100644 src/JackTrip.cpp create mode 100644 src/JackTrip.h create mode 100644 src/JackTripWorker.cpp create mode 100644 src/JackTripWorker.h create mode 100644 src/JitterBuffer.cpp create mode 100644 src/JitterBuffer.h create mode 100644 src/Limiter.cpp create mode 100644 src/Limiter.h create mode 100644 src/LoopBack.cpp create mode 100644 src/LoopBack.h create mode 100644 src/Meter.cpp create mode 100644 src/Meter.h create mode 100644 src/Monitor.cpp create mode 100644 src/Monitor.h create mode 100644 src/PacketHeader.cpp create mode 100644 src/PacketHeader.h create mode 100644 src/Patcher.cpp create mode 100644 src/Patcher.h create mode 100644 src/ProcessPlugin.cpp create mode 100644 src/ProcessPlugin.h create mode 100644 src/QtStaticPlugins.cpp create mode 100644 src/Regulator.cpp create mode 100644 src/Regulator.h create mode 100644 src/Reverb.cpp create mode 100644 src/Reverb.h create mode 100644 src/RingBuffer.cpp create mode 100644 src/RingBuffer.h create mode 100644 src/RingBufferWavetable.h create mode 100644 src/RtAudioInterface.cpp create mode 100644 src/RtAudioInterface.h create mode 100644 src/Settings.cpp create mode 100644 src/Settings.h create mode 100644 src/SslServer.cpp create mode 100644 src/SslServer.h create mode 100644 src/StereoToMono.cpp create mode 100644 src/StereoToMono.h create mode 100644 src/Tone.cpp create mode 100644 src/Tone.h create mode 100644 src/UdpDataProtocol.cpp create mode 100644 src/UdpDataProtocol.h create mode 100644 src/UdpHubListener.cpp create mode 100644 src/UdpHubListener.h create mode 100644 src/Volume.cpp create mode 100644 src/Volume.h create mode 100644 src/WaitFreeFrameBuffer.h create mode 100644 src/WaitFreeRingBuffer.h create mode 100755 src/build create mode 100644 src/compressordsp.h create mode 100644 src/dblsqd/feed.cpp create mode 100644 src/dblsqd/feed.h create mode 100644 src/dblsqd/release.cpp create mode 100644 src/dblsqd/release.h create mode 100644 src/dblsqd/semver.cpp create mode 100644 src/dblsqd/semver.h create mode 100644 src/dblsqd/update_dialog.cpp create mode 100644 src/dblsqd/update_dialog.h create mode 100644 src/dblsqd/update_dialog.ui create mode 100644 src/freeverbdsp.h create mode 100644 src/freeverbmonodsp.h create mode 100644 src/gui/AppIcon.qml create mode 100644 src/gui/AudioInterfaceMode.h create mode 100644 src/gui/AudioSettings.qml create mode 100644 src/gui/Browse.qml create mode 100644 src/gui/ChangeDevices.qml create mode 100644 src/gui/Connected.qml create mode 100644 src/gui/CreateStudio.qml create mode 100644 src/gui/DeviceControls.qml create mode 100644 src/gui/DeviceControlsGroup.qml create mode 100644 src/gui/DeviceRefreshButton.qml create mode 100644 src/gui/DeviceWarning.qml create mode 100644 src/gui/Failed.qml create mode 100644 src/gui/FeedbackSurvey.qml create mode 100644 src/gui/FirstLaunch.qml create mode 100644 src/gui/Footer.qml create mode 100644 src/gui/InfoTooltip.qml create mode 100644 src/gui/JTOriginal.png create mode 100644 src/gui/JTVS.png create mode 100644 src/gui/LearnMoreButton.qml create mode 100644 src/gui/Login.qml create mode 100644 src/gui/Meter.qml create mode 100644 src/gui/MeterBars.qml create mode 100644 src/gui/NoNap.h create mode 100644 src/gui/NoNap.mm create mode 100644 src/gui/Permissions.qml create mode 100644 src/gui/Poppins-Bold.ttf create mode 100644 src/gui/Poppins-Regular.ttf create mode 100644 src/gui/Prompt.svg create mode 100644 src/gui/Recommendations.qml create mode 100644 src/gui/SectionHeading.qml create mode 100644 src/gui/Settings.qml create mode 100644 src/gui/Setup.qml create mode 100644 src/gui/Studio.qml create mode 100644 src/gui/VolumeSlider.qml create mode 100644 src/gui/Web.qml create mode 100644 src/gui/WebEngine.qml create mode 100644 src/gui/WebNull.qml create mode 100644 src/gui/WebSocketTransport.cpp create mode 100644 src/gui/WebSocketTransport.h create mode 100644 src/gui/WebView.qml create mode 100644 src/gui/about.cpp create mode 100644 src/gui/about.h create mode 100644 src/gui/about.png create mode 100644 src/gui/about.ui create mode 100644 src/gui/about@2x.png create mode 100644 src/gui/alt/Jacktrip.ai create mode 100644 src/gui/alt/about.png create mode 100644 src/gui/alt/about@2x.png create mode 100644 src/gui/alt/icon.png create mode 100644 src/gui/check.svg create mode 100644 src/gui/close.svg create mode 100644 src/gui/cog.svg create mode 100644 src/gui/ethernet.svg create mode 100644 src/gui/expand_less.svg create mode 100644 src/gui/expand_more.svg create mode 100644 src/gui/externalMic.svg create mode 100644 src/gui/flags/AE.svg create mode 100644 src/gui/flags/AU.svg create mode 100644 src/gui/flags/BE.svg create mode 100644 src/gui/flags/BR.svg create mode 100644 src/gui/flags/CA.svg create mode 100644 src/gui/flags/CH.svg create mode 100644 src/gui/flags/DE.svg create mode 100644 src/gui/flags/FR.svg create mode 100644 src/gui/flags/GB.svg create mode 100644 src/gui/flags/HK.svg create mode 100644 src/gui/flags/ID.svg create mode 100644 src/gui/flags/IT.svg create mode 100644 src/gui/flags/JP.svg create mode 100644 src/gui/flags/RO.svg create mode 100644 src/gui/flags/SE.svg create mode 100644 src/gui/flags/SG.svg create mode 100644 src/gui/flags/TW.svg create mode 100644 src/gui/flags/US.svg create mode 100644 src/gui/flags/ZA.svg create mode 100644 src/gui/headphones.svg create mode 100644 src/gui/help.svg create mode 100644 src/gui/icon.png create mode 100644 src/gui/jacktrip white.png create mode 100644 src/gui/jacktrip.png create mode 100644 src/gui/join.svg create mode 100644 src/gui/language.svg create mode 100644 src/gui/leave.svg create mode 100644 src/gui/logo.svg create mode 100644 src/gui/loud.svg create mode 100644 src/gui/manage.svg create mode 100644 src/gui/messageDialog.cpp create mode 100644 src/gui/messageDialog.h create mode 100644 src/gui/messageDialog.ui create mode 100644 src/gui/mic.svg create mode 100644 src/gui/micoff.svg create mode 100644 src/gui/network.svg create mode 100644 src/gui/networkCheck.svg create mode 100644 src/gui/private.svg create mode 100644 src/gui/public.svg create mode 100644 src/gui/qjacktrip.cpp create mode 100644 src/gui/qjacktrip.h create mode 100644 src/gui/qjacktrip.qrc create mode 100644 src/gui/qjacktrip.ui create mode 100644 src/gui/qjacktrip_novs.qrc create mode 100644 src/gui/quiet.svg create mode 100644 src/gui/refresh.svg create mode 100644 src/gui/sentiment_very_dissatisfied.svg create mode 100644 src/gui/share.svg create mode 100644 src/gui/speed.svg create mode 100644 src/gui/star.svg create mode 100644 src/gui/start.svg create mode 100644 src/gui/textbuf.cpp create mode 100644 src/gui/textbuf.h create mode 100644 src/gui/video.svg create mode 100644 src/gui/virtualstudio.cpp create mode 100644 src/gui/virtualstudio.h create mode 100644 src/gui/vs.qml create mode 100644 src/gui/vsApi.cpp create mode 100644 src/gui/vsApi.h create mode 100644 src/gui/vsAudio.cpp create mode 100644 src/gui/vsAudio.h create mode 100644 src/gui/vsAuth.cpp create mode 100644 src/gui/vsAuth.h create mode 100644 src/gui/vsConstants.h create mode 100644 src/gui/vsDeeplink.cpp create mode 100644 src/gui/vsDeeplink.h create mode 100644 src/gui/vsDevice.cpp create mode 100644 src/gui/vsDevice.h create mode 100644 src/gui/vsDeviceCodeFlow.cpp create mode 100644 src/gui/vsDeviceCodeFlow.h create mode 100644 src/gui/vsMacPermissions.h create mode 100644 src/gui/vsMacPermissions.mm create mode 100644 src/gui/vsPermissions.cpp create mode 100644 src/gui/vsPermissions.h create mode 100644 src/gui/vsPing.cpp create mode 100644 src/gui/vsPing.h create mode 100644 src/gui/vsPinger.cpp create mode 100644 src/gui/vsPinger.h create mode 100644 src/gui/vsQmlClipboard.h create mode 100644 src/gui/vsQuickView.cpp create mode 100644 src/gui/vsQuickView.h create mode 100644 src/gui/vsServerInfo.cpp create mode 100644 src/gui/vsServerInfo.h create mode 100644 src/gui/vsWebSocket.cpp create mode 100644 src/gui/vsWebSocket.h create mode 100644 src/gui/vuMeter.cpp create mode 100644 src/gui/vuMeter.h create mode 100644 src/gui/warning.svg create mode 100644 src/gui/wedge.svg create mode 100644 src/gui/wedge_inactive.svg create mode 100644 src/jacktrip_globals.cpp create mode 100644 src/jacktrip_globals.h create mode 100644 src/jacktrip_types.h create mode 100644 src/limiterdsp.h create mode 100644 src/main.cpp create mode 100755 src/makeXcodeproj.sh create mode 100644 src/meterdsp.h create mode 100644 src/monitordsp.h create mode 100644 src/stereotomonodsp.h create mode 100644 src/tonedsp.h create mode 100644 src/volumedsp.h create mode 100644 src/zitarevdsp.h create mode 100644 src/zitarevmonodsp.h create mode 100644 subprojects/packagefiles/rtaudio-coreaudio-stream-channels.patch create mode 100644 subprojects/packagefiles/rtaudio-remove-input-disconnect-listener.patch create mode 100644 subprojects/rtaudio.wrap create mode 100644 subprojects/wingetopt.wrap create mode 100644 tests/jacktrip_tests.cpp create mode 100755 win/CodeSignTool/CodeSignTool.sh create mode 100644 win/CodeSignTool/conf/code_sign_tool.properties create mode 100644 win/CodeSignTool/conf/log4j2.xml create mode 100755 win/build_installer.bat create mode 100644 win/dialog.bmp create mode 100644 win/dialog_alt.bmp create mode 100755 win/getCsv.sh create mode 100644 win/jack.pc create mode 100644 win/jacktrip.exe.manifest create mode 100644 win/jacktrip.ico create mode 100644 win/jacktrip.wxs create mode 100644 win/jacktrip_alt.ico create mode 100644 win/meson.build create mode 100644 win/qjacktrip.rc create mode 100644 win/qt5.wxs create mode 100644 win/qt6-noguids.wxs create mode 100644 win/qt6.wxs diff --git a/.clang-format b/.clang-format new file mode 100644 index 0000000..273d78a --- /dev/null +++ b/.clang-format @@ -0,0 +1,184 @@ +--- +Language: Cpp +# BasedOnStyle: Google +AccessModifierOffset: -1 +AlignAfterOpenBracket: Align +AlignConsecutiveMacros: true +AlignConsecutiveAssignments: true +AlignConsecutiveBitFields: false +AlignConsecutiveDeclarations: false +AlignEscapedNewlines: Left +AlignOperands: Align +AlignTrailingComments: true +AllowAllArgumentsOnNextLine: true +AllowAllConstructorInitializersOnNextLine: true +AllowAllParametersOfDeclarationOnNextLine: true +AllowShortEnumsOnASingleLine: true +AllowShortBlocksOnASingleLine: Empty +AllowShortCaseLabelsOnASingleLine: false +AllowShortFunctionsOnASingleLine: Inline +AllowShortLambdasOnASingleLine: Empty +AllowShortIfStatementsOnASingleLine: Never +AllowShortLoopsOnASingleLine: false +AlwaysBreakAfterDefinitionReturnType: None +AlwaysBreakAfterReturnType: None +AlwaysBreakBeforeMultilineStrings: true +AlwaysBreakTemplateDeclarations: Yes +BinPackArguments: true +BinPackParameters: true +BraceWrapping: + AfterCaseLabel: false + AfterClass: false + AfterControlStatement: Never + AfterEnum: false + AfterFunction: false + AfterNamespace: false + AfterObjCDeclaration: false + AfterStruct: false + AfterUnion: false + AfterExternBlock: false + BeforeCatch: false + BeforeElse: false + BeforeLambdaBody: false + BeforeWhile: false + IndentBraces: false + SplitEmptyFunction: true + SplitEmptyRecord: true + SplitEmptyNamespace: true +BreakBeforeBinaryOperators: NonAssignment +BreakBeforeBraces: Linux +BreakBeforeInheritanceComma: false +BreakInheritanceList: BeforeComma +BreakBeforeTernaryOperators: true +BreakConstructorInitializersBeforeComma: false +BreakConstructorInitializers: BeforeComma +BreakAfterJavaFieldAnnotations: false +BreakStringLiterals: true +ColumnLimit: 90 +CommentPragmas: '( \| |\*--|
  • |@ref | @p | @param |@returns |@warning |@ingroup |@author |@date |@related |@relates |@relatesalso |@deprecated |@image |@return |@brief |@attention |@copydoc |@addtogroup |@todo |@tparam |@see |@note |@skip |@skipline |@until |@line |@dontinclude |@include)' +CompactNamespaces: false +ConstructorInitializerAllOnOneLineOrOnePerLine: true +ConstructorInitializerIndentWidth: 4 +ContinuationIndentWidth: 4 +Cpp11BracedListStyle: true +DeriveLineEnding: true +DerivePointerAlignment: false +DisableFormat: false +ExperimentalAutoDetectBinPacking: false +FixNamespaceComments: true +ForEachMacros: + - foreach + - Q_FOREACH + - BOOST_FOREACH +IncludeBlocks: Regroup +IncludeCategories: + - Regex: '^' + Priority: 2 + SortPriority: 0 + - Regex: '^<.*\.h>' + Priority: 1 + SortPriority: 0 + - Regex: '^<.*' + Priority: 2 + SortPriority: 0 + - Regex: '.*' + Priority: 3 + SortPriority: 0 +IncludeIsMainRegex: '([-_](test|unittest))?$' +IncludeIsMainSourceRegex: '' +IndentCaseLabels: false +IndentCaseBlocks: false +IndentGotoLabels: true +IndentPPDirectives: None +IndentExternBlock: AfterExternBlock +IndentWidth: 4 +IndentWrappedFunctionNames: false +InsertTrailingCommas: None +JavaScriptQuotes: Leave +JavaScriptWrapImports: true +KeepEmptyLinesAtTheStartOfBlocks: false +MacroBlockBegin: '' +MacroBlockEnd: '' +MaxEmptyLinesToKeep: 1 +NamespaceIndentation: None +ObjCBinPackProtocolList: Never +ObjCBlockIndentWidth: 2 +ObjCBreakBeforeNestedBlockParam: true +ObjCSpaceAfterProperty: false +ObjCSpaceBeforeProtocolList: true +PenaltyBreakAssignment: 2 +PenaltyBreakBeforeFirstCallParameter: 1 +PenaltyBreakComment: 300 +PenaltyBreakFirstLessLess: 120 +PenaltyBreakString: 1000 +PenaltyBreakTemplateDeclaration: 10 +PenaltyExcessCharacter: 1000000 +PenaltyReturnTypeOnItsOwnLine: 200 +PointerAlignment: Left +RawStringFormats: + - Language: Cpp + Delimiters: + - cc + - CC + - cpp + - Cpp + - CPP + - 'c++' + - 'C++' + CanonicalDelimiter: '' + BasedOnStyle: google + - Language: TextProto + Delimiters: + - pb + - PB + - proto + - PROTO + EnclosingFunctions: + - EqualsProto + - EquivToProto + - PARSE_PARTIAL_TEXT_PROTO + - PARSE_TEST_PROTO + - PARSE_TEXT_PROTO + - ParseTextOrDie + - ParseTextProtoOrDie + - ParseTestProto + - ParsePartialTestProto + CanonicalDelimiter: '' + BasedOnStyle: google +ReflowComments: true +SortIncludes: true +SortUsingDeclarations: true +SpaceAfterCStyleCast: false +SpaceAfterLogicalNot: false +SpaceAfterTemplateKeyword: false +SpaceBeforeAssignmentOperators: true +SpaceBeforeCpp11BracedList: false +SpaceBeforeCtorInitializerColon: true +SpaceBeforeInheritanceColon: true +SpaceBeforeParens: ControlStatements +SpaceBeforeRangeBasedForLoopColon: true +SpaceInEmptyBlock: false +SpaceInEmptyParentheses: false +SpacesBeforeTrailingComments: 2 +SpacesInAngles: false +SpacesInConditionalStatement: false +SpacesInContainerLiterals: true +SpacesInCStyleCastParentheses: false +SpacesInParentheses: false +SpacesInSquareBrackets: false +SpaceBeforeSquareBrackets: false +Standard: Auto +StatementMacros: + - Q_UNUSED + - QT_REQUIRE_VERSION +TabWidth: 8 +UseCRLF: false +UseTab: Never +WhitespaceSensitiveMacros: + - STRINGIZE + - PP_STRINGIZE + - BOOST_PP_STRINGIZE +--- +Language: ObjC +DisableFormat: true +... diff --git a/.clang-format-ignore b/.clang-format-ignore new file mode 100644 index 0000000..9337953 --- /dev/null +++ b/.clang-format-ignore @@ -0,0 +1,4 @@ +externals/* +faust-src/faust2header.cpp +src/*dsp.h + diff --git a/.clang-tidy b/.clang-tidy new file mode 100644 index 0000000..864b26f --- /dev/null +++ b/.clang-tidy @@ -0,0 +1 @@ +Checks: '-*,modernize-deprecated-headers,modernize-loop-convert,google-build-using-namespace' diff --git a/.clang-tidy-ignore b/.clang-tidy-ignore new file mode 100644 index 0000000..0cb64dc --- /dev/null +++ b/.clang-tidy-ignore @@ -0,0 +1,4 @@ +subprojects +externals +documentation +src/*dsp.h \ No newline at end of file diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..b517c8e --- /dev/null +++ b/.dockerignore @@ -0,0 +1,8 @@ +* +!docs +!meson* +!container +!src +!subprojects +!linux +!win \ No newline at end of file diff --git a/.mailmap b/.mailmap new file mode 100644 index 0000000..626b511 --- /dev/null +++ b/.mailmap @@ -0,0 +1,35 @@ +Nils Tonnätt +Nils Tonnätt studio + +Marcin Pączkowski + +Maximilian Wagenbach + +Julius Smith +Julius Smith Julius Smith + +Juan-Pablo Caceres +Juan-Pablo Caceres +Juan-Pablo Caceres +Juan-Pablo Caceres jcaceres +Juan-Pablo Caceres jua20133 +Juan-Pablo Caceres jcaceres + +Aaron Wyatt +Aaron Wyatt psiborg112 + +Chris Chafe +Chris Chafe cc +Chris Chafe +Chris Chafe <4406287+cchafe@users.noreply.github.com> + + +Bonnie Kwong +Bonnie Kwong Bonnie Kwong + +Omar Costa Hamido + +Mike Dickey +Mike Dickey Mike Dickey + +IOhannes m zmölnig diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..bcffe68 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,9 @@ +fail_fast: false +repos: + - repo: https://github.com/ssciwr/clang-format-hook + rev: v13.0.1 + hooks: + - id: clang-format + files: ^src/ + types_or: [c++] + exclude: '^src/.+dsp\.h' \ No newline at end of file diff --git a/CMakeLists.txt b/CMakeLists.txt new file mode 100644 index 0000000..a4e80a8 --- /dev/null +++ b/CMakeLists.txt @@ -0,0 +1,291 @@ +cmake_minimum_required(VERSION 3.12) +set(CMAKE_OSX_DEPLOYMENT_TARGET 10.14) +set(CMAKE_CXX_STANDARD 17) +project(QJackTrip) + +set(nogui FALSE) +set(rtaudio TRUE) +set(weakjack TRUE) +set(novs FALSE) +set(vsftux FALSE) +set(noupdater FALSE) +set(psi FALSE) +set(QtVersion "5") + +if (${QtVersion} MATCHES "5") + set(CMAKE_OSX_DEPLOYMENT_TARGET 10.13) + set(CMAKE_OSX_ARCHITECTURES arm64;x86_64) +endif () + +message(STATUS "Hello Aaron! For anyone else, heed the following warning:") +message(WARNING "The CMake build of JackTrip is currently NOT officially supported. Meson or QMake are recommended for a full featured build." + "https://jacktrip.github.io/jacktrip/Build/Meson_build/") + +if (nogui) + add_compile_definitions(NO_GUI) + set(novs TRUE) + set(noupdater TRUE) +endif () + +if (psi) + set(novs TRUE) +endif () + +if (novs) + add_compile_definitions(NO_VS) + set(QRC_FILE "src/gui/qjacktrip_novs.qrc") +else () + set(QRC_FILE "src/gui/qjacktrip.qrc") +endif () + +if (vsftux) + add_compile_definitions(VS_FTUX) +endif () + +if (noupdater) + add_compile_definitions(NO_UPDATER) +endif () + +if (psi) + add_compile_definitions(PSI) + if (novs) + add_compile_definitions(BUILD_TYPE="psi-borg.org NO_VS binary") + else () + add_compile_definitions(BUILD_TYPE="psi-borg.org binary") + endif () + + file(READ "${QRC_FILE}" QRC_CONTENTS) + string(REPLACE "about@2x.png" "alt/about@2x.png" QRC_CONTENTS "${QRC_CONTENTS}") + string(REPLACE "about.png" "alt/about.png" QRC_CONTENTS "${QRC_CONTENTS}") + string(REPLACE "icon.png" "alt/icon.png" QRC_CONTENTS "${QRC_CONTENTS}") + file(WRITE "${QRC_FILE}" "${QRC_CONTENTS}") + string(TIMESTAMP BUILD_DATE "%Y%m%d") + set(BUILD_NUMBER "00") + add_compile_definitions(BUILD_ID="${BUILD_DATE}${BUILD_NUMBER}") + add_compile_definitions(NDEBUG) +else () + file(READ "${QRC_FILE}" QRC_CONTENTS) + string(REPLACE "alt/about@2x.png" "about@2x.png" QRC_CONTENTS "${QRC_CONTENTS}") + string(REPLACE "alt/about.png" "about.png" QRC_CONTENTS "${QRC_CONTENTS}") + string(REPLACE "alt/icon.png" "icon.png" QRC_CONTENTS "${QRC_CONTENTS}") + file(WRITE "${QRC_FILE}" "${QRC_CONTENTS}") +endif () + +add_compile_definitions(QT_OPENSOURCE) + +if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + set (ENV{PKG_CONFIG_PATH} "/usr/local/lib/pkgconfig") +elseif (${CMAKE_SYSTEM_NAME} MATCHES "Windows") + add_compile_definitions(_WIN32_WINNT=0x0600 WIN32_LEAN_AND_MEAN) + if (EXISTS "C:/Program Files/JACK2/include") + include_directories("C:/Program Files/JACK2/include") + set (jacklib "C:/Program Files/JACK2/lib/libjack64.lib") + else () + include_directories("C:/Program Files (x86)/Jack/includes") + set (jacklib "C:/Program Files (x86)/Jack/lib/libjack64.lib") + endif () + file(GLOB QtDirs "C:/Qt/${QtVersion}.*.*/mingw*_64") + list(GET QtDirs 0 QtDir) + message(STATUS "Using Qt found at ${QtDir}") + set (CMAKE_PREFIX_PATH "${QtDir}") + if (rtaudio) + include_directories("C:/Program Files (x86)/RtAudio/include") + set (rtaudiolib "C:/Program Files (x86)/RtAudio/lib/librtaudio.dll.a") + endif () +endif () + +string(PREPEND QtVersion "Qt") + +if (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + find_package(PkgConfig REQUIRED) + pkg_check_modules(JACK REQUIRED IMPORTED_TARGET jack) + if (weakjack) + # On mac, weakjack doesn't find jack unless this is explicitly included. + include_directories(${JACK_INCLUDE_DIRS}) + endif () + if (rtaudio) + pkg_check_modules(RTAUDIO REQUIRED IMPORTED_TARGET rtaudio) + endif () +endif () + +#set_property(SOURCE src/Regulator.h PROPERTY SKIP_AUTOGEN ON) +# Find includes in corresponding build directories +set(CMAKE_INCLUDE_CURRENT_DIR ON) +# Instruct CMake to run moc automatically when needed. +set(CMAKE_AUTOMOC ON) +# Instruct CMake to create code from Qt designer ui files +set(CMAKE_AUTOUIC ON) + +set(CMAKE_AUTORCC ON) + +# Find the QtWidgets library +if (NOT nogui) + find_package(${QtVersion}Widgets CONFIG REQUIRED) + if (NOT novs) + find_package(${QtVersion}Quick CONFIG REQUIRED) + find_package(${QtVersion}NetworkAuth CONFIG REQUIRED) + find_package(${QtVersion}WebSockets CONFIG REQUIRED) + endif () +endif () +find_package(${QtVersion}Network CONFIG REQUIRED) + +set(qjacktrip_SRC + src/main.cpp + src/Settings.cpp + src/jacktrip_globals.cpp + src/JackTrip.cpp + src/UdpHubListener.cpp + src/JackTripWorker.cpp + src/DataProtocol.cpp + src/UdpDataProtocol.cpp + src/AudioInterface.cpp + src/JackAudioInterface.cpp + src/JMess.cpp + src/LoopBack.cpp + src/PacketHeader.cpp + src/RingBuffer.cpp + src/JitterBuffer.cpp + src/Regulator.cpp + src/Compressor.cpp + src/Limiter.cpp + src/Reverb.cpp + src/AudioTester.cpp + src/Patcher.cpp + src/SslServer.cpp + src/Auth.cpp + src/ProcessPlugin.cpp +) + +if (rtaudio) + add_compile_definitions(RT_AUDIO) + set (qjacktrip_SRC ${qjacktrip_SRC} + src/RtAudioInterface.cpp + src/StereoToMono.cpp + ) +endif () + +if (weakjack) + add_compile_definitions(USE_WEAK_JACK) + include_directories("externals/weakjack") + set (qjacktrip_SRC ${qjacktrip_SRC} + externals/weakjack/weak_libjack.c + ) +endif () + +if (NOT nogui) + set (qjacktrip_SRC ${qjacktrip_SRC} + src/gui/qjacktrip.cpp + src/gui/about.cpp + src/gui/messageDialog.cpp + src/gui/textbuf.cpp + src/gui/vuMeter.cpp + src/Meter.cpp + ) + + if (NOT novs) + set (qjacktrip_SRC ${qjacktrip_SRC} + src/gui/virtualstudio.cpp + src/gui/vsApi.cpp + src/gui/vsAuth.cpp + src/gui/vsDeviceCodeFlow.cpp + src/gui/vsDeeplink.cpp + src/gui/vsQuickView.cpp + src/gui/vsServerInfo.cpp + src/gui/vsPing.cpp + src/gui/vsPinger.cpp + src/gui/vsDevice.cpp + src/gui/vsAudio.cpp + src/gui/vsWebSocket.cpp + src/gui/vsPermissions.cpp + src/gui/qjacktrip.qrc + src/Analyzer.cpp + src/Monitor.cpp + src/Volume.cpp + src/Tone.cpp + # Need to include this for AUTOMOC to do its thing + src/JTApplication.h + src/gui/vsQmlClipboard.h + ) + if (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + set (qjacktrip_SRC ${qjacktrip_SRC} src/gui/vsMacPermissions.mm) + endif () + else () + set (qjacktrip_SRC ${qjacktrip_SRC} src/gui/qjacktrip_novs.qrc) + endif () + + if (NOT noupdater) + set (qjacktrip_SRC ${qjacktrip_SRC} + src/dblsqd/feed.cpp + src/dblsqd/release.cpp + src/dblsqd/semver.cpp + src/dblsqd/update_dialog.cpp + ) + endif () + + if (${CMAKE_SYSTEM_NAME} MATCHES "Windows") + file(READ "win/qjacktrip.rc" RC_CONTENTS) + if (psi) + string(REPLACE "jacktrip.ico" "jacktrip_alt.ico" RC_CONTENTS "${RC_CONTENTS}") + else () + string(REPLACE "jacktrip_alt.ico" "jacktrip.ico" RC_CONTENTS "${RC_CONTENTS}") + endif () + file(WRITE "win/qjacktrip.rc" "${RC_CONTENTS}") + set (qjacktrip_SRC ${qjacktrip_SRC} win/qjacktrip.rc) + elseif (${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + set (qjacktrip_SRC ${qjacktrip_SRC} src/gui/NoNap.mm) + set (CMAKE_C_FLAGS "-x objective-c") + set (CMAKE_EXE_LINKER_FLAGS "-framework Foundation") + if (NOT novs) + set (CMAKE_EXE_LINKER_FLAGS "${CMAKE_EXE_LINKER_FLAGS} -framework AVFoundation") + endif () + endif () +endif () + +add_compile_definitions(WAIRTOHUB) + +# Tell CMake to create the executable +add_executable(jacktrip ${qjacktrip_SRC}) + +# Set our libraries for our linker +set (qjacktrip_LIBS ${QtVersion}::Network) +if (NOT nogui) + set (qjacktrip_LIBS ${qjacktrip_LIBS} ${QtVersion}::Widgets) + if (NOT novs) + set (qjacktrip_LIBS ${qjacktrip_LIBS} ${QtVersion}::Quick ${QtVersion}::NetworkAuth ${QtVersion}::WebSockets) + endif () +endif () + +if (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + if (weakjack) + set (qjacktrip_LIBS ${qjacktrip_LIBS} dl) + else () + set (qjacktrip_LIBS ${qjacktrip_LIBS} PkgConfig::JACK) + endif () + if (rtaudio) + set (qjacktrip_LIBS ${qjacktrip_LIBS} PkgConfig::RTAUDIO) + endif () +elseif (${CMAKE_SYSTEM_NAME} MATCHES "Windows") + set (qjacktrip_LIBS ${qjacktrip_LIBS} ws2_32) + if (NOT weakjack) + set (qjacktrip_LIBS ${qjacktrip_LIBS} ${jacklib}) + endif () + if (rtaudio) + set (qjacktrip_LIBS ${qjacktrip_LIBS} ${rtaudiolib}) + endif () +endif () + +target_link_libraries(jacktrip ${qjacktrip_LIBS}) + +if (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + add_custom_command( + TARGET jacktrip POST_BUILD + COMMAND help2man --no-info --section=1 --output=jacktrip.1 ./jacktrip + WORKING_DIRECTORY ${CMAKE_BINARY_DIR} + ) +endif () + +# Install the executable +install(TARGETS jacktrip DESTINATION bin) +if (${CMAKE_SYSTEM_NAME} MATCHES "Linux" OR ${CMAKE_SYSTEM_NAME} MATCHES "Darwin") + install(FILES ${CMAKE_BINARY_DIR}/jacktrip.1 DESTINATION share/man/man1) +endif () diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..2fa1bc0 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,68 @@ +# JackTrip container image using Redhat Universal Base Image ubi-init +# +# Copyright (c) 2023-2024 JackTrip Labs, Inc. +# MIT License. +# +# To build this from repository root: "podman build -t jacktrip/jacktrip ." + +# container image versions +ARG FEDORA_VERSION=34 +ARG JACK_VERSION=latest + + +############### +# STAGE BUILDER +############### +# use a temporary container to build jacktrip +FROM registry.fedoraproject.org/fedora:${FEDORA_VERSION} AS builder + +# install tools require to build jacktrip +RUN dnf install -y --nodocs gcc gcc-c++ meson git python3-pyyaml python3-jinja2 glib2-devel jack-audio-connection-kit-devel + +ENV QT_VERSION=6.5.3 +RUN if [ "$(uname -m)" = "x86_64" ]; then export ARCH=amd64; else export ARCH=arm64; fi \ + && curl -L -s -o /root/qt.tar.gz "https://files.jacktrip.org/contrib/qt/qt-${QT_VERSION}-static-linux-${ARCH}.tar.gz" \ + && tar -C /opt -xzf /root/qt.tar.gz \ + && rm -f /root/qt.tar.gz + +# copy files from repository to build container +COPY . /root + +# configure and run the build +RUN cd /root \ + && export QT_PATH=/opt/qt-${QT_VERSION}-static \ + && export PATH=${QT_PATH}/bin:${PATH} \ + && export LDFLAGS="-L${QT_PATH}/lib -L${QT_PATH}/plugins/tls" \ + && meson setup -Ddefault_library=static -Dnogui=true --buildtype release builddir \ + && meson compile -C builddir + +# stage files in INSTALLDIR +ENV INSTALLDIR=/artifacts +RUN mkdir -p ${INSTALLDIR}/usr/local/bin/ ${INSTALLDIR}/etc/systemd/system/ \ + && cp /root/builddir/jacktrip ${INSTALLDIR}/usr/local/bin/ \ + && strip ${INSTALLDIR}/usr/local/bin/jacktrip +COPY linux/container/jacktrip.service ${INSTALLDIR}/etc/systemd/system/ + + +######################## +# STAGE JACKTRIP (FINAL) +######################## +# use the jack ubi-init container +FROM jacktrip/jack:${JACK_VERSION} + +# add jacktrip user, enable service and allow access to jackd +RUN useradd -r -m -N -G audio -s /usr/sbin/nologin jacktrip \ + && chown -R jacktrip.audio /home/jacktrip \ + && chmod g+rwx /home/jacktrip \ + && ln -s /etc/systemd/system/jacktrip.service /etc/systemd/system/multi-user.target.wants \ + && sed -i 's,PassEnvironment=.*,PassEnvironment=SAMPLE_RATE BUFFER_SIZE JACK_OPTS JACKTRIP_OPTS,' /etc/systemd/system/defaults.service \ + && sed -i 's,WantedBy=.*,WantedBy=multi-user.target jack.service jacktrip.service,' /etc/systemd/system/defaults.service \ + && echo 'if [[ -z "$JACKTRIP_OPTS" ]]; then JACKTRIP_OPTS="-S -t -z --hubpatch 4 --bufstrategy 4 -q auto"; fi' >> /usr/sbin/defaults.sh \ + && echo 'echo "JACKTRIP_OPTS=\"$JACKTRIP_OPTS\"" > /etc/default/jacktrip' >> /usr/sbin/defaults.sh + +# copy the artifacts we built into the final container image +COPY --from=builder /artifacts / + +# jacktrip hub server listens on 4464 and uses 61000+ for clients +EXPOSE 4464/tcp +EXPOSE 61000-61100/udp \ No newline at end of file diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..44a9421 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,2603 @@ +# Doxyfile 1.9.1 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = JackTrip + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = + +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. + +PROJECT_LOGO = linux/icons/jacktrip.svg + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. + +OUTPUT_DIRECTORY = . + +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. + +CREATE_SUBDIRS = NO + +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = YES + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. + +OUTPUT_LANGUAGE = English + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief +# description. +# The default value is: NO. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. +# The default value is: NO. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. + +FULL_PATH_NAMES = YES + +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# By default Python docstrings are displayed as preformatted text and doxygen's +# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the +# doxygen's special commands can be used and the contents of the docstring +# documentation blocks is shown as doxygen documentation. +# The default value is: YES. + +PYTHON_DOCSTRING = YES + +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. + +TAB_SIZE = 8 + +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. When specifying no_extension you should add +# * to the FILE_PATTERNS. +# +# Note see also the list of default file extension mappings. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. +# The default value is: NO. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. +# The default value is: NO. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. +# The default value is: NO. + +DISTRIBUTE_GROUP_DOC = NO + +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. + +TYPEDEF_HIDES_STRUCT = NO + +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. + +LOOKUP_CACHE_SIZE = 0 + +# The NUM_PROC_THREADS specifies the number threads doxygen is allowed to use +# during processing. When set to 0 doxygen will based this on the number of +# cores available in the system. You can set it explicitly to a value larger +# than 0 to get more control over the balance between CPU load and processing +# speed. At this moment only the input processing can be done using multiple +# threads. Since this is still an experimental feature the default is set to 1, +# which efficively disables parallel processing. Please report any issues you +# encounter. Generating dot graphs in parallel is controlled by the +# DOT_NUM_THREADS setting. +# Minimum value: 0, maximum value: 32, default value: 1. + +NUM_PROC_THREADS = 1 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = NO + +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. + +EXTRACT_ANON_NSPACES = NO + +# If this flag is set to YES, the name of an unnamed parameter in a declaration +# will be determined by the corresponding definition. By default unnamed +# parameters remain unnamed in the output. +# The default value is: YES. + +RESOLVE_UNNAMED_PARAMS = YES + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# declarations. If set to NO, these declarations will be included in the +# documentation. +# The default value is: NO. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. + +INTERNAL_DOCS = NO + +# With the correct setting of option CASE_SENSE_NAMES doxygen will better be +# able to match the capabilities of the underlying filesystem. In case the +# filesystem is case sensitive (i.e. it supports files in the same directory +# whose names only differ in casing), the option must be set to YES to properly +# deal with such files in case they appear in the input. For filesystems that +# are not case sensitive the option should be be set to NO to properly deal with +# output files written for symbols that only differ in casing, such as for two +# classes, one named CLASS and the other named Class, and to also support +# references to files without having to specify the exact matching casing. On +# Windows (including Cygwin) and MacOS, users should typically set this option +# to NO, whereas on Linux or other Unix flavors it should typically be set to +# YES. +# The default value is: system dependent. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. + +HIDE_SCOPE_NAMES = NO + +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. + +SHOW_INCLUDE_FILES = YES + +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. + +SORT_MEMBERS_CTORS_1ST = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS +# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but +# at the end of the doxygen process doxygen will return with a non-zero status. +# Possible values are: NO, YES and FAIL_ON_WARNINGS. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = ./src \ + ./documentation + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: +# https://www.gnu.org/software/libiconv/) for the list of possible encodings. +# The default value is: UTF-8. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# Note the list of default checked file patterns might differ from the list of +# default file extension mappings. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox (to be provided as doxygen C comment), +# *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, *.vhdl, +# *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = ./documentation/img + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = + +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = + +#--------------------------------------------------------------------------- +# Configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the +# clang parser (see: +# http://clang.llvm.org/) for more accurate parsing at the cost of reduced +# performance. This can be particularly helpful with template rich C++ code for +# which doxygen's built-in parser lacks the necessary type information. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. +# The default value is: NO. + +CLANG_ASSISTED_PARSING = NO + +# If clang assisted parsing is enabled and the CLANG_ADD_INC_PATHS tag is set to +# YES then doxygen will add the directory of each input to the include path. +# The default value is: YES. + +CLANG_ADD_INC_PATHS = YES + +# If clang assisted parsing is enabled you can provide the compiler with command +# line options that you would normally use when invoking the compiler. Note that +# the include paths will already be set by doxygen for the files and directories +# specified with INPUT and INCLUDE_PATH. +# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES. + +CLANG_OPTIONS = + +# If clang assisted parsing is enabled you can provide the clang parser with the +# path to the directory containing a file called compile_commands.json. This +# file is the compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the +# options used when the source files were built. This is equivalent to +# specifying the -p option to a clang tool, such as clang-check. These options +# will then be passed to the parser. Any options specified with CLANG_OPTIONS +# will be added as well. +# Note: The availability of this option depends on whether or not doxygen was +# generated with the -Duse_libclang=ON option for CMake. + +CLANG_DATABASE_PATH = + +#--------------------------------------------------------------------------- +# Configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. + +ALPHABETICAL_INDEX = NO + +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = ./documentation/header.html + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = ./documentation/footer.html + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = externals/doxygen-awesome-css/doxygen-awesome.css externals/doxygen-awesome-css/doxygen-awesome-sidebar-only.css + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the style sheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_TIMESTAMP = NO + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: +# https://developer.apple.com/xcode/), introduced with OSX 10.5 (Leopard). To +# create a documentation set, doxygen will generate a Makefile in the HTML +# output directory. Running make will produce the docset in that directory and +# running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: +# https://www.microsoft.com/en-us/download/details.aspx?id=21138) on Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the main .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +GENERATE_CHI = NO + +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_INDEX_ENCODING = + +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location (absolute path +# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to +# run qhelpgenerator on the generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. + +ENUM_VALUES_PER_LINE = 4 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. + +TREEVIEW_WIDTH = 250 + +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +EXT_LINKS_IN_WINDOW = NO + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png (the default) and svg (looks nicer but requires the +# pdf2svg or inkscape tool). +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2 + +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: +# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /