CelliesProjects/eStreamPlayer32_VS1053

An esp32 app to play web-radio or music files from a local lamp or llmp server. Needs a separate VS1053 decoder board. Compiles in the Arduino IDE.

eStreamPlayer32_VS1053

July 31 2023 - This project will not be continued as an Arduino IDE project.
Development will continue as a PlatformIO project at eStreamplayer32-vs1053-pio.

A web-based esp32 music player for webradio and mp3/ogg/aac/aac+ files from a lamp or llmp server. Sound output comes from a separate VS1053 mp3/aac/ogg/wav decoder breakout board. The web interface has radio-browser.info search integrated.

Supports http, https (insecure mode)/chunked streams.

Plays mp3, ogg, aac and aac+ streams.

What does it do?

• Play your local files (over http)
• Play preset radio stations
• Search for new radio stations on radio-browser.info and save these to favorites

You control the music player with a browser on your phone, pc or tablet.

Local file playback limitations

eStreamPlayer is written for playback over http(s). What this means is that you will need a (lamp or llmp) webserver to play back your local files.
This is because the esp32 does not speak NFS or SMB which are common ways to share files over a network. Instead eStreamPlayer uses a php script on the server to navigate the music folders. Copy this script to the server to use your music library.
This is totally insecure and should only be used on a LAN!

But if you don't have a local music server you can still use eStreamPlayer to tune in to web radio stations and add your own radio stations to presets and favorites.

Webinterface screenshots

File info overlay

LIBRARY tab

WEBRADIO tab

FAVORITES tab

Setup

Use the latest ESP32 Arduino Core version.

1. Download and install ESP_VS1053_Library, ESP32_VS1053_Stream, AsyncTCP and ESPAsyncWebServer in the Arduino libraries folder.
2. Download and unzip the latest eStreamPlayer release.
3. Copy the php script (found in the copy to server folder) to your music folder on the server.
4. Open eStreamPlayer_vs1053.ino in the Arduino IDE.
5. Select Tools->Partition Scheme->No OTA(2MB APP/2MB FATFS).
   If your board does not have that option you can select ESP32 Dev Module in Tools->Board.
6. Open system_setup.h and set your wifi credentials and set SCRIPT_URL to the php script location set in step #3.
   Set up LIBRARY_USER and LIBRARY_PWD if your local library requires login.
7. Flash the sketch to your esp32. Set Tools->Core Debug Level->Info before you flash so you can grab the ip address from the serial port.
8. On first boot or after a flash erase the fatfs has to be formatted. This will take a couple of seconds.
   You can monitor the boot/formatting progress on the serial port.
   Flashing an update will not erase the fatfs data.
   Note: Take care to select the same partition table when updating otherwise the partition will be formatted.
9. Browse to the ip address shown on the serial port.

Software needed

• ESP_VS1053_Library -> GNU General Public License v3.0
• ESP32_VS1053_Stream -> MIT license.
• AsyncTCP (LGPL-3.0 License)
• ESPAsyncWebServer (LGPL-3.0 License)
• A lamp or llmp webstack to serve local files. Apache2 and lighttpd were tested and should work. The php script should be fairly version agnostic.

Libraries used in the web interface

• The radio-browser.info API is used for the search. The returned data is in the public domain.
  See de1.api.radio-browser.info for API information.
• The used icons are from material.io and are available under Apache2.0 license.
• Reconnecting WebSocket which is available under MIT licence.
• Google Roboto font which is available under Apache2.0 license.
• jQuery 3.4.1 which is available under MIT license.

MIT License

Copyright (c) 2020 Cellie

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.