linux_wheel.yaml

name: Linux CPU x86

on:
  pull_request:
  push:
    branches:
      - nightly
      - main
      - release/*
    tags:
        - v[0-9]+.[0-9]+.[0-9]+-rc[0-9]+
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref_name }}-${{ github.ref_type == 'branch' && github.sha }}-${{ github.event_name == 'workflow_dispatch' }}
  cancel-in-progress: true

permissions:
  id-token: write
  contents: write

defaults:
  run:
    shell: bash -l -eo pipefail {0}

jobs:

  generate-matrix:
    uses: pytorch/test-infra/.github/workflows/generate_binary_build_matrix.yml@main
    with:
      package-type: wheel
      os: linux
      test-infra-repository: pytorch/test-infra
      test-infra-ref: main
      with-xpu: disable
      with-rocm: disable
      with-cuda: disable
      build-python-only: "disable"

  build:
    needs: generate-matrix
    strategy:
      fail-fast: false
    name: Build and Upload wheel
    uses: pytorch/test-infra/.github/workflows/build_wheels_linux.yml@main
    with:
      repository: meta-pytorch/torchcodec
      ref: ""
      test-infra-repository: pytorch/test-infra
      test-infra-ref: main
      build-matrix: ${{ needs.generate-matrix.outputs.matrix }}
      pre-script: packaging/pre_build_script.sh
      post-script: packaging/post_build_script.sh
      smoke-test-script: packaging/fake_smoke_test.py
      package-name: torchcodec
      trigger-event: ${{ github.event_name }}
      build-platform: "python-build-package"
      build-command: "BUILD_AGAINST_ALL_FFMPEG_FROM_S3=1 python -m build --wheel -vvv --no-isolation"
      also-upload-to-gpu-arch-versions: "xpu"

  install-and-test:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10']
        ffmpeg-version-for-tests: ['4', '5', '6', '7', '8', '9']
    needs: build
    steps:
      - name: Check out repo
        uses: actions/checkout@v6

      - name: Remove src/ folder
        run: bash packaging/remove_src.sh

      - name: Setup conda env
        uses: conda-incubator/setup-miniconda@v3
        with:
          auto-update-conda: true
          # Using miniforge instead of miniconda ensures that the default
          # conda channel is conda-forge instead of main/default. This ensures
          # ABI consistency between dependencies:
          # https://conda-forge.org/docs/user/transitioning_from_defaults/
          miniforge-version: latest
          activate-environment: test
          python-version: ${{ matrix.python-version }}

      - name: Update pip
        run: python -m pip install --upgrade pip

      - name: Install PyTorch
        run: bash packaging/install_pytorch.sh cpu "torch torchvision"

      - uses: actions/download-artifact@v4
        with:
          name: meta-pytorch_torchcodec__${{ matrix.python-version }}_cpu_x86_64
          path: dist/

      - name: Install torchcodec from the wheel
        run: bash packaging/install_torchcodec_wheel.sh

      - name: Install ffmpeg, post build
        run: bash packaging/install_ffmpeg.sh ${{ matrix.ffmpeg-version-for-tests }}

      - name: Install test dependencies
        run: bash packaging/install_test_dependencies.sh ${{ matrix.ffmpeg-version-for-tests != '4' }}

      - name: Run Python tests
        run: |
          if [ "${{ matrix.ffmpeg-version-for-tests }}" = "4" ]; then export FAIL_WITHOUT_HEIC=0; fi
          python packaging/assert_ffmpeg_version.py ${{ matrix.ffmpeg-version-for-tests }}
          FAIL_WITHOUT_IMAGE_CODECS=1 pytest --override-ini="addopts=-v" test

  install-and-test-no-ffmpeg:
    # Asserts that torchcodec works WITHOUT FFmpeg installed: the package must
    # import, the FFmpeg-free image decoders must work, and the FFmpeg-backed
    # entry points must fail with a clear error.
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10']
    needs: build
    steps:
      - name: Check out repo
        uses: actions/checkout@v6

      - name: Remove src/ folder
        run: bash packaging/remove_src.sh

      - name: Setup conda env
        uses: conda-incubator/setup-miniconda@v3
        with:
          auto-update-conda: true
          miniforge-version: latest
          activate-environment: test
          python-version: ${{ matrix.python-version }}

      - name: Update pip
        run: python -m pip install --upgrade pip

      - name: Install PyTorch
        run: bash packaging/install_pytorch.sh cpu "torch torchvision"

      - uses: actions/download-artifact@v4
        with:
          name: meta-pytorch_torchcodec__${{ matrix.python-version }}_cpu_x86_64
          path: dist/

      - name: Install torchcodec from the wheel
        run: bash packaging/install_torchcodec_wheel.sh

      - name: Install test dependencies
        run: bash packaging/install_test_dependencies.sh

      # Deliberately NO "Install ffmpeg" step here.
      - name: Assert FFmpeg is absent and torchcodec still imports
        run: |
          source packaging/helpers.sh
          assert_ffmpeg_not_installed
          python -c "import torchcodec; from torchcodec._core import ops; assert not ops._FFMPEG_AVAILABLE, 'FFmpeg was unexpectedly loaded'; print('OK: torchcodec imported without FFmpeg')"

      - name: Run FFmpeg-free Python tests
        run: |
          FAIL_WITHOUT_IMAGE_CODECS=1 \
            pytest --override-ini="addopts=-v" test/test_ffmpeg_optional.py test/test_decoders.py::TestImageDecoder

  install-and-test-third-party-interface:
    runs-on: ubuntu-latest
    strategy:
      fail-fast: false
      matrix:
        python-version: ['3.10']
        ffmpeg-version-for-tests: ['9']
    needs: build
    steps:
      - name: Check out repo
        uses: actions/checkout@v3

      - name: Remove src/ folder
        run: bash packaging/remove_src.sh

      - name: Setup conda env
        uses: conda-incubator/setup-miniconda@v3
        with:
          auto-update-conda: true
          # Using miniforge instead of miniconda ensures that the default
          # conda channel is conda-forge instead of main/default. This ensures
          # ABI consistency between dependencies:
          # https://conda-forge.org/docs/user/transitioning_from_defaults/
          miniforge-version: latest
          activate-environment: test
          python-version: ${{ matrix.python-version }}

      - name: Update pip
        run: python -m pip install --upgrade pip

      - name: Install PyTorch
        run: bash packaging/install_pytorch.sh cpu "torch torchvision"

      - uses: actions/download-artifact@v4
        with:
          name: meta-pytorch_torchcodec__${{ matrix.python-version }}_cpu_x86_64
          path: dist/

      - name: Install torchcodec from the wheel
        run: bash packaging/install_torchcodec_wheel.sh

      - name: Install ffmpeg, post build
        run: bash packaging/install_ffmpeg.sh ${{ matrix.ffmpeg-version-for-tests }}

      - name: Install pkg-config
        run: |
          conda install pkg-config -c conda-forge

      - name: Install test dependencies
        run: bash packaging/install_test_dependencies.sh

      - name: Run Python tests
        run: |
          python packaging/assert_ffmpeg_version.py ${{ matrix.ffmpeg-version-for-tests }}
          pytest --override-ini="addopts=-v" test/third-party-interface