search

coffeegreg / YTuner

YTuner is a simple project designed to replace vTuner internet radio service and dedicated to all users of AVRs made by Yamaha, Denon, Onkyo, Marantz and others with built-in vTuner support.
MIT License
25 stars 2 forks source link
avr denon grundig marantz noxon onkyo radiosetup vtuner yamaha

readme

AVR

"Everything should be made as simple as possible, but not simpler" - Albert Einstein.

YTuner

YTuner is a simple project inspired by YCast but rewritten from scratch and greatly improved. Designed to replace vTuner internet radio service and dedicated to all users of AVRs made by Yamaha, Denon, Onkyo, Marantz, Grundig and others with built-in vTuner support. If you own one (or even more) of the vTuner-enabled AVRs mentioned above and want to enjoy free internet radio stations on your device as before, and be sure that your device's streaming service won't suddenly end, you should consider using YTuner.

Why

YCast is a great project, but my goal was to run a similar service on a very low-spec platform where python along with packages turned out to be too heavy and too slow. Now, with YTuner you can enjoy improved functionality at full speed of ultra lightweight native app on operating systems such as:

and with selected CPU architecture:

or any others powered by cross-build abilities of Free Pascal Compiler.

Features

YTuner supports :

YTuner also has build in :

Supported devices

Theoretically, YTuner should work with most AVRs that support vTuner.
Now, the list of supported and tested devices below is short, but I hope it will expand with your help.

Please test YTuner with your AVR and give me your feedback.

Confirmed working

Installation

YTuner is a standalone application and in most cases it does not require additional services, frameworks, packages, virtual machines, libraries or tools to run properly (except optional OpenSSL and/or SQLite3 libraries). You can download from Releases a file specific to your operating system and CPU architecture or build YTuner from source (look at Build section).

After download (or build) save and extract files into prepared directory with granted read/write/execute privileges. Remember that the credentials who will run YTuner must also have permission to open TCP port 80 and optionally UDP 53 (note below).

Now, you should have directory with some of the following subdirectories and files :

-- ytuner
 |-- config (subdir for config files) 
   |-- stations.ini  (if you want to use a ini file with your favorite radio stations) 
   |-- stations.yaml (if you want to use a yaml/yml file with your favorite radio stations)
   |-- avr.ini (common configuration file for all your AVRs)
   |-- bookmark.xml (common bookmark file for all your AVRs - only if one of your AVR support bookmark)
   |-- ...... (AVRs dedicated bookmark and config files)
 |-- cache (subdir for cache files)
   |-- rbuuids.txt (Radio browser UUIDs cache file)
   |-- ...... (other cache files)
 |-- db (subdir for databse cache file)
   |-- rb.db (Radio browser database cache file)
 |-- ytuner (or ytuner.exe for Windows)
 |-- ytuner.ini (YTuner important config file)

