bonob

A Sonos SMAPI implementation to allow registering sources of music with Sonos.

Support for Subsonic API clones (tested against Navidrome and Gonic).

Features

• SONOS S1 and S2 support
• Integrates with Subsonic API clones (Navidrome, Gonic)
• Browse by Artist, Albums, Random, Favourites, Top Rated, Playlist, Genres, Years, Recently Added Albums, Recently Played Albums, Most Played Albums
• Artist & Album Art
• View Related Artists via Artist -> '...' -> Menu -> Related Arists
• Now playing & Track Scrobbling
• Search by Album, Artist, Track
• Playlist editing through Sonos app.
• Marking of songs as favourites and with ratings through the Sonos app.
• Transcoding within subsonic clone
• Custom players by mime type, allowing custom transcoding rules for different file types
• Localization (only en-US, da-DK, nl-NL & fr-FR supported currently, require translations for other languages). Sonos localization and supported languages
• Multiple registrations within a single household.

S1 specific features

• Auto registration with Sonos on startup
• Auto discovery of Sonos devices
• Discovery of Sonos devices using seed IP address

Running bonob

bonob is packaged as an OCI image to both the docker hub registry and github registry.

docker run docker.io/simojenki/bonob
#or
docker run ghcr.io/simojenki/bonob

Sonos S1 vs S2

In May 2024 Sonos released an update to the Sonos S2 app that required bonob be exposed to the internet to continue to work on S2. S1 devices continue to work locally within youur network. There is a lengthy thread on the issue.

The tldr; is:

• If you have devices that can be down graded to Sonos S1 then you can use bonob within your network without exposing anything to the internet, support for this mode of operation will continue until Sonos themselves EOL S1. This mode is no longer the default, you will need to set SONOS_ENABLE_S1=true
• If you have devices that cannot be downgraded to S1 then you must use S2, in which case you need to expose bonob to the internet so that it can be called by Sonos itself. Exposing services to the internet comes with additional risk, tread carefully.

Sonos S2 setup

Sonos S1 setup

Configuration

Additional S1 configuration options

These will have no effect if you do not set BNB_SONOS_ENABLE_S1=true

Transcoding

Automatic (OpenSubsonic Transcoding extension)

If your Subsonic server supports the OpenSubsonic Transcoding extension (Navidrome 0.61.0+), bonob will automatically negotiate the right transcoding decisions with the server using a Sonos-specific capability profile.

This is the recommended approach for handling unsupported audio formats (e.g. high sample rate FLAC). The Sonos profile bonob sends declares the supported sample rates (≤48kHz), bit depths, and channels — the server then decides whether to direct play or transcode each track based on these capabilities. No manual BNB_SUBSONIC_CUSTOM_CLIENTS configuration is required.

Important: When using this approach, ensure the bonob player in your Subsonic server has no Transcoding profile assigned and no Max Bit Rate cap. A server-side player override would replace bonob's capability profile and prevent the extension from working correctly.

If the server does not support the extension (e.g. older Navidrome versions), bonob automatically falls back to the legacy /rest/stream flow described below.

Legacy transcoding options

Transcode everything

The simplest transcoding solution is to simply change the player ('bonob') in your subsonic server to transcode all content to something Sonos supports (ie. mp3 & flac)

Audio file type specific transcoding

Disclaimer: The following configuration is more complicated, and if you get the configuration wrong Sonos will refuse to play your content.

In some situations you may wish to have different 'Players' within your Subsonic server so that you can configure different transcoding options depending on the file type. For example if you have flacs with a mixture of frequency formats where not all are supported by Sonos See issue #52 & Sonos supported audio formats

In this case you could set;

# This is equivalent to setting BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac>audio/flac"
BNB_SUBSONIC_CUSTOM_CLIENTS="audio/flac"

This would result in 2 players in Navidrome, one called 'bonob', the other called 'bonob+audio/flac'. You could then configure a custom flac transcoder in Navidrome that re-samples the flacs to a Sonos supported format, ie Using something like this or this:

ffmpeg -i %s -af aformat=sample_fmts=s16|s32:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -

Note for Sonos S1: 24-bit depth is only supported by Sonos S2, so if your system is still on Sonos S1, transcoding should convert all FLACs to 16-bit:

ffmpeg -i %s -af aformat=sample_fmts=s16:sample_rates=8000|11025|16000|22050|24000|32000|44100|48000 -f flac -

Alternatively perhaps you have some aac (audio/mpeg) files that will not play in Sonos (ie. voice recordings from an iPhone), however you do not want to transcode all everything, just those audio/mpeg files. Let's say you want to transcode them to mp3s, you could set the following;

BNB_SUBSONIC_CUSTOM_CLIENTS="audio/mpeg>audio/mp3"

And then configure the 'bonob+audio/mpeg' player in your subsonic server.

Changing Icon colors

-e BNB_ICON_FOREGROUND_COLOR=white \
-e BNB_ICON_BACKGROUND_COLOR=darkgrey

-e BNB_ICON_FOREGROUND_COLOR=chartreuse \
-e BNB_ICON_BACKGROUND_COLOR=fuchsia

-e BNB_ICON_FOREGROUND_COLOR=lime \
-e BNB_ICON_BACKGROUND_COLOR=aliceblue

-e 'BNB_ICON_FOREGROUND_COLOR=#1db954' \
-e 'BNB_ICON_BACKGROUND_COLOR=#121212'

Notes on running bonob with various integrations

Running bonob and navidrome using docker-compose

version: "3"
services:
  navidrome:
    image: deluan/navidrome:latest
    user: 1000:1000 # should be owner of volumes
    ports:
      - "4533:4533"
    restart: unless-stopped
    environment:
      # Optional: put your config options customization here. Examples:
      ND_SCANSCHEDULE: 1h
      ND_LOGLEVEL: info  
      ND_SESSIONTIMEOUT: 24h
      ND_BASEURL: ""
    volumes:
      - "/tmp/navidrome/data:/data"
      - "/tmp/navidrome/music:/music:ro"
  bonob:
    image: simojenki/bonob:latest
    user: 1000:1000 # should be owner of volumes
    ports:
      - "4534:4534"
    restart: unless-stopped
    environment:
      BNB_PORT: 4534
      # ip address of your machine running bonob
      BNB_URL: http://192.168.1.111:4534  
      BNB_SECRET: changeme
      BNB_SUBSONIC_URL: http://navidrome:4533

Running bonob on synology

See this issue

Credits

• Icons courtesy of Navidrome, Vectornator, and @jicho
• Sonos S2 setup documentation and navidrome images courtesy of @wkulhanek
• Sonos S2 support courtest of everyone involved with issue 205