Skip to main content

Qt/QML pose estimation components

Project description

Sidepose
Sidepose

Pose QML (sidepose)

QML-friendly, headless pose processing with simple anchors for overlaying items on people, bones, and faces.

Sample outputs

Quick screencasts of the overlay running on sample videos:

Features

  • Headless PoseProcessor (QObject) for frames from VideoOutput/camera.
  • QML anchors: PoseKeypointAnchor, PoseBoneAnchor, PoseFaceAnchor to position any QML item.
  • PoseSpace wrapper auto-computes mapping (like VideoOutput.contentRect) so anchors just work.
  • Multi-platform model cache with automatic download of MediaPipe pose models.

Requirements

  • Python 3.10+
  • PySide6 (Qt 6)
  • MediaPipe Tasks (via the mediapipe Python package)

Install deps (example):

python3 -m pip install -U pip
pip install PySide6 mediapipe numpy

Quick start (minimal demo)

Run the example app:

python3 -m example.main

What it does:

  • Plays example/sample.mp4 in a VideoOutput.
  • Starts PoseProcessor and overlays keypoints, bones, and a face mask using anchors inside PoseSpace.
  • On first run, downloads the default model (pose_landmarker_full.task) into a cache.

Publishing (maintainers)

This project ships wheels and sdists via GitLab CI:

  • Create a tag for TestPyPI (e.g., v0.2.0-rc1) to trigger the testpypi job.
  • Create a tag like v0.2.0 to enable the manual PyPI publish job.
  • Provide CI variables: TWINE_USERNAME (usually token), TWINE_PASSWORD_TESTPYPI, TWINE_PASSWORD_PYPI.

Automatic model handling

You don’t need to specify a model path. If modelAssetPath is empty:

  • Sidepose defaults to pose_landmarker_full and downloads it the first time.
  • You can override with a name (pose_landmarker_lite|full|heavy), a local path, or a URL (file://, https://).

Cache location:

  • Env override: SIDEPOSE_CACHE_DIR.
  • Windows: %LOCALAPPDATA%/sidepose/models (fallback: %USERPROFILE%/AppData/Local/sidepose/models).
  • macOS: ~/Library/Caches/sidepose/models.
  • Linux: $XDG_CACHE_HOME/sidepose/models or ~/.cache/sidepose/models.

Minimal QML snippet

import QtQuick
import QtQuick.Window
import QtMultimedia
import Pose 1.0
import "../sidepose/qml/Pose"

Window {
	width: 1280
	height: 720
	visible: true

	VideoOutput {
		id: view
		anchors.fill: parent
		fillMode: VideoOutput.PreserveAspectFit
	}

	MediaPlayer {
		id: player
		source: Qt.resolvedUrl("sample.mp4")
		autoPlay: true
		loops: MediaPlayer.Infinite
		videoOutput: view
	}

	PoseProcessor {
		id: pose
		videoSink: view.videoSink
		backend: "mediapipe"
		useGpu: true
	}

	PoseSpace {
		anchors.fill: parent
		processor: pose

		Repeater {
			model: 33
			delegate: PoseKeypointAnchor {
				processor: pose
				keypoint: index
				Rectangle {
					anchors.centerIn: parent
					width: 6; height: 6; radius: 3
					color: "#FF4081"
				}
			}
		}

		Repeater {
			model: 12
			delegate: PoseBoneAnchor {
				processor: pose
				bone: index
				height: 4
				Rectangle {
					anchors.fill: parent
					color: "#40C4FF"
					radius: 2
				}
			}
		}

		PoseFaceAnchor {
			processor: pose
			strategy: Pose.FaceStrategy.EyesEars
			rotationFrom: Pose.FaceRotation.EarLine
			scaleFactor: 1.0
			Image {
				anchors.fill: parent
				source: Qt.resolvedUrl("face_mask.png")
				fillMode: Image.PreserveAspectFit
			}
		}
	}
}

Troubleshooting

  • If the model fails to load, check your internet connection on first run, or set SIDEPOSE_CACHE_DIR to a writable directory.
  • If QML types aren’t found, ensure register_qml_types() is called in your runner (example/main.py does this).
  • For CPU fallback when GPU init fails, the processor automatically retries; see logs for details.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sidepose-0.0.1.tar.gz (53.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sidepose-0.0.1-py3-none-any.whl (99.3 kB view details)

Uploaded Python 3

File details

Details for the file sidepose-0.0.1.tar.gz.

File metadata

  • Download URL: sidepose-0.0.1.tar.gz
  • Upload date:
  • Size: 53.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for sidepose-0.0.1.tar.gz
Algorithm Hash digest
SHA256 69d8101e08df8203199071773f7f30eb8c3dc3e00821071f5ab5688fbfd91386
MD5 f0000d4e58c162d79509b0f26f9a6cb4
BLAKE2b-256 2716de1fa8b5696e61ec703b8c26c259a298dc7b060475664f1297903a47016a

See more details on using hashes here.

File details

Details for the file sidepose-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: sidepose-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 99.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for sidepose-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1e3f97df37560c17fcc0e5c44d40954d7b9fa0ef1b5020d67b219b7a9bbc7911
MD5 bb1db8bfe499789d0e35dc659618d20c
BLAKE2b-256 1653cc6bdab142f531ca3ee4eb69efaeb33dff858dfdcb63281fc64ca262f9d8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page