Home

Awesome

<!-- *** Thanks for checking out this README Template. If you have a suggestion that would *** make this better, please fork the repo and create a pull request or simply open *** an issue with the tag "enhancement". *** Thanks again! Now go create something AMAZING! :D *** *** *** *** To avoid retyping too much info. Do a search and replace for the following: *** github_username, repo, twitter_handle, email --> <!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://github.com/filahf/budgie-stream"> <img src="images/logo.png" alt="Logo" width="160" height="160"> </a> <h3 align="center">Budgie Stream</h3> <p align="center"> Stream system output to your Sonos devices <br /> <a href="https://github.com/filahf/budgie-stream/releases"><strong>Download »</strong></a> <br /> <br /> <a href="#usage">Usage</a> · <a href="https://github.com/filahf/budgie-stream/issues">Report Bug</a> · <a href="https://github.com/filahf/budgie-stream/issues">Request Feature</a> </p> <p align="center"> <img src="https://img.shields.io/github/v/release/filahf/budgie-stream?style=flat-square" /> <img alt="GitHub All Releases" src="https://img.shields.io/github/downloads/filahf/budgie-stream/total?style=flat-square"> <img alt="GitHub issues" src="https://img.shields.io/github/issues/filahf/budgie-stream?style=flat-square"> <img alt="GitHub" src="https://img.shields.io/github/license/filahf/budgie-stream?style=flat-square"> </p> </p> <!-- TABLE OF CONTENTS -->

Table of Contents

<!-- ABOUT THE PROJECT -->

About The Project

Technology

<p align="center"> <img src="images/flowdiagram.png" alt="screenshot" height="300"> </p> The project is built using Electron/React/Express. The image above shows the simplified flow of audio data, from capture to playback on your Sonos device.

Capture

The project utilizes electrons desktopCapturer to capture raw audio. The stream of raw audio is captured in the format of 32 bit float.

Conversion

The server expects a stream of 16 bit signed integer. Hence the conversion before sending the stream to the server.

The stream is sent to the backend by IPC. Early versions of the software sent the stream via socket.io but the use of another package seemed redundant. I noticed no performance changes going from sockets to IPC.

Encode

The stream of 16 bit signed integers is encoded to mp3 with LAME. I had issues with the sample rate being inconsistent on different computers leading to a high/low pitched final result. To solve this I implemented an option to change the sample rate in the client.

Broadcast

The stream is now in the format of mp3 and ready for broadcast. The stream is linked to an endpoint served by express, the url of the endpoint is then sent by node-sonos to selected devices.

Built With

<!-- GETTING STARTED -->

Dev Environment

To get a local copy up and running follow these simple steps.

Installation

  1. Clone the repo
git clone https://github.com/filahf/budgie-stream.git
  1. Install NPM packages
cd budgie-stream/
yarn install
  1. Start
yarn start

Common Errors

<details> <summary>Node module was built with the wrong version</summary> Run electron rebuild 
$(npm bin)/electron-rebuild

Or if you're on Windows:

.\node_modules\.bin\electron-rebuild.cmd
</details> <!-- USAGE EXAMPLES -->

Usage

<p align="center"> <img src="images/screenshot.jpg" alt="screenshot" height="400"> </p>
  1. Download system corresponding package
  2. Install
  3. Make sure to allow Budgie Stream through the firewall
  4. Select devices and hit play!
<!-- CONTRIBUTING -->

Contributing

Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request
<!-- LICENSE -->

License

Distributed under the MIT License. See LICENSE for more information.

Support

<a href="https://www.buymeacoffee.com/budgie" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>

<!-- CONTACT -->

Contact

Feel free to contact me if you have any questions.

Filip Åhfelt - filipahfelt.se

Project Link: https://github.com/filahf/budgie-stream