Official Go implementation of the Livepeer protocol
Clone or download
ericxtang Merge pull request #686 from livepeer/et/demo_script
Improve demo script to take in custom video url
Latest commit a2c3f51 Jan 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci PM: using assert lib in DB tests Dec 27, 2018
.github/ISSUE_TEMPLATE Update issue templates May 23, 2018
cmd discovery.go reorganization Jan 7, 2019
common adding testify to tests, edits to db and discovery Jan 7, 2019
core server: fix O sig check Jan 8, 2019
discovery adding cacheRegisteredTranscoders method Jan 9, 2019
doc doc: Various documentation updates. Dec 10, 2018
drivers memorystore: Return root-relative URLs. Jan 7, 2019
etc adding the transcoding test Jul 27, 2017
eth fix build: missing stubclient method Jan 4, 2019
ipfs Object Store implmentation Nov 8, 2018
monitor eth: update contract bindings Dec 27, 2018
net net: add TicketParams, Ticket and Payment messages Jan 3, 2019
pm pm & server: update TicketParams struct Jan 7, 2019
server server: fix O sig check Jan 8, 2019
vendor Update vendor go-ethereum to #77be57bc3b6275105a91ca4bee4d54d52f5ab1f9 Nov 6, 2018
.dockerignore run metrics sending code in separate go-routine Dec 18, 2018
.gitignore livepeer_cli: add TicketBroker deposit functionality Jan 4, 2019
Dockerfile Object Store implmentation Nov 8, 2018
LICENSE Initial commit Jun 19, 2017
Makefile proto: Move protobufs definitions into net. Aug 15, 2018
PULL_REQUEST_TEMPLATE.md Update PULL_REQUEST_TEMPLATE.md Dec 12, 2018
README.md doc: Various documentation updates. Dec 10, 2018
install.sh Use latest release Dec 19, 2017
install_ffmpeg.sh ffmpeg: Enable gnutls for HTTPS. Oct 26, 2018
test.sh PM: added pm folder to test script Dec 25, 2018
test_docker.sh circleci 2.0 config Jun 26, 2018
transcode_demo.sh improve demo script to take in custom video url Jan 16, 2019

README.md

Build Status Go Report Card Gitter

go-livepeer

Livepeer is a live video streaming network protocol that is fully decentralized, highly scalable, crypto token incentivized, and results in a solution which is cheaper to an app developer or broadcaster than using traditional centralized live video solutions. go-livepeer is a golang implementation of the protocol.

Building and running this node allows you to:

  • Create a local Livepeer Network, or join the existing Livepeer test network.
  • Broadcast a live stream into the network.
  • Request that your stream be transcoded into multiple formats.
  • Consume a live stream from the network.

For full documentation and a project overview, go to Livepeer Documentation or Livepeer Wiki

Installing Livepeer

Option 1: Download executables

The easiest way to install Livepeer is by downloading the livepeer and livepeer_cli executables from the release page on Github.

  1. Download the packages for your OS - darwin for Macs and linux for linux.
  2. Untar them and optionally move the executables to your PATH.

Option 2: Build from source

You can also build the executables from scratch.

  1. If you have never set up your Go programming environment, do so according to Go's Getting Started Guide.

  2. You can fetch the code running go get github.com/livepeer/go-livepeer/cmd/livepeer in terminal.

  3. You need to install ffmpeg as a dependency. Run ./install_ffmpeg.sh. This will install the dependencies in ~/compiled. You need to have pkg-config installed.

  4. You can now run PKG_CONFIG_PATH=~/compiled/lib/pkgconfig go build ./cmd/livepeer/livepeer.go from the project root directory. To get latest version, git pull from the project root directory.

  5. To run tests in locall run ./test.sh, to run in docker container run ./test_docker.sh

Running Livepeer

