plaincast

command module
v0.0.0-...-9a8916e Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 14, 2020 License: BSD-2-Clause Imports: 2 Imported by: 0

README

Plaincast

This is a small DIAL server that emulates Chromecast-like devices, and implements the YouTube app. It only renders the audio, not the video, so it is very lightweight and can run headless.

It can be used as media server, for example on the Raspberry Pi.

Installation

I'm going to assume you're running Linux for this installation guide, preferably Debian Jessie (or newer when their time comes). Debian before Jessie contains too old versions of certain packages.

First, make sure you have the needed dependencies installed:

  • golang 1.3 (1.1+ might also work, but 1.0 certainly doesn't)
  • libmpv-dev
  • pip3
  • pytube (see 'notes on pytube' below)

These can be installed in one go under Debian Jessie:

$ sudo apt-get install golang libmpv-dev python3-pip

If you haven't already set up a Go workspace, create one now. Some people like to set it to their home directory, but you can also set it to a separate directory. In any case, set the environment variable $GOROOT to this path:

$ mkdir golang
$ cd golang
$ export GOPATH="`pwd`"

Then get the required packages and compile:

$ go get -u github.com/aykevl/plaincast

To run the server, you can run the executable bin/plaincast relative to your Go workspace.

$ bin/plaincast [OPTIONS]

or install it as service

$ cd src/github.com/aykevl/plaincast
$ make install

If you want to remove service $ make remove

Any browser that supports chromecast extension and Android phone with YouTube app (or possibly iPhone, but I haven't tested) on the same network should recognize the server and it should be possible to play the audio of videos on it.

Manual service installation

Copy compiled binary file plaincast to /usr/local/bin/ and create new user plaincast in group audio

$ useradd -s /bin/false -r -M plaincast -g audio

Create directory

$ mkdir -p /var/local/plaincast
$ chown plaincast:audio /var/local/plaincast

Copy systemd unit file plaincast.service to /etc/systemd/system/ and enable the service

$ systemctl enable plaincast

Options

-h, -help	    	Prints help text and exit
-ao-pcm		    	Write audio to a file, 48kHz stereo format S16
-app		    	Name of the app to run on startup, no need to use 
    	            	as currently is supported only YouTube	
-cachedir	    	Cache directory location for youtube-dl
-config		    	Location of the configuration file, path to to config
    	            	(default location ~/.config/plaincast.json)
-friendly-name  	Custom friendly name (default "Plaincast HOSTNAME")	
-http-port	    	Custom http port (default 8008)
-log-libmpv	    	Log output of libmpv
-log-mpv	    	Log MPV wrapper output
-log-player	    	Log media player messages
-log-server	    	Log HTTP and SSDP server
-log-youtube    	Log YouTube app
-loglevel	    	Baseline loglevel (info, warn, err) (default "warn")
-no-config	    	Disable reading from and writing to config file
-no-sspd	    	Disable SSDP server
Snapcast support

You can easily write audio output to snapcast pipe using option

-ao-pcm PATH-TO-SNAPFIFO

Notes on pytube

Because of youtube_dl beeing awfully slow at fetching stream urls on my raspberry pi 2 I opted for this alternative approach, which works much faster on this low power platform.

I tried using python 2 but had no success with it. To install most recent pytube version use pip3!

$ python3 -m pip install git+https://github.com/nficano/pytube

It is advisable to run this regularly as it has to keep up with YouTube updates. Certainly first try updating pytube when plaincast stops working.

Thanks

I would like to thank the creators of leapcast. Leapcast is a Chromecast emulator, which was essential in the process of reverse-engineering the YouTube protocol and better understanding the DIAL protocol.

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL