pipewire-gobject 0.3.1__tar.gz

pipewire_gobject-0.3.1/.dockerignore

@@ -0,0 +1,17 @@
+.git
+.agents
+.pytest_cache
+.ruff_cache
+__pycache__/
+*.py[cod]
+
+build/
+build-*/
+dist/
+install-root/
+meson-logs/
+meson-private/
+
+*.so
+*.typelib
+*.gir

pipewire_gobject-0.3.1/.github/ISSUE_TEMPLATE/api_proposal.yml

@@ -0,0 +1,54 @@
+name: API Proposal
+description: Propose a new public Pwg API or a change to existing behavior.
+title: "api: "
+labels:
+  - api
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Public API is unstable in 0.x, but proposals should preserve the project boundary: safe GI PipeWire application APIs for discovery, metadata, params, app-owned modules, and app-owned streams, without raw PipeWire ownership or WirePlumber session-management policy.
+  - type: textarea
+    id: use_case
+    attributes:
+      label: Use case
+      description: What application workflow needs this API?
+    validations:
+      required: true
+  - type: textarea
+    id: proposed_api
+    attributes:
+      label: Proposed API shape
+      description: Function, property, signal, or type names if you have them.
+      render: c
+    validations:
+      required: false
+  - type: dropdown
+    id: consumers
+    attributes:
+      label: Primary GI consumers
+      multiple: true
+      options:
+        - Python/PyGObject
+        - GJS
+        - Vala
+        - C
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: boundary
+    attributes:
+      label: Boundary with WirePlumber
+      description: Why does this belong in Pwg as generic PipeWire application API instead of WirePlumber session-management or policy API?
+    validations:
+      required: true
+  - type: checkboxes
+    id: safety
+    attributes:
+      label: Safety expectations
+      options:
+        - label: This does not expose raw pw_stream, pw_buffer, spa_buffer, or spa_pod ownership to GI consumers.
+          required: true
+        - label: This does not add routing policy or session-manager behavior.
+          required: true

pipewire_gobject-0.3.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,58 @@
+name: Bug Report
+description: Report a crash, build problem, binding issue, or unexpected behavior.
+title: "bug: "
+labels:
+  - bug
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for reporting a bug. This project is experimental; please include enough environment detail to reproduce the issue.
+  - type: input
+    id: version
+    attributes:
+      label: pipewire-gobject version or commit
+      placeholder: "0.1.0 or git commit"
+    validations:
+      required: true
+  - type: input
+    id: pipewire_version
+    attributes:
+      label: PipeWire version
+      placeholder: "pkg-config --modversion libpipewire-0.3"
+    validations:
+      required: true
+  - type: dropdown
+    id: language
+    attributes:
+      label: Consumer language
+      options:
+        - C
+        - Python/PyGObject
+        - GJS
+        - Vala
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: problem
+    attributes:
+      label: Problem
+      description: What happened, and what did you expect?
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: Reproducer
+      description: Minimal code, commands, or steps that reproduce the issue.
+      render: shell
+    validations:
+      required: true
+  - type: textarea
+    id: logs
+    attributes:
+      label: Logs
+      description: Meson logs, Python traceback, PipeWire log, or relevant terminal output.
+      render: text
+

pipewire_gobject-0.3.1/.github/ISSUE_TEMPLATE/community_feedback.yml

@@ -0,0 +1,41 @@
+name: Community Scope Feedback
+description: Discuss project scope, WirePlumber overlap, or upstream placement.
+title: "scope: "
+labels:
+  - scope
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This template is for feedback on the project boundary: standalone Pwg project, WirePlumber extension, PipeWire companion library, or another shape.
+  - type: dropdown
+    id: perspective
+    attributes:
+      label: Perspective
+      options:
+        - PipeWire user
+        - WirePlumber user
+        - Application developer
+        - Distribution/package maintainer
+        - PipeWire/WirePlumber contributor
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: feedback
+    attributes:
+      label: Feedback
+      description: What boundary or project organization would you prefer, and why?
+    validations:
+      required: true
+  - type: textarea
+    id: concerns
+    attributes:
+      label: Concerns
+      description: API overlap, maintenance, packaging, stability, or ecosystem concerns.
+  - type: textarea
+    id: alternatives
+    attributes:
+      label: Alternatives
+      description: Existing APIs or project homes that should be considered.
+

