shaka-packager 2.4.2 → 3.0.0

package/LICENSE

@@ -0,0 +1,59 @@
+Copyright 2014, Google LLC. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+    * Redistributions of source code must retain the above copyright
+notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above
+copyright notice, this list of conditions and the following disclaimer
+in the documentation and/or other materials provided with the
+distribution.
+    * Neither the name of Google LLC. nor the names of its
+contributors may be used to endorse or promote products derived from
+this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+------------------------------------------------------------------------
+
+*** LICENSE addendum from the Chromium-LICENSE file. ***
+
+// Copyright 2014 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google LLC. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,110 @@
+[comment]: # (While not ideal, absolute URLs are used here as it is the        )
+[comment]: # (simplest way to make the links work on GitHub and Docker Hub.    )
+[comment]: # (These links in cloned repositories will point back to the main   )
+[comment]: # (repository and if it is an issue, we suggest updating the links  )
+[comment]: # (in the cloned repository.                                        )
+[comment]: # (See https://github.com/shaka-project/shaka-packager/issues/408 for the  )
+[comment]: # (full background.                                                 )
+
+![Shaka Packager](https://raw.githubusercontent.com/shaka-project/shaka-packager/main/docs/shaka-packager.png)
+
+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/)¹
+  - [Marlin](https://www.intertrust.com/marlin-drm/)¹
+- 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     |       -      |      -      |       -      |
+  |       AV1         |    I / O     |    I / O     |       -      |      -      |       -      |
+  |       AAC         |    I / O     |      -       |     I / O    |      I      |       O      |
+  |       MP3         |      O       |      -       |     I / O    |      -      |       O      |
+  |    Dolby AC3      |    I / O     |      -       |     I / O    |      -      |       O      |
+  |    Dolby EAC3     |    I / O     |      -       |       O      |      -      |       O      |
+  |   MPEG-H Audio    |    I / O     |      -       |       -      |      -      |       -      |
+  |    Dolby AC4      |    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
+
+  |     Format    |  Input   | Output |
+  |:-------------:|:--------:|:------:|
+  |  Text WebVTT  |    Y     |    Y   |
+  | WebVTT in MP4 | [#405][] |    Y   |
+  |   Text TTML   |    ⁴     |    Y   |
+  |  TTML in MP4  |    -     |    Y   |
+  |    DVB-SUB    |    Y     |    -   |
+  |   Teletext    | [#272][] |    -   |
+
+  - ⁴: TTML input is only supported with TTML output (pass-through, DASH only),
+    see also [#584][].
+
+[#272]: https://github.com/shaka-project/shaka-packager/issues/272
+[#405]: https://github.com/shaka-project/shaka-packager/issues/405
+[#584]: https://github.com/shaka-project/shaka-packager/issues/584
+
+- 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/shaka-project/shaka-packager/blob/main/docs/source/docker_instructions.md).
+- Get prebuilt binaries from
+  [release](https://github.com/shaka-project/shaka-packager/releases).
+- Built from source, see
+  [Build Instructions](https://github.com/shaka-project/shaka-packager/blob/main/docs/source/build_instructions.md)
+  for details.
+
+# Useful Links
+
+- [Announcement List](https://groups.google.com/forum/#!forum/shaka-packager-users)
+  (join for infrequent announcements and surveys)
+- Subscribe to releases by following
+  [instructions from this blog](https://www.jessesquires.com/blog/2020/07/30/github-tip-watching-releases/)- [Documentation](https://shaka-project.github.io/shaka-packager/html/)
+- [Tutorials](https://shaka-project.github.io/shaka-packager/html/tutorials/tutorials.html)
+- Several open source players:
+  - [DASH and HLS on Web: Shaka Player](https://github.com/shaka-project/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/shaka-project/shaka-packager/blob/main/CONTRIBUTING.md for
+details.

package/index.js

@@ -4,15 +4,31 @@
 var path = require('path');
 var spawnSync = require('child_process').spawnSync;
 
-// Command names per-platform:
+// Command names per-platform (process.platform) and per-architecture
+// (process.arch):
 var commandNames = {
-  linux: 'packager-linux',
-  darwin: 'packager-osx',
-  win32: 'packager-win.exe',
+  linux: {
+    'x64': 'packager-linux-x64',
+    'arm64': 'packager-linux-arm64',
+  },
+  darwin: {
+    'x64': 'packager-osx-x64',
+  },
+  win32: {
+    'x64': 'packager-win-x64.exe',
+  },
 };
 
 // Find the platform-specific binary:
-var binaryPath = path.resolve(__dirname, 'bin', commandNames[process.platform]);
+if (!(process.platform in commandNames)) {
+  throw new Error('Platform not supported: ' + process.platform);
+}
+if (!(process.arch in commandNames[process.platform])) {
+  throw new Error(
+      'Architecture not supported: ' + process.platform + '/' + process.arch);
+}
+var commandName = commandNames[process.platform][process.arch];
+var binaryPath = path.resolve(__dirname, 'bin', commandName);
 
 // Find the args to pass to that binary:
 // argv[0] is node itself, and argv[1] is the script.
@@ -20,7 +36,7 @@ var binaryPath = path.resolve(__dirname, 'bin', commandNames[process.platform]);
 var args = process.argv.slice(2);
 
 var options = {
-  detached: false,  // Do not let the child process continue without us
+  detached: false,   // Do not let the child process continue without us
   stdio: 'inherit',  // Pass stdin/stdout/stderr straight through
 };
 

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "shaka-packager",
   "description": "A media packaging tool and SDK.",
-  "version": "2.4.2",
-  "homepage": "https://github.com/google/shaka-packager",
+  "version": "3.0.0",
+  "private": false,
+  "homepage": "https://github.com/shaka-project/shaka-packager",
   "author": "Google",
   "maintainers": [
     {
-      "name": "Kongqun Yang",
-      "email": "kqyang@google.com"
+      "name": "Joey Parrish",
+      "email": "joeyparrish@google.com"
     }
   ],
   "main": "index.js",
   "repository": {
     "type": "git",
-    "url": "https://github.com/google/shaka-packager.git"
+    "url": "https://github.com/shaka-project/shaka-packager.git"
   },
   "bugs": {
-    "url": "https://github.com/google/shaka-packager/issues"
+    "url": "https://github.com/shaka-project/shaka-packager/issues"
   },
   "license": "See LICENSE",
   "scripts": {

package/prepublish.js

@@ -5,25 +5,37 @@ var fs = require('fs');
 var path = require('path');
 var spawnSync = require('child_process').spawnSync;
 
-// Command names per-platform:
+// Command names per-platform (process.platform) and per-architecture
+// (process.arch):
 var commandNames = {
-  linux: 'packager-linux',
-  darwin: 'packager-osx',
-  win32: 'packager-win.exe',
+  linux: {
+    'x64': 'packager-linux-x64',
+    'arm64': 'packager-linux-arm64',
+  },
+  darwin: {
+    'x64': 'packager-osx-x64',
+  },
+  win32: {
+    'x64': 'packager-win-x64.exe',
+  },
 };
 
 // Get the current package version:
 var package = require(path.resolve(__dirname, 'package.json'));
 console.log('Preparing Shaka Packager v' + package.version);
 
+// Calculate the repo name.  In GitHub Actions context, this will pull binaries
+// correctly from a fork.  When run by hand, it will default to the official
+// repo.
+var repo = process.env.GITHUB_REPOSITORY || 'shaka-project/shaka-packager';
+
 // For fetching binaries from GitHub:
-var urlBase =
-    'https://github.com/google/shaka-packager/releases/download/v' +
+var urlBase = 'https://github.com/' + repo + '/releases/download/v' +
     package.version + '/';
 
 // For spawning curl subprocesses:
 var options = {
-  detached: false,  // Do not let the child process continue without us
+  detached: false,   // Do not let the child process continue without us
   stdio: 'inherit',  // Pass stdin/stdout/stderr straight through
 };
 
@@ -40,26 +52,56 @@ fs.readdirSync(binFolderPath).forEach(function(childName) {
 });
 
 for (var platform in commandNames) {
-  // Find the destination for this binary:
-  var command = commandNames[platform];
-  var binaryPath = path.resolve(binFolderPath, command);
+  for (var arch in commandNames[platform]) {
+    // Find the destination for this binary:
+    var command = commandNames[platform][arch];
+    var binaryPath = path.resolve(binFolderPath, command);
+
+    try {
+      download(urlBase + command, binaryPath);
+      fs.chmodSync(binaryPath, 0755);
+    } catch (error) {
+      if (arch == 'arm64') {
+        // Optional.  Forks may not have arm64 builds available.  Ignore.
+      } else {
+        // Required.  Re-throw and fail.
+        throw error;
+      }
+    }
+  }
+}
+
+// Fetch LICENSE and README files from the same tag, and include them in the
+// package.
+var licenseUrl = 'https://raw.githubusercontent.com/' + repo + '/' +
+    'v' + package.version + '/LICENSE';
+download(licenseUrl, 'LICENSE');
+
+var readmeUrl = 'https://raw.githubusercontent.com/' + repo + '/' +
+    'v' + package.version + '/README.md';
+download(readmeUrl, 'README.md');
 
+console.log('Done!');
+
+
+// Generic download helper
+function download(url, outputPath) {
   // Curl args:
   var args = [
     '-L',  // follow redirects
-    '-o', binaryPath,  // output destination
-    '--silent', '--show-error',  // show errors, but no progress bar
-    urlBase + command,  // URL
+    '-f',  // fail if the request fails
+    // output destination:
+    '-o',
+    outputPath,
+    '--show-error',  // show errors
+    '--silent',      // but no progress bar
+    url,
   ];
 
   // Now fetch the binary and fail the script if that fails:
-  console.log('Downloading', command);
+  console.log('Downloading', url, 'to', outputPath);
   var returnValue = spawnSync('curl', args, options);
-  if (returnValue.error) {
-    process.exit(returnValue.error.code);
+  if (returnValue.status != 0) {
+    throw new Error('Download of ' + url + ' failed: ' + returnValue.status);
   }
-
-  fs.chmodSync(binaryPath, 0755);
 }
-
-console.log('Done!');