react-native-alpha-video 0.0.0-stage → 1.0.1

package/scripts/build_xcframework.sh

@@ -0,0 +1,49 @@
+#!/bin/bash
+# Builds the codec modules' binary targets in Package.swift, one xcframework per codec library:
+#   prebuilt/AlphaVideoLibvpx.xcframework   libvpx, for AlphaVideoVPX
+#   prebuilt/AlphaVideoDav1d.xcframework    dav1d, for AlphaVideoAV1
+# from the static libraries that build_codecs_ios.sh leaves in prebuilt/ios and
+# prebuilt/ios-simulator.
+#
+# Also writes a .zip of each and prints its SwiftPM checksum. Those zips are the files to attach
+# to the GitHub Release; Package.swift's checksums must match them byte for byte.
+
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "$0")/.." && pwd)"
+PREBUILT="$ROOT/prebuilt"
+WORK="$(mktemp -d)"
+trap 'rm -rf "$WORK"' EXIT
+
+# build_xcframework <name> <library> <header directory>
+build_xcframework() {
+    local name="$1" library="$2" headers="$3"
+    local out="$PREBUILT/$name.xcframework"
+    local args=()
+    mkdir -p "$WORK/$name/include"
+    cp -R "$PREBUILT/include/$headers" "$WORK/$name/include/"
+    for slice in ios ios-simulator; do
+        local lib="$PREBUILT/$slice/lib/lib$library.a"
+        if [ ! -f "$lib" ]; then
+            echo "Missing $lib: run scripts/build_codecs_ios.sh first" >&2
+            exit 1
+        fi
+        args+=(-library "$lib" -headers "$WORK/$name/include")
+    done
+
+    rm -rf "$out"
+    xcodebuild -create-xcframework "${args[@]}" -output "$out" >/dev/null
+
+    (
+        cd "$PREBUILT"
+        # Fixed times, so rebuilding from the same libraries gives the same zip and checksum.
+        find "$name.xcframework" -exec touch -h -t 202601010000 {} +
+        rm -f "$name.xcframework.zip"
+        find "$name.xcframework" | LC_ALL=C sort | zip -q -X -D -9 "$name.xcframework.zip" -@
+        echo "Wrote $out and $out.zip"
+        echo "  checksum: $(swift package compute-checksum "$name.xcframework.zip")"
+    )
+}
+
+build_xcframework AlphaVideoLibvpx vpx vpx
+build_xcframework AlphaVideoDav1d dav1d dav1d

package/scripts/fetch-prebuilt.sh

@@ -0,0 +1,48 @@
+#!/bin/bash
+#
+# fetch-prebuilt.sh [--force]
+#
+# Downloads the prebuilt libvpx + dav1d static libraries into prebuilt/ from this repo's GitHub
+# Release. A git clone needs them to build; the npm package already contains them. To build them
+# from source instead, run build_codecs_android.sh and build_codecs_ios.sh.
+#
+# Leaves an existing prebuilt/ alone unless --force is given.
+#
+
+set -euo pipefail
+
+RELEASE="v1.0.0"
+ARCHIVE="prebuilt-libvpx1.14.0-dav1d1.5.1.tar.gz"
+SHA256="b95e75aed9a75c41f92388a31cb3e1e311ab44f81d02140c4fbf5e570865195e"
+URL="https://github.com/MediaCacheDev/alpha-video/releases/download/$RELEASE/$ARCHIVE"
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+PREBUILT="$ROOT/prebuilt"
+
+sha256() {
+    if command -v sha256sum > /dev/null; then
+        sha256sum "$1" | cut -d' ' -f1
+    else
+        shasum -a 256 "$1" | cut -d' ' -f1
+    fi
+}
+
+if [ "${1:-}" != "--force" ] && [ -d "$PREBUILT/android" ] && [ -d "$PREBUILT/ios/lib" ]; then
+    echo "prebuilt/ is already there (--force replaces it)"
+    exit 0
+fi
+
+TMP="$(mktemp -d)"
+trap 'rm -rf "$TMP"' EXIT
+
+echo "⬇️  $URL"
+curl -fL --retry 3 -o "$TMP/$ARCHIVE" "$URL"
+ACTUAL="$(sha256 "$TMP/$ARCHIVE")"
+if [ "$ACTUAL" != "$SHA256" ]; then
+    echo "❌ Checksum mismatch for $ARCHIVE: expected $SHA256, got $ACTUAL" >&2
+    exit 1
+fi
+
+rm -rf "$PREBUILT/android" "$PREBUILT/ios" "$PREBUILT/ios-simulator" "$PREBUILT/include"
+tar -xzf "$TMP/$ARCHIVE" -C "$ROOT"
+echo "✅ prebuilt/ (libvpx 1.14.0, dav1d 1.5.1)"