pipewire_gobject-0.3.1/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,2 @@
+blank_issues_enabled: true
+

pipewire_gobject-0.3.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,21 @@
+## Summary
+
+Describe the change and the application workflow or maintenance problem it
+addresses.
+
+## Scope
+
+- [ ] This keeps the public API GI-friendly and GObject-native.
+- [ ] This does not expose raw PipeWire or SPA ownership to language bindings.
+- [ ] This does not add WirePlumber session-management or routing policy.
+- [ ] Public API/ABI changes are intentional and documented.
+
+## Validation
+
+List the checks you ran, or explain why they were not run.
+
+```text
+meson test -C build --print-errorlogs
+meson compile -C build docs
+ruff check .
+```

pipewire_gobject-0.3.1/.github/dependabot.yml

@@ -0,0 +1,11 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    groups:
+      github-actions:
+        patterns:
+          - "*"
+

pipewire_gobject-0.3.1/.github/workflows/ci.yml

@@ -0,0 +1,372 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+  schedule:
+    - cron: "17 4 * * 1"
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  changes:
+    name: Change detection
+    runs-on: ubuntu-latest
+    outputs:
+      run_build: ${{ steps.detect.outputs.run_build }}
+      run_docs: ${{ steps.detect.outputs.run_docs }}
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Detect build-relevant changes
+        id: detect
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          run_build=true
+          event="${{ github.event_name }}"
+
+          if [ "$event" = "pull_request" ]; then
+            base="${{ github.event.pull_request.base.sha }}"
+            head="${{ github.sha }}"
+            run_build=false
+            run_docs=false
+          elif [ "$event" = "push" ]; then
+            base="${{ github.event.before }}"
+            head="${{ github.sha }}"
+            if [[ "$base" =~ ^0+$ ]]; then
+              run_build=true
+              run_docs=true
+            else
+              run_build=false
+              run_docs=false
+            fi
+          else
+            base=""
+            head=""
+            run_build=true
+            run_docs=true
+          fi
+
+          if [ -n "$base" ] && [ "$run_build" = "false" ]; then
+            git diff --name-only "$base" "$head" > changed-files.txt
+            cat changed-files.txt
+
+            while IFS= read -r path; do
+              case "$path" in
+                src/*|tests/*|examples/*|python/*|meson.build|meson_options.txt|pyproject.toml|Dockerfile|.dockerignore|ruff.toml|.github/workflows/ci.yml)
+                  run_build=true
+                  run_docs=true
+                  ;;
+                docs/*)
+                  run_docs=true
+                  ;;
+              esac
+            done < changed-files.txt
+          fi
+
+          echo "run_build=$run_build" >> "$GITHUB_OUTPUT"
+          echo "run_docs=$run_docs" >> "$GITHUB_OUTPUT"
+          echo "run_build=$run_build"
+          echo "run_docs=$run_docs"
+
+  python-lint:
+    name: Python lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Install Ruff
+        run: |
+          python3 -m venv /tmp/ruff
+          /tmp/ruff/bin/pip install --upgrade pip
+          /tmp/ruff/bin/pip install ruff==0.15.12
+
+      - name: Ruff
+        run: /tmp/ruff/bin/ruff check .
+
+  api-docs:
+    name: API docs
+    needs: changes
+    runs-on: ubuntu-latest
+    container: debian:trixie-slim
+    env:
+      RUN_DOCS: ${{ needs.changes.outputs.run_docs }}
+
+    steps:
+      - name: Skip notice
+        if: env.RUN_DOCS != 'true'
+        run: echo "No API-doc-relevant files changed; API docs check is satisfied."
+
+      - name: Install dependencies
+        if: env.RUN_DOCS == 'true'
+        env:
+          DEBIAN_FRONTEND: noninteractive
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends \
+            build-essential \
+            ca-certificates \
+            gi-docgen \
+            git \
+            meson \
+            ninja-build \
+            pkg-config \
+            libglib2.0-dev \
+            libpipewire-0.3-dev \
+            gobject-introspection \
+            libgirepository1.0-dev \
+            python3-gi
+
+      - uses: actions/checkout@v6
+        if: env.RUN_DOCS == 'true'
+
+      - name: Build API docs
+        if: env.RUN_DOCS == 'true'
+        run: |
+          meson setup build
+          meson compile -C build docs
+
+  distro:
+    name: Debian packaged PipeWire
+    needs: changes
+    runs-on: ubuntu-latest
+    container: debian:trixie-slim
+    env:
+      RUN_BUILD: ${{ needs.changes.outputs.run_build }}
+
+    steps:
+      - name: Skip notice
+        if: env.RUN_BUILD != 'true'
+        run: echo "No build-relevant files changed; Debian packaged PipeWire check is satisfied."
+
+      - name: Install dependencies
+        if: env.RUN_BUILD == 'true'
+        env:
+          DEBIAN_FRONTEND: noninteractive
+        run: |
+          apt-get update
+          apt-get install -y --no-install-recommends \
+            build-essential \
+            ca-certificates \
+            gi-docgen \
+            git \
+            meson \
+            ninja-build \
+            pkg-config \
+            libglib2.0-dev \
+            libpipewire-0.3-dev \
+            gobject-introspection \
+            libgirepository1.0-dev \
+            python3-gi \
+            python3-pip \
+            python3-venv \
+            dbus \
+            pipewire \
+            libspa-0.2-modules \
+            wireplumber
+
+      - uses: actions/checkout@v6
+        if: env.RUN_BUILD == 'true'
+
+      - name: Build
+        if: env.RUN_BUILD == 'true'
+        run: |
+          meson setup build
+          meson compile -C build
+
+      - name: Test
+        if: env.RUN_BUILD == 'true'
+        run: meson test -C build --print-errorlogs
+
+      - name: Strict runtime warning check
+        if: env.RUN_BUILD == 'true'
+        env:
+          G_DEBUG: fatal-warnings,fatal-criticals
+          G_SLICE: debug-blocks
+        run: meson test -C build --print-errorlogs
+
+      - name: Sanitizer check
+        if: env.RUN_BUILD == 'true'
+        run: |
+          meson setup build-sanitize -Db_sanitize=address,undefined -Db_lundef=false
+          meson compile -C build-sanitize
+
+          asan="$(gcc -print-file-name=libasan.so)"
+          ubsan="$(gcc -print-file-name=libubsan.so)"
+          preload="$asan:$ubsan${LD_PRELOAD:+:$LD_PRELOAD}"
+          sanitizer_wrapper="env LD_PRELOAD=$preload ASAN_OPTIONS=detect_leaks=0:halt_on_error=1:abort_on_error=1:print_summary=1 UBSAN_OPTIONS=halt_on_error=1:abort_on_error=1:print_summary=1:print_stacktrace=1"
+
+          meson test -C build-sanitize --print-errorlogs --wrapper "$sanitizer_wrapper"
+
+          leak_wrapper="env LD_PRELOAD=$preload ASAN_OPTIONS=detect_leaks=1:halt_on_error=1:abort_on_error=1:print_summary=1 UBSAN_OPTIONS=halt_on_error=1:abort_on_error=1:print_summary=1:print_stacktrace=1"
+          meson test -C build-sanitize --print-errorlogs stream-dispatch --wrapper "$leak_wrapper"
+
+      - name: Strict warning check
+        if: env.RUN_BUILD == 'true'
+        run: |
+          meson setup build-strict -Dwerror=true
+          meson compile -C build-strict
+          meson test -C build-strict --print-errorlogs
+
+      - name: Install check
+        if: env.RUN_BUILD == 'true'
+        run: DESTDIR="$PWD/install-root" meson install -C build --no-rebuild
+
+      - name: Dist check
+        if: env.RUN_BUILD == 'true'
+        run: |
+          git config --global --add safe.directory "$PWD"
+          meson dist -C build
+
+      - name: Build Python package
+        if: env.RUN_BUILD == 'true'
+        run: |
+          python3 -m venv --system-site-packages .venv
+          .venv/bin/python -m pip install --upgrade pip
+          .venv/bin/python -m pip install build meson-python twine
+          rm -rf dist
+          .venv/bin/python -m build
+          .venv/bin/python -m twine check dist/*
+
+      - name: Smoke-test local wheel
+        if: env.RUN_BUILD == 'true'
+        run: |
+          python3 -m venv --system-site-packages /tmp/pwg-wheel-test
+          /tmp/pwg-wheel-test/bin/python -m pip install dist/*.whl
+          /tmp/pwg-wheel-test/bin/python - <<'PY'
+          import pipewire_gobject
+
+          import gi
+
+          gi.require_version("Pwg", "0.1")
+          from gi.repository import Pwg
+
+          assert Pwg.get_library_version() == "0.3.1"
+          assert pipewire_gobject.typelib_paths()
+          assert pipewire_gobject.library_paths()
+          print("Pwg wheel import ok", Pwg.get_library_version())
+          PY
+
+      - name: Live PipeWire smoke test
+        if: env.RUN_BUILD == 'true'
+        run: |
+          mkdir -p /tmp/pwg-runtime
+          chmod 700 /tmp/pwg-runtime
+          export XDG_RUNTIME_DIR=/tmp/pwg-runtime
+          pipewire >/tmp/pwg-pipewire.log 2>&1 &
+          pw_pid=$!
+          trap 'kill "$pw_pid" 2>/dev/null || true' EXIT
+          sleep 1
+          GI_TYPELIB_PATH="$PWD/build" \
+          LD_LIBRARY_PATH="$PWD/build" \
+          python3 tests/test_live_pipewire.py
+
+      - name: Live stream audio smoke test
+        if: env.RUN_BUILD == 'true'
+        run: |
+          GI_TYPELIB_PATH="$PWD/build" \
+          LD_LIBRARY_PATH="$PWD/build" \
+          python3 tests/test_live_stream_audio.py
+
+  pipewire-source:
+    name: PipeWire ${{ matrix.pipewire_version }}
+    needs: changes
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        pipewire_version:
+          - "1.0.2"
+          - "1.6.4"
+
+    env:
+      RUN_BUILD: ${{ needs.changes.outputs.run_build }}
+      PIPEWIRE_PREFIX: /tmp/pipewire-${{ matrix.pipewire_version }}
+      PIPEWIRE_TARBALL: https://gitlab.freedesktop.org/pipewire/pipewire/-/archive/${{ matrix.pipewire_version }}/pipewire-${{ matrix.pipewire_version }}.tar.bz2
+
+    steps:
+      - uses: actions/checkout@v6
+        if: env.RUN_BUILD == 'true'
+
+      - name: Skip notice
+        if: env.RUN_BUILD != 'true'
+        run: echo "No build-relevant files changed; PipeWire ${{ matrix.pipewire_version }} check is satisfied."
+
+      - name: Install dependencies
+        if: env.RUN_BUILD == 'true'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            build-essential \
+            meson \
+            ninja-build \
+            pkg-config \
+            python3 \
+            python3-gi \
+            ca-certificates \
+            curl \
+            libglib2.0-dev \
+            libdbus-1-dev \
+            gobject-introspection \
+            libgirepository1.0-dev
+
+      - name: Cache PipeWire prefix
+        if: env.RUN_BUILD == 'true'
+        id: pipewire-cache
+        uses: actions/cache@v5
+        with:
+          path: ${{ env.PIPEWIRE_PREFIX }}
+          key: ${{ runner.os }}-pipewire-${{ matrix.pipewire_version }}-minimal-v1
+
+      - name: Build PipeWire
+        if: env.RUN_BUILD == 'true' && steps.pipewire-cache.outputs.cache-hit != 'true'
+        run: |
+          set -e
+          workdir="$(mktemp -d)"
+          curl -L --fail -o "$workdir/pipewire.tar.bz2" "$PIPEWIRE_TARBALL"
+          tar -xf "$workdir/pipewire.tar.bz2" -C "$workdir"
+          meson setup "$workdir/build" "$workdir/pipewire-${{ matrix.pipewire_version }}" \
+            --prefix="$PIPEWIRE_PREFIX" \
+            -Dauto_features=disabled \
+            -Dtests=disabled \
+            -Dexamples=disabled \
+            -Dsession-managers=[]
+          meson compile -C "$workdir/build"
+          meson install -C "$workdir/build"
+
+      - name: Verify PipeWire version
+        if: env.RUN_BUILD == 'true'
+        run: |
+          export PKG_CONFIG_PATH="$PIPEWIRE_PREFIX/lib/x86_64-linux-gnu/pkgconfig:$PIPEWIRE_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
+          test "$(pkg-config --modversion libpipewire-0.3)" = "${{ matrix.pipewire_version }}"
+
+      - name: Build and test
+        if: env.RUN_BUILD == 'true'
+        run: |
+          export PKG_CONFIG_PATH="$PIPEWIRE_PREFIX/lib/x86_64-linux-gnu/pkgconfig:$PIPEWIRE_PREFIX/lib/pkgconfig:$PKG_CONFIG_PATH"
+          export LD_LIBRARY_PATH="$PIPEWIRE_PREFIX/lib/x86_64-linux-gnu:$PIPEWIRE_PREFIX/lib:$LD_LIBRARY_PATH"
+          meson setup build
+          meson compile -C build
+          meson test -C build --print-errorlogs
+
+      - name: Install check
+        if: env.RUN_BUILD == 'true'
+        run: |
+          export LD_LIBRARY_PATH="$PIPEWIRE_PREFIX/lib/x86_64-linux-gnu:$PIPEWIRE_PREFIX/lib:$LD_LIBRARY_PATH"
+          DESTDIR="$PWD/install-root" meson install -C build --no-rebuild

pipewire_gobject-0.3.1/.github/workflows/codeql.yml

@@ -0,0 +1,109 @@
+name: CodeQL
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  schedule:
+    - cron: "31 3 * * 2"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  security-events: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    name: Analyze C/C++
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Detect C/C++ analysis changes
+        id: changes
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          run_codeql=true
+          event="${{ github.event_name }}"
+
+          if [ "$event" = "pull_request" ]; then
+            base="${{ github.event.pull_request.base.sha }}"
+            head="${{ github.sha }}"
+            run_codeql=false
+          elif [ "$event" = "push" ]; then
+            base="${{ github.event.before }}"
+            head="${{ github.sha }}"
+            if [[ "$base" =~ ^0+$ ]]; then
+              run_codeql=true
+            else
+              run_codeql=false
+            fi
+          else
+            base=""
+            head=""
+            run_codeql=true
+          fi
+
+          if [ -n "$base" ] && [ "$run_codeql" = "false" ]; then
+            git diff --name-only "$base" "$head" > changed-files.txt
+            cat changed-files.txt
+
+            while IFS= read -r path; do
+              case "$path" in
+                src/*|meson.build|.github/workflows/codeql.yml)
+                  run_codeql=true
+                  ;;
+              esac
+            done < changed-files.txt
+          fi
+
+          echo "run_codeql=$run_codeql" >> "$GITHUB_OUTPUT"
+          echo "run_codeql=$run_codeql"
+
+      - name: Skip notice
+        if: steps.changes.outputs.run_codeql != 'true'
+        run: echo "No C/C++ analysis-relevant files changed; Analyze C/C++ check is satisfied."
+
+      - name: Install dependencies
+        if: steps.changes.outputs.run_codeql == 'true'
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y --no-install-recommends \
+            build-essential \
+            meson \
+            ninja-build \
+            pkg-config \
+            libglib2.0-dev \
+            libpipewire-0.3-dev \
+            gobject-introspection \
+            libgirepository1.0-dev \
+            python3-gi
+
+      - name: Initialize CodeQL
+        if: steps.changes.outputs.run_codeql == 'true'
+        uses: github/codeql-action/init@v4
+        with:
+          languages: c-cpp
+
+      - name: Build
+        if: steps.changes.outputs.run_codeql == 'true'
+        run: |
+          meson setup build-codeql
+          meson compile -C build-codeql
+
+      - name: Perform CodeQL analysis
+        if: steps.changes.outputs.run_codeql == 'true'
+        uses: github/codeql-action/analyze@v4