From d1b916a7ab41fb6027e758a63bcd49594590ac3f Mon Sep 17 00:00:00 2001 From: Taner Sener Date: Wed, 5 Aug 2020 01:53:02 +0100 Subject: [PATCH] add ffmpeg implementation --- .gitignore | 3 + LICENSE.GPLv3 | 674 + LICENSE.LGPLv3 | 165 + README.md | 586 + android.sh | 227 +- android/.gitignore | 7 + android/app/Doxyfile | 2549 +++ android/app/build.gradle | 44 + android/app/proguard-rules.pro | 16 + android/app/src/main/AndroidManifest.xml | 2 + android/app/src/main/cpp/.gitignore | 2 + .../app/src/main/cpp/android_lts_support.c | 69 + android/app/src/main/cpp/ffmpegkit.c | 945 + android/app/src/main/cpp/ffmpegkit.h | 141 + .../app/src/main/cpp/ffmpegkit_abidetect.c | 144 + .../app/src/main/cpp/ffmpegkit_abidetect.h | 75 + .../app/src/main/cpp/ffmpegkit_exception.c | 24 + .../app/src/main/cpp/ffmpegkit_exception.h | 29 + android/app/src/main/cpp/ffprobekit.c | 96 + android/app/src/main/cpp/ffprobekit.h | 32 + android/app/src/main/cpp/fftools_cmdutils.c | 2403 +++ android/app/src/main/cpp/fftools_cmdutils.h | 636 + android/app/src/main/cpp/fftools_ffmpeg.c | 5582 ++++++ android/app/src/main/cpp/fftools_ffmpeg.h | 764 + .../app/src/main/cpp/fftools_ffmpeg_filter.c | 1228 ++ android/app/src/main/cpp/fftools_ffmpeg_hw.c | 491 + android/app/src/main/cpp/fftools_ffmpeg_opt.c | 3391 ++++ android/app/src/main/cpp/fftools_ffprobe.c | 3830 ++++ .../java/com/arthenica/ffmpegkit/Abi.java | 108 + .../com/arthenica/ffmpegkit/AbiDetect.java | 94 + .../ffmpegkit/AsyncFFmpegExecuteTask.java | 62 + .../ffmpegkit/AsyncFFprobeExecuteTask.java | 53 + .../AsyncGetMediaInformationTask.java | 48 + .../arthenica/ffmpegkit/CameraSupport.java | 75 + .../arthenica/ffmpegkit/ExecuteCallback.java | 37 + .../arthenica/ffmpegkit/FFmpegExecution.java | 50 + .../com/arthenica/ffmpegkit/FFmpegKit.java | 274 + .../arthenica/ffmpegkit/FFmpegKitConfig.java | 769 + .../com/arthenica/ffmpegkit/FFprobeKit.java | 130 + .../GetMediaInformationCallback.java | 30 + .../java/com/arthenica/ffmpegkit/Level.java | 132 + .../com/arthenica/ffmpegkit/LogCallback.java | 30 + .../com/arthenica/ffmpegkit/LogMessage.java | 66 + .../arthenica/ffmpegkit/MediaInformation.java | 208 + .../ffmpegkit/MediaInformationParser.java | 73 + .../com/arthenica/ffmpegkit/Packages.java | 273 + .../java/com/arthenica/ffmpegkit/Signal.java | 43 + .../com/arthenica/ffmpegkit/Statistics.java | 180 + .../ffmpegkit/StatisticsCallback.java | 30 + .../ffmpegkit/StreamInformation.java | 281 + .../ffmpegkit/FFmpegKitConfigTest.java | 186 + .../arthenica/ffmpegkit/FFmpegKitTest.java | 746 + android/build.gradle | 25 + android/gradle.properties | 19 + android/gradle/wrapper/gradle-wrapper.jar | Bin 0 -> 58695 bytes .../gradle/wrapper/gradle-wrapper.properties | 5 + android/gradlew | 183 + android/gradlew.bat | 103 + android/jni/.gitignore | 2 + android/jni/Android.mk | 104 + android/jni/cpu-features/Android.mk | 12 + android/jni/ffmpeg/Android.mk | 46 + android/jni/ffmpeg/neon/Android.mk | 61 + android/settings.gradle | 4 + docs/assets/ffmpeg-kit-icon-v4.png | Bin 0 -> 55928 bytes ios.sh | 439 +- macos.sh | 600 + objc/.gitignore | 10 + objc/Doxyfile | 2549 +++ objc/Makefile.am | 3 + objc/Makefile.in | 806 + objc/aclocal.m4 | 1238 ++ objc/ar-lib | 271 + objc/autogen.sh | 3 + objc/compile | 348 + objc/config.guess | 1667 ++ objc/config.sub | 1793 ++ objc/configure | 16076 ++++++++++++++++ objc/configure.ac | 64 + objc/depcomp | 791 + objc/install-sh | 529 + objc/libtool | 11642 +++++++++++ objc/ltmain.sh | 11147 +++++++++++ objc/m4/libtool.m4 | 8364 ++++++++ objc/m4/ltoptions.m4 | 437 + objc/m4/ltsugar.m4 | 124 + objc/m4/ltversion.m4 | 23 + objc/m4/lt~obsolete.m4 | 99 + objc/missing | 215 + objc/src/.gitignore | 6 + objc/src/ArchDetect.h | 51 + objc/src/ArchDetect.m | 184 + objc/src/AtomicLong.h | 31 + objc/src/AtomicLong.m | 47 + objc/src/ExecuteDelegate.h | 26 + objc/src/FFmpegExecution.h | 35 + objc/src/FFmpegExecution.m | 52 + objc/src/FFmpegKit.h | 137 + objc/src/FFmpegKit.m | 310 + objc/src/FFmpegKitConfig.h | 266 + objc/src/FFmpegKitConfig.m | 1029 + objc/src/FFprobeKit.h | 87 + objc/src/FFprobeKit.m | 147 + objc/src/LogDelegate.h | 26 + objc/src/Makefile.am | 49 + objc/src/Makefile.in | 975 + objc/src/MediaInformation.h | 128 + objc/src/MediaInformation.m | 127 + objc/src/MediaInformationParser.h | 35 + objc/src/MediaInformationParser.m | 53 + objc/src/Statistics.h | 49 + objc/src/Statistics.m | 124 + objc/src/StatisticsDelegate.h | 28 + objc/src/StreamInformation.h | 183 + objc/src/StreamInformation.m | 162 + objc/src/ffmpegkit_exception.h | 29 + objc/src/ffmpegkit_exception.m | 23 + objc/src/fftools_cmdutils.c | 2403 +++ objc/src/fftools_cmdutils.h | 636 + objc/src/fftools_ffmpeg.c | 5582 ++++++ objc/src/fftools_ffmpeg.h | 764 + objc/src/fftools_ffmpeg_filter.c | 1228 ++ objc/src/fftools_ffmpeg_hw.c | 491 + objc/src/fftools_ffmpeg_opt.c | 3391 ++++ objc/src/fftools_ffmpeg_videotoolbox.c | 169 + objc/src/fftools_ffprobe.c | 3830 ++++ scripts/android/chromaprint.sh | 69 + scripts/android/cpu-features.sh | 14 + scripts/android/expat.sh | 61 + scripts/android/ffmpeg.sh | 464 + scripts/android/fontconfig.sh | 65 + scripts/android/freetype.sh | 68 + scripts/android/fribidi.sh | 62 + scripts/android/giflib.sh | 60 + scripts/android/gmp.sh | 61 + scripts/android/gnutls.sh | 93 + scripts/android/jpeg.sh | 74 + scripts/android/kvazaar.sh | 68 + scripts/android/lame.sh | 65 + scripts/android/leptonica.sh | 82 + scripts/android/libaom.sh | 94 + scripts/android/libass.sh | 79 + scripts/android/libiconv.sh | 60 + scripts/android/libilbc.sh | 59 + scripts/android/libogg.sh | 59 + scripts/android/libpng.sh | 78 + scripts/android/libsamplerate.sh | 64 + scripts/android/libsndfile.sh | 63 + scripts/android/libtheora.sh | 72 + scripts/android/libuuid.sh | 59 + scripts/android/libvidstab.sh | 80 + scripts/android/libvorbis.sh | 65 + scripts/android/libvpx.sh | 115 + scripts/android/libwebp.sh | 83 + scripts/android/libxml2.sh | 70 + scripts/android/nettle.sh | 75 + scripts/android/opencore-amr.sh | 60 + scripts/android/openh264.sh | 81 + scripts/android/opus.sh | 66 + scripts/android/rubberband.sh | 67 + scripts/android/sdl.sh | 61 + scripts/android/shine.sh | 59 + scripts/android/snappy.sh | 72 + scripts/android/soxr.sh | 74 + scripts/android/speex.sh | 66 + scripts/android/tesseract.sh | 72 + scripts/android/tiff.sh | 65 + scripts/android/twolame.sh | 63 + scripts/android/vo-amrwbenc.sh | 68 + scripts/android/wavpack.sh | 62 + scripts/android/x264.sh | 81 + scripts/android/x265.sh | 99 + scripts/android/xvidcore.sh | 68 + scripts/common-android.sh | 864 - scripts/common-ios.sh | 821 - scripts/common-tvos.sh | 781 - scripts/function-android.sh | 950 + scripts/function-ios.sh | 1057 + scripts/function-macos.sh | 892 + scripts/function-tvos.sh | 867 + scripts/{common-arch.sh => function.sh} | 817 +- scripts/main-android.sh | 397 +- scripts/main-ios.sh | 374 +- scripts/main-macos.sh | 206 + scripts/main-tvos.sh | 373 +- scripts/objc/chromaprint.sh | 73 + scripts/objc/expat.sh | 65 + scripts/objc/ffmpeg-kit.sh | 75 + scripts/objc/ffmpeg.sh | 531 + scripts/objc/fontconfig.sh | 74 + scripts/objc/freetype.sh | 72 + scripts/objc/fribidi.sh | 66 + scripts/objc/giflib.sh | 64 + scripts/objc/gmp.sh | 80 + scripts/objc/gnutls.sh | 106 + scripts/objc/jpeg.sh | 94 + scripts/objc/kvazaar.sh | 75 + scripts/objc/lame.sh | 69 + scripts/objc/leptonica.sh | 86 + scripts/objc/libaom.sh | 122 + scripts/objc/libass.sh | 80 + scripts/objc/libilbc.sh | 63 + scripts/objc/libogg.sh | 66 + scripts/objc/libpng.sh | 77 + scripts/objc/libsamplerate.sh | 68 + scripts/objc/libsndfile.sh | 67 + scripts/objc/libtheora.sh | 69 + scripts/objc/libuuid.sh | 63 + scripts/objc/libvidstab.sh | 83 + scripts/objc/libvorbis.sh | 73 + scripts/objc/libvpx.sh | 140 + scripts/objc/libwebp.sh | 87 + scripts/objc/libxml2.sh | 68 + scripts/objc/nettle.sh | 79 + scripts/objc/opencore-amr.sh | 74 + scripts/objc/openh264.sh | 85 + scripts/objc/opus.sh | 70 + scripts/objc/rubberband.sh | 71 + scripts/objc/sdl.sh | 80 + scripts/objc/shine.sh | 63 + scripts/objc/snappy.sh | 76 + scripts/objc/soxr.sh | 75 + scripts/objc/speex.sh | 71 + scripts/objc/tesseract.sh | 74 + scripts/objc/tiff.sh | 69 + scripts/objc/twolame.sh | 67 + scripts/objc/vo-amrwbenc.sh | 74 + scripts/objc/wavpack.sh | 77 + scripts/objc/x264.sh | 81 + scripts/objc/x265.sh | 126 + scripts/objc/xvidcore.sh | 81 + scripts/source.sh | 32 + scripts/variable.sh | 92 + src/.gitignore | 2 + tools/clean.sh | 12 + tools/release/android/build.gradle | 44 + tools/release/android/build.lts.gradle | 44 + tools/release/android/release.template.gradle | 178 + tvos.sh | 256 +- 239 files changed, 123531 insertions(+), 4070 deletions(-) create mode 100644 LICENSE.GPLv3 create mode 100644 LICENSE.LGPLv3 create mode 100644 README.md create mode 100644 android/.gitignore create mode 100644 android/app/Doxyfile create mode 100644 android/app/build.gradle create mode 100644 android/app/proguard-rules.pro create mode 100644 android/app/src/main/AndroidManifest.xml create mode 100644 android/app/src/main/cpp/.gitignore create mode 100644 android/app/src/main/cpp/android_lts_support.c create mode 100644 android/app/src/main/cpp/ffmpegkit.c create mode 100644 android/app/src/main/cpp/ffmpegkit.h create mode 100644 android/app/src/main/cpp/ffmpegkit_abidetect.c create mode 100644 android/app/src/main/cpp/ffmpegkit_abidetect.h create mode 100644 android/app/src/main/cpp/ffmpegkit_exception.c create mode 100644 android/app/src/main/cpp/ffmpegkit_exception.h create mode 100644 android/app/src/main/cpp/ffprobekit.c create mode 100644 android/app/src/main/cpp/ffprobekit.h create mode 100644 android/app/src/main/cpp/fftools_cmdutils.c create mode 100644 android/app/src/main/cpp/fftools_cmdutils.h create mode 100644 android/app/src/main/cpp/fftools_ffmpeg.c create mode 100644 android/app/src/main/cpp/fftools_ffmpeg.h create mode 100644 android/app/src/main/cpp/fftools_ffmpeg_filter.c create mode 100644 android/app/src/main/cpp/fftools_ffmpeg_hw.c create mode 100644 android/app/src/main/cpp/fftools_ffmpeg_opt.c create mode 100644 android/app/src/main/cpp/fftools_ffprobe.c create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/Abi.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/AbiDetect.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/AsyncFFmpegExecuteTask.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/AsyncFFprobeExecuteTask.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/AsyncGetMediaInformationTask.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/CameraSupport.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/ExecuteCallback.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/FFmpegExecution.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/FFmpegKit.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/FFmpegKitConfig.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/FFprobeKit.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/GetMediaInformationCallback.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/Level.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/LogCallback.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/LogMessage.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/MediaInformation.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/MediaInformationParser.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/Packages.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/Signal.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/Statistics.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/StatisticsCallback.java create mode 100644 android/app/src/main/java/com/arthenica/ffmpegkit/StreamInformation.java create mode 100644 android/app/src/test/java/com/arthenica/ffmpegkit/FFmpegKitConfigTest.java create mode 100644 android/app/src/test/java/com/arthenica/ffmpegkit/FFmpegKitTest.java create mode 100644 android/build.gradle create mode 100644 android/gradle.properties create mode 100644 android/gradle/wrapper/gradle-wrapper.jar create mode 100644 android/gradle/wrapper/gradle-wrapper.properties create mode 100755 android/gradlew create mode 100755 android/gradlew.bat create mode 100644 android/jni/.gitignore create mode 100644 android/jni/Android.mk create mode 100644 android/jni/cpu-features/Android.mk create mode 100644 android/jni/ffmpeg/Android.mk create mode 100644 android/jni/ffmpeg/neon/Android.mk create mode 100644 android/settings.gradle create mode 100644 docs/assets/ffmpeg-kit-icon-v4.png create mode 100755 macos.sh create mode 100644 objc/.gitignore create mode 100644 objc/Doxyfile create mode 100644 objc/Makefile.am create mode 100644 objc/Makefile.in create mode 100644 objc/aclocal.m4 create mode 100755 objc/ar-lib create mode 100755 objc/autogen.sh create mode 100755 objc/compile create mode 100755 objc/config.guess create mode 100755 objc/config.sub create mode 100755 objc/configure create mode 100644 objc/configure.ac create mode 100755 objc/depcomp create mode 100755 objc/install-sh create mode 100755 objc/libtool create mode 100644 objc/ltmain.sh create mode 100644 objc/m4/libtool.m4 create mode 100644 objc/m4/ltoptions.m4 create mode 100644 objc/m4/ltsugar.m4 create mode 100644 objc/m4/ltversion.m4 create mode 100644 objc/m4/lt~obsolete.m4 create mode 100755 objc/missing create mode 100644 objc/src/.gitignore create mode 100644 objc/src/ArchDetect.h create mode 100644 objc/src/ArchDetect.m create mode 100644 objc/src/AtomicLong.h create mode 100644 objc/src/AtomicLong.m create mode 100644 objc/src/ExecuteDelegate.h create mode 100644 objc/src/FFmpegExecution.h create mode 100644 objc/src/FFmpegExecution.m create mode 100644 objc/src/FFmpegKit.h create mode 100644 objc/src/FFmpegKit.m create mode 100644 objc/src/FFmpegKitConfig.h create mode 100644 objc/src/FFmpegKitConfig.m create mode 100644 objc/src/FFprobeKit.h create mode 100644 objc/src/FFprobeKit.m create mode 100644 objc/src/LogDelegate.h create mode 100644 objc/src/Makefile.am create mode 100644 objc/src/Makefile.in create mode 100644 objc/src/MediaInformation.h create mode 100644 objc/src/MediaInformation.m create mode 100644 objc/src/MediaInformationParser.h create mode 100644 objc/src/MediaInformationParser.m create mode 100644 objc/src/Statistics.h create mode 100644 objc/src/Statistics.m create mode 100644 objc/src/StatisticsDelegate.h create mode 100644 objc/src/StreamInformation.h create mode 100644 objc/src/StreamInformation.m create mode 100644 objc/src/ffmpegkit_exception.h create mode 100644 objc/src/ffmpegkit_exception.m create mode 100644 objc/src/fftools_cmdutils.c create mode 100644 objc/src/fftools_cmdutils.h create mode 100644 objc/src/fftools_ffmpeg.c create mode 100644 objc/src/fftools_ffmpeg.h create mode 100644 objc/src/fftools_ffmpeg_filter.c create mode 100644 objc/src/fftools_ffmpeg_hw.c create mode 100644 objc/src/fftools_ffmpeg_opt.c create mode 100644 objc/src/fftools_ffmpeg_videotoolbox.c create mode 100644 objc/src/fftools_ffprobe.c create mode 100755 scripts/android/chromaprint.sh create mode 100755 scripts/android/cpu-features.sh create mode 100755 scripts/android/expat.sh create mode 100755 scripts/android/ffmpeg.sh create mode 100755 scripts/android/fontconfig.sh create mode 100755 scripts/android/freetype.sh create mode 100755 scripts/android/fribidi.sh create mode 100755 scripts/android/giflib.sh create mode 100755 scripts/android/gmp.sh create mode 100755 scripts/android/gnutls.sh create mode 100755 scripts/android/jpeg.sh create mode 100755 scripts/android/kvazaar.sh create mode 100755 scripts/android/lame.sh create mode 100755 scripts/android/leptonica.sh create mode 100755 scripts/android/libaom.sh create mode 100755 scripts/android/libass.sh create mode 100755 scripts/android/libiconv.sh create mode 100755 scripts/android/libilbc.sh create mode 100755 scripts/android/libogg.sh create mode 100755 scripts/android/libpng.sh create mode 100755 scripts/android/libsamplerate.sh create mode 100755 scripts/android/libsndfile.sh create mode 100755 scripts/android/libtheora.sh create mode 100755 scripts/android/libuuid.sh create mode 100755 scripts/android/libvidstab.sh create mode 100755 scripts/android/libvorbis.sh create mode 100755 scripts/android/libvpx.sh create mode 100755 scripts/android/libwebp.sh create mode 100755 scripts/android/libxml2.sh create mode 100755 scripts/android/nettle.sh create mode 100755 scripts/android/opencore-amr.sh create mode 100755 scripts/android/openh264.sh create mode 100755 scripts/android/opus.sh create mode 100755 scripts/android/rubberband.sh create mode 100755 scripts/android/sdl.sh create mode 100755 scripts/android/shine.sh create mode 100755 scripts/android/snappy.sh create mode 100755 scripts/android/soxr.sh create mode 100755 scripts/android/speex.sh create mode 100755 scripts/android/tesseract.sh create mode 100755 scripts/android/tiff.sh create mode 100755 scripts/android/twolame.sh create mode 100755 scripts/android/vo-amrwbenc.sh create mode 100755 scripts/android/wavpack.sh create mode 100755 scripts/android/x264.sh create mode 100755 scripts/android/x265.sh create mode 100755 scripts/android/xvidcore.sh delete mode 100755 scripts/common-android.sh delete mode 100755 scripts/common-ios.sh delete mode 100755 scripts/common-tvos.sh create mode 100755 scripts/function-android.sh create mode 100755 scripts/function-ios.sh create mode 100755 scripts/function-macos.sh create mode 100755 scripts/function-tvos.sh rename scripts/{common-arch.sh => function.sh} (60%) create mode 100755 scripts/main-macos.sh create mode 100755 scripts/objc/chromaprint.sh create mode 100755 scripts/objc/expat.sh create mode 100755 scripts/objc/ffmpeg-kit.sh create mode 100755 scripts/objc/ffmpeg.sh create mode 100755 scripts/objc/fontconfig.sh create mode 100755 scripts/objc/freetype.sh create mode 100755 scripts/objc/fribidi.sh create mode 100755 scripts/objc/giflib.sh create mode 100755 scripts/objc/gmp.sh create mode 100755 scripts/objc/gnutls.sh create mode 100755 scripts/objc/jpeg.sh create mode 100755 scripts/objc/kvazaar.sh create mode 100755 scripts/objc/lame.sh create mode 100755 scripts/objc/leptonica.sh create mode 100755 scripts/objc/libaom.sh create mode 100755 scripts/objc/libass.sh create mode 100755 scripts/objc/libilbc.sh create mode 100755 scripts/objc/libogg.sh create mode 100755 scripts/objc/libpng.sh create mode 100755 scripts/objc/libsamplerate.sh create mode 100755 scripts/objc/libsndfile.sh create mode 100755 scripts/objc/libtheora.sh create mode 100755 scripts/objc/libuuid.sh create mode 100755 scripts/objc/libvidstab.sh create mode 100755 scripts/objc/libvorbis.sh create mode 100755 scripts/objc/libvpx.sh create mode 100755 scripts/objc/libwebp.sh create mode 100755 scripts/objc/libxml2.sh create mode 100755 scripts/objc/nettle.sh create mode 100755 scripts/objc/opencore-amr.sh create mode 100755 scripts/objc/openh264.sh create mode 100755 scripts/objc/opus.sh create mode 100755 scripts/objc/rubberband.sh create mode 100755 scripts/objc/sdl.sh create mode 100755 scripts/objc/shine.sh create mode 100755 scripts/objc/snappy.sh create mode 100755 scripts/objc/soxr.sh create mode 100755 scripts/objc/speex.sh create mode 100755 scripts/objc/tesseract.sh create mode 100755 scripts/objc/tiff.sh create mode 100755 scripts/objc/twolame.sh create mode 100755 scripts/objc/vo-amrwbenc.sh create mode 100755 scripts/objc/wavpack.sh create mode 100755 scripts/objc/x264.sh create mode 100755 scripts/objc/x265.sh create mode 100755 scripts/objc/xvidcore.sh create mode 100644 scripts/source.sh create mode 100644 scripts/variable.sh create mode 100644 src/.gitignore create mode 100755 tools/clean.sh create mode 100644 tools/release/android/build.gradle create mode 100644 tools/release/android/build.lts.gradle create mode 100644 tools/release/android/release.template.gradle diff --git a/.gitignore b/.gitignore index 50e1322..1503308 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ +/.tmp/ /*.log +/prebuilt/ +.DS_Store diff --git a/LICENSE.GPLv3 b/LICENSE.GPLv3 new file mode 100644 index 0000000..94a9ed0 --- /dev/null +++ b/LICENSE.GPLv3 @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. diff --git a/LICENSE.LGPLv3 b/LICENSE.LGPLv3 new file mode 100644 index 0000000..65c5ca8 --- /dev/null +++ b/LICENSE.LGPLv3 @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/README.md b/README.md new file mode 100644 index 0000000..96ab096 --- /dev/null +++ b/README.md @@ -0,0 +1,586 @@ +# FFmpegKit ![GitHub release](https://img.shields.io/badge/release-v4.4-blue.svg) ![Bintray](https://img.shields.io/badge/bintray-v4.4-blue.svg) ![CocoaPods](https://img.shields.io/badge/pod-v4.4-blue.svg) [![Build Status](https://travis-ci.org/tanersener/ffmpeg-kit.svg?branch=master)](https://travis-ci.org/tanersener/ffmpeg-kit) + +FFmpeg kit for applications. Supports Android, iOS, tvOS. + + + +### 1. Features +- Includes both `FFmpeg` and `FFprobe` +- Use binaries available at `Github`/`JCenter`/`CocoaPods` or build your own version with external libraries you need +- Supports + - Android, iOS and tvOS + - FFmpeg `v4.4-dev` releases + - 29 external libraries + + `chromaprint`, `fontconfig`, `freetype`, `fribidi`, `gmp`, `gnutls`, `kvazaar`, `lame`, `libaom`, `libass`, `libiconv`, `libilbc`, `libtheora`, `libvorbis`, `libvpx`, `libwebp`, `libxml2`, `opencore-amr`, `openh264`, `opus`, `sdl`, `shine`, `snappy`, `soxr`, `speex`, `tesseract`, `twolame`, `vo-amrwbenc`, `wavpack` + + - 5 external libraries with GPL license + + `rubberband`, `vid.stab`, `x264`, `x265`, `xvidcore` + + - Concurrent execution + +- Exposes both FFmpeg library and FFmpegKit wrapper library capabilities +- Includes cross-compile instructions for 47 open-source libraries + + `chromaprint`, `expat`, `ffmpeg`, `fontconfig`, `freetype`, `fribidi`, `giflib`, `gmp`, `gnutls`, `kvazaar`, `lame`, `leptonica`, `libaom`, `libass`, `libiconv`, `libilbc`, `libjpeg`, `libjpeg-turbo`, `libogg`, `libpng`, `libsamplerate`, `libsndfile`, `libtheora`, `libuuid`, `libvorbis`, `libvpx`, `libwebp`, `libxml2`, `nettle`, `opencore-amr`, `openh264`, `opus`, `rubberband`, `sdl`, `shine`, `snappy`, `soxr`, `speex`, `tesseract`, `tiff`, `twolame`, `vid.stab`, `vo-amrwbenc`, `wavpack`, `x264`, `x265`, `xvidcore` + +- Licensed under LGPL 3.0, can be customized to support GPL v3.0 + +#### 1.1 Android +- Builds `arm-v7a`, `arm-v7a-neon`, `arm64-v8a`, `x86` and `x86_64` architectures +- Supports `zlib` and `MediaCodec` system libraries +- Camera access on [supported devices](https://developer.android.com/ndk/guides/stable_apis#camera) +- Builds shared native libraries (.so) +- Creates Android archives with .aar extension +- Supports `API Level 16+` + +#### 1.2 iOS +- Builds `armv7`, `armv7s`, `arm64`, `arm64e`, `i386`, `x86_64` and `x86_64` (Mac Catalyst) architectures +- Supports `bzip2`, `iconv`, `libuuid`, `zlib` system libraries and `AudioToolbox`, `VideoToolbox`, `AVFoundation` system frameworks +- Objective-C API +- Camera access +- `ARC` enabled library +- Built with `-fembed-bitcode` flag +- Creates static frameworks, static xcframeworks and static universal (fat) libraries (.a) +- Supports `iOS SDK 9.3` or later + +#### 1.3 tvOS +- Builds `arm64` and `x86_64` architectures +- Supports `bzip2`, `iconv`, `libuuid`, `zlib` system libraries and `AudioToolbox`, `VideoToolbox` system frameworks +- Objective-C API +- `ARC` enabled library +- Built with `-fembed-bitcode` flag +- Creates static frameworks and static universal (fat) libraries (.a) +- Supports `tvOS SDK 9.2` or later + +### 2. Using + +Prebuilt binaries are available at [Github](https://github.com/tanersener/ffmpeg-kit/releases), [JCenter](https://bintray.com/bintray/jcenter) and [CocoaPods](https://cocoapods.org). + +#### 2.1 Packages + +There are eight different `ffmpeg-kit` packages. Below you can see which system libraries and external libraries are enabled in each of package. + +Please remember that some parts of `FFmpeg` are licensed under the `GPL` and only `GPL` licensed `ffmpeg-kit` packages include them. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
minmin-gplhttpshttps-gplaudiovideofullfull-gpl
external libraries-vid.stab
x264
x265
xvidcore
gmp
gnutls
gmp
gnutls
vid.stab
x264
x265
xvidcore
lame
libilbc
libvorbis
opencore-amr
opus
shine
soxr
speex
twolame
vo-amrwbenc
wavpack
fontconfig
freetype
fribidi
kvazaar
libaom
libass
libiconv
libtheora
libvpx
libwebp
snappy
fontconfig
freetype
fribidi
gmp
gnutls
kvazaar
lame
libaom
libass
libiconv
libilbc
libtheora
libvorbis
libvpx
libwebp
libxml2
opencore-amr
opus
shine
snappy
soxr
speex
twolame
vo-amrwbenc
wavpack
fontconfig
freetype
fribidi
gmp
gnutls
kvazaar
lame
libaom
libass
libiconv
libilbc
libtheora
libvorbis
libvpx
libwebp
libxml2
opencore-amr
opus
shine
snappy
soxr
speex
twolame
vid.stab
vo-amrwbenc
wavpack
x264
x265
xvidcore
android system librarieszlib
MediaCodec
ios system librarieszlib
AudioToolbox
AVFoundation
iconv
VideoToolbox
bzip2
tvos system librarieszlib
AudioToolbox
iconv
VideoToolbox
bzip2
+ + - `AVFoundation` is not available on `tvOS`, `VideoToolbox` is not available on `tvOS` LTS releases + +#### 2.2 Android +1. Add FFmpegKit dependency to your `build.gradle` in `ffmpeg-kit-` pattern. + ``` + dependencies { + implementation 'com.arthenica:ffmpeg-kit-full:4.4' + } + ``` + +2. Execute synchronous FFmpeg commands. + ``` + import com.arthenica.ffmpegkit.Config; + import com.arthenica.ffmpegkit.FFmpeg; + + int rc = FFmpeg.execute("-i file1.mp4 -c:v mpeg4 file2.mp4"); + + if (rc == RETURN_CODE_SUCCESS) { + Log.i(Config.TAG, "Command execution completed successfully."); + } else if (rc == RETURN_CODE_CANCEL) { + Log.i(Config.TAG, "Command execution cancelled by user."); + } else { + Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); + Config.printLastCommandOutput(Log.INFO); + } + ``` + +3. Execute asynchronous FFmpeg commands. + ``` + import com.arthenica.ffmpegkit.Config; + import com.arthenica.ffmpegkit.FFmpeg; + + long executionId = FFmpeg.executeAsync("-i file1.mp4 -c:v mpeg4 file2.mp4", new ExecuteCallback() { + + @Override + public void apply(final long executionId, final int returnCode) { + if (rc == RETURN_CODE_SUCCESS) { + Log.i(Config.TAG, "Async command execution completed successfully."); + } else if (rc == RETURN_CODE_CANCEL) { + Log.i(Config.TAG, "Async command execution cancelled by user."); + } else { + Log.i(Config.TAG, String.format("Async command execution failed with rc=%d.", rc)); + } + } + }); + ``` + +4. Execute FFprobe commands. + ``` + import com.arthenica.ffmpegkit.Config; + import com.arthenica.ffmpegkit.FFprobe; + + int rc = FFprobe.execute("-i file1.mp4"); + + if (rc == RETURN_CODE_SUCCESS) { + Log.i(Config.TAG, "Command execution completed successfully."); + } else { + Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); + Config.printLastCommandOutput(Log.INFO); + } + ``` + +5. Check execution output later. + ``` + int rc = Config.getLastReturnCode(); + + if (rc == RETURN_CODE_SUCCESS) { + Log.i(Config.TAG, "Command execution completed successfully."); + } else if (rc == RETURN_CODE_CANCEL) { + Log.i(Config.TAG, "Command execution cancelled by user."); + } else { + Log.i(Config.TAG, String.format("Command execution failed with rc=%d and the output below.", rc)); + Config.printLastCommandOutput(Log.INFO); + } + ``` + +6. Stop ongoing FFmpeg operations. + - Stop all executions + ``` + FFmpeg.cancel(); + ``` + - Stop a specific execution + ``` + FFmpeg.cancel(executionId); + ``` + +7. Get media information for a file. + ``` + MediaInformation info = FFprobe.getMediaInformation(""); + ``` + +8. Record video using Android camera. + ``` + FFmpeg.execute("-f android_camera -i 0:0 -r 30 -pixel_format bgr0 -t 00:00:05 "); + ``` + +9. Enable log callback. + ``` + Config.enableLogCallback(new LogCallback() { + public void apply(LogMessage message) { + Log.d(Config.TAG, message.getText()); + } + }); + ``` + +10. Enable statistics callback. + ``` + Config.enableStatisticsCallback(new StatisticsCallback() { + public void apply(Statistics newStatistics) { + Log.d(Config.TAG, String.format("frame: %d, time: %d", newStatistics.getVideoFrameNumber(), newStatistics.getTime())); + } + }); + ``` +11. Ignore the handling of a signal. + ``` + Config.ignoreSignal(Signal.SIGXCPU); + ``` + +12. List ongoing executions. + ``` + final List ffmpegExecutions = FFmpeg.listExecutions(); + for (int i = 0; i < ffmpegExecutions.size(); i++) { + FFmpegExecution execution = ffmpegExecutions.get(i); + Log.d(TAG, String.format("Execution %d = id:%d, startTime:%s, command:%s.", i, execution.getExecutionId(), execution.getStartTime(), execution.getCommand())); + } + ``` + +13. Set default log level. + ``` + Config.setLogLevel(Level.AV_LOG_FATAL); + ``` + +14. Register custom fonts directory. + ``` + Config.setFontDirectory(this, "", Collections.EMPTY_MAP); + ``` + +#### 2.3 iOS / tvOS +1. Add FFmpegKit dependency to your `Podfile` in `ffmpeg-kit-` pattern. + + - iOS + ``` + pod 'ffmpeg-kit-full', '~> 4.4' + ``` + + - tvOS + ``` + pod 'ffmpeg-kit-tvos-full', '~> 4.4' + ``` + +2. Execute synchronous FFmpeg commands. + ``` + #import + #import + + int rc = [FFmpegKit execute: @"-i file1.mp4 -c:v mpeg4 file2.mp4"]; + + if (rc == RETURN_CODE_SUCCESS) { + NSLog(@"Command execution completed successfully.\n"); + } else if (rc == RETURN_CODE_CANCEL) { + NSLog(@"Command execution cancelled by user.\n"); + } else { + NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, [FFmpegKitConfig getLastCommandOutput]); + } + ``` + +3. Execute asynchronous FFmpeg commands. + ``` + #import + #import + + long executionId = [FFmpegKit executeAsync:@"-i file1.mp4 -c:v mpeg4 file2.mp4" withCallback:self]; + + - (void)executeCallback:(long)executionId :(int)returnCode { + if (rc == RETURN_CODE_SUCCESS) { + NSLog(@"Async command execution completed successfully.\n"); + } else if (rc == RETURN_CODE_CANCEL) { + NSLog(@"Async command execution cancelled by user.\n"); + } else { + NSLog(@"Async command execution failed with rc=%d.\n", rc); + } + } + ``` + +4. Execute FFprobe commands. + ``` + #import + #import + + int rc = [FFprobeKit execute: @"-i file1.mp4"]; + + if (rc == RETURN_CODE_SUCCESS) { + NSLog(@"Command execution completed successfully.\n"); + } else if (rc == RETURN_CODE_CANCEL) { + NSLog(@"Command execution cancelled by user.\n"); + } else { + NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, [FFmpegKitConfig getLastCommandOutput]); + } + ``` + +5. Check execution output later. + ``` + int rc = [FFmpegKitConfig getLastReturnCode]; + NSString *output = [FFmpegKitConfig getLastCommandOutput]; + + if (rc == RETURN_CODE_SUCCESS) { + NSLog(@"Command execution completed successfully.\n"); + } else if (rc == RETURN_CODE_CANCEL) { + NSLog(@"Command execution cancelled by user.\n"); + } else { + NSLog(@"Command execution failed with rc=%d and output=%@.\n", rc, output); + } + ``` + +6. Stop ongoing FFmpeg operations. + - Stop all executions + ``` + [FFmpegKit cancel]; + + ``` + - Stop a specific execution + ``` + [FFmpegKit cancel:executionId]; + ``` + +7. Get media information for a file. + ``` + MediaInformation *mediaInformation = [FFprobeKit getMediaInformation:@""]; + ``` + +8. Record video and audio using iOS camera. This operation is not supported on `tvOS` since `AVFoundation` is not available on `tvOS`. + + ``` + [FFmpegKit execute: @"-f avfoundation -r 30 -video_size 1280x720 -pixel_format bgr0 -i 0:0 -vcodec h264_videotoolbox -vsync 2 -f h264 -t 00:00:05 %@", recordFilePath]; + ``` + +9. Enable log callback. + ``` + [FFmpegKitConfig setLogDelegate:self]; + + - (void)logCallback:(long)executionId :(int)level :(NSString*)message { + dispatch_async(dispatch_get_main_queue(), ^{ + NSLog(@"%@", message); + }); + } + ``` + +10. Enable statistics callback. + ``` + [FFmpegKitConfig setStatisticsDelegate:self]; + + - (void)statisticsCallback:(Statistics *)newStatistics { + dispatch_async(dispatch_get_main_queue(), ^{ + NSLog(@"frame: %d, time: %d\n", newStatistics.getVideoFrameNumber, newStatistics.getTime); + }); + } + ``` + +11. Ignore the handling of a signal. + ``` + [FFmpegKitConfig ignoreSignal:SIGXCPU]; + ``` + +12. List ongoing executions. + ``` + NSArray* ffmpegExecutions = [FFmpegKit listExecutions]; + for (int i = 0; i < [ffmpegExecutions count]; i++) { + FFmpegExecution* execution = [ffmpegExecutions objectAtIndex:i]; + NSLog(@"Execution %d = id: %ld, startTime: %@, command: %@.\n", i, [execution getExecutionId], [execution getStartTime], [execution getCommand]); + } + ``` + +13. Set default log level. + ``` + [FFmpegKitConfig setLogLevel:AV_LOG_FATAL]; + ``` + +14. Register custom fonts directory. + ``` + [FFmpegKitConfig setFontDirectory:@"" with:nil]; + ``` + +#### 2.4 Manual Installation +##### 2.4.1 Android + +You can import `FFmpegKit` aar packages in `Android Studio` using the `File` -> `New` -> `New Module` -> `Import .JAR/.AAR Package` menu. + +##### 2.4.2 iOS / tvOS + +iOS and tvOS frameworks can be installed manually using the [Importing Frameworks](https://github.com/tanersener/ffmpeg-kit/wiki/Importing-Frameworks) guide. +If you want to use universal binaries please refer to [Using Universal Binaries](https://github.com/tanersener/ffmpeg-kit/wiki/Using-Universal-Binaries) guide. + +#### 2.5 Test Application +You can see how FFmpegKit is used inside an application by running test applications provided. +There is an `Android` test application under the `android/test-app` folder, an `iOS` test application under the +`ios/test-app` folder and a `tvOS` test application under the `tvos/test-app` folder. + +All applications are identical and supports command execution, video encoding, accessing https, encoding audio, +burning subtitles, video stabilisation, pipe operations and concurrent command execution. + + + +### 3. Versions + +- `dev` part in `FFmpeg` version number indicates that `FFmpeg` source is pulled from the `FFmpeg` `master` branch. +Exact version number is obtained using `git describe --tags`. + +| FFmpegKit Version | FFmpeg Version | Release Date | +| :----: | :----: |:----: | +| [4.4](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4) | 4.4-dev-416 | Jul 25, 2020 | +| [4.4.LTS](https://github.com/tanersener/ffmpeg-kit/releases/tag/v4.4.LTS) | 4.4-dev-416 | Jul 24, 2020 | + +### 4. LTS Releases + +`FFmpegKit` binaries are published in two release variants: `Main Release` and `LTS Release`. + +- Main releases include complete functionality of the library and support the latest SDK/API features. + +- LTS releases are customized to support a wider range of devices. They are built using older API/SDK versions, so some features are not available on them. + +This table shows the differences between two variants. + +| | Main Release | LTS Release | +| :----: | :----: | :----: | +| Android API Level | 24 | 16 | +| Android Camera Access | Yes | - | +| Android Architectures | arm-v7a-neon
arm64-v8a
x86
x86-64 | arm-v7a
arm-v7a-neon
arm64-v8a
x86
x86-64 | +| Xcode Support | 10.1 | 7.3.1 | +| iOS SDK | 12.1 | 9.3 | +| iOS AVFoundation | Yes | - | +| iOS Architectures | arm64
x86-64
x86-64-mac-catalyst | armv7
arm64
i386
x86-64 | +| tvOS SDK | 10.2 | 9.2 | +| tvOS Architectures | arm64
x86-64 | arm64
x86-64 | + +### 5. Building + +Build scripts from `master` and `development` branches are tested periodically. See the latest status from the table below. + +| branch | status | +| :---: | :---: | +| master | [![Build Status](https://travis-ci.org/tanersener/ffmpeg-kit.svg?branch=master)](https://travis-ci.org/tanersener/ffmpeg-kit) | +| development | [![Build Status](https://travis-ci.org/tanersener/ffmpeg-kit.svg?branch=development)](https://travis-ci.org/tanersener/ffmpeg-kit) | + + +#### 5.1 Prerequisites +1. Use your package manager (apt, yum, dnf, brew, etc.) to install the following packages. + + ``` + autoconf automake libtool pkg-config curl cmake gcc gperf texinfo yasm nasm bison autogen patch git + ``` +Some of these packages are not mandatory for the default build. +Please visit [Android Prerequisites](https://github.com/tanersener/ffmpeg-kit/wiki/Android-Prerequisites), +[iOS Prerequisites](https://github.com/tanersener/ffmpeg-kit/wiki/iOS-Prerequisites) and +[tvOS Prerequisites](https://github.com/tanersener/ffmpeg-kit/wiki/tvOS-Prerequisites) for the details. + +2. Android builds require these additional packages. + - **Android SDK 4.1 Jelly Bean (API Level 16)** or later + - **Android NDK r21** or later with LLDB and CMake + +3. iOS builds need these extra packages and tools. + - **Xcode 7.3.1** or later + - **iOS SDK 9.3** or later + - **Command Line Tools** + +4. tvOS builds need these extra packages and tools. + - **Xcode 7.3.1** or later + - **tvOS SDK 9.2** or later + - **Command Line Tools** + +#### 5.2 Build Scripts +Use `android.sh`, `ios.sh` and `tvos.sh` to build FFmpegKit for each platform. + +All three scripts support additional options and +can be customized to enable/disable specific external libraries and/or architectures. Please refer to wiki pages of +[android.sh](https://github.com/tanersener/ffmpeg-kit/wiki/android.sh), +[ios.sh](https://github.com/tanersener/ffmpeg-kit/wiki/ios.sh) and +[tvos.sh](https://github.com/tanersener/ffmpeg-kit/wiki/tvos.sh) to see all available build options. +##### 5.2.1 Android +``` +export ANDROID_SDK_ROOT= +export ANDROID_NDK_ROOT= +./android.sh +``` + + + +##### 5.2.2 iOS +``` +./ios.sh +``` + + + +##### 5.2.3 tvOS +``` +./tvos.sh +``` + + + + +##### 5.2.4 Building LTS Binaries + +Use `--lts` option to build lts binaries for each platform. + +#### 5.3 Build Output + +All libraries created by the top level build scripts (`android.sh`, `ios.sh` and `tvos.sh`) can be found under +the `prebuilt` directory. + +- `Android` archive (.aar file) is located under the `android-aar` folder +- `iOS` frameworks are located under the `ios-framework` folder +- `iOS` xcframeworks are located under the `ios-xcframework` folder +- `iOS` universal binaries are located under the `ios-universal` folder +- `tvOS` frameworks are located under the `tvos-framework` folder +- `tvOS` universal binaries are located under the `tvos-universal` folder + +#### 5.4 GPL Support +It is possible to enable GPL licensed libraries `x264`, `xvidcore`, `vid.stab`, `x265` and`rubberband` from the top +level build scripts. Their source code is not included in the repository and downloaded when enabled. + +#### 5.5 External Libraries +`build` directory includes build scripts of all external libraries. Two scripts exist for each external library, +one for `Android` and one for `iOS / tvOS`. Each of these two scripts contains options/flags used to cross-compile the +library on the specified platform. + +CPU optimizations (`ASM`) are enabled for most of the external libraries. Details and exceptions can be found under the +[ASM Support](https://github.com/tanersener/ffmpeg-kit/wiki/ASM-Support) wiki page. + +### 6. Documentation + +A more detailed documentation is available at [Wiki](https://github.com/tanersener/ffmpeg-kit/wiki). + +### 8. License + +`FFmpegKit` is licensed under the LGPL v3.0. However, if source code is built using the optional `--enable-gpl` flag +or prebuilt binaries with `-gpl` postfix are used, then FFmpegKit is subject to the GPL v3.0 license. + +The source code of all external libraries included is in compliance with their individual licenses. + +`openh264` source code included in this repository is licensed under the 2-clause BSD License but this license does +not cover the `MPEG LA` licensing fees. If you build `ffmpeg-kit` with `openh264` and distribute that library, then +you are subject to pay `MPEG LA` licensing fees. Refer to [OpenH264 FAQ](https://www.openh264.org/faq.html) page for +the details. Please note that `ffmpeg-kit` does not publish a binary with `openh264` inside. + +`strip-frameworks.sh` script included and distributed (until v4.x) is published under the +[Apache License version 2.0](https://www.apache.org/licenses/LICENSE-2.0). + +In test applications; embedded fonts are licensed under the +[SIL Open Font License](https://opensource.org/licenses/OFL-1.1), other digital assets are published in the public +domain. + +Please visit [License](https://github.com/tanersener/ffmpeg-kit/wiki/License) page for the details. + +### 9. Patents + +It is not clearly explained in their documentation but it is believed that `FFmpeg`, `kvazaar`, `x264` and `x265` +include algorithms which are subject to software patents. If you live in a country where software algorithms are +patentable then you'll probably need to pay royalty fees to patent holders. We are not lawyers though, so we recommend +that you seek legal advice first. See [FFmpeg Patent Mini-FAQ](https://ffmpeg.org/legal.html). + +`openh264` clearly states that it uses patented algorithms. Therefore, if you build ffmpeg-kit with openh264 and +distribute that library, then you are subject to pay MPEG LA licensing fees. Refer to +[OpenH264 FAQ](https://www.openh264.org/faq.html) page for the details. + +### 10. Contributing + +Feel free to submit issues or pull requests. + +Please note that `master` includes only the latest released source code. Changes planned for the next release are +implemented under the `development` branch. Therefore, if you want to create a pull request, please open it against +the `development`. + +### 11. See Also + +- [libav gas-preprocessor](https://github.com/libav/gas-preprocessor/raw/master/gas-preprocessor.pl) +- [FFmpeg API Documentation](https://ffmpeg.org/doxygen/4.0/index.html) +- [FFmpeg Wiki](https://trac.ffmpeg.org/wiki/WikiStart) +- [FFmpeg External Library Licenses](https://www.ffmpeg.org/doxygen/4.0/md_LICENSE.html) diff --git a/android.sh b/android.sh index cc0a798..947ccef 100755 --- a/android.sh +++ b/android.sh @@ -1,119 +1,51 @@ #!/bin/bash -export FFMPEG_KIT_BUILD_TYPE="android" -export BASEDIR="$(pwd)" - -source "${BASEDIR}"/scripts/common-${FFMPEG_KIT_BUILD_TYPE}.sh - -# ENABLE ARCH -ENABLED_ARCHITECTURES=(1 1 0 0 1 0 0 0 1 1 0) - -# ENABLE LIBRARIES -ENABLED_LIBRARIES=(0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0) - -# USING API LEVEL 24 / Android 7.0 (NOUGAT) -export API=24 - -RECONF_LIBRARIES=() -REBUILD_LIBRARIES=() -REDOWNLOAD_LIBRARIES=() - -get_ffmpeg_kit_version() { - local FFMPEG_KIT_VERSION=$(grep '#define FFMPEG_KIT_VERSION' "${BASEDIR}"/android/app/src/main/cpp/ffmpegkit.h | grep -Eo '\".*\"' | sed -e 's/\"//g') - - echo "${FFMPEG_KIT_VERSION}" -} - -display_help() { - local COMMAND=$(echo "$0" | sed -e 's/\.\///g') - - echo -e "\n'$COMMAND' builds FFmpegKit for Android platform. By default five Android ABIs (armeabi-v7a, \ -armeabi-v7a-neon, arm64-v8a, x86 and x86_64) are built without any external libraries enabled. Options can be used to \ -disable ABIs and/or enable external libraries. Please note that GPL libraries (external libraries with GPL license) \ -need --enable-gpl flag to be set explicitly. When compilation ends an Android Archive (AAR) file is created under the \ -prebuilt folder.\n" - echo -e "Usage: ./$COMMAND [OPTION]... [VAR=VALUE]...\n" - echo -e "Specify environment variables as VARIABLE=VALUE to override default build options.\n" - - display_help_options " --api-level=api\t\tset Android api level [${API}]" - display_help_licensing - - echo -e "Architectures:" - echo -e " --disable-arm-v7a\t\tdo not build arm-v7a architecture [yes]" - echo -e " --disable-arm-v7a-neon\tdo not build arm-v7a-neon architecture [yes]" - echo -e " --disable-arm64-v8a\t\tdo not build arm64-v8a architecture [yes]" - echo -e " --disable-x86\t\t\tdo not build x86 architecture [yes]" - echo -e " --disable-x86-64\t\tdo not build x86-64 architecture [yes]\n" - - echo -e "Libraries:" - echo -e " --full\t\t\tenables all external libraries" - echo -e " --enable-android-media-codec\tbuild with built-in Android MediaCodec support[no]" - echo -e " --enable-android-zlib\t\tbuild with built-in zlib support[no]" - - display_help_common_libraries - display_help_gpl_libraries - display_help_advanced_options -} - -enable_lts_build() { - export FFMPEG_KIT_LTS_BUILD="1" - - # USING API LEVEL 16 / Android 4.1 (JELLY BEAN) - export API=16 -} - -build_application_mk() { - if [[ -n ${FFMPEG_KIT_LTS_BUILD} ]]; then - local LTS_BUILD_FLAG="-DFFMPEG_KIT_LTS " - fi - - if [[ ${ENABLED_LIBRARIES[$LIBRARY_X265]} -eq 1 ]] || [[ ${ENABLED_LIBRARIES[$LIBRARY_TESSERACT]} -eq 1 ]] || [[ ${ENABLED_LIBRARIES[$LIBRARY_OPENH264]} -eq 1 ]] || [[ ${ENABLED_LIBRARIES[$LIBRARY_SNAPPY]} -eq 1 ]] || [[ ${ENABLED_LIBRARIES[$LIBRARY_RUBBERBAND]} -eq 1 ]]; then - local APP_STL="c++_shared" - else - local APP_STL="none" - fi - - local BUILD_DATE="-DFFMPEG_KIT_BUILD_DATE=$(date +%Y%m%d 2>>"${BASEDIR}"/build.log)" - - rm -f "${BASEDIR}/android/jni/Application.mk" - - cat >"${BASEDIR}/android/jni/Application.mk" <>"${BASEDIR}"/build.log 2>&1 echo -e "INFO: Build options: $*\n" 1>>"${BASEDIR}"/build.log 2>&1 +# SET DEFAULT BUILD OPTIONS GPL_ENABLED="no" DISPLAY_HELP="" -BUILD_LTS="" BUILD_FULL="" BUILD_TYPE_ID="" -BUILD_VERSION=$(git describe --tags 2>>"${BASEDIR}"/build.log) +BUILD_VERSION=$(git describe --tags --always 2>>"${BASEDIR}"/build.log) +# PROCESS LTS BUILD OPTION FIRST AND SET BUILD TYPE: MAIN OR LTS +rm -f "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 +cp "${BASEDIR}"/tools/release/android/build.gradle "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 +for argument in "$@"; do + if [[ "$argument" == "-l" ]] || [[ "$argument" == "--lts" ]]; then + enable_lts_build + BUILD_TYPE_ID+="LTS " + rm -f "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 + cp "${BASEDIR}"/tools/release/android/build.lts.gradle "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 + fi +done + +# PROCESS BUILD OPTIONS while [ ! $# -eq 0 ]; do case $1 in @@ -146,11 +78,9 @@ while [ ! $# -eq 0 ]; do -s | --speed) optimize_for_speed ;; - -l | --lts) - BUILD_LTS="1" - ;; + -l | --lts) ;; -f | --force) - BUILD_FORCE="1" + export BUILD_FORCE="1" ;; --reconf-*) CONF_LIBRARY=$(echo $1 | sed -e 's/^--[A-Za-z]*-//g') @@ -200,39 +130,28 @@ if [[ -z ${BUILD_VERSION} ]]; then exit 1 fi -# DETECT BUILD TYPE -rm -f "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 -if [[ -n ${BUILD_LTS} ]]; then - enable_lts_build - BUILD_TYPE_ID+="LTS " - - cp "${BASEDIR}"/tools/release/android/build.lts.gradle "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 -else - cp "${BASEDIR}"/tools/release/android/build.gradle "${BASEDIR}"/android/app/build.gradle 1>>"${BASEDIR}"/build.log 2>&1 -fi - -# HELP DISPLAYED AFTER SETTING LTS FLAG -if [[ -n ${DISPLAY_HELP} ]]; then - display_help - exit 0 -fi - -# PROCESS FULL FLAG +# PROCESS FULL OPTION AS LAST OPTION if [[ -n ${BUILD_FULL} ]]; then - for library in {0..60}; do + for library in {0..57}; do if [ ${GPL_ENABLED} == "yes" ]; then - enable_library "$(get_library_name $library)" + enable_library "$(get_library_name $library)" 1 else - if [[ $library -ne $LIBRARY_X264 ]] && [[ $library -ne $LIBRARY_XVIDCORE ]] && [[ $library -ne $LIBRARY_X265 ]] && [[ $library -ne $LIBRARY_LIBVIDSTAB ]] && [[ $library -ne $LIBRARY_RUBBERBAND ]]; then - enable_library "$(get_library_name $library)" + if [[ $(is_gpl_licensed $library) -eq 1 ]]; then + enable_library "$(get_library_name $library)" 1 fi fi done fi +# IF HELP DISPLAYED EXIT +if [[ -n ${DISPLAY_HELP} ]]; then + display_help + exit 0 +fi + echo -e "\nBuilding ffmpeg-kit ${BUILD_TYPE_ID}library for Android\n" echo -e -n "INFO: Building ffmpeg-kit ${BUILD_VERSION} ${BUILD_TYPE_ID}library for Android: " 1>>"${BASEDIR}"/build.log 2>&1 -echo -e "$(date)" 1>>"${BASEDIR}"/build.log 2>&1 +echo -e "$(date)\n" 1>>"${BASEDIR}"/build.log 2>&1 # PRINT BUILD SUMMARY print_enabled_architectures @@ -241,7 +160,7 @@ print_reconfigure_requested_libraries print_rebuild_requested_libraries print_redownload_requested_libraries -# CHECK GPL FLAG AND DOWNLOAD LIBRARIES +# VALIDATE GPL FLAGS for gpl_library in {$LIBRARY_X264,$LIBRARY_XVIDCORE,$LIBRARY_X265,$LIBRARY_LIBVIDSTAB,$LIBRARY_RUBBERBAND}; do if [[ ${ENABLED_LIBRARIES[$gpl_library]} -eq 1 ]]; then library_name=$(get_library_name ${gpl_library}) @@ -250,21 +169,20 @@ for gpl_library in {$LIBRARY_X264,$LIBRARY_XVIDCORE,$LIBRARY_X265,$LIBRARY_LIBVI echo -e "\n(*) Invalid configuration detected. GPL library ${library_name} enabled without --enable-gpl flag.\n" echo -e "\n(*) Invalid configuration detected. GPL library ${library_name} enabled without --enable-gpl flag.\n" 1>>"${BASEDIR}"/build.log 2>&1 exit 1 - else - DOWNLOAD_RESULT=$(download_gpl_library_source "${library_name}") - if [[ ${DOWNLOAD_RESULT} -ne 0 ]]; then - echo -e "\n(*) Failed to download GPL library ${library_name} source. Please check build.log file for details. If the problem persists refer to offline building instructions.\n" - echo -e "\n(*) Failed to download GPL library ${library_name} source.\n" 1>>"${BASEDIR}"/build.log 2>&1 - exit 1 - fi fi fi done -# SAVE API VALUE +echo -n -e "\nDownloading sources: " +echo -e "INFO: Downloading source code of ffmpeg and enabled external libraries.\n" 1>>"${BASEDIR}"/build.log 2>&1 + +# DOWNLOAD LIBRARY SOURCES +downloaded_enabled_library_sources "${ENABLED_LIBRARIES[@]}" + +# SAVE ORIGINAL API LEVEL = NECESSARY TO BUILD 64bit ARCHITECTURES export ORIGINAL_API=${API} -# BUILD ALL ENABLED ARCHITECTURES +# BUILD ENABLED LIBRARIES ON ENABLED ARCHITECTURES for run_arch in {0..10}; do if [[ ${ENABLED_ARCHITECTURES[$run_arch]} -eq 1 ]]; then if [[ (${run_arch} -eq ${ARCH_ARM64_V8A} || ${run_arch} -eq ${ARCH_X86_64}) && ${API} -lt 21 ]]; then @@ -279,10 +197,11 @@ for run_arch in {0..10}; do export TOOLCHAIN=$(get_toolchain) export TOOLCHAIN_ARCH=$(get_toolchain_arch) + # EXECUTE MAIN BUILD SCRIPT . "${BASEDIR}"/scripts/main-android.sh "${ENABLED_LIBRARIES[@]}" || exit 1 # CLEAR FLAGS - for library in {0..60}; do + for library in {0..57}; do library_name=$(get_library_name ${library}) unset "$(echo "OK_${library_name}" | sed "s/\-/\_/g")" unset "$(echo "DEPENDENCY_REBUILT_${library_name}" | sed "s/\-/\_/g")" @@ -290,56 +209,52 @@ for run_arch in {0..10}; do fi done +# GET BACK THE ORIGINAL API LEVEL export API=${ORIGINAL_API} -# SET ARCHITECTURES INSIDE Application.mk +# SET ARCHITECTURES TO BUILD rm -f "${BASEDIR}"/android/build/.armv7 1>>"${BASEDIR}"/build.log 2>&1 rm -f "${BASEDIR}"/android/build/.armv7neon 1>>"${BASEDIR}"/build.log 2>&1 ANDROID_ARCHITECTURES="" -if [[ ${ENABLED_ARCHITECTURES[0]} -eq 1 ]] || [[ ${ENABLED_ARCHITECTURES[1]} -eq 1 ]]; then +if [[ ${ENABLED_ARCHITECTURES[ARCH_ARM_V7A]} -eq 1 ]] || [[ ${ENABLED_ARCHITECTURES[ARCH_ARM_V7A_NEON]} -eq 1 ]]; then ANDROID_ARCHITECTURES+="$(get_android_arch 0) " fi -if [[ ${ENABLED_ARCHITECTURES[0]} -eq 1 ]]; then +if [[ ${ENABLED_ARCHITECTURES[ARCH_ARM_V7A]} -eq 1 ]]; then mkdir -p "${BASEDIR}"/android/build 1>>"${BASEDIR}"/build.log 2>&1 cat >"${BASEDIR}"/android/build/.armv7 <>"${BASEDIR}"/build.log 2>&1 cat >"${BASEDIR}"/android/build/.armv7neon <>"${BASEDIR}"/build.log 2>&1 - - mkdir -p "${FFMPEG_KIT_AAR}" 1>>"${BASEDIR}"/build.log 2>&1 + rm -rf "${BASEDIR}"/android/obj 1>>"${BASEDIR}"/build.log 2>&1 cd "${BASEDIR}"/android 1>>"${BASEDIR}"/build.log 2>&1 || exit 1 - # CLEAR OLD NDK LIBS - rm -rf "${BASEDIR}"/android/libs 1>>"${BASEDIR}"/build.log 2>&1 - rm -rf "${BASEDIR}"/android/obj 1>>"${BASEDIR}"/build.log 2>&1 - + # BUILD NATIVE LIBRARY "${ANDROID_NDK_ROOT}"/ndk-build -B 1>>"${BASEDIR}"/build.log 2>&1 - if [ $? -eq 0 ]; then echo "ok" else @@ -349,21 +264,23 @@ if [[ -n ${ANDROID_ARCHITECTURES} ]]; then echo -e -n "\n\nCreating Android archive under prebuilt/android-aar: " + # BUILD ANDROID ARCHIVE ./gradlew app:clean app:assembleRelease app:testReleaseUnitTest 1>>"${BASEDIR}"/build.log 2>&1 - if [ $? -ne 0 ]; then echo -e "failed\n" exit 1 fi + # COPY ANDROID ARCHIVE TO PREBUILT DIRECTORY + FFMPEG_KIT_AAR="${BASEDIR}"/prebuilt/android-aar/ffmpeg-kit + rm -rf "${FFMPEG_KIT_AAR}" 1>>"${BASEDIR}"/build.log 2>&1 + mkdir -p "${FFMPEG_KIT_AAR}" 1>>"${BASEDIR}"/build.log 2>&1 cp "${BASEDIR}"/android/app/build/outputs/aar/ffmpeg-kit-release.aar "${FFMPEG_KIT_AAR}"/ffmpeg-kit.aar 1>>"${BASEDIR}"/build.log 2>&1 - if [ $? -ne 0 ]; then echo -e "failed\n" exit 1 fi echo -e "Created ffmpeg-kit Android archive successfully.\n" 1>>"${BASEDIR}"/build.log 2>&1 - echo -e "ok\n" fi diff --git a/android/.gitignore b/android/.gitignore new file mode 100644 index 0000000..447a113 --- /dev/null +++ b/android/.gitignore @@ -0,0 +1,7 @@ +/build +/local.properties +/.idea/ +/.gradle/ +/libs/ +/obj/ +/app/build/ diff --git a/android/app/Doxyfile b/android/app/Doxyfile new file mode 100644 index 0000000..f92b9e7 --- /dev/null +++ b/android/app/Doxyfile @@ -0,0 +1,2549 @@ +# Doxyfile 1.8.18 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project. +# +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. +# The format is: +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. +# The default value is: UTF-8. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. + +PROJECT_NAME = "FFmpegKit Android API" + +# 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 = 4.4 + +# 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 = + +# 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 = ../../docs/android/doc + +# 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 = YES + +# 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 + +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. +# The default value is: YES. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. + +ABBREVIATE_BRIEF = "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 = src/main/cpp + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. + +JAVADOC_AUTOBRIEF = NO + +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. + +MULTILINE_CPP_IS_BRIEF = NO + +# 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. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, JavaScript, +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, VHDL, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files). For instance to make doxygen treat .inc files +# as Fortran files (default is PHP), and .f files as C (default is Fortran), +# use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See https://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. + +MARKDOWN_SUPPORT = YES + +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 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_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal +# scope will be included in the documentation. +# The default value is: NO. + +EXTRACT_PACKAGE = YES + +# 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 +# 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 +# (including Cygwin) ands 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 = NO + +# 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 = NO + +# 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 = NO + +# 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 = NO + +# 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= NO + +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. +# The default value is: YES. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# Configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. + +WARNINGS = YES + +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. + +WARN_IF_UNDOCUMENTED = YES + +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. +# The default value is: NO. + +WARN_NO_PARAMDOC = NO + +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# Configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING +# Note: If this tag is empty the current directory is searched. + +INPUT = src/main/cpp + +# 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 (to be provided as doxygen C comment), +# *.doc (to be provided as doxygen C comment), *.txt (to be provided as doxygen +# C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, +# *.vhdl, *.ucf, *.qsf and *.ice. + +FILE_PATTERNS = *.c \ + *.cc \ + *.cxx \ + *.cpp \ + *.c++ \ + *.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 = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. +# The default value is: NO. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. + +EXAMPLE_PATTERNS = * + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). + +IMAGE_PATH = + +# 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 = YES + +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# entity all documented functions referencing it will be listed. +# The default value is: NO. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. + +REFERENCES_LINK_SOURCE = YES + +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see https://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# 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 = .html + +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# 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 = YES + +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via JavaScript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have JavaScript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_SECTIONS = NO + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_DOCSET = NO + +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +GENERATE_HTMLHELP = NO + +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be +# written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +CHM_FILE = + +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. + +HHC_LOCATION = + +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the 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: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_VIRTUAL_FOLDER = doc + +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. + +QHP_SECT_FILTER_ATTRS = + +# The QHG_LOCATION tag can be used to specify the location 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 + +# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg +# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see +# https://inkscape.org) to generate formulas as SVG images instead of PNGs for +# the HTML output. These images will generally look nicer at scaled resolutions. +# Possible values are: png The default and svg Looks nicer but requires the +# pdf2svg tool. +# The default value is: png. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FORMULA_FORMAT = png + +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +FORMULA_TRANSPARENT = YES + +# The FORMULA_MACROFILE can contain LaTeX \newcommand and \renewcommand commands +# to create new LaTeX commands to be used in formulas as building blocks. See +# the section "Including formulas" for details. + +FORMULA_MACROFILE = + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# https://www.mathjax.org) which uses client side JavaScript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. + +USE_MATHJAX = NO + +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdn.jsdelivr.net/npm/mathjax@2. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_RELPATH = https://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 +# , /