Showing preview only (2,732K chars total). Download the full file or copy to clipboard to get everything.
Repository: snapcast/snapcast
Branch: develop
Commit: f12373479243
Files: 271
Total size: 2.6 MB
Directory structure:
gitextract_rc5jeayv/
├── .clang-format
├── .clang-tidy
├── .clangd
├── .devcontainer/
│ ├── Dockerfile.alpine
│ ├── Dockerfile.debian
│ ├── Dockerfile.fedora
│ └── devcontainer.json
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ ├── config.yml
│ │ └── feature_request.md
│ ├── dependabot.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── ci.yml
│ └── package.yml
├── .gitignore
├── CMakeLists.txt
├── CONTRIBUTING.md
├── Doxyfile
├── LICENSE
├── README.md
├── TODO.md
├── _CMakePresets.json
├── _config.yml
├── changelog.md
├── client/
│ ├── CMakeLists.txt
│ ├── browseZeroConf/
│ │ ├── browse_avahi.cpp
│ │ ├── browse_avahi.hpp
│ │ ├── browse_bonjour.cpp
│ │ ├── browse_bonjour.hpp
│ │ ├── browse_mdns.hpp
│ │ └── browse_zeroconf.hpp
│ ├── build_android.sh
│ ├── build_android_all.sh
│ ├── client_connection.cpp
│ ├── client_connection.hpp
│ ├── client_settings.hpp
│ ├── controller.cpp
│ ├── controller.hpp
│ ├── decoder/
│ │ ├── decoder.hpp
│ │ ├── flac_decoder.cpp
│ │ ├── flac_decoder.hpp
│ │ ├── null_decoder.cpp
│ │ ├── null_decoder.hpp
│ │ ├── ogg_decoder.cpp
│ │ ├── ogg_decoder.hpp
│ │ ├── opus_decoder.cpp
│ │ ├── opus_decoder.hpp
│ │ ├── pcm_decoder.cpp
│ │ └── pcm_decoder.hpp
│ ├── double_buffer.hpp
│ ├── etc/
│ │ └── snapclient.plist
│ ├── player/
│ │ ├── alsa_player.cpp
│ │ ├── alsa_player.hpp
│ │ ├── coreaudio_player.cpp
│ │ ├── coreaudio_player.hpp
│ │ ├── file_player.cpp
│ │ ├── file_player.hpp
│ │ ├── oboe_player.cpp
│ │ ├── oboe_player.hpp
│ │ ├── opensl_player.cpp
│ │ ├── opensl_player.hpp
│ │ ├── pcm_device.hpp
│ │ ├── pipewire_player.cpp
│ │ ├── pipewire_player.hpp
│ │ ├── player.cpp
│ │ ├── player.hpp
│ │ ├── pulse_player.cpp
│ │ ├── pulse_player.hpp
│ │ ├── sdl2_player.cpp
│ │ ├── sdl2_player.hpp
│ │ ├── wasapi_player.cpp
│ │ └── wasapi_player.hpp
│ ├── snapclient.1
│ ├── snapclient.cpp
│ ├── stream.cpp
│ ├── stream.hpp
│ ├── time_provider.cpp
│ └── time_provider.hpp
├── cmake/
│ ├── CheckAtomic.cmake
│ ├── CheckCXX11StringSupport.cmake
│ ├── SystemdService.cmake
│ ├── TargetArch.cmake
│ ├── clang-tidy.cmake
│ ├── cppcheck.cmake
│ └── reformat.cmake
├── common/
│ ├── CMakeLists.txt
│ ├── aixlog.hpp
│ ├── base64.cpp
│ ├── base64.h
│ ├── daemon.cpp
│ ├── daemon.hpp
│ ├── endian.hpp
│ ├── error_code.hpp
│ ├── json.hpp
│ ├── message/
│ │ ├── client_info.hpp
│ │ ├── codec_header.hpp
│ │ ├── error.hpp
│ │ ├── factory.hpp
│ │ ├── hello.hpp
│ │ ├── json_message.hpp
│ │ ├── message.hpp
│ │ ├── pcm_chunk.hpp
│ │ ├── server_settings.hpp
│ │ ├── time.hpp
│ │ └── wire_chunk.hpp
│ ├── popl.hpp
│ ├── queue.hpp
│ ├── resampler.cpp
│ ├── resampler.hpp
│ ├── sample_format.cpp
│ ├── sample_format.hpp
│ ├── snap_exception.hpp
│ ├── str_compat.hpp
│ ├── stream_uri.cpp
│ ├── stream_uri.hpp
│ ├── time_defs.hpp
│ ├── utils/
│ │ ├── file_utils.cpp
│ │ ├── file_utils.hpp
│ │ ├── logging.hpp
│ │ ├── string_utils.cpp
│ │ └── string_utils.hpp
│ ├── utils.hpp
│ └── version.hpp
├── control/
│ ├── control.py
│ ├── scripts.md
│ ├── setVolume.py
│ ├── snapcast_mpris.py
│ └── testClient.py
├── doc/
│ ├── binary_protocol.md
│ ├── build.md
│ ├── client/
│ │ └── pipewire_player.md
│ ├── configuration.md
│ ├── contributions.md
│ ├── install.md
│ ├── json_rpc_api/
│ │ ├── control.md
│ │ └── stream_plugin.md
│ ├── pipewire-stream.md
│ └── player_setup.md
├── extras/
│ ├── changelog_current_version.py
│ └── package/
│ ├── debian/
│ │ ├── README.source
│ │ ├── changelog
│ │ ├── changelog_md2deb.py
│ │ ├── compat
│ │ ├── control
│ │ ├── copyright
│ │ ├── rules
│ │ ├── snapclient.default
│ │ ├── snapclient.init
│ │ ├── snapclient.install
│ │ ├── snapclient.manpages
│ │ ├── snapclient.postinst
│ │ ├── snapclient.postrm
│ │ ├── snapclient.service
│ │ ├── snapserver.default
│ │ ├── snapserver.docs
│ │ ├── snapserver.init
│ │ ├── snapserver.install
│ │ ├── snapserver.manpages
│ │ ├── snapserver.postinst
│ │ ├── snapserver.postrm
│ │ ├── snapserver.service
│ │ └── source/
│ │ ├── format
│ │ └── local-options
│ ├── mac/
│ │ ├── readme.md
│ │ └── snapclient.plist
│ └── rpm/
│ ├── snapcast.changes
│ ├── snapcast.spec
│ ├── snapclient.default
│ ├── snapclient.service
│ ├── snapserver.default
│ └── snapserver.service
├── server/
│ ├── CMakeLists.txt
│ ├── authinfo.cpp
│ ├── authinfo.hpp
│ ├── build_android.sh
│ ├── config.cpp
│ ├── config.hpp
│ ├── control_requests.cpp
│ ├── control_requests.hpp
│ ├── control_server.cpp
│ ├── control_server.hpp
│ ├── control_session.hpp
│ ├── control_session_http.cpp
│ ├── control_session_http.hpp
│ ├── control_session_tcp.cpp
│ ├── control_session_tcp.hpp
│ ├── control_session_ws.cpp
│ ├── control_session_ws.hpp
│ ├── encoder/
│ │ ├── encoder.hpp
│ │ ├── encoder_factory.cpp
│ │ ├── encoder_factory.hpp
│ │ ├── flac_encoder.cpp
│ │ ├── flac_encoder.hpp
│ │ ├── null_encoder.cpp
│ │ ├── null_encoder.hpp
│ │ ├── ogg_encoder.cpp
│ │ ├── ogg_encoder.hpp
│ │ ├── opus_encoder.cpp
│ │ ├── opus_encoder.hpp
│ │ ├── pcm_encoder.cpp
│ │ └── pcm_encoder.hpp
│ ├── etc/
│ │ ├── index.html
│ │ ├── plug-ins/
│ │ │ ├── example.py
│ │ │ ├── meta_go-librespot.py
│ │ │ ├── meta_librespot-java.py
│ │ │ ├── meta_mopidy.py
│ │ │ ├── meta_mpd.py
│ │ │ └── plex_bridge.py
│ │ ├── snapserver.bsd
│ │ ├── snapserver.plist
│ │ └── snapweb/
│ │ └── index.html
│ ├── image_cache.hpp
│ ├── jsonrpcpp.hpp
│ ├── jwt.cpp
│ ├── jwt.hpp
│ ├── publishZeroConf/
│ │ ├── publish_avahi.cpp
│ │ ├── publish_avahi.hpp
│ │ ├── publish_bonjour.cpp
│ │ ├── publish_bonjour.hpp
│ │ ├── publish_mdns.hpp
│ │ └── publish_zeroconf.hpp
│ ├── server.cpp
│ ├── server.hpp
│ ├── server_settings.hpp
│ ├── snapserver.1
│ ├── snapserver.cpp
│ ├── stream_server.cpp
│ ├── stream_server.hpp
│ ├── stream_session.cpp
│ ├── stream_session.hpp
│ ├── stream_session_tcp.cpp
│ ├── stream_session_tcp.hpp
│ ├── stream_session_ws.cpp
│ ├── stream_session_ws.hpp
│ └── streamreader/
│ ├── airplay_stream.cpp
│ ├── airplay_stream.hpp
│ ├── alsa_stream.cpp
│ ├── alsa_stream.hpp
│ ├── asio_stream.hpp
│ ├── control_error.cpp
│ ├── control_error.hpp
│ ├── file_stream.cpp
│ ├── file_stream.hpp
│ ├── jack_stream.cpp
│ ├── jack_stream.hpp
│ ├── librespot_stream.cpp
│ ├── librespot_stream.hpp
│ ├── meta_stream.cpp
│ ├── meta_stream.hpp
│ ├── metadata.cpp
│ ├── metadata.hpp
│ ├── pcm_stream.cpp
│ ├── pcm_stream.hpp
│ ├── pipe_stream.cpp
│ ├── pipe_stream.hpp
│ ├── pipewire_stream.cpp
│ ├── pipewire_stream.hpp
│ ├── process_stream.cpp
│ ├── process_stream.hpp
│ ├── properties.cpp
│ ├── properties.hpp
│ ├── stream_control.cpp
│ ├── stream_control.hpp
│ ├── stream_manager.cpp
│ ├── stream_manager.hpp
│ ├── tcp_stream.cpp
│ ├── tcp_stream.hpp
│ ├── watchdog.cpp
│ └── watchdog.hpp
└── test/
├── CMakeLists.txt
└── test_main.cpp
================================================
FILE CONTENTS
================================================
================================================
FILE: .clang-format
================================================
---
AccessModifierOffset: '-4'
AllowShortBlocksOnASingleLine: 'false'
AllowShortCaseLabelsOnASingleLine: 'false'
AllowShortFunctionsOnASingleLine: None
AllowShortIfStatementsOnASingleLine: 'false'
AllowShortLoopsOnASingleLine: 'false'
AlwaysBreakTemplateDeclarations: 'true'
BreakBeforeBraces: Allman
LambdaBodyIndentation: OuterScope
ColumnLimit: '160'
IndentCaseLabels: 'true'
IndentWidth: '4'
Language: Cpp
MaxEmptyLinesToKeep: '3'
PenaltyBreakComment: '100000'
PointerAlignment: Left
Standard: Latest
UseTab: Never
...
================================================
FILE: .clang-tidy
================================================
---
Checks: 'clang-diagnostic-*,clang-analyzer-*,modernize*,performance*,readability-*size*,readability*redundant*,-readability-redundant-member-init,-readability-redundant-access-specifiers,misc*,boost-use-to-string,cert*,google-runtime-member-string-references,google-explicit-constructor,-cert-err33-c,-cert-err58-cpp,-modernize-concat-nested-namespaces,-modernize-use-nodiscard,-misc-non-private-member-variables-in-classes,-modernize-use-trailing-return-type,-misc-no-recursion,-misc-const-correctness,-misc-use-anonymous-namespace,-misc-include-cleaner'
WarningsAsErrors: ''
HeaderFilterRegex: ''
FormatStyle: file
User: badaix
CheckOptions:
- key: modernize-loop-convert.MaxCopySize
value: '16'
- key: modernize-loop-convert.MinConfidence
value: reasonable
- key: modernize-loop-convert.NamingStyle
value: CamelCase
- key: modernize-pass-by-value.IncludeStyle
value: llvm
- key: modernize-replace-auto-ptr.IncludeStyle
value: llvm
- key: modernize-use-nullptr.NullMacros
value: 'NULL'
- key: hicpp-signed-bitwise.IgnorePositiveIntegerLiterals
value: '1'
...
================================================
FILE: .clangd
================================================
InlayHints:
Enabled: Yes
ParameterNames: No
DeducedTypes: No
Diagnostics:
UnusedIncludes: Strict
MissingIncludes: None
================================================
FILE: .devcontainer/Dockerfile.alpine
================================================
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.238.0/containers/cpp/.devcontainer/base.Dockerfile
# [Choice] Debian / Ubuntu version (use Debian 11, Ubuntu 18.04/22.04 on local arm64/Apple Silicon): debian-11, debian-10, ubuntu-22.04, ubuntu-20.04, ubuntu-18.04
ARG VARIANT="alpine"
FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT}
RUN echo "https://dl-cdn.alpinelinux.org/alpine/edge/testing/" >> /etc/apk/repositories
RUN apk update && apk upgrade && apk add --no-cache \
bash git alpine-sdk \
cmake ninja ccache libstdc++ clang clang-dev gdb \
alsa-lib-dev avahi-dev boost-dev expat-dev flac-dev jack-dev \
libvorbis-dev openssl-dev opus-dev soxr-dev
================================================
FILE: .devcontainer/Dockerfile.debian
================================================
ARG VARIANT="debian-11"
FROM mcr.microsoft.com/devcontainers/cpp:1-${VARIANT}
# [Optional] Uncomment this section to install additional packages.
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install --no-install-recommends \
build-essential cmake cmake-format ccache ninja-build python3-autopep8 clang-format \
alsa-utils avahi-daemon libasound2-dev libavahi-client-dev libboost-dev libexpat1-dev \
libflac-dev libjack-dev libopus-dev libpulse-dev libsoxr-dev libssl-dev libvorbis-dev \
libpipewire-0.3-dev libvorbisidec-dev
================================================
FILE: .devcontainer/Dockerfile.fedora
================================================
ARG VARIANT="42"
FROM fedora:${VARIANT}
# [Optional] Uncomment this section to install additional packages.
RUN dnf -y update \
&& dnf -y install @development-tools gcc-c++ libstdc++-static libatomic cmake ccache ninja-build \
alsa-lib-devel avahi-devel boost-devel expat-devel flac-devel libvorbis-devel openssl-devel \
opus-devel pipewire-jack-audio-connection-kit-devel pulseaudio-libs-devel soxr-devel \
&& dnf clean all
RUN useradd -rm -d /home/vscode -s /bin/bash -g root -u 1001 vscode
USER vscode
WORKDIR /home/vscode
================================================
FILE: .devcontainer/devcontainer.json
================================================
// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.238.0/containers/cpp
{
"name": "Snapcast-dev",
"build": {
"dockerfile": "Dockerfile.debian"
// "args": { "VARIANT": "alpine" }
},
"runArgs": ["--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"],
// Configure tool-specific properties.
"customizations": {
// Configure properties specific to VS Code.
"vscode": {
// Add the IDs of extensions you want installed when the container is created.
"extensions": [
"ms-vscode.cpptools",
"ms-vscode.cmake-tools",
"llvm-vs-code-extensions.vscode-clangd"
]
}
},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [1704, 1705, 1780],
// Use 'postCreateCommand' to run commands after the container is created.
// "postCreateCommand": "gcc -v",
// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
"remoteUser": "vscode"
}
================================================
FILE: .github/ISSUE_TEMPLATE/bug_report.md
================================================
---
name: Bug report
about: 'Report a bug'
title: ''
labels:
assignees: ''
---
**Describe the bug**
A clear and concise description of what the bug is.
**Steps to Reproduce**
1.
2.
3.
**Environment details**
- OS: [e.g. Raspbian, debian, Windows]
- Snapcast version [e.g. 0.21.0]
- Installed from a package, self compiled, ...
**Attach logfile if applicable**
Generate logs with `snapclient --logfilter debug` or `snapserver --logging.filter debug` if possible and paste them in the following codeblock
```log
# Replace this with your logs
```
================================================
FILE: .github/ISSUE_TEMPLATE/config.yml
================================================
blank_issues_enabled: true
contact_links:
- name: Ask a question
url: https://github.com/snapcast/snapcast/discussions
about: Ask questions and discuss with other community members
================================================
FILE: .github/ISSUE_TEMPLATE/feature_request.md
================================================
---
name: Feature request
about: Suggest an idea or enhancement for snapcast
title: ''
labels: feature request
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
================================================
FILE: .github/dependabot.yml
================================================
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
day: saturday
time: "10:00"
open-pull-requests-limit: 10
target-branch: develop
================================================
FILE: .github/pull_request_template.md
================================================
[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]
* * *
## Pull Request Checklist
* Contributions must be licensed under the [GPL-3.0 License](LICENSE)
* This project loosely follows the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
* For better compatibility with embedded toolchains, the used C++ standard should be limited to C++17
* Code should be formatted by running `make reformat`
* Branch from the `develop` branch and ensure it is up to date with the current `develop` branch before submitting your pull request. If it doesn't merge cleanly with `develop`, you may be asked to resolve the conflicts. Pull requests to master will be closed.
* Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
* Pull requests must not contain compiled sources (already set by the default .gitignore) or binary files
* Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. If tested manually, provide information about the test scope in the PR description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”).
* Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review before you can continue your work item.
* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review by contacting us via [email](mailto:snapcast@badaix.de).
* Post review:
* If a review requires you to change your commit(s), please test the changes again.
* Amend the affected commit(s) and force push onto your branch.
* Set respective comments in your GitHub review to resolved.
* Create a general PR comment to notify the reviewers that your amendments are ready for another round of review.
================================================
FILE: .github/workflows/ci.yml
================================================
name: CI
on:
push:
pull_request:
env:
BOOST_VERSION: 1_90_0
jobs:
static-analysis:
strategy:
fail-fast: false
matrix:
tool:
- cppcheck
- clang-tidy
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v6
- name: print environment
run: env
- name: dependencies
run: |
sudo apt-get update && \
sudo apt-get install -yq libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev \
libopus-dev alsa-utils libpulse-dev libavahi-client-dev libssl-dev \
avahi-daemon ccache expat cppcheck clang-tidy \
libpipewire-0.3-dev
- name: cache boost
id: cache-boost
uses: actions/cache@v5
with:
path: boost_${{ env.BOOST_VERSION }}
key: boost-${{ env.BOOST_VERSION }}
enableCrossOsArchive: true
- name: get boost
if: steps.cache-boost.outputs.cache-hit != 'true'
run: |
wget https://archives.boost.io/release/${BOOST_VERSION//_/.}/source/boost_${BOOST_VERSION}.tar.bz2
tar xjf boost_${BOOST_VERSION}.tar.bz2
- name: configure
run: |
cmake -S . -B build \
-DWERROR=ON -DBUILD_TESTS=OFF \
-DBOOST_ROOT=boost_${BOOST_VERSION} \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_EXPORT_COMPILE_COMMANDS=TRUE \
-DBUILD_WITH_PIPEWIRE=ON \
-DCMAKE_CXX_FLAGS="-DCMAKE_CXX_FLAGS=-DJSON_HAS_CPP_14"
- name: analysis
run: |
mkdir -p build/analysis
cmake --build build --target ${{ matrix.tool }} 2>&1 | tee build/analysis.log
- name: evaluate
run: |
WARNINGS=$(cat build/analysis.log | sort | uniq | grep -e ": warning: " | wc -l)
MAX_ALLOWED=0
echo "Analysis finished with $WARNINGS warnings, max allowed: $MAX_ALLOWED"
if [ "$WARNINGS" -gt "$MAX_ALLOWED" ]; then exit $WARNINGS; else exit 0; fi;
documentation:
# TODO: upload artifacts
strategy:
fail-fast: false
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v6
- name: print environment
run: env
- name: dependencies
run: |
sudo apt-get update && \
sudo apt-get install -yq libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev \
libopus-dev alsa-utils libpulse-dev libavahi-client-dev libssl-dev \
avahi-daemon debhelper ccache expat cppcheck doxygen graphviz \
libpipewire-0.3-dev
- name: doxygen
run: |
mkdir -p build/doxygen
doxygen 2>&1 | tee build/doxygen.log
- name: evaluate
run: |
WARNINGS=$(cat build/doxygen.log | sort | uniq | grep -e ": warning: " | wc -l)
MAX_ALLOWED=0
echo "Doxygen finished with $WARNINGS warnings, max allowed: $MAX_ALLOWED"
if [ "$WARNINGS" -gt "$MAX_ALLOWED" ]; then exit $WARNINGS; else exit 0; fi;
unit-test:
strategy:
fail-fast: false
matrix:
sanitizer:
- asan
- tsan
include:
- sanitizer: asan
param: "ASAN=ON"
- sanitizer: tsan
param: "TSAN=ON"
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v6
- name: print environment
run: env
- name: dependencies
run: |
sudo apt-get update && \
sudo apt-get install -yq libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev \
libopus-dev alsa-utils libpulse-dev libavahi-client-dev libssl-dev \
avahi-daemon ccache expat catch2 \
libpipewire-0.3-dev
- name: cache boost
id: cache-boost
uses: actions/cache@v5
with:
path: boost_${{ env.BOOST_VERSION }}
key: boost-${{ env.BOOST_VERSION }}
enableCrossOsArchive: true
- name: get boost
if: steps.cache-boost.outputs.cache-hit != 'true'
run: |
wget https://archives.boost.io/release/${BOOST_VERSION//_/.}/source/boost_${BOOST_VERSION}.tar.bz2
tar xjf boost_${BOOST_VERSION}.tar.bz2
- name: cache ccache
id: cache-ccache
uses: actions/cache@v5
with:
# TODO: use environment variable $HOME/.ccache
path: /home/runner/.ccache
key: ${{ matrix.sanitizer }}-ccache-${{ github.sha }}
restore-keys: ${{ matrix.sanitizer }}-ccache-
- name: configure
run: |
cmake -S . -B build \
-DWERROR=OFF \
-DBUILD_TESTS=ON \
-D${{ matrix.param }} \
-DBOOST_ROOT=boost_${BOOST_VERSION} \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-DCMAKE_EXPORT_COMPILE_COMMANDS=TRUE \
-DBUILD_WITH_PIPEWIRE=ON \
-DCMAKE_CXX_FLAGS="-DCMAKE_CXX_FLAGS=-DJSON_HAS_CPP_14"
- name: build
env:
# TODO: use environment variable $HOME/.ccache
CCACHE_DIR: /home/runner/.ccache
run: cmake --build build --parallel 4 --verbose
- name: unit-test
run: ./bin/snapcast_test
linux:
strategy:
fail-fast: false
matrix:
compiler:
- clang-13
- clang-14
- clang-15
- clang-16
- clang-17
- clang-18
- gcc-10
- gcc-11
- gcc-12
- gcc-13
- gcc-14
build_type:
- Debug
- Release
include:
- compiler: clang-13
cc: clang-13
cxx: clang++-13
os: ubuntu-22.04
- compiler: clang-14
cc: clang-14
cxx: clang++-14
os: ubuntu-22.04
- compiler: clang-15
cc: clang-15
cxx: clang++-15
os: ubuntu-22.04
- compiler: clang-16
cc: clang-16
cxx: clang++-16
os: ubuntu-24.04
- compiler: clang-17
cc: clang-17
cxx: clang++-17
os: ubuntu-24.04
- compiler: clang-18
cc: clang-18
cxx: clang++-18
os: ubuntu-24.04
- compiler: gcc-10
cc: gcc-10
cxx: g++-10
os: ubuntu-22.04
- compiler: gcc-11
cc: gcc-11
cxx: g++-11
os: ubuntu-22.04
- compiler: gcc-12
cc: gcc-12
cxx: g++-12
os: ubuntu-22.04
- compiler: gcc-13
cc: gcc-13
cxx: g++-13
os: ubuntu-24.04
- compiler: gcc-14
cc: gcc-14
cxx: g++-14
os: ubuntu-24.04
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: print environment
run: env
- name: dependencies
run: |
sudo apt-get update && \
sudo apt-get install -yq libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev \
libopus-dev alsa-utils libpulse-dev libjack-dev libavahi-client-dev libssl-dev libsdl2-dev \
avahi-daemon ccache expat \
libpipewire-0.3-dev
- name: cache boost
id: cache-boost
uses: actions/cache@v5
with:
path: boost_${{ env.BOOST_VERSION }}
key: boost-${{ env.BOOST_VERSION }}
enableCrossOsArchive: true
- name: get boost
if: steps.cache-boost.outputs.cache-hit != 'true'
run: |
wget https://archives.boost.io/release/${BOOST_VERSION//_/.}/source/boost_${BOOST_VERSION}.tar.bz2
tar xjf boost_${BOOST_VERSION}.tar.bz2
- name: cache ccache
id: cache-ccache
uses: actions/cache@v5
with:
# TODO: use environment variable $HOME/.ccache
path: /home/runner/.ccache
key: ${{ runner.os }}-${{ matrix.compiler }}-${{ matrix.build_type }}-ccache-${{ github.sha }}
restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-${{ matrix.build_type }}-ccache-
#- name: ccache dump config
# run: ccache -p
- name: configure
run: |
cmake -S . -B build \
-DWERROR=ON -DBUILD_TESTS=ON \
-DBOOST_ROOT=boost_${BOOST_VERSION} \
-DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_COMPILER_LAUNCHER=ccache \
-DCMAKE_EXPORT_COMPILE_COMMANDS=TRUE \
-DBUILD_WITH_PULSE=ON \
-DBUILD_WITH_JACK=ON \
-DBUILD_WITH_PIPEWIRE=ON \
-DBUILD_WITH_SDL2=ON \
-DCMAKE_CXX_FLAGS="-DCMAKE_CXX_FLAGS=-DJSON_HAS_CPP_14"
env:
CC: ${{ matrix.cc }}
CXX: ${{ matrix.cxx }}
- name: build
env:
# TODO: use environment variable $HOME/.ccache
CCACHE_DIR: /home/runner/.ccache
run: cmake --build build --parallel 3 --verbose
macos:
strategy:
fail-fast: false
matrix:
xcode:
- "15.0"
- "15.1"
- "15.2"
- "15.3"
- "15.4"
- "16.0"
- "16.1"
- "16.2"
- "16.3"
- "16.4"
- "26.0"
- "26.1"
build_type:
- Debug
- Release
include:
- xcode: "15.0"
os: macos-14
- xcode: "15.1"
os: macos-14
- xcode: "15.2"
os: macos-14
- xcode: "15.3"
os: macos-14
- xcode: "15.4"
os: macos-14
- xcode: "16.0"
os: macos-15
- xcode: "16.1"
os: macos-15
- xcode: "16.2"
os: macos-15
- xcode: "16.3"
os: macos-15
- xcode: "16.4"
os: macos-15
- xcode: "26.0"
os: macos-15
- xcode: "26.1"
os: macos-15
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: print environment
run: env
- name: dependencies
run: |
brew update-if-needed
brew install libsoxr flac libvorbis opus catch2 boost
- name: configure
run: |
cmake -S . -B build \
-DWERROR=ON -DBUILD_TESTS=ON \
-DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
-DCMAKE_CXX_FLAGS="-I/usr/local/include -DCMAKE_CXX_FLAGS=-DJSON_HAS_CPP_14"
env:
DEVELOPER_DIR: /Applications/Xcode_${{ matrix.xcode }}.app/Contents/Developer
- name: build
run: cmake --build build --parallel 3 --verbose
windows:
strategy:
fail-fast: false
matrix:
compiler:
# - vs-16
- vs-17
build_type:
- Debug
- Release
include:
# - compiler: vs-16
# os: windows-2019
# vs: "Visual Studio 16 2019"
- compiler: vs-17
os: windows-2022
vs: "Visual Studio 17 2022"
runs-on: ${{ matrix.os }}
steps:
- uses: actions/checkout@v6
- name: cache dependencies
id: cache-dependencies
uses: actions/cache@v5
with:
#path: ${VCPKG_INSTALLATION_ROOT}\installed
path: c:\vcpkg\installed
key: ${{ runner.os }}-${{ matrix.compiler }}-${{ matrix.build_type }}-ccache-${{ github.sha }}
restore-keys: ${{ runner.os }}-${{ matrix.compiler }}-${{ matrix.build_type }}-ccache-
- name: dependencies
if: steps.cache-dependencies.outputs.cache-hit != 'true'
run: |
cd c:\vcpkg
git pull
vcpkg.exe update
vcpkg.exe --triplet x64-windows install libflac libvorbis soxr opus openssl boost-asio boost-beast catch2
- name: configure
run: |
echo vcpkg installation root: ${env:VCPKG_INSTALLATION_ROOT}
cmake -S . -B build -G "${{ matrix.vs }}" `
-DWERROR=ON -DBUILD_TESTS=ON `
-DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" `
-DVCPKG_TARGET_TRIPLET="x64-windows" `
-DCMAKE_BUILD_TYPE=${{ matrix.build_type }} `
-DREVISION="${{ github.sha }}"
- name: build
run: cmake --build build --parallel 3 --verbose
================================================
FILE: .github/workflows/package.yml
================================================
name: Package
run-name: Package ${{ github.sha }} by @${{ github.actor }}
on:
workflow_dispatch:
permissions:
contents: write
env:
BOOST_VERSION: 1_90_0
SNAPWEB_VERSION: v0.9.2
jobs:
release:
runs-on: ubuntu-latest
name: Create release
outputs:
tag: ${{ steps.draft_release.outputs.tag }}
steps:
- name: Get dependencies
run: sudo apt-get update && sudo apt-get install -yq python3
env:
DEBIAN_FRONTEND: noninteractive
- name: Checkout
uses: actions/checkout@v6
- name: Create release notes
run: $GITHUB_WORKSPACE/extras/changelog_current_version.py $GITHUB_WORKSPACE/changelog.md > $GITHUB_WORKSPACE/changelog_current.md
- name: Create draft release
id: draft_release
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
URL=$( \
gh release create v0.0.0 \
--draft \
--repo="$GITHUB_REPOSITORY" \
--title="Snapcast v${{ github.sha }}" \
--notes-file changelog_current.md \
)
echo "tag=$(basename $URL)" >> $GITHUB_OUTPUT
deb:
needs: release
strategy:
fail-fast: false
matrix:
debian:
- bullseye
- bookworm
- trixie
arch:
- amd64
- armhf
- arm64
include:
- arch: "amd64"
os: ubuntu-latest
image_prefix: "debian:"
- arch: "armhf"
os: self-hosted-rpi4
image_prefix: "badaix/raspios-lite:"
- arch: "arm64"
os: self-hosted-rpi5
image_prefix: "badaix/raspios-lite:"
runs-on: ${{ matrix.os }}
name: deb (${{ matrix.arch }}, ${{ matrix.debian }})
timeout-minutes: 240
container:
image: ${{matrix.image_prefix}}${{matrix.debian}}
steps:
- name: Get dependencies
run: |
sed -i -e 's/MODULES=dep/MODULES=most/g' /etc/initramfs-tools/initramfs.conf || true
apt-get update && \
apt-get install -yq wget debhelper build-essential cmake git rename \
libatomic1 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev \
libopus-dev alsa-utils libpulse-dev libavahi-client-dev avahi-daemon libexpat1-dev \
libssl-dev libpipewire-0.3-dev python3 ccache unzip debhelper
env:
DEBIAN_FRONTEND: noninteractive
- name: Get GitHub cli
run: |
(type -p wget >/dev/null || (apt update && apt-get install wget -y)) \
&& mkdir -p -m 755 /etc/apt/keyrings \
&& wget -qO- https://cli.github.com/packages/githubcli-archive-keyring.gpg | tee /etc/apt/keyrings/githubcli-archive-keyring.gpg > /dev/null \
&& chmod go+r /etc/apt/keyrings/githubcli-archive-keyring.gpg \
&& echo "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
&& apt update \
&& apt install gh -y
- name: Checkout
uses: actions/checkout@v6
- name: Setup environment
run: |
echo "PARENT_DIR=$(dirname $GITHUB_WORKSPACE)" >> $GITHUB_ENV
BOOST_DOT_VERSION=$(echo ${BOOST_VERSION} | sed 's/_/./g')
echo "BOOST_DOT_VERSION=$BOOST_DOT_VERSION" >> $GITHUB_ENV
echo "BOOST=boost_${BOOST_VERSION}" >> $GITHUB_ENV
ln -s extras/package/debian debian
- name: Create changelog
run: |
$GITHUB_WORKSPACE/debian/changelog_md2deb.py $GITHUB_WORKSPACE/changelog.md > $GITHUB_WORKSPACE/debian/changelog
cat $GITHUB_WORKSPACE/debian/changelog
- name: Clean up
run: rm -rf ${{env.PARENT_DIR}}/snap*_*.deb
- name: Cache boost
id: cache-boost
uses: actions/cache@v5
with:
path: ${{env.BOOST}}
key: ${{env.BOOST}}
- name: Get boost
if: steps.cache-boost.outputs.cache-hit != 'true'
run: |
wget https://archives.boost.io/release/${{env.BOOST_DOT_VERSION}}/source/${{env.BOOST}}.tar.bz2
tar xjf ${{env.BOOST}}.tar.bz2
- name: cache ccache
id: cache-ccache
uses: actions/cache@v5
with:
# TODO: use environment variable $HOME/.ccache
path: /home/runner/.ccache
key: ${{ matrix.os }}-${{ matrix.debian }}-ccache-${{ github.sha }}
restore-keys: ${{ matrix.os }}-${{ matrix.debian }}-ccache-
- name: Get Snapweb
run: |
wget https://github.com/snapcast/snapweb/releases/download/${SNAPWEB_VERSION}/snapweb.zip
unzip snapweb.zip -d snapweb
- name: Create deb package
env:
# TODO: use environment variable $HOME/.ccache
CCACHE_DIR: /home/runner/.ccache
run: |
fakeroot make -f debian/rules CMAKEFLAGS="-DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DBOOST_ROOT=$GITHUB_WORKSPACE/${{env.BOOST}} -DCMAKE_BUILD_TYPE:STRING=Release -DREVISION=${{ github.sha }} -DSNAPWEB_DIR:STRING=$GITHUB_WORKSPACE/snapweb" binary
rename 's/_${{ matrix.arch }}/_${{ matrix.arch }}_${{ matrix.debian }}/g' ../snap*_${{ matrix.arch }}.deb
fakeroot make -f debian/rules clean
fakeroot make -f debian/rules CMAKEFLAGS="-DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DBOOST_ROOT=$GITHUB_WORKSPACE/${{env.BOOST}} -DCMAKE_BUILD_TYPE:STRING=Release -DREVISION=${{ github.sha }} -DBUILD_WITH_PULSE=ON -DSNAPWEB_DIR:STRING=$GITHUB_WORKSPACE/snapweb" binary
rm ../snapserver_*_${{ matrix.arch }}.deb
rename 's/_${{ matrix.arch }}/_${{ matrix.arch }}_${{ matrix.debian }}_with-pulse/g' ../snap*_${{ matrix.arch }}.deb
fakeroot make -f debian/rules clean
fakeroot make -f debian/rules CMAKEFLAGS="-DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DBOOST_ROOT=$GITHUB_WORKSPACE/${{env.BOOST}} -DCMAKE_BUILD_TYPE:STRING=Release -DREVISION=${{ github.sha }} -DBUILD_WITH_PIPEWIRE=ON -DSNAPWEB_DIR:STRING=$GITHUB_WORKSPACE/snapweb" binary
rename 's/_${{ matrix.arch }}/_${{ matrix.arch }}_${{ matrix.debian }}_with-pipewire/g' ../snap*_${{ matrix.arch }}.deb
- name: Release artifacts
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config --global --add safe.directory $GITHUB_WORKSPACE
gh release upload ${{needs.release.outputs.tag}} ${{env.PARENT_DIR}}/snap*_*.deb
win:
needs: release
runs-on: windows-2022
name: win
steps:
- name: Checkout
uses: actions/checkout@v6
- name: Checkout Snapcast
uses: actions/checkout@v6
with:
repository: snapcast/snapcast
path: src/snapcast
ref: ${{ env.VERSION }}
- name: Cache dependencies
id: cache-dependencies
uses: actions/cache@v5
with:
#path: ${VCPKG_INSTALLATION_ROOT}\installed
path: c:\vcpkg\installed
key: ${{ runner.os }}-dependencies
- name: Get dependenciesenv
if: steps.cache-dependencies.outputs.cache-hit != 'true'
run: vcpkg.exe install libflac libvorbis soxr opus openssl boost-asio boost-beast --triplet x64-windows
- name: configure
run: |
echo vcpkg installation root: $env:VCPKG_INSTALLATION_ROOT
cmake -S . -B build -G "Visual Studio 17 2022" -DCMAKE_TOOLCHAIN_FILE="$env:VCPKG_INSTALLATION_ROOT/scripts/buildsystems/vcpkg.cmake" -DVCPKG_TARGET_TRIPLET="x64-windows" -DCMAKE_BUILD_TYPE="Release" -DREVISION="${{ github.sha }}" -DWERROR=ON
- name: build
run: cmake --build build --config Release --parallel 3 --verbose
- name: installer
run: |
mkdir bundle
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\FLAC.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\ogg.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\opus.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\vorbis.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\soxr.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\libcrypto-3-x64.dll bundle\
copy ${env:VCPKG_INSTALLATION_ROOT}\installed\x64-windows\bin\libssl-3-x64.dll bundle\
copy "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Redist\MSVC\v143\vc_redist.x64.exe" bundle\
copy bin\Release\snapclient.exe bundle\
Compress-Archive -Path bundle\* -Destination snapclient_win64.zip
- name: Release artifacts
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config --global --add safe.directory .
gh release upload ${{needs.release.outputs.tag}} snapclient_win64.zip
# mac:
# strategy:
# fail-fast: false
# matrix:
# xcode: ['11']
# runs-on: macos-latest
# name: mac (xcode ${{ matrix.xcode }})
# steps:
# - name: Checkout
# uses: actions/checkout@v6
# - name: Checkout Snapcast
# uses: actions/checkout@v6
# with:
# repository: snapcast/snapcast
# path: src/snapcast
# ref: ${{ env.VERSION }}
# - name: Setup environment
# run: |
# BOOST_DOT_VERSION=$(echo ${BOOST_VERSION} | sed 's/_/./g')
# echo "BOOST_DOT_VERSION=$BOOST_DOT_VERSION" >> $GITHUB_ENV
# echo "BOOST=boost_${BOOST_VERSION}" >> $GITHUB_ENV
# - name: Get dependencies
# run: brew install pkgconfig libsoxr ccache expat
# - name: Cache boost
# id: cache-boost
# uses: actions/cache@v5
# with:
# path: ${{env.BOOST}}
# key: ${{ runner.os }}-boost
# - name: Get boost
# if: steps.cache-boost.outputs.cache-hit != 'true'
# run: |
# wget https://boostorg.jfrog.io/artifactory/main/release/${{env.BOOST_DOT_VERSION}}/source/${{env.BOOST}}.tar.bz2
# tar xjf ${{env.BOOST}}.tar.bz2
# - name: Cache ccache
# id: cache-ccache
# uses: actions/cache@v5
# with:
# path: /Users/runner/.ccache
# key: ${{ runner.os }}-ccache-${{ github.sha }}
# restore-keys: ${{ runner.os }}-ccache-
# #- name: ccache dump config
# # run: ccache -p
# - name: configure
# run: cmake -S $GITHUB_WORKSPACE/src/snapcast -B build -DBOOST_ROOT=$GITHUB_WORKSPACE/${{env.BOOST}} -DCMAKE_BUILD_TYPE=Release -DREVISION=${{ github.sha }} -DWERROR=ON -DCMAKE_CXX_COMPILER_LAUNCHER=ccache -DCMAKE_CXX_FLAGS="-I/usr/local/include -Wno-deprecated-declarations"
# - name: build
# run: cmake --build build --parallel 3
# rpm:
# if: ${{ false }} # disable for now
# strategy:
# fail-fast: false
# matrix:
# image:
# - 34
# - 35
# os:
# - ubuntu-latest
# - self-hosted-rpi4
# include:
# - os: ubuntu-latest
# arch: "x86_64"
# - os: self-hosted-rpi4
# arch: "armv7hl"
# runs-on: ${{ matrix.os }}
# name: rpm (${{ matrix.arch }}, fedora ${{ matrix.image }})
# container:
# image: fedora:${{matrix.image}}
# steps:
# - name: Get dependencies
# run: dnf -y update && dnf -y install wget git rpm-build gcc-c++ cmake boost-devel alsa-lib-devel avahi-devel libatomic libvorbis-devel opus-devel pulseaudio-libs-devel flac-devel soxr-devel libstdc++-static expat-devel
# - name: Checkout
# uses: actions/checkout@v6
# - name: Checkout Snapcast
# uses: actions/checkout@v6
# with:
# repository: snapcast/snapcast
# path: src/snapcast
# ref: ${{ env.VERSION }}
# - name: Create rpm package
# run: |
# mkdir -p ~/rpmbuild/{BUILD,BUILDROOT,RPMS,SOURCES,SPECS,SRPMS}
# cp rpm/* ~/rpmbuild/SOURCES/
# tar -C $GITHUB_WORKSPACE/src/ -czvf ~/rpmbuild/SOURCES/snapcast.tar.gz snapcast
# rpmbuild --nodebuginfo --define '_reversion ${{ github.sha }}' --define '_version ${{ env.VERSION }}' -bb ~/rpmbuild/SOURCES/snapcast.spec
# - name: Archive artifacts
# uses: actions/upload-artifact@v4
# with:
# name: snapcast_${{ matrix.arch }}-fedora-${{matrix.image}}-${{ github.sha }}
# path: ~/rpmbuild/RPMS/${{ matrix.arch }}/snap*.rpm
================================================
FILE: .gitignore
================================================
# Compiled Object files
*.slo
*.lo
*.o
*.obj
# Precompiled Headers
*.gch
*.pch
# Compiled Dynamic libraries
*.so
*.dylib
*.dll
# Fortran module files
*.mod
# Compiled Static libraries
*.lai
*.la
*.a
*.lib
# Executables
*.exe
*.out
*.app
*.*~
client/snapclient
server/snapserver
.vscode
GPATH
GRTAGS
GTAGS
build
bin
android/.idea
android/Snapcast/release
# debian packages
debian/.debhelper
debian/snapclient
debian/snapserver
debian/debhelper-build-stamp
debian/snapclient.debhelper.log
debian/snapserver.debhelper.log
debian/files
debian/snapclient.postinst.debhelper
debian/snapclient.postrm.debhelper
debian/snapclient.prerm.debhelper
debian/snapclient.substvars
debian/snapserver.postinst.debhelper
debian/snapserver.postrm.debhelper
debian/snapserver.prerm.debhelper
debian/snapserver.substvars
debian/tmp
obj-x86_64-linux-gnu
# clangd
.cache
compile_commands.json
# misc
notes.txt
sanitizer-suppressions.txt
snapserver.conf
certs
server/etc/certs
extras/package/debian/snap*.debhelper.log
================================================
FILE: CMakeLists.txt
================================================
cmake_minimum_required(VERSION 3.14)
# find_package() uses uppercase <PackageName>_ROOT variables.
if(POLICY CMP0144)
cmake_policy(SET CMP0144 NEW)
endif()
# The FindBoost module is removed. CI is failing, maybe because it uses just the
# downloaded headers without being installed if(POLICY CMP0167) cmake_policy(SET
# CMP0167 NEW) endif()
project(
snapcast
LANGUAGES CXX
VERSION 0.35.0)
set(PROJECT_DESCRIPTION "Multiroom client-server audio player")
set(PROJECT_URL "https://github.com/snapcast/snapcast")
option(BUILD_SHARED_LIBS "Build snapcast in a shared context" ON)
option(BUILD_STATIC_LIBS "Build snapcast in a static context" ON)
option(BUILD_TESTS "Build tests (in test/snapcast_test)" OFF)
option(WERROR "Treat warnings as errors" OFF)
option(ASAN "Enable AddressSanitizer" OFF)
option(TSAN "Enable ThreadSanitizer" OFF)
option(UBSAN "Enable UndefinedBehaviorSanitizer" OFF)
option(TIDY "Enable clang tidy" OFF)
if(REVISION)
add_compile_definitions(REVISION=\"${REVISION}\")
endif()
if(TIDY)
find_program(CLANG_TIDY "clang-tidy")
if(CLANG_TIDY)
set(CMAKE_CXX_CLANG_TIDY "clang-tidy")
endif()
endif()
if(${CMAKE_SYSTEM_NAME} MATCHES "Darwin")
set(MACOSX TRUE)
elseif(${CMAKE_SYSTEM_NAME} MATCHES "FreeBSD")
set(FREEBSD TRUE)
if(BUILD_CLIENT)
message(
FATAL_ERROR
"Snapclient not yet supported for FreeBSD, use \"-DBUILD_CLIENT=OFF\"")
endif()
elseif(${CMAKE_SYSTEM_NAME} MATCHES "Android")
set(ANDROID TRUE)
endif()
if(MSVC)
# warning level 4 and all warnings as errors warning C4505: 'getArch':
# unreferenced local function has been removed warning C4458: declaration of
# 'size' hides class member warning C4459: declaration of 'query' hides global
# declaration
add_compile_options(/W4 /wd4458 /wd4459 /wd4505)
if(WERROR)
add_compile_options(/WX)
endif()
else()
# lots of warnings and all warnings as errors
add_compile_options(-Wall -Wextra -pedantic -Wno-unused-function)
if(MACOSX)
add_compile_options(-Wno-deprecated-declarations)
add_compile_options(
# From CoreAudioTypes.framework
-Wno-nullability-extension
# From IOKit.framework
-Wno-zero-length-array
# From CoreFoundation.framework
-Wno-gnu-zero-variadic-macro-arguments
# Boost ... although includedd as system header
-Wno-unused-parameter)
endif()
if(WERROR)
add_compile_options(-Werror)
endif()
if(ASAN)
add_compile_options(-fsanitize=address -g)
add_link_options(-fsanitize=address)
endif()
if(TSAN)
add_compile_options(-fsanitize=thread)
add_link_options(-fsanitize=thread)
endif()
if(UBSAN)
add_compile_options(-fsanitize=undefined)
add_link_options(-fsanitize=undefined)
endif()
endif()
include(GNUInstallDirs)
include(${CMAKE_SOURCE_DIR}/cmake/clang-tidy.cmake)
include(${CMAKE_SOURCE_DIR}/cmake/cppcheck.cmake)
include(${CMAKE_SOURCE_DIR}/cmake/reformat.cmake)
if(NOT WIN32)
option(BUILD_SERVER "Build Snapserver" ON) # no Windows server for now
endif()
option(BUILD_CLIENT "Build Snapclient" ON)
option(BUILD_WITH_SSL "Build with SSL support" ON)
option(BUILD_WITH_ALSA "Build with ALSA support" ON)
option(BUILD_WITH_FLAC "Build with FLAC support" ON)
option(BUILD_WITH_VORBIS "Build with VORBIS support" ON)
option(BUILD_WITH_TREMOR "Build with vorbis using TREMOR" OFF)
option(BUILD_WITH_OPUS "Build with OPUS support" ON)
option(BUILD_WITH_AVAHI "Build with AVAHI support" ON)
option(BUILD_WITH_EXPAT "Build with EXPAT support" ON)
option(BUILD_WITH_PULSE "Build with PulseAudio support" OFF)
option(BUILD_WITH_JACK "Build with JACK support" OFF)
option(BUILD_WITH_PIPEWIRE "Build with PipeWire support" OFF)
option(BUILD_WITH_SDL2 "Build with SDL2 support" OFF)
if(NOT BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS)
message(
FATAL_ERROR
"One or both of BUILD_SHARED_LIBS or BUILD_STATIC_LIBS must be set to ON to build"
)
endif()
if(NOT BUILD_CLIENT AND NOT BUILD_SERVER)
message(
FATAL_ERROR
"One or both of BUILD_CLIENT or BUILD_SERVER must be set to ON to build")
endif()
# Configure paths
if(NOT DEFINED CMAKE_INSTALL_BINDIR)
set(CMAKE_INSTALL_BINDIR
bin
CACHE PATH "Output directory for binary files")
endif()
if(NOT DEFINED CMAKE_INSTALL_LIBDIR)
set(CMAKE_INSTALL_LIBDIR
lib
CACHE PATH "Output directory for libraries")
endif()
if(NOT DEFINED CMAKE_INSTALL_INCLUDEDIR)
set(CMAKE_INSTALL_INCLUDEDIR
include
CACHE PATH "Output directory for header files")
endif()
set(INCLUDE_DIRS "${CMAKE_SOURCE_DIR}" "${CMAKE_INSTALL_INCLUDEDIR}")
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} "${CMAKE_SOURCE_DIR}/cmake/")
add_compile_definitions(VERSION="${PROJECT_VERSION}")
if(NOT ANDROID)
set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${CMAKE_BINARY_DIR})
set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${CMAKE_SOURCE_DIR}/bin)
endif()
# Configure compiler options
set(CMAKE_CXX_STANDARD 17)
include(${CMAKE_SOURCE_DIR}/cmake/TargetArch.cmake)
target_architecture(HOST_ARCH)
# message(STATUS "System name: ${CMAKE_SYSTEM_NAME}")
message(STATUS "Architecture: ${HOST_ARCH}")
# message(STATUS "System processor: ${CMAKE_SYSTEM_PROCESSOR}")
if(ARCH)
message(STATUS "Using arch: ${ARCH}")
set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -march=${ARCH}")
endif()
include(CheckAtomic)
include(TestBigEndian)
test_big_endian(BIGENDIAN)
if(${BIGENDIAN})
add_compile_definitions(IS_BIG_ENDIAN)
endif(${BIGENDIAN})
# Check dependencies
if(NOT WIN32) # no PkgConfig on Windows...
find_package(PkgConfig REQUIRED)
endif()
find_package(Threads REQUIRED)
include(CMakePushCheckState)
include(CheckIncludeFileCXX)
include_directories(${INCLUDE_DIRS})
include(${CMAKE_SOURCE_DIR}/cmake/CheckCXX11StringSupport.cmake)
check_cxx11_string_support(HAS_CXX11_STRING_SUPPORT)
if(NOT HAS_CXX11_STRING_SUPPORT)
add_compile_definitions(NO_CPP11_STRING)
endif()
if(NOT WIN32 AND NOT ANDROID)
if(MACOSX)
set(BONJOUR_FOUND true)
if(BONJOUR_FOUND)
add_compile_definitions(HAS_BONJOUR HAS_MDNS)
endif(BONJOUR_FOUND)
add_compile_definitions(FREEBSD MACOS HAS_DAEMON)
link_directories("/usr/local/lib")
list(APPEND INCLUDE_DIRS "/usr/local/include")
else()
include(FindPkgConfig)
if(BUILD_WITH_ALSA)
pkg_search_module(ALSA REQUIRED alsa)
add_compile_definitions(HAS_ALSA)
endif(BUILD_WITH_ALSA)
if(BUILD_WITH_JACK)
pkg_check_modules(JACK REQUIRED jack)
# message(STATUS "Using JACK_LINK_LIBRARIES: ${JACK_LINK_LIBRARIES}")
# message(STATUS "Using JACK_INCLUDE_DIRS: ${JACK_INCLUDE_DIRS}")
add_compile_definitions(HAS_JACK)
endif(BUILD_WITH_JACK)
if(BUILD_WITH_PULSE)
pkg_search_module(PULSE REQUIRED libpulse)
add_compile_definitions(HAS_PULSE)
endif(BUILD_WITH_PULSE)
if(BUILD_WITH_PIPEWIRE)
pkg_search_module(PIPEWIRE REQUIRED libpipewire-0.3>=0.3.19)
add_compile_definitions(HAS_PIPEWIRE)
endif(BUILD_WITH_PIPEWIRE)
if(BUILD_WITH_SDL2)
# Find SDL2
find_package(PkgConfig REQUIRED)
pkg_check_modules(SDL2 REQUIRED sdl2)
add_compile_definitions(HAS_SDL2)
endif(BUILD_WITH_SDL2)
if(BUILD_WITH_AVAHI)
pkg_search_module(AVAHI REQUIRED avahi-client)
add_compile_definitions(HAS_AVAHI HAS_MDNS)
endif(BUILD_WITH_AVAHI)
add_compile_definitions(HAS_DAEMON)
if(FREEBSD)
add_compile_definitions(FREEBSD)
link_directories("/usr/local/lib")
list(APPEND INCLUDE_DIRS "/usr/local/include")
endif()
endif()
pkg_search_module(SOXR soxr)
if(SOXR_FOUND)
add_compile_definitions(HAS_SOXR)
else()
message(STATUS "soxr not found")
endif(SOXR_FOUND)
if(BUILD_WITH_FLAC)
pkg_search_module(FLAC REQUIRED flac)
add_compile_definitions(HAS_FLAC)
endif()
if(BUILD_WITH_VORBIS OR BUILD_WITH_TREMOR)
pkg_search_module(OGG REQUIRED ogg)
add_compile_definitions(HAS_OGG)
endif()
if(BUILD_WITH_VORBIS)
pkg_search_module(VORBIS vorbis)
if(VORBIS_FOUND)
add_compile_definitions(HAS_VORBIS)
endif(VORBIS_FOUND)
endif()
if(BUILD_WITH_TREMOR)
pkg_search_module(TREMOR vorbisidec)
if(TREMOR_FOUND)
add_compile_definitions(HAS_TREMOR)
endif(TREMOR_FOUND)
endif()
if((BUILD_WITH_VORBIS OR BUILD_WITH_TREMOR)
AND NOT VORBIS_FOUND
AND NOT TREMOR_FOUND)
message(STATUS "tremor and vorbis not found")
endif()
if(BUILD_WITH_VORBIS)
pkg_search_module(VORBISENC REQUIRED vorbisenc)
add_compile_definitions(HAS_VORBIS_ENC)
endif()
if(BUILD_WITH_OPUS)
pkg_search_module(OPUS REQUIRED opus)
add_compile_definitions(HAS_OPUS)
endif()
if(BUILD_WITH_EXPAT)
pkg_search_module(EXPAT REQUIRED expat)
add_compile_definitions(HAS_EXPAT)
endif()
endif()
if(NOT ANDROID)
find_package(Boost 1.74 REQUIRED)
else()
find_package(oboe REQUIRED CONFIG)
find_package(flac REQUIRED CONFIG)
find_package(ogg REQUIRED CONFIG)
find_package(opus REQUIRED CONFIG)
find_package(soxr REQUIRED CONFIG)
find_package(tremor REQUIRED CONFIG)
find_package(boost REQUIRED CONFIG)
add_compile_definitions(HAS_OBOE)
add_compile_definitions(HAS_OPENSL)
add_compile_definitions(HAS_FLAC)
add_compile_definitions(HAS_OGG)
add_compile_definitions(HAS_OPUS)
add_compile_definitions(HAS_SOXR)
add_compile_definitions(HAS_TREMOR)
endif()
if(BUILD_WITH_SSL)
if(ANDROID)
find_package(openssl REQUIRED CONFIG)
add_compile_definitions(HAS_OPENSSL)
else()
find_package(OpenSSL REQUIRED)
add_compile_definitions(HAS_OPENSSL)
endif()
# set OPENSSL_FOUND to TRUE for Android compatibility
set(OPENSSL_FOUND TRUE)
endif()
add_compile_definitions(BOOST_ERROR_CODE_HEADER_ONLY BOOST_ASIO_NO_TS_EXECUTORS
BOOST_PROCESS_VERSION=1)
if(WIN32)
include(FindPackageHandleStandardArgs)
set(CMAKE_FIND_LIBRARY_SUFFIXES .lib .a ${CMAKE_FIND_LIBRARY_SUFFIXES})
find_path(FLAC_INCLUDE_DIRS FLAC/all.h)
find_library(FLAC_LIBRARIES FLAC)
find_package_handle_standard_args(FLAC REQUIRED FLAC_INCLUDE_DIRS
FLAC_LIBRARIES)
find_path(OGG_INCLUDE_DIRS ogg/ogg.h)
find_library(OGG_LIBRARIES ogg)
find_package_handle_standard_args(Ogg REQUIRED OGG_INCLUDE_DIRS OGG_LIBRARIES)
find_path(VORBIS_INCLUDE_DIRS vorbis/vorbisenc.h)
find_library(VORBIS_LIBRARIES vorbis)
find_package_handle_standard_args(Vorbis REQUIRED VORBIS_INCLUDE_DIRS
VORBIS_LIBRARIES)
find_path(OPUS_INCLUDE_DIRS opus/opus.h)
find_library(OPUS_LIBRARIES opus)
find_package_handle_standard_args(Opus REQUIRED OPUS_INCLUDE_DIRS
OPUS_LIBRARIES)
find_path(SOXR_INCLUDE_DIRS soxr.h)
find_library(SOXR_LIBRARIES soxr)
find_package_handle_standard_args(Soxr REQUIRED SOXR_INCLUDE_DIRS
SOXR_LIBRARIES)
add_compile_definitions(
NTDDI_VERSION=0x06020000
_WIN32_WINNT=0x0602
WINVER=0x0602
WINDOWS
WIN32_LEAN_AND_MEAN
UNICODE
# _UNICODE
_CRT_SECURE_NO_WARNINGS)
add_compile_definitions(
HAS_OGG
HAS_VORBIS
HAS_FLAC
HAS_VORBIS_ENC
HAS_OPUS
HAS_WASAPI
HAS_SOXR)
endif()
list(APPEND CMAKE_REQUIRED_INCLUDES "${INCLUDE_DIRS}")
# include(${CMAKE_SOURCE_DIR}/cmake/SystemdService.cmake)
add_subdirectory(common)
if(BUILD_SERVER)
add_subdirectory(server)
endif()
if(BUILD_CLIENT)
add_subdirectory(client)
endif()
if(BUILD_TESTS)
add_subdirectory(test)
endif(BUILD_TESTS)
================================================
FILE: CONTRIBUTING.md
================================================
# Contributing
## Engaging in Our Project
You can contribute in several ways:
* Contribute code for new features, bugfixes, or documentation (see below)
* Help testing the latest features. Nightly builds are available in [Actions](https://github.com/snapcast/snapcast/actions)
* Star the project
* Donate on [PayPal](https://www.paypal.me/badaix)
* Spread the word: blog about Snapcast, tell your friends ...
We use GitHub to manage reviews of pull requests.
* If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
* Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
* The team will review the issue and decide whether it should be implemented as a Pull Request. In that case, they will assign the issue to you. If the team decides against picking up the issue, it will be closed with a proper explanation.
## Steps to Contribute
Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.
Only start working on the Pull Request after the team assigned the issue to you to avoid unnecessary efforts.
If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.
We kindly ask you to follow the [Pull Request Checklist](#pull-request-checklist) to ensure reviews can happen accordingly.
## Contributing Code
You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.
Only start working on the Pull Request after the team assigned the issue to you to avoid unnecessary efforts.
Please note that Snapweb related contributions should be made in the [Snapweb project](https://github.com/snapcast/snapweb).
The following rule governs code contributions:
* Contributions must be licensed under the [GPL-3.0 License](LICENSE)
* This project loosely follows the [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html)
* For better compatibility with embedded toolchains, the used C++ standard should be limited to C++17
* Code should be formatted by running `make reformat`
## Contributing Documentation
You are welcome to contribute documentation to the project.
The following rule governs documentation contributions:
* Contributions must be licensed under the same license as code, the [GPL-3.0 License](LICENSE)
## Pull Request Checklist
* Branch from the `develop` branch and ensure it is up to date with the current `develop` branch before submitting your pull request. If it doesn't merge cleanly with `develop`, you may be asked to resolve the conflicts. Pull requests to master will be closed.
* Commits should be as small as possible while ensuring that each commit is correct independently (i.e., each commit should compile and pass tests).
* Pull requests must not contain compiled sources (already set by the default .gitignore) or binary files
* Test your changes as thoroughly as possible before you commit them. Preferably, automate your test by unit/integration tests. If tested manually, provide information about the test scope in the PR description (e.g. “Test passed: Upgrade version from 0.42 to 0.42.23.”).
* Create _Work In Progress [WIP]_ pull requests only if you need clarification or an explicit review before you can continue your work item.
* If your patch is not getting reviewed or you need a specific person to review it, you can @-reply a reviewer asking for a review in the pull request or a comment, or you can ask for a review by contacting us via [email](mailto:snapcast@badaix.de).
* Post review:
* If a review requires you to change your commit(s), please test the changes again.
* Amend the affected commit(s) and force push onto your branch.
* Set respective comments in your GitHub review to resolved.
* Create a general PR comment to notify the reviewers that your amendments are ready for another round of review.
## Issues and Planning
* We use GitHub issues to track bugs and enhancement requests.
* Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.
* Attach a log file (preferably inline as code block) if necessary. Use `debug` log level (`snapclient --logfilter debug`, `snapserver --logging.filter debug`).
* Please apply one or more applicable [labels](https://github.com/snapcast/snapcast/labels) to your issue so that all community members are able to cluster the issues better.
================================================
FILE: Doxyfile
================================================
# Doxyfile 1.9.8
# 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 (\" \").
#
# Note:
#
# Use doxygen to compare the used configuration file with the template
# configuration file:
# doxygen -x [configFile]
# Use doxygen to compare the used configuration file with the template
# configuration file without replacing the environment variables or CMake type
# replacement variables:
# doxygen -x_noenv [configFile]
#---------------------------------------------------------------------------
# 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 = "My Project"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version
# control system is used.
PROJECT_NUMBER =
# Using the PROJECT_BRIEF tag one can provide an optional one line description
# for a project that appears at the top of each page and should give viewer a
# quick idea about the purpose of the project. Keep the description short.
PROJECT_BRIEF =
# With the PROJECT_LOGO tag one can specify a logo or an icon that is included
# in the documentation. The maximum height of the logo should not exceed 55
# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy
# the logo to the output directory.
PROJECT_LOGO =
# 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 = build/doxgen/
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 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. Adapt CREATE_SUBDIRS_LEVEL to
# control the number of sub-directories.
# The default value is: NO.
CREATE_SUBDIRS = NO
# Controls the number of sub-directories that will be created when
# CREATE_SUBDIRS tag is set to YES. Level 0 represents 16 directories, and every
# level increment doubles the number of directories, resulting in 4096
# directories at level 8 which is the default and also the maximum value. The
# sub-directories are organized in 2 levels, the first level always has a fixed
# number of 16 directories.
# Minimum value: 0, maximum value: 8, default value: 8.
# This tag requires that the tag CREATE_SUBDIRS is set to YES.
CREATE_SUBDIRS_LEVEL = 8
# 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, Bulgarian,
# Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, English
# (United States), Esperanto, Farsi (Persian), Finnish, French, German, Greek,
# Hindi, Hungarian, Indonesian, Italian, Japanese, Japanese-en (Japanese with
# English messages), Korean, Korean-en (Korean with English messages), Latvian,
# Lithuanian, Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese,
# Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish,
# Swedish, Turkish, Ukrainian and Vietnamese.
# The default value is: English.
OUTPUT_LANGUAGE = English
# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member
# descriptions after the members that are listed in the file and class
# documentation (similar to Javadoc). Set to NO to disable this.
# The default value is: YES.
BRIEF_MEMBER_DESC = YES
# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief
# description of a member or function before the detailed description
#
# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the
# brief descriptions will be completely suppressed.
# The default value is: YES.
REPEAT_BRIEF = YES
# This tag implements a quasi-intelligent brief description abbreviator that is
# used to form the text in various listings. Each string in this list, if found
# as the leading text of the brief description, will be stripped from the text
# and the result, after processing the whole list, is used as the annotated
# text. Otherwise, the brief description is used as-is. If left blank, the
# following values are used ($name is automatically replaced with the name of
# the entity):The $name class, The $name widget, The $name file, is, provides,
# specifies, contains, represents, a, an and the.
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then
# doxygen will generate a detailed section even if there is only a brief
# description.
# The default value is: NO.
ALWAYS_DETAILED_SEC = NO
# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all
# inherited members of a class in the documentation of that class as if those
# members were ordinary class members. Constructors, destructors and assignment
# operators of the base classes will not be shown.
# The default value is: NO.
INLINE_INHERITED_MEMB = NO
# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path
# before files name in the file list and in the header files. If set to NO the
# shortest path that makes the file name unique will be used
# The default value is: YES.
FULL_PATH_NAMES = YES
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
# Stripping is only done if one of the specified strings matches the left-hand
# part of the path. The tag can be used to show relative paths in the file list.
# If left blank the directory from which doxygen is run is used as the path to
# strip.
#
# Note that you can specify absolute paths here, but also relative paths, which
# will be relative from the directory where doxygen is started.
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
STRIP_FROM_PATH =
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
# path mentioned in the documentation of a class, which tells the reader which
# header file to include in order to use a class. If left blank only the name of
# the header file containing the class definition is used. Otherwise one should
# specify the list of include paths that are normally passed to the compiler
# using the -I flag.
STRIP_FROM_INC_PATH =
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
# less readable) file names. This can be useful is your file systems doesn't
# support long names like on DOS, Mac, or CD-ROM.
# The default value is: NO.
SHORT_NAMES = NO
# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the
# first line (until the first dot) of a Javadoc-style comment as the brief
# description. If set to NO, the Javadoc-style will behave just like regular Qt-
# style comments (thus requiring an explicit @brief command for a brief
# description.)
# The default value is: NO.
JAVADOC_AUTOBRIEF = NO
# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line
# such as
# /***************
# as being the beginning of a Javadoc-style comment "banner". If set to NO, the
# Javadoc-style will behave just like regular comments and it will not be
# interpreted by doxygen.
# The default value is: NO.
JAVADOC_BANNER = NO
# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first
# line (until the first dot) of a Qt-style comment as the brief description. If
# set to NO, the Qt-style will behave just like regular Qt-style comments (thus
# requiring an explicit \brief command for a brief description.)
# The default value is: NO.
QT_AUTOBRIEF = NO
# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a
# multi-line C++ special comment block (i.e. a block of //! or /// comments) as
# a brief description. This used to be the default behavior. The new default is
# to treat a multi-line C++ comment block as a detailed description. Set this
# tag to YES if you prefer the old behavior instead.
#
# Note that setting this tag to YES also means that rational rose comments are
# not recognized any more.
# The default value is: NO.
MULTILINE_CPP_IS_BRIEF = NO
# By default Python docstrings are displayed as preformatted text and doxygen's
# special commands cannot be used. By setting PYTHON_DOCSTRING to NO the
# doxygen's special commands can be used and the contents of the docstring
# documentation blocks is shown as doxygen documentation.
# The default value is: YES.
PYTHON_DOCSTRING = YES
# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the
# documentation from any documented member that it re-implements.
# The default value is: YES.
INHERIT_DOCS = YES
# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new
# page for each member. If set to NO, the documentation of a member will be part
# of the file/class/namespace that contains it.
# The default value is: NO.
SEPARATE_MEMBER_PAGES = NO
# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen
# uses this value to replace tabs by spaces in code fragments.
# Minimum value: 1, maximum value: 16, default value: 4.
TAB_SIZE = 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:^^"
# 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:". Note that you cannot put \n's in the value part of an alias
# to insert newlines (in the resulting output). You can put ^^ in the value part
# of an alias to insert a newline as if a physical newline was in the original
# file. When you need a literal { or } or , in the value part of an alias you
# have to escape them by means of a backslash (\), this can lead to conflicts
# with the commands \{ and \} for these it is advised to use the version @{ and
# @} or use a double escape (\\{ and \\})
ALIASES =
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
# only. Doxygen will then generate output that is more tailored for C. For
# instance, some of the names that are used will be different. The list of all
# members will be omitted, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_FOR_C = NO
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
# Python sources only. Doxygen will then generate output that is more tailored
# for that language. For instance, namespaces will be presented as packages,
# qualified scopes will look different, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_JAVA = NO
# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran
# sources. Doxygen will then generate output that is tailored for Fortran.
# The default value is: NO.
OPTIMIZE_FOR_FORTRAN = NO
# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL
# sources. Doxygen will then generate output that is tailored for VHDL.
# The default value is: NO.
OPTIMIZE_OUTPUT_VHDL = NO
# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice
# sources only. Doxygen will then generate output that is more tailored for that
# language. For instance, namespaces will be presented as modules, types will be
# separated into more groups, etc.
# The default value is: NO.
OPTIMIZE_OUTPUT_SLICE = NO
# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
# extension. Doxygen has a built-in mapping, but you can override or extend it
# using this tag. The format is ext=language, where ext is a file extension, and
# language is one of the parsers supported by doxygen: IDL, Java, JavaScript,
# Csharp (C#), C, C++, Lex, D, PHP, md (Markdown), Objective-C, Python, Slice,
# VHDL, Fortran (fixed format Fortran: FortranFixed, free formatted Fortran:
# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser
# tries to guess whether the code is fixed or free formatted code, this is the
# default for Fortran type files). For instance to make doxygen treat .inc files
# as Fortran files (default is PHP), and .f files as C (default is Fortran),
# use: inc=Fortran f=C.
#
# Note: For files without extension you can use no_extension as a placeholder.
#
# Note that for custom extensions you also need to set FILE_PATTERNS otherwise
# the files are not read by doxygen. When specifying no_extension you should add
# * to the FILE_PATTERNS.
#
# Note see also the list of default file extension mappings.
EXTENSION_MAPPING =
# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
# according to the Markdown format, which allows for more readable
# documentation. See https://daringfireball.net/projects/markdown/ for details.
# The output of markdown processing is further processed by doxygen, so you can
# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in
# case of backward compatibilities issues.
# The default value is: YES.
MARKDOWN_SUPPORT = YES
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
# to that level are automatically included in the table of contents, even if
# they do not have an id attribute.
# Note: This feature currently applies only to Markdown headings.
# Minimum value: 0, maximum value: 99, default value: 5.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
TOC_INCLUDE_HEADINGS = 5
# The MARKDOWN_ID_STYLE tag can be used to specify the algorithm used to
# generate identifiers for the Markdown headings. Note: Every identifier is
# unique.
# Possible values are: DOXYGEN use a fixed 'autotoc_md' string followed by a
# sequence number starting at 0 and GITHUB use the lower case version of title
# with any whitespace replaced by '-' and punctuation characters removed.
# The default value is: DOXYGEN.
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
MARKDOWN_ID_STYLE = DOXYGEN
# When enabled doxygen tries to link words that correspond to documented
# classes, or namespaces to their corresponding documentation. Such a link can
# be prevented in individual cases by putting a % sign in front of the word or
# globally by setting AUTOLINK_SUPPORT to NO.
# The default value is: YES.
AUTOLINK_SUPPORT = YES
# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want
# to include (a tag file for) the STL sources as input, then you should set this
# tag to YES in order to let doxygen match functions declarations and
# definitions whose arguments contain STL classes (e.g. func(std::string);
# versus func(std::string) {}). This also make the inheritance and collaboration
# diagrams that involve STL classes more complete and accurate.
# The default value is: NO.
BUILTIN_STL_SUPPORT = NO
# If you use Microsoft's C++/CLI language, you should set this option to YES to
# enable parsing support.
# The default value is: NO.
CPP_CLI_SUPPORT = NO
# Set the SIP_SUPPORT tag to YES if your project consists of sip (see:
# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen
# will parse them like normal C++ but will assume all classes use public instead
# of private inheritance when no explicit protection keyword is present.
# The default value is: NO.
SIP_SUPPORT = NO
# For Microsoft's IDL there are propget and propput attributes to indicate
# getter and setter methods for a property. Setting this option to YES will make
# doxygen to replace the get and set methods by a property in the documentation.
# This will only work if the methods are indeed getting or setting a simple
# type. If this is not the case, or you want to show the methods anyway, you
# should set this option to NO.
# The default value is: YES.
IDL_PROPERTY_SUPPORT = YES
# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC
# tag is set to YES then doxygen will reuse the documentation of the first
# member in the group (if any) for the other members of the group. By default
# all members of a group must be documented explicitly.
# The default value is: NO.
DISTRIBUTE_GROUP_DOC = NO
# If one adds a struct or class to a group and this option is enabled, then also
# any nested class or struct is added to the same group. By default this option
# is disabled and one has to add nested compounds explicitly via \ingroup.
# The default value is: NO.
GROUP_NESTED_COMPOUNDS = NO
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
# (for instance a group of public functions) to be put as a subgroup of that
# type (e.g. under the Public Functions section). Set it to NO to prevent
# subgrouping. Alternatively, this can be done per class using the
# \nosubgrouping command.
# The default value is: YES.
SUBGROUPING = YES
# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions
# are shown inside the group in which they are included (e.g. using \ingroup)
# instead of on a separate page (for HTML and Man pages) or section (for LaTeX
# and RTF).
#
# Note that this feature does not work in combination with
# SEPARATE_MEMBER_PAGES.
# The default value is: NO.
INLINE_GROUPED_CLASSES = NO
# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions
# with only public data fields or simple typedef fields will be shown inline in
# the documentation of the scope in which they are defined (i.e. file,
# namespace, or group documentation), provided this scope is documented. If set
# to NO, structs, classes, and unions are shown on a separate page (for HTML and
# Man pages) or section (for LaTeX and RTF).
# The default value is: NO.
INLINE_SIMPLE_STRUCTS = NO
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
# enum is documented as struct, union, or enum with the name of the typedef. So
# typedef struct TypeS {} TypeT, will appear in the documentation as a struct
# with name TypeT. When disabled the typedef will appear as a member of a file,
# namespace, or class. And the struct will be named TypeS. This can typically be
# useful for C code in case the coding convention dictates that all compound
# types are typedef'ed and only the typedef is referenced, never the tag name.
# The default value is: NO.
TYPEDEF_HIDES_STRUCT = NO
# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This
# cache is used to resolve symbols given their name and scope. Since this can be
# an expensive process and often the same symbol appears multiple times in the
# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small
# doxygen will become slower. If the cache is too large, memory is wasted. The
# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range
# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536
# symbols. At the end of a run doxygen will report the cache usage and suggest
# the optimal cache size from a speed point of view.
# Minimum value: 0, maximum value: 9, default value: 0.
LOOKUP_CACHE_SIZE = 0
# The NUM_PROC_THREADS specifies the number of threads doxygen is allowed to use
# during processing. When set to 0 doxygen will based this on the number of
# cores available in the system. You can set it explicitly to a value larger
# than 0 to get more control over the balance between CPU load and processing
# speed. At this moment only the input processing can be done using multiple
# threads. Since this is still an experimental feature the default is set to 1,
# which effectively disables parallel processing. Please report any issues you
# encounter. Generating dot graphs in parallel is controlled by the
# DOT_NUM_THREADS setting.
# Minimum value: 0, maximum value: 32, default value: 1.
NUM_PROC_THREADS = 1
# If the TIMESTAMP tag is set different from NO then each generated page will
# contain the date or date and time when the page was generated. Setting this to
# NO can help when comparing the output of multiple runs.
# Possible values are: YES, NO, DATETIME and DATE.
# The default value is: NO.
TIMESTAMP = NO
#---------------------------------------------------------------------------
# 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 = NO
# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will
# be included in the documentation.
# The default value is: NO.
EXTRACT_PRIVATE = NO
# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
# The default value is: NO.
EXTRACT_PRIV_VIRTUAL = NO
# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal
# scope will be included in the documentation.
# The default value is: NO.
EXTRACT_PACKAGE = NO
# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be
# included in the documentation.
# The default value is: NO.
EXTRACT_STATIC = NO
# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
# only classes defined in header files are included. Does not have any effect
# for Java sources.
# The default value is: YES.
EXTRACT_LOCAL_CLASSES = YES
# This flag is only useful for Objective-C code. If set to YES, local methods,
# which are defined in the implementation section but not in the interface are
# included in the documentation. If set to NO, only methods in the interface are
# included.
# The default value is: NO.
EXTRACT_LOCAL_METHODS = NO
# If this flag is set to YES, the members of anonymous namespaces will be
# extracted and appear in the documentation as a namespace called
# 'anonymous_namespace{file}', where file will be replaced with the base name of
# the file that contains the anonymous namespace. By default anonymous namespace
# are hidden.
# The default value is: NO.
EXTRACT_ANON_NSPACES = NO
# If this flag is set to YES, the name of an unnamed parameter in a declaration
# will be determined by the corresponding definition. By default unnamed
# parameters remain unnamed in the output.
# The default value is: YES.
RESOLVE_UNNAMED_PARAMS = YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all
# undocumented members inside documented classes or files. If set to NO these
# members will be included in the various overviews, but no documentation
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_MEMBERS = NO
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
# to NO, these classes will be included in the various overviews. This option
# will also hide undocumented C++ concepts if enabled. This option has no effect
# if EXTRACT_ALL is enabled.
# The default value is: NO.
HIDE_UNDOC_CLASSES = NO
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# declarations. If set to NO, these declarations will be included in the
# documentation.
# The default value is: NO.
HIDE_FRIEND_COMPOUNDS = NO
# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any
# documentation blocks found inside the body of a function. If set to NO, these
# blocks will be appended to the function's detailed documentation block.
# The default value is: NO.
HIDE_IN_BODY_DOCS = NO
# The INTERNAL_DOCS tag determines if documentation that is typed after a
# \internal command is included. If the tag is set to NO then the documentation
# will be excluded. Set it to YES to include the internal documentation.
# The default value is: NO.
INTERNAL_DOCS = NO
# With the correct setting of option CASE_SENSE_NAMES doxygen will better be
# able to match the capabilities of the underlying filesystem. In case the
# filesystem is case sensitive (i.e. it supports files in the same directory
# whose names only differ in casing), the option must be set to YES to properly
# deal with such files in case they appear in the input. For filesystems that
# are not case sensitive the option should be set to NO to properly deal with
# output files written for symbols that only differ in casing, such as for two
# classes, one named CLASS and the other named Class, and to also support
# references to files without having to specify the exact matching casing. On
# Windows (including Cygwin) and MacOS, users should typically set this option
# to NO, whereas on Linux or other Unix flavors it should typically be set to
# YES.
# Possible values are: SYSTEM, NO and YES.
# The default value is: SYSTEM.
CASE_SENSE_NAMES = YES
# 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_HEADERFILE tag is set to YES then the documentation for a class
# will show which file needs to be included to use the class.
# The default value is: YES.
SHOW_HEADERFILE = YES
# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of
# the files that are included by a file in the documentation of that file.
# The default value is: YES.
SHOW_INCLUDE_FILES = YES
# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
# grouped member an include statement to the documentation, telling the reader
# which file to include in order to use the member.
# The default value is: NO.
SHOW_GROUPED_MEMB_INC = NO
# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include
# files with double quotes in the documentation rather than with sharp brackets.
# The default value is: NO.
FORCE_LOCAL_INCLUDES = NO
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
# documentation for inline members.
# The default value is: YES.
INLINE_INFO = YES
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
# (detailed) documentation of file and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
SORT_MEMBER_DOCS = YES
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
# name. If set to NO, the members will appear in declaration order. Note that
# this will also influence the order of the classes in the class list.
# The default value is: NO.
SORT_BRIEF_DOCS = NO
# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the
# (brief and detailed) documentation of class members so that constructors and
# destructors are listed first. If set to NO the constructors will appear in the
# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS.
# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief
# member documentation.
# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting
# detailed member documentation.
# The default value is: NO.
SORT_MEMBERS_CTORS_1ST = NO
# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy
# of group names into alphabetical order. If set to NO the group names will
# appear in their defined order.
# The default value is: NO.
SORT_GROUP_NAMES = NO
# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by
# fully-qualified names, including namespaces. If set to NO, the class list will
# be sorted only by class name, not including the namespace part.
# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES.
# Note: This option applies only to the class list, not to the alphabetical
# list.
# The default value is: NO.
SORT_BY_SCOPE_NAME = NO
# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper
# type resolution of all parameters of a function it will reject a match between
# the prototype and the implementation of a member function even if there is
# only one candidate or it is obvious which candidate to choose by doing a
# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still
# accept a match between prototype and implementation in such cases.
# The default value is: NO.
STRICT_PROTO_MATCHING = NO
# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo
# list. This list is created by putting \todo commands in the documentation.
# The default value is: YES.
GENERATE_TODOLIST = YES
# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test
# list. This list is created by putting \test commands in the documentation.
# The default value is: YES.
GENERATE_TESTLIST = YES
# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug
# list. This list is created by putting \bug commands in the documentation.
# The default value is: YES.
GENERATE_BUGLIST = YES
# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO)
# the deprecated list. This list is created by putting \deprecated commands in
# the documentation.
# The default value is: YES.
GENERATE_DEPRECATEDLIST= YES
# The ENABLED_SECTIONS tag can be used to enable conditional documentation
# sections, marked by \if <section_label> ... \endif and \cond <section_label>
# ... \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. See also section "Changing the
# layout of pages" for information.
#
# 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 documenting some parameters in
# a documented function twice, or documenting parameters that don't exist or
# using markup commands wrongly.
# The default value is: YES.
WARN_IF_DOC_ERROR = YES
# If WARN_IF_INCOMPLETE_DOC is set to YES, doxygen will warn about incomplete
# function parameter documentation. If set to NO, doxygen will accept that some
# parameters have no documentation without warning.
# The default value is: YES.
WARN_IF_INCOMPLETE_DOC = 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 parameter
# documentation, but not about the absence of documentation. If EXTRACT_ALL is
# set to YES then this flag will automatically be disabled. See also
# WARN_IF_INCOMPLETE_DOC
# The default value is: NO.
WARN_NO_PARAMDOC = NO
# If WARN_IF_UNDOC_ENUM_VAL option is set to YES, doxygen will warn about
# undocumented enumeration values. If set to NO, doxygen will accept
# undocumented enumeration values. If EXTRACT_ALL is set to YES then this flag
# will automatically be disabled.
# The default value is: NO.
WARN_IF_UNDOC_ENUM_VAL = NO
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered. If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS
# then doxygen will continue running as if WARN_AS_ERROR tag is set to NO, but
# at the end of the doxygen process doxygen will return with a non-zero status.
# If the WARN_AS_ERROR tag is set to FAIL_ON_WARNINGS_PRINT then doxygen behaves
# like FAIL_ON_WARNINGS but in case no WARN_LOGFILE is defined doxygen will not
# write the warning messages in between other messages but write them at the end
# of a run, in case a WARN_LOGFILE is defined the warning messages will be
# besides being in the defined file also be shown at the end of a run, unless
# the WARN_LOGFILE is defined as - i.e. standard output (stdout) in that case
# the behavior will remain as with the setting FAIL_ON_WARNINGS.
# Possible values are: NO, YES, FAIL_ON_WARNINGS and FAIL_ON_WARNINGS_PRINT.
# 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)
# See also: WARN_LINE_FORMAT
# The default value is: $file:$line: $text.
WARN_FORMAT = "$file:$line: $text"
# In the $text part of the WARN_FORMAT command it is possible that a reference
# to a more specific place is given. To make it easier to jump to this place
# (outside of doxygen) the user can define a custom "cut" / "paste" string.
# Example:
# WARN_LINE_FORMAT = "'vi $file +$line'"
# See also: WARN_FORMAT
# The default value is: at line $line of file $file.
WARN_LINE_FORMAT = "at line $line of file $file"
# 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). In case the file specified cannot be opened for writing the
# warning and error messages are written to standard error. When as file - is
# specified the warning and error messages are written to standard output
# (stdout).
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 = client \
common \
server
# 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.
# See also: INPUT_FILE_ENCODING
# The default value is: UTF-8.
INPUT_ENCODING = UTF-8
# This tag can be used to specify the character encoding of the source files
# that doxygen parses The INPUT_FILE_ENCODING tag can be used to specify
# character encoding on a per file pattern basis. Doxygen will compare the file
# name with each pattern and apply the encoding instead of the default
# INPUT_ENCODING) if there is a match. The character encodings are a list of the
# form: pattern=encoding (like *.php=ISO-8859-1). See cfg_input_encoding
# "INPUT_ENCODING" for further information on supported encodings.
INPUT_FILE_ENCODING =
# If the value of the INPUT tag contains directories, you can use the
# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and
# *.h) to filter out the source-files in the directories.
#
# Note that for custom extensions or not directly supported extensions you also
# need to set EXTENSION_MAPPING for the extension otherwise the files are not
# read by doxygen.
#
# Note the list of default checked file patterns might differ from the list of
# default file extension mappings.
#
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cxxm,
# *.cpp, *.cppm, *.c++, *.c++m, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl,
# *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.ixx, *.l, *.cs, *.d, *.php,
# *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox (to be
# provided as doxygen C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
# *.f18, *.f, *.for, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice.
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f18 \
*.f \
*.for \
*.vhd \
*.vhdl \
*.ucf \
*.qsf \
*.ice
# The RECURSIVE tag can be used to specify whether or not subdirectories should
# be searched for input files as well.
# The default value is: NO.
RECURSIVE = YES
# The EXCLUDE tag can be used to specify files and/or directories that should be
# excluded from the INPUT source files. This way you can easily exclude a
# subdirectory from a directory tree whose root is specified with the INPUT tag.
#
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = README.md \
common/json.hpp \
server/etc \
server/jsonrpcpp.hpp \
common/popl.hpp \
common/aixlog.hpp
# 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,
# ANamespace::AClass, ANamespace::*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:
#
# <filter> <input-file>
#
# where <filter> is the value of the INPUT_FILTER tag, and <input-file> 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 doxygen will use the data processed and written to standard output
# for further processing, therefore nothing else, like debug statements or used
# commands (so in case of a Windows batch file always use @echo OFF), should be
# written to standard output.
#
# 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 =
# The Fortran standard specifies that for fixed formatted Fortran code all
# characters from position 72 are to be considered as comment. A common
# extension is to allow longer lines before the automatic comment starts. The
# setting FORTRAN_COMMENT_AFTER will also make it possible that longer lines can
# be processed before the automatic comment starts.
# Minimum value: 7, maximum value: 10000, default value: 72.
FORTRAN_COMMENT_AFTER = 72
#---------------------------------------------------------------------------
# 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
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
# clang parser (see:
# http://clang.llvm.org/) for more accurate parsing at the cost of reduced
# performance. This can be particularly helpful with template rich C++ code for
# which doxygen's built-in parser lacks the necessary type information.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
# tag is set to YES then doxygen will add the directory of each input to the
# include path.
# The default value is: YES.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_ADD_INC_PATHS = YES
# If clang assisted parsing is enabled you can provide the compiler with command
# line options that you would normally use when invoking the compiler. Note that
# the include paths will already be set by doxygen for the files and directories
# specified with INPUT and INCLUDE_PATH.
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
CLANG_OPTIONS =
# If clang assisted parsing is enabled you can provide the clang parser with the
# path to the directory containing a file called compile_commands.json. This
# file is the compilation database (see:
# http://clang.llvm.org/docs/HowToSetupToolingForLLVM.html) containing the
# options used when the source files were built. This is equivalent to
# specifying the -p option to a clang tool, such as clang-check. These options
# will then be passed to the parser. Any options specified with CLANG_OPTIONS
# will be added as well.
# Note: The availability of this option depends on whether or not doxygen was
# generated with the -Duse_libclang=ON option for CMake.
CLANG_DATABASE_PATH =
#---------------------------------------------------------------------------
# Configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all
# compounds will be generated. Enable this if the project contains a lot of
# classes, structs, unions or interfaces.
# The default value is: YES.
ALPHABETICAL_INDEX = YES
# 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. The IGNORE_PREFIX
# tag works for classes, function and member names. The entity will be placed in
# the alphabetical list under the first letter of the entity name that remains
# after removing the prefix.
# 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).
# Note: Since the styling of scrollbars can currently not be overruled in
# Webkit/Chromium, the styling will be left out of the default doxygen.css if
# one or more extra stylesheets have been specified. So if scrollbar
# customization is desired it has to be added explicitly. 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 tag can be used to specify if the generated HTML output
# should be rendered with a dark or light theme.
# Possible values are: LIGHT always generate light mode output, DARK always
# generate dark mode output, AUTO_LIGHT automatically set the mode according to
# the user preference, use light mode if no preference is set (the default),
# AUTO_DARK automatically set the mode according to the user preference, use
# dark mode if no preference is set and TOGGLE allow to user to switch between
# light and dark mode via a button.
# The default value is: AUTO_LIGHT.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_COLORSTYLE = AUTO_LIGHT
# 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 color-wheel, 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 gray-scales 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_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
# If the HTML_CODE_FOLDING tag is set to YES then classes and functions can be
# dynamically folded and expanded in the generated HTML source code.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_CODE_FOLDING = YES
# 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 determines the URL 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.
# This tag requires that the tag GENERATE_DOCSET is set to YES.
DOCSET_FEEDURL =
# 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
# on Windows. In the beginning of 2021 Microsoft took the original page, with
# a.o. the download links, offline the HTML help workshop was already many years
# in maintenance mode). You can download the HTML help workshop from the web
# archives at Installation executable (see:
# http://web.archive.org/web/20160201063255/http://download.microsoft.com/downlo
# ad/0/A/9/0A939EF6-E31C-430F-A3DF-DFAE7960D564/htmlhelp.exe).
#
# The HTML Help Workshop contains a compiler that can convert all HTML output
# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML
# files are now used as the Windows 98 help format, and will replace the old
# Windows help format (.hlp) on all Windows platforms in the future. Compressed
# HTML files also contain an index, a table of contents, and you can search for
# words in the documentation. The HTML workshop also contains a viewer for
# compressed HTML files.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_HTMLHELP = NO
# The CHM_FILE tag can be used to specify the file name of the resulting .chm
# file. You can add a path in front of the file if the result should not be
# written to the html output directory.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_FILE =
# The HHC_LOCATION tag can be used to specify the location (absolute path
# including file name) of the HTML help compiler (hhc.exe). If non-empty,
# doxygen will try to run the HTML help compiler on the generated index.hhp.
# The file has to be specified with full path.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
HHC_LOCATION =
# The GENERATE_CHI flag controls if a separate .chi index file is generated
# (YES) or that it should be included in the main .chm file (NO).
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
GENERATE_CHI = NO
# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc)
# and project file content.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
CHM_INDEX_ENCODING =
# The BINARY_TOC flag controls whether a binary table of contents is generated
# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it
# enables the Previous and Next buttons.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
BINARY_TOC = NO
# The TOC_EXPAND flag can be set to YES to add extra items for group members to
# the table of contents of the HTML help documentation and to the tree view.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTMLHELP is set to YES.
TOC_EXPAND = NO
# The SITEMAP_URL tag is used to specify the full URL of the place where the
# generated documentation will be placed on the server by the user during the
# deployment of the documentation. The generated sitemap is called sitemap.xml
# and placed on the directory specified by HTML_OUTPUT. In case no SITEMAP_URL
# is specified no sitemap is generated. For information about the sitemap
# protocol see https://www.sitemaps.org
# This tag requires that the tag GENERATE_HTML is set to YES.
SITEMAP_URL =
# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and
# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that
# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help
# (.qch) of the generated HTML documentation.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_QHP = NO
# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify
# the file name of the resulting .qch file. The path specified is relative to
# the HTML output folder.
# This tag requires that the tag GENERATE_QHP is set to YES.
QCH_FILE =
# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help
# Project output. For more information please see Qt Help Project / Namespace
# (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace).
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = org.doxygen.Project
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt
# Help Project output. For more information please see Qt Help Project / Virtual
# Folders (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual-folders).
# The default value is: doc.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_VIRTUAL_FOLDER = doc
# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom
# filter to add. For more information please see Qt Help Project / Custom
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_NAME =
# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the
# custom filter to add. For more information please see Qt Help Project / Custom
# Filters (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom-filters).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_CUST_FILTER_ATTRS =
# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this
# project's filter section matches. Qt Help Project / Filter Attributes (see:
# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes).
# This tag requires that the tag GENERATE_QHP is set to YES.
QHP_SECT_FILTER_ATTRS =
# The QHG_LOCATION tag can be used to specify the location (absolute path
# including file name) of Qt's qhelpgenerator. If non-empty doxygen will try to
# run qhelpgenerator on the generated .qhp file.
# This tag requires that the tag GENERATE_QHP is set to YES.
QHG_LOCATION =
# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be
# generated, together with the HTML files, they form an Eclipse help plugin. To
# install this plugin and make it available under the help contents menu in
# Eclipse, the contents of the directory containing the HTML and XML files needs
# to be copied into the plugins directory of eclipse. The name of the directory
# within the plugins directory should be the same as the ECLIPSE_DOC_ID value.
# After copying Eclipse needs to be restarted before the help appears.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
GENERATE_ECLIPSEHELP = NO
# A unique identifier for the Eclipse help plugin. When installing the plugin
# the directory name containing the HTML and XML files should also have this
# name. Each documentation set should have its own identifier.
# The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES.
ECLIPSE_DOC_ID = org.doxygen.Project
# If you want full control over the layout of the generated HTML pages it might
# be necessary to disable the index and replace it with your own. The
# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top
# of each HTML page. A value of NO enables the index and the value YES disables
# it. Since the tabs in the index contain the same information as the navigation
# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
DISABLE_INDEX = NO
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
# structure should be generated to display hierarchical information. If the tag
# value is set to YES, a side panel will be generated containing a tree-like
# index structure (just like the one that is generated for HTML Help). For this
# to work a browser that supports JavaScript, DHTML, CSS and frames is required
# (i.e. any modern browser). Windows users are probably better off using the
# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can
# further fine tune the look of the index (see "Fine-tuning the output"). 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
# When both GENERATE_TREEVIEW and DISABLE_INDEX are set to YES, then the
# FULL_SIDEBAR option determines if the side bar is limited to only the treeview
# area (value NO) or if it should extend to the full height of the window (value
# YES). Setting this to YES gives a layout similar to
# https://docs.readthedocs.io with more room for contents, but less room for the
# project logo, title, and description. If either GENERATE_TREEVIEW or
# DISABLE_INDEX is set to NO, this option has no effect.
# The default value is: NO.
# This tag requires that the tag GENERATE_HTML is set to YES.
FULL_SIDEBAR = 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 OBFUSCATE_EMAILS tag is set to YES, doxygen will obfuscate email
# addresses.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
OBFUSCATE_EMAILS = YES
# If the HTML_FORMULA_FORMAT option is set to svg, doxygen will use the pdf2svg
# tool (see https://github.com/dawbarton/pdf2svg) or inkscape (see
# https://inkscape.org) to generate formulas as SVG images instead of PNGs for
# the HTML output. These images will generally look nicer at scaled resolutions.
# Possible values are: png (the default) and svg (looks nicer but requires the
# pdf2svg or inkscape tool).
# The default value is: png.
# This tag requires that the tag GENERATE_HTML is set to YES.
HTML_FORMULA_FORMAT = png
# Use this tag to change the font size of LaTeX formulas included as images in
# the HTML documentation. When you change the font size after a successful
# doxygen run you need to manually remove any form_*.png images from the HTML
# output directory to force them to be regenerated.
# Minimum value: 8, maximum value: 50, default value: 10.
# This tag requires that the tag GENERATE_HTML is set to YES.
FORMULA_FONTSIZE = 10
# 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
# With MATHJAX_VERSION it is possible to specify the MathJax version to be used.
# Note that the different versions of MathJax have different requirements with
# regards to the different settings, so it is possible that also other MathJax
# settings have to be changed when switching between the different MathJax
# versions.
# Possible values are: MathJax_2 and MathJax_3.
# The default value is: MathJax_2.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_VERSION = MathJax_2
# When MathJax is enabled you can set the default output format to be used for
# the MathJax output. For more details about the output format see MathJax
# version 2 (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) and MathJax version 3
# (see:
# http://docs.mathjax.org/en/latest/web/components/output.html).
# Possible values are: HTML-CSS (which is slower, but has the best
# compatibility. This is the name for Mathjax version 2, for MathJax version 3
# this will be translated into chtml), NativeMML (i.e. MathML. Only supported
# for NathJax 2. For MathJax version 3 chtml will be used instead.), chtml (This
# is the name for Mathjax version 3, for MathJax version 2 this will be
# translated into HTML-CSS) 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:
# - in case of MathJax version 2: https://cdn.jsdelivr.net/npm/mathjax@2
# - in case of MathJax version 3: https://cdn.jsdelivr.net/npm/mathjax@3
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_RELPATH = https://cdn.jsdelivr.net/npm/mathjax@2
# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax
# extension names that should be enabled during MathJax rendering. For example
# for MathJax version 2 (see
# https://docs.mathjax.org/en/v2.7-latest/tex.html#tex-and-latex-extensions):
# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
# For example for MathJax version 3 (see
# http://docs.mathjax.org/en/latest/input/tex/extensions/index.html):
# MATHJAX_EXTENSIONS = ams
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_EXTENSIONS =
# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces
# of code that will be used on startup of the MathJax code. See the MathJax site
# (see:
# http://docs.mathjax.org/en/v2.7-latest/output.html) for more details. For an
# example see the documentation.
# This tag requires that the tag USE_MATHJAX is set to YES.
MATHJAX_CODEFILE =
# When the SEARCHENGINE tag is enabled doxygen will generate a search box for
# the HTML output. The underlying search engine uses javascript and DHTML and
# should work on any modern browser. Note that when using HTML help
# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET)
# there is already a search function so this one should typically be disabled.
# For large projects the javascript based search engine can be slow, then
# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to
# search using the keyboard; to jump to the search box use <access key> + S
# (what the <access key> is depends on the OS and browser, but it is typically
# <CTRL>, <ALT>/<option>, or both). Inside the search box use the <cursor down
# key> to jump into the search results window, the results can be navigated
# using the <cursor keys>. Press <Enter> to select an item or <escape> to cancel
# the search. The filter options can be selected when the cursor is inside the
# search box by pressing <Shift>+<cursor down>. Also here use the <cursor keys>
# to select a filter and <Enter> or <escape> to activate or cancel the filter
# option.
# The default value is: YES.
# This tag requires that the tag GENERATE_HTML is set to YES.
SEARCHENGINE = YES
# When the SERVER_BASED_SEARCH tag is enabled the search engine will be
# implemented using a web server instead of a web client using JavaScript. There
# are two flavors of web server based searching depending on the EXTERNAL_SEARCH
# setting. When disabled, doxygen will generate a PHP script for searching and
# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing
# and searching needs to be provided by external tools. See the section
# "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
SERVER_BASED_SEARCH = NO
# When EXTERNAL_SEARCH tag is enabled doxygen will no longer generate the PHP
# script for searching. Instead the search results are written to an XML file
# which needs to be processed by an external indexer. Doxygen will invoke an
# external search engine pointed to by the SEARCHENGINE_URL option to obtain the
# search results.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/).
#
# See the section "External Indexing and Searching" for details.
# The default value is: NO.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH = NO
# The SEARCHENGINE_URL should point to a search engine hosted by a web server
# which will return the search results when EXTERNAL_SEARCH is enabled.
#
# Doxygen ships with an example indexer (doxyindexer) and search engine
# (doxysearch.cgi) which are based on the open source search engine library
# Xapian (see:
# https://xapian.org/). See the section "External Indexing and Searching" for
# details.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHENGINE_URL =
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the unindexed
# search data is written to a file for indexing by an external tool. With the
# SEARCHDATA_FILE tag the name of this file can be specified.
# The default file is: searchdata.xml.
# This tag requires that the tag SEARCHENGINE is set to YES.
SEARCHDATA_FILE = searchdata.xml
# When SERVER_BASED_SEARCH and EXTERNAL_SEARCH are both enabled the
# EXTERNAL_SEARCH_ID tag can be used as an identifier for the project. This is
# useful in combination with EXTRA_SEARCH_MAPPINGS to search through multiple
# projects and redirect the results back to the right project.
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTERNAL_SEARCH_ID =
# The EXTRA_SEARCH_MAPPINGS tag can be used to enable searching through doxygen
# projects other than the one defined by this configuration file, but that are
# all added to the same external search index. Each project needs to have a
# unique id set via EXTERNAL_SEARCH_ID. The search mapping then maps the id of
# to a relative location where the documentation can be found. The format is:
# EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
# This tag requires that the tag SEARCHENGINE is set to YES.
EXTRA_SEARCH_MAPPINGS =
#---------------------------------------------------------------------------
# Configuration options related to the LaTeX output
#---------------------------------------------------------------------------
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
# The default value is: YES.
GENERATE_LATEX = YES
# The LATEX_OUTPUT tag is used to specify where the LaTeX 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: latex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_OUTPUT = latex
# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be
# invoked.
#
# Note that when not enabling USE_PDFLATEX the default is latex when enabling
# USE_PDFLATEX the default is pdflatex and when in the later case latex is
# chosen this is overwritten by pdflatex. For specific output languages the
# default can have been set differently, this depends on the implementation of
# the output language.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_CMD_NAME =
# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate
# index for LaTeX.
# Note: This tag is used in the Makefile / make.bat.
# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file
# (.tex).
# The default file is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
MAKEINDEX_CMD_NAME = makeindex
# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
# generate index for LaTeX. In case there is no backslash (\) as first character
# it will be automatically added in the LaTeX code.
# Note: This tag is used in the generated output file (.tex).
# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.
# The default value is: makeindex.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_MAKEINDEX_CMD = makeindex
# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
COMPACT_LATEX = NO
# The PAPER_TYPE tag can be used to set the paper type that is used by the
# printer.
# Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x
# 14 inches) and executive (7.25 x 10.5 inches).
# The default value is: a4.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PAPER_TYPE = a4
# The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names
# that should be included in the LaTeX output. The package can be specified just
# by its name or with the correct syntax as to be used with the LaTeX
# \usepackage command. To get the times font for instance you can specify :
# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
# To use the option intlimits with the amsmath package you can specify:
# EXTRA_PACKAGES=[intlimits]{amsmath}
# If left blank no extra packages will be included.
# This tag requires that the tag GENERATE_LATEX is set to YES.
EXTRA_PACKAGES =
# The LATEX_HEADER tag can be used to specify a user-defined LaTeX header for
# the generated LaTeX document. The header should contain everything until the
# first chapter. If it is left blank doxygen will generate a standard header. It
# is highly recommended to start with a default header using
# doxygen -w latex new_header.tex new_footer.tex new_stylesheet.sty
# and then modify the file new_header.tex. See also section "Doxygen usage" for
# information on how to generate the default header that doxygen normally uses.
#
# Note: Only use a user-defined header if you know what you are doing!
# Note: The header is subject to change so you typically have to regenerate the
# default header when upgrading to a newer version of doxygen. The following
# commands have a special meaning inside the header (and footer): For a
# description of the possible markers and block names see the documentation.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HEADER =
# The LATEX_FOOTER tag can be used to specify a user-defined LaTeX footer for
# the generated LaTeX document. The footer should contain everything after the
# last chapter. If it is left blank doxygen will generate a standard footer. See
# LATEX_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. Note: Only use a user-defined footer if you know what you are
# doing!
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_FOOTER =
# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined
# LaTeX style sheets that are included after the standard style sheets created
# by doxygen. Using this option one can overrule certain style aspects. 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).
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_STYLESHEET =
# The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or
# other source files which should be copied to the LATEX_OUTPUT output
# directory. Note that the files will be copied as-is; there are no commands or
# markers available.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EXTRA_FILES =
# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is
# prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will
# contain links (just like the HTML output) instead of page references. This
# makes the output suitable for online browsing using a PDF viewer.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
PDF_HYPERLINKS = YES
# If the USE_PDFLATEX tag is set to YES, doxygen will use the engine as
# specified with LATEX_CMD_NAME to generate the PDF file directly from the LaTeX
# files. Set this option to YES, to get a higher quality PDF documentation.
#
# See also section LATEX_CMD_NAME for selecting the engine.
# The default value is: YES.
# This tag requires that the tag GENERATE_LATEX is set to YES.
USE_PDFLATEX = YES
# The LATEX_BATCHMODE tag signals the behavior of LaTeX in case of an error.
# Possible values are: NO same as ERROR_STOP, YES same as BATCH, BATCH In batch
# mode nothing is printed on the terminal, errors are scrolled as if <return> is
# hit at every error; missing files that TeX tries to input or request from
# keyboard input (\read on a not open input stream) cause the job to abort,
# NON_STOP In nonstop mode the diagnostic message will appear on the terminal,
# but there is no possibility of user interaction just like in batch mode,
# SCROLL In scroll mode, TeX will stop only for missing files to input or if
# keyboard input is necessary and ERROR_STOP In errorstop mode, TeX will stop at
# each error, asking for user intervention.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BATCHMODE = NO
# If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the
# index chapters (such as File Index, Compound Index, etc.) in the output.
# The default value is: NO.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_HIDE_INDICES = NO
# The LATEX_BIB_STYLE tag can be used to specify the style to use for the
# bibliography, e.g. plainnat, or ieeetr. See
# https://en.wikipedia.org/wiki/BibTeX and \cite for more info.
# The default value is: plain.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_BIB_STYLE = plain
# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute)
# path from which the emoji images will be read. If a relative path is entered,
# it will be relative to the LATEX_OUTPUT directory. If left blank the
# LATEX_OUTPUT directory will be used.
# This tag requires that the tag GENERATE_LATEX is set to YES.
LATEX_EMOJI_DIRECTORY =
#---------------------------------------------------------------------------
# Configuration options related to the RTF output
#---------------------------------------------------------------------------
# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The
# RTF output is optimized for Word 97 and may not look too pretty with other RTF
# readers/editors.
# The default value is: NO.
GENERATE_RTF = NO
# The RTF_OUTPUT tag is used to specify where the RTF 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: rtf.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_OUTPUT = rtf
# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF
# documents. This may be useful for small projects and may help to save some
# trees in general.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
COMPACT_RTF = NO
# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will
# contain hyperlink fields. The RTF file will contain links (just like the HTML
# output) instead of page references. This makes the output suitable for online
# browsing using Word or some other Word compatible readers that support those
# fields.
#
# Note: WordPad (write) and others do not support links.
# The default value is: NO.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_HYPERLINKS = NO
# Load stylesheet definitions from file. Syntax is similar to doxygen's
# configuration file, i.e. a series of assignments. You only have to provide
# replacements, missing definitions are set to their default value.
#
# See also section "Doxygen usage" for information on how to generate the
# default style sheet that doxygen normally uses.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_STYLESHEET_FILE =
# Set optional variables used in the generation of an RTF document. Syntax is
# similar to doxygen's configuration file. A template extensions file can be
# generated using doxygen -e rtf extensionFile.
# This tag requires that the tag GENERATE_RTF is set to YES.
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# Configuration options related to the man page output
#---------------------------------------------------------------------------
# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for
# classes and files.
# The default value is: NO.
GENERATE_MAN = NO
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
# it. A directory man3 will be created inside the directory specified by
# MAN_OUTPUT.
# The default directory is: man.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_OUTPUT = man
# The MAN_EXTENSION tag determines the extension that is added to the generated
# man pages. In case the manual section does not start with a number, the number
# 3 is prepended. The dot (.) at the beginning of the MAN_EXTENSION tag is
# optional.
# The default value is: .3.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_EXTENSION = .3
# The MAN_SUBDIR tag determines the name of the directory created within
# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by
# MAN_EXTENSION with the initial . removed.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_SUBDIR =
# If the MAN_LINKS tag is set to YES and doxygen generates man output, then it
# will generate one additional man file for each entity documented in the real
# man page(s). These additional files only source the real man page, but without
# them the man command would be unable to find the correct page.
# The default value is: NO.
# This tag requires that the tag GENERATE_MAN is set to YES.
MAN_LINKS = NO
#---------------------------------------------------------------------------
# Configuration options related to the XML output
#---------------------------------------------------------------------------
# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
# The XML_OUTPUT tag is used to specify where the XML pages 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: xml.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_OUTPUT = xml
# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program
# listings (including syntax highlighting and cross-referencing information) to
# the XML output. Note that enabling this will significantly increase the size
# of the XML output.
# The default value is: YES.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_PROGRAMLISTING = YES
# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include
# namespace members in file scope as well, matching the HTML output.
# The default value is: NO.
# This tag requires that the tag GENERATE_XML is set to YES.
XML_NS_MEMB_FILE_SCOPE = NO
#---------------------------------------------------------------------------
# Configuration options related to the DOCBOOK output
#---------------------------------------------------------------------------
# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files
# that can be used to generate PDF.
# The default value is: NO.
GENERATE_DOCBOOK = NO
# The DOCBOOK_OUTPUT tag is used to specify where the Docbook pages 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: docbook.
# This tag requires that the tag GENERATE_DOCBOOK is set to YES.
DOCBOOK_OUTPUT = docbook
#---------------------------------------------------------------------------
# Configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an
# AutoGen Definitions (see https://autogen.sourceforge.net/) file that captures
# the structure of the code including all documentation. Note that this feature
# is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_AUTOGEN_DEF = NO
#---------------------------------------------------------------------------
# Configuration options related to Sqlite3 output
#---------------------------------------------------------------------------
# If the GENERATE_SQLITE3 tag is set to YES doxygen will generate a Sqlite3
# database with symbols found by doxygen stored in tables.
# The default value is: NO.
GENERATE_SQLITE3 = NO
# The SQLITE3_OUTPUT tag is used to specify where the Sqlite3 database 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: sqlite3.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
SQLITE3_OUTPUT = sqlite3
# The SQLITE3_OVERWRITE_DB tag is set to YES, the existing doxygen_sqlite3.db
# database file will be recreated with each doxygen run. If set to NO, doxygen
# will warn if an a database file is already found and not modify it.
# The default value is: YES.
# This tag requires that the tag GENERATE_SQLITE3 is set to YES.
SQLITE3_RECREATE_DB = YES
#---------------------------------------------------------------------------
# Configuration options related to the Perl module output
#---------------------------------------------------------------------------
# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module
# file that captures the structure of the code including all documentation.
#
# Note that this feature is still experimental and incomplete at the moment.
# The default value is: NO.
GENERATE_PERLMOD = NO
# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary
# Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI
# output from the Perl module output.
# The default value is: NO.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_LATEX = NO
# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely
# formatted so it can be parsed by a human reader. This is useful if you want to
# understand what is going on. On the other hand, if this tag is set to NO, the
# size of the Perl module output will be much smaller and Perl will parse it
# just the same.
# The default value is: YES.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_PRETTY = YES
# The names of the make variables in the generated doxyrules.make file are
# prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. This is useful
# so different doxyrules.make files included by the same Makefile don't
# overwrite each other's variables.
# This tag requires that the tag GENERATE_PERLMOD is set to YES.
PERLMOD_MAKEVAR_PREFIX =
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all
# C-preprocessor directives found in the sources and include files.
# The default value is: YES.
ENABLE_PREPROCESSING = YES
# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names
# in the source code. If set to NO, only conditional compilation will be
# performed. Macro expansion can be done in a controlled way by setting
# EXPAND_ONLY_PREDEF to YES.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
MACRO_EXPANSION = NO
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
# the macro expansion is limited to the macros specified with the PREDEFINED and
# EXPAND_AS_DEFINED tags.
# The default value is: NO.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_ONLY_PREDEF = NO
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
# INCLUDE_PATH will be searched if a #include is found.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SEARCH_INCLUDES = YES
# The INCLUDE_PATH tag can be used to specify one or more directories that
# contain include files that are not input files but should be processed by the
# preprocessor. Note that the INCLUDE_PATH is not recursive, so the setting of
# RECURSIVE has no effect here.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
INCLUDE_PATH =
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
# directories. If left blank, the patterns specified with FILE_PATTERNS will be
# used.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
INCLUDE_FILE_PATTERNS =
# The PREDEFINED tag can be used to specify one or more macro names that are
# defined before the preprocessor is started (similar to the -D option of e.g.
# gcc). The argument of the tag is a list of macros of the form: name or
# name=definition (no spaces). If the definition and the "=" are omitted, "=1"
# is assumed. To prevent a macro definition from being undefined via #undef or
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED =
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
# tag if you want to use a different macro definition that overrules the
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
# If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have
# an all uppercase name, and do not end with a semicolon. Such function macros
# are typically used for boiler-plate code, and will confuse the parser if not
# removed.
# The default value is: YES.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
# Configuration options related to external references
#---------------------------------------------------------------------------
# The TAGFILES tag can be used to specify one or more tag files. For each tag
# file the location of the external documentation should be added. The format of
# a tag file without this location is as follows:
# TAGFILES = file1 file2 ...
# Adding location for the tag files is done as follows:
# TAGFILES = file1=loc1 "file2 = loc2" ...
# where loc1 and loc2 can be relative or absolute paths or URLs. See the
# section "Linking to external documentation" for more information about the use
# of tag files.
# Note: Each tag file must have a unique name (where the name does NOT include
# the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here.
TAGFILES =
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
GENERATE_TAGFILE =
# If the ALLEXTERNALS tag is set to YES, all external classes and namespaces
# will be listed in the class and namespace index. If set to NO, only the
# inherited external classes will be listed.
# The default value is: NO.
ALLEXTERNALS = NO
# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed
# in the topic index. If set to NO, only the current project's groups will be
# listed.
# The default value is: YES.
EXTERNAL_GROUPS = YES
# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will
# be listed.
# The default value is: YES.
EXTERNAL_PAGES = YES
#---------------------------------------------------------------------------
# Configuration options related to diagram generator tools
#---------------------------------------------------------------------------
# If set to YES the inheritance and collaboration graphs will hide inheritance
# and usage relations if the target is undocumented or is not a class.
# The default value is: YES.
HIDE_UNDOC_RELATIONS = YES
# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is
# available from the path. This tool is part of Graphviz (see:
# https://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
# Bell Labs. The other options in this section have no effect if this option is
# set to NO
# The default value is: YES.
HAVE_DOT = YES
# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is allowed
# to run in parallel. When set to 0 doxygen will base this on the number of
# processors available in the system. You can set it explicitly to a value
# larger than 0 to get control over the balance between CPU load and processing
# speed.
# Minimum value: 0, maximum value: 32, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NUM_THREADS = 0
# DOT_COMMON_ATTR is common attributes for nodes, edges and labels of
# subgraphs. When you want a differently looking font in the dot files that
# doxygen generates you can specify fontname, fontcolor and fontsize attributes.
# For details please see <a href=https://graphviz.org/doc/info/attrs.html>Node,
# Edge and Graph Attributes specification</a> You need to make sure dot is able
# to find the font, which can be done by putting it in a standard location or by
# setting the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the
# directory containing the font. Default graphviz fontsize is 14.
# The default value is: fontname=Helvetica,fontsize=10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_COMMON_ATTR = "fontname=Helvetica,fontsize=10"
# DOT_EDGE_ATTR is concatenated with DOT_COMMON_ATTR. For elegant style you can
# add 'arrowhead=open, arrowtail=open, arrowsize=0.5'. <a
# href=https://graphviz.org/doc/info/arrows.html>Complete documentation about
# arrows shapes.</a>
# The default value is: labelfontname=Helvetica,labelfontsize=10.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_EDGE_ATTR = "labelfontname=Helvetica,labelfontsize=10"
# DOT_NODE_ATTR is concatenated with DOT_COMMON_ATTR. For view without boxes
# around nodes set 'shape=plain' or 'shape=plaintext' <a
# href=https://www.graphviz.org/doc/info/shapes.html>Shapes specification</a>
# The default value is: shape=box,height=0.2,width=0.4.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_NODE_ATTR = "shape=box,height=0.2,width=0.4"
# You can set the path where dot can find font specified with fontname in
# DOT_COMMON_ATTR and others dot attributes.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_FONTPATH =
# If the CLASS_GRAPH tag is set to YES or GRAPH or BUILTIN then doxygen will
# generate a graph for each documented class showing the direct and indirect
# inheritance relations. In case the CLASS_GRAPH tag is set to YES or GRAPH and
# HAVE_DOT is enabled as well, then dot will be used to draw the graph. In case
# the CLASS_GRAPH tag is set to YES and HAVE_DOT is disabled or if the
# CLASS_GRAPH tag is set to BUILTIN, then the built-in generator will be used.
# If the CLASS_GRAPH tag is set to TEXT the direct and indirect inheritance
# relations will be shown as texts / links.
# Possible values are: NO, YES, TEXT, GRAPH and BUILTIN.
# The default value is: YES.
CLASS_GRAPH = YES
# If the COLLABORATION_GRAPH tag is set to YES then doxygen will generate a
# graph for each documented class showing the direct and indirect implementation
# dependencies (inheritance, containment, and class references variables) of the
# class with other documented classes. Explicit enabling a collaboration graph,
# when COLLABORATION_GRAPH is set to NO, can be accomplished by means of the
# command \collaborationgraph. Disabling a collaboration graph can be
# accomplished by means of the command \hidecollaborationgraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
COLLABORATION_GRAPH = YES
# If the GROUP_GRAPHS tag is set to YES then doxygen will generate a graph for
# groups, showing the direct groups dependencies. Explicit enabling a group
# dependency graph, when GROUP_GRAPHS is set to NO, can be accomplished by means
# of the command \groupgraph. Disabling a directory graph can be accomplished by
# means of the command \hidegroupgraph. See also the chapter Grouping in the
# manual.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GROUP_GRAPHS = YES
# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and
# collaboration diagrams in a style similar to the OMG's Unified Modeling
# Language.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
UML_LOOK = NO
# If the UML_LOOK tag is enabled, the fields and methods are shown inside the
# class node. If there are many fields or methods and many nodes the graph may
# become too big to be useful. The UML_LIMIT_NUM_FIELDS threshold limits the
# number of items for each type to make the size more manageable. Set this to 0
# for no limit. Note that the threshold may be exceeded by 50% before the limit
# is enforced. So when you set the threshold to 10, up to 15 fields may appear,
# but if the number exceeds 15, the total amount of fields shown is limited to
# 10.
# Minimum value: 0, maximum value: 100, default value: 10.
# This tag requires that the tag UML_LOOK is set to YES.
UML_LIMIT_NUM_FIELDS = 10
# If the DOT_UML_DETAILS tag is set to NO, doxygen will show attributes and
# methods without types and arguments in the UML graphs. If the DOT_UML_DETAILS
# tag is set to YES, doxygen will add type and arguments for attributes and
# methods in the UML graphs. If the DOT_UML_DETAILS tag is set to NONE, doxygen
# will not generate fields with class member information in the UML graphs. The
# class diagrams will look similar to the default class diagrams but using UML
# notation for the relationships.
# Possible values are: NO, YES and NONE.
# The default value is: NO.
# This tag requires that the tag UML_LOOK is set to YES.
DOT_UML_DETAILS = NO
# The DOT_WRAP_THRESHOLD tag can be used to set the maximum number of characters
# to display on a single line. If the actual line length exceeds this threshold
# significantly it will wrapped across multiple lines. Some heuristics are apply
# to avoid ugly line breaks.
# Minimum value: 0, maximum value: 1000, default value: 17.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_WRAP_THRESHOLD = 17
# If the TEMPLATE_RELATIONS tag is set to YES then the inheritance and
# collaboration graphs will show the relations between templates and their
# instances.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
TEMPLATE_RELATIONS = NO
# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
# direct and indirect include dependencies of the file with other documented
# files. Explicit enabling an include graph, when INCLUDE_GRAPH is is set to NO,
# can be accomplished by means of the command \includegraph. Disabling an
# include graph can be accomplished by means of the command \hideincludegraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDE_GRAPH = YES
# If the INCLUDED_BY_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are
# set to YES then doxygen will generate a graph for each documented file showing
# the direct and indirect include dependencies of the file with other documented
# files. Explicit enabling an included by graph, when INCLUDED_BY_GRAPH is set
# to NO, can be accomplished by means of the command \includedbygraph. Disabling
# an included by graph can be accomplished by means of the command
# \hideincludedbygraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
INCLUDED_BY_GRAPH = YES
# If the CALL_GRAPH tag is set to YES then doxygen will generate a call
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable call graphs for selected
# functions only using the \callgraph command. Disabling a call graph can be
# accomplished by means of the command \hidecallgraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALL_GRAPH = NO
# If the CALLER_GRAPH tag is set to YES then doxygen will generate a caller
# dependency graph for every global function or class method.
#
# Note that enabling this option will significantly increase the time of a run.
# So in most cases it will be better to enable caller graphs for selected
# functions only using the \callergraph command. Disabling a caller graph can be
# accomplished by means of the command \hidecallergraph.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
CALLER_GRAPH = NO
# If the GRAPHICAL_HIERARCHY tag is set to YES then doxygen will graphical
# hierarchy of all classes instead of a textual one.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GRAPHICAL_HIERARCHY = YES
# If the DIRECTORY_GRAPH tag is set to YES then doxygen will show the
# dependencies a directory has on other directories in a graphical way. The
# dependency relations are determined by the #include relations between the
# files in the directories. Explicit enabling a directory graph, when
# DIRECTORY_GRAPH is set to NO, can be accomplished by means of the command
# \directorygraph. Disabling a directory graph can be accomplished by means of
# the command \hidedirectorygraph.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
DIRECTORY_GRAPH = YES
# The DIR_GRAPH_MAX_DEPTH tag can be used to limit the maximum number of levels
# of child directories generated in directory dependency graphs by dot.
# Minimum value: 1, maximum value: 25, default value: 1.
# This tag requires that the tag DIRECTORY_GRAPH is set to YES.
DIR_GRAPH_MAX_DEPTH = 1
# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images
# generated by dot. For an explanation of the image formats see the section
# output formats in the documentation of the dot tool (Graphviz (see:
# https://www.graphviz.org/)).
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
# to make the SVG files visible in IE 9+ (other browsers do not have this
# requirement).
# Possible values are: png, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd,
# gif, gif:cairo, gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd,
# png:cairo, png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
# png:gdiplus:gdiplus.
# The default value is: png.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_IMAGE_FORMAT = png
# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to
# enable generation of interactive SVG images that allow zooming and panning.
#
# Note that this requires a modern browser other than Internet Explorer. Tested
# and working are Firefox, Chrome, Safari, and Opera.
# Note: For IE 9+ you need to set HTML_FILE_EXTENSION to xhtml in order to make
# the SVG files visible. Older versions of IE do not have SVG support.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
INTERACTIVE_SVG = NO
# The DOT_PATH tag can be used to specify the path where the dot tool can be
# found. If left blank, it is assumed the dot tool can be found in the path.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_PATH =
# The DOTFILE_DIRS tag can be used to specify one or more directories that
# contain dot files that are included in the documentation (see the \dotfile
# command).
# This tag requires that the tag HAVE_DOT is set to YES.
DOTFILE_DIRS =
# You can include diagrams made with dia in doxygen documentation. Doxygen will
# then run dia to produce the diagram and insert it in the documentation. The
# DIA_PATH tag allows you to specify the directory where the dia binary resides.
# If left empty dia is assumed to be found in the default search path.
DIA_PATH =
# The DIAFILE_DIRS tag can be used to specify one or more directories that
# contain dia files that are included in the documentation (see the \diafile
# command).
DIAFILE_DIRS =
# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the
# path where java can find the plantuml.jar file or to the filename of jar file
# to be used. If left blank, it is assumed PlantUML is not used or called during
# a preprocessing step. Doxygen will generate a warning when it encounters a
# \startuml command in this case and will not generate output for the diagram.
PLANTUML_JAR_PATH =
# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a
# configuration file for plantuml.
PLANTUML_CFG_FILE =
# When using plantuml, the specified paths are searched for files specified by
# the !include statement in a plantuml block.
PLANTUML_INCLUDE_PATH =
# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes
# that will be shown in the graph. If the number of nodes in a graph becomes
# larger than this value, doxygen will truncate the graph, which is visualized
# by representing a node as a red box. Note that doxygen if the number of direct
# children of the root node in a graph is already larger than
# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note that
# the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH.
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_GRAPH_MAX_NODES = 50
# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
# root by following a path via at most 3 edges will be shown. Nodes that lay
# further from the root node will be omitted. Note that setting this option to 1
# or 2 may greatly reduce the computation time needed for large code bases. Also
# note that the size of a graph can be further restricted by
# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction.
# Minimum value: 0, maximum value: 1000, default value: 0.
# This tag requires that the tag HAVE_DOT is set to YES.
MAX_DOT_GRAPH_DEPTH = 0
# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output
# files in one run (i.e. multiple -o and -T options on the command line). This
# makes dot run faster, but since only newer versions of dot (>1.8.10) support
# this, this feature is disabled by default.
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.
DOT_MULTI_TARGETS = NO
# If the GENERATE_LEGEND tag is set to YES doxygen will generate a legend page
# explaining the meaning of the various boxes and arrows in the dot generated
# graphs.
# Note: This tag requires that UML_LOOK isn't set, i.e. the doxygen internal
# graphical representation for inheritance and collaboration diagrams is used.
# The default value is: YES.
# This tag requires that the tag HAVE_DOT is set to YES.
GENERATE_LEGEND = YES
# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate
# files that are used to generate the various graphs.
#
# Note: This setting is not only used for dot files but also for msc temporary
# files.
# The default value is: YES.
DOT_CLEANUP = YES
# You can define message sequence charts within doxygen comments using the \msc
# command. If the MSCGEN_TOOL tag is left empty (the default), then doxygen will
# use a built-in version of mscgen tool to produce the charts. Alternatively,
# the MSCGEN_TOOL tag can also specify the name an external tool. For instance,
# specifying prog as the value, doxygen will call the tool as prog -T
# <outfile_format> -o <outputfile> <inputfile>. The external tool should support
# output file formats "png", "eps", "svg", and "ismap".
MSCGEN_TOOL =
# The MSCFILE_DIRS tag can be used to specify one or more directories that
# contain msc files that are included in the documentation (see the \mscfile
# command).
MSCFILE_DIRS =
================================================
FILE: LICENSE
================================================
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
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, y
gitextract_rc5jeayv/
├── .clang-format
├── .clang-tidy
├── .clangd
├── .devcontainer/
│ ├── Dockerfile.alpine
│ ├── Dockerfile.debian
│ ├── Dockerfile.fedora
│ └── devcontainer.json
├── .github/
│ ├── ISSUE_TEMPLATE/
│ │ ├── bug_report.md
│ │ ├── config.yml
│ │ └── feature_request.md
│ ├── dependabot.yml
│ ├── pull_request_template.md
│ └── workflows/
│ ├── ci.yml
│ └── package.yml
├── .gitignore
├── CMakeLists.txt
├── CONTRIBUTING.md
├── Doxyfile
├── LICENSE
├── README.md
├── TODO.md
├── _CMakePresets.json
├── _config.yml
├── changelog.md
├── client/
│ ├── CMakeLists.txt
│ ├── browseZeroConf/
│ │ ├── browse_avahi.cpp
│ │ ├── browse_avahi.hpp
│ │ ├── browse_bonjour.cpp
│ │ ├── browse_bonjour.hpp
│ │ ├── browse_mdns.hpp
│ │ └── browse_zeroconf.hpp
│ ├── build_android.sh
│ ├── build_android_all.sh
│ ├── client_connection.cpp
│ ├── client_connection.hpp
│ ├── client_settings.hpp
│ ├── controller.cpp
│ ├── controller.hpp
│ ├── decoder/
│ │ ├── decoder.hpp
│ │ ├── flac_decoder.cpp
│ │ ├── flac_decoder.hpp
│ │ ├── null_decoder.cpp
│ │ ├── null_decoder.hpp
│ │ ├── ogg_decoder.cpp
│ │ ├── ogg_decoder.hpp
│ │ ├── opus_decoder.cpp
│ │ ├── opus_decoder.hpp
│ │ ├── pcm_decoder.cpp
│ │ └── pcm_decoder.hpp
│ ├── double_buffer.hpp
│ ├── etc/
│ │ └── snapclient.plist
│ ├── player/
│ │ ├── alsa_player.cpp
│ │ ├── alsa_player.hpp
│ │ ├── coreaudio_player.cpp
│ │ ├── coreaudio_player.hpp
│ │ ├── file_player.cpp
│ │ ├── file_player.hpp
│ │ ├── oboe_player.cpp
│ │ ├── oboe_player.hpp
│ │ ├── opensl_player.cpp
│ │ ├── opensl_player.hpp
│ │ ├── pcm_device.hpp
│ │ ├── pipewire_player.cpp
│ │ ├── pipewire_player.hpp
│ │ ├── player.cpp
│ │ ├── player.hpp
│ │ ├── pulse_player.cpp
│ │ ├── pulse_player.hpp
│ │ ├── sdl2_player.cpp
│ │ ├── sdl2_player.hpp
│ │ ├── wasapi_player.cpp
│ │ └── wasapi_player.hpp
│ ├── snapclient.1
│ ├── snapclient.cpp
│ ├── stream.cpp
│ ├── stream.hpp
│ ├── time_provider.cpp
│ └── time_provider.hpp
├── cmake/
│ ├── CheckAtomic.cmake
│ ├── CheckCXX11StringSupport.cmake
│ ├── SystemdService.cmake
│ ├── TargetArch.cmake
│ ├── clang-tidy.cmake
│ ├── cppcheck.cmake
│ └── reformat.cmake
├── common/
│ ├── CMakeLists.txt
│ ├── aixlog.hpp
│ ├── base64.cpp
│ ├── base64.h
│ ├── daemon.cpp
│ ├── daemon.hpp
│ ├── endian.hpp
│ ├── error_code.hpp
│ ├── json.hpp
│ ├── message/
│ │ ├── client_info.hpp
│ │ ├── codec_header.hpp
│ │ ├── error.hpp
│ │ ├── factory.hpp
│ │ ├── hello.hpp
│ │ ├── json_message.hpp
│ │ ├── message.hpp
│ │ ├── pcm_chunk.hpp
│ │ ├── server_settings.hpp
│ │ ├── time.hpp
│ │ └── wire_chunk.hpp
│ ├── popl.hpp
│ ├── queue.hpp
│ ├── resampler.cpp
│ ├── resampler.hpp
│ ├── sample_format.cpp
│ ├── sample_format.hpp
│ ├── snap_exception.hpp
│ ├── str_compat.hpp
│ ├── stream_uri.cpp
│ ├── stream_uri.hpp
│ ├── time_defs.hpp
│ ├── utils/
│ │ ├── file_utils.cpp
│ │ ├── file_utils.hpp
│ │ ├── logging.hpp
│ │ ├── string_utils.cpp
│ │ └── string_utils.hpp
│ ├── utils.hpp
│ └── version.hpp
├── control/
│ ├── control.py
│ ├── scripts.md
│ ├── setVolume.py
│ ├── snapcast_mpris.py
│ └── testClient.py
├── doc/
│ ├── binary_protocol.md
│ ├── build.md
│ ├── client/
│ │ └── pipewire_player.md
│ ├── configuration.md
│ ├── contributions.md
│ ├── install.md
│ ├── json_rpc_api/
│ │ ├── control.md
│ │ └── stream_plugin.md
│ ├── pipewire-stream.md
│ └── player_setup.md
├── extras/
│ ├── changelog_current_version.py
│ └── package/
│ ├── debian/
│ │ ├── README.source
│ │ ├── changelog
│ │ ├── changelog_md2deb.py
│ │ ├── compat
│ │ ├── control
│ │ ├── copyright
│ │ ├── rules
│ │ ├── snapclient.default
│ │ ├── snapclient.init
│ │ ├── snapclient.install
│ │ ├── snapclient.manpages
│ │ ├── snapclient.postinst
│ │ ├── snapclient.postrm
│ │ ├── snapclient.service
│ │ ├── snapserver.default
│ │ ├── snapserver.docs
│ │ ├── snapserver.init
│ │ ├── snapserver.install
│ │ ├── snapserver.manpages
│ │ ├── snapserver.postinst
│ │ ├── snapserver.postrm
│ │ ├── snapserver.service
│ │ └── source/
│ │ ├── format
│ │ └── local-options
│ ├── mac/
│ │ ├── readme.md
│ │ └── snapclient.plist
│ └── rpm/
│ ├── snapcast.changes
│ ├── snapcast.spec
│ ├── snapclient.default
│ ├── snapclient.service
│ ├── snapserver.default
│ └── snapserver.service
├── server/
│ ├── CMakeLists.txt
│ ├── authinfo.cpp
│ ├── authinfo.hpp
│ ├── build_android.sh
│ ├── config.cpp
│ ├── config.hpp
│ ├── control_requests.cpp
│ ├── control_requests.hpp
│ ├── control_server.cpp
│ ├── control_server.hpp
│ ├── control_session.hpp
│ ├── control_session_http.cpp
│ ├── control_session_http.hpp
│ ├── control_session_tcp.cpp
│ ├── control_session_tcp.hpp
│ ├── control_session_ws.cpp
│ ├── control_session_ws.hpp
│ ├── encoder/
│ │ ├── encoder.hpp
│ │ ├── encoder_factory.cpp
│ │ ├── encoder_factory.hpp
│ │ ├── flac_encoder.cpp
│ │ ├── flac_encoder.hpp
│ │ ├── null_encoder.cpp
│ │ ├── null_encoder.hpp
│ │ ├── ogg_encoder.cpp
│ │ ├── ogg_encoder.hpp
│ │ ├── opus_encoder.cpp
│ │ ├── opus_encoder.hpp
│ │ ├── pcm_encoder.cpp
│ │ └── pcm_encoder.hpp
│ ├── etc/
│ │ ├── index.html
│ │ ├── plug-ins/
│ │ │ ├── example.py
│ │ │ ├── meta_go-librespot.py
│ │ │ ├── meta_librespot-java.py
│ │ │ ├── meta_mopidy.py
│ │ │ ├── meta_mpd.py
│ │ │ └── plex_bridge.py
│ │ ├── snapserver.bsd
│ │ ├── snapserver.plist
│ │ └── snapweb/
│ │ └── index.html
│ ├── image_cache.hpp
│ ├── jsonrpcpp.hpp
│ ├── jwt.cpp
│ ├── jwt.hpp
│ ├── publishZeroConf/
│ │ ├── publish_avahi.cpp
│ │ ├── publish_avahi.hpp
│ │ ├── publish_bonjour.cpp
│ │ ├── publish_bonjour.hpp
│ │ ├── publish_mdns.hpp
│ │ └── publish_zeroconf.hpp
│ ├── server.cpp
│ ├── server.hpp
│ ├── server_settings.hpp
│ ├── snapserver.1
│ ├── snapserver.cpp
│ ├── stream_server.cpp
│ ├── stream_server.hpp
│ ├── stream_session.cpp
│ ├── stream_session.hpp
│ ├── stream_session_tcp.cpp
│ ├── stream_session_tcp.hpp
│ ├── stream_session_ws.cpp
│ ├── stream_session_ws.hpp
│ └── streamreader/
│ ├── airplay_stream.cpp
│ ├── airplay_stream.hpp
│ ├── alsa_stream.cpp
│ ├── alsa_stream.hpp
│ ├── asio_stream.hpp
│ ├── control_error.cpp
│ ├── control_error.hpp
│ ├── file_stream.cpp
│ ├── file_stream.hpp
│ ├── jack_stream.cpp
│ ├── jack_stream.hpp
│ ├── librespot_stream.cpp
│ ├── librespot_stream.hpp
│ ├── meta_stream.cpp
│ ├── meta_stream.hpp
│ ├── metadata.cpp
│ ├── metadata.hpp
│ ├── pcm_stream.cpp
│ ├── pcm_stream.hpp
│ ├── pipe_stream.cpp
│ ├── pipe_stream.hpp
│ ├── pipewire_stream.cpp
│ ├── pipewire_stream.hpp
│ ├── process_stream.cpp
│ ├── process_stream.hpp
│ ├── properties.cpp
│ ├── properties.hpp
│ ├── stream_control.cpp
│ ├── stream_control.hpp
│ ├── stream_manager.cpp
│ ├── stream_manager.hpp
│ ├── tcp_stream.cpp
│ ├── tcp_stream.hpp
│ ├── watchdog.cpp
│ └── watchdog.hpp
└── test/
├── CMakeLists.txt
└── test_main.cpp
SYMBOL INDEX (1511 symbols across 167 files)
FILE: client/browseZeroConf/browse_avahi.hpp
class BrowseAvahi (line 33) | class BrowseAvahi : public BrowsemDNS
FILE: client/browseZeroConf/browse_bonjour.cpp
type DNSServiceRefDeleter (line 44) | struct DNSServiceRefDeleter
function string (line 57) | string BonjourGetError(DNSServiceErrorType error)
type mDNSReply (line 161) | struct mDNSReply
type mDNSResolve (line 169) | struct mDNSResolve
function runService (line 180) | void runService(const DNSServiceHandle& service)
FILE: client/browseZeroConf/browse_bonjour.hpp
class BrowseBonjour (line 30) | class BrowseBonjour : public BrowsemDNS
FILE: client/browseZeroConf/browse_mdns.hpp
type IPVersion (line 26) | enum class IPVersion
type mDNSResult (line 33) | struct mDNSResult
class BrowsemDNS (line 44) | class BrowsemDNS
FILE: client/client_connection.cpp
function tcp_websocket (line 434) | tcp_websocket& ClientConnectionWs::getWs()
function ssl_websocket (line 564) | ssl_websocket& ClientConnectionWss::getWs()
FILE: client/client_connection.hpp
class ClientConnection (line 57) | class ClientConnection
method sendRequest (line 135) | void sendRequest(const msg::message_ptr& message, const chronos::usec&...
type PendingMessage (line 192) | struct PendingMessage
method PendingMessage (line 195) | PendingMessage(msg::message_ptr msg, ResultHandler handler) : msg(st...
class PendingRequest (line 63) | class PendingRequest : public std::enable_shared_from_this<PendingRequest>
class ClientConnection (line 103) | class ClientConnection
method sendRequest (line 135) | void sendRequest(const msg::message_ptr& message, const chronos::usec&...
type PendingMessage (line 192) | struct PendingMessage
method PendingMessage (line 195) | PendingMessage(msg::message_ptr msg, ResultHandler handler) : msg(st...
class ClientConnectionTcp (line 210) | class ClientConnectionTcp : public ClientConnection
class ClientConnectionWs (line 234) | class ClientConnectionWs : public ClientConnection
class ClientConnectionWss (line 265) | class ClientConnectionWss : public ClientConnection
FILE: client/client_settings.hpp
type ClientSettings (line 33) | struct ClientSettings
type SharingMode (line 36) | enum class SharingMode : char
type Mixer (line 44) | struct Mixer
type Mode (line 47) | enum class Mode : char
type Server (line 62) | struct Server
type Auth (line 65) | struct Auth
method isSsl (line 86) | bool isSsl() const
type Player (line 93) | struct Player
type Logging (line 112) | struct Logging
FILE: client/controller.hpp
class Controller (line 43) | class Controller
FILE: client/decoder/decoder.hpp
type decoder (line 31) | namespace decoder
class Decoder (line 35) | class Decoder
method Decoder (line 39) | Decoder() = default;
FILE: client/decoder/flac_decoder.cpp
type decoder (line 36) | namespace decoder
type callback (line 39) | namespace callback
function FLAC__StreamDecoderReadStatus (line 136) | FLAC__StreamDecoderReadStatus read_callback(const FLAC__StreamDecode...
function FLAC__StreamDecoderWriteStatus (line 163) | FLAC__StreamDecoderWriteStatus write_callback(const FLAC__StreamDeco...
function metadata_callback (line 210) | void metadata_callback(const FLAC__StreamDecoder* /*decoder*/, const...
function error_callback (line 222) | void error_callback(const FLAC__StreamDecoder* /*decoder*/, FLAC__St...
function SampleFormat (line 112) | SampleFormat FlacDecoder::setHeader(msg::CodecHeader* chunk)
type callback (line 133) | namespace callback
function FLAC__StreamDecoderReadStatus (line 136) | FLAC__StreamDecoderReadStatus read_callback(const FLAC__StreamDecode...
function FLAC__StreamDecoderWriteStatus (line 163) | FLAC__StreamDecoderWriteStatus write_callback(const FLAC__StreamDeco...
function metadata_callback (line 210) | void metadata_callback(const FLAC__StreamDecoder* /*decoder*/, const...
function error_callback (line 222) | void error_callback(const FLAC__StreamDecoder* /*decoder*/, FLAC__St...
FILE: client/decoder/flac_decoder.hpp
type decoder (line 32) | namespace decoder
type CacheInfo (line 37) | struct CacheInfo
method reset (line 40) | void reset()
class FlacDecoder (line 53) | class FlacDecoder : public Decoder
FILE: client/decoder/null_decoder.cpp
type decoder (line 29) | namespace decoder
function SampleFormat (line 43) | SampleFormat NullDecoder::setHeader(msg::CodecHeader* chunk)
FILE: client/decoder/null_decoder.hpp
type decoder (line 25) | namespace decoder
class NullDecoder (line 29) | class NullDecoder : public Decoder
FILE: client/decoder/ogg_decoder.cpp
type decoder (line 44) | namespace decoder
function SampleFormat (line 175) | SampleFormat OggDecoder::setHeader(msg::CodecHeader* chunk)
FILE: client/decoder/ogg_decoder.hpp
type decoder (line 36) | namespace decoder
class OggDecoder (line 40) | class OggDecoder : public Decoder
method T (line 54) | T clip(const IN_TYPE& value, const T& lower, const T& upper) const
FILE: client/decoder/opus_decoder.cpp
type decoder (line 28) | namespace decoder
function SampleFormat (line 90) | SampleFormat OpusDecoder::setHeader(msg::CodecHeader* chunk)
FILE: client/decoder/opus_decoder.hpp
type decoder (line 36) | namespace decoder
class OpusDecoder (line 40) | class OpusDecoder : public Decoder
FILE: client/decoder/pcm_decoder.cpp
type decoder (line 27) | namespace decoder
type riff_wave_header (line 37) | struct riff_wave_header
type chunk_header (line 47) | struct chunk_header
type chunk_fmt (line 56) | struct chunk_fmt
function SampleFormat (line 78) | SampleFormat PcmDecoder::setHeader(msg::CodecHeader* chunk)
FILE: client/decoder/pcm_decoder.hpp
type decoder (line 25) | namespace decoder
class PcmDecoder (line 29) | class PcmDecoder : public Decoder
FILE: client/double_buffer.hpp
class DoubleBuffer (line 36) | class DoubleBuffer
method DoubleBuffer (line 40) | explicit DoubleBuffer(size_t size = 10) : bufferSize(size)
method add (line 45) | inline void add(const T& element)
method add (line 53) | inline void add(T&& element)
method T (line 61) | T median(uint16_t mean = 1) const
method mean (line 85) | double mean() const
method T (line 96) | T percentile(unsigned int percentile) const
method percentiles (line 107) | std::array<T, Size> percentiles(std::array<uint8_t, Size> percentiles)...
method full (line 122) | inline bool full() const
method clear (line 128) | inline void clear()
method size (line 134) | inline size_t size() const
method empty (line 140) | inline bool empty() const
method setSize (line 146) | void setSize(size_t size)
FILE: client/player/alsa_player.cpp
type player (line 39) | namespace player
FILE: client/player/alsa_player.hpp
type player (line 35) | namespace player
class AlsaPlayer (line 44) | class AlsaPlayer : public Player
FILE: client/player/coreaudio_player.cpp
type player (line 28) | namespace player
function callback (line 38) | void callback(void* custom_data, AudioQueueRef queue, AudioQueueBuffer...
FILE: client/player/coreaudio_player.hpp
type player (line 31) | namespace player
class CoreAudioPlayer (line 45) | class CoreAudioPlayer : public Player
FILE: client/player/file_player.cpp
type player (line 35) | namespace player
FILE: client/player/file_player.hpp
type player (line 33) | namespace player
class FilePlayer (line 41) | class FilePlayer : public Player
FILE: client/player/oboe_player.cpp
type player (line 35) | namespace player
FILE: client/player/oboe_player.hpp
type player (line 32) | namespace player
class OboePlayer (line 41) | class OboePlayer : public Player, public oboe::AudioStreamDataCallback...
FILE: client/player/opensl_player.cpp
type player (line 35) | namespace player
function bqPlayerCallback (line 54) | static void bqPlayerCallback(SLAndroidSimpleBufferQueueItf bq, void* c...
FILE: client/player/opensl_player.hpp
type player (line 33) | namespace player
class OpenslPlayer (line 47) | class OpenslPlayer : public Player
FILE: client/player/pcm_device.hpp
type player (line 24) | namespace player
type PcmDevice (line 31) | struct PcmDevice
method PcmDevice (line 34) | PcmDevice() : idx(-1), name(DEFAULT_DEVICE){}
method PcmDevice (line 37) | PcmDevice(int idx, std::string name, std::string description = "") :...
FILE: client/player/pipewire_player.cpp
type player (line 43) | namespace player
function spa_audio_format (line 55) | spa_audio_format sampleFormatToPipeWire(const SampleFormat& format)
type pw_registry_events (line 123) | struct pw_registry_events
type spa_dict (line 126) | struct spa_dict
type spa_hook (line 156) | struct spa_hook
type pw_proxy (line 166) | struct pw_proxy
type pw_buffer (line 274) | struct pw_buffer
type pw_time (line 322) | struct pw_time
type spa_pod (line 360) | struct spa_pod
type spa_audio_info_raw (line 395) | struct spa_audio_info_raw
type spa_pod (line 406) | struct spa_pod
type spa_pod_builder (line 425) | struct spa_pod_builder
type spa_audio_info_raw (line 495) | struct spa_audio_info_raw
type spa_pod (line 514) | struct spa_pod
type spa_loop (line 552) | struct spa_loop
FILE: client/player/pipewire_player.hpp
type player (line 37) | namespace player
class PipeWirePlayer (line 43) | class PipeWirePlayer : public Player
type spa_pod (line 60) | struct spa_pod
type spa_pod (line 66) | struct spa_pod
type pw_main_loop (line 75) | struct pw_main_loop
type pw_stream (line 76) | struct pw_stream
type pw_stream_events (line 79) | struct pw_stream_events
FILE: client/player/player.cpp
type player (line 49) | namespace player
FILE: client/player/player.hpp
type player (line 40) | namespace player
class Player (line 47) | class Player
type Volume (line 51) | struct Volume
method setVolumeCallback (line 75) | void setVolumeCallback(const volume_callback& callback)
method notifyVolumeChange (line 105) | void notifyVolumeChange(const Volume& volume) const
method adjustVolume (line 132) | void adjustVolume(char* buffer, size_t count, double volume)
FILE: client/player/pulse_player.cpp
type player (line 39) | namespace player
FILE: client/player/pulse_player.hpp
type player (line 34) | namespace player
class PulsePlayer (line 42) | class PulsePlayer : public Player
FILE: client/player/sdl2_player.cpp
type player (line 35) | namespace player
FILE: client/player/sdl2_player.hpp
type player (line 33) | namespace player
class Sdl2Player (line 43) | class Sdl2Player : public Player
FILE: client/player/wasapi_player.cpp
type player (line 45) | namespace player
type COMMemDeleter (line 52) | struct COMMemDeleter
function PcmDevice (line 114) | inline PcmDevice convertToDevice(int idx, IMMDevicePtr& device)
function HRESULT (line 442) | HRESULT STDMETHODCALLTYPE AudioSessionEventListener::QueryInterface(RE...
function HRESULT (line 462) | HRESULT STDMETHODCALLTYPE AudioSessionEventListener::OnSimpleVolumeCha...
function HRESULT (line 480) | HRESULT STDMETHODCALLTYPE AudioSessionEventListener::OnStateChanged(Au...
function HRESULT (line 498) | HRESULT STDMETHODCALLTYPE AudioSessionEventListener::OnSessionDisconne...
function HRESULT (line 530) | HRESULT STDMETHODCALLTYPE AudioEndpointVolumeCallback::OnNotify(PAUDIO...
FILE: client/player/wasapi_player.hpp
type player (line 32) | namespace player
class AudioSessionEventListener (line 36) | class AudioSessionEventListener : public IAudioSessionEvents
method AudioSessionEventListener (line 45) | AudioSessionEventListener() : _cRef(1)
method getVolume (line 50) | float getVolume()
method getMuted (line 56) | bool getMuted()
method AddRef (line 69) | AddRef()
method Release (line 75) | Release()
method OnDisplayNameChanged (line 91) | OnDisplayNameChanged(LPCWSTR NewDisplayName, LPCGUID EventContext)
method OnIconPathChanged (line 97) | OnIconPathChanged(LPCWSTR NewIconPath, LPCGUID EventContext)
method OnChannelVolumeChanged (line 106) | OnChannelVolumeChanged(DWORD ChannelCount, float NewChannelVolumeArr...
method OnGroupingParamChanged (line 112) | OnGroupingParamChanged(LPCGUID NewGroupingParam, LPCGUID EventContext)
class AudioEndpointVolumeCallback (line 126) | class AudioEndpointVolumeCallback : public IAudioEndpointVolumeCallback
method AudioEndpointVolumeCallback (line 134) | AudioEndpointVolumeCallback() : _cRef(1)
method getVolume (line 144) | float getVolume()
method getMuted (line 150) | bool getMuted()
method AddRef (line 158) | AddRef()
method Release (line 164) | Release()
method QueryInterface (line 175) | QueryInterface(REFIID riid, VOID** ppvInterface)
class WASAPIPlayer (line 205) | class WASAPIPlayer : public Player
method needsThread (line 218) | bool needsThread() const override
FILE: client/snapclient.cpp
function PcmDevice (line 73) | PcmDevice getPcmDevice(const std::string& player, const std::string& par...
function main (line 142) | int main(int argc, char** argv)
FILE: client/stream.hpp
class Stream (line 45) | class Stream
method SampleFormat (line 75) | const SampleFormat& getFormat() const
FILE: client/time_provider.hpp
class TimeProvider (line 40) | class TimeProvider
method TimeProvider (line 44) | static TimeProvider& getInstance()
method T (line 57) | inline T getDiffToServer() const
method T (line 69) | static T sinceEpoche(const chronos::time_point_clk& point)
method toTimePoint (line 75) | static chronos::time_point_clk toTimePoint(const tv& timeval)
method now (line 81) | inline static chronos::time_point_clk now()
method serverNow (line 87) | inline static chronos::time_point_clk serverNow()
FILE: common/aixlog.hpp
type SEVERITY (line 132) | enum SEVERITY
type AixLog (line 143) | namespace AixLog
type Severity (line 152) | enum class Severity : std::int8_t
function Severity (line 179) | static Severity to_severity(std::string severity, Severity def = Sever...
function to_string (line 201) | static std::string to_string(Severity logSeverity)
type Color (line 230) | enum class Color
type TextColor (line 256) | struct TextColor
method TextColor (line 258) | TextColor(Color foreground = Color::none, Color background = Color::...
type Conditional (line 270) | struct Conditional
method Conditional (line 274) | Conditional() : func_([](void) { return true; })
method Conditional (line 278) | Conditional(EvalFunc func) : func_(std::move(func))
method Conditional (line 282) | Conditional(bool value) : func_([value](void) { return value; })
method is_true (line 288) | virtual bool is_true() const
type Timestamp (line 303) | struct Timestamp
method Timestamp (line 307) | Timestamp(std::nullptr_t) : is_null_(true)
method Timestamp (line 311) | Timestamp() : Timestamp(nullptr)
method Timestamp (line 315) | Timestamp(const time_point_sys_clock& time_point) : time_point(time_...
method Timestamp (line 319) | Timestamp(time_point_sys_clock&& time_point) : time_point(time_point...
method to_string (line 331) | std::string to_string(const std::string& format = "%Y-%m-%d %H-%M-%S...
method localtime_xp (line 354) | inline std::tm localtime_xp(std::time_t timer) const
type Tag (line 374) | struct Tag
method Tag (line 376) | Tag(std::nullptr_t) : is_null_(true)
method Tag (line 380) | Tag() : Tag(nullptr)
method Tag (line 384) | Tag(const char* text) : text(text), is_null_(false)
method Tag (line 388) | Tag(const std::string& text) : text(text), is_null_(false)
method Tag (line 392) | Tag(std::string&& text) : text(std::move(text)), is_null_(false)
type Function (line 418) | struct Function
method Function (line 420) | Function(const std::string& name, const std::string& file, size_t li...
method Function (line 424) | Function(std::string&& name, std::string&& file, size_t line) : name...
method Function (line 428) | Function(std::nullptr_t) : line(0), is_null_(true)
method Function (line 432) | Function() : Function(nullptr)
type Metadata (line 455) | struct Metadata
method Metadata (line 457) | Metadata() : severity(Severity::trace), tag(nullptr), function(nullp...
class Filter (line 468) | class Filter
method Filter (line 471) | Filter()
method Filter (line 475) | Filter(Severity severity)
method match (line 480) | bool match(const Metadata& metadata) const
method add_filter (line 496) | void add_filter(const Tag& tag, Severity severity)
method add_filter (line 501) | void add_filter(Severity severity)
method add_filter (line 506) | void add_filter(const std::string& filter)
type Sink (line 526) | struct Sink
method Sink (line 528) | Sink(Filter filter) : filter(std::move(filter))
class Log (line 558) | class Log : public std::basic_streambuf<char, std::char_traits<char>>
method Log (line 561) | static Log& instance()
method init (line 568) | static void init(const std::vector<log_sink_ptr>& log_sinks = {})
method init (line 577) | static std::shared_ptr<T> init(Ts&&... params)
method add_logsink (line 585) | std::shared_ptr<T> add_logsink(Ts&&... params)
method add_logsink (line 594) | void add_logsink(const log_sink_ptr& sink)
method remove_logsink (line 600) | void remove_logsink(const log_sink_ptr& sink)
method Log (line 607) | Log() noexcept : last_buffer_(nullptr), do_log_(true)
method sync (line 618) | int sync() override
method overflow (line 638) | int overflow(int c) override
type SinkNull (line 691) | struct SinkNull : public Sink
method SinkNull (line 693) | SinkNull() : Sink(Filter())
method log (line 697) | void log(const Metadata& /*metadata*/, const std::string& /*message*...
type SinkFormat (line 717) | struct SinkFormat : public Sink
method SinkFormat (line 719) | SinkFormat(const Filter& filter, const std::string& format) : Sink(f...
method set_format (line 723) | virtual void set_format(const std::string& format)
method do_log (line 731) | virtual void do_log(std::ostream& stream, const Metadata& metadata, ...
type SinkCout (line 783) | struct SinkCout : public SinkFormat
method SinkCout (line 785) | SinkCout(const Filter& filter, const std::string& format = "%Y-%m-%d...
method log (line 789) | void log(const Metadata& metadata, const std::string& message) override
type SinkCerr (line 799) | struct SinkCerr : public SinkFormat
method SinkCerr (line 801) | SinkCerr(const Filter& filter, const std::string& format = "%Y-%m-%d...
method log (line 805) | void log(const Metadata& metadata, const std::string& message) override
type SinkFile (line 815) | struct SinkFile : public SinkFormat
method SinkFile (line 817) | SinkFile(const Filter& filter, const std::string& filename, const st...
method log (line 828) | void log(const Metadata& metadata, const std::string& message) override
type SinkOutputDebugString (line 844) | struct SinkOutputDebugString : public Sink
method SinkOutputDebugString (line 846) | SinkOutputDebugString(const Filter& filter) : Sink(filter)
method log (line 850) | void log(const Metadata& /*metadata*/, const std::string& message) o...
type SinkUnifiedLogging (line 867) | struct SinkUnifiedLogging : public Sink
method SinkUnifiedLogging (line 869) | SinkUnifiedLogging(const Filter& filter) : Sink(filter)
method os_log_type_t (line 873) | os_log_type_t get_os_log_type(Severity severity) const
method log (line 895) | void log(const Metadata& metadata, const std::string& message) override
type SinkSyslog (line 907) | struct SinkSyslog : public Sink
method SinkSyslog (line 909) | SinkSyslog(const char* ident, const Filter& filter) : Sink(filter)
method get_syslog_priority (line 919) | int get_syslog_priority(Severity severity) const
method log (line 942) | void log(const Metadata& metadata, const std::string& message) override
type SinkAndroid (line 956) | struct SinkAndroid : public Sink
method SinkAndroid (line 958) | SinkAndroid(const std::string& ident, const Filter& filter) : Sink(f...
method android_LogPriority (line 962) | android_LogPriority get_android_prio(Severity severity) const
method log (line 985) | void log(const Metadata& metadata, const std::string& message) override
type SinkEventLog (line 1013) | struct SinkEventLog : public Sink
method SinkEventLog (line 1015) | SinkEventLog(const std::string& ident, const Filter& filter) : Sink(...
method WORD (line 1025) | WORD get_type(Severity severity) const
method log (line 1046) | void log(const Metadata& metadata, const std::string& message) override
type SinkNative (line 1073) | struct SinkNative : public Sink
method SinkNative (line 1075) | SinkNative(const std::string& ident, const Filter& filter) : Sink(fi...
method log_sink_ptr (line 1091) | virtual log_sink_ptr get_logger()
method log (line 1096) | void log(const Metadata& metadata, const std::string& message) override
type SinkCallback (line 1115) | struct SinkCallback : public Sink
method SinkCallback (line 1119) | SinkCallback(const Filter& filter, callback_fun callback) : Sink(fil...
method log (line 1123) | void log(const Metadata& metadata, const std::string& message) override
FILE: common/base64.cpp
function is_base64 (line 41) | static inline bool is_base64(unsigned char c)
function base64_encode (line 46) | std::string base64_encode(const unsigned char* bytes_to_encode, size_t i...
function base64_encode (line 90) | std::string base64_encode(const std::string& text)
function base64_decode (line 95) | std::string base64_decode(const std::string& encoded_string)
function base64url_encode (line 144) | std::string base64url_encode(const unsigned char* bytes_to_encode, size_...
function base64url_encode (line 153) | std::string base64url_encode(const std::string& text)
function base64url_decode (line 158) | std::string base64url_decode(const std::string& encoded_string)
FILE: common/daemon.cpp
type passwd (line 76) | struct passwd
type group (line 88) | struct group
FILE: common/daemon.hpp
class Daemon (line 26) | class Daemon
FILE: common/endian.hpp
type endian (line 34) | namespace endian
function swap (line 41) | inline int8_t swap(const int8_t& val)
function swap (line 47) | inline int16_t swap(const int16_t& val)
function swap (line 53) | inline int32_t swap(const int32_t& val)
function swap (line 59) | inline int64_t swap(const int64_t& val)
FILE: common/error_code.hpp
type snapcast (line 28) | namespace snapcast
type ErrorCode (line 32) | struct ErrorCode : public std::error_code
method ErrorCode (line 35) | ErrorCode() : std::error_code(), detail_(std::nullopt)
method ErrorCode (line 41) | ErrorCode(const std::error_code& code) : std::error_code(code), deta...
method ErrorCode (line 48) | ErrorCode(const std::error_code& code, std::string detail) : std::er...
method ErrorCode (line 53) | ErrorCode(ErrorCode&& other) = default;
method ErrorCode (line 55) | ErrorCode& operator=(ErrorCode&& rhs) = default;
method detailed_message (line 58) | std::string detailed_message() const
type ErrorOr (line 74) | struct ErrorOr
method ErrorOr (line 77) | ErrorOr(T&& t) : var(std::move(t))
method ErrorOr (line 82) | ErrorOr(const T& t) : var(t)
method ErrorOr (line 87) | ErrorOr(ErrorCode&& error) : var(std::move(error))
method ErrorOr (line 92) | ErrorOr(const ErrorCode& error) : var(error)
method hasValue (line 97) | bool hasValue()
method hasError (line 103) | bool hasError()
method T (line 109) | const T& getValue()
method T (line 115) | T&& takeValue()
method ErrorCode (line 121) | const ErrorCode& getError()
method ErrorCode (line 127) | ErrorCode&& takeError()
FILE: common/json.hpp
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 247) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 258) | NLOHMANN_JSON_NAMESPACE_END
type would_call_std_ (line 2814) | struct would_call_std_
type value_t (line 2872) | enum class value_t : std::uint8_t
function NLOHMANN_JSON_NAMESPACE_END (line 2937) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 3030) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 3076) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 3267) | NLOHMANN_JSON_NAMESPACE_BEGIN
class json_pointer (line 3416) | class json_pointer
type ordered_map (line 3427) | struct ordered_map
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 3438) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 4230) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 4358) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_END (line 4590) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 4636) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 4644) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 4659) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 5174) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 5356) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 5404) | NLOHMANN_JSON_NAMESPACE_BEGIN
type adl_serializer (line 5832) | struct adl_serializer
method from_json (line 5837) | static auto from_json(BasicJsonType && j, TargetType& val) noexcept(
method from_json (line 5847) | static auto from_json(BasicJsonType && j) noexcept(
method to_json (line 5857) | static auto to_json(BasicJsonType& j, TargetType && val) noexcept(
function set_subtype (line 5938) | void set_subtype(subtype_type subtype_) noexcept
function subtype_type (line 5946) | constexpr subtype_type subtype() const noexcept
function has_subtype (line 5953) | constexpr bool has_subtype() const noexcept
function clear_subtype (line 5960) | void clear_subtype() noexcept
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 5999) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 6171) | NLOHMANN_JSON_NAMESPACE_BEGIN
function json_sax_dom_parser (line 6813) | explicit json_sax_dom_parser(BasicJsonType& r, const bool allow_exceptio...
function json_sax_dom_parser (line 6818) | json_sax_dom_parser(const json_sax_dom_parser&) = delete;
function json_sax_dom_parser (line 6819) | json_sax_dom_parser(json_sax_dom_parser&&) = default;
function null (line 6824) | bool null()
function boolean (line 6830) | bool boolean(bool val)
function number_integer (line 6836) | bool number_integer(number_integer_t val)
function number_unsigned (line 6842) | bool number_unsigned(number_unsigned_t val)
function number_float (line 6848) | bool number_float(number_float_t val, const string_t& /*unused*/)
function string (line 6854) | bool string(string_t& val)
function binary (line 6860) | bool binary(binary_t& val)
function start_object (line 6866) | bool start_object(std::size_t len)
function key (line 6878) | bool key(string_t& val)
function end_object (line 6888) | bool end_object()
function start_array (line 6898) | bool start_array(std::size_t len)
function end_array (line 6910) | bool end_array()
function parse_error (line 6921) | bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/,
function is_errored (line 6933) | constexpr bool is_errored() const
class json_sax_dom_callback_parser (line 6982) | class json_sax_dom_callback_parser
method json_sax_dom_callback_parser (line 6993) | json_sax_dom_callback_parser(BasicJsonType& r,
method json_sax_dom_callback_parser (line 7002) | json_sax_dom_callback_parser(const json_sax_dom_callback_parser&) = de...
method json_sax_dom_callback_parser (line 7003) | json_sax_dom_callback_parser(json_sax_dom_callback_parser&&) = default;
method json_sax_dom_callback_parser (line 7004) | json_sax_dom_callback_parser& operator=(const json_sax_dom_callback_pa...
method json_sax_dom_callback_parser (line 7005) | json_sax_dom_callback_parser& operator=(json_sax_dom_callback_parser&&...
method null (line 7008) | bool null()
method boolean (line 7014) | bool boolean(bool val)
method number_integer (line 7020) | bool number_integer(number_integer_t val)
method number_unsigned (line 7026) | bool number_unsigned(number_unsigned_t val)
method number_float (line 7032) | bool number_float(number_float_t val, const string_t& /*unused*/)
method string (line 7038) | bool string(string_t& val)
method binary (line 7044) | bool binary(binary_t& val)
method start_object (line 7050) | bool start_object(std::size_t len)
method key (line 7068) | bool key(string_t& val)
method end_object (line 7085) | bool end_object()
method start_array (line 7121) | bool start_array(std::size_t len)
method end_array (line 7138) | bool end_array()
method parse_error (line 7171) | bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/,
method is_errored (line 7183) | constexpr bool is_errored() const
method handle_value (line 7205) | std::pair<bool, BasicJsonType*> handle_value(Value&& v, const bool ski...
class json_sax_acceptor (line 7289) | class json_sax_acceptor
method null (line 7298) | bool null()
method boolean (line 7303) | bool boolean(bool /*unused*/)
method number_integer (line 7308) | bool number_integer(number_integer_t /*unused*/)
method number_unsigned (line 7313) | bool number_unsigned(number_unsigned_t /*unused*/)
method number_float (line 7318) | bool number_float(number_float_t /*unused*/, const string_t& /*unused*/)
method string (line 7323) | bool string(string_t& /*unused*/)
method binary (line 7328) | bool binary(binary_t& /*unused*/)
method start_object (line 7333) | bool start_object(std::size_t /*unused*/ = static_cast<std::size_t>(-1))
method key (line 7338) | bool key(string_t& /*unused*/)
method end_object (line 7343) | bool end_object()
method start_array (line 7348) | bool start_array(std::size_t /*unused*/ = static_cast<std::size_t>(-1))
method end_array (line 7353) | bool end_array()
method parse_error (line 7358) | bool parse_error(std::size_t /*unused*/, const std::string& /*unused*/...
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 7397) | NLOHMANN_JSON_NAMESPACE_BEGIN
function reset (line 8692) | void reset() noexcept
function char_int_type (line 8709) | char_int_type get()
function unget (line 8746) | void unget()
function add (line 8773) | void add(char_int_type c)
function number_unsigned_t (line 8790) | constexpr number_unsigned_t get_number_unsigned() const noexcept
function number_float_t (line 8796) | constexpr number_float_t get_number_float() const noexcept
function string_t (line 8802) | string_t& get_string()
function position_t (line 8812) | constexpr position_t get_position() const noexcept
function get_token_string (line 8820) | std::string get_token_string() const
function JSON_HEDLEY_RETURNS_NON_NULL (line 8844) | JSON_HEDLEY_RETURNS_NON_NULL
function skip_bom (line 8858) | bool skip_bom()
function skip_whitespace (line 8872) | void skip_whitespace()
function token_type (line 8881) | token_type scan()
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 9030) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 9170) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 12195) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 12719) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 12835) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 12890) | NLOHMANN_JSON_NAMESPACE_BEGIN
function pointer (line 13192) | pointer operator->() const
function iter_impl (line 13234) | iter_impl operator++(int)& // NOLINT(cert-dcl21-cpp)
function iter_impl (line 13245) | iter_impl& operator++()
function iter_impl (line 13285) | iter_impl operator--(int)& // NOLINT(cert-dcl21-cpp)
function iter_impl (line 13296) | iter_impl& operator--()
function iter_impl (line 13444) | iter_impl& operator+=(difference_type i)
function iter_impl (line 13481) | iter_impl& operator-=(difference_type i)
function iter_impl (line 13490) | iter_impl operator+(difference_type i) const
function friend (line 13501) | friend iter_impl operator+(difference_type i, const iter_impl& it)
function iter_impl (line 13512) | iter_impl operator-(difference_type i) const
function difference_type (line 13523) | difference_type operator-(const iter_impl& other) const
function reference (line 13552) | reference operator[](difference_type n) const
function reference (line 13606) | reference value() const
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 13641) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 13774) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 13835) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_BASIC_JSON_TPL_DECLARATION (line 13855) | NLOHMANN_BASIC_JSON_TPL_DECLARATION
function json_pointer (line 13867) | explicit json_pointer(const string_t& s = "")
function string_t (line 13873) | string_t to_string() const
function friend (line 13894) | friend std::ostream& operator<<(std::ostream& o, const json_pointer& ptr)
function json_pointer (line 13903) | json_pointer& operator/=(const json_pointer& ptr)
function json_pointer (line 13913) | json_pointer& operator/=(string_t token)
function json_pointer (line 13921) | json_pointer& operator/=(std::size_t array_idx)
function friend (line 13928) | friend json_pointer operator/(const json_pointer& lhs,
function friend (line 13936) | friend json_pointer operator/(const json_pointer& lhs, string_t token) /...
function friend (line 13943) | friend json_pointer operator/(const json_pointer& lhs, std::size_t array...
function json_pointer (line 13950) | json_pointer parent_pointer() const
function pop_back (line 13964) | void pop_back()
function string_t (line 13976) | const string_t& back() const
function push_back (line 13988) | void push_back(const string_t& token)
function push_back (line 13995) | void push_back(string_t&& token)
function empty (line 14002) | bool empty() const noexcept
function BasicJsonType (line 14079) | BasicJsonType& get_and_create(BasicJsonType& j) const
function BasicJsonType (line 14159) | BasicJsonType& get_unchecked(BasicJsonType* ptr) const
function BasicJsonType (line 14227) | BasicJsonType& get_checked(BasicJsonType* ptr) const
function BasicJsonType (line 14285) | const BasicJsonType& get_unchecked(const BasicJsonType* ptr) const
function BasicJsonType (line 14334) | const BasicJsonType& get_checked(const BasicJsonType* ptr) const
function contains (line 14383) | bool contains(const BasicJsonType* ptr) const
function split (line 14471) | static std::vector<string_t> split(const string_t& reference_string)
function BasicJsonType (line 14611) | static BasicJsonType
function convert (line 14640) | json_pointer<string_t> convert() const&
function convert (line 14647) | json_pointer<string_t> convert()&&
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 14814) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 14939) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 15061) | NLOHMANN_JSON_NAMESPACE_END
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 16928) | NLOHMANN_JSON_NAMESPACE_BEGIN
function NLOHMANN_JSON_NAMESPACE_END (line 18025) | NLOHMANN_JSON_NAMESPACE_END
function hex_bytes (line 18685) | static std::string hex_bytes(std::uint8_t byte)
function is_negative_number (line 18696) | bool is_negative_number(NumberType x)
function is_negative_number (line 18702) | bool is_negative_number(NumberType /*unused*/)
function dump_integer (line 18722) | void dump_integer(NumberType x)
function dump_float (line 18807) | void dump_float(number_float_t x)
function dump_float (line 18828) | void dump_float(number_float_t x, std::true_type /*is_ieee_single_or_dou...
function dump_float (line 18836) | void dump_float(number_float_t x, std::false_type /*is_ieee_single_or_do...
function decode (line 18908) | static std::uint8_t decode(std::uint8_t& state, std::uint32_t& codep, co...
function number_unsigned_t (line 18948) | number_unsigned_t remove_sign(number_unsigned_t x)
function number_unsigned_t (line 18963) | inline number_unsigned_t remove_sign(number_integer_t x) noexcept
function ordered_map (line 19050) | ordered_map() noexcept(noexcept(Container())) : Container{} {}
function ordered_map (line 19051) | explicit ordered_map(const Allocator& alloc) noexcept(noexcept(Container...
function ordered_map (line 19053) | ordered_map(It first, It last, const Allocator& alloc = Allocator())
function ordered_map (line 19055) | ordered_map(std::initializer_list<value_type> init, const Allocator& all...
function emplace (line 19058) | std::pair<iterator, bool> emplace(const key_type& key, T&& t)
function emplace (line 19073) | std::pair<iterator, bool> emplace(KeyType && key, T && t)
function T (line 19086) | T& operator[](const key_type& key)
function T (line 19093) | T & operator[](KeyType && key)
function T (line 19098) | const T& operator[](const key_type& key) const
function T (line 19105) | const T & operator[](KeyType && key) const
function T (line 19110) | T& at(const key_type& key)
function T (line 19125) | T & at(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-forward)
function T (line 19138) | const T& at(const key_type& key) const
function T (line 19153) | const T & at(KeyType && key) const // NOLINT(cppcoreguidelines-missing-s...
function size_type (line 19166) | size_type erase(const key_type& key)
function size_type (line 19187) | size_type erase(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-...
function iterator (line 19206) | iterator erase(iterator pos)
function iterator (line 19211) | iterator erase(iterator first, iterator last)
function size_type (line 19264) | size_type count(const key_type& key) const
function size_type (line 19278) | size_type count(KeyType && key) const // NOLINT(cppcoreguidelines-missin...
function iterator (line 19290) | iterator find(const key_type& key)
function iterator (line 19304) | iterator find(KeyType && key) // NOLINT(cppcoreguidelines-missing-std-fo...
function const_iterator (line 19316) | const_iterator find(const key_type& key) const
function insert (line 19328) | std::pair<iterator, bool> insert( value_type&& value )
function insert (line 19333) | std::pair<iterator, bool> insert( const value_type& value )
function insert (line 19351) | void insert(InputIt first, InputIt last)
function NLOHMANN_JSON_NAMESPACE_BEGIN (line 19378) | NLOHMANN_JSON_NAMESPACE_BEGIN
function set_parents (line 20005) | void set_parents()
function iterator (line 20042) | iterator set_parents(iterator it, typename iterator::difference_type cou...
function reference (line 20055) | reference set_parent(reference j, std::size_t old_capacity = static_cast...
function basic_json (line 20117) | basic_json(const value_t v)
function basic_json (line 20125) | basic_json(std::nullptr_t = nullptr) noexcept // NOLINT(bugprone-excepti...
function basic_json (line 20137) | basic_json(CompatibleType && val) noexcept(noexcept( // NOLINT(bugprone-...
function basic_json (line 20151) | basic_json(const BasicJsonType& val)
function basic_json (line 20204) | basic_json(initializer_list_t init,
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20262) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20273) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20284) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20295) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20306) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 20314) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 20322) | basic_json(size_type cnt, const basic_json& val):
function basic_json (line 20334) | basic_json(InputIT first, InputIT last)
function basic_json (line 20443) | basic_json(const JsonRef& ref) : basic_json(ref.moved_or_copied()) {}
function basic_json (line 20447) | basic_json(const basic_json& other)
function basic_json (line 20516) | basic_json(basic_json&& other) noexcept
function basic_json (line 20533) | basic_json& operator=(basic_json other) noexcept (
function value_t (line 20596) | constexpr value_t type() const noexcept
function is_primitive (line 20603) | constexpr bool is_primitive() const noexcept
function is_structured (line 20610) | constexpr bool is_structured() const noexcept
function is_null (line 20617) | constexpr bool is_null() const noexcept
function is_boolean (line 20624) | constexpr bool is_boolean() const noexcept
function is_number (line 20631) | constexpr bool is_number() const noexcept
function is_number_integer (line 20638) | constexpr bool is_number_integer() const noexcept
function is_number_unsigned (line 20645) | constexpr bool is_number_unsigned() const noexcept
function is_number_float (line 20652) | constexpr bool is_number_float() const noexcept
function is_object (line 20659) | constexpr bool is_object() const noexcept
function is_array (line 20666) | constexpr bool is_array() const noexcept
function is_string (line 20673) | constexpr bool is_string() const noexcept
function is_binary (line 20680) | constexpr bool is_binary() const noexcept
function is_discarded (line 20687) | constexpr bool is_discarded() const noexcept
function object_t (line 20718) | object_t* get_impl_ptr(object_t* /*unused*/) noexcept
function object_t (line 20724) | constexpr const object_t* get_impl_ptr(const object_t* /*unused*/) const...
function array_t (line 20730) | array_t* get_impl_ptr(array_t* /*unused*/) noexcept
function array_t (line 20736) | constexpr const array_t* get_impl_ptr(const array_t* /*unused*/) const n...
function string_t (line 20742) | string_t* get_impl_ptr(string_t* /*unused*/) noexcept
function string_t (line 20748) | constexpr const string_t* get_impl_ptr(const string_t* /*unused*/) const...
function boolean_t (line 20754) | boolean_t* get_impl_ptr(boolean_t* /*unused*/) noexcept
function boolean_t (line 20760) | constexpr const boolean_t* get_impl_ptr(const boolean_t* /*unused*/) con...
function number_integer_t (line 20766) | number_integer_t* get_impl_ptr(number_integer_t* /*unused*/) noexcept
function number_integer_t (line 20772) | constexpr const number_integer_t* get_impl_ptr(const number_integer_t* /...
function number_unsigned_t (line 20778) | number_unsigned_t* get_impl_ptr(number_unsigned_t* /*unused*/) noexcept
function number_unsigned_t (line 20784) | constexpr const number_unsigned_t* get_impl_ptr(const number_unsigned_t*...
function number_float_t (line 20790) | number_float_t* get_impl_ptr(number_float_t* /*unused*/) noexcept
function number_float_t (line 20796) | constexpr const number_float_t* get_impl_ptr(const number_float_t* /*unu...
function binary_t (line 20802) | binary_t* get_impl_ptr(binary_t* /*unused*/) noexcept
function binary_t (line 20808) | constexpr const binary_t* get_impl_ptr(const binary_t* /*unused*/) const...
function ReferenceType (line 20825) | static ReferenceType get_ref_impl(ThisType& obj)
function get_ptr (line 20858) | constexpr auto get_ptr() const noexcept -> decltype(std::declval<const b...
function ValueType (line 20950) | ValueType get_impl(detail::priority_tag<1> /*unused*/) const noexcept(no...
function BasicJsonType (line 20975) | BasicJsonType get_impl(detail::priority_tag<2> /*unused*/) const
function basic_json (line 20998) | basic_json get_impl(detail::priority_tag<3> /*unused*/) const
function get_impl (line 21011) | constexpr auto get_impl(detail::priority_tag<4> /*unused*/) const noexcept
function get (line 21087) | auto get() noexcept -> decltype(std::declval<basic_json_t&>().template g...
function ValueType (line 21100) | ValueType & get_to(ValueType& v) const noexcept(noexcept(
function ValueType (line 21113) | ValueType & get_to(ValueType& v) const
function Array (line 21124) | Array get_to(T (&v)[N]) const // NOLINT(cppcoreguidelines-avoid-c-arrays...
function ReferenceType (line 21136) | ReferenceType get_ref()
function ReferenceType (line 21147) | ReferenceType get_ref() const
function binary_t (line 21206) | binary_t& get_binary()
function binary_t (line 21218) | const binary_t& get_binary() const
function reference (line 21240) | reference at(size_type idx)
function const_reference (line 21263) | const_reference at(size_type idx) const
function reference (line 21286) | reference at(const typename object_t::key_type& key)
function reference (line 21306) | reference at(KeyType && key)
function const_reference (line 21324) | const_reference at(const typename object_t::key_type& key) const
function const_reference (line 21344) | const_reference at(KeyType && key) const
function reference (line 21362) | reference operator[](size_type idx)
function const_reference (line 21408) | const_reference operator[](size_type idx) const
function reference (line 21421) | reference operator[](typename object_t::key_type key)
function const_reference (line 21443) | const_reference operator[](const typename object_t::key_type& key) const
function reference (line 21459) | reference operator[](T* key)
function const_reference (line 21465) | const_reference operator[](T* key) const
function reference (line 21474) | reference operator[](KeyType && key)
function const_reference (line 21498) | const_reference operator[](KeyType && key) const
class ValueType (line 21524) | class ValueType
function ReturnType (line 21553) | ReturnType value(const typename object_t::key_type& key, ValueType && de...
function ValueType (line 21579) | ValueType value(KeyType && key, const ValueType& default_value) const
function ReturnType (line 21606) | ReturnType value(KeyType && key, ValueType && default_value) const
function ValueType (line 21629) | ValueType value(const json_pointer& ptr, const ValueType& default_value)...
function ReturnType (line 21654) | ReturnType value(const json_pointer& ptr, ValueType && default_value) const
function ValueType (line 21678) | ValueType value(const ::nlohmann::json_pointer<BasicJsonType>& ptr, cons...
function ReturnType (line 21689) | ReturnType value(const ::nlohmann::json_pointer<BasicJsonType>& ptr, Val...
function reference (line 21696) | reference front()
function const_reference (line 21703) | const_reference front() const
function reference (line 21710) | reference back()
function const_reference (line 21719) | const_reference back() const
function IteratorType (line 21731) | IteratorType erase(IteratorType pos)
function IteratorType (line 21801) | IteratorType erase(IteratorType first, IteratorType last)
function erase_internal (line 21869) | private:
function size_type (line 21885) | size_type erase_internal(KeyType && key)
function size_type (line 21917) | size_type erase(KeyType && key)
function erase (line 21924) | void erase(const size_type idx)
function iterator (line 21953) | iterator find(const typename object_t::key_type& key)
function const_iterator (line 21967) | const_iterator find(const typename object_t::key_type& key) const
function iterator (line 21983) | iterator find(KeyType && key)
function const_iterator (line 21999) | const_iterator find(KeyType && key) const
function size_type (line 22013) | size_type count(const typename object_t::key_type& key) const
function size_type (line 22023) | size_type count(KeyType && key) const
function contains (line 22031) | bool contains(const typename object_t::key_type& key) const
function contains (line 22040) | bool contains(KeyType && key) const
function contains (line 22047) | bool contains(const json_pointer& ptr) const
function contains (line 22054) | bool contains(const typename ::nlohmann::json_pointer<BasicJsonType>& pt...
function iterator (line 22070) | iterator begin() noexcept
function const_iterator (line 22079) | const_iterator begin() const noexcept
function const_iterator (line 22086) | const_iterator cbegin() const noexcept
function iterator (line 22095) | iterator end() noexcept
function const_iterator (line 22104) | const_iterator end() const noexcept
function const_iterator (line 22111) | const_iterator cend() const noexcept
function reverse_iterator (line 22120) | reverse_iterator rbegin() noexcept
function const_reverse_iterator (line 22127) | const_reverse_iterator rbegin() const noexcept
function reverse_iterator (line 22134) | reverse_iterator rend() noexcept
function const_reverse_iterator (line 22141) | const_reverse_iterator rend() const noexcept
function const_reverse_iterator (line 22148) | const_reverse_iterator crbegin() const noexcept
function const_reverse_iterator (line 22155) | const_reverse_iterator crend() const noexcept
function iterator_wrapper (line 22167) | static iteration_proxy<iterator> iterator_wrapper(reference ref) noexcept
function iterator_wrapper (line 22178) | static iteration_proxy<const_iterator> iterator_wrapper(const_reference ...
function items (line 22185) | iteration_proxy<iterator> items() noexcept
function items (line 22192) | iteration_proxy<const_iterator> items() const noexcept
function empty (line 22208) | bool empty() const noexcept
function size_type (line 22247) | size_type size() const noexcept
function size_type (line 22286) | size_type max_size() const noexcept
function clear (line 22329) | void clear() noexcept
function push_back (line 22390) | void push_back(basic_json&& val)
function reference (line 22415) | reference operator+=(basic_json&& val)
function push_back (line 22423) | void push_back(const basic_json& val)
function reference (line 22447) | reference operator+=(const basic_json& val)
function push_back (line 22455) | void push_back(const typename object_t::value_type& val)
function reference (line 22478) | reference operator+=(const typename object_t::value_type& val)
function push_back (line 22486) | void push_back(initializer_list_t init)
function reference (line 22502) | reference operator+=(initializer_list_t init)
function reference (line 22511) | reference emplace_back(Args&& ... args)
function emplace (line 22536) | std::pair<iterator, bool> emplace(Args&& ... args)
function iterator (line 22568) | iterator insert_iterator(const_iterator pos, Args&& ... args)
function iterator (line 22587) | iterator insert(const_iterator pos, const basic_json& val)
function iterator (line 22607) | iterator insert(const_iterator pos, basic_json&& val)
function iterator (line 22614) | iterator insert(const_iterator pos, size_type cnt, const basic_json& val)
function iterator (line 22634) | iterator insert(const_iterator pos, const_iterator first, const_iterator...
function iterator (line 22665) | iterator insert(const_iterator pos, initializer_list_t ilist)
function insert (line 22685) | void insert(const_iterator first, const_iterator last)
function update (line 22710) | void update(const_reference j, bool merge_objects = false)
function update (line 22717) | void update(const_iterator first, const_iterator last, bool merge_object...
function swap (line 22764) | void swap(reference other) noexcept (
function friend (line 22781) | friend void swap(reference left, reference right) noexcept (
function swap (line 22793) | void swap(array_t& other) // NOLINT(bugprone-exception-escape,cppcoregui...
function swap (line 22809) | void swap(object_t& other) // NOLINT(bugprone-exception-escape,cppcoregu...
function swap (line 22825) | void swap(string_t& other) // NOLINT(bugprone-exception-escape,cppcoregu...
function swap (line 22841) | void swap(binary_t& other) // NOLINT(bugprone-exception-escape,cppcoregu...
function swap (line 22857) | void swap(typename binary_t::container_type& other) // NOLINT(bugprone-e...
function else (line 22946) | else if(compares_unordered(lhs, rhs))\
function compares_unordered (line 22975) | bool compares_unordered(const_reference rhs, bool inverse = false) const...
function friend (line 23088) | friend bool operator==(const_reference lhs, const_reference rhs) noexcept
function friend (line 23120) | friend bool operator!=(const_reference lhs, const_reference rhs) noexcept
function friend (line 23177) | friend bool operator<=(const_reference lhs, const_reference rhs) noexcept
function friend (line 23206) | friend bool operator>(const_reference lhs, const_reference rhs) noexcept
function friend (line 23236) | friend bool operator>=(const_reference lhs, const_reference rhs) noexcept
function friend (line 23277) | friend std::ostream& operator<<(std::ostream& o, const basic_json& j)
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23316) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23330) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 23344) | static basic_json parse(detail::span_input_adapter&& i,
function accept (line 23357) | static bool accept(InputType&& i,
function accept (line 23366) | static bool accept(IteratorType first, IteratorType last,
function accept (line 23374) | static bool accept(detail::span_input_adapter&& i,
function sax_parse (line 23384) | static bool sax_parse(InputType&& i, SAX* sax,
function sax_parse (line 23399) | static bool sax_parse(IteratorType first, IteratorType last, SAX* sax,
function sax_parse (line 23418) | static bool sax_parse(detail::span_input_adapter&& i, SAX* sax,
function JSON_HEDLEY_RETURNS_NON_NULL (line 23459) | JSON_HEDLEY_RETURNS_NON_NULL
type data (line 23491) | struct data
method data (line 23499) | data(const value_t v)
method data (line 23504) | data(size_type cnt, const basic_json& val)
method data (line 23510) | data() noexcept = default;
method data (line 23511) | data(data&&) noexcept = default;
method data (line 23512) | data(const data&) noexcept = delete;
method data (line 23513) | data& operator=(data&&) noexcept = delete;
method data (line 23514) | data& operator=(const data&) noexcept = delete;
function to_cbor (line 23548) | static void to_cbor(const basic_json& j, detail::output_adapter<std::uin...
function to_cbor (line 23555) | static void to_cbor(const basic_json& j, detail::output_adapter<char> o)
function to_msgpack (line 23562) | static std::vector<std::uint8_t> to_msgpack(const basic_json& j)
function to_msgpack (line 23571) | static void to_msgpack(const basic_json& j, detail::output_adapter<std::...
function to_msgpack (line 23578) | static void to_msgpack(const basic_json& j, detail::output_adapter<char> o)
function to_ubjson (line 23585) | static std::vector<std::uint8_t> to_ubjson(const basic_json& j,
function to_ubjson (line 23596) | static void to_ubjson(const basic_json& j, detail::output_adapter<std::u...
function to_ubjson (line 23604) | static void to_ubjson(const basic_json& j, detail::output_adapter<char> o,
function to_bjdata (line 23612) | static std::vector<std::uint8_t> to_bjdata(const basic_json& j,
function to_bjdata (line 23623) | static void to_bjdata(const basic_json& j, detail::output_adapter<std::u...
function to_bjdata (line 23631) | static void to_bjdata(const basic_json& j, detail::output_adapter<char> o,
function to_bson (line 23639) | static std::vector<std::uint8_t> to_bson(const basic_json& j)
function to_bson (line 23648) | static void to_bson(const basic_json& j, detail::output_adapter<std::uin...
function to_bson (line 23655) | static void to_bson(const basic_json& j, detail::output_adapter<char> o)
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23663) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23679) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 23695) | static basic_json from_cbor(const T* ptr, std::size_t len,
function basic_json (line 23705) | static basic_json from_cbor(detail::span_input_adapter&& i,
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23721) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23736) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 23751) | static basic_json from_msgpack(const T* ptr, std::size_t len,
function basic_json (line 23760) | static basic_json from_msgpack(detail::span_input_adapter&& i,
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23775) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23790) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 23805) | static basic_json from_ubjson(const T* ptr, std::size_t len,
function basic_json (line 23814) | static basic_json from_ubjson(detail::span_input_adapter&& i,
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23829) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23844) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23859) | JSON_HEDLEY_WARN_UNUSED_RESULT
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 23874) | JSON_HEDLEY_WARN_UNUSED_RESULT
function basic_json (line 23889) | static basic_json from_bson(const T* ptr, std::size_t len,
function basic_json (line 23898) | static basic_json from_bson(detail::span_input_adapter&& i,
function reference (line 23920) | reference operator[](const json_pointer& ptr)
function reference (line 23927) | reference operator[](const ::nlohmann::json_pointer<BasicJsonType>& ptr)
function const_reference (line 23934) | const_reference operator[](const json_pointer& ptr) const
function const_reference (line 23941) | const_reference operator[](const ::nlohmann::json_pointer<BasicJsonType>...
function reference (line 23948) | reference at(const json_pointer& ptr)
function reference (line 23955) | reference at(const ::nlohmann::json_pointer<BasicJsonType>& ptr)
function const_reference (line 23962) | const_reference at(const json_pointer& ptr) const
function const_reference (line 23969) | const_reference at(const ::nlohmann::json_pointer<BasicJsonType>& ptr) c...
function basic_json (line 23976) | basic_json flatten() const
function basic_json (line 23985) | basic_json unflatten() const
function patch_inplace (line 24001) | void patch_inplace(const basic_json& json_patch)
function basic_json (line 24272) | basic_json patch(const basic_json& json_patch) const
function JSON_HEDLEY_WARN_UNUSED_RESULT (line 24281) | JSON_HEDLEY_WARN_UNUSED_RESULT
function merge_patch (line 24424) | void merge_patch(const basic_json& apply_patch)
function NLOHMANN_BASIC_JSON_TPL_DECLARATION (line 24455) | NLOHMANN_BASIC_JSON_TPL_DECLARATION
function NLOHMANN_JSON_NAMESPACE_END (line 24492) | NLOHMANN_JSON_NAMESPACE_END
FILE: common/message/client_info.hpp
type msg (line 25) | namespace msg
class ClientInfo (line 34) | class ClientInfo : public JsonMessage
method ClientInfo (line 38) | ClientInfo() : JsonMessage(message_type::kClientInfo)
method getVolume (line 48) | uint16_t getVolume()
method isMuted (line 54) | bool isMuted()
method setVolume (line 60) | void setVolume(uint16_t volume)
method setMuted (line 66) | void setMuted(bool muted)
FILE: common/message/codec_header.hpp
type msg (line 25) | namespace msg
class CodecHeader (line 31) | class CodecHeader : public BaseMessage
method CodecHeader (line 35) | explicit CodecHeader(const std::string& codec_name = "", uint32_t si...
method read (line 48) | void read(std::istream& stream) override
method getSize (line 54) | uint32_t getSize() const override
method doserialize (line 67) | void doserialize(std::ostream& stream) const override
FILE: common/message/error.hpp
type msg (line 25) | namespace msg
class Error (line 31) | class Error : public BaseMessage
method Error (line 35) | explicit Error(uint32_t code, std::string error, std::string message)
method Error (line 41) | Error() : Error(0, "", "")
method read (line 45) | void read(std::istream& stream) override
method getSize (line 52) | uint32_t getSize() const override
method doserialize (line 69) | void doserialize(std::ostream& stream) const override
FILE: common/message/factory.hpp
type msg (line 32) | namespace msg
function message_cast (line 38) | static std::unique_ptr<ToType> message_cast(std::unique_ptr<msg::BaseM...
type factory (line 50) | namespace factory
function createMessage (line 55) | static std::unique_ptr<T> createMessage(const BaseMessage& base_mess...
function createMessage (line 65) | static std::unique_ptr<BaseMessage> createMessage(const BaseMessage&...
FILE: common/message/hello.hpp
type msg (line 31) | namespace msg
class Hello (line 36) | class Hello : public JsonMessage
type Auth (line 40) | struct Auth
method Auth (line 43) | Auth() = default;
method Auth (line 46) | explicit Auth(const json& j)
method Auth (line 55) | Auth(std::string scheme, std::string param) : scheme(std::move(sch...
method json (line 60) | json toJson() const
method Hello (line 75) | Hello() : JsonMessage(message_type::kHello)
method Hello (line 80) | Hello(const std::string& mac_address, const std::string& id, size_t ...
method getMacAddress (line 99) | std::string getMacAddress() const
method getHostName (line 105) | std::string getHostName() const
method getVersion (line 111) | std::string getVersion() const
method getClientName (line 117) | std::string getClientName() const
method getOS (line 123) | std::string getOS() const
method getArch (line 129) | std::string getArch() const
method getInstance (line 135) | int getInstance() const
method getProtocolVersion (line 141) | int getProtocolVersion() const
method getId (line 147) | std::string getId() const
method getUniqueId (line 153) | std::string getUniqueId() const
method getAuth (line 165) | std::optional<Auth> getAuth() const
FILE: common/message/json_message.hpp
type msg (line 30) | namespace msg
class JsonMessage (line 34) | class JsonMessage : public BaseMessage
method JsonMessage (line 38) | explicit JsonMessage(message_type msg_type) : BaseMessage(msg_type)
method read (line 45) | void read(std::istream& stream) override
method getSize (line 52) | uint32_t getSize() const override
method doserialize (line 62) | void doserialize(std::ostream& stream) const override
method T (line 69) | T get(const std::string& what, const T& def) const
FILE: common/message/message.hpp
type membuf (line 49) | struct membuf : public std::basic_streambuf<char>
method membuf (line 52) | membuf(char* begin, char* end)
type message_type (line 59) | enum class message_type : uint16_t
type tv (line 111) | struct tv
method tv (line 114) | tv()
method tv (line 123) | explicit tv(timeval tv) : sec(tv.tv_sec), usec(tv.tv_usec){}
method tv (line 125) | tv(int32_t _sec, int32_t _usec) : sec(_sec), usec(_usec){}
method tv (line 133) | tv operator+(const tv& other) const
method tv (line 147) | tv operator-(const tv& other) const
type msg (line 161) | namespace msg
type BaseMessage (line 167) | struct BaseMessage
method BaseMessage (line 175) | BaseMessage() : BaseMessage(message_type::kBase)
method BaseMessage (line 180) | explicit BaseMessage(message_type type_) : type(type_), id(0), refer...
method read (line 188) | virtual void read(std::istream& stream)
method deserialize (line 201) | void deserialize(char* payload)
method deserialize (line 209) | void deserialize(const BaseMessage& baseMessage, char* payload)
method serialize (line 223) | virtual void serialize(std::ostream& stream) const
method getSize (line 238) | virtual uint32_t getSize() const
method writeVal (line 258) | void writeVal(std::ostream& stream, const bool& val) const
method writeVal (line 265) | void writeVal(std::ostream& stream, const char& val) const
method writeVal (line 271) | void writeVal(std::ostream& stream, const uint16_t& val) const
method writeVal (line 278) | void writeVal(std::ostream& stream, const message_type& val) const
method writeVal (line 285) | void writeVal(std::ostream& stream, const int16_t& val) const
method writeVal (line 292) | void writeVal(std::ostream& stream, const uint32_t& val) const
method writeVal (line 299) | void writeVal(std::ostream& stream, const int32_t& val) const
method writeVal (line 306) | void writeVal(std::ostream& stream, const char* payload, const uint3...
method writeVal (line 313) | void writeVal(std::ostream& stream, const std::string& val) const
method readVal (line 321) | void readVal(std::istream& stream, bool& val) const
method readVal (line 329) | void readVal(std::istream& stream, char& val) const
method readVal (line 335) | void readVal(std::istream& stream, uint16_t& val) const
method readVal (line 343) | void readVal(std::istream& stream, message_type& val) const
method readVal (line 350) | void readVal(std::istream& stream, int16_t& val) const
method readVal (line 358) | void readVal(std::istream& stream, uint32_t& val) const
method readVal (line 366) | void readVal(std::istream& stream, int32_t& val) const
method readVal (line 374) | void readVal(std::istream& stream, char** payload, uint32_t& size) c...
method readVal (line 382) | void readVal(std::istream& stream, std::string& val) const
type BaseMessage (line 172) | struct BaseMessage
method BaseMessage (line 175) | BaseMessage() : BaseMessage(message_type::kBase)
method BaseMessage (line 180) | explicit BaseMessage(message_type type_) : type(type_), id(0), refer...
method read (line 188) | virtual void read(std::istream& stream)
method deserialize (line 201) | void deserialize(char* payload)
method deserialize (line 209) | void deserialize(const BaseMessage& baseMessage, char* payload)
method serialize (line 223) | virtual void serialize(std::ostream& stream) const
method getSize (line 238) | virtual uint32_t getSize() const
method writeVal (line 258) | void writeVal(std::ostream& stream, const bool& val) const
method writeVal (line 265) | void writeVal(std::ostream& stream, const char& val) const
method writeVal (line 271) | void writeVal(std::ostream& stream, const uint16_t& val) const
method writeVal (line 278) | void writeVal(std::ostream& stream, const message_type& val) const
method writeVal (line 285) | void writeVal(std::ostream& stream, const int16_t& val) const
method writeVal (line 292) | void writeVal(std::ostream& stream, const uint32_t& val) const
method writeVal (line 299) | void writeVal(std::ostream& stream, const int32_t& val) const
method writeVal (line 306) | void writeVal(std::ostream& stream, const char* payload, const uint3...
method writeVal (line 313) | void writeVal(std::ostream& stream, const std::string& val) const
method readVal (line 321) | void readVal(std::istream& stream, bool& val) const
method readVal (line 329) | void readVal(std::istream& stream, char& val) const
method readVal (line 335) | void readVal(std::istream& stream, uint16_t& val) const
method readVal (line 343) | void readVal(std::istream& stream, message_type& val) const
method readVal (line 350) | void readVal(std::istream& stream, int16_t& val) const
method readVal (line 358) | void readVal(std::istream& stream, uint32_t& val) const
method readVal (line 366) | void readVal(std::istream& stream, int32_t& val) const
method readVal (line 374) | void readVal(std::istream& stream, char** payload, uint32_t& size) c...
method readVal (line 382) | void readVal(std::istream& stream, std::string& val) const
FILE: common/message/pcm_chunk.hpp
type msg (line 30) | namespace msg
class PcmChunk (line 38) | class PcmChunk : public WireChunk
method PcmChunk (line 42) | PcmChunk(const SampleFormat& sample_format, uint32_t ms) : WireChunk...
method PcmChunk (line 47) | PcmChunk() : WireChunk()
method readFrames (line 56) | int readFrames(void* outputBuffer, const std::chrono::duration<Rep, ...
method readFrames (line 80) | int readFrames(void* output_buffer, uint32_t frame_count)
method seek (line 99) | int seek(int frames)
method start (line 112) | chronos::time_point_clk start() const override
method end (line 119) | inline chronos::time_point_clk end() const
method T (line 126) | inline T duration() const
method setFrameCount (line 140) | void setFrameCount(int frame_count)
method durationMs (line 148) | double durationMs() const
method T (line 155) | inline T durationLeft() const
method isEndOfChunk (line 161) | inline bool isEndOfChunk() const
method getFrameCount (line 167) | inline uint32_t getFrameCount() const
method getSampleCount (line 173) | inline uint32_t getSampleCount() const
FILE: common/message/server_settings.hpp
type msg (line 25) | namespace msg
class ServerSettings (line 29) | class ServerSettings : public JsonMessage
method ServerSettings (line 33) | ServerSettings() : JsonMessage(message_type::kServerSettings)
method getBufferMs (line 45) | int32_t getBufferMs()
method getLatency (line 51) | int32_t getLatency()
method getVolume (line 57) | uint16_t getVolume()
method isMuted (line 63) | bool isMuted()
method setBufferMs (line 70) | void setBufferMs(int32_t buffer_ms)
method setLatency (line 76) | void setLatency(int32_t latency)
method setVolume (line 82) | void setVolume(uint16_t volume)
method setMuted (line 88) | void setMuted(bool muted)
FILE: common/message/time.hpp
type msg (line 24) | namespace msg
class Time (line 28) | class Time : public BaseMessage
method Time (line 32) | Time() : BaseMessage(message_type::kTime)
method read (line 39) | void read(std::istream& stream) override
method getSize (line 45) | uint32_t getSize() const override
method doserialize (line 54) | void doserialize(std::ostream& stream) const override
FILE: common/message/wire_chunk.hpp
type msg (line 32) | namespace msg
class WireChunk (line 39) | class WireChunk : public BaseMessage
method WireChunk (line 43) | explicit WireChunk(uint32_t size = 0) : BaseMessage(message_type::kW...
method WireChunk (line 50) | WireChunk(const WireChunk& wireChunk) : BaseMessage(message_type::kW...
method read (line 62) | void read(std::istream& stream) override
method getSize (line 69) | uint32_t getSize() const override
method start (line 75) | virtual chronos::time_point_clk start() const
method getPayload (line 86) | std::pair<T*, size_t> getPayload() const
method doserialize (line 92) | void doserialize(std::ostream& stream) const override
FILE: common/popl.hpp
type popl (line 41) | namespace popl
type Argument (line 53) | enum class Argument
type Attribute (line 70) | enum class Attribute
type OptionName (line 87) | enum class OptionName
class Option (line 101) | class Option
method Option (line 116) | Option(const Option&) = default;
method Option (line 119) | Option(Option&&) = default;
method Option (line 122) | Option& operator=(const Option&) = default;
method Option (line 125) | Option& operator=(Option&&) = default;
class Value (line 194) | class Value : public Option
class Implicit (line 270) | class Implicit : public Value<T>
class Switch (line 289) | class Switch : public Value<bool>
method set_default (line 294) | void set_default(const bool& value) = delete;
class OptionParser (line 312) | class OptionParser
class invalid_option (line 395) | class invalid_option : public std::invalid_argument
type Error (line 398) | enum class Error
method invalid_option (line 406) | invalid_option(const Option* option, invalid_option::Error error, Op...
method invalid_option (line 411) | invalid_option(const Option* option, invalid_option::Error error, co...
method Option (line 416) | const Option* option() const
method Error (line 421) | Error error() const
method OptionName (line 426) | OptionName what_name() const
method value (line 431) | std::string value() const
class OptionPrinter (line 449) | class OptionPrinter
method OptionPrinter (line 454) | explicit OptionPrinter(const OptionParser* option_parser) : option_p...
class ConsoleOptionPrinter (line 477) | class ConsoleOptionPrinter : public OptionPrinter
class GroffOptionPrinter (line 495) | class GroffOptionPrinter : public OptionPrinter
class BashCompletionOptionPrinter (line 513) | class BashCompletionOptionPrinter : public OptionPrinter
function Attribute (line 576) | inline Attribute Option::attribute() const
function T (line 631) | inline T Value<T>::value_or(const T& default_value, size_t idx) const
function T (line 642) | inline T Value<T>::value(size_t idx) const
function T (line 686) | inline T Value<T>::get_default() const
function Argument (line 705) | inline Argument Value<T>::argument_type() const
function Argument (line 805) | inline Argument Implicit<T>::argument_type() const
function Argument (line 836) | inline Argument Switch::argument_type() const
function Option_ptr (line 900) | inline Option_ptr OptionParser::find_option(const std::string& long_na...
function Option_ptr (line 909) | inline Option_ptr OptionParser::find_option(char short_name) const
FILE: common/queue.hpp
class Queue (line 30) | class Queue
method Queue (line 34) | Queue() = default;
method Queue (line 35) | Queue(const Queue&) = delete;
method Queue (line 36) | Queue& operator=(const Queue&) = delete;
method T (line 39) | T pop()
method abort_wait (line 51) | void abort_wait()
method wait_for (line 61) | bool wait_for(const std::chrono::microseconds& timeout) const
method try_pop (line 72) | bool try_pop(T& item, const std::chrono::microseconds& timeout = std::...
method pop (line 92) | void pop(T& item)
method push_front (line 103) | void push_front(const T& item)
method back_copy (line 113) | bool back_copy(T& copy)
method front_copy (line 123) | bool front_copy(T& copy)
method push_front (line 133) | void push_front(T&& item)
method push (line 143) | void push(const T& item)
method push (line 153) | void push(T&& item)
method size (line 163) | size_t size() const
method empty (line 170) | bool empty() const
FILE: common/resampler.hpp
class Resampler (line 36) | class Resampler
FILE: common/sample_format.cpp
function string (line 53) | string SampleFormat::toString() const
FILE: common/sample_format.hpp
class SampleFormat (line 38) | class SampleFormat
method isInitialized (line 57) | bool isInitialized() const
method rate (line 63) | uint32_t rate() const
method bits (line 69) | uint16_t bits() const
method channels (line 75) | uint16_t channels() const
method sampleSize (line 81) | uint16_t sampleSize() const
method frameSize (line 87) | uint16_t frameSize() const
method msRate (line 93) | inline double msRate() const
method usRate (line 99) | inline double usRate() const
method nsRate (line 105) | inline double nsRate() const
FILE: common/snap_exception.hpp
class SnapException (line 26) | class SnapException : public std::exception
method SnapException (line 33) | explicit SnapException(const char* text, int error_code = 0) : text_(t...
method SnapException (line 38) | explicit SnapException(const std::string& text, int error_code = 0) : ...
method code (line 46) | int code() const noexcept
FILE: common/str_compat.hpp
type cpt (line 36) | namespace cpt
type lconv (line 38) | struct lconv
type lconv (line 41) | struct lconv
function to_string (line 51) | static std::string to_string(const T& t)
function stoul (line 62) | static long stoul(const std::string& str)
function stoi (line 78) | static int stoi(const std::string& str)
function stoi (line 87) | static int stoi(const std::string& str, int def)
function stod (line 99) | static double stod(const std::string& str)
function strtold (line 115) | static long double strtold(const char* str, char** endptr)
function strtof (line 125) | static float strtof(const char* str, char** endptr)
FILE: common/stream_uri.cpp
function json (line 173) | json StreamUri::toJson() const
FILE: common/stream_uri.hpp
type StreamUri (line 35) | struct StreamUri
method StreamUri (line 38) | StreamUri() = default;
FILE: common/time_defs.hpp
type chronos (line 39) | namespace chronos
function timeofday (line 54) | inline static void timeofday(struct timeval* tv)
function gettimeofday (line 64) | inline static int gettimeofday(struct timeval* tp, struct timezone* tzp)
function steadytimeofday (line 85) | inline static void steadytimeofday(struct timeval* tv)
function systemtimeofday (line 94) | inline static void systemtimeofday(struct timeval* tv)
function ToDuration (line 100) | inline ToDuration diff(const timeval& tv1, const timeval& tv2)
function getTickCount (line 112) | inline static long getTickCount()
function abs (line 131) | inline std::chrono::duration<Rep, Period> abs(std::chrono::duration<Re...
function duration (line 138) | inline int64_t duration(std::chrono::duration<Rep, Period> d)
function sleep (line 145) | inline void sleep(const std::chrono::duration<Rep, Period>& sleep_dura...
function sleep (line 150) | inline void sleep(const int32_t& milliseconds)
function usleep (line 157) | inline void usleep(const int32_t& microseconds)
FILE: common/utils.hpp
function execGetOutput (line 67) | static std::string execGetOutput(const std::string& cmd)
function getProp (line 89) | static std::string getProp(const std::string& key, const std::string& de...
function getOS (line 100) | static std::string getOS()
function getHostName (line 165) | static std::string getHostName()
function getArch (line 182) | static std::string getArch()
function generateUUID (line 259) | static std::string generateUUID()
function getMacAddress (line 277) | static std::string getMacAddress(int sock)
function getMacAddress (line 382) | static std::string getMacAddress(const std::string& address)
function getHostId (line 418) | static std::string getHostId(const std::string& defaultId = "")
FILE: common/utils/file_utils.cpp
type utils::file (line 44) | namespace utils::file
function exists (line 50) | bool exists(const std::string& filename)
function isInDirectory (line 57) | std::optional<std::filesystem::path> isInDirectory(std::filesystem::pa...
function do_chown (line 79) | void do_chown(const std::string& file_path, const std::string& user_na...
function mkdirRecursive (line 111) | int mkdirRecursive(const char* path, mode_t mode)
FILE: common/utils/file_utils.hpp
type utils::file (line 34) | namespace utils::file
FILE: common/utils/logging.hpp
type utils (line 26) | namespace utils
type logging (line 28) | namespace logging
type TimeConditional (line 34) | struct TimeConditional : public AixLog::Conditional
method TimeConditional (line 38) | TimeConditional(const std::chrono::milliseconds& interval) : inter...
method reset (line 44) | void reset()
method setInterval (line 51) | void setInterval(const std::chrono::milliseconds& interval)
method is_true (line 58) | bool is_true() const override
FILE: common/utils/string_utils.cpp
type utils::string (line 40) | namespace utils::string
function wildcardMatch (line 45) | bool wildcardMatch(const std::string& pattern, const std::string& text)
function ltrim_copy (line 89) | std::string ltrim_copy(const std::string& s)
function rtrim_copy (line 96) | std::string rtrim_copy(const std::string& s)
function trim_copy (line 103) | std::string trim_copy(const std::string& s)
function uriEncode (line 110) | std::string uriEncode(const std::string& str)
function uriEncodePath (line 135) | std::string uriEncodePath(const std::string& path)
function uriDecode (line 156) | std::string uriDecode(const std::string& src)
function split_left (line 179) | void split_left(const std::string& s, char delim, std::string& left, s...
function split_right (line 195) | void split_right(const std::string& s, char delim, std::string& left, ...
function split_left (line 211) | std::string split_left(const std::string& s, char delim, std::string& ...
function split_right (line 219) | std::string split_right(const std::string& s, char delim, std::string&...
function split (line 244) | std::vector<std::string> split(const std::string& s, char delim)
function split_pairs (line 252) | std::map<std::string, std::string> split_pairs(const std::string& s, c...
function tolower_copy (line 269) | std::string tolower_copy(const std::string& s)
FILE: common/utils/string_utils.hpp
type utils::string (line 30) | namespace utils::string
function split_pairs_to_container (line 87) | std::map<std::string, T> split_pairs_to_container(const std::string& s...
function container_to_string (line 106) | std::string container_to_string(const T& container, const std::string&...
FILE: common/version.hpp
type version (line 26) | namespace version
function rev (line 41) | static std::string rev(std::size_t len = 0)
FILE: control/control.py
function doRequest (line 14) | def doRequest(j, requestId):
function setVolume (line 26) | def setVolume(client, volume):
function setName (line 33) | def setName(client, name):
FILE: control/setVolume.py
function doRequest (line 10) | def doRequest(j, requestId):
function setVolume (line 22) | def setVolume(client, volume):
FILE: control/snapcast_mpris.py
class SnapcastWrapper (line 257) | class SnapcastWrapper(object):
method __init__ (line 262) | def __init__(self, params):
method websocket_loop (line 288) | def websocket_loop(self):
method __get_stream_id_from_server_status (line 295) | def __get_stream_id_from_server_status(self, status, client_id):
method __update_metadata (line 310) | def __update_metadata(self, meta):
method __update_properties (line 343) | def __update_properties(self, props):
method on_ws_message (line 376) | def on_ws_message(self, ws, message):
method on_ws_error (line 410) | def on_ws_error(self, ws, error):
method on_ws_open (line 414) | def on_ws_open(self, ws):
method on_ws_close (line 428) | def on_ws_close(self, ws):
method send_request (line 434) | def send_request(self, method, params=None):
method stop (line 445) | def stop(self):
method mediakey_callback (line 450) | def mediakey_callback(self, appname, key):
method control (line 471) | def control(self, command, params={}):
method set_property (line 475) | def set_property(self, property, value):
method metadata (line 481) | def metadata(self):
method properties (line 485) | def properties(self):
method position (line 488) | def position(self):
method property (line 500) | def property(self, name, default):
method notify_about_track (line 503) | def notify_about_track(self, meta, state='play'):
method notify_about_state (line 526) | def notify_about_state(self, state):
method setup_mediakeys (line 556) | def setup_mediakeys(self):
method register_mediakeys (line 564) | def register_mediakeys(self):
method gsd_name_owner_changed_callback (line 583) | def gsd_name_owner_changed_callback(self, bus_name, old_owner, new_own...
class NotifyWrapper (line 596) | class NotifyWrapper(object):
method __init__ (line 598) | def __init__(self, params):
method _bootstrap_notifications (line 611) | def _bootstrap_notifications(self):
method notify (line 644) | def notify(self, title, body, uri=''):
class MPRISInterface (line 671) | class MPRISInterface(dbus.service.Object):
method __init__ (line 678) | def __init__(self, params):
method _name_owner_changed_callback (line 697) | def _name_owner_changed_callback(self, name, old_owner, new_owner):
method acquire_name (line 707) | def acquire_name(self):
method release_name (line 713) | def release_name(self):
method __get_playback_status (line 728) | def __get_playback_status():
method __set_loop_status (line 733) | def __set_loop_status(value):
method __get_loop_status (line 739) | def __get_loop_status():
method __set_shuffle (line 744) | def __set_shuffle(value):
method __get_shuffle (line 749) | def __get_shuffle():
method __get_metadata (line 754) | def __get_metadata():
method __get_volume (line 758) | def __get_volume():
method __set_volume (line 766) | def __set_volume(value):
method __get_position (line 772) | def __get_position():
method __get_can_go_next (line 777) | def __get_can_go_next():
method __get_can_go_previous (line 782) | def __get_can_go_previous():
method __get_can_play (line 787) | def __get_can_play():
method __get_can_pause (line 792) | def __get_can_pause():
method __get_can_seek (line 797) | def __get_can_seek():
method __get_can_control (line 802) | def __get_can_control():
method Introspect (line 832) | def Introspect(self):
method PropertiesChanged (line 836) | def PropertiesChanged(self, interface, changed_properties,
method Get (line 842) | def Get(self, interface, prop):
method Set (line 850) | def Set(self, interface, prop, value):
method GetAll (line 857) | def GetAll(self, interface):
method update_property (line 866) | def update_property(self, interface, prop):
method Raise (line 878) | def Raise(self):
method Quit (line 884) | def Quit(self):
method Next (line 890) | def Next(self):
method Previous (line 895) | def Previous(self):
method Pause (line 900) | def Pause(self):
method PlayPause (line 905) | def PlayPause(self):
method Stop (line 910) | def Stop(self):
method Play (line 915) | def Play(self):
method Seek (line 920) | def Seek(self, offset):
method SetPosition (line 937) | def SetPosition(self, trackid, position):
method OpenUri (line 955) | def OpenUri(self):
method Seeked (line 962) | def Seeked(self, position):
function __get_client_from_server_status (line 968) | def __get_client_from_server_status(status):
function usage (line 988) | def usage(params):
FILE: control/testClient.py
class ReaderThread (line 15) | class ReaderThread(threading.Thread):
method __init__ (line 16) | def __init__(self, tn, stop_event):
method run (line 21) | def run(self):
function doRequest (line 31) | def doRequest(str):
FILE: server/authinfo.cpp
type snapcast::error::auth (line 41) | namespace snapcast::error::auth
type detail (line 44) | namespace detail
type category (line 48) | struct category : public std::error_category
function make_error_code (line 95) | std::error_code make_error_code(AuthErrc errc)
function ErrorCode (line 106) | ErrorCode AuthInfo::validateUser(const std::string& username, const std:...
function ErrorCode (line 121) | ErrorCode AuthInfo::authenticate(const std::string& scheme, const std::s...
function ErrorCode (line 136) | ErrorCode AuthInfo::authenticate(const std::string& auth)
function ErrorCode (line 145) | ErrorCode AuthInfo::authenticateBasic(const std::string& credentials)
function ErrorCode (line 159) | ErrorCode AuthInfo::authenticatePlain(const std::string& user_password)
function ErrorCode (line 174) | ErrorCode AuthInfo::authenticateBearer(const std::string& token)
FILE: server/authinfo.hpp
type AuthErrc (line 34) | enum class AuthErrc
type snapcast::error::auth (line 44) | namespace snapcast::error::auth
type std (line 51) | namespace std
type is_error_code_enum<AuthErrc> (line 54) | struct is_error_code_enum<AuthErrc> : public std::true_type
class AuthInfo (line 65) | class AuthInfo
FILE: server/config.cpp
function ClientInfoPtr (line 133) | ClientInfoPtr Config::getClientInfo(const std::string& client_id) const
function GroupPtr (line 152) | GroupPtr Config::addClientInfo(const ClientInfoPtr& client)
function GroupPtr (line 166) | GroupPtr Config::addClientInfo(const std::string& client_id)
function GroupPtr (line 176) | GroupPtr Config::getGroup(const std::string& group_id) const
function GroupPtr (line 189) | GroupPtr Config::getGroupFromClient(const std::string& client_id)
function GroupPtr (line 204) | GroupPtr Config::getGroupFromClient(const ClientInfoPtr& client)
function json (line 210) | json Config::getServerStatus(const json& streams) const
function json (line 234) | json Config::getGroupsJson() const
FILE: server/config.hpp
type ClientInfo (line 38) | struct ClientInfo
method ClientInfo (line 247) | explicit ClientInfo(std::string _clientId = "") : id(std::move(_client...
method fromJson (line 253) | void fromJson(const json& j) override
method json (line 264) | json toJson() override
type Group (line 39) | struct Group
method Group (line 290) | explicit Group(const ClientInfoPtr& client = nullptr)
method fromJson (line 297) | void fromJson(const json& j) override
method json (line 316) | json toJson() override
method ClientInfoPtr (line 332) | ClientInfoPtr removeClient(const std::string& client_id)
method ClientInfoPtr (line 346) | ClientInfoPtr removeClient(const ClientInfoPtr& client)
method ClientInfoPtr (line 355) | ClientInfoPtr getClient(const std::string& client_id)
method addClient (line 366) | void addClient(const ClientInfoPtr& client)
method empty (line 387) | bool empty() const
type JsonConfigItem (line 46) | struct JsonConfigItem
method T (line 59) | T jGet(const json& j, const std::string& what, const T& def)
type Volume (line 75) | struct Volume : public JsonConfigItem
method Volume (line 78) | explicit Volume(uint16_t _percent = 100, bool _muted = false) : percen...
method fromJson (line 82) | void fromJson(const json& j) override
method json (line 88) | json toJson() override
type Host (line 102) | struct Host : public JsonConfigItem
method Host (line 105) | Host() = default;
method update (line 108) | void update()
method fromJson (line 115) | void fromJson(const json& j) override
method json (line 124) | json toJson() override
type ClientConfig (line 144) | struct ClientConfig : public JsonConfigItem
method ClientConfig (line 147) | ClientConfig() : volume(100)
method fromJson (line 151) | void fromJson(const json& j) override
method json (line 159) | json toJson() override
type Snapcast (line 177) | struct Snapcast : public JsonConfigItem
method Snapcast (line 180) | explicit Snapcast(std::string _name = "", std::string _version = "") :...
method fromJson (line 186) | void fromJson(const json& j) override
method json (line 193) | json toJson() override
type Snapclient (line 209) | struct Snapclient : public Snapcast
method Snapclient (line 212) | explicit Snapclient(std::string _name = "", std::string _version = "")...
type Snapserver (line 219) | struct Snapserver : public Snapcast
method Snapserver (line 222) | explicit Snapserver(std::string _name = "", std::string _version = "")...
method fromJson (line 226) | void fromJson(const json& j) override
method json (line 232) | json toJson() override
type ClientInfo (line 244) | struct ClientInfo : public JsonConfigItem
method ClientInfo (line 247) | explicit ClientInfo(std::string _clientId = "") : id(std::move(_client...
method fromJson (line 253) | void fromJson(const json& j) override
method json (line 264) | json toJson() override
type Group (line 287) | struct Group : public JsonConfigItem
method Group (line 290) | explicit Group(const ClientInfoPtr& client = nullptr)
method fromJson (line 297) | void fromJson(const json& j) override
method json (line 316) | json toJson() override
method ClientInfoPtr (line 332) | ClientInfoPtr removeClient(const std::string& client_id)
method ClientInfoPtr (line 346) | ClientInfoPtr removeClient(const ClientInfoPtr& client)
method ClientInfoPtr (line 355) | ClientInfoPtr getClient(const std::string& client_id)
method addClient (line 366) | void addClient(const ClientInfoPtr& client)
method empty (line 387) | bool empty() const
class Config (line 401) | class Config
method Config (line 405) | static Config& instance()
method Config (line 455) | Config() = default;
FILE: server/control_requests.cpp
function checkParams (line 44) | static void checkParams(const jsonrpcpp::request_ptr& request, const std...
function StreamServer (line 75) | const StreamServer& Request::getStreamServer() const
function StreamManager (line 80) | StreamManager& Request::getStreamManager() const
function ServerSettings (line 85) | const ServerSettings& Request::getSettings() const
function ClientInfoPtr (line 161) | ClientInfoPtr ClientRequest::getClient(const jsonrpcpp::request_ptr& req...
function GroupPtr (line 329) | GroupPtr GroupRequest::getGroup(const jsonrpcpp::request_ptr& request)
function PcmStreamPtr (line 588) | PcmStreamPtr StreamRequest::getStream(const StreamManager& stream_manage...
FILE: server/control_requests.hpp
class Server (line 36) | class Server
class Request (line 39) | class Request
type Description (line 43) | struct Description
type Type (line 46) | enum class Type
method toString (line 57) | std::string toString(Type type)
type Parameter (line 78) | struct Parameter
type Result (line 86) | struct Result
method Description (line 94) | Description(std::string description, std::vector<Parameter> paramete...
method Json (line 107) | Json toJson()
method Request (line 135) | Request() = delete;
class ControlRequestFactory (line 179) | class ControlRequestFactory
class ClientRequest (line 195) | class ClientRequest : public Request
class ClientGetStatusRequest (line 211) | class ClientGetStatusRequest : public ClientRequest
class ClientSetVolumeRequest (line 222) | class ClientSetVolumeRequest : public ClientRequest
class ClientSetLatencyRequest (line 233) | class ClientSetLatencyRequest : public ClientRequest
class ClientSetNameRequest (line 244) | class ClientSetNameRequest : public ClientRequest
class GroupRequest (line 256) | class GroupRequest : public Request
class GroupGetStatusRequest (line 269) | class GroupGetStatusRequest : public GroupRequest
class GroupSetNameRequest (line 280) | class GroupSetNameRequest : public GroupRequest
class GroupSetMuteRequest (line 291) | class GroupSetMuteRequest : public GroupRequest
class GroupSetStreamRequest (line 302) | class GroupSetStreamRequest : public GroupRequest
class GroupSetClientsRequest (line 313) | class GroupSetClientsRequest : public GroupRequest
class StreamRequest (line 325) | class StreamRequest : public Request
class StreamControlRequest (line 340) | class StreamControlRequest : public StreamRequest
class StreamSetPropertyRequest (line 351) | class StreamSetPropertyRequest : public StreamRequest
class StreamAddRequest (line 362) | class StreamAddRequest : public StreamRequest
class StreamRemoveRequest (line 373) | class StreamRemoveRequest : public StreamRequest
class ServerGetRpcVersionRequest (line 385) | class ServerGetRpcVersionRequest : public Request
class ServerGetStatusRequest (line 396) | class ServerGetStatusRequest : public Request
class ServerDeleteClientRequest (line 407) | class ServerDeleteClientRequest : public Request
class ServerAuthenticateRequest (line 418) | class ServerAuthenticateRequest : public Request
method requiresAuthentication (line 426) | bool requiresAuthentication() const override
method requiresAuthorization (line 431) | bool requiresAuthorization() const override
class ServerGetTokenRequest (line 440) | class ServerGetTokenRequest : public Request
class GeneralGetRpcCommands (line 451) | class GeneralGetRpcCommands : public Request
method requiresAuthentication (line 462) | bool requiresAuthentication() const override
method requiresAuthorization (line 467) | bool requiresAuthorization() const override
FILE: server/control_server.cpp
type timeval (line 179) | struct timeval
FILE: server/control_server.hpp
class ControlServer (line 45) | class ControlServer : public ControlMessageReceiver
FILE: server/control_session.hpp
class ControlSession (line 33) | class ControlSession
method ControlSession (line 62) | ControlSession(ControlMessageReceiver* receiver, const ServerSettings&...
class StreamSession (line 34) | class StreamSession
class ControlMessageReceiver (line 37) | class ControlMessageReceiver
class ControlSession (line 58) | class ControlSession : public std::enable_shared_from_this<ControlSession>
method ControlSession (line 62) | ControlSession(ControlMessageReceiver* receiver, const ServerSettings&...
FILE: server/control_session_http.cpp
function mime_type (line 84) | boost::beast::string_view mime_type(boost::beast::string_view path)
function path_cat (line 141) | std::string path_cat(boost::beast::string_view base, boost::beast::strin...
FILE: server/control_session_http.hpp
class ControlSessionHttp (line 51) | class ControlSessionHttp : public ControlSession
FILE: server/control_session_tcp.hpp
class ControlSessionTcp (line 42) | class ControlSessionTcp : public ControlSession
FILE: server/control_session_ws.hpp
class ControlSessionWebsocket (line 52) | class ControlSessionWebsocket : public ControlSession
FILE: server/encoder/encoder.hpp
type encoder (line 32) | namespace encoder
class Encoder (line 40) | class Encoder
method Encoder (line 48) | explicit Encoder(std::string codecOptions = "") : headerChunk_(nullp...
method init (line 56) | virtual void init(OnEncodedCallback&& callback, const SampleFormat& ...
method getAvailableOptions (line 72) | virtual std::string getAvailableOptions() const
method getDefaultOptions (line 78) | virtual std::string getDefaultOptions() const
method getHeader (line 84) | virtual std::shared_ptr<msg::CodecHeader> getHeader() const
FILE: server/encoder/encoder_factory.cpp
type encoder (line 40) | namespace encoder
FILE: server/encoder/encoder_factory.hpp
type encoder (line 29) | namespace encoder
class EncoderFactory (line 33) | class EncoderFactory
FILE: server/encoder/flac_encoder.cpp
type encoder (line 38) | namespace encoder
function FLAC__StreamEncoderWriteStatus (line 152) | FLAC__StreamEncoderWriteStatus FlacEncoder::write_callback(const FLAC_...
type callback (line 172) | namespace callback
function FLAC__StreamEncoderWriteStatus (line 175) | FLAC__StreamEncoderWriteStatus write_callback(const FLAC__StreamEnco...
FILE: server/encoder/flac_encoder.hpp
type encoder (line 33) | namespace encoder
class FlacEncoder (line 37) | class FlacEncoder : public Encoder
FILE: server/encoder/null_encoder.cpp
type encoder (line 29) | namespace encoder
FILE: server/encoder/null_encoder.hpp
type encoder (line 25) | namespace encoder
class NullEncoder (line 37) | class NullEncoder : public Encoder
FILE: server/encoder/ogg_encoder.cpp
type encoder (line 36) | namespace encoder
FILE: server/encoder/ogg_encoder.hpp
type encoder (line 29) | namespace encoder
class OggEncoder (line 33) | class OggEncoder : public Encoder
FILE: server/encoder/opus_encoder.cpp
type encoder (line 32) | namespace encoder
function assign (line 45) | void assign(void* pointer, T val)
FILE: server/encoder/opus_encoder.hpp
type encoder (line 34) | namespace encoder
class OpusEncoder (line 38) | class OpusEncoder : public Encoder
FILE: server/encoder/pcm_encoder.cpp
type encoder (line 30) | namespace encoder
function assign (line 43) | void assign(void* pointer, T val)
FILE: server/encoder/pcm_encoder.hpp
type encoder (line 25) | namespace encoder
class PcmEncoder (line 29) | class PcmEncoder : public Encoder
FILE: server/etc/plug-ins/example.py
function send (line 49) | def send(json_msg):
class exampleControl (line 59) | class exampleControl(object):
method __init__ (line 64) | def __init__(self, params):
method log (line 85) | def log(self, message):
method updateProperties (line 94) | def updateProperties(self):
method control (line 114) | def control(self, cmd):
function usage (line 128) | def usage(params):
FILE: server/etc/plug-ins/meta_go-librespot.py
function send (line 58) | def send(msg):
class LibrespotControl (line 63) | class LibrespotControl:
method __init__ (line 64) | def __init__(self, params):
method websocket_loop (line 127) | def websocket_loop(self):
method on_ws_message (line 140) | def on_ws_message(self, ws, message):
method on_ws_error (line 205) | def on_ws_error(self, ws, error):
method on_ws_open (line 208) | def on_ws_open(self, ws):
method on_ws_close (line 212) | def on_ws_close(self, ws, close_status_code, close_msg):
method stop (line 215) | def stop(self):
method post_json (line 221) | def post_json(self, path: str, payload=None, timeout=2.0):
method control (line 236) | def control(self, cmd):
function parse_args (line 300) | def parse_args():
FILE: server/etc/plug-ins/meta_librespot-java.py
function send (line 61) | def send(json_msg):
class LibrespotControl (line 67) | class LibrespotControl(object):
method __init__ (line 70) | def __init__(self, params):
method websocket_loop (line 114) | def websocket_loop(self):
method getMetaData (line 125) | def getMetaData(self, data):
method updateProperties (line 171) | def updateProperties(self):
method on_ws_message (line 177) | def on_ws_message(self, ws, message):
method on_ws_error (line 225) | def on_ws_error(self, ws, error):
method on_ws_open (line 229) | def on_ws_open(self, ws):
method on_ws_close (line 233) | def on_ws_close(self, ws, close_status_code, close_msg):
method send_request (line 236) | def send_request(self, method, params=None):
method stop (line 244) | def stop(self):
method control (line 249) | def control(self, cmd):
function usage (line 344) | def usage(params):
FILE: server/etc/plug-ins/meta_mopidy.py
function send (line 59) | def send(json_msg):
class MopidyControl (line 65) | class MopidyControl(object):
method __init__ (line 68) | def __init__(self, params):
method websocket_loop (line 97) | def websocket_loop(self):
method extractImageUrl (line 108) | def extractImageUrl(self, track_uri, jmsg):
method onGetImageResponse (line 119) | def onGetImageResponse(self, result):
method getMetaData (line 137) | def getMetaData(self, track):
method getProperties (line 185) | def getProperties(self, req_res):
method onGetTrackResponse (line 236) | def onGetTrackResponse(self, req_id, track):
method onSnapcastPropertiesResponse (line 256) | def onSnapcastPropertiesResponse(self, req_id, req_res):
method onPropertiesResponse (line 262) | def onPropertiesResponse(self, req_res):
method onGetTimePositionResponse (line 273) | def onGetTimePositionResponse(self, result):
method on_ws_message (line 280) | def on_ws_message(self, ws, message):
method on_ws_error (line 368) | def on_ws_error(self, ws, error):
method on_ws_open (line 372) | def on_ws_open(self, ws):
method on_ws_close (line 376) | def on_ws_close(self, ws, close_status_code, close_msg):
method send_request (line 379) | def send_request(self, method, params=None, callback=None):
method send_batch_request (line 390) | def send_batch_request(self, methods_params, callback=None):
method stop (line 406) | def stop(self):
method control (line 411) | def control(self, cmd):
function usage (line 544) | def usage(params):
FILE: server/etc/plug-ins/meta_mpd.py
function send (line 185) | def send(json_msg):
class MPDWrapper (line 190) | class MPDWrapper(object):
method __init__ (line 195) | def __init__(self, params):
method run (line 214) | def run(self):
method connected (line 225) | def connected(self):
method my_connect (line 228) | def my_connect(self):
method reconnect (line 307) | def reconnect(self):
method disconnect (line 319) | def disconnect(self):
method init_state (line 322) | def init_state(self):
method idle_enter (line 330) | def idle_enter(self):
method idle_leave (line 343) | def idle_leave(self):
method timer_callback (line 358) | def timer_callback(self):
method control (line 370) | def control(self, cmd):
method io_callback (line 450) | def io_callback(self, fd, event):
method socket_callback (line 471) | def socket_callback(self, fd, event):
method __track_key (line 498) | def __track_key(self, snapmeta):
method get_albumart (line 501) | def get_albumart(self, snapmeta, cached):
method get_metadata (line 553) | def get_metadata(self):
method __diff_map (line 609) | def __diff_map(self, old_map, new_map):
method _get_properties (line 621) | def _get_properties(self, mpd_status):
method _update_properties (line 644) | def _update_properties(self, force=False):
method fileno (line 721) | def fileno(self):
method fileno (line 724) | def fileno(self):
method _write_command (line 739) | def _write_command(self, *args):
method _write_command (line 742) | def _write_command(self, *args):
method _fetch_object (line 746) | def _fetch_object(self):
method _fetch_object (line 752) | def _fetch_object(self):
method _fetch_object (line 755) | def _fetch_object(self):
method _fetch_objects (line 762) | def _fetch_objects(self, *args):
method _fetch_objects (line 765) | def _fetch_objects(self, *args):
method _fetch_objects (line 768) | def _fetch_objects(self, *args):
method __getattr__ (line 773) | def __getattr__(self, attr):
method call (line 778) | def call(self, command, *args):
function usage (line 794) | def usage(params):
FILE: server/etc/plug-ins/plex_bridge.py
class PlexSnapcastBridge (line 22) | class PlexSnapcastBridge:
method __init__ (line 23) | def __init__(self, config: Dict[str, Union[str, Optional[str]]]):
method connect_to_plex (line 38) | def connect_to_plex(self) -> None:
method update_snapcast_status (line 52) | def update_snapcast_status(self, properties: Dict[str, Any]) -> None:
method send_ready_notification (line 71) | def send_ready_notification(self) -> None:
method _send_json (line 78) | def _send_json(self, data: Dict[str, Any]) -> None:
method send_properties_notification (line 86) | def send_properties_notification(self, properties: Dict[str, Any]) -> ...
method send_log (line 95) | def send_log(self, message: str, severity: str = "info") -> None:
method get_current_properties (line 106) | def get_current_properties(self) -> Dict[str, Any]:
method get_default_properties (line 168) | def get_default_properties(self) -> Dict[str, Any]:
method handle_control_command (line 184) | def handle_control_command(self, command: str, params: Dict[str, Any])...
method handle_set_property (line 224) | def handle_set_property(self, property_name: str, value: Any) -> Dict[...
method handle_command (line 242) | def handle_command(self, command: Dict[str, Any]) -> Dict[str, Any]:
method monitor_sessions (line 282) | def monitor_sessions(self) -> None:
method run (line 299) | def run(self) -> None:
FILE: server/image_cache.hpp
class ImageCache (line 34) | class ImageCache
method ImageCache (line 38) | static ImageCache& instance()
method setImage (line 46) | std::string setImage(const std::string& key, std::string image, const ...
method clear (line 74) | void clear(const std::string& key)
method getImage (line 89) | std::optional<std::string> getImage(const std::string& url)
method ImageCache (line 100) | ImageCache() = default;
FILE: server/jsonrpcpp.hpp
type jsonrpcpp (line 37) | namespace jsonrpcpp
class Entity (line 40) | class Entity
type entity_t (line 60) | enum class entity_t : uint8_t
method Entity (line 74) | Entity(const Entity&) = default;
method Entity (line 75) | Entity& operator=(const Entity&) = default;
class Request (line 41) | class Request
class Notification (line 42) | class Notification
class Parameter (line 43) | class Parameter
class Response (line 44) | class Response
class Error (line 45) | class Error
class Batch (line 46) | class Batch
class Entity (line 57) | class Entity
type entity_t (line 60) | enum class entity_t : uint8_t
method Entity (line 74) | Entity(const Entity&) = default;
method Entity (line 75) | Entity& operator=(const Entity&) = default;
function Entity (line 98) | class NullableEntity : public Entity
type entity_t (line 60) | enum class entity_t : uint8_t
method Entity (line 74) | Entity(const Entity&) = default;
method Entity (line 75) | Entity& operator=(const Entity&) = default;
function Json (line 1149) | inline Json Notification::to_json() const
function Json (line 1196) | inline Json Batch::to_json() const
function entity_ptr (line 1219) | inline entity_ptr Parser::parse(const std::string& json_str)
function entity_ptr (line 1250) | inline entity_ptr Parser::parse_json(const Json& json)
function entity_ptr (line 1255) | inline entity_ptr Parser::do_parse(const std::string& json_str)
function entity_ptr (line 1275) | inline entity_ptr Parser::do_parse_json(const Json& json)
FILE: server/jwt.cpp
function EVP_PKEY (line 55) | EVP_PKEY* readKey(const std::string& key)
function EVP_PKEY (line 93) | EVP_PKEY* readCert(const std::string& key)
function sign (line 131) | bool sign(const std::string& pem_key, const std::string& msg, std::vecto...
function verifySignature (line 163) | bool verifySignature(const std::string& pem_cert, const unsigned char* M...
FILE: server/jwt.hpp
class Jwt (line 81) | class Jwt
FILE: server/publishZeroConf/publish_avahi.hpp
class PublishAvahi (line 41) | class PublishAvahi : public PublishmDNS
FILE: server/publishZeroConf/publish_bonjour.cpp
type timeval (line 84) | struct timeval
function reg_reply (line 124) | static void DNSSD_API reg_reply(DNSServiceRef sdref, const DNSServiceFla...
FILE: server/publishZeroConf/publish_bonjour.hpp
class PublishBonjour (line 34) | class PublishBonjour : public PublishmDNS
FILE: server/publishZeroConf/publish_mdns.hpp
type mDNSService (line 31) | struct mDNSService
method mDNSService (line 34) | mDNSService(std::string name, size_t port) : name_(std::move(name)), p...
class PublishmDNS (line 44) | class PublishmDNS
method PublishmDNS (line 48) | PublishmDNS(std::string serviceName, boost::asio::io_context& ioc) : s...
FILE: server/server.hpp
class Server (line 51) | class Server : public StreamMessageReceiver, public ControlMessageReceiv...
method onNewSession (line 73) | void onNewSession(std::shared_ptr<ControlSession> session) override
FILE: server/server_settings.hpp
type ServerSettings (line 36) | struct ServerSettings
type Server (line 39) | struct Server
type Ssl (line 56) | struct Ssl
method enabled (line 70) | bool enabled() const
type Authorization (line 77) | struct Authorization
method Authorization (line 80) | Authorization() = default;
method init (line 83) | void init(const std::vector<std::string>& conf_roles, const std::vec...
type Role (line 112) | struct Role
method Role (line 115) | Role() = default;
method Role (line 118) | explicit Role(const std::string& role_permissions)
type User (line 132) | struct User
method User (line 135) | explicit User(const std::string& user_password_role)
type Http (line 161) | struct Http
type TcpControl (line 188) | struct TcpControl
type TcpStream (line 201) | struct TcpStream
type Stream (line 214) | struct Stream
type StreamingClient (line 237) | struct StreamingClient
type Logging (line 244) | struct Logging
FILE: server/snapserver.cpp
function main (line 55) | int main(int argc, char* argv[])
FILE: server/stream_server.cpp
function session_ptr (line 155) | session_ptr StreamServer::getStreamSession(StreamSession* streamSession)...
function session_ptr (line 169) | session_ptr StreamServer::getStreamSession(const std::string& clientId) ...
type timeval (line 202) | struct timeval
FILE: server/stream_server.hpp
class StreamServer (line 53) | class StreamServer : public StreamMessageReceiver
FILE: server/stream_session.cpp
function PcmStreamPtr (line 52) | const PcmStreamPtr StreamSession::pcmStream() const
FILE: server/stream_session.hpp
class StreamSession (line 42) | class StreamSession
method setMessageReceiver (line 158) | void setMessageReceiver(StreamMessageReceiver* receiver)
class StreamMessageReceiver (line 48) | class StreamMessageReceiver
class shared_const_buffer (line 59) | class shared_const_buffer
type Message (line 62) | struct Message
method shared_const_buffer (line 72) | explicit shared_const_buffer(msg::BaseMessage& message)
method Message (line 108) | const Message& message() const
method setWriteHandler (line 114) | void setWriteHandler(WriteHandler&& handler)
method WriteHandler (line 120) | const WriteHandler& getWriteHandler() const
class StreamSession (line 141) | class StreamSession : public std::enable_shared_from_this<StreamSession>
method setMessageReceiver (line 158) | void setMessageReceiver(StreamMessageReceiver* receiver)
FILE: server/stream_session_tcp.hpp
class StreamSessionTcp (line 39) | class StreamSessionTcp : public StreamSession
FILE: server/stream_session_ws.hpp
class StreamSessionWebsocket (line 51) | class StreamSessionWebsocket : public StreamSession
FILE: server/streamreader/airplay_stream.cpp
type streamreader (line 34) | namespace streamreader
function string (line 41) | string hex2str(const string& input)
type XML_Status (line 94) | enum XML_Status
FILE: server/streamreader/airplay_stream.hpp
type streamreader (line 33) | namespace streamreader
type TageEntry (line 37) | struct TageEntry
class AirplayStream (line 53) | class AirplayStream : public ProcessStream
FILE: server/streamreader/alsa_stream.cpp
type streamreader (line 38) | namespace streamreader
function wait (line 54) | void wait(boost::asio::steady_timer& timer, const std::chrono::duratio...
FILE: server/streamreader/alsa_stream.hpp
type streamreader (line 31) | namespace streamreader
class AlsaStream (line 41) | class AlsaStream : public PcmStream
FILE: server/streamreader/asio_stream.hpp
type streamreader (line 35) | namespace streamreader
class AsioStream (line 42) | class AsioStream : public PcmStream
FILE: server/streamreader/control_error.cpp
type snapcast::error::control (line 23) | namespace snapcast::error::control
type detail (line 26) | namespace detail
type category (line 30) | struct category : public std::error_category
function make_error_code (line 91) | std::error_code make_error_code(ControlErrc errc)
FILE: server/streamreader/control_error.hpp
type ControlErrc (line 32) | enum class ControlErrc
type snapcast::error::control (line 64) | namespace snapcast::error::control
type std (line 71) | namespace std
type is_error_code_enum<ControlErrc> (line 74) | struct is_error_code_enum<ControlErrc> : public std::true_type
FILE: server/streamreader/file_stream.cpp
type streamreader (line 35) | namespace streamreader
type stat (line 45) | struct stat
FILE: server/streamreader/file_stream.hpp
type streamreader (line 28) | namespace streamreader
class FileStream (line 39) | class FileStream : public AsioStream<stream_descriptor>
FILE: server/streamreader/jack_stream.cpp
type streamreader (line 34) | namespace streamreader
function float_to_s32 (line 42) | void float_to_s32(char* dst, jack_default_audio_sample_t* src, unsigne...
function float_to_s24 (line 56) | void float_to_s24(char* dst, jack_default_audio_sample_t* src, unsigne...
function float_to_s16 (line 86) | void float_to_s16(char* dst, jack_default_audio_sample_t* src, unsigne...
function wait (line 111) | void wait(boost::asio::steady_timer& timer, const std::chrono::duratio...
FILE: server/streamreader/jack_stream.hpp
type streamreader (line 33) | namespace streamreader
class JackStream (line 43) | class JackStream : public PcmStream
FILE: server/streamreader/librespot_stream.cpp
type streamreader (line 35) | namespace streamreader
FILE: server/streamreader/librespot_stream.hpp
type streamreader (line 25) | namespace streamreader
class LibrespotStream (line 37) | class LibrespotStream : public ProcessStream
FILE: server/streamreader/meta_stream.cpp
type streamreader (line 30) | namespace streamreader
FILE: server/streamreader/meta_stream.hpp
type streamreader (line 29) | namespace streamreader
class MetaStream (line 41) | class MetaStream : public PcmStream, public PcmStream::Listener
FILE: server/streamreader/metadata.cpp
function readTag (line 35) | void readTag(const json& j, const std::string& tag, std::optional<T>& dest)
function addTag (line 51) | void addTag(json& j, const std::string& tag, const std::optional<T>& sou...
function json (line 77) | json Metadata::toJson() const
FILE: server/streamreader/metadata.hpp
class Metadata (line 33) | class Metadata
type ArtData (line 37) | struct ArtData
method Metadata (line 58) | Metadata() = default;
FILE: server/streamreader/pcm_stream.cpp
type streamreader (line 43) | namespace streamreader
function StreamUri (line 112) | const StreamUri& PcmStream::getUri() const
function SampleFormat (line 130) | const SampleFormat& PcmStream::getSampleFormat() const
function ReaderState (line 314) | ReaderState PcmStream::getState() const
function json (line 379) | json PcmStream::toJson() const
function Properties (line 400) | const Properties& PcmStream::getProperties() const
FILE: server/streamreader/pcm_stream.hpp
type streamreader (line 51) | namespace streamreader
class PcmStream (line 54) | class PcmStream
type Source (line 108) | enum class Source : char
class Listener (line 116) | class Listener
type ReaderState (line 56) | enum class ReaderState : char
function to_string (line 65) | static std::string to_string(const ReaderState& reader_state)
class PcmStream (line 104) | class PcmStream : public std::enable_shared_from_this<PcmStream>
type Source (line 108) | enum class Source : char
class Listener (line 116) | class Listener
FILE: server/streamreader/pipe_stream.cpp
type streamreader (line 35) | namespace streamreader
FILE: server/streamreader/pipe_stream.hpp
type streamreader (line 29) | namespace streamreader
class PipeStream (line 41) | class PipeStream : public AsioStream<stream_descriptor>
FILE: server/streamreader/pipewire_stream.cpp
type streamreader (line 45) | namespace streamreader
function spa_audio_format (line 57) | spa_audio_format sampleFormatToPipeWire(const SampleFormat& format)
type pw_stream_state (line 100) | enum pw_stream_state
type pw_stream_state (line 100) | enum pw_stream_state
type spa_pod (line 128) | struct spa_pod
type spa_audio_info (line 135) | struct spa_audio_info
type pw_buffer (line 156) | struct pw_buffer
type spa_buffer (line 163) | struct spa_buffer
type spa_data (line 164) | struct spa_data
type pw_core_info (line 231) | struct pw_core_info
type spa_pod (line 291) | struct spa_pod
type spa_pod_builder (line 293) | struct spa_pod_builder
type spa_audio_info_raw (line 380) | struct spa_audio_info_raw
FILE: server/streamreader/pipewire_stream.hpp
type streamreader (line 36) | namespace streamreader
class PipeWireStream (line 45) | class PipeWireStream : public PcmStream
type pw_stream_state (line 63) | enum pw_stream_state
type pw_stream_state (line 63) | enum pw_stream_state
type spa_pod (line 64) | struct spa_pod
type pw_core_info (line 65) | struct pw_core_info
type pw_main_loop (line 73) | struct pw_main_loop
type pw_context (line 74) | struct pw_context
type pw_core (line 75) | struct pw_core
type pw_stream (line 76) | struct pw_stream
type pw_core_events (line 79) | struct pw_core_events
type spa_hook (line 80) | struct spa_hook
type pw_stream_events (line 81) | struct pw_stream_events
type spa_hook (line 82) | struct spa_hook
type pw_stream_state (line 102) | enum pw_stream_state
FILE: server/streamreader/process_stream.cpp
type streamreader (line 35) | namespace streamreader
FILE: server/streamreader/process_stream.hpp
type streamreader (line 36) | namespace streamreader
class ProcessStream (line 47) | class ProcessStream : public AsioStream<stream_descriptor>
FILE: server/streamreader/properties.cpp
function readTag (line 34) | void readTag(const json& j, const std::string& tag, std::optional<T>& dest)
function readTag (line 50) | void readTag(const json& j, const std::string& tag, T& dest, const T& def)
function addTag (line 61) | void addTag(json& j, const std::string& tag, const T& source)
function addTag (line 74) | void addTag(json& j, const std::string& tag, const std::optional<T>& sou...
function json (line 93) | json Properties::toJson() const
FILE: server/streamreader/properties.hpp
type PlaybackStatus (line 33) | enum class PlaybackStatus
type LoopStatus (line 42) | enum class LoopStatus
function to_string (line 51) | static std::string to_string(PlaybackStatus playback_status)
function PlaybackStatus (line 74) | static PlaybackStatus playback_status_from_string(std::string& status)
function to_string (line 99) | static std::string to_string(LoopStatus loop_status)
function LoopStatus (line 122) | static LoopStatus loop_status_from_string(std::string& status)
class Properties (line 147) | class Properties
method Properties (line 151) | Properties() = default;
FILE: server/streamreader/stream_control.cpp
type streamreader (line 36) | namespace streamreader
FILE: server/streamreader/stream_control.hpp
type streamreader (line 47) | namespace streamreader
class StreamControl (line 54) | class StreamControl
class ScriptStreamControl (line 103) | class ScriptStreamControl : public StreamControl
FILE: server/streamreader/stream_manager.cpp
type streamreader (line 54) | namespace streamreader
function PcmStreamPtr (line 64) | PcmStreamPtr StreamManager::addStream(const std::string& uri, PcmStrea...
function PcmStreamPtr (line 71) | PcmStreamPtr StreamManager::addStream(StreamUri& streamUri, PcmStream:...
function PcmStreamPtr (line 196) | const PcmStreamPtr StreamManager::getDefaultStream() const
function PcmStreamPtr (line 218) | const PcmStreamPtr StreamManager::getStream(const std::string& id) const
function json (line 255) | json StreamManager::toJson() const
FILE: server/streamreader/stream_manager.hpp
type streamreader (line 34) | namespace streamreader
class StreamManager (line 41) | class StreamManager
FILE: server/streamreader/tcp_stream.cpp
type streamreader (line 36) | namespace streamreader
FILE: server/streamreader/tcp_stream.hpp
type streamreader (line 30) | namespace streamreader
class TcpStream (line 39) | class TcpStream : public AsioStream<tcp::socket>
FILE: server/streamreader/watchdog.cpp
type streamreader (line 36) | namespace streamreader
FILE: server/streamreader/watchdog.hpp
type streamreader (line 29) | namespace streamreader
class Watchdog (line 32) | class Watchdog
class Watchdog (line 36) | class Watchdog
Condensed preview — 271 files, each showing path, character count, and a content snippet. Download the .json file or copy for the full structured content (2,807K chars).
[
{
"path": ".clang-format",
"chars": 525,
"preview": "---\nAccessModifierOffset: '-4'\nAllowShortBlocksOnASingleLine: 'false'\nAllowShortCaseLabelsOnASingleLine: 'false'\nAllowS"
},
{
"path": ".clang-tidy",
"chars": 1285,
"preview": "---\nChecks: 'clang-diagnostic-*,clang-analyzer-*,modernize*,performance*,readability-*size*,readability*redunda"
},
{
"path": ".clangd",
"chars": 129,
"preview": "InlayHints:\n Enabled: Yes\n ParameterNames: No\n DeducedTypes: No\nDiagnostics:\n UnusedIncludes: Strict\n MissingInclud"
},
{
"path": ".devcontainer/Dockerfile.alpine",
"chars": 729,
"preview": "# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.238.0/containers/cpp/.devconta"
},
{
"path": ".devcontainer/Dockerfile.debian",
"chars": 577,
"preview": "ARG VARIANT=\"debian-11\"\nFROM mcr.microsoft.com/devcontainers/cpp:1-${VARIANT}\n\n# [Optional] Uncomment this section to in"
},
{
"path": ".devcontainer/Dockerfile.fedora",
"chars": 544,
"preview": "ARG VARIANT=\"42\"\nFROM fedora:${VARIANT}\n\n# [Optional] Uncomment this section to install additional packages.\nRUN dnf -y "
},
{
"path": ".devcontainer/devcontainer.json",
"chars": 1082,
"preview": "// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:\n// https://github.co"
},
{
"path": ".github/ISSUE_TEMPLATE/bug_report.md",
"chars": 551,
"preview": "---\nname: Bug report\nabout: 'Report a bug'\ntitle: ''\nlabels: \nassignees: ''\n\n---\n\n**Describe the bug**\nA clear and conci"
},
{
"path": ".github/ISSUE_TEMPLATE/config.yml",
"chars": 190,
"preview": "blank_issues_enabled: true\ncontact_links:\n - name: Ask a question\n url: https://github.com/snapcast/snapcast/discuss"
},
{
"path": ".github/ISSUE_TEMPLATE/feature_request.md",
"chars": 619,
"preview": "---\nname: Feature request\nabout: Suggest an idea or enhancement for snapcast\ntitle: ''\nlabels: feature request\nassignees"
},
{
"path": ".github/dependabot.yml",
"chars": 198,
"preview": "version: 2\nupdates:\n- package-ecosystem: github-actions\n directory: \"/\"\n schedule:\n interval: weekly\n day: satur"
},
{
"path": ".github/pull_request_template.md",
"chars": 2019,
"preview": "[Describe your pull request here. Please read the text below the line, and make sure you follow the checklist.]\n\n* * *\n\n"
},
{
"path": ".github/workflows/ci.yml",
"chars": 12430,
"preview": "name: CI\n\non:\n push:\n pull_request:\n\nenv:\n BOOST_VERSION: 1_90_0\n\njobs:\n static-analysis:\n\n strategy:\n fail-"
},
{
"path": ".github/workflows/package.yml",
"chars": 12496,
"preview": "name: Package\nrun-name: Package ${{ github.sha }} by @${{ github.actor }}\n\non:\n workflow_dispatch:\n\npermissions:\n cont"
},
{
"path": ".gitignore",
"chars": 1005,
"preview": "# Compiled Object files\n*.slo\n*.lo\n*.o\n*.obj\n\n# Precompiled Headers\n*.gch\n*.pch\n\n# Compiled Dynamic libraries\n*.so\n*.dyl"
},
{
"path": "CMakeLists.txt",
"chars": 11596,
"preview": "cmake_minimum_required(VERSION 3.14)\n\n# find_package() uses uppercase <PackageName>_ROOT variables.\nif(POLICY CMP0144)\n "
},
{
"path": "CONTRIBUTING.md",
"chars": 4724,
"preview": "# Contributing\n\n## Engaging in Our Project\n\nYou can contribute in several ways:\n\n* Contribute code for new features, bug"
},
{
"path": "Doxyfile",
"chars": 128441,
"preview": "# Doxyfile 1.9.8\n\n# This file describes the settings to be used by the documentation system\n# doxygen (www.doxygen.org) "
},
{
"path": "LICENSE",
"chars": 35142,
"preview": " GNU GENERAL PUBLIC LICENSE\n Version 3, 29 June 2007\n\n Copyright (C) 2007 Free "
},
{
"path": "README.md",
"chars": 14361,
"preview": "# Snapcast\n\n<picture>\n <source media=\"(prefers-color-scheme: dark)\" srcset=\"doc/Snapcast_800_dark.png\">\n <source media=\""
},
{
"path": "TODO.md",
"chars": 712,
"preview": "TODO\n====\n\nGeneral\n-------\n\n- Update Readme.md\n- JsonRPC documentation\n- Server ping client?\n- UDP based audio streaming"
},
{
"path": "_CMakePresets.json",
"chars": 4743,
"preview": "{\n \"version\": 3,\n \"cmakeMinimumRequired\": {\n \"major\": 3,\n \"minor\": 21,\n \"patch\": 0\n },\n "
},
{
"path": "_config.yml",
"chars": 134,
"preview": "remote_theme: pages-themes/slate@v0.2.0\nplugins:\n- jekyll-remote-theme\ntitle: Snapcast\ndescription: Synchronous multiroo"
},
{
"path": "changelog.md",
"chars": 30377,
"preview": "# Snapcast changelog\n\n## Version 0.35.0\n\n### Features\n\n- Client: Add SDL2 player for better portability (PR #1460)\n- Ser"
},
{
"path": "client/CMakeLists.txt",
"chars": 5152,
"preview": "set(CLIENT_SOURCES\n client_connection.cpp\n controller.cpp\n snapclient.cpp\n stream.cpp\n time_provider.cpp\n"
},
{
"path": "client/browseZeroConf/browse_avahi.cpp",
"chars": 8297,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/browseZeroConf/browse_avahi.hpp",
"chars": 2203,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/browseZeroConf/browse_bonjour.cpp",
"chars": 9001,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/browseZeroConf/browse_bonjour.hpp",
"chars": 1019,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/browseZeroConf/browse_mdns.hpp",
"chars": 1494,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/browseZeroConf/browse_zeroconf.hpp",
"chars": 944,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/build_android.sh",
"chars": 693,
"preview": "#/bin/sh\n\nexport NDK_DIR=\"$1\"\nexport JNI_LIBS_DIR=\"$2\"\nexport TOOLCHAIN=\"$NDK_DIR/toolchains/llvm/prebuilt/linux-x86_64\""
},
{
"path": "client/build_android_all.sh",
"chars": 143,
"preview": "#/bin/sh\n\nexport NDK_DIR_ARM=\"$1-arm\"\nexport NDK_DIR_ARM64=\"$1-arm64\"\nexport NDK_DIR_X86=\"$1-x86\"\nexport JNI_LIBS_DIR=\"$"
},
{
"path": "client/client_connection.cpp",
"chars": 23432,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/client_connection.hpp",
"chars": 9731,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: you"
},
{
"path": "client/client_settings.hpp",
"chars": 3527,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/controller.cpp",
"chars": 19915,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/controller.hpp",
"chars": 2581,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/decoder.hpp",
"chars": 1622,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/flac_decoder.cpp",
"chars": 8886,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/flac_decoder.hpp",
"chars": 1754,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/null_decoder.cpp",
"chars": 1148,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/null_decoder.hpp",
"chars": 1076,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/ogg_decoder.cpp",
"chars": 9001,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/ogg_decoder.hpp",
"chars": 2321,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/opus_decoder.cpp",
"chars": 4351,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2015 Hannes Ellinger\n Copyright (C) 2016-2024 Johannes Poh"
},
{
"path": "client/decoder/opus_decoder.hpp",
"chars": 1424,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2015 Hannes Ellinger\n Copyright (C) 2016-2025 "
},
{
"path": "client/decoder/pcm_decoder.cpp",
"chars": 3988,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/decoder/pcm_decoder.hpp",
"chars": 1048,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/double_buffer.hpp",
"chars": 4251,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/etc/snapclient.plist",
"chars": 488,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "client/player/alsa_player.cpp",
"chars": 26894,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/alsa_player.hpp",
"chars": 2663,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/coreaudio_player.cpp",
"chars": 7792,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2023 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/coreaudio_player.hpp",
"chars": 1960,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/file_player.cpp",
"chars": 4089,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/file_player.hpp",
"chars": 1783,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/oboe_player.cpp",
"chars": 9351,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/oboe_player.hpp",
"chars": 2396,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/opensl_player.cpp",
"chars": 13919,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/opensl_player.hpp",
"chars": 2325,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/pcm_device.hpp",
"chars": 1349,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/pipewire_player.cpp",
"chars": 20074,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n Copyright (C) 2025 aanno <aannoaa"
},
{
"path": "client/player/pipewire_player.hpp",
"chars": 2279,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n Copyright (C) 2025 aanno <aannoaa"
},
{
"path": "client/player/player.cpp",
"chars": 9385,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/player.hpp",
"chars": 4591,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/pulse_player.cpp",
"chars": 20566,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/pulse_player.hpp",
"chars": 2594,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/sdl2_player.cpp",
"chars": 4953,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n Copyright (C) 2025 malkstar\n\n "
},
{
"path": "client/player/sdl2_player.hpp",
"chars": 1907,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n Copyright (C) 2025 malkstar\n\n "
},
{
"path": "client/player/wasapi_player.cpp",
"chars": 18939,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/player/wasapi_player.hpp",
"chars": 5504,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/snapclient.1",
"chars": 2897,
"preview": ".\\\"groff -Tascii -man snapclient.1\n.TH SNAPCLIENT 1 \"September 2025\"\n.SH NAME\nsnapclient - Snapcast client\n.SH SYNOPSIS\n"
},
{
"path": "client/snapclient.cpp",
"chars": 24396,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/stream.cpp",
"chars": 19056,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/stream.hpp",
"chars": 5469,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/time_provider.cpp",
"chars": 2403,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "client/time_provider.hpp",
"chars": 2889,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "cmake/CheckAtomic.cmake",
"chars": 5555,
"preview": "# ==============================================================================\n# LLVM Release License\n# =============="
},
{
"path": "cmake/CheckCXX11StringSupport.cmake",
"chars": 1854,
"preview": "# This file is part of snapcast Copyright (C) 2014-2020 Johannes Pohl\n\n# This program is free software: you can redistr"
},
{
"path": "cmake/SystemdService.cmake",
"chars": 778,
"preview": "#\n# Find systemd service dir\n\npkg_check_modules(SYSTEMD \"systemd\")\nif(SYSTEMD_FOUND AND \"${SYSTEMD_SERVICES_INSTALL_DIR}"
},
{
"path": "cmake/TargetArch.cmake",
"chars": 5240,
"preview": "# Based on the Qt 5 processor detection code, so should be very accurate\n# https://qt.gitorious.org/qt/qtbase/blobs/mast"
},
{
"path": "cmake/clang-tidy.cmake",
"chars": 501,
"preview": "if(CMAKE_VERSION VERSION_EQUAL \"3.19.0\" OR CMAKE_VERSION VERSION_GREATER\n \"3.1"
},
{
"path": "cmake/cppcheck.cmake",
"chars": 2478,
"preview": "if(CMAKE_VERSION VERSION_EQUAL \"3.19.0\" OR CMAKE_VERSION VERSION_GREATER\n \"3.1"
},
{
"path": "cmake/reformat.cmake",
"chars": 1236,
"preview": "find_program(CLANG_FORMAT \"clang-format\")\nif(CLANG_FORMAT)\n file(GLOB_RECURSE CHECK_CXX_SOURCE_FILES common/*.[ch]pp cl"
},
{
"path": "common/CMakeLists.txt",
"chars": 450,
"preview": "set(SOURCES resampler.cpp sample_format.cpp base64.cpp stream_uri.cpp\n utils/string_utils.cpp utils/file_util"
},
{
"path": "common/aixlog.hpp",
"chars": 32964,
"preview": "/***\n __ __ _ _ __ __ ___\n / _\\ ( )( \\/ )( ) / \\ / __)\n / \\ )( ) ( / (_/\\( O )( (_ \\"
},
{
"path": "common/base64.cpp",
"chars": 5548,
"preview": "/*\n base64.cpp and base64.h\n\n Copyright (C) 2004-2008 René Nyffenegger\n\n This source code is provided 'as-is', wit"
},
{
"path": "common/base64.h",
"chars": 1206,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2017-2017 https://github.com/frafall\n\n This program is free"
},
{
"path": "common/daemon.cpp",
"chars": 5133,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/daemon.hpp",
"chars": 1162,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/endian.hpp",
"chars": 1418,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/error_code.hpp",
"chars": 3156,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/json.hpp",
"chars": 919974,
"preview": "// __ _____ _____ _____\n// __| | __| | | | JSON for Modern C++\n// | | |__ | | | | | | version 3.11"
},
{
"path": "common/message/client_info.hpp",
"chars": 1718,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/codec_header.hpp",
"chars": 1970,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/error.hpp",
"chars": 2112,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/factory.hpp",
"chars": 3069,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/hello.hpp",
"chars": 4240,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/json_message.hpp",
"chars": 1954,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/message.hpp",
"chars": 10973,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/pcm_chunk.hpp",
"chars": 6190,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/server_settings.hpp",
"chars": 2159,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/time.hpp",
"chars": 1513,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/message/wire_chunk.hpp",
"chars": 2816,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/popl.hpp",
"chars": 37529,
"preview": "/***\n ____ __ ____ __\n ( _ \\ / \\( _ \\( )\n ) __/( O )) __// (_/\\\n (__) \\__/(__) \\____/\n vers"
},
{
"path": "common/queue.hpp",
"chars": 4870,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/resampler.cpp",
"chars": 8770,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/resampler.hpp",
"chars": 1662,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/sample_format.cpp",
"chars": 2334,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/sample_format.hpp",
"chars": 3499,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/snap_exception.hpp",
"chars": 1500,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/str_compat.hpp",
"chars": 2877,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/stream_uri.cpp",
"chars": 6126,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/stream_uri.hpp",
"chars": 2325,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/time_defs.hpp",
"chars": 4409,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils/file_utils.cpp",
"chars": 3773,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils/file_utils.hpp",
"chars": 1560,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils/logging.hpp",
"chars": 2126,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2021 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils/string_utils.cpp",
"chars": 6414,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils/string_utils.hpp",
"chars": 4222,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/utils.hpp",
"chars": 13791,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "common/version.hpp",
"chars": 1203,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "control/control.py",
"chars": 2507,
"preview": "#!/usr/bin/env python\nimport sys\nimport telnetlib\nimport json\n\nif len(sys.argv) < 3:\n print(\"usage: control.py <SERVE"
},
{
"path": "control/scripts.md",
"chars": 1024,
"preview": "# Example HTTP requests\n\n## Command line requests\n\nRequires `curl` and `jq`\n\n### Get all client names\n\n```bash\ncurl --he"
},
{
"path": "control/setVolume.py",
"chars": 1380,
"preview": "#!/usr/bin/env python\nimport sys\nimport telnetlib\nimport json\n\ntelnet = telnetlib.Telnet(sys.argv[1], 1705)\nrequestId = "
},
{
"path": "control/snapcast_mpris.py",
"chars": 41055,
"preview": "#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n#\n# This program is free software: you can redistribute it and/or modi"
},
{
"path": "control/testClient.py",
"chars": 4928,
"preview": "#!/usr/bin/env python\nimport sys\nimport telnetlib\nimport json\nimport threading\nimport time\n\nif len(sys.argv) < 2:\n pr"
},
{
"path": "doc/binary_protocol.md",
"chars": 9840,
"preview": "# Snapcast binary protocol\n\nEach message sent with the Snapcast binary protocol is split up into two parts:\n\n- A base me"
},
{
"path": "doc/build.md",
"chars": 7914,
"preview": "# Build Snapcast\n\n## Clone the Snapcast repository\n\nTo do this, you need git. \nFor Debian derivates (e.g. Raspberry Pi "
},
{
"path": "doc/client/pipewire_player.md",
"chars": 4541,
"preview": "# PipeWire Player Usage Guide for Snapcast Client\n\n## Overview\n\nThis implementation adds native PipeWire support to Snap"
},
{
"path": "doc/configuration.md",
"chars": 21303,
"preview": "# Configuration\n\n## Sources\n\nAudio sources are added to the server as `source` in the `[stream]` section of the configur"
},
{
"path": "doc/contributions.md",
"chars": 16,
"preview": "# Contributions\n"
},
{
"path": "doc/install.md",
"chars": 1556,
"preview": "# Install Linux packages\n\nSnapcast packages are available for several Linux distributions:\n\n- [Debian](#debian)\n- [OpenW"
},
{
"path": "doc/json_rpc_api/control.md",
"chars": 29226,
"preview": "# Snapcast JSON RPC Control API\n\n## Raw TCP sockets\n\nSnapcast can be controlled with a [JSON-RPC 2.0](http://www.jsonrpc"
},
{
"path": "doc/json_rpc_api/stream_plugin.md",
"chars": 14095,
"preview": "\n# Stream plugin\n\nA stream plugin is an executable binary or script that is started by the server for a specific stream "
},
{
"path": "doc/pipewire-stream.md",
"chars": 4693,
"preview": "# PipeWire Stream Usage Guide for Snapcast\n\n## Overview\n\nThis implementation adds native PipeWire support to Snapcast se"
},
{
"path": "doc/player_setup.md",
"chars": 15126,
"preview": "# Setup of audio players/server\n\nSnapcast can be used with a number of different audio players and servers, and so it ca"
},
{
"path": "extras/changelog_current_version.py",
"chars": 1364,
"preview": "#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n#\n# This file is part of snapcast\n# Copyright (C) 2022-2024 Johannes Poh"
},
{
"path": "extras/package/debian/README.source",
"chars": 0,
"preview": ""
},
{
"path": "extras/package/debian/changelog",
"chars": 219,
"preview": "snapcast (0.0.0-1) unstable; urgency=medium\n\n * Placeholder for changelog\n Content should be created with `changelo"
},
{
"path": "extras/package/debian/changelog_md2deb.py",
"chars": 1846,
"preview": "#!/usr/bin/env python3\n# -*- coding: utf-8 -*-\n#\n# This file is part of snapcast\n# Copyright (C) 2022-2024 Johannes Poh"
},
{
"path": "extras/package/debian/compat",
"chars": 3,
"preview": "10\n"
},
{
"path": "extras/package/debian/control",
"chars": 1787,
"preview": "Source: snapcast\nSection: sound\nPriority: optional\nMaintainer: Johannes Pohl <snapcast@badaix.de>\nBuild-Depends: debhelp"
},
{
"path": "extras/package/debian/copyright",
"chars": 4416,
"preview": "Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/\nUpstream-Name: Snapcast\nUpstream-Contact: Joh"
},
{
"path": "extras/package/debian/rules",
"chars": 380,
"preview": "#!/usr/bin/make -f\n\ninclude /usr/share/dpkg/buildflags.mk\n\nexport DEB_BUILD_MAINT_OPTIONS = hardening=+all\nexport DEB_BU"
},
{
"path": "extras/package/debian/snapclient.default",
"chars": 314,
"preview": "# Start the client, used only by the init.d script\nSTART_SNAPCLIENT=true\n\n# Additional command line options that will be"
},
{
"path": "extras/package/debian/snapclient.init",
"chars": 4377,
"preview": "#! /bin/sh\n### BEGIN INIT INFO\n# Provides: snapclient\n# Required-Start: $remote_fs $syslog $network\n# Requir"
},
{
"path": "extras/package/debian/snapclient.install",
"chars": 77,
"preview": "usr/bin/snapclient usr/bin/\nusr/share/pixmaps/snapcast.svg usr/share/pixmaps/"
},
{
"path": "extras/package/debian/snapclient.manpages",
"chars": 19,
"preview": "client/snapclient.1"
},
{
"path": "extras/package/debian/snapclient.postinst",
"chars": 392,
"preview": "#!/bin/sh\n\nset -e\n\nUSERNAME=snapclient\nHOMEDIR=/var/lib/snapclient\n\nif [ \"$1\" = configure ]; then\n if ! getent passwd $"
},
{
"path": "extras/package/debian/snapclient.postrm",
"chars": 334,
"preview": "#!/bin/sh\n\nset -e\n\n#DEBHELPER#\n\nUSERNAME=snapclient\nHOMEDIR=/var/lib/snapclient\n\nif [ \"$1\" = \"purge\" ]; then\n rm -r $HO"
},
{
"path": "extras/package/debian/snapclient.service",
"chars": 379,
"preview": "[Unit]\nDescription=Snapcast client\nDocumentation=man:snapclient(1)\nWants=avahi-daemon.service\nAfter=network-online.targe"
},
{
"path": "extras/package/debian/snapserver.default",
"chars": 314,
"preview": "# Start the server, used only by the init.d script\nSTART_SNAPSERVER=true\n\n# Additional command line options that will be"
},
{
"path": "extras/package/debian/snapserver.docs",
"chars": 30,
"preview": "README.md\ndoc/player_setup.md\n"
},
{
"path": "extras/package/debian/snapserver.init",
"chars": 4370,
"preview": "#! /bin/sh\n### BEGIN INIT INFO\n# Provides: snapserver\n# Required-Start: $remote_fs $syslog $network\n# Requir"
},
{
"path": "extras/package/debian/snapserver.install",
"chars": 104,
"preview": "usr/bin/snapserver usr/bin/\nusr/share/snapserver usr/share/\netc/snapserver.conf\tetc/\netc/snapserver etc/"
},
{
"path": "extras/package/debian/snapserver.manpages",
"chars": 19,
"preview": "server/snapserver.1"
},
{
"path": "extras/package/debian/snapserver.postinst",
"chars": 448,
"preview": "#!/bin/sh\n\nset -e\n\nUSERNAME=snapserver\nHOMEDIR=/var/lib/snapserver\n\nif [ \"$1\" = configure ]; then\n if ! getent passwd $"
},
{
"path": "extras/package/debian/snapserver.postrm",
"chars": 335,
"preview": "#!/bin/sh\n\nset -e\n\n#DEBHELPER#\n\nUSERNAME=snapserver\nHOMEDIR=/var/lib/snapserver\n\nif [ \"$1\" = \"purge\" ]; then\n rm -rf $H"
},
{
"path": "extras/package/debian/snapserver.service",
"chars": 396,
"preview": "[Unit]\nDescription=Snapcast server\nDocumentation=man:snapserver(1)\nWants=avahi-daemon.service\nAfter=network-online.targe"
},
{
"path": "extras/package/debian/source/format",
"chars": 12,
"preview": "3.0 (quilt)\n"
},
{
"path": "extras/package/debian/source/local-options",
"chars": 42,
"preview": "unapply-patches\nabort-on-upstream-changes\n"
},
{
"path": "extras/package/mac/readme.md",
"chars": 334,
"preview": "install:\n\techo macOS\n\tinstall -s -g wheel -o root $(BIN) $(TARGET_DIR)/local/bin/$(BIN)\n\tinstall -g wheel -o root $(BIN)"
},
{
"path": "extras/package/mac/snapclient.plist",
"chars": 488,
"preview": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<!DOCTYPE plist PUBLIC \"-//Apple//DTD PLIST 1.0//EN\" \"http://www.apple.com/DTDs/P"
},
{
"path": "extras/package/rpm/snapcast.changes",
"chars": 1909,
"preview": "-------------------------------------------------------------------\nThu Dec 23 01:33:18 UTC 2021 - abdullah mardini <sup"
},
{
"path": "extras/package/rpm/snapcast.spec",
"chars": 5699,
"preview": "Name: snapcast \nRelease: 1\nLicense: GPL-3.0 \nGroup: Productivity/Multimedia/Sound/Playe"
},
{
"path": "extras/package/rpm/snapclient.default",
"chars": 314,
"preview": "# Start the client, used only by the init.d script\nSTART_SNAPCLIENT=true\n\n# Additional command line options that will be"
},
{
"path": "extras/package/rpm/snapclient.service",
"chars": 379,
"preview": "[Unit]\nDescription=Snapcast client\nDocumentation=man:snapclient(1)\nWants=avahi-daemon.service\nAfter=network-online.targe"
},
{
"path": "extras/package/rpm/snapserver.default",
"chars": 314,
"preview": "# Start the server, used only by the init.d script\nSTART_SNAPSERVER=true\n\n# Additional command line options that will be"
},
{
"path": "extras/package/rpm/snapserver.service",
"chars": 396,
"preview": "[Unit]\nDescription=Snapcast server\nDocumentation=man:snapserver(1)\nWants=avahi-daemon.service\nAfter=network-online.targe"
},
{
"path": "server/CMakeLists.txt",
"chars": 6007,
"preview": "set(SERVER_SOURCES\n authinfo.cpp\n config.cpp\n control_server.cpp\n control_requests.cpp\n control_session_t"
},
{
"path": "server/authinfo.cpp",
"chars": 9011,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/authinfo.hpp",
"chars": 3396,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/build_android.sh",
"chars": 366,
"preview": "export NDK_DIR=\"/home/johannes/Develop/android-toolchain-arm-14\"\nexport ADD_CFLAGS=\"\"\nmake clean; make TARGET=ANDROID -j"
},
{
"path": "server/config.cpp",
"chars": 8204,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2026 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/config.hpp",
"chars": 12779,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2026 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_requests.cpp",
"chars": 50658,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2026 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_requests.hpp",
"chars": 13785,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_server.cpp",
"chars": 11319,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_server.hpp",
"chars": 2506,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session.hpp",
"chars": 2766,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_http.cpp",
"chars": 20587,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_http.hpp",
"chars": 2899,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_tcp.cpp",
"chars": 4308,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_tcp.hpp",
"chars": 1955,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2024 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_ws.cpp",
"chars": 5128,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/control_session_ws.hpp",
"chars": 2806,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/encoder.hpp",
"chars": 3142,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2026 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/encoder_factory.cpp",
"chars": 2263,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/encoder_factory.hpp",
"chars": 1110,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/flac_encoder.cpp",
"chars": 8652,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/flac_encoder.hpp",
"chars": 1874,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/null_encoder.cpp",
"chars": 1355,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/null_encoder.hpp",
"chars": 1514,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/ogg_encoder.cpp",
"chars": 9666,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/ogg_encoder.hpp",
"chars": 1916,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
},
{
"path": "server/encoder/opus_encoder.cpp",
"chars": 10144,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2015 Hannes Ellinger\n Copyright (C) 2016-2025 Johannes Poh"
},
{
"path": "server/encoder/opus_encoder.hpp",
"chars": 1685,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2015 Hannes Ellinger\n Copyright (C) 2016-2025 Johannes Poh"
},
{
"path": "server/encoder/pcm_encoder.cpp",
"chars": 2720,
"preview": "/***\n This file is part of snapcast\n Copyright (C) 2014-2025 Johannes Pohl\n\n This program is free software: yo"
}
]
// ... and 71 more files (download for full content)
About this extraction
This page contains the full source code of the snapcast/snapcast GitHub repository, extracted and formatted as plain text for AI agents and large language models (LLMs). The extraction includes 271 files (2.6 MB), approximately 684.0k tokens, and a symbol index with 1511 extracted functions, classes, methods, constants, and types. Use this with OpenClaw, Claude, ChatGPT, Cursor, Windsurf, or any other AI tool that accepts text input. You can copy the full output to your clipboard or download it as a .txt file.
Extracted by GitExtract — free GitHub repo to text converter for AI. Built by Nikandr Surkov.