copt

---

Capture Operations

---

📋 Table of Contents

• Overview
• Features
• Installation
• Usage
• Configuration
• Documentation
• Contributing
• Roadmap
• Support
• License
• Acknowledgements

---

🔍 Overview

Low-level Wayland screen capture tool for UNIX systems. Uses FFmpeg's KMS grab to capture the framebuffer directly, with hardware-accelerated encoding via VAAPI or NVENC, plus ALSA audio capture.

Why copt?

Wayland compositors don't expose the X11 screen-grab APIs that traditional tools rely on. copt uses the kernel's KMS (Kernel Mode Setting) framebuffer interface through FFmpeg's kmsgrab device, giving you zero-copy GPU capture with hardware encoding — no Xwayland needed.

---

✨ Features

• KMS Grab — Capture the Wayland framebuffer via /dev/dri without compositor cooperation
• Hardware Encoding — VAAPI (Intel/AMD) and NVENC (NVIDIA) with automatic detection
• Software Fallback — Falls back to libx264/libx265 when no hardware encoder is available
• ALSA Audio — Captures system audio via ALSA with auto-detection of devices
• Region Crop — Capture a specific region of the screen with configurable X/Y/W/H
• Resolution Scaling — Scale down from native resolution to any output size
• Config File — Persistent settings in ~/.config/copt/copt.conf
• Dry Run — Preview the FFmpeg command without executing
• System Probe — Detect GPUs, DRI devices, audio hardware, and available encoders

---

📥 Installation

Prerequisites

• Linux with KMS support (kernel 5.x+)
• FFmpeg built with --enable-libx264 and kmsgrab support
• GPU drivers (Mesa for VAAPI, or NVIDIA proprietary for NVENC)
• Root/sudo access (required for KMS framebuffer reads)

Quick Start

# Clone the repository
git clone https://github.com/XAOSTECH/copt.git
cd copt

# Install to /usr/local/bin
./install.sh

# Or just run directly
chmod +x copt
sudo ./copt --help

Manual Install

sudo install -Dm755 copt /usr/local/bin/copt
mkdir -p ~/.config/copt
cp copt.conf.example ~/.config/copt/copt.conf

---

🚀 Usage

Basic Usage

# Full screen capture with auto-detection of GPU, encoder, and audio
sudo copt -o ~/recording.mkv

Advanced Usage

# Capture a 1920x1080 region from offset (100,200), encode with NVENC, no audio
sudo copt --crop-x 100 --crop-y 200 --crop-w 1920 --crop-h 1080 \
    -e nvenc -A -o /tmp/region.mkv

Examples

📘 Example 1: Full Screen (3456x2160 → 1440x900)

sudo copt -W 3456 -H 2160 -w 1440 -h 900 \
    -d /dev/dri/card1 -a hw:0,6 -o ~/screen.mkv

📗 Example 2: 30fps clip, 60 second duration, software encoder

sudo copt -r 30 -t 60 -e x264 -q 23 -o /tmp/clip.mkv

📙 Example 3: Probe your system to find devices

sudo copt --probe

📕 Example 4: Dry run — see the ffmpeg command without executing

sudo copt --crop-w 1920 --crop-h 1080 --dry-run

---

⚙️ Configuration

Environment Variables

All settings can be set via environment variables prefixed with COPT_:

Variable	Description	Default
COPT_DRI_DEVICE	DRI card device path	auto-detect
COPT_SCREEN_W	Source screen width	3456
COPT_SCREEN_H	Source screen height	2160
COPT_OUT_W	Output video width	1440
COPT_OUT_H	Output video height	900
COPT_CROP_X	Crop region X offset	0
COPT_CROP_Y	Crop region Y offset	0
COPT_CROP_W	Crop region width	screen width
COPT_CROP_H	Crop region height	screen height
COPT_ENCODER	Encoder: auto/vaapi/nvenc/x264/x265	auto
COPT_QUALITY	CRF/QP value (0-51)	20
COPT_FRAMERATE	Capture framerate	60
COPT_AUDIO	Enable audio (1/0)	1
COPT_AUDIO_DEVICE	ALSA device	auto-detect
COPT_AUDIO_CODEC	Audio codec: aac/opus/mp3/copy	aac
COPT_OUTPUT	Output file path	/tmp/copt-output.mkv
COPT_DURATION	Duration in seconds (0=unlimited)	0

Configuration File

# ~/.config/copt/copt.conf
COPT_DRI_DEVICE="/dev/dri/card1"
COPT_SCREEN_W=3456
COPT_SCREEN_H=2160
COPT_OUT_W=1440
COPT_OUT_H=900
COPT_ENCODER=vaapi
COPT_AUDIO_DEVICE="hw:0,6"

See copt.conf.example for all options with documentation.

---

📝 Notes

• Root required: kmsgrab reads the KMS framebuffer directly and needs root privileges.
• Multi-GPU: If /dev/dri/card0 doesn't work, try card1 (common on hybrid GPU laptops).
• Audio devices: Check cat /proc/asound/cards and cat /proc/asound/devices to find yours.
• Mouse cursor: kmsgrab does not capture the mouse cursor (kernel limitation).
• Wayland only: This uses KMS grab, not PipeWire or X11 screen capture.

---

🤝 Contributing

Contributions are welcome! Please read our Contributing Guidelines before submitting PRs.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

See also: Code of Conduct | Security Policy

---

🗺️ Roadmap

• KMS grab screen capture with VAAPI encoding
• NVENC and software encoder fallback
• ALSA audio capture with auto-detection
• Configurable crop regions and output scaling
• PipeWire audio capture support
• Multi-monitor / specific output selection
• Overlay / mouse cursor compositing
• RTMP/SRT live streaming output

See the open issues for a full list of proposed features and known issues.

---

💬 Support

• 💻 Issues: GitHub Issues
• 💬 Discussions: GitHub Discussions

---

📄 License

Distributed under the GPL-3.0 License. See LICENSE for more information.

---

🙏 Acknowledgements

• FFmpeg — the backbone of all encoding
• KMS/DRM — Linux kernel modesetting API
• VAAPI — Video Acceleration API
• NVIDIA NVENC — NVIDIA hardware video encoder

---

⬆️ Back to Top