Skip to content

Latest commit

 

History

History
232 lines (141 loc) · 7.28 KB

build.md

File metadata and controls

232 lines (141 loc) · 7.28 KB

#Build Snapcast Clone the Snapcast repository. To do this, you need git.
For Debian derivates (e.g. Raspbian, Debian, Ubuntu, Mint):

$ sudo apt-get install git

For Arch derivates:

$ pacman -S git

For FreeBSD:

$ sudo pkg install git

Clone Snapcast:

$ git clone https://github.com/badaix/snapcast.git

this creates a directory snapcast, in the following referred to as <snapcast dir>.
Next clone the external submodules:

$ cd <snapcast dir>/externals
$ git submodule update --init --recursive

##Linux (Native) Install the build tools and required libs:
For Debian derivates (e.g. Raspbian, Debian, Ubuntu, Mint):

$ sudo apt-get install build-essential
$ sudo apt-get install libasound2-dev libvorbisidec-dev libvorbis-dev libflac-dev alsa-utils libavahi-client-dev avahi-daemon

Compilation requires gcc 4.8 or higher, so it's highly recommended to use Debian (Raspbian) Jessie.

For Arch derivates:

$ pacman -S base-devel
$ pacman -S alsa-lib avahi libvorbis flac alsa-utils

###Build Snapclient and Snapserver cd into the Snapcast src-root directory:

$ cd <snapcast dir>
$ make

Install Snapclient and/or Snapserver:

$ sudo make installserver
$ sudo make installclient

This will copy the client and/or server binary to /usr/sbin and update init.d/systemd to start the client/server as a daemon.

###Build Snapclient cd into the Snapclient src-root directory:

$ cd <snapcast dir>/client
$ make

Install Snapclient

$ sudo make install

This will copy the client binary to /usr/sbin and update init.d/systemd to start the client as a daemon.

###Build Snapserver cd into the Snapserver src-root directory:

$ cd <snapcast dir>/server
$ make

Install Snapserver

$ sudo make install

This will copy the server binary to /usr/sbin and update init.d/systemd to start the server as a daemon.

##FreeBSD (Native) Install the build tools and required libs:

$ sudo pkg install gmake gcc bash avahi libogg libvorbis flac

###Build Snapserver cd into the Snapserver src-root directory:

$ cd <snapcast dir>/server
$ gmake TARGET=FREEBSD

Install Snapserver

$ sudo gmake TARGET=FREEBSD install

This will copy the server binary to /usr/local/sbin and the startup script to /usr/local/etc/rc.d/snapserver. To enable the Snapserver, add this line to /etc/rc.conf:

snapserver_enable="YES"

For additional command line arguments, add in /etc/rc.conf:

snapserver_opts="<your custom options>"

Start and stop the server with sudo service snapserver start and sudo service snapserver stop.

##macOS (Native)

Warning: macOS support is experimental

  1. Install Xcode from the App Store
  2. Install Homebrew
  3. Install the required libs
$ brew install flac libvorbis

###Build Snapclient cd into the Snapclient src-root directory:

$ cd <snapcast dir>/client
$ make TARGET=MACOS

Install Snapclient

$ sudo make install TARGET=MACOS

This will copy the client binary to /usr/local/bin and create a Launch Agent to start the client as a daemon.

###Build Snapserver cd into the Snapserver src-root directory:

$ cd <snapcast dir>/server
$ make TARGET=MACOS

Install Snapserver

$ sudo make install TARGET=MACOS

This will copy the server binary to /usr/local/bin and create a Launch Agent to start the server as a daemon.

##Android (Cross compile) Cross compilation for Android is done with the Android NDK on a Linux host machine.

###Android NDK setup http://developer.android.com/ndk/guides/standalone_toolchain.html

  1. Download NDK: https://dl.google.com/android/repository/android-ndk-r13-linux-x86_64.zip
  2. Extract to: /SOME/LOCAL/PATH/android-ndk-r13
  3. Setup toolchain somewhere in your home dir (<android-ndk dir>):
$ cd /SOME/LOCAL/PATH/android-ndk-r13/build/tools
$ ./make_standalone_toolchain.py --arch arm --api 14 --install-dir <android-ndk dir>

###Build Snapclient Edit the first lines in <snapcast dir>/client/build_android.sh and in <snapcast dir>/externals/build_externals_android.sh to let NDK_DIR point to your <android-ndk dir>
Cross compile and install FLAC, ogg, and tremor (only needed once):

$ cd <snapcast dir>/externals
$ ./build_externals_android.sh

Compile the Snapclient:

$ cd <snapcast dir>/client
$ ./build_android.sh

The binaries for armeabi and armeabi-v7a will be copied into the Android's assets directory (<snapcast dir>/android/Snapcast/src/main/assets/bin/) and will be part of the Snapcast App.

##OpenWrt (Cross compile) Cross compilation for OpenWrt is done with the OpenWrt build system on a Linux host machine.
https://wiki.openwrt.org/doc/howto/build

###OpenWrt build system setup https://wiki.openwrt.org/doc/howto/buildroot.exigence

Clone OpenWrt to some place in your home directory (<buildroot dir>)

$ git clone git://git.openwrt.org/15.05/openwrt.git

Download and install available feeds

$ cd <buildroot dir>
$ ./scripts/feeds update -a
$ ./scripts/feeds install -a

Build

$ make menuconfig
$ make

Within the OpenWrt directory create symbolic links to the Snapcast source directory and to the OpenWrt Makefile:

$ cd <buildroot dir>/package/sxx/snapcast
$ ln -s <snapcast dir>/openWrt/Makefile.openwrt Makefile
$ ln -s <snapcast dir> src

Build Snapcast:

$ cd <buildroot dir>
$ make package/sxx/snapcast/clean
$ make package/sxx/snapcast/compile

The packaged ipk files are in <buildroot dir>/bin/ar71xx/packages/base/snap[client|server]_x.x.x_ar71xx.ipk

##Buildroot (Cross compile) This example will show you how to add snapcast to Buildroot.

###Buildroot setup Buildroot recommends keeping customizations outside of the main Buildroot directory which is what this example will walk through.

Clone Buildroot to some place in your home directory (<buildroot dir>):

$ BUILDROOT_VERSION=2016.11.2
$ git clone --branch $BUILDROOT_VERSION --depth=1 git://git.buildroot.net/buildroot

The <snapcast dir>/buildroot is currently setup as an external Buildroot folder following the recommended structure. As of Buildroot 2016.11 you may specify multiple BR2_EXTERNAL trees. If you are using a version of Buildroot prior to this, then you will need to manually merge <snapcast dir>/buildroot with your existing Buildroot external tree.

Now configure buildroot with the required packages (you can also manually add them to your project's existing defconfig):

$ cd <buildroot dir> && make BR2_EXTERNAL=<snapcast dir>/buildroot snapcast_defconfig

Then use menuconfig to configure the rest of your project:

$ cd <buildroot dir> && make BR2_EXTERNAL=<snapcast dir>/buildroot menuconfig

And finally run the build:

$ cd <buildroot dir> && make BR2_EXTERNAL=<snapcast dir>/buildroot

##Raspberry Pi (Cross compile) This example will show you how to add snapcast to Buildroot and compile for Raspberry Pi.