zvidlib 0.5.0

Frame-accurate video and audio I/O for native and WebAssembly applications
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

name: Docs

on:
  push:
    branches: [main]
  pull_request:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: pages-${{ github.ref }}
  cancel-in-progress: false

jobs:
  build:
    name: Build site and rustdoc
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Install Rust toolchain
        run: rustup show
      # This job rebuilt every dependency from a cold `target/` on every run
      # before this step existed (#352). The cache is keyed on the job, the
      # runner, the toolchain and the manifest, so the `[profile.bench]`
      # fat-LTO artifacts and the `[profile.dev]` ones never share an entry;
      # `cache-on-failure` keeps a failed run's dependency build, since the
      # dependencies are not what failed.
      - name: Cache cargo registry and build artifacts
        uses: Swatinem/rust-cache@v2
        with:
          cache-on-failure: true
      - name: Install native audio dependencies
        timeout-minutes: 15
        run: python3 .github/scripts/apt_install.py libasound2-dev
      # Every workspace crate, not only `zvidlib`: its pages inline the
      # subcrates' items, and `-D warnings` is what keeps their intra-doc links
      # from rotting in the crates docs.rs documents on their own (#604).
      - name: Build API documentation
        run: cargo doc --workspace --no-deps --features native
        env:
          RUSTDOCFLAGS: -D warnings
      # The landing page's live demo runs on the browser package, so the site
      # is built from the same commit as the API documentation (#651). The
      # published musl binary, pinned as in the CI and release workflows.
      - name: Install wasm-pack
        env:
          WASM_PACK_VERSION: '0.15.0'
        run: |
          target="wasm-pack-v${WASM_PACK_VERSION}-x86_64-unknown-linux-musl"
          mkdir -p "$RUNNER_TEMP/wasm-pack"
          curl -sSfL "https://github.com/rustwasm/wasm-pack/releases/download/v${WASM_PACK_VERSION}/${target}.tar.gz"             | tar -xz --strip-components=1 -C "$RUNNER_TEMP/wasm-pack" "${target}/wasm-pack"
          "$RUNNER_TEMP/wasm-pack/wasm-pack" --version
          echo "$RUNNER_TEMP/wasm-pack" >> "$GITHUB_PATH"
      - name: Build browser package for the site
        run: wasm-pack build --target web --out-dir site/pkg --features web
      # One Pages artifact: the landing site at the root, and rustdoc's output
      # beside it, so existing links to `/zvidlib/...` keep working. `/api/`
      # is a shorter name for the same documentation. Rustdoc writes no root
      # `index.html` and none of the site's `assets/`, `media/` or `pkg/`, so
      # neither tree overwrites the other.
      - name: Assemble the site
        run: |
          set -euo pipefail
          mkdir -p _site
          cp -R target/doc/. _site/
          cp -R site/. _site/
          rm -f _site/.gitignore _site/pkg/.gitignore _site/pkg/README.md
          mkdir -p _site/media _site/api
          cp examples/media/BigBuckBunny.av1.mp4 _site/media/
          echo '<!doctype html><meta charset="utf-8"><meta http-equiv="refresh" content="0; url=../zvidlib/index.html"><link rel="canonical" href="../zvidlib/index.html"><a href="../zvidlib/index.html">zvidlib API documentation</a>' > _site/api/index.html
          for required in index.html zvidlib/index.html pkg/zvidlib.js pkg/zvidlib_bg.wasm media/BigBuckBunny.av1.mp4; do
            test -f "_site/$required" || { echo "::error::_site/$required is missing"; exit 1; }
          done
          du -sh _site
      - uses: actions/upload-pages-artifact@v3
        with:
          path: _site

  deploy:
    name: Deploy to GitHub Pages
    needs: build
    if: github.event_name == 'push'
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4