diff --git a/.clang-format b/.clang-format
new file mode 100644
index 00000000..7b1bec3d
--- /dev/null
+++ b/.clang-format
@@ -0,0 +1,20 @@
+---
+AccessModifierOffset: '-4'
+AllowShortBlocksOnASingleLine: 'false'
+AllowShortCaseLabelsOnASingleLine: 'false'
+AllowShortFunctionsOnASingleLine: None
+AllowShortIfStatementsOnASingleLine: 'false'
+AllowShortLoopsOnASingleLine: 'false'
+AlwaysBreakTemplateDeclarations: 'true'
+BreakBeforeBraces: Allman
+ColumnLimit: '160'
+IndentCaseLabels: 'true'
+IndentWidth: '4'
+Language: Cpp
+MaxEmptyLinesToKeep: '3'
+PenaltyBreakComment: '100000'
+PointerAlignment: Left
+Standard: Cpp11
+UseTab: Never
+
+...
diff --git a/.gitignore b/.gitignore
index 77afae24..b57ef8a7 100644
--- a/.gitignore
+++ b/.gitignore
@@ -34,3 +34,24 @@ server/snapserver
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
diff --git a/.gitmodules b/.gitmodules
index ed007560..299e4477 100644
--- a/.gitmodules
+++ b/.gitmodules
@@ -1,21 +1,15 @@
-[submodule "externals/popl"]
- path = externals/popl
- url = https://github.com/badaix/popl.git
-[submodule "externals/asio"]
- path = externals/asio
- url = https://github.com/chriskohlhoff/asio.git
[submodule "externals/flac"]
path = externals/flac
- url = https://git.xiph.org/flac.git
+ url = https://gitlab.xiph.org/xiph/flac.git
[submodule "externals/ogg"]
path = externals/ogg
- url = https://git.xiph.org/ogg.git
+ url = https://gitlab.xiph.org/xiph/ogg.git
[submodule "externals/tremor"]
path = externals/tremor
- url = https://git.xiph.org/tremor.git
-[submodule "externals/jsonrpcpp"]
- path = externals/jsonrpcpp
- url = https://github.com/badaix/jsonrpcpp.git
-[submodule "externals/aixlog"]
- path = externals/aixlog
- url = https://github.com/badaix/aixlog.git
+ url = https://github.com/badaix/tremor.git
+[submodule "externals/opus"]
+ path = externals/opus
+ url = https://gitlab.xiph.org/xiph/opus.git
+[submodule "externals/oboe"]
+ path = externals/oboe
+ url = https://github.com/google/oboe.git
diff --git a/.travis.yml b/.travis.yml
index e265330e..0cd75742 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,28 +1,208 @@
language: cpp
-compiler:
- - gcc
+dist: trusty
+sudo: required
+group: edge
+
+git:
+ submodules: false
+
matrix:
include:
- # build on ubuntu
- os: linux
- sudo: required
+ compiler: gcc
+ env:
+ - COMPILER=g++-4.9
addons:
apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
packages:
- - build-essential libasound2-dev libvorbisidec-dev libvorbis-dev libflac-dev alsa-utils libavahi-client-dev avahi-daemon
+ - g++-4.9 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: gcc
env:
- - MATRIX_EVAL="CC=gcc-7 && CXX=g++-7"
+ - COMPILER=g++-5
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
+ packages:
+ - g++-5 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: gcc
+ env:
+ - COMPILER=g++-6
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
+ packages:
+ - g++-6 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: gcc
+ env:
+ - COMPILER=g++-7
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
+ packages:
+ - g++-7 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: gcc
+ env:
+ - COMPILER=g++-8
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
+ packages:
+ - g++-8 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: gcc
+ env:
+ - COMPILER=g++-9
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - ubuntu-toolchain-r-test
+ packages:
+ - g++-9 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+
+ - os: linux
+ compiler: clang
+ env:
+ - COMPILER=clang++-3.9
+ - CXXFLAGS=-stdlib=libc++
+ - CC=clang-3.9
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - llvm-toolchain-trusty-3.9
+ packages:
+ - clang-3.9 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: clang
+ env:
+ - COMPILER=clang++-4.0
+ - CXXFLAGS=-stdlib=libc++
+ - CC=clang-4.0
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - llvm-toolchain-trusty-4.0
+ packages:
+ - clang-4.0 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: clang
+ env:
+ - COMPILER=clang++-5.0
+ - CXXFLAGS=-stdlib=libc++
+ - CC=clang-5.0
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - llvm-toolchain-trusty-5.0
+ packages:
+ - clang-5.0 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: clang
+ env:
+ - COMPILER=clang++-6.0
+ - CXXFLAGS=-stdlib=libc++
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - llvm-toolchain-trusty-6.0
+ - ubuntu-toolchain-r-test
+ packages:
+ - clang-6.0 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
+ - os: linux
+ compiler: clang
+ env:
+ - COMPILER=clang++-7
+ - CXXFLAGS=-stdlib=libc++
+ addons:
+ apt:
+ sources:
+ - sourceline: 'ppa:mhier/libboost-latest'
+ - llvm-toolchain-trusty-7
+ - ubuntu-toolchain-r-test
+ packages:
+ - clang-7 boost1.70 libasound2-dev libsoxr-dev libvorbisidec-dev libvorbis-dev libflac-dev libopus-dev alsa-utils libavahi-client-dev avahi-daemon
+
# build on osx
- os: osx
- osx_image: xcode9.1
+ osx_image: xcode9.4
env:
- - MATRIX_EVAL="brew update && brew install flac libvorbis"
- allow_failures:
+ - MATRIX_EVAL="brew update && brew unlink python@2 && brew upgrade boost && brew install flac opus libvorbis libsoxr"
+
- os: osx
+ osx_image: xcode10.3
+ env:
+ - MATRIX_EVAL="brew update && brew install flac opus libvorbis libsoxr"
+
+ - os: osx
+ osx_image: xcode11
+ env:
+ - MATRIX_EVAL="brew update && brew install flac opus libvorbis libsoxr"
+
+ # build on windows
+ - os: windows
+
before_install:
- eval "${MATRIX_EVAL}"
+ - |
+ (
+ if [ "$TRAVIS_OS_NAME" = 'windows' ]; then
+ curl -LfsS -o /tmp/travis-wait-enhanced.zip "https://github.com/crazy-max/travis-wait-enhanced/releases/download/v1.1.0/travis-wait-enhanced_1.1.0_windows_x86_64.zip"
+ 7z x /tmp/travis-wait-enhanced.zip -y -o/usr/bin/ travis-wait-enhanced.exe -r
+ travis-wait-enhanced --version # we use this tool so travis doesn't timeout when there's no output for > 10 minutes (vcpkg has no verbose option). travis_wait also fixes this issue, but it swallows the output
+ if [ ! -f "vcpkg/vcpkg.exe" ]; then # if not in cache from a previous run
+ git clone https://github.com/Microsoft/vcpkg.git
+ ./vcpkg/bootstrap-vcpkg.bat
+ travis-wait-enhanced --interval=1m --timeout=30m -- ./vcpkg/vcpkg.exe install libflac libvorbis soxr opus boost-asio --triplet x64-windows
+ else
+ ./vcpkg/vcpkg.exe update # make sure dependencies are up to date
+ fi
+ fi
+ )
+
script:
- - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then BUILD_PARAMS="TARGET=MACOS" ; fi
- - make $BUILD_PARAMS
- - sudo make installclient $BUILD_PARAMS
- - sudo make installserver $BUILD_PARAMS
+ # make sure CXX is correctly set
+ - if [[ "${COMPILER}" != "" ]] && [[ "${TRAVIS_COMPILER}" == "gcc" ]]; then export CXX=${COMPILER}; fi
+
+ - mkdir build
+ - cd build
+ - |
+ (
+ if [ "$TRAVIS_OS_NAME" != 'windows' ]; then
+ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS="$CXXFLAGS -Werror -Wall -Wextra -pedantic -Wno-unused-function" .. && make && sudo make install
+ else
+ cmake -G "Visual Studio 15 2017 Win64" -DCMAKE_TOOLCHAIN_FILE=../vcpkg/scripts/buildsystems/vcpkg.cmake -DVCPKG_TARGET_TRIPLET=x64-windows ..
+ cmake --build . --config Release
+ fi
+ )
+cache:
+ directories:
+ - vcpkg
\ No newline at end of file
diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644
index 00000000..3aad38ce
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,237 @@
+cmake_minimum_required(VERSION 3.2)
+
+project(snapcast LANGUAGES CXX VERSION 0.20.0)
+set(PROJECT_DESCRIPTION "Multiroom client-server audio player")
+set(PROJECT_URL "https://github.com/badaix/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 (run tests with make test)" ON)
+
+if(NOT WIN32)
+ option(BUILD_SERVER "Build Snapserver" ON) # no Windows server for now
+endif()
+
+option(BUILD_CLIENT "Build Snapclient" 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" ON)
+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)
+
+
+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()
+
+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)
+ add_definitions("-DASIO_DISABLE_STD_FUTURE")
+ if (BUILD_SERVER)
+ message(FATAL_ERROR "Snapserver not yet supported for Android, use \"-DBUILD_SERVER=OFF\"")
+ endif()
+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_definitions(-DVERSION="${PROJECT_VERSION}")
+
+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)
+
+# Configure compiler options
+set(CMAKE_CXX_STANDARD 14)
+
+# Get arch
+include(${CMAKE_SOURCE_DIR}/cmake/TargetArch.cmake)
+target_architecture(ARCH)
+
+#message(STATUS "System name: ${CMAKE_SYSTEM_NAME}")
+#message(STATUS "Architecture: ${ARCH}")
+#message(STATUS "System processor: ${CMAKE_SYSTEM_PROCESSOR}")
+
+include(CheckAtomic)
+
+INCLUDE(TestBigEndian)
+TEST_BIG_ENDIAN(BIGENDIAN)
+IF(${BIGENDIAN})
+ add_definitions("-DIS_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_definitions("-DNO_CPP11_STRING")
+endif()
+
+
+if(NOT WIN32)
+
+ if(MACOSX)
+ set(BONJOUR_FOUND true)
+ if (BONJOUR_FOUND)
+ add_definitions(-DHAS_BONJOUR)
+ endif (BONJOUR_FOUND)
+
+ add_definitions(-DFREEBSD -DHAS_DAEMON)
+ link_directories("/usr/local/lib")
+ list(APPEND INCLUDE_DIRS "/usr/local/include")
+ list(APPEND CMAKE_REQUIRED_INCLUDES "${INCLUDE_DIRS}")
+ elseif(ANDROID)
+ # add_definitions("-DNO_CPP11_STRING")
+ else()
+ if (BUILD_CLIENT)
+ pkg_search_module(ALSA REQUIRED alsa)
+ if (ALSA_FOUND)
+ add_definitions(-DHAS_ALSA)
+ endif (ALSA_FOUND)
+ endif()
+
+ if(BUILD_WITH_AVAHI)
+ pkg_search_module(AVAHI avahi-client)
+ if (AVAHI_FOUND)
+ add_definitions(-DHAS_AVAHI)
+ endif (AVAHI_FOUND)
+ endif(BUILD_WITH_AVAHI)
+
+ add_definitions(-DHAS_DAEMON)
+
+ if(FREEBSD)
+ add_definitions(-DFREEBSD)
+ link_directories("/usr/local/lib")
+ list(APPEND INCLUDE_DIRS "/usr/local/include")
+ list(APPEND CMAKE_REQUIRED_INCLUDES "${INCLUDE_DIRS}")
+ endif()
+ endif()
+
+
+ if(BUILD_WITH_FLAC)
+ pkg_search_module(FLAC flac)
+ if (FLAC_FOUND)
+ add_definitions("-DHAS_FLAC")
+ endif (FLAC_FOUND)
+ endif()
+
+ if(BUILD_WITH_VORBIS OR BUILD_WITH_TREMOR)
+ pkg_search_module(OGG ogg)
+ if (OGG_FOUND)
+ add_definitions("-DHAS_OGG")
+ endif (OGG_FOUND)
+ endif()
+
+ if(BUILD_WITH_VORBIS)
+ pkg_search_module(VORBIS vorbis)
+ if (VORBIS_FOUND)
+ add_definitions("-DHAS_VORBIS")
+ endif (VORBIS_FOUND)
+ endif()
+
+ if(BUILD_WITH_TREMOR)
+ pkg_search_module(TREMOR vorbisidec)
+ if (TREMOR_FOUND)
+ add_definitions("-DHAS_TREMOR")
+ endif (TREMOR_FOUND)
+ endif()
+
+ if(BUILD_WITH_VORBIS)
+ pkg_search_module(VORBISENC vorbisenc)
+ if (VORBISENC_FOUND)
+ add_definitions("-DHAS_VORBIS_ENC")
+ endif(VORBISENC_FOUND)
+ endif()
+
+ if(BUILD_WITH_OPUS)
+ pkg_search_module(OPUS opus)
+ if (OPUS_FOUND)
+ add_definitions("-DHAS_OPUS")
+ endif (OPUS_FOUND)
+ endif()
+
+ if(BUILD_WITH_EXPAT)
+ pkg_search_module(EXPAT expat)
+ if (EXPAT_FOUND)
+ add_definitions("-DHAS_EXPAT")
+ endif (EXPAT_FOUND)
+ endif()
+endif()
+
+find_package(Boost 1.70 REQUIRED)
+add_definitions("-DBOOST_ERROR_CODE_HEADER_ONLY")
+
+if(WIN32)
+ include(FindPackageHandleStandardArgs)
+
+ find_path(FLAC_INCLUDE_DIRS FLAC/all.h)
+ find_library(FLAC_LIBRARIES FLAC)
+ find_package_handle_standard_args(FLAC DEFAULT_MSG FLAC_INCLUDE_DIRS FLAC_LIBRARIES)
+
+ find_path(OGG_INCLUDE_DIRS ogg/ogg.h)
+ find_library(OGG_LIBRARIES ogg)
+ find_package_handle_standard_args(Ogg DEFAULT_MSG OGG_INCLUDE_DIRS OGG_LIBRARIES)
+
+ find_path(VORBIS_INCLUDE_DIRS vorbis/vorbisenc.h)
+ find_library(VORBIS_LIBRARIES vorbis)
+ find_package_handle_standard_args(Vorbis DEFAULT_MSG 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)
+
+ add_definitions(-DNTDDI_VERSION=0x06020000 -D_WIN32_WINNT=0x0602 -DWINVER=0x0602 -DWINDOWS -DWIN32_LEAN_AND_MEAN -DUNICODE -D_UNICODE -D_CRT_SECURE_NO_WARNINGS )
+ add_definitions(-DHAS_OGG -DHAS_VORBIS -DHAS_FLAC -DHAS_VORBIS_ENC -DHAS_OPUS -DHAS_WASAPI)
+endif()
+
+add_subdirectory(common)
+
+if (BUILD_SERVER)
+ add_subdirectory(server)
+endif()
+
+if (BUILD_CLIENT)
+ add_subdirectory(client)
+endif()
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 45248814..8b7f1034 100644
--- a/Makefile
+++ b/Makefile
@@ -2,6 +2,11 @@
all: client server
+reformat:
+ find client/ -iname *.h -o -iname *.hpp -o -iname *.cpp | xargs clang-format -i
+ find server/ -iname *.h -o -iname *.hpp -o -iname *.cpp | xargs clang-format -i
+ find common/ -iname *.h -o -iname *.hpp -o -iname *.cpp | xargs clang-format -i
+
server:
$(MAKE) -C server
diff --git a/README.md b/README.md
index cc8f191a..168533ab 100644
--- a/README.md
+++ b/README.md
@@ -1,116 +1,201 @@
-Snapcast
-========
+# Snapcast

-**S**y**n**chronous **a**udio **p**layer
-
+**S**y**n**chronous **a**udio **p**layer
+
[](https://travis-ci.org/badaix/snapcast)
[](https://github.com/badaix/snapcast/releases)
+[](https://www.paypal.me/badaix)
-Snapcast is a multi-room client-server audio player, where all clients are time synchronized with the server to play perfectly synced audio. It's not a standalone player, but an extension that turns your existing audio player into a Sonos-like multi-room solution.
-The server's audio input is a named pipe `/tmp/snapfifo`. All data that is fed into this file will be send to the connected clients. One of the most generic ways to use Snapcast is in conjunction with the music player daemon ([MPD](http://www.musicpd.org/)) or [Mopidy](https://www.mopidy.com/), which can be configured to use a named pipe as audio output.
+Snapcast is a multiroom client-server audio player, where all clients are time synchronized with the server to play perfectly synced audio. It's not a standalone player, but an extension that turns your existing audio player into a Sonos-like multiroom solution.
+The server's audio input is a named pipe `/tmp/snapfifo`. All data that is fed into this file will be sent to the connected clients. One of the most generic ways to use Snapcast is in conjunction with the music player daemon ([MPD](http://www.musicpd.org/)) or [Mopidy](https://www.mopidy.com/), which can be configured to use a named pipe as audio output.
+
+## How does it work
-How does is work
-----------------
The Snapserver reads PCM chunks from the pipe `/tmp/snapfifo`. The chunk is encoded and tagged with the local time. Supported codecs are:
-* **PCM** lossless uncompressed
-* **FLAC** lossless compressed [default]
-* **Vorbis** lossy compression
+
+- **PCM** lossless uncompressed
+- **FLAC** lossless compressed [default]
+- **Vorbis** lossy compression
+- **Opus** lossy low-latency compression
The encoded chunk is sent via a TCP connection to the Snapclients.
-Each client does continuos time synchronization with the server, so that the client is always aware of the local server time.
-Every received chunk is first decoded and added to the client's chunk-buffer. Knowing the server's time, the chunk is played out using ALSA at the appropriate time. Time deviations are corrected by
-* skipping parts or whole chunks
-* playing silence
-* playing faster/slower
+Each client does continuous time synchronization with the server, so that the client is always aware of the local server time.
+Every received chunk is first decoded and added to the client's chunk-buffer. Knowing the server's time, the chunk is played out using a system dependend low level audio API (e.g. ALSA) at the appropriate time. Time deviations are corrected by playing faster/slower, which is done by removing/duplicating single samples (a sample at 48kHz has a duration of ~0.02ms).
-Typically the deviation is smaller than 1ms.
+Typically the deviation is below 0.2ms.
-Installation
-------------
-You can either build and install snapcast from source, or on debian systems install a prebuild .deb package
+For more information on the binary protocol, please see the [documentation](doc/binary_protocol.md).
-### Installation from source
-Please follow this [guide](doc/build.md) to build Snapcast for
-* [Linux](doc/build.md#linux-native)
-* [FreeBSD](doc/build.md#freebsd-native)
-* [macOS](doc/build.md#macos-native)
-* [Android](doc/build.md#android-cross-compile)
-* [OpenWrt](doc/build.md#openwrtlede-cross-compile)
-* [Buildroot](doc/build.md#buildroot-cross-compile)
- * [Raspberry Pi](doc/build.md#raspberry-pi-cross-compile)
+## Installation
+
+You can either install Snapcast from a prebuilt package (recommended for new users), or build and install snapcast from source.
+
+### Install Linux packages (recommended for beginners)
+
+Snapcast packages are available for several Linux distributions.
+
+#### Debian
+
+For Debian (and Debian-based systems, such as Ubuntu, Linux Mint, ElementaryOS) download the package for your CPU architecture from the [latest release page](https://github.com/badaix/snapcast/releases/latest).
+
+e.g. for Raspberry Pi `snapclient_0.x.x_armhf.deb`, for laptops `snapclient_0.x.x_amd64.deb`
+
+##### using apt 1.1 or later
+
+ sudo apt install
+
+or
+
+ sudo apt install
+
+##### using dpkg
-### Install debian packages
-Download the debian package for your CPU architecture from the [latest release page](https://github.com/badaix/snapcast/releases/latest), e.g. for Raspberry pi `snapclient_0.x.x_armhf.deb`
Install the package:
- $ sudo dpkg -i snapclient_0.x.x_armhf.deb
+ sudo dpkg -i snapclient_0.x.x_armhf.deb
+
+or
+
+ sudo dpkg -i snapclient_0.x.x_amd64.deb
Install missing dependencies:
- $ sudo apt-get -f install
+ sudo apt-get -f install
+
+#### OpenWrt
On OpenWrt do:
- $ opkg install snapclient_0.x.x_ar71xx.ipk
+ opkg install snapclient_0.x.x_ar71xx.ipk
+
+#### Alpine Linux
+
+On Alpine Linux do:
+
+ apk add snapcast
+
+Or, for just the client:
+
+ apk add snapcast-client
+
+Or, for just the server:
+
+ apk add snapcast-server
+
+#### Gentoo Linux
+
+On Gentoo Linux do:
+
+ emerge --ask media-sound/snapcast
+
+#### Archlinux
+
+On Archlinux, Snapcast is available through the AUR. To install, use your favorite AUR helper, or do:
+
+ git clone https://aur.archlinux.org/snapcast
+ cd snapcast
+ makepkg -si
+
+#### Void Linux
+
+To install the client:
+
+ # xbps-install snapclient
+
+To install the server:
+
+ # xbps-install snapserver
+
+### Installation from source
+
+Please follow this [guide](doc/build.md) to build Snapcast for
+
+- [Linux](doc/build.md#linux-native)
+- [FreeBSD](doc/build.md#freebsd-native)
+- [macOS](doc/build.md#macos-native)
+- [Android](doc/build.md#android-cross-compile)
+- [OpenWrt](doc/build.md#openwrtlede-cross-compile)
+- [Buildroot](doc/build.md#buildroot-cross-compile)
+- [Raspberry Pi](doc/build.md#raspberry-pi-cross-compile)
+
+## SnapOS
+
+The bravest among you may be interested in [SnapOS](https://github.com/badaix/snapos), a small and fast-booting "just enough" OS to run Snapcast as an appliance.
+
+There is a guide (with the necessary buildfiles) available to build SnapOS, which comes in two flavors:
+
+- [Buildroot](https://github.com/badaix/snapos/blob/master/buildroot-external/README.md) based, or
+- [OpenWrt](https://github.com/badaix/snapos/tree/master/openwrt) based.
+
+Please note that there are no pre-built firmware packages available.
+
+## Configuration
-Configuration
--------------
After installation, Snapserver and Snapclient are started with the command line arguments that are configured in `/etc/default/snapserver` and `/etc/default/snapclient`.
Allowed options are listed in the man pages (`man snapserver`, `man snapclient`) or by invoking the snapserver or snapclient with the `-h` option.
-Different streams can by configured with a list of `-s` options, e.g.:
+The server configuration is done in `/etc/snapserver.conf`. Different streams can by configured in the `[stream]` section with a list of `stream` options, e.g.:
- SNAPSERVER_OPTS="-d -s pipe:///tmp/snapfifo?name=Radio&sampleformat=48000:16:2&codec=flac -s file:///home/user/Musik/Some%20wave%20file.wav?name=File"
+ [stream]
+ stream = pipe:///tmp/snapfifo?name=Radio&sampleformat=48000:16:2&codec=flac
+ stream = file:///home/user/Musik/Some%20wave%20file.wav?name=File
+
+The pipe stream (`stream = pipe`) will per default create the pipe. Sometimes your audio source might insist in creating the pipe itself. So the pipe creation mode can by changed to "not create, but only read mode", using the `mode` option set to `create` or `read`:
+
+ stream = pipe:///tmp/snapfifo?name=Radio&mode=read"
+
+## Test
-The pipe stream (`-s pipe`) will per default create the pipe. Sometimes your audio source might insist in creating the pipe itself. So the pipe creation mode can by changed to "not create, but only read mode", using the `mode` option set to `create` or `read`:
-
- SNAPSERVER_OPTS="-d -s pipe:///tmp/snapfifo?name=Radio&mode=read"
-
-Test
-----
You can test your installation by copying random data into the server's fifo file
- $ sudo cat /dev/urandom > /tmp/snapfifo
+ sudo cat /dev/urandom > /tmp/snapfifo
All connected clients should play random noise now. You might raise the client's volume with "alsamixer".
-It's also possible to let the server play a wave file. Simply configure a `file` stream in `/etc/default/snapserver`, and restart the server:
+It's also possible to let the server play a WAV file. Simply configure a `file` stream in `/etc/snapserver.conf`, and restart the server:
- SNAPSERVER_OPTS="-d -s file:///home/user/Musik/Some%20wave%20file.wav?name=test"
+ [stream]
+ stream = file:///home/user/Musik/Some%20wave%20file.wav?name=test
-When you are using a Raspberry pi, you might have to change your audio output to the 3.5mm jack:
+When you are using a Raspberry Pi, you might have to change your audio output to the 3.5mm jack:
#The last number is the audio output with 1 being the 3.5 jack, 2 being HDMI and 0 being auto.
- $ amixer cset numid=3 1
+ amixer cset numid=3 1
-To setup WiFi on a raspberry pi, you can follow this guide:
-https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md
+To setup WiFi on a Raspberry Pi, you can follow this [guide](https://www.raspberrypi.org/documentation/configuration/wireless/wireless-cli.md)
+
+## Control
-Control
--------
Snapcast can be controlled using a [JSON-RPC API](doc/json_rpc_api/v2_0_0.md):
-* Set client's volume
-* Mute clients
-* Rename clients
-* Assign a client to a stream
-* ...
-There is an Android client available in [Releases](https://github.com/badaix/snapcast/releases/latest)
+- Set client's volume
+- Mute clients
+- Rename clients
+- Assign a client to a stream
+- ...
+
+There is an Android client [snapdroid](https://github.com/badaix/snapdroid) available in [Releases](https://github.com/badaix/snapdroid/releases/latest) and on [Google Play](https://play.google.com/store/apps/details?id=de.badaix.snapcast)

There is also an unofficial WebApp from @atoomic [atoomic/snapcast-volume-ui](https://github.com/atoomic/snapcast-volume-ui).
-This app list all clients connected to a server and allow to control individualy the volume of each client.
+This app lists all clients connected to a server and allows you to control individually the volume of each client.
Once installed, you can use any mobile device, laptop, desktop, or browser.
-There is also an [unofficial FHEM module](https://forum.fhem.de/index.php/topic,62389.0.html) from @unimatrix27 which integrates a snapcast controller in to the [FHEM](https://fhem.de/fhem.html) home automation system.
+There is also an [unofficial FHEM module](https://forum.fhem.de/index.php/topic,62389.0.html) from @unimatrix27 which integrates a Snapcast controller into the [FHEM](https://fhem.de/fhem.html) home automation system.
-There is a [snapcast component for Home Assistant](https://home-assistant.io/components/media_player.snapcast/) which integrates a snapcast controller in to the [Home Assistant](https://home-assistant.io/) home automation system.
+There is a [snapcast component for Home Assistant](https://home-assistant.io/components/media_player.snapcast/) which integrates a Snapcast controller in to the [Home Assistant](https://home-assistant.io/) home automation system.
+
+For a web interface in Python, see [snapcastr](https://github.com/xkonni/snapcastr), based on [python-snapcast](https://github.com/happyleavesaoc/python-snapcast). This interface controls client volume and assigns streams to groups.
+
+Another web interface running on any device is [snapcast-websockets-ui](https://github.com/derglaus/snapcast-websockets-ui), running entirely in the browser, which needs [websockify](https://github.com/novnc/websockify). No configuration needed; features almost all functions; still needs some tuning for the optics.
+
+A web interface called [HydraPlay](https://github.com/mariolukas/HydraPlay) integrates Snapcast and multiple Mopidy instances. It is JavaScript based and uses Angular 7. A Snapcast web socket proxy server is needed to connect Snapcast to HydraPlay over web sockets.
+
+## Setup of audio players/server
-Setup of audio players/server
------------------------------
Snapcast can be used with a number of different audio players and servers, and so it can be integrated into your favorite audio-player solution and make it synced-multiroom capable.
The only requirement is that the player's audio can be redirected into the Snapserver's fifo `/tmp/snapfifo`. In the following configuration hints for [MPD](http://www.musicpd.org/) and [Mopidy](https://www.mopidy.com/) are given, which are base of other audio player solutions, like [Volumio](https://volumio.org/) or [RuneAudio](http://www.runeaudio.com/) (both MPD) or [Pi MusicBox](http://www.pimusicbox.com/) (Mopidy).
@@ -119,29 +204,31 @@ The goal is to build the following chain:
audio player software -> snapfifo -> snapserver -> network -> snapclient -> alsa
This [guide](doc/player_setup.md) shows how to configure different players/audio sources to redirect their audio signal into the Snapserver's fifo:
-* [MPD](doc/player_setup.md#mpd)
-* [Mopidy](doc/player_setup.md#mopidy)
-* [FFmpeg](doc/player_setup.md#ffmpeg)
-* [mpv](doc/player_setup.md#mpv)
-* [MPlayer](doc/player_setup.md#mplayer)
-* [Alsa](doc/player_setup.md#alsa)
-* [PulseAudio](doc/player_setup.md#pulseaudio)
-* [AirPlay](doc/player_setup.md#airplay)
-* [Spotify](doc/player_setup.md#spotify)
-* [Process](doc/player_setup.md#process)
-* [Line-in](doc/player_setup.md#line-in)
-Roadmap
--------
+- [MPD](doc/player_setup.md#mpd)
+- [Mopidy](doc/player_setup.md#mopidy)
+- [FFmpeg](doc/player_setup.md#ffmpeg)
+- [mpv](doc/player_setup.md#mpv)
+- [MPlayer](doc/player_setup.md#mplayer)
+- [Alsa](doc/player_setup.md#alsa)
+- [PulseAudio](doc/player_setup.md#pulseaudio)
+- [AirPlay](doc/player_setup.md#airplay)
+- [Spotify](doc/player_setup.md#spotify)
+- [Process](doc/player_setup.md#process)
+- [Line-in](doc/player_setup.md#line-in)
+
+## Roadmap
+
Unordered list of features that should make it into the v1.0
-- [X] **Remote control** JSON-RPC API to change client latency, volume, zone, ...
+
+- [X] **Remote control** JSON-RPC API to change client latency, volume, zone,...
- [X] **Android client** JSON-RPC client and Snapclient
- [X] **Streams** Support multiple streams
- [X] **Debian packages** prebuild deb packages
- [X] **Endian** independent code
- [X] **OpenWrt** port Snapclient to OpenWrt
-- [X] **Hi-Res audio** support (like 192kHz 24bit)
+- [X] **Hi-Res audio** support (like 96kHz 24bit)
- [X] **Groups** support multiple Groups of clients ("Zones")
- [ ] **JSON-RPC** Possibility to add, remove, rename streams
- [ ] **Protocol specification** Snapcast binary streaming protocol, JSON-RPC protocol
-- [ ] **Ports** Snapclient for Windows, ~~Mac OS X~~, ...
+- [ ] **Ports** Snapclient for Windows, ~~Mac OS X~~,...
diff --git a/TODO.md b/TODO.md
new file mode 100644
index 00000000..b29b2689
--- /dev/null
+++ b/TODO.md
@@ -0,0 +1,28 @@
+TODO
+====
+
+General
+-------
+
+- Update Readme.md
+- JsonRPC documentation
+- Server ping client?
+- UDP based audio streaming
+
+Server
+------
+
+- [fd stream](https://gstreamer.freedesktop.org/data/doc/gstreamer/head/gstreamer-plugins/html/gstreamer-plugins-fdsink.html)
+- gstreamer snapcast sink plugin?
+- "sync" option for streams (realtime reading vs read as much as available)
+- #402: Add meta stream that reads the input of other streams (in some fallback hierarchy manner: when the first one plays, use this signal, else if the second is playing, take this, ...).
+
+Client
+------
+
+- Add option to not play in sync, i.e. not change the tempo
+
+Issues
+------
+
+- Android clean data structures after changing the Server
diff --git a/android/.gitignore b/android/.gitignore
deleted file mode 100644
index c6cbe562..00000000
--- a/android/.gitignore
+++ /dev/null
@@ -1,8 +0,0 @@
-*.iml
-.gradle
-/local.properties
-/.idea/workspace.xml
-/.idea/libraries
-.DS_Store
-/build
-/captures
diff --git a/android/.idea/.name b/android/.idea/.name
deleted file mode 100644
index 1fd74d19..00000000
--- a/android/.idea/.name
+++ /dev/null
@@ -1 +0,0 @@
-android
\ No newline at end of file
diff --git a/android/.idea/compiler.xml b/android/.idea/compiler.xml
deleted file mode 100644
index 96cc43ef..00000000
--- a/android/.idea/compiler.xml
+++ /dev/null
@@ -1,22 +0,0 @@
-
- Copyright © 2014 - 2017 BadAix Author: Johannes Pohl and contributors Snapcast is licensed under the GNU General Public License, version 3 or
- later (herein referred to as GPL). If you find Snapcast useful, then I'd really appreciate it if you'd consider contributing to the project however you can.
- Donating is the easiest. You can donate Bitcoins here: 1Cm9WL99fyYSPbLvgnGbRihjb1GYZ5aZFz
- The sources to this application can be retrieved at https://github.com/badaix/snapcast. Snapcast uses external libraries that make extensive use of the following persons' or companies' code:
-
-
-
-
-
-
-
-
-
-
License
-
- How Can I Help?
-
- Sources
-
- Libraries
-
-
-
-
-
-
Version 3, 29 June 2007
- -Copyright © 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.
- -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.
- -“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.
- -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.
- -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.
- -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.
- -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.
- -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 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.
- -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 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.
- -“Additional permissions” are terms that supplement the terms of this License by making exceptions from one - or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though - they were included in this License, to the extent that they are valid under applicable law. If additional permissions - apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains - governed by this License without regard to the additional permissions.
- -When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from - any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the - work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give - appropriate copyright permission.
- -Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by - the copyright holders of that material) supplement the terms of this License with terms:
- -All other non-permissive additional terms are considered “further restrictions” within the meaning of section - 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License - along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction - but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms - of that license document, provided that the further restriction does not survive such relicensing or conveying.
- -If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement - of the additional terms that apply to those files, or a notice indicating where to find the applicable terms.
- -Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as - exceptions; the above requirements apply either way.
- -You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to - propagate or modify it is void, and will automatically terminate your rights under this License (including any patent - licenses granted under the third paragraph of section 11).
- -However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated - (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, - if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.
- -Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you - of the violation by some reasonable means, this is the first time you have received notice of violation of this License - (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.
- -Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights - from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to - receive new licenses for the same material under section 10.
- -You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of - a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not - require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered - work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered - work, you indicate your acceptance of this License to do so.
- -Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, - modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties - with this License.
- -An “entity transaction” is a transaction transferring control of an organization, or substantially all assets - of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity - transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work - the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the - Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable - efforts. -
- -You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, - you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you - may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed - by making, using, selling, offering for sale, or importing the Program or any portion of it.
- -A “contributor” is a copyright holder who authorizes use under this License of the Program or a work on which - the Program is based. The work thus licensed is called the contributor's “contributor version”.
- -A contributor's “essential patent claims” are all patent claims owned or controlled by the contributor, whether - already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, - using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of - further modification of the contributor version. For purposes of this definition, “control” includes the right - to grant patent sublicenses in a manner consistent with the requirements of this License.
- -Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent - claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor - version. -
- -In the following three paragraphs, a “patent license” is any express agreement or commitment, however denominated, - not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). - To “grant” such a patent license to a party means to make such an agreement or commitment not to enforce a - patent against the party.
- -If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available - for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or - other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange - to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent - with the requirements of this License, to extend the patent license to downstream recipients. “Knowingly relying” - means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your - recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that - you have reason to believe are valid.
- -If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance - of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, - propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended - to all recipients of the covered work and works based on it.
- -A patent license is “discriminatory” if it does not include within the scope of its coverage, prohibits the - exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this - License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business - of distributing software, under which you make payment to the third party based on the extent of your activity of conveying - the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a - discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those - copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, - unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007.
- -Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement - that may otherwise be available to you under applicable patent law.
- -If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this - License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy - simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may - not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying - from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to - refrain entirely from conveying the Program.
- -Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work - licensed under version 3 of the GNU Affero General Public License into a single combined work, and to convey the resulting - work. The terms of this License will continue to apply to the part which is the covered work, but the special requirements - of the GNU Affero General Public License, section 13, concerning interaction through a network will apply to the combination - as such.
- -The Free Software Foundation may publish revised and/or new versions of the GNU General Public License from time to time. - Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or - concerns. -
- -Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the - GNU General Public License “or any later version” applies to it, you have the option of following the terms - and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the - Program does not specify a version number of the GNU General Public License, you may choose any version ever published - by the Free Software Foundation.
- -If the Program specifies that a proxy can decide which future versions of the GNU General Public License can be used, that - proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program.
- -Later license versions may give you additional or different permissions. However, no additional obligations are imposed - on any author or copyright holder as a result of your choosing to follow a later version.
- -THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING - THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER - EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR - PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, - YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
- -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO - MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, - INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED - TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM - TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
- -If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to - their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability - in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return - for a fee.
-Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson
- -- Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following - conditions are met: - -