Quick start

  • Make sure you have successfully gone through the steps in 'Installing Livepeer' and 'Additional Dependencies'.

  • Run ./livepeer -rinkeby -currentManifest.

  • Run ./livepeer_cli.

    • You should see a wizard launch in the command line.
    • The wizard should print out Account Eth Addr, Token balance, and Eth balance
  • Get some test eth for the Rinkeby faucet. Make sure to use the Eth account address from above. Remember to add 0x as a prefix to address, if not present.

    • You can check that the request is successful by going to livepeer_cli and selecting Get node status. You should see a positive Eth balance.
  • Now get some test Livepeer tokens. Pick Get test Livepeer Token.

    • You can check that the request is successful by going to livepeer_cli and selecting Get node status. You should see your Token balance go up.
  • You should have some test Eth and test Livepeer tokens now. If that's the case, you are ready to broadcast.

Broadcasting

For full details, read the Broadcasting guide.

Sometimes you want to use third-party broadcasting software, especially if you are running the software on Windows or Linux. Livepeer can take any RTMP stream as input, so you can use other popular streaming software to create the video stream. We recommend OBS or ffmpeg.

By default, the RTMP port is 1935. For example, if you are using OSX with ffmpeg, run

ffmpeg -f avfoundation -framerate 30 -pixel_format uyvy422 -i "0:0" -vcodec libx264 -tune zerolatency -b 1000k -x264-params keyint=60:min-keyint=60 -acodec aac -ac 1 -b:a 96k -f flv rtmp://localhost:1935/movie

Similarly, you can use OBS, and change the Settings->Stream->URL to rtmp://localhost:1935/movie , along with the keyframe interval to 4 seconds, via Settings -> Output -> Output Mode (Advanced) -> Streaming tab -> Keyframe Interval 4.

If the broadcast is successful, you should be able to get a streamID by querying the local node's CLI API:

curl http://localhost:7935/manifestID

Streaming

You can use tools like ffplay or VLC to view the stream.

For example, after you get the streamID, you can view the stream by running:

ffplay http://localhost:8935/stream/current.m3u8

Note that the default HTTP port or playback (8935) is different from the CLI API port (7935) that is used for node management and diagnostics!

Using Amazon S3 for storing stream's data

You can use S3 to store source and transcoded data. For that livepeer should be run like this livepeer -s3bucket region/bucket -s3creds accessKey/accessKeySecret. Stream's data will be saved into directory MANIFESTID, where MANIFESTID - id of the manifest associated with stream. In this directory will be saved all the segments data, plus manifest, named MANIFESTID_full.m3u8. Livepeer node doesn't do any storage management, it only saves data and never deletes it.

Becoming an Orchestrator

We'll walk through the steps of becoming a transcoder on the test network. To learn more about the transcoder, refer to the Livepeer whitepaper and the Transcoding guide.

  • livepeer --rinkeby --transcoder to start the node as an orchestrator with an attached local transcoder .

  • livepeer_cli - make sure you have test ether and test Livepeer token. Refer to the Quick Start section for getting test ether and test tokens.

  • You should see the Transcoder Status as "Not Registered".

  • Pick "Become a transcoder" in the wizard. Make sure to choose "bond to yourself". Follow the rest of the prompts, including confirming the transcoder's public IP and port on the blockchain. If Successful, you should see the Transcoder Status change to "Registered"

  • Wait for the next round to start, and your transcoder will become active.

  • If running on Rinkeby or mainnet, ensure your orchestrator is publicly accessible in order to receive jobs from broadcasters. The only port that is required to be public is the one that was set during the transcoder registration step (default 8935).

Standalone Orchestrators

Orchestrators can be run in standalone mode without an attached transcoder. Standalone transcoders will need to connect to this orchestrator in order for the orchestrator to process jobs.

  • livepeer --rinkeby --orchestrator -orchSecret asdf

The orchSecret is a shared secret used to authenticate remote transcoders. It can be any arbitrary string.

Standalone Transcoders

A standalone transcoder can be run which connects to a remote orchestrator. The orchestrator will send transcoding tasks to this transcoder as segments come in.

  • livepeer -standaloneTranscoder -orchAddr 127.0.0.1:8935 -orchSecret asdf

Contribution

Thank you for your interest in contributing to the core software of Livepeer.

There are many ways to contribute to the Livepeer community. To see the project overview, head to our Wiki overview page. The best way to get started is to reach out to us directly via our discord channel.