Do not forget to add execute privileges to ytuner on linux/*nix systems with a command like chmod +x ytuner.

OpenSSL (optional)

If you want to use SSL to support YTuner HTTPS web request you have to get OpenSSL libraries.

and place them in your ytuner directory or anywhere in your system PATH. Make sure your system has valid CA certificates.

Tip: The YTuner should work with LibreSSL libraries as well.

SQLite3 (optional)

If you want to forget about potential connection problems with Radio-browser.info while using YTuner and listening to your favorite stations, use one of the options [catDB, catMemDB, catPermMemDB] of the RBCacheType parameter in the ytuner.ini file to download the full contents of the Radio-browser.info resources once and store it in your local SQLite3 database. Of course, only data that is useful for YTuner and AVR devices is downloaded and stored locally. Due to the use of the very popular SQLite database, YTuner will need to use the library provided by the SQLite development team.

! Important ! : Minimal version of SQLite library is 3.33.0 (2020-08-14)

Tip: If you faced problems with the SQLite library, read this description.

Configuration

Your YTuner machine and AVR(s) have to have internet access. Make sure your firewall is properly configured if necessary.

AVR

Set all DNS servers on your AVR config to your YTuner machine IP address.

Router

Make sure that your YTuner machine is assigned a static IPv4 address.

YTuner Web Service

Regardless of what operating system you use, you need to make sure that TCP port 80 is not being used by another application. YTuner has a built-in multi-threaded web server that listens on TCP port 80 so you don't have to worry about its configuration and performance.

Tip: In some special cases, it may be necessary to change the default TCP port 80 to another. You can do this by editing the YTuner ini file. See Application configuration section below.

YTuner DNS Service

YTuner has a built-in multi-threaded DNS proxy server that listens on UDP port 53. This feature is optional and you can simple disable it and/or configure by editing configuration .ini file ytuner.ini (See Application configuration section below). You can also use your favorite DNS server like dnsmasq.
*Most important is to point *.vtuner.com domain to you YTuner machine and set all DNS servers on your AVR config to your YTuner machine IP address.*

Tip: In some special cases, it may be necessary to change the default UDP port 53 to another. You can do this by editing the YTuner ini file. See Application configuration section below.

YTuner Maintenance Service

YTuner has a built-in maintenance service for diagnostic and future goals. At this moment you can use it to shut down YTuner service only.

Tip: In most cases, you will not need this functionality. See Application configuration section below.

Application configuration

YTuner is configured by simple ytuner.ini file.
This file has the following capabilities: https://github.com/coffeegreg/YTuner/blob/96570772b7632e678cf2ae61387a0d43208801b4/cfg/ytuner.ini#L1-L165

YTuner's filtering and sorting functionality can be oriented by AVR device. You can decide about it with CommonAVRini setting of ytuner.ini. Common AVR config file avr.ini or other AVRs dedicated config files have the following capabilities: https://github.com/coffeegreg/YTuner/blob/273e48b94f4c1b3bd33077905ae1f4fa8ca3ee95/cfg/example-avr.ini#L1-L78

Please read the descriptions in both .ini files carefully.

Custom stations

You can enable support for the stations list local file. Two types of files are supported:

[Category two name] Station three name=http://url-of-station-three|http://url-of-station-three-logo Station four name=http://url-of-station-four|http://url-of-station-four-logo

* .yaml / .yml file :

Category one name: Station one name: http://url-of-station-one|http://url-of-station-one-logo Station two name: http://url-of-station-two|http://url-of-station-two-logo

Category two name: Station three name: http://url-of-station-three|http://url-of-station-three-logo Station four name: http://url-of-station-four|http://url-of-station-four-logo

YTuner can convert and resize on the fly logo image from JPEG, PNG, GIFF and TIFF (optionaly) to JPEG (default) or PNG format. 
>Tip: URLs with logo station images are optional.

### Bookmark
What is the `Bookmark` ? `Bookmark` is what is mentioned in the AVR user's manual. `Bookmark` is operated only from the AVR device using the remote control. When you listen to a new station you can decide to put it into the `Bookmark` or want to remove it from it. All stations added in this way are visible in the `Bookmark` submenu of the AVR receiver.

If you AVR support `Bookmark` you can enable and use this YTuner functionality.
You can configure YTuner to use one common bookmark file (`bookmark.xml`) for all your AVR devices (if you have more then one) or each AVR will own its own bookmark file. 
See [Application configuration](README.md#application-configuration) section above.

## Running the application
### Windows
Simply execute `ytuner.exe`. 

### Linux / Unix (Solaris, BSD) / macOS
If you credentials meet all requirements mentioned above just go to your ytuner directory and start application or simple use `sudo` to execute application:

$ sudo ./ytuner


### Docker container
If you are not familiar with building Docker containers you can read [this](doc/DOCKER.md).

## Build
You can use [CodeTyphon Studio](https://www.pilotlogic.com) or [Lazarus Free Pascal RAD IDE](https://www.lazarus-ide.org/) to build YTuner.  
Use the latest versions of these IDE. Relevant project files are included.

### Dependencies
YTuner uses [Indy - Internet Direct](https://github.com/IndySockets/Indy) library to build its own binary files. Of course, YTuner binaries no longer need any additional libraries beyond the optional OpenSSL and/or SQLite3.
>Important: Use the latest version of Indy library to build YTuner.

## Summary
If you found this project useful, please star it. ⭐

## License
YTuner is licensed under MIT license.
See the [license.txt](LICENSE.txt) file for more details.