shaka-packager/README.md

<!--
  While not ideal, absolute URLs are used here as it is the simplest way to make
  the links work on GitHub and Docker Hub. These links in cloned repositories
  will point back to the main repository and if it is an issue, we suggest
  updating the links in the cloned repository.

  See https://github.com/google/shaka-packager/issues/408 for the full
  background.
-->

![Shaka Packager](https://raw.githubusercontent.com/google/shaka-packager/master/docs/shaka-packager.png)

[![Build Status](https://travis-ci.org/google/shaka-packager.svg?branch=master)](https://travis-ci.org/google/shaka-packager)
[![Build status](https://ci.appveyor.com/api/projects/status/3t8iu603rp25sa74?svg=true)](https://ci.appveyor.com/project/shaka/shaka-packager)

Shaka Packager is a tool and a media packaging SDK for
[DASH](http://dashif.org/) and [HLS](https://developer.apple.com/streaming/)
packaging and encryption. It can prepare and package media content for online
streaming.

Shaka Packager supports:

- Both Video-On-Demand and Live.
- Streaming formats:
  - [DASH](http://dashif.org/)
  - [HLS](https://developer.apple.com/streaming/)
- Key systems:
  - [Widevine](http://www.widevine.com/)
  - [PlayReady](https://www.microsoft.com/playready/)¹
  - [FairPlay](https://developer.apple.com/streaming/fps/)¹
- Encryption standards:
  - [CENC](https://en.wikipedia.org/wiki/MPEG_Common_Encryption)
  - [SAMPLE-AES](https://developer.apple.com/library/content/documentation/AudioVideo/Conceptual/HLS_Sample_Encryption/Intro/Intro.html)
- Media Containers and codecs

  |      Codecs       |   ISO-BMFF   |     WebM     |   MPEG2-TS   |     WVM     | Packed Audio²|
  |:-----------------:|:------------:|:------------:|:------------:|:-----------:|:------------:|
  |    H264 (AVC)     |    I / O     |      -       |     I / O    |      I      |       -      |
  |    H265 (HEVC)    |    I / O     |      -       |       I      |      -      |       -      |
  |       VP8         |    I / O     |    I / O     |       -      |      -      |       -      |
  |       VP9         |    I / O     |    I / O     |       -      |      -      |       -      |
  |       AAC         |    I / O     |      -       |     I / O    |      I      |       O      |
  |  Dolby AC3/EAC3   |    I / O     |      -       |       I      |      -      |       O      |
  |       DTS         |    I / O     |      -       |       -      |      -      |       -      |
  |       FLAC        |    I / O     |      -       |       -      |      -      |       -      |
  |       Opus        |    I / O³    |    I / O     |       -      |      -      |       -      |
  |      Vorbis       |      -       |    I / O     |       -      |      -      |       -      |

  NOTES:
  - I for input and O for output.
  - ²: https://tools.ietf.org/html/draft-pantos-http-live-streaming-23#section-3.4
  - ³: Opus support in ISO-BMFF is experimental.
- Subtitles
  - WebVTT in both text form and embedded in MP4
  - TTML in text form (DASH only)
- Platforms
  - Linux
  - Mac
  - Windows
  - Cross compiling for ARM is also supported.

<sup>1: Limited support</sup>

# Getting Shaka Packager

There are several ways you can get Shaka Packager.

- Using [Docker](https://www.docker.com/whatisdocker).
  Instructions are available
  [here](https://github.com/google/shaka-packager/blob/master/docs/source/docker_instructions.md).
- Get prebuilt binaries from
  [release](https://github.com/google/shaka-packager/releases).
- Built from source, see
  [Build Instructions](https://github.com/google/shaka-packager/blob/master/docs/source/build_instructions.md)
  for details.

# Useful Links

- [Announcement List](https://groups.google.com/forum/#!forum/shaka-packager-users)
  (join for release announcements and surveys)
- [Documentation](https://google.github.io/shaka-packager/html/)
- [Tutorials](https://google.github.io/shaka-packager/html/tutorials/tutorials.html)
- Several open source players:
  - [DASH and HLS on Web: Shaka Player](https://github.com/google/shaka-player)
  - [DASH on Web: dash.js](https://github.com/Dash-Industry-Forum/dash.js)
  - [HLS on Web: hls.js](https://github.com/video-dev/hls.js)
  - [DASH and HLS on Android: ExoPlayer](https://github.com/google/ExoPlayer)

# Contributing

If you have improvements or fixes, we would love to have your contributions.
See https://github.com/google/shaka-packager/blob/master/CONTRIBUTING.md for
details.