README.md

P2P Media Loader

P2P Media Loader is an open-source JavaScript library that uses features of modern web browsers (i.e. HTML5 video and WebRTC) to deliver media over P2P and do playback via integrations with many popular HTML5 video players. It doesn’t require any web browser plugins or add-ons to function.

It allows creating Peer-to-Peer network (also called P2P CDN or P2PTV) for traffic sharing between users (peers) that are watching the same media stream live or VOD over HLS or MPEG-DASH protocols.

It significantly reduces traditional CDN traffic and cost while delivering media streams to more users.

Related projects

• wt-tracker - high-performance WebTorrent tracker
• WebTorrent - streaming torrent client for the web https://webtorrent.io

Useful links

• P2P development, support & consulting
• Demo
• FAQ
• Overview
• Technical overview
• API documentation
  • Hls.js integration
  • Shaka Player integration
  • Core
• JS CDN
  • Core
  • Hls.js integration
  • Shaka Player integration
• npm packages
  • Core
  • Hls.js integration
  • Shaka Player integration

Key features

• Supports live and VOD streams over HLS or MPEG-DASH protocols
• Supports multiple HTML5 video players and engines:
  • Engines: Hls.js, Shaka Player
  • Video players: JWPlayer, Clappr, Flowplayer, MediaElement, VideoJS
• Supports adaptive bitrate streaming of HLS and MPEG-DASH protocols
• No need in server-side software. By default P2P Media Loader uses publicly available servers:
  • STUN servers - Public STUN server list
  • WebTorrent trackers - https://openwebtorrent.com/

Key components of the P2P network

All the components of the P2P network are free and open-source.

P2P Media Loader web browser requirements are:

• WebRTC Data Channels support to exchange data between peers
• Media Source Extensions are required by Hls.js and Shaka Player engines for media playback

STUN server is used by WebRTC to gather ICE candidates. There are many running public servers available on Public STUN server list.

WebTorrent tracker is used for WebRTC signaling and to create swarms of peers that download the same media stream. Few running public trackers are available: https://openwebtorrent.com/. It is possible to run personal WebTorrent tracker using open-source implementations: bittorrent-tracker, uWebTorrentTracker.

P2P Media Loader is configured to use public STUN and WebTorrent servers by default. It means that it is not required to run any server-side software for the P2P network to function.

How it works

A web browser runs a video player integrated with P2P Media Loader library. An instance of P2P Media Loader is called peer. Many peers form the P2P network.

P2P Media Loader starts to download initial media segments over HTTP(S) from source server or CDN. This allows beginning media playback faster. Also, in case of no peers, it will continue to download segments over HTTP(S) that will not differ from traditional media stream download over HTTP.

After that P2P Media Loader sends media stream details and its connection details (ICE candidates) to WebTorrent trackers and obtains from them list of other peers that are downloading the same media stream.

P2P Media Loader connects and starts to download media segments from the obtained peers as well as sharing already downloaded segments to them.

From time to time random peers from the P2P swarm download new segments over HTTP(S) and share them to others over P2P.

Limitations

Only one media track is delivered over P2P. If video and audio tracks in HLS or MPEG-DASH go separately, just video is going to be shared over the P2P network.

Web browsers support

	Chrome	Firefox	macOS Safari	iOS Safari	IE	Edge
WebRTC Data Channels	+	+	+	+	-	-
Media Source Extensions	+	+	+	-	+	+
P2P Media Loader	+	+	+	-	-	-