package/scripts/package_release.sh

@@ -0,0 +1,107 @@
+#!/bin/bash
+#
+# package_release.sh
+#
+# Collects the GitHub Release assets for v<version> (package.json) in dist/release-v<version>/:
+#
+#   prebuilt-libvpx<V>-dav1d<D>.tar.gz    prebuilt/ for Android and iOS, what fetch-prebuilt.sh unpacks
+#   AlphaVideoLibvpx.xcframework.zip      Package.swift's binary targets, as built by
+#   AlphaVideoDav1d.xcframework.zip       build_xcframework.sh
+#   alpha-video-<version>-ios.zip         the CocoaPods source (alpha-video.podspec): the iOS sources,
+#                                         the codec modules, libwebm's parser, range-source's
+#                                         headers and both xcframeworks
+#   SHA256SUMS
+#
+# Uploads nothing. Afterwards, fetch-prebuilt.sh's SHA256 must be the prebuilt archive's,
+# alpha-video.podspec's sha256 the pod zip's, and Package.swift's checksums the xcframework zips';
+# the script stops or warns when they differ.
+#
+
+set -euo pipefail
+
+ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+LIBVPX_VERSION="1.14.0"
+DAV1D_VERSION="1.5.1"
+
+VERSION="$(node -p "require('$ROOT/package.json').version")"
+OUT="$ROOT/dist/release-v$VERSION"
+PREBUILT_ARCHIVE="prebuilt-libvpx$LIBVPX_VERSION-dav1d$DAV1D_VERSION.tar.gz"
+
+sha256() {
+    shasum -a 256 "$1" | cut -d' ' -f1
+}
+
+for dir in android ios/lib ios-simulator/lib include; do
+    if [ ! -d "$ROOT/prebuilt/$dir" ]; then
+        echo "❌ prebuilt/$dir is missing: run the build_codecs_*.sh scripts" >&2
+        exit 1
+    fi
+done
+XCFRAMEWORKS="AlphaVideoLibvpx AlphaVideoDav1d"
+for name in $XCFRAMEWORKS; do
+    ZIP="$ROOT/prebuilt/$name.xcframework.zip"
+    if [ ! -f "$ZIP" ]; then
+        echo "❌ $ZIP is missing: run scripts/build_xcframework.sh" >&2
+        exit 1
+    fi
+    if ! grep -q "codecLibrary(\"$name\", checksum: \"$(sha256 "$ZIP")\")" "$ROOT/Package.swift"; then
+        echo "❌ Package.swift's checksum for $name is not $name.xcframework.zip's ($(sha256 "$ZIP"))" >&2
+        exit 1
+    fi
+done
+
+rm -rf "$OUT"
+mkdir -p "$OUT"
+
+# The archive carries the notices, since it is a copy of the libraries on its own.
+STAGE="$(mktemp -d)"
+trap 'rm -rf "$STAGE"' EXIT
+mkdir -p "$STAGE/prebuilt/ios" "$STAGE/prebuilt/ios-simulator"
+cp -R "$ROOT/prebuilt/android" "$ROOT/prebuilt/include" "$STAGE/prebuilt/"
+cp -R "$ROOT/prebuilt/ios/lib" "$STAGE/prebuilt/ios/"
+cp -R "$ROOT/prebuilt/ios-simulator/lib" "$STAGE/prebuilt/ios-simulator/"
+cp "$ROOT/THIRD_PARTY_NOTICES.md" "$STAGE/prebuilt/"
+cp -R "$ROOT/licenses" "$STAGE/prebuilt/"
+find "$STAGE" -name .DS_Store -delete
+# Reproducible, so packaging the same libraries again keeps fetch-prebuilt.sh's checksum valid:
+# fixed times, sorted entries, no owners or macOS metadata, no gzip timestamp.
+find "$STAGE/prebuilt" -exec touch -h -t 202601010000 {} +
+(cd "$STAGE" && find prebuilt | LC_ALL=C sort) \
+    | COPYFILE_DISABLE=1 tar -c -n -T - -C "$STAGE" --no-mac-metadata \
+        --uid 0 --gid 0 --uname "" --gname "" -f - \
+    | gzip -n -9 > "$OUT/$PREBUILT_ARCHIVE"
+
+# The CocoaPods source: prebuilt/ isn't in git, so the pod downloads the sources and the codecs
+# together. Reproducible in the same way, for alpha-video.podspec's sha256.
+POD="$STAGE/pod"
+mkdir -p "$POD/cpp" "$POD/ios/Sources" "$POD/third_party"
+cp "$ROOT"/cpp/*.h "$ROOT"/cpp/*.cpp "$POD/cpp/"
+rm "$POD/cpp/WebMAlphaPlayer_jni.cpp"
+cp -R "$ROOT/ios/Sources/AlphaVideo" "$ROOT/ios/Sources/AlphaVideoVPX" "$ROOT/ios/Sources/AlphaVideoAV1" "$POD/ios/Sources/"
+cp -R "$ROOT/codecs" "$POD/"
+cp -R "$ROOT/third_party/libwebm" "$ROOT/third_party/range-source" "$POD/third_party/"
+for name in $XCFRAMEWORKS; do
+    cp -R "$ROOT/prebuilt/$name.xcframework" "$POD/"
+done
+cp -R "$ROOT/LICENSE" "$ROOT/THIRD_PARTY_NOTICES.md" "$ROOT/licenses" "$POD/"
+find "$POD" -name .DS_Store -delete
+find "$POD" -exec touch -h -t 202601010000 {} +
+POD_ZIP="alpha-video-$VERSION-ios.zip"
+(cd "$POD" && find . -mindepth 1 | sed 's#^\./##' | LC_ALL=C sort | zip -q -X -D -9 "$OUT/$POD_ZIP" -@)
+
+for name in $XCFRAMEWORKS; do
+    cp "$ROOT/prebuilt/$name.xcframework.zip" "$OUT/"
+done
+
+(cd "$OUT" && shasum -a 256 -- * > SHA256SUMS)
+echo "📦 $OUT"
+sed 's/^/   /' "$OUT/SHA256SUMS"
+
+PREBUILT_SHA256="$(sha256 "$OUT/$PREBUILT_ARCHIVE")"
+if ! grep -q "^SHA256=\"$PREBUILT_SHA256\"" "$ROOT/scripts/fetch-prebuilt.sh"; then
+    echo "⚠️  Set SHA256=\"$PREBUILT_SHA256\" in scripts/fetch-prebuilt.sh before uploading"
+fi
+POD_SHA256="$(sha256 "$OUT/$POD_ZIP")"
+if ! grep -q ":sha256 => '$POD_SHA256'" "$ROOT/alpha-video.podspec"; then
+    echo "⚠️  Set :sha256 => '$POD_SHA256' in alpha-video.podspec before uploading"
+fi

package/scripts/publish-android.sh

@@ -0,0 +1,85 @@
+#!/bin/bash
+#
+# publish-android.sh [local|central]
+#
+# Builds the standalone Android library in android/ and publishes it as
+# dev.mediacache:alpha-video:<version>, the version in android/build.gradle, with the codec
+# modules alpha-video-vpx (android/vpx, libvpx) and alpha-video-av1 (android/av1, dav1d). Needs
+# libvpx and dav1d in prebuilt/android (build_codecs_android.sh, or fetch-prebuilt.sh).
+# dev.mediacache:range-source, which the player depends on, comes from Maven Central.
+#
+#   local    publishToMavenLocal (~/.m2), unsigned unless a key is set. The default.
+#   central  signs, bundles and uploads to the Maven Central Portal. Needs:
+#              ORG_GRADLE_PROJECT_mavenCentralUsername / …Password   Central Portal user token
+#              ORG_GRADLE_PROJECT_signingInMemoryKey                 armored secret key
+#              ORG_GRADLE_PROJECT_signingInMemoryKeyPassword
+#              ORG_GRADLE_PROJECT_signingInMemoryKeyId               optional
+#            The deployment waits in the portal for you to press Publish, unless
+#            PUBLISHING_TYPE=AUTOMATIC.
+#
+
+set -euo pipefail
+
+ROOT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
+GRADLE_DIR="$ROOT_DIR/android"
+MODE="${1:-local}"
+VERSION="$(sed -n "s/^version = '\(.*\)'/\1/p" "$GRADLE_DIR/build.gradle")"
+GRADLE=("$GRADLE_DIR/gradlew" -p "$GRADLE_DIR" -q)
+
+if [ -z "$VERSION" ]; then
+    echo "❌ No version = '…' line in android/build.gradle"
+    exit 1
+fi
+if [ ! -d "$ROOT_DIR/prebuilt/android" ]; then
+    echo "❌ prebuilt/android is missing: run scripts/build_codecs_android.sh"
+    exit 1
+fi
+
+case "$MODE" in
+    local)
+        "${GRADLE[@]}" publishToMavenLocal
+        echo "✅ dev.mediacache:alpha-video, -vpx and -av1 $VERSION in ~/.m2/repository"
+        ;;
+    central)
+        for var in ORG_GRADLE_PROJECT_mavenCentralUsername ORG_GRADLE_PROJECT_mavenCentralPassword \
+                   ORG_GRADLE_PROJECT_signingInMemoryKey ORG_GRADLE_PROJECT_signingInMemoryKeyPassword; do
+            if [ -z "${!var:-}" ]; then
+                echo "❌ $var is not set"
+                exit 1
+            fi
+        done
+
+        STAGING="$GRADLE_DIR/build/staging-repo"
+        rm -rf "$STAGING"
+        "${GRADLE[@]}" publishReleasePublicationToStagingRepository
+
+        VERSION_DIRS=()
+        for artifact in alpha-video alpha-video-vpx alpha-video-av1; do
+            VERSION_DIRS+=("dev/mediacache/$artifact/$VERSION")
+        done
+        for dir in "${VERSION_DIRS[@]}"; do
+            if ! ls "$STAGING/$dir"/*.aar.asc > /dev/null 2>&1; then
+                echo "❌ $dir was not signed"
+                exit 1
+            fi
+        done
+
+        BUNDLE="$GRADLE_DIR/build/alpha-video-$VERSION-bundle.zip"
+        rm -f "$BUNDLE"
+        (cd "$STAGING" && zip -qr "$BUNDLE" "${VERSION_DIRS[@]}")
+        echo "📦 $BUNDLE"
+        unzip -l "$BUNDLE" | awk 'NR > 3 { print "   " $4 }' | sed '/^   $/d'
+
+        TOKEN="$(printf '%s:%s' "$ORG_GRADLE_PROJECT_mavenCentralUsername" "$ORG_GRADLE_PROJECT_mavenCentralPassword" | base64 | tr -d "\n")"
+        DEPLOYMENT_ID="$(curl --fail-with-body -sS \
+            -H "Authorization: Bearer $TOKEN" \
+            -F "bundle=@$BUNDLE" \
+            "https://central.sonatype.com/api/v1/publisher/upload?name=alpha-video-$VERSION&publishingType=${PUBLISHING_TYPE:-USER_MANAGED}")"
+        echo "⬆️  Uploaded, deployment $DEPLOYMENT_ID"
+        echo "   Watch https://central.sonatype.com/publishing/deployments"
+        ;;
+    *)
+        echo "Usage: $0 [local|central]"
+        exit 1
+        ;;
+esac

package/scripts/vendor_range_source.sh

@@ -0,0 +1,47 @@
+#!/bin/bash
+# Copies range-source's native headers (its C interface, and the basic input) from a range-source
+# checkout into third_party/range-source, and records its commit there. The add-on itself is a
+# dependency (dev.mediacache:range-source, the RangeSource SwiftPM product, the range-source pod).
+#
+#   scripts/vendor_range_source.sh [path to range-source]
+#
+# Without a path it looks for a checkout beside this repository, or one folder further up.
+set -euo pipefail
+
+PROJECT_DIR="$(cd "$(dirname "$0")/.." && pwd)"
+if [ $# -ge 1 ]; then
+    SOURCE_DIR="$1"
+else
+    SOURCE_DIR=""
+    for candidate in "$PROJECT_DIR/../range-source" "$PROJECT_DIR/../../range-source"; do
+        if [ -d "$candidate/native/include" ]; then SOURCE_DIR="$candidate"; break; fi
+    done
+fi
+if [ -z "$SOURCE_DIR" ] || [ ! -d "$SOURCE_DIR/native/include" ]; then
+    echo "No range-source checkout found${SOURCE_DIR:+ at $SOURCE_DIR}; pass its path." >&2
+    exit 1
+fi
+SOURCE_DIR="$(cd "$SOURCE_DIR" && pwd)"
+DEST="$PROJECT_DIR/third_party/range-source"
+
+COMMIT="$(git -C "$SOURCE_DIR" rev-parse HEAD)"
+if [ -n "$(git -C "$SOURCE_DIR" status --porcelain -- native/include)" ]; then
+    COMMIT="$COMMIT, with uncommitted changes"
+fi
+
+rm -rf "$DEST/include" "$DEST/src"
+mkdir -p "$DEST/include"
+cp "$SOURCE_DIR"/native/include/*.h "$DEST/include/"
+cp "$SOURCE_DIR/LICENSE" "$DEST/LICENSE"
+
+cat > "$DEST/README.md" <<EOF
+# range-source (native)
+
+\`include/\` is \`native/include\` from [range-source](https://github.com/MediaCacheDev/range-source), unmodified, at commit \`$COMMIT\`. MIT, by the same author as this repository.
+
+- \`include/range_source.h\` is the add-on's C interface, a table of functions, with a C++ wrapper over it. The player finds the add-on at runtime and reads URLs and data sources through it (\`cpp/RangeSourceClient.h\`).
+- \`include/range_source_download.h\` is the basic input, for when the add-on isn't there: a URL downloaded whole into a temporary file, read as it arrives.
+
+To update, run \`scripts/vendor_range_source.sh\` against a newer checkout. Its tests live in that repository (\`native/test\`).
+EOF
+echo "Vendored range-source's headers at $COMMIT"

package/third_party/libwebm/AUTHORS.TXT

@@ -0,0 +1,5 @@
+# Names should be added to this file like so:
+# Name or Organization <email address>
+
+Google Inc.
+Elijah Cirioli <eli.cirioli@gmail.com>

package/third_party/libwebm/LICENSE.TXT

@@ -0,0 +1,30 @@
+Copyright (c) 2010, Google Inc. 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 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
+HOLDER 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/third_party/libwebm/PATENTS.TXT

@@ -0,0 +1,23 @@
+Additional IP Rights Grant (Patents)
+------------------------------------
+
+"These implementations" means the copyrightable works that implement the WebM
+codecs distributed by Google as part of the WebM Project.
+
+Google hereby grants to you a perpetual, worldwide, non-exclusive, no-charge,
+royalty-free, irrevocable (except as stated in this section) patent license to
+make, have made, use, offer to sell, sell, import, transfer, and otherwise
+run, modify and propagate the contents of these implementations of WebM, where
+such license applies only to those patent claims, both currently owned by
+Google and acquired in the future, licensable by Google that are necessarily
+infringed by these implementations of WebM. This grant does not include claims
+that would be infringed only as a consequence of further modification of these
+implementations. If you or your agent or exclusive licensee institute or order
+or agree to the institution of patent litigation or any other patent
+enforcement activity against any entity (including a cross-claim or
+counterclaim in a lawsuit) alleging that any of these implementations of WebM
+or any code incorporated within any of these implementations of WebM
+constitute direct or contributory patent infringement, or inducement of
+patent infringement, then any patent rights granted to you under this License
+for these implementations of WebM shall terminate as of the date such
+litigation is filed.

package/third_party/libwebm/README.md

@@ -0,0 +1,7 @@
+# libwebm's WebM parser
+
+`webm_parser/` is `webm_parser/include` and `webm_parser/src` from [libwebm](https://chromium.googlesource.com/webm/libwebm), unmodified, at commit `6184f4484a826724b5293837134ab9492261b941` (21 April 2026). BSD licence: `LICENSE.TXT`, with the patent grant in `PATENTS.TXT`.
+
+The C++ core's demuxer (`cpp/AlphaDemuxer.cpp`) reads WebM with it on Android and iOS. Its sources compile with the core's, with `webm_parser/` and `webm_parser/include` on the include path.
+
+To update, copy the two directories from a newer libwebm checkout and change the commit above.

package/third_party/libwebm/webm_parser/include/webm/buffer_reader.h

@@ -0,0 +1,138 @@
+// Copyright (c) 2016 The WebM project authors. All Rights Reserved.
+//
+// Use of this source code is governed by a BSD-style license
+// that can be found in the LICENSE file in the root of the source
+// tree. An additional intellectual property rights grant can be found
+// in the file PATENTS.  All contributing project authors may
+// be found in the AUTHORS file in the root of the source tree.
+#ifndef INCLUDE_WEBM_BUFFER_READER_H_
+#define INCLUDE_WEBM_BUFFER_READER_H_
+
+#include <cstddef>
+#include <cstdint>
+#include <initializer_list>
+#include <vector>
+
+#include "./reader.h"
+#include "./status.h"
+
+/**
+ \file
+ A `Reader` implementation that reads from a `std::vector<std::uint8_t>`.
+ */
+
+namespace webm {
+
+/**
+ \addtogroup PUBLIC_API
+ @{
+ */
+
+/**
+ A simple reader that reads data from a buffer of bytes.
+ */
+class BufferReader : public Reader {
+ public:
+  /**
+   Constructs a new, empty reader.
+   */
+  BufferReader() = default;
+
+  /**
+   Constructs a new reader by copying the provided reader into the new reader.
+
+   \param other The source reader to copy.
+   */
+  BufferReader(const BufferReader& other) = default;
+
+  /**
+   Copies the provided reader into this reader.
+
+   \param other The source reader to copy. May be equal to `*this`, in which
+   case this is a no-op.
+   \return `*this`.
+   */
+  BufferReader& operator=(const BufferReader& other) = default;
+
+  /**
+   Constructs a new reader by moving the provided reader into the new reader.
+
+   \param other The source reader to move. After moving, it will be reset to an
+   empty stream.
+   */
+  BufferReader(BufferReader&&);
+
+  /**
+   Moves the provided reader into this reader.
+
+   \param other The source reader to move. After moving, it will be reset to an
+   empty stream. May be equal to `*this`, in which case this is a no-op.
+   \return `*this`.
+   */
+  BufferReader& operator=(BufferReader&&);
+
+  /**
+   Creates a new `BufferReader` populated with the provided bytes.
+
+   \param bytes Bytes that are assigned to the internal buffer and used as the
+   source which is read from.
+   */
+  BufferReader(std::initializer_list<std::uint8_t> bytes);
+
+  /**
+   Creates a new `BufferReader` populated with the provided data.
+
+   \param vector A vector of bytes that is copied to the internal buffer and
+   used as the source which is read from.
+   */
+  explicit BufferReader(const std::vector<std::uint8_t>& vector);
+
+  /**
+   Creates a new `BufferReader` populated with the provided data.
+
+   \param vector A vector of bytes that is moved to the internal buffer and used
+   as the source which is read from.
+   */
+  explicit BufferReader(std::vector<std::uint8_t>&& vector);
+
+  /**
+   Resets the reader to read from the given list of bytes, starting at the
+   beginning.
+
+   This makes `reader = {1, 2, 3};` effectively equivalent to `reader =
+   BufferReader({1, 2, 3});`.
+
+   \param bytes Bytes that are assigned to the internal buffer and used as the
+   source which is read from.
+   \return `*this`.
+   */
+  BufferReader& operator=(std::initializer_list<std::uint8_t> bytes);
+
+  Status Read(std::size_t num_to_read, std::uint8_t* buffer,
+              std::uint64_t* num_actually_read) override;
+
+  Status Skip(std::uint64_t num_to_skip,
+              std::uint64_t* num_actually_skipped) override;
+
+  std::uint64_t Position() const override;
+
+  /**
+   Gets the total size of the buffer.
+   */
+  std::size_t size() const { return data_.size(); }
+
+ private:
+  // Stores the byte buffer from which data is read.
+  std::vector<std::uint8_t> data_;
+
+  // The position of the reader in the byte buffer.
+  std::size_t pos_ = 0;
+};
+
+/**
+ @}
+ */
+
+}  // namespace webm
+
+#endif  // INCLUDE_WEBM_BUFFER_READER_H_