From 5a6c26e8834c22d4cff9f58083ba1743e4eb5773 Mon Sep 17 00:00:00 2001 From: aahmed878 Date: Tue, 11 Nov 2025 09:40:28 +0000 Subject: [PATCH 1/4] TEST Signed-off-by: aahmed878 --- CMakeLists.txt | 59 +- middleware/.github/CODEOWNERS | 5 + middleware/.github/workflows/L1-tests.yml | 51 + middleware/.github/workflows/cla.yml | 20 + ...gration_stateless_diffscan_target_repo.yml | 19 + .../.github/workflows/native-full-build.yml | 29 + middleware/.gitignore | 2 + middleware/CMakeLists.txt | 413 ++ middleware/CONTRIBUTING.md | 4 + middleware/COPYING | 1 + middleware/Doxyfile | 2518 +++++++ middleware/GstHandlerControl.cpp | 85 + middleware/GstHandlerControl.h | 165 + middleware/GstUtils.cpp | 123 + middleware/GstUtils.h | 123 + middleware/InterfacePlayerPriv.h | 318 + middleware/InterfacePlayerRDK.cpp | 5349 ++++++++++++++ middleware/InterfacePlayerRDK.h | 781 +++ middleware/LICENSE | 281 + middleware/NOTICE | 32 + middleware/OSX/OSxSetup.md | 61 + .../patches/0009-qtdemux-tm_gst-1.16.patch | 168 + ...move-override-segment-event_gst-1.16.patch | 34 + ...-crypto-info-on-trak-switch_gst-1.16.patch | 49 + ...0021-qtdemux-tm-multiperiod_gst-1.16.patch | 124 + middleware/OSX/patches/JsonHelper.patch | 38 + middleware/OSX/patches/RDKLogo.png | Bin 0 -> 45324 bytes middleware/OSX/patches/RDKLogoBlack.png | Bin 0 -> 53447 bytes middleware/OSX/patches/RDKLogoGreen.png | Bin 0 -> 53973 bytes .../OSX/patches/subttxrend-app-packet.patch | 39 + .../subttxrend-app-ubuntu_24_04_build.patch | 86 + .../patches/subttxrend-app-xkbcommon.patch | 161 + .../patches/websocket-ipplayer2-link.patch | 22 + .../websocket-ipplayer2-typescpp.patch | 16 + ...bsocket-ipplayer2-ubuntu_24_04_build.patch | 20 + middleware/PlayerMetadata.hpp | 54 + middleware/PlayerScheduler.cpp | 249 + middleware/PlayerScheduler.h | 168 + middleware/PlayerUtils.cpp | 267 + middleware/PlayerUtils.h | 103 + middleware/ProcessHandler.cpp | 160 + middleware/ProcessHandler.h | 98 + middleware/RDK-Logo.png | Bin 0 -> 11420 bytes middleware/SocUtils.cpp | 128 + middleware/SocUtils.h | 98 + middleware/baseConversion/CMakeLists.txt | 36 + middleware/baseConversion/_base64.cpp | 128 + middleware/baseConversion/_base64.h | 52 + middleware/baseConversion/base16.cpp | 102 + middleware/baseConversion/base16.h | 47 + middleware/closedcaptions/CCTrackInfo.h | 39 + middleware/closedcaptions/PlayerCCManager.cpp | 889 +++ middleware/closedcaptions/PlayerCCManager.h | 357 + .../rialto/PlayerRialtoCCManager.cpp | 203 + .../rialto/PlayerRialtoCCManager.h | 129 + .../subtec/CCDataController.cpp | 332 + .../closedcaptions/subtec/CCDataController.h | 89 + .../subtec/PlayerSubtecCCManager.cpp | 202 + .../subtec/PlayerSubtecCCManager.h | 144 + .../closedcaptions/subtec/SubtecConnector.cpp | 168 + .../closedcaptions/subtec/SubtecConnector.h | 404 ++ middleware/cmake/FindWPEFramework.cmake | 109 + middleware/drm/ClearKeyDrmSession.cpp | 632 ++ middleware/drm/ClearKeyDrmSession.h | 154 + middleware/drm/DrmCallbacks.h | 45 + middleware/drm/DrmConstants.h | 38 + middleware/drm/DrmData.h | 98 + middleware/drm/DrmInfo.h | 95 + middleware/drm/DrmJsonObject.cpp | 660 ++ middleware/drm/DrmJsonObject.h | 279 + middleware/drm/DrmMediaFormat.h | 47 + middleware/drm/DrmMemorySystem.h | 80 + middleware/drm/DrmSession.cpp | 67 + middleware/drm/DrmSession.h | 176 + middleware/drm/DrmSessionFactory.cpp | 66 + middleware/drm/DrmSessionFactory.h | 48 + middleware/drm/DrmSessionManager.cpp | 837 +++ middleware/drm/DrmSessionManager.h | 487 ++ middleware/drm/DrmSystems.h | 47 + middleware/drm/DrmUtils.cpp | 170 + middleware/drm/DrmUtils.h | 101 + middleware/drm/HlsDrmBase.h | 140 + middleware/drm/HlsDrmSessionManager.cpp | 62 + middleware/drm/HlsDrmSessionManager.h | 62 + middleware/drm/HlsOcdmBridge.cpp | 102 + middleware/drm/HlsOcdmBridge.h | 71 + middleware/drm/HlsOcdmBridgeInterface.cpp | 41 + middleware/drm/HlsOcdmBridgeInterface.h | 77 + .../drm/PlayerHlsDrmSessionInterface.cpp | 80 + middleware/drm/PlayerHlsDrmSessionInterface.h | 96 + .../drm/PlayerHlsDrmSessionInterfaceBase.h | 81 + middleware/drm/aes/Aes.cpp | 387 ++ middleware/drm/aes/Aes.h | 224 + middleware/drm/helper/ClearKeyHelper.cpp | 263 + middleware/drm/helper/ClearKeyHelper.h | 99 + middleware/drm/helper/DrmHelper.cpp | 61 + middleware/drm/helper/DrmHelper.h | 371 + middleware/drm/helper/DrmHelperFactory.cpp | 106 + middleware/drm/helper/PlayReadyHelper.cpp | 307 + middleware/drm/helper/PlayReadyHelper.h | 102 + middleware/drm/helper/VanillaDrmHelper.h | 77 + middleware/drm/helper/VerimatrixHelper.cpp | 151 + middleware/drm/helper/VerimatrixHelper.h | 83 + middleware/drm/helper/WidevineDrmHelper.cpp | 271 + middleware/drm/helper/WidevineDrmHelper.h | 98 + .../drm/ocdm/OcdmBasicSessionAdapter.cpp | 79 + middleware/drm/ocdm/OcdmBasicSessionAdapter.h | 40 + middleware/drm/ocdm/OcdmGstSessionAdapter.cpp | 432 ++ middleware/drm/ocdm/OcdmGstSessionAdapter.h | 58 + middleware/drm/ocdm/opencdmsessionadapter.cpp | 422 ++ middleware/drm/ocdm/opencdmsessionadapter.h | 146 + middleware/drm/processProtectionHls.cpp | 259 + middleware/externals/CMakeLists.txt | 186 + .../externals/IFirebolt/FireboltInterface.cpp | 124 + .../externals/IFirebolt/FireboltInterface.h | 57 + middleware/externals/Module.cpp | 31 + middleware/externals/Module.h | 34 + middleware/externals/PlayerExternalUtils.cpp | 68 + middleware/externals/PlayerExternalUtils.h | 48 + .../externals/PlayerExternalsInterface.cpp | 150 + .../externals/PlayerExternalsInterface.h | 201 + .../externals/PlayerExternalsInterfaceBase.h | 143 + middleware/externals/PlayerRfc.cpp | 74 + middleware/externals/PlayerRfc.h | 36 + .../externals/PlayerThunderAccessBase.h | 412 ++ .../externals/PlayerThunderInterface.cpp | 457 ++ middleware/externals/PlayerThunderInterface.h | 306 + .../ContentSecurityManager.cpp | 221 + .../ContentSecurityManager.h | 281 + .../ContentSecurityManagerSession.cpp | 155 + .../ContentSecurityManagerSession.h | 148 + .../IFirebolt/ContentProtectionFirebolt.cpp | 612 ++ .../IFirebolt/ContentProtectionFirebolt.h | 207 + .../PlayerMemoryUtils.cpp | 106 + .../PlayerMemoryUtils.h | 47 + .../PlayerSecInterface.cpp | 214 + .../PlayerSecInterface.h | 223 + .../SecManagerThunder.cpp | 962 +++ .../SecManagerThunder.h | 208 + .../ThunderAccessPlayer.cpp | 234 + .../ThunderAccessPlayer.h | 127 + .../externals/rdk/DeviceInterfaceBase.h | 57 + .../rdk/IFirebolt/DeviceFireboltInterface.cpp | 276 + .../rdk/IFirebolt/DeviceFireboltInterface.h | 87 + .../rdk/IIarm/DeviceIARMInterface.cpp | 319 + .../externals/rdk/IIarm/DeviceIARMInterface.h | 72 + .../rdk/PlayerExternalsRdkInterface.cpp | 295 + .../rdk/PlayerExternalsRdkInterface.h | 154 + .../externals/rdk/PlayerThunderAccess.cpp | 1159 ++++ .../externals/rdk/PlayerThunderAccess.h | 452 ++ middleware/gst-plugins/CMakeLists.txt | 124 + middleware/gst-plugins/COPYING | 22 + middleware/gst-plugins/COPYING.LGPL | 176 + .../gst-plugins/drm/gst/gstcdmidecryptor.cpp | 1097 +++ .../gst-plugins/drm/gst/gstcdmidecryptor.h | 88 + .../drm/gst/gstclearkeydecryptor.cpp | 113 + .../drm/gst/gstclearkeydecryptor.h | 82 + .../drm/gst/gstplayreadydecryptor.cpp | 110 + .../drm/gst/gstplayreadydecryptor.h | 80 + .../drm/gst/gstverimatrixdecryptor.cpp | 91 + .../drm/gst/gstverimatrixdecryptor.h | 82 + .../drm/gst/gstwidevinedecryptor.cpp | 98 + .../drm/gst/gstwidevinedecryptor.h | 82 + .../gst-plugins/gst_subtec/CMakeLists.txt | 84 + middleware/gst-plugins/gst_subtec/Readme.md | 23 + .../gst-plugins/gst_subtec/gstsubtecbin.cpp | 386 ++ .../gst-plugins/gst_subtec/gstsubtecbin.h | 66 + .../gst_subtec/gstsubtecmp4transform.cpp | 393 ++ .../gst_subtec/gstsubtecmp4transform.h | 55 + .../gst-plugins/gst_subtec/gstsubtecsink.cpp | 656 ++ .../gst-plugins/gst_subtec/gstsubtecsink.h | 63 + .../gst_subtec/gstvipertransform.cpp | 601 ++ .../gst_subtec/gstvipertransform.h | 68 + middleware/gst-plugins/gstinit.cpp | 106 + middleware/gstplayertaskpool.cpp | 120 + middleware/gstplayertaskpool.h | 60 + middleware/install-middleware.sh | 168 + middleware/mp4demux/mp4demux.hpp | 1241 ++++ middleware/playerJsonObject/CMakeLists.txt | 50 + .../playerJsonObject/PlayerJsonObject.cpp | 737 ++ .../playerJsonObject/PlayerJsonObject.h | 280 + middleware/playerLogManager/CMakeLists.txt | 58 + .../playerLogManager/PlayerLogManager.cpp | 203 + .../playerLogManager/PlayerLogManager.h | 167 + middleware/playerisobmff/playerisobmffbox.cpp | 1515 ++++ middleware/playerisobmff/playerisobmffbox.h | 1134 +++ .../playerisobmff/playerisobmffbuffer.cpp | 209 + .../playerisobmff/playerisobmffbuffer.h | 159 + middleware/scripts/install_clone.sh | 49 + middleware/scripts/install_dependencies.sh | 254 + middleware/scripts/install_glib.sh | 34 + middleware/scripts/install_gstreamer.sh | 131 + middleware/scripts/install_gtest.sh | 46 + middleware/scripts/install_libcjson.sh | 67 + middleware/scripts/install_libdash.sh | 66 + middleware/scripts/install_options.sh | 98 + middleware/scripts/install_player.sh | 31 + middleware/scripts/install_rialto.sh | 86 + middleware/scripts/install_subtec.sh | 84 + middleware/scripts/tools.sh | 136 + .../subtec/libsubtec/ClosedCaptionsPacket.hpp | 117 + middleware/subtec/libsubtec/PacketSender.cpp | 246 + middleware/subtec/libsubtec/PacketSender.hpp | 103 + .../subtec/libsubtec/SubtecAttribute.hpp | 30 + middleware/subtec/libsubtec/SubtecChannel.cpp | 124 + middleware/subtec/libsubtec/SubtecChannel.hpp | 93 + middleware/subtec/libsubtec/SubtecPacket.hpp | 392 ++ middleware/subtec/libsubtec/TtmlPacket.hpp | 130 + middleware/subtec/libsubtec/WebVttPacket.hpp | 131 + .../subtecparser/TextStyleAttributes.cpp | 456 ++ .../subtec/subtecparser/TextStyleAttributes.h | 220 + .../subtec/subtecparser/TtmlSubtecParser.cpp | 224 + .../subtec/subtecparser/TtmlSubtecParser.hpp | 52 + .../subtecparser/WebVttSubtecParser.cpp | 110 + .../subtecparser/WebVttSubtecParser.hpp | 48 + .../subtecparser/WebvttSubtecDevInterface.cpp | 78 + .../subtecparser/WebvttSubtecDevInterface.hpp | 49 + middleware/subtec/test/subtec_test.cpp | 149 + middleware/subtitle/subtitleParser.h | 121 + middleware/subtitle/vttCue.h | 54 + middleware/test/common/CodeCoverage.cmake | 742 ++ middleware/test/pi-cli/CMakeLists.txt | 37 + middleware/test/pi-cli/Dockerfile | 64 + middleware/test/pi-cli/README.md | 122 + middleware/test/pi-cli/commandProcessing.cpp | 638 ++ middleware/test/pi-cli/commandProcessing.h | 78 + middleware/test/pi-cli/main.cpp | 144 + middleware/test/utests/CMakeLists.txt | 103 + middleware/test/utests/ReadMe.md | 165 + .../test/utests/drm/mocks/FakeID3Metadata.cpp | 81 + .../test/utests/drm/mocks/Fakeopencdm.cpp | 163 + .../test/utests/drm/mocks/Fakeopencdm.h | 57 + .../test/utests/drm/mocks/MockOpenCdm.h | 54 + middleware/test/utests/drm/mocks/gstMocks.c | 100 + middleware/test/utests/drm/ocdm/open_cdm.h | 639 ++ .../test/utests/drm/ocdm/open_cdm_adapter.h | 96 + middleware/test/utests/fakes/CMakeLists.txt | 65 + middleware/test/utests/fakes/FakeBase16.cpp | 25 + middleware/test/utests/fakes/FakeCrypto.cpp | 36 + .../test/utests/fakes/FakeDRMHelper.cpp | 38 + .../test/utests/fakes/FakeDRMSession.cpp | 25 + middleware/test/utests/fakes/FakeGLib.cpp | 252 + .../test/utests/fakes/FakeGStreamer.cpp | 878 +++ .../utests/fakes/FakeGstHandlerControl.cpp | 51 + .../utests/fakes/FakeGstPlayerTaskPool.cpp | 25 + middleware/test/utests/fakes/FakeGstUtils.cpp | 27 + .../test/utests/fakes/FakePacketSender.cpp | 68 + .../utests/fakes/FakePlayerJsonObject.cpp | 226 + .../test/utests/fakes/FakePlayerScheduler.cpp | 68 + .../fakes/FakePlayerThunderInterface.cpp | 174 + .../test/utests/fakes/FakePlayerUtils.cpp | 64 + .../test/utests/fakes/FakeSocInterface.cpp | 213 + middleware/test/utests/fakes/FakeSocUtils.cpp | 70 + .../utests/fakes/FakeTextStyleAttributes.cpp | 30 + middleware/test/utests/fakes/Fakeopencdm.cpp | 124 + .../fakes/Fakeopencdmsessionadapter.cpp | 70 + .../test/utests/mocks/MockDrmCallbacks.h | 32 + middleware/test/utests/mocks/MockDrmHelper.h | 85 + .../test/utests/mocks/MockDrmMemorySystem.h | 43 + middleware/test/utests/mocks/MockDrmSession.h | 44 + middleware/test/utests/mocks/MockGLib.h | 45 + middleware/test/utests/mocks/MockGStreamer.h | 70 + .../test/utests/mocks/MockGstHandlerControl.h | 35 + .../test/utests/mocks/MockHlsDrmSession.h | 38 + middleware/test/utests/mocks/MockOpenCdm.h | 56 + .../utests/mocks/MockOpenCdmSessionAdapter.h | 36 + .../test/utests/mocks/MockPacketSender.h | 51 + .../test/utests/mocks/MockPlayerConfig.h | 53 + .../test/utests/mocks/MockPlayerJsonObject.h | 49 + .../test/utests/mocks/MockPlayerScheduler.h | 36 + .../test/utests/mocks/MockPlayerUtils.h | 33 + middleware/test/utests/mocks/opencdmMocks.cpp | 103 + middleware/test/utests/mocks/opencdmMocks.h | 70 + middleware/test/utests/ocdm/open_cdm.h | 639 ++ .../test/utests/ocdm/open_cdm_adapter.h | 96 + middleware/test/utests/run.sh | 183 + .../tests/Base64PLAYER/Base64PLAYERTests.cpp | 26 + .../utests/tests/Base64PLAYER/Base64Tests.cpp | 334 + .../utests/tests/Base64PLAYER/CMakeLists.txt | 57 + middleware/test/utests/tests/CMakeLists.txt | 32 + .../test/utests/tests/DrmAes/CMakeLists.txt | 123 + .../test/utests/tests/DrmAes/DrmTestsAes.cpp | 1495 ++++ .../test/utests/tests/DrmAes/DrmTestsRun.cpp | 26 + .../test/utests/tests/DrmOcdm/CMakeLists.txt | 123 + .../tests/DrmOcdm/ClearKeyDrmSessionTests.cpp | 1479 ++++ .../utests/tests/DrmOcdm/DrmDataTests.cpp | 705 ++ .../test/utests/tests/DrmOcdm/DrmHLSTests.cpp | 73 + .../utests/tests/DrmOcdm/DrmHelperTests.cpp | 1062 +++ .../tests/DrmOcdm/DrmMemorySystemTests.cpp | 185 + .../tests/DrmOcdm/DrmSessionFactoryTests.cpp | 250 + .../tests/DrmOcdm/DrmSessionManagerTests.cpp | 6147 +++++++++++++++++ .../utests/tests/DrmOcdm/DrmSessionTests.cpp | 291 + .../test/utests/tests/DrmOcdm/DrmTestsRun.cpp | 26 + .../utests/tests/DrmOcdm/DrmUtilsTests.cpp | 595 ++ .../PlayerHlsDrmSessionInterfaceTests.cpp | 430 ++ .../tests/DrmSecureClient/CMakeLists.txt | 131 + .../tests/DrmSecureClient/DrmSessionTests.cpp | 152 + .../tests/DrmSecureClient/DrmTestsRun.cpp | 26 + .../utests/tests/DrmUrlTests/CMakeLists.txt | 72 + .../tests/DrmUrlTests/DrmSessionTests.cpp | 211 + .../utests/tests/DrmUrlTests/DrmTestsRun.cpp | 26 + .../GstHandlerControlTests/CMakeLists.txt | 61 + .../GstHandlerControlPlayerTests.cpp | 26 + .../GstHandlerControlTests.cpp | 195 + .../utests/tests/GstPlayer/CMakeLists.txt | 93 + .../tests/GstPlayer/FunctionalTests.cpp | 639 ++ .../utests/tests/GstPlayer/GstPlayerTests.cpp | 26 + .../tests/GstPlayer/PauseOnPlaybackTests.cpp | 369 + .../utests/tests/GstUtilsTests/CMakeLists.txt | 64 + .../GstUtilsTests/GstUtilsPlayerTests.cpp | 26 + .../tests/GstUtilsTests/GstUtilsTests.cpp | 86 + .../tests/OCDMSessionAdapter/CMakeLists.txt | 81 + .../OCDMSessionAdapter/FunctionalTests.cpp | 87 + .../OCDMSessionAdapterTests.cpp | 26 + .../tests/OCDMSessionAdapter/fakes/config.h | 1 + .../CMakeLists.txt | 79 + .../FunctionalTests.cpp | 243 + .../OcdmBasicSessionAdapterTests.cpp | 26 + .../utests/tests/PluginsTests/CMakeLists.txt | 133 + .../PlayerClearKeyDecryptorTests.cpp | 47 + .../PlayerPlayReadyDecryptorTests.cpp | 44 + .../PlayerVeriMatrixDecryptorTests.cpp | 44 + .../PlayerWidevineDecryptorTests.cpp | 45 + .../utests/tests/PluginsTests/PluginsRun.cpp | 26 + .../utests/tests/SubtecTests/CMakeLists.txt | 59 + .../PlayerSubtecCCManagerTests.cpp | 1952 ++++++ .../tests/SubtecTests/PlayerSubtecTests.cpp | 26 + .../tests/TextStyleAttributes/CMakeLists.txt | 53 + .../GetTextStyleAttributesTests.cpp | 2838 ++++++++ .../TextStyleAttributesTests.cpp | 26 + .../tests/TtmlSubtecParser/CMakeLists.txt | 78 + .../TtmlSubtecParserPlayer.cpp | 25 + .../TtmlSubtecParserTests.cpp | 1687 +++++ .../utests/tests/base16Tests/CMakeLists.txt | 64 + .../utests/tests/base16Tests/base16Tests.cpp | 153 + .../tests/base16Tests/base16playerTests.cpp | 25 + middleware/vendor/SocInterface.cpp | 258 + middleware/vendor/SocInterface.h | 488 ++ .../vendor/amlogic/AmlogicSocInterface.cpp | 302 + .../vendor/amlogic/AmlogicSocInterface.h | 206 + middleware/vendor/brcm/BrcmSocInterface.cpp | 208 + middleware/vendor/brcm/BrcmSocInterface.h | 140 + .../vendor/default/DefaultSocInterface.cpp | 264 + .../vendor/default/DefaultSocInterface.h | 172 + .../vendor/realtek/RealtekSocInterface.cpp | 355 + .../vendor/realtek/RealtekSocInterface.h | 291 + 346 files changed, 82532 insertions(+), 16 deletions(-) create mode 100644 middleware/.github/CODEOWNERS create mode 100644 middleware/.github/workflows/L1-tests.yml create mode 100644 middleware/.github/workflows/cla.yml create mode 100644 middleware/.github/workflows/fossid_integration_stateless_diffscan_target_repo.yml create mode 100644 middleware/.github/workflows/native-full-build.yml create mode 100644 middleware/.gitignore create mode 100644 middleware/CMakeLists.txt create mode 100644 middleware/CONTRIBUTING.md create mode 120000 middleware/COPYING create mode 100644 middleware/Doxyfile create mode 100644 middleware/GstHandlerControl.cpp create mode 100644 middleware/GstHandlerControl.h create mode 100644 middleware/GstUtils.cpp create mode 100644 middleware/GstUtils.h create mode 100755 middleware/InterfacePlayerPriv.h create mode 100644 middleware/InterfacePlayerRDK.cpp create mode 100644 middleware/InterfacePlayerRDK.h create mode 100644 middleware/LICENSE create mode 100644 middleware/NOTICE create mode 100644 middleware/OSX/OSxSetup.md create mode 100644 middleware/OSX/patches/0009-qtdemux-tm_gst-1.16.patch create mode 100644 middleware/OSX/patches/0013-qtdemux-remove-override-segment-event_gst-1.16.patch create mode 100644 middleware/OSX/patches/0014-qtdemux-clear-crypto-info-on-trak-switch_gst-1.16.patch create mode 100644 middleware/OSX/patches/0021-qtdemux-tm-multiperiod_gst-1.16.patch create mode 100644 middleware/OSX/patches/JsonHelper.patch create mode 100644 middleware/OSX/patches/RDKLogo.png create mode 100644 middleware/OSX/patches/RDKLogoBlack.png create mode 100644 middleware/OSX/patches/RDKLogoGreen.png create mode 100644 middleware/OSX/patches/subttxrend-app-packet.patch create mode 100644 middleware/OSX/patches/subttxrend-app-ubuntu_24_04_build.patch create mode 100644 middleware/OSX/patches/subttxrend-app-xkbcommon.patch create mode 100644 middleware/OSX/patches/websocket-ipplayer2-link.patch create mode 100644 middleware/OSX/patches/websocket-ipplayer2-typescpp.patch create mode 100644 middleware/OSX/patches/websocket-ipplayer2-ubuntu_24_04_build.patch create mode 100644 middleware/PlayerMetadata.hpp create mode 100644 middleware/PlayerScheduler.cpp create mode 100644 middleware/PlayerScheduler.h create mode 100644 middleware/PlayerUtils.cpp create mode 100644 middleware/PlayerUtils.h create mode 100644 middleware/ProcessHandler.cpp create mode 100644 middleware/ProcessHandler.h create mode 100644 middleware/RDK-Logo.png create mode 100644 middleware/SocUtils.cpp create mode 100644 middleware/SocUtils.h create mode 100644 middleware/baseConversion/CMakeLists.txt create mode 100644 middleware/baseConversion/_base64.cpp create mode 100644 middleware/baseConversion/_base64.h create mode 100644 middleware/baseConversion/base16.cpp create mode 100644 middleware/baseConversion/base16.h create mode 100644 middleware/closedcaptions/CCTrackInfo.h create mode 100644 middleware/closedcaptions/PlayerCCManager.cpp create mode 100644 middleware/closedcaptions/PlayerCCManager.h create mode 100644 middleware/closedcaptions/rialto/PlayerRialtoCCManager.cpp create mode 100644 middleware/closedcaptions/rialto/PlayerRialtoCCManager.h create mode 100644 middleware/closedcaptions/subtec/CCDataController.cpp create mode 100644 middleware/closedcaptions/subtec/CCDataController.h create mode 100644 middleware/closedcaptions/subtec/PlayerSubtecCCManager.cpp create mode 100644 middleware/closedcaptions/subtec/PlayerSubtecCCManager.h create mode 100644 middleware/closedcaptions/subtec/SubtecConnector.cpp create mode 100644 middleware/closedcaptions/subtec/SubtecConnector.h create mode 100644 middleware/cmake/FindWPEFramework.cmake create mode 100644 middleware/drm/ClearKeyDrmSession.cpp create mode 100644 middleware/drm/ClearKeyDrmSession.h create mode 100644 middleware/drm/DrmCallbacks.h create mode 100755 middleware/drm/DrmConstants.h create mode 100644 middleware/drm/DrmData.h create mode 100755 middleware/drm/DrmInfo.h create mode 100755 middleware/drm/DrmJsonObject.cpp create mode 100755 middleware/drm/DrmJsonObject.h create mode 100644 middleware/drm/DrmMediaFormat.h create mode 100644 middleware/drm/DrmMemorySystem.h create mode 100644 middleware/drm/DrmSession.cpp create mode 100755 middleware/drm/DrmSession.h create mode 100644 middleware/drm/DrmSessionFactory.cpp create mode 100644 middleware/drm/DrmSessionFactory.h create mode 100755 middleware/drm/DrmSessionManager.cpp create mode 100644 middleware/drm/DrmSessionManager.h create mode 100644 middleware/drm/DrmSystems.h create mode 100644 middleware/drm/DrmUtils.cpp create mode 100644 middleware/drm/DrmUtils.h create mode 100644 middleware/drm/HlsDrmBase.h create mode 100644 middleware/drm/HlsDrmSessionManager.cpp create mode 100644 middleware/drm/HlsDrmSessionManager.h create mode 100644 middleware/drm/HlsOcdmBridge.cpp create mode 100644 middleware/drm/HlsOcdmBridge.h create mode 100644 middleware/drm/HlsOcdmBridgeInterface.cpp create mode 100644 middleware/drm/HlsOcdmBridgeInterface.h create mode 100644 middleware/drm/PlayerHlsDrmSessionInterface.cpp create mode 100644 middleware/drm/PlayerHlsDrmSessionInterface.h create mode 100644 middleware/drm/PlayerHlsDrmSessionInterfaceBase.h create mode 100755 middleware/drm/aes/Aes.cpp create mode 100644 middleware/drm/aes/Aes.h create mode 100644 middleware/drm/helper/ClearKeyHelper.cpp create mode 100755 middleware/drm/helper/ClearKeyHelper.h create mode 100755 middleware/drm/helper/DrmHelper.cpp create mode 100755 middleware/drm/helper/DrmHelper.h create mode 100755 middleware/drm/helper/DrmHelperFactory.cpp create mode 100755 middleware/drm/helper/PlayReadyHelper.cpp create mode 100755 middleware/drm/helper/PlayReadyHelper.h create mode 100644 middleware/drm/helper/VanillaDrmHelper.h create mode 100755 middleware/drm/helper/VerimatrixHelper.cpp create mode 100755 middleware/drm/helper/VerimatrixHelper.h create mode 100755 middleware/drm/helper/WidevineDrmHelper.cpp create mode 100755 middleware/drm/helper/WidevineDrmHelper.h create mode 100755 middleware/drm/ocdm/OcdmBasicSessionAdapter.cpp create mode 100755 middleware/drm/ocdm/OcdmBasicSessionAdapter.h create mode 100755 middleware/drm/ocdm/OcdmGstSessionAdapter.cpp create mode 100755 middleware/drm/ocdm/OcdmGstSessionAdapter.h create mode 100644 middleware/drm/ocdm/opencdmsessionadapter.cpp create mode 100644 middleware/drm/ocdm/opencdmsessionadapter.h create mode 100755 middleware/drm/processProtectionHls.cpp create mode 100644 middleware/externals/CMakeLists.txt create mode 100644 middleware/externals/IFirebolt/FireboltInterface.cpp create mode 100644 middleware/externals/IFirebolt/FireboltInterface.h create mode 100644 middleware/externals/Module.cpp create mode 100644 middleware/externals/Module.h create mode 100644 middleware/externals/PlayerExternalUtils.cpp create mode 100644 middleware/externals/PlayerExternalUtils.h create mode 100644 middleware/externals/PlayerExternalsInterface.cpp create mode 100644 middleware/externals/PlayerExternalsInterface.h create mode 100644 middleware/externals/PlayerExternalsInterfaceBase.h create mode 100644 middleware/externals/PlayerRfc.cpp create mode 100644 middleware/externals/PlayerRfc.h create mode 100644 middleware/externals/PlayerThunderAccessBase.h create mode 100644 middleware/externals/PlayerThunderInterface.cpp create mode 100644 middleware/externals/PlayerThunderInterface.h create mode 100755 middleware/externals/contentsecuritymanager/ContentSecurityManager.cpp create mode 100755 middleware/externals/contentsecuritymanager/ContentSecurityManager.h create mode 100644 middleware/externals/contentsecuritymanager/ContentSecurityManagerSession.cpp create mode 100755 middleware/externals/contentsecuritymanager/ContentSecurityManagerSession.h create mode 100644 middleware/externals/contentsecuritymanager/IFirebolt/ContentProtectionFirebolt.cpp create mode 100644 middleware/externals/contentsecuritymanager/IFirebolt/ContentProtectionFirebolt.h create mode 100644 middleware/externals/contentsecuritymanager/PlayerMemoryUtils.cpp create mode 100644 middleware/externals/contentsecuritymanager/PlayerMemoryUtils.h create mode 100644 middleware/externals/contentsecuritymanager/PlayerSecInterface.cpp create mode 100644 middleware/externals/contentsecuritymanager/PlayerSecInterface.h create mode 100644 middleware/externals/contentsecuritymanager/SecManagerThunder.cpp create mode 100644 middleware/externals/contentsecuritymanager/SecManagerThunder.h create mode 100755 middleware/externals/contentsecuritymanager/ThunderAccessPlayer.cpp create mode 100755 middleware/externals/contentsecuritymanager/ThunderAccessPlayer.h create mode 100644 middleware/externals/rdk/DeviceInterfaceBase.h create mode 100644 middleware/externals/rdk/IFirebolt/DeviceFireboltInterface.cpp create mode 100644 middleware/externals/rdk/IFirebolt/DeviceFireboltInterface.h create mode 100644 middleware/externals/rdk/IIarm/DeviceIARMInterface.cpp create mode 100644 middleware/externals/rdk/IIarm/DeviceIARMInterface.h create mode 100644 middleware/externals/rdk/PlayerExternalsRdkInterface.cpp create mode 100644 middleware/externals/rdk/PlayerExternalsRdkInterface.h create mode 100644 middleware/externals/rdk/PlayerThunderAccess.cpp create mode 100644 middleware/externals/rdk/PlayerThunderAccess.h create mode 100755 middleware/gst-plugins/CMakeLists.txt create mode 100644 middleware/gst-plugins/COPYING create mode 100644 middleware/gst-plugins/COPYING.LGPL create mode 100755 middleware/gst-plugins/drm/gst/gstcdmidecryptor.cpp create mode 100644 middleware/gst-plugins/drm/gst/gstcdmidecryptor.h create mode 100644 middleware/gst-plugins/drm/gst/gstclearkeydecryptor.cpp create mode 100644 middleware/gst-plugins/drm/gst/gstclearkeydecryptor.h create mode 100644 middleware/gst-plugins/drm/gst/gstplayreadydecryptor.cpp create mode 100644 middleware/gst-plugins/drm/gst/gstplayreadydecryptor.h create mode 100755 middleware/gst-plugins/drm/gst/gstverimatrixdecryptor.cpp create mode 100755 middleware/gst-plugins/drm/gst/gstverimatrixdecryptor.h create mode 100644 middleware/gst-plugins/drm/gst/gstwidevinedecryptor.cpp create mode 100644 middleware/gst-plugins/drm/gst/gstwidevinedecryptor.h create mode 100644 middleware/gst-plugins/gst_subtec/CMakeLists.txt create mode 100644 middleware/gst-plugins/gst_subtec/Readme.md create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecbin.cpp create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecbin.h create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecmp4transform.cpp create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecmp4transform.h create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecsink.cpp create mode 100644 middleware/gst-plugins/gst_subtec/gstsubtecsink.h create mode 100644 middleware/gst-plugins/gst_subtec/gstvipertransform.cpp create mode 100644 middleware/gst-plugins/gst_subtec/gstvipertransform.h create mode 100755 middleware/gst-plugins/gstinit.cpp create mode 100644 middleware/gstplayertaskpool.cpp create mode 100644 middleware/gstplayertaskpool.h create mode 100755 middleware/install-middleware.sh create mode 100644 middleware/mp4demux/mp4demux.hpp create mode 100644 middleware/playerJsonObject/CMakeLists.txt create mode 100644 middleware/playerJsonObject/PlayerJsonObject.cpp create mode 100644 middleware/playerJsonObject/PlayerJsonObject.h create mode 100644 middleware/playerLogManager/CMakeLists.txt create mode 100644 middleware/playerLogManager/PlayerLogManager.cpp create mode 100644 middleware/playerLogManager/PlayerLogManager.h create mode 100644 middleware/playerisobmff/playerisobmffbox.cpp create mode 100644 middleware/playerisobmff/playerisobmffbox.h create mode 100644 middleware/playerisobmff/playerisobmffbuffer.cpp create mode 100644 middleware/playerisobmff/playerisobmffbuffer.h create mode 100644 middleware/scripts/install_clone.sh create mode 100644 middleware/scripts/install_dependencies.sh create mode 100644 middleware/scripts/install_glib.sh create mode 100644 middleware/scripts/install_gstreamer.sh create mode 100644 middleware/scripts/install_gtest.sh create mode 100755 middleware/scripts/install_libcjson.sh create mode 100755 middleware/scripts/install_libdash.sh create mode 100755 middleware/scripts/install_options.sh create mode 100644 middleware/scripts/install_player.sh create mode 100644 middleware/scripts/install_rialto.sh create mode 100755 middleware/scripts/install_subtec.sh create mode 100755 middleware/scripts/tools.sh create mode 100644 middleware/subtec/libsubtec/ClosedCaptionsPacket.hpp create mode 100644 middleware/subtec/libsubtec/PacketSender.cpp create mode 100644 middleware/subtec/libsubtec/PacketSender.hpp create mode 100644 middleware/subtec/libsubtec/SubtecAttribute.hpp create mode 100644 middleware/subtec/libsubtec/SubtecChannel.cpp create mode 100644 middleware/subtec/libsubtec/SubtecChannel.hpp create mode 100644 middleware/subtec/libsubtec/SubtecPacket.hpp create mode 100644 middleware/subtec/libsubtec/TtmlPacket.hpp create mode 100644 middleware/subtec/libsubtec/WebVttPacket.hpp create mode 100644 middleware/subtec/subtecparser/TextStyleAttributes.cpp create mode 100644 middleware/subtec/subtecparser/TextStyleAttributes.h create mode 100644 middleware/subtec/subtecparser/TtmlSubtecParser.cpp create mode 100644 middleware/subtec/subtecparser/TtmlSubtecParser.hpp create mode 100644 middleware/subtec/subtecparser/WebVttSubtecParser.cpp create mode 100644 middleware/subtec/subtecparser/WebVttSubtecParser.hpp create mode 100644 middleware/subtec/subtecparser/WebvttSubtecDevInterface.cpp create mode 100644 middleware/subtec/subtecparser/WebvttSubtecDevInterface.hpp create mode 100644 middleware/subtec/test/subtec_test.cpp create mode 100644 middleware/subtitle/subtitleParser.h create mode 100644 middleware/subtitle/vttCue.h create mode 100644 middleware/test/common/CodeCoverage.cmake create mode 100644 middleware/test/pi-cli/CMakeLists.txt create mode 100644 middleware/test/pi-cli/Dockerfile create mode 100644 middleware/test/pi-cli/README.md create mode 100644 middleware/test/pi-cli/commandProcessing.cpp create mode 100644 middleware/test/pi-cli/commandProcessing.h create mode 100644 middleware/test/pi-cli/main.cpp create mode 100644 middleware/test/utests/CMakeLists.txt create mode 100644 middleware/test/utests/ReadMe.md create mode 100644 middleware/test/utests/drm/mocks/FakeID3Metadata.cpp create mode 100644 middleware/test/utests/drm/mocks/Fakeopencdm.cpp create mode 100644 middleware/test/utests/drm/mocks/Fakeopencdm.h create mode 100644 middleware/test/utests/drm/mocks/MockOpenCdm.h create mode 100644 middleware/test/utests/drm/mocks/gstMocks.c create mode 100644 middleware/test/utests/drm/ocdm/open_cdm.h create mode 100644 middleware/test/utests/drm/ocdm/open_cdm_adapter.h create mode 100644 middleware/test/utests/fakes/CMakeLists.txt create mode 100644 middleware/test/utests/fakes/FakeBase16.cpp create mode 100644 middleware/test/utests/fakes/FakeCrypto.cpp create mode 100644 middleware/test/utests/fakes/FakeDRMHelper.cpp create mode 100644 middleware/test/utests/fakes/FakeDRMSession.cpp create mode 100644 middleware/test/utests/fakes/FakeGLib.cpp create mode 100644 middleware/test/utests/fakes/FakeGStreamer.cpp create mode 100644 middleware/test/utests/fakes/FakeGstHandlerControl.cpp create mode 100644 middleware/test/utests/fakes/FakeGstPlayerTaskPool.cpp create mode 100644 middleware/test/utests/fakes/FakeGstUtils.cpp create mode 100644 middleware/test/utests/fakes/FakePacketSender.cpp create mode 100644 middleware/test/utests/fakes/FakePlayerJsonObject.cpp create mode 100644 middleware/test/utests/fakes/FakePlayerScheduler.cpp create mode 100644 middleware/test/utests/fakes/FakePlayerThunderInterface.cpp create mode 100644 middleware/test/utests/fakes/FakePlayerUtils.cpp create mode 100644 middleware/test/utests/fakes/FakeSocInterface.cpp create mode 100644 middleware/test/utests/fakes/FakeSocUtils.cpp create mode 100644 middleware/test/utests/fakes/FakeTextStyleAttributes.cpp create mode 100644 middleware/test/utests/fakes/Fakeopencdm.cpp create mode 100644 middleware/test/utests/fakes/Fakeopencdmsessionadapter.cpp create mode 100644 middleware/test/utests/mocks/MockDrmCallbacks.h create mode 100644 middleware/test/utests/mocks/MockDrmHelper.h create mode 100644 middleware/test/utests/mocks/MockDrmMemorySystem.h create mode 100644 middleware/test/utests/mocks/MockDrmSession.h create mode 100644 middleware/test/utests/mocks/MockGLib.h create mode 100644 middleware/test/utests/mocks/MockGStreamer.h create mode 100644 middleware/test/utests/mocks/MockGstHandlerControl.h create mode 100644 middleware/test/utests/mocks/MockHlsDrmSession.h create mode 100644 middleware/test/utests/mocks/MockOpenCdm.h create mode 100644 middleware/test/utests/mocks/MockOpenCdmSessionAdapter.h create mode 100644 middleware/test/utests/mocks/MockPacketSender.h create mode 100644 middleware/test/utests/mocks/MockPlayerConfig.h create mode 100644 middleware/test/utests/mocks/MockPlayerJsonObject.h create mode 100644 middleware/test/utests/mocks/MockPlayerScheduler.h create mode 100644 middleware/test/utests/mocks/MockPlayerUtils.h create mode 100755 middleware/test/utests/mocks/opencdmMocks.cpp create mode 100755 middleware/test/utests/mocks/opencdmMocks.h create mode 100644 middleware/test/utests/ocdm/open_cdm.h create mode 100644 middleware/test/utests/ocdm/open_cdm_adapter.h create mode 100755 middleware/test/utests/run.sh create mode 100755 middleware/test/utests/tests/Base64PLAYER/Base64PLAYERTests.cpp create mode 100644 middleware/test/utests/tests/Base64PLAYER/Base64Tests.cpp create mode 100644 middleware/test/utests/tests/Base64PLAYER/CMakeLists.txt create mode 100644 middleware/test/utests/tests/CMakeLists.txt create mode 100755 middleware/test/utests/tests/DrmAes/CMakeLists.txt create mode 100644 middleware/test/utests/tests/DrmAes/DrmTestsAes.cpp create mode 100644 middleware/test/utests/tests/DrmAes/DrmTestsRun.cpp create mode 100755 middleware/test/utests/tests/DrmOcdm/CMakeLists.txt create mode 100755 middleware/test/utests/tests/DrmOcdm/ClearKeyDrmSessionTests.cpp create mode 100755 middleware/test/utests/tests/DrmOcdm/DrmDataTests.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmHLSTests.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmHelperTests.cpp create mode 100755 middleware/test/utests/tests/DrmOcdm/DrmMemorySystemTests.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmSessionFactoryTests.cpp create mode 100755 middleware/test/utests/tests/DrmOcdm/DrmSessionManagerTests.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmSessionTests.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmTestsRun.cpp create mode 100644 middleware/test/utests/tests/DrmOcdm/DrmUtilsTests.cpp create mode 100755 middleware/test/utests/tests/DrmOcdm/PlayerHlsDrmSessionInterfaceTests.cpp create mode 100644 middleware/test/utests/tests/DrmSecureClient/CMakeLists.txt create mode 100644 middleware/test/utests/tests/DrmSecureClient/DrmSessionTests.cpp create mode 100644 middleware/test/utests/tests/DrmSecureClient/DrmTestsRun.cpp create mode 100755 middleware/test/utests/tests/DrmUrlTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/DrmUrlTests/DrmSessionTests.cpp create mode 100644 middleware/test/utests/tests/DrmUrlTests/DrmTestsRun.cpp create mode 100644 middleware/test/utests/tests/GstHandlerControlTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/GstHandlerControlTests/GstHandlerControlPlayerTests.cpp create mode 100644 middleware/test/utests/tests/GstHandlerControlTests/GstHandlerControlTests.cpp create mode 100644 middleware/test/utests/tests/GstPlayer/CMakeLists.txt create mode 100644 middleware/test/utests/tests/GstPlayer/FunctionalTests.cpp create mode 100644 middleware/test/utests/tests/GstPlayer/GstPlayerTests.cpp create mode 100644 middleware/test/utests/tests/GstPlayer/PauseOnPlaybackTests.cpp create mode 100644 middleware/test/utests/tests/GstUtilsTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/GstUtilsTests/GstUtilsPlayerTests.cpp create mode 100644 middleware/test/utests/tests/GstUtilsTests/GstUtilsTests.cpp create mode 100644 middleware/test/utests/tests/OCDMSessionAdapter/CMakeLists.txt create mode 100644 middleware/test/utests/tests/OCDMSessionAdapter/FunctionalTests.cpp create mode 100644 middleware/test/utests/tests/OCDMSessionAdapter/OCDMSessionAdapterTests.cpp create mode 100644 middleware/test/utests/tests/OCDMSessionAdapter/fakes/config.h create mode 100644 middleware/test/utests/tests/OcdmBasicSessionAdapterTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/OcdmBasicSessionAdapterTests/FunctionalTests.cpp create mode 100644 middleware/test/utests/tests/OcdmBasicSessionAdapterTests/OcdmBasicSessionAdapterTests.cpp create mode 100644 middleware/test/utests/tests/PluginsTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/PluginsTests/PlayerClearKeyDecryptorTests.cpp create mode 100644 middleware/test/utests/tests/PluginsTests/PlayerPlayReadyDecryptorTests.cpp create mode 100644 middleware/test/utests/tests/PluginsTests/PlayerVeriMatrixDecryptorTests.cpp create mode 100644 middleware/test/utests/tests/PluginsTests/PlayerWidevineDecryptorTests.cpp create mode 100644 middleware/test/utests/tests/PluginsTests/PluginsRun.cpp create mode 100644 middleware/test/utests/tests/SubtecTests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/SubtecTests/PlayerSubtecCCManagerTests.cpp create mode 100644 middleware/test/utests/tests/SubtecTests/PlayerSubtecTests.cpp create mode 100644 middleware/test/utests/tests/TextStyleAttributes/CMakeLists.txt create mode 100644 middleware/test/utests/tests/TextStyleAttributes/GetTextStyleAttributesTests.cpp create mode 100644 middleware/test/utests/tests/TextStyleAttributes/TextStyleAttributesTests.cpp create mode 100644 middleware/test/utests/tests/TtmlSubtecParser/CMakeLists.txt create mode 100644 middleware/test/utests/tests/TtmlSubtecParser/TtmlSubtecParserPlayer.cpp create mode 100755 middleware/test/utests/tests/TtmlSubtecParser/TtmlSubtecParserTests.cpp create mode 100644 middleware/test/utests/tests/base16Tests/CMakeLists.txt create mode 100644 middleware/test/utests/tests/base16Tests/base16Tests.cpp create mode 100644 middleware/test/utests/tests/base16Tests/base16playerTests.cpp create mode 100644 middleware/vendor/SocInterface.cpp create mode 100644 middleware/vendor/SocInterface.h create mode 100644 middleware/vendor/amlogic/AmlogicSocInterface.cpp create mode 100644 middleware/vendor/amlogic/AmlogicSocInterface.h create mode 100644 middleware/vendor/brcm/BrcmSocInterface.cpp create mode 100644 middleware/vendor/brcm/BrcmSocInterface.h create mode 100644 middleware/vendor/default/DefaultSocInterface.cpp create mode 100644 middleware/vendor/default/DefaultSocInterface.h create mode 100644 middleware/vendor/realtek/RealtekSocInterface.cpp create mode 100644 middleware/vendor/realtek/RealtekSocInterface.h diff --git a/CMakeLists.txt b/CMakeLists.txt index b04411945..c32d00763 100755 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -50,13 +50,14 @@ pkg_check_modules(LIBDASH REQUIRED libdash) pkg_check_modules(OPENSSL REQUIRED openssl) pkg_check_modules(LIBCJSON REQUIRED libcjson) pkg_check_modules(UUID REQUIRED uuid) - -pkg_check_modules(BASECONVERSION REQUIRED libbaseconversion) -pkg_check_modules(PLAYERLOGMANAGER REQUIRED libplayerlogmanager) -pkg_check_modules(PLAYERFBINTERFACE REQUIRED libplayerfbinterface) -pkg_check_modules(PLAYERGSTINTERFACE REQUIRED libplayergstinterface) -pkg_check_modules(SUBTEC REQUIRED libsubtec) - +set(CMAKE_TEST_MW ON) +if(CMAKE_TEST_MW) + pkg_check_modules(BASECONVERSION REQUIRED libbaseconversion) + pkg_check_modules(PLAYERLOGMANAGER REQUIRED libplayerlogmanager) + pkg_check_modules(PLAYERFBINTERFACE REQUIRED libplayerfbinterface) + pkg_check_modules(PLAYERGSTINTERFACE REQUIRED libplayergstinterface) + pkg_check_modules(SUBTEC REQUIRED libsubtec) +endif() if(APPLE) # libcurl < 8.5 exhibits memory leaks. On Ubuntu 22.04 can't update beyond 7.81.0-1ubuntu1.16 without building from source pkg_check_modules(CURL REQUIRED libcurl>=8.5) @@ -159,7 +160,7 @@ include_directories(${CMAKE_CURRENT_SOURCE_DIR}/tsb/api) # Locally built/installed dependencies are here include_directories(${CMAKE_CURRENT_SOURCE_DIR}/.libs/include) - +if(CMAKE_TEST_MW) set(LIBAAMP_DEPENDS ${OS_LD_FLAGS} ${UUID_LINK_LIBRARIES} @@ -180,15 +181,33 @@ set(LIBAAMP_DEPENDS ${SUBTEC_LINK_LIBRARIES} -ldl ) +else() +set(LIBAAMP_DEPENDS + ${OS_LD_FLAGS} + ${UUID_LINK_LIBRARIES} + ${LIBCJSON_LINK_LIBRARIES} + ${GSTREAMERBASE_LINK_LIBRARIES} + ${GSTREAMER_LINK_LIBRARIES} + ${CURL_LINK_LIBRARIES} + ${LIBDASH_LINK_LIBRARIES} + ${LIBXML2_LIBRARIES} + ${CMAKE_THREAD_LIBS_INIT} + ${OPENSSL_LIBRARIES} + ${GL_DEPENDS} + ${AAMP_CLI_LD_FLAGS} +-ldl) +endif() # TDB needs to bring back for UT. #include(test/mocks/mocks.cmake NO_POLICY_SCOPE) +if(CMAKE_TEST_MW) include_directories(${PLAYERFBINTERFACE_INCLUDE_DIRS}) include_directories(${BASECONVERSION_INCLUDE_DIRS}) include_directories(${PLAYERLOGMANAGER_INCLUDE_DIRS}) include_directories(${PLAYERGSTINTERFACE_INCLUDE_DIRS}) include_directories(${SUBTEC_INCLUDE_DIRS}) +endif() if (CMAKE_INBUILT_AAMP_DEPENDENCIES) message("Building aamp support libraries") @@ -407,7 +426,11 @@ endif() set(LIBAAMP_SOURCES "${LIBAAMP_SOURCES}" "${LIBAAMP_MOCK_SOURCES}") add_library(aamp SHARED ${LIBAAMP_SOURCES}) -target_link_libraries(aamp tsb ${LIBAAMP_DEPENDS} ${LIBAAMP_MOCK_DEPENDS}) +if(CMAKE_TEST_MW) + target_link_libraries(aamp tsb ${LIBAAMP_DEPENDS} ${LIBAAMP_MOCK_DEPENDS}) +else() + target_link_libraries(aamp tsb playergstinterface playerfbinterface ${LIBAAMP_DEPENDS} ${LIBAAMP_MOCK_DEPENDS}) +endif() set_target_properties(aamp PROPERTIES COMPILE_FLAGS "${LIBAAMP_DEFINES} ${OS_CXX_FLAGS}") set_target_properties(aamp PROPERTIES PUBLIC_HEADER "main_aamp.h") set_target_properties(aamp PROPERTIES PRIVATE_HEADER "priv_aamp.h") @@ -429,13 +452,17 @@ set(AAMP_CLI_SOURCES test/aampcli/AampcliPrintf.cpp ) add_executable(aamp-cli ${AAMP_CLI_SOURCES}) -target_link_libraries(aamp-cli aamp tsb -${PLAYERFBINTERFACE_LINK_LIBRARIES} -${BASECONVERSION_LINK_LIBRARIES} -${PLAYERLOGMANAGER_LINK_LIBRARIES} -${PLAYERGSTINTERFACE_LINK_LIBRARIES} -${SUBTEC_LINK_LIBRARIES} -${AAMP_CLI_LD_FLAGS} "-lreadline") +if(CMAKE_TEST_MW) + target_link_libraries(aamp-cli aamp tsb + ${PLAYERFBINTERFACE_LINK_LIBRARIES} + ${BASECONVERSION_LINK_LIBRARIES} + ${PLAYERLOGMANAGER_LINK_LIBRARIES} + ${PLAYERGSTINTERFACE_LINK_LIBRARIES} + ${SUBTEC_LINK_LIBRARIES} + ${AAMP_CLI_LD_FLAGS} "-lreadline") +else() + target_link_libraries(aamp-cli aamp tsb playergstinterface playerfbinterface ${AAMP_CLI_LD_FLAGS} "-lreadline") +endif() #aamp-cli is not an ideal standalone app. It uses private aamp instance for debugging purposes set_target_properties(aamp-cli PROPERTIES COMPILE_FLAGS "${LIBAAMP_DEFINES} ${OS_CXX_FLAGS}") diff --git a/middleware/.github/CODEOWNERS b/middleware/.github/CODEOWNERS new file mode 100644 index 000000000..29a6f601c --- /dev/null +++ b/middleware/.github/CODEOWNERS @@ -0,0 +1,5 @@ +# These owners will be the default owners for everything in +# the repo. Unless a later match takes precedence, +# @global-owner1 and @global-owner2 will be requested for +# review when someone opens a pull request. +* @rdkcentral/mw-player-int-maintainers diff --git a/middleware/.github/workflows/L1-tests.yml b/middleware/.github/workflows/L1-tests.yml new file mode 100644 index 000000000..cd1a22c8e --- /dev/null +++ b/middleware/.github/workflows/L1-tests.yml @@ -0,0 +1,51 @@ +name: L1 tests + +on: + pull_request: + branches: [develop, main] + paths: ['**/*.c', '**/*.cpp', '**/*.cc', '**/*.cxx', '**/*.h', '**/*.hpp', '**/*.sh'] + +jobs: + execute-unit-tests-on-pr: + name: Runs all unit tests + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v3 + + - name: native build + run: yes | ./install-middleware.sh -s subtec + + # Run L1 tests + - name: Run unit tests with coverage + working-directory: ./test/utests + run: ./run.sh -c + + # Publish test results + - name: Publish L1 test results + uses: dorny/test-reporter@v1 + with: + name: Unit Test Results + path: test/utests/build/ctest-results.xml + reporter: java-junit + + # Upload artifact (test/utests/build/ctest-results.xml) + - name: Upload test result file (test/utests) + uses: actions/upload-artifact@v4 + with: + name: ctest-results-middleware-utests-${{ github.run_id }} + path: test/utests/build/ctest-results.xml + + - name: Upload CombinedCoverage report + if: ${{ !env.ACT }} + uses: actions/upload-artifact@v4 + with: + name: CombinedCoverage-report + path: test/utests/build/CombinedCoverage/ + if-no-files-found: warn + + # Show failure + - name: Show failure details (if any) + # if: failure() + run: tail -n 50 test/utests/build/ctest-results.xml || true diff --git a/middleware/.github/workflows/cla.yml b/middleware/.github/workflows/cla.yml new file mode 100644 index 000000000..c58b1b0b1 --- /dev/null +++ b/middleware/.github/workflows/cla.yml @@ -0,0 +1,20 @@ +name: "CLA" + +permissions: + contents: read + pull-requests: write + actions: write + statuses: write + +on: + issue_comment: + types: [created] + pull_request_target: + types: [opened, closed, synchronize] + +jobs: + CLA-Lite: + name: "Signature" + uses: rdkcentral/cmf-actions/.github/workflows/cla.yml@v1 + secrets: + PERSONAL_ACCESS_TOKEN: ${{ secrets.CLA_ASSISTANT }} diff --git a/middleware/.github/workflows/fossid_integration_stateless_diffscan_target_repo.yml b/middleware/.github/workflows/fossid_integration_stateless_diffscan_target_repo.yml new file mode 100644 index 000000000..7b8c1cba1 --- /dev/null +++ b/middleware/.github/workflows/fossid_integration_stateless_diffscan_target_repo.yml @@ -0,0 +1,19 @@ +name: Fossid Stateless Diff Scan + +on: + pull_request: + types: [opened, synchronize, reopened] + +permissions: + contents: read + pull-requests: read + +jobs: + call-fossid-workflow: + if: ${{ ! github.event.pull_request.head.repo.fork }} + uses: rdkcentral/build_tools_workflows/.github/workflows/fossid_integration_stateless_diffscan.yml@1.0.0 + secrets: + FOSSID_CONTAINER_USERNAME: ${{ secrets.FOSSID_CONTAINER_USERNAME }} + FOSSID_CONTAINER_PASSWORD: ${{ secrets.FOSSID_CONTAINER_PASSWORD }} + FOSSID_HOST_USERNAME: ${{ secrets.FOSSID_HOST_USERNAME }} + FOSSID_HOST_TOKEN: ${{ secrets.FOSSID_HOST_TOKEN }} diff --git a/middleware/.github/workflows/native-full-build.yml b/middleware/.github/workflows/native-full-build.yml new file mode 100644 index 000000000..524034ed0 --- /dev/null +++ b/middleware/.github/workflows/native-full-build.yml @@ -0,0 +1,29 @@ +name: Build Component in Native Environment + +on: + pull_request: + branches: [ develop , main ] + paths: ['**/*.c', '**/*.cpp', '**/*.cc', '**/*.cxx', '**/*.h', '**/*.hpp', '**/*.sh'] + +jobs: + build-player-interface-on-pr: + name: Build player-interface component in github rdkcentral + runs-on: ubuntu-latest + container: + image: ghcr.io/rdkcentral/docker-rdk-ci:latest + + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: native build + run: | + apt-get update + apt-get install -y sudo + sudo apt-get install -y python3-pip + sudo apt remove -y meson || true + sudo pip3 install --upgrade meson + hash -r + yes | ./install-middleware.sh -s subtec + env: + GITHUB_TOKEN: ${{ secrets.RDKCM_RDKE }} diff --git a/middleware/.gitignore b/middleware/.gitignore new file mode 100644 index 000000000..0d0bd272a --- /dev/null +++ b/middleware/.gitignore @@ -0,0 +1,2 @@ +build/ +.libs/ diff --git a/middleware/CMakeLists.txt b/middleware/CMakeLists.txt new file mode 100644 index 000000000..6a3b059d2 --- /dev/null +++ b/middleware/CMakeLists.txt @@ -0,0 +1,413 @@ +# LibPlayerGstInterface CMakeLists.txt +# If not stated otherwise in this file or this component's license file the +# following copyright and licenses apply: +# +# Copyright 2025 RDK Management +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +cmake_minimum_required(VERSION 3.5) +project(Playergstinterface) +set(CMAKE_CXX_STANDARD 17) +find_package(OpenSSL REQUIRED) +option(DISABLE_SECURITY_TOKEN "Disable security token" OFF) + +if(DISABLE_SECURITY_TOKEN) + add_definitions(-DDISABLE_SECURITY_TOKEN) +endif() + +# Option for building pi-cli +option(BUILD_PICLI "Build the pi-cli test project" OFF) + +find_package(PkgConfig REQUIRED) +pkg_check_modules(GST REQUIRED gstreamer-plugins-base-1.0) +pkg_check_modules(GSTREAMER REQUIRED gstreamer-1.0) +pkg_check_modules(GSTREAMERBASE REQUIRED gstreamer-app-1.0) + +if(CMAKE_SYSTEM_NAME STREQUAL Linux) + include_directories(${GST_INCLUDE_DIRS} ${GSTREAMER_INCLUDE_DIRS} ${GSTREAMERBASE_INCLUDE_DIRS} ${GSTREAMERVIDEO_INCLUDE_DIRS} ${OPENSSL_INCLUDE_DIR}) +else() + include_directories(${GST_INCLUDE_DIRS} ${GSTREAMER_INCLUDE_DIRS} ${GSTREAMERBASE_INCLUDE_DIRS} ${GSTREAMERVIDEO_INCLUDE_DIRS}) +endif(CMAKE_SYSTEM_NAME STREQUAL Linux) + +#include_directories(${GST_INCLUDE_DIRS} ${GSTREAMER_INCLUDE_DIRS} ${GSTREAMERBASE_INCLUDE_DIRS} ${GSTREAMERVIDEO_INCLUDE_DIRS} ${OPENSSL_INCLUDE_DIR}) +include_directories(${CMAKE_CURRENT_SOURCE_DIR} subtitle playerisobmff isobmff + closedcaptions + closedcaptions/subtec + drm drm/helper + drm/ocdm) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/externals) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/externals/contentsecuritymanager) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/externals/rdk) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/baseConversion) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/playerLogManager) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/playerJsonObject) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/mp4demux) +include_directories(${CMAKE_CURRENT_SOURCE_DIR}/closedcaptions/rialto) + + +#set(LIBPLAYERGSTINTERFACE_DEPENDS ${OS_LD_FLAGS} ${UUID_LINK_LIBRARIES} ${LIBCJSON_LINK_LIBRARIES} ${GSTREAMERBASE_LINK_LIBRARIES} ${GSTREAMER_LINK_LIBRARIES} ${CURL_LINK_LIBRARIES} ${LIBDASH_LINK_LIBRARIES} ${LibXml2_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT} ${OPENSSL_LIBRARIES} ${OPENGL_LIBRARIES} ${GLEW_LIBRARIES} -ldl) + +#shoud be made part of PLAYERGSTINTERFACE cmakelists +add_subdirectory(baseConversion) +add_subdirectory(playerLogManager) +add_subdirectory(playerJsonObject) +add_subdirectory(externals) + +set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} closedcaptions/PlayerCCManager.cpp PlayerUtils.cpp) + +set(SUBTEC_CLASS_SOURCES playerisobmff/playerisobmffbox.cpp + playerisobmff/playerisobmffbuffer.cpp + subtec/subtecparser/WebVttSubtecParser.cpp + subtec/subtecparser/TtmlSubtecParser.cpp + subtec/subtecparser/TextStyleAttributes.cpp + subtec/subtecparser/WebvttSubtecDevInterface.cpp + playerJsonObject/PlayerJsonObject.cpp +) + +if(CMAKE_PLATFORM_UBUNTU) + message("CMAKE_PLATFORM_UBUNTU set") + link_directories(${CMAKE_LIBRARY_PATH}) +endif() + +if(CMAKE_SOC_PLATFORM_RPI) + message("CMAKE_SOC_PLATFORM_RPI set") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -DRPI=1") +endif() + +#update XCode scheme flags, harmless for non Darwin builds +set (CMAKE_CODE_GENERATE_SCHEME TRUE) +if (CMAKE_PLATFORM_UBUNTU OR CMAKE_SYSTEM_NAME STREQUAL Darwin) + if(CMAKE_SYSTEM_NAME STREQUAL Darwin) + set(OPENGL_LIBRARIES "-framework OpenGL -framework GLUT") + else() + pkg_check_modules(OPENGL REQUIRED gl) + set(OPENGL_LIBRARIES "${OPENGL_LIBRARIES} -lglut") + pkg_check_modules(GLEW REQUIRED glew) + endif(CMAKE_SYSTEM_NAME STREQUAL Darwin) +endif() + +# Mac OS X +if(CMAKE_SYSTEM_NAME STREQUAL Darwin) + execute_process ( + COMMAND bash -c "xcrun --show-sdk-path" OUTPUT_VARIABLE osxSdkPath OUTPUT_STRIP_TRAILING_WHITESPACE + ) + set(OS_CXX_FLAGS "${OS_CXX_FLAGS} -std=c++14 -g -x objective-c++ -Wno-inconsistent-missing-override -F${osxSdkPath}/System/Library/Frameworks") + set(OS_LD_FLAGS "${OS_LD_FLAGS} -F${osxSdkPath}/System/Library/Frameworks -framework Cocoa -L${osxSdkPath}/../MacOSX.sdk/usr/lib -L.libs/lib -L/usr/local/lib/") + set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -isysroot ${osxSdkPath}/../MacOSX.sdk -I/usr/local/include") + string(STRIP ${OS_LD_FLAGS} OS_LD_FLAGS) + link_directories(${OPENSSL_LIBRARY_DIRS}) + set(CMAKE_THREAD_LIBS_INIT "-lpthread") + set(CMAKE_HAVE_THREADS_LIBRARY 1) + pkg_check_modules(GLIB REQUIRED GLib-2.0) + include_directories(${GLIB_INCLUDE_DIRS}) + + # XCode build flags. Even when using CLANG, the GCC name is required to enable the check + set(CMAKE_XCODE_ATTRIBUTE_GCC_WARN_UNUSED_FUNCTION "YES") + set(CMAKE_XCODE_ATTRIBUTE_GCC_WARN_UNUSED_VARIABLE "YES") +else() + set(USE_MAC_FOR_RANDOM_GEN "-DUSE_MAC_FOR_RANDOM_GEN") +endif(CMAKE_SYSTEM_NAME STREQUAL Darwin) + +if(CMAKE_SYSTEM_NAME STREQUAL "Darwin") + set(GSTREAMER_LINK_LIBRARIES "") + set(GST_LIBRARIES "") + set(GSTREAMERBASE_LIBRARIES "") + set(GSTVIDEO_LIBRARIES "") + set(LIBPLAYERGSTINTERFACE_DEPENDS ${OS_LD_FLAGS} ${UUID_LINK_LIBRARIES} ${LIBCJSON_LINK_LIBRARIES} ${CURL_LINK_LIBRARIES} ${LIBDASH_LINK_LIBRARIES} ${OPENSSL_LIBRARIES}) +else() + set(LIBPLAYERGSTINTERFACE_DEPENDS ${OS_LD_FLAGS} ${UUID_LINK_LIBRARIES} ${LIBCJSON_LINK_LIBRARIES} ${GSTREAMERBASE_LINK_LIBRARIES} ${GSTREAMER_LINK_LIBRARIES} ${CURL_LINK_LIBRARIES} ${LIBDASH_LINK_LIBRARIES} ${LibXml2_LIBRARIES} ${CMAKE_THREAD_LIBS_INIT} ${OPENSSL_LIBRARIES} ${OPENGL_LIBRARIES} ${GLEW_LIBRARIES} -ldl) +endif() + + set(LIBPLAYERGSTINTERFACE_HEADERS + closedcaptions/CCTrackInfo.h + GstUtils.h + PlayerUtils.h + GstUtils.h + PlayerMetadata.hpp + closedcaptions/PlayerCCManager.h + PlayerScheduler.h + gstplayertaskpool.h + GstHandlerControl.h + InterfacePlayerRDK.h + drm/DrmUtils.h + drm/aes/Aes.h + drm/HlsDrmBase.h + drm/DrmSystems.h + drm/DrmUtils.h + drm/DrmCallbacks.h + drm/ocdm/opencdmsessionadapter.h + drm/DrmJsonObject.h + vendor/SocInterface.h + vendor/amlogic/AmlogicSocInterface.h + vendor/realtek/RealtekSocInterface.h + vendor/brcm/BrcmSocInterface.h + vendor/default/DefaultSocInterface.h + subtitle/vttCue.h + ProcessHandler.h + ) + + install(FILES closedcaptions/CCTrackInfo.h + PlayerScheduler.h + gstplayertaskpool.h + GstHandlerControl.h + InterfacePlayerRDK.h + SocUtils.h + drm/DrmUtils.h + GstUtils.h + PlayerMetadata.hpp + closedcaptions/PlayerCCManager.h + PlayerUtils.h + drm/ocdm/opencdmsessionadapter.h + drm/aes/Aes.h + drm/DrmMemorySystem.h drm/DrmSessionManager.h drm/DrmSystems.h + drm/DrmData.h drm/DrmInfo.h drm/DrmMediaFormat.h drm/DrmCallbacks.h + drm/DrmSession.h drm/ClearKeyDrmSession.h drm/DrmSessionFactory.h drm/ocdm/opencdmsessionadapter.h + drm/helper/DrmHelper.h + drm/HlsDrmBase.h + drm/DrmConstants.h + drm/PlayerHlsDrmSessionInterface.h + drm/PlayerHlsDrmSessionInterfaceBase.h + drm/helper/VanillaDrmHelper.h + drm/HlsOcdmBridgeInterface.h + drm/HlsDrmSessionManager.h + vendor/SocInterface.h + subtitle/subtitleParser.h + subtec/subtecparser/WebVttSubtecParser.hpp + subtec/subtecparser/TtmlSubtecParser.hpp + GstUtils.h + PlayerMetadata.hpp + subtec/subtecparser/WebvttSubtecDevInterface.hpp + subtec/subtecparser/TextStyleAttributes.h + subtec/libsubtec/SubtecPacket.hpp + playerisobmff/playerisobmffbuffer.h + playerisobmff/playerisobmffbox.h + DESTINATION include) + + set(SOURCES + InterfacePlayerRDK.cpp + SocUtils.cpp + GstUtils.cpp + GstHandlerControl.cpp + PlayerScheduler.cpp + gstplayertaskpool.cpp + PlayerUtils.cpp + vendor/SocInterface.cpp + vendor/default/DefaultSocInterface.cpp + drm/processProtectionHls.cpp + ProcessHandler.cpp + ) + +if(NOT (CMAKE_PLATFORM_UBUNTU OR CMAKE_SYSTEM_NAME STREQUAL "Darwin")) + list(APPEND SOURCES + vendor/amlogic/AmlogicSocInterface.cpp + vendor/realtek/RealtekSocInterface.cpp + vendor/brcm/BrcmSocInterface.cpp + ) +endif() + + set(LIBPLAYERGSTINTERFACE_DRM_SOURCES drm/PlayerHlsDrmSessionInterface.cpp + drm/DrmSessionManager.cpp + drm/DrmSession.cpp + drm/DrmSessionFactory.cpp + drm/helper/DrmHelper.cpp + drm/helper/DrmHelperFactory.cpp + drm/HlsOcdmBridgeInterface.cpp + drm/DrmUtils.cpp + drm/DrmSystems.h + drm/aes/Aes.cpp + drm/DrmJsonObject.cpp + ) + + if (CMAKE_PLATFORM_UBUNTU OR CMAKE_SYSTEM_NAME STREQUAL Darwin ) + # uncomment below to build additional drm support in simulator + # set(CMAKE_USE_OPENCDM_ADAPTER TRUE) + # set(CMAKE_USE_OPENCDM_ADAPTER_MOCKS TRUE) + # set(CMAKE_USE_THUNDER_OCDM_API_0_2 TRUE) + # set(CMAKE_USE_SECCLIENT TRUE) + # set(CMAKE_USE_SECCLIENT_MOCKS TRUE) + endif() + + set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} ${SOURCES} ${SUBTEC_CLASS_SOURCES}) + + include_directories(${GSTVIDEO_INCLUDE_DIRS}) + + if(CMAKE_USE_THUNDER_OCDM_API_0_2) + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DUSE_THUNDER_OCDM_API_0_2") + endif() + + if(CMAKE_USE_OPENCDM_ADAPTER) + message("Using OPEN CDM support enabled") + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DUSE_OPENCDM_ADAPTER") + + set(LIBPLAYERGSTINTERFACE_DRM_SOURCES "${LIBPLAYERGSTINTERFACE_DRM_SOURCES}" drm/HlsDrmSessionManager.cpp + drm/HlsOcdmBridge.cpp + drm/processProtectionHls.cpp + ) + + # DRM Helpers + if(CMAKE_USE_WIDEVINE) + set(LIBPLAYERGSTINTERFACE_HELP_SOURCES "${LIBPLAYERGSTINTERFACE_HELP_SOURCES}" drm/helper/WidevineDrmHelper.cpp) + endif() + + if(CMAKE_USE_CLEARKEY) + set(LIBPLAYERGSTINTERFACE_HELP_SOURCES "${LIBPLAYERGSTINTERFACE_HELP_SOURCES}" drm/helper/ClearKeyHelper.cpp) + endif() + + if(CMAKE_USE_PLAYREADY) + set(LIBPLAYERGSTINTERFACE_HELP_SOURCES "${LIBPLAYERGSTINTERFACE_HELP_SOURCES}" drm/helper/PlayReadyHelper.cpp) + endif() + + if(CMAKE_USE_VERIMATRIX) + message("CMAKE_USE_VERIMATRIX set") + set(LIBPLAYERGSTINTERFACE_HELP_SOURCES "${LIBPLAYERGSTINTERFACE_HELP_SOURCES}" drm/helper/VerimatrixHelper.cpp) + endif() + else() + message("No OpenCDM support enabled") + endif() + + if(CMAKE_USE_CLEARKEY) + set(LIBPLAYERGSTINTERFACE_DRM_SOURCES "${LIBPLAYERGSTINTERFACE_DRM_SOURCES}" drm/ClearKeyDrmSession.cpp) + set(LIBPLAYERGSTINTERFACE_HELP_SOURCES "${LIBPLAYERGSTINTERFACE_HELP_SOURCES}" drm/helper/ClearKeyHelper.cpp) + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DUSE_CLEARKEY") + endif() + + if(CMAKE_USE_OPENCDM_ADAPTER) + message("Using OPEN CDM ADAPTER") + # Include OpenCDM-related source files + set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} + drm/ocdm/opencdmsessionadapter.cpp + drm/ocdm/OcdmBasicSessionAdapter.cpp + drm/ocdm/OcdmGstSessionAdapter.cpp + ) + + # Add GStreamer video dependency + set(LIBPLAYERGSTINTERFACE_DEPENDS "${LIBPLAYERGSTINTERFACE_DEPENDS} -lgstvideo-1.0") + + if(CMAKE_USE_OPENCDM_ADAPTER_MOCKS) + # Add mock headers and sources if mock is enabled + set(LIBPLAYERGSTINTERFACE_HEADERS ${LIBPLAYERGSTINTERFACE_HEADERS} open_cdm.h open_cdm_adapter.h) + set(LIBPLAYERGSTINTERFACE_MOCK_SOURCES ${LIBPLAYERGSTINTERFACE_MOCK_SOURCES} test/mocks/opencdmMocks.cpp) + set(LIBPLAYERGSTINTERFACE_MOCK_DEPENDS -lgmock -lgtest) + else() + # Link with actual OpenCDM library + set(LIBPLAYERGSTINTERFACE_DEPENDS ${LIBPLAYERGSTINTERFACE_DEPENDS} "-locdm") + endif() + + # Find OpenCDM headers and include them + find_path(STAGING_INCDIR opencdm) + include_directories(${STAGING_INCDIR}/opencdm) + + # Find GStreamer headers and include them + find_path(STAGING_INCDIR gstreamer-1.0) + include_directories(${STAGING_INCDIR}/gstreamer-1.0) + endif() + set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} ${LIBPLAYERGSTINTERFACE_DRM_SOURCES} ${LIBPLAYERGSTINTERFACE_HELP_SOURCES} ) + + add_library(subtec SHARED subtec/libsubtec/PacketSender.cpp subtec/libsubtec/SubtecChannel.cpp) + set(SUBTEC_PUBLIC_HEADERS subtec/libsubtec/SubtecChannel.hpp subtec/libsubtec/SubtecAttribute.hpp) + set_target_properties(subtec PROPERTIES PUBLIC_HEADER "${SUBTEC_PUBLIC_HEADERS}") + set(SUBTEC_COMPILE_FLAGS "${CMAKE_CXX_FLAGS} -DSUBTEC_PACKET_DEBUG=1") + if(CMAKE_PLATFORM_UBUNTU) + message("CMAKE_PLATFORM_UBUNTU set") + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DUBUNTU=1 -DNO_NATIVE_AV=1") + set(SUBTEC_COMPILE_FLAGS "${SUBTEC_COMPILE_FLAGS} -DUBUNTU=1") + endif() + + set_target_properties(subtec PROPERTIES COMPILE_FLAGS "${SUBTEC_COMPILE_FLAGS}") + + target_include_directories(subtec PUBLIC + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/playerjsonobject + ${CMAKE_CURRENT_SOURCE_DIR}/subtec/subtecparser + ${CMAKE_CURRENT_SOURCE_DIR}/subtec/libsubtec + ${CMAKE_CURRENT_SOURCE_DIR}/subtitle) + + install (TARGETS subtec + DESTINATION lib + PUBLIC_HEADER DESTINATION include + ) + + if (CMAKE_GST_SUBTEC_ENABLED) + set(CMAKE_SUBTITLE_SUPPORT TRUE) + message("CMAKE_GST_SUBTEC_ENABLED set") + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DGST_SUBTEC_ENABLED") + endif() + + if (CMAKE_SUBTITLE_SUPPORT) + message("CMAKE_SUBTITLE_SUPPORT set") + set(LIBPLAYERGSTINTERFACE_DEFINES "${LIBPLAYERGSTINTERFACE_DEFINES} -DSUBTITLE_SUPPORTED") + find_path(STAGING_INCDIR closedcaption/ccDataReader.h) + include_directories(${STAGING_INCDIR}/closedcaption) + if (CMAKE_USE_CC_MANAGER_MOCKS) + set(LIBPLAYERGSTINTERFACE_MOCK_SOURCES ${LIBPLAYERGSTINTERFACE_MOCK_SOURCES} ${CMAKE_CURRENT_SOURCE_DIR}/../test/fakes/ccManagerFakes.cpp) + else() + set(LIBSUBTECCONNECTOR_DEPENDS pthread rdkCCReader subtec) + endif() + + set(LIBSUBTECCONNECTOR_SOURCES + closedcaptions/subtec/SubtecConnector.cpp + closedcaptions/subtec/CCDataController.cpp) + + add_library(subtec_connector SHARED ${LIBSUBTECCONNECTOR_SOURCES}) + target_link_libraries(subtec_connector ${LIBSUBTECCONNECTOR_DEPENDS}) + target_link_libraries(subtec_connector playerlogmanager) + install(TARGETS subtec_connector DESTINATION lib) + + set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} closedcaptions/subtec/PlayerSubtecCCManager.cpp closedcaptions/rialto/PlayerRialtoCCManager.cpp) + endif() + add_library(playergstinterface SHARED ${SOURCES} ${LIBPLAYERGSTINTERFACE_HEADERS} ${LIBPLAYERGSTINTERFACE_SOURCES} ${LIBPLAYERGSTINTERFACE_DRM_SOURCES} ${LIBPLAYERGSTINTERFACE_HELP_SOURCES}) + + target_include_directories(playergstinterface PUBLIC + ${CMAKE_CURRENT_SOURCE_DIR} + ${CMAKE_CURRENT_SOURCE_DIR}/externals + ${CMAKE_CURRENT_SOURCE_DIR}/subtec/subtecparser + ${CMAKE_CURRENT_SOURCE_DIR}/subtec/libsubtec + ${CMAKE_CURRENT_SOURCE_DIR}/subtitle + ${CMAKE_CURRENT_SOURCE_DIR}/playerisobmff + ${CMAKE_CURRENT_SOURCE_DIR}/playerjsonobject + ${CMAKE_CURRENT_SOURCE_DIR}/closedcaptions + ${CMAKE_CURRENT_SOURCE_DIR}/closedcaptions/subtec + ${CMAKE_CURRENT_SOURCE_DIR}/vendor) + + if (CMAKE_SUBTITLE_SUPPORT) + target_link_libraries(playergstinterface subtec_connector) + endif() + + string(STRIP "${LIBPLAYERGSTINTERFACE_DEPENDS}" LIBPLAYERGSTINTERFACE_DEPENDS) + message("Building middleware support libraries") + add_subdirectory(gst-plugins) + + target_link_libraries(playergstinterface ${LIBPLAYERGSTINTERFACE_DEPENDS}) + + target_link_libraries(playergstinterface ${GST_LIBRARIES} ${GSTREAMER_LIBRARIES} ${GSTREAMERBASE_LIBRARIES} ${GSTREAMERBASE_LINK_LIBRARIES}) + + target_link_libraries(playergstinterface ${GSTVIDEO_LIBRARIES} ${LIBPLAYERGSTINTERFACE_DEPENDS}) + + set_target_properties(playergstinterface PROPERTIES COMPILE_FLAGS "${LIBPLAYERGSTINTERFACE_DEFINES} ${OS_CXX_FLAGS}") + + install(TARGETS playergstinterface + LIBRARY DESTINATION lib + PUBLIC_HEADER DESTINATION lib/include + ) + target_link_libraries(subtec playerlogmanager) + target_link_libraries(playergstinterface ${GSTVIDEO_LIBRARIES} ${LIBPLAYERGSTINTERFACE_DEPENDS}) + target_link_libraries(playergstinterface subtec) + target_link_libraries(playergstinterface baseconversion) + target_link_libraries(playergstinterface playerfbinterface) + set(LIBPLAYERGSTINTERFACE_SOURCES ${LIBPLAYERGSTINTERFACE_SOURCES} {LIBPLAYERGSTINTERFACE_MOCK_SOURCES}) + + # Optionally build pi-cli for l2 + if(BUILD_PICLI) + add_subdirectory(test/pi-cli) + endif() diff --git a/middleware/CONTRIBUTING.md b/middleware/CONTRIBUTING.md new file mode 100644 index 000000000..e626c75e4 --- /dev/null +++ b/middleware/CONTRIBUTING.md @@ -0,0 +1,4 @@ +Contributing +============ + +If you would like to contribute code to this project you can do so through GitHub by forking the repository and sending a pull request. Before RDK accepts your code into the project you must sign the RDK Contributor License Agreement (CLA). diff --git a/middleware/COPYING b/middleware/COPYING new file mode 120000 index 000000000..7a694c969 --- /dev/null +++ b/middleware/COPYING @@ -0,0 +1 @@ +LICENSE \ No newline at end of file diff --git a/middleware/Doxyfile b/middleware/Doxyfile new file mode 100644 index 000000000..86c4870ba --- /dev/null +++ b/middleware/Doxyfile @@ -0,0 +1,2518 @@ +# Doxyfile 1.8.14 + +# 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 config 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 = "Advanced Adaptive Media Player" + +# 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 = RDK-Logo.png + +# 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 = NO + +# 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 + +# 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 = "The $name class" \ + "The $name widget" \ + "The $name file" \ + is \ + provides \ + specifies \ + contains \ + represents \ + a \ + an \ + the + +# 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 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 + +# 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 = 4 + +# 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. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. + +TCL_SUBST = + +# 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 + +# 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, +# C#, C, C++, D, PHP, Objective-C, Python, 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), VHDL. 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. + +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 http://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: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + +# 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 + +#--------------------------------------------------------------------------- +# 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 = YES + +# 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 = YES + +# 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 = YES + +# 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 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 +# (class|struct|union) 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 + +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. +# 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. +# 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. +# 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 = + +# 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. +# +# 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, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. + +FILE_PATTERNS = *.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 \ + *.py \ + *.pyw \ + *.f90 \ + *.f95 \ + *.f03 \ + *.f08 \ + *.f \ + *.for \ + *.tcl \ + *.vhd \ + *.vhdl \ + *.ucf \ + *.qsf + +# 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 = */html/* \ + */libdash-test/* \ + */latex/* \ + */receiver-integration/* \ + */test/* \ + */vs2010/* \ + */build/* + +# 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 = + +# 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 +# function 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 config 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 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 compilation database (see: +# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) used when the 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. +# 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: 0. + +CLANG_COMPILATION_DATABASE_PATH= 0 + +#--------------------------------------------------------------------------- +# 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 = YES + +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. + +COLS_IN_ALPHA_INDEX = 5 + +# 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 = .htm + +# 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 = + +# 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 = + +# 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 = + +# 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/tools/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/tools/creatingdocsetswithdoxygen.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: http://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 master .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: http://doc.qt.io/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: http://doc.qt.io/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: http://doc.qt.io/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: http://doc.qt.io/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: +# http://doc.qt.io/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 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 = NO + +# 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 + +# 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 + +# 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/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://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.2/. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.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/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 +# , /