Skip to content

Commit 85cc669

Browse files
Merge pull request #1 from XAOSTECH:anglicise/20260401-020828
chore: Convert American spellings to British English
2 parents 1ece3e5 + a825a38 commit 85cc669

18 files changed

Lines changed: 78 additions & 78 deletions

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ assignees: ''
1111
A clear and concise description of what the bug is.
1212

1313
**To Reproduce**
14-
Steps to reproduce the behavior:
14+
Steps to reproduce the behaviour:
1515
1. Go to '...'
1616
2. Click on '....'
1717
3. Scroll down to '....'
1818
4. See error
1919

20-
**Expected behavior**
20+
**Expected behaviour**
2121
A clear and concise description of what you expected to happen.
2222

2323
**Screenshots**

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Please check the type of change your PR introduces:
1414
- [ ] Documentation content changes
1515
- [ ] Other (please describe):
1616

17-
## What is the current behavior?
17+
## What is the current behaviour?
1818

19-
<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
19+
<!-- Please describe the current behaviour that you are modifying, or link to a relevant issue. -->
2020

2121
Issue Number: N/A
2222

23-
## What is the new behavior?
23+
## What is the new behaviour?
2424

25-
<!-- Please describe the behavior or changes that are being added by this PR. -->
25+
<!-- Please describe the behaviour or changes that are being added by this PR. -->
2626

2727
-
2828
-

docs/BUFFER_CORRUPTION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -257,7 +257,7 @@ ffmpeg -f v4l2 -video_size <WIDTH>x<HEIGHT> -framerate <FPS> -i /dev/video0 -t 5
257257
# Example: 4K@30fps
258258
ffmpeg -f v4l2 -video_size 3840x2160 -framerate 30 -i /dev/video0 -t 5 -f rawvideo out.raw 2>&1 | tee capture.log
259259

260-
# Analyze corruption patterns
260+
# Analyse corruption patterns
261261
grep -i "corrupted" capture.log | head -20
262262

263263
# Check frame size (should be WIDTH*HEIGHT*1.5 bytes for NV12)

docs/CODE_OF_CONDUCT.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ diverse, inclusive, and healthy community.
1414

1515
## Our Standards
1616

17-
Examples of behavior that contributes to a positive environment for our
17+
Examples of behaviour that contributes to a positive environment for our
1818
community include:
1919

2020
* Demonstrating empathy and kindness toward other people
2121
* Being respectful of differing opinions, viewpoints, and experiences
2222
* Giving and gracefully accepting constructive feedback
23-
* Accepting responsibility and apologizing to those affected by our mistakes,
23+
* Accepting responsibility and apologising to those affected by our mistakes,
2424
and learning from the experience
2525
* Focusing on what is best not just for us as individuals, but for the
2626
overall community
2727

28-
Examples of unacceptable behavior include:
28+
Examples of unacceptable behaviour include:
2929

3030
* The use of sexualized language or imagery, and sexual attention or
3131
advances of any kind
@@ -39,8 +39,8 @@ Examples of unacceptable behavior include:
3939
## Enforcement Responsibilities
4040

4141
Community leaders are responsible for clarifying and enforcing our standards of
42-
acceptable behavior and will take appropriate and fair corrective action in
43-
response to any behavior that they deem inappropriate, threatening, offensive,
42+
acceptable behaviour and will take appropriate and fair corrective action in
43+
response to any behaviour that they deem inappropriate, threatening, offensive,
4444
or harmful.
4545

4646
Community leaders have the right and responsibility to remove, edit, or reject
@@ -58,7 +58,7 @@ representative at an online or offline event.
5858

5959
## Enforcement
6060

61-
Instances of abusive, harassing, or otherwise unacceptable behavior may be
61+
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
6262
reported to the community leaders responsible for enforcement at
6363
.
6464
All complaints will be reviewed and investigated promptly and fairly.
@@ -73,12 +73,12 @@ the consequences for any action they deem in violation of this Code of Conduct:
7373

7474
### 1. Correction
7575

76-
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
**Community Impact**: Use of inappropriate language or other behaviour deemed
7777
unprofessional or unwelcome in the community.
7878

7979
**Consequence**: A private, written warning from community leaders, providing
8080
clarity around the nature of the violation and an explanation of why the
81-
behavior was inappropriate. A public apology may be requested.
81+
behaviour was inappropriate. A public apology may be requested.
8282

8383
### 2. Warning
8484

@@ -106,7 +106,7 @@ Violating these terms may lead to a permanent ban.
106106
### 4. Permanent Ban
107107

108108
**Community Impact**: Demonstrating a pattern of violation of community
109-
standards, including sustained inappropriate behavior, harassment of an
109+
standards, including sustained inappropriate behaviour, harassment of an
110110
individual, or aggression toward or disparagement of classes of individuals.
111111

112112
**Consequence**: A permanent ban from any sort of public interaction within
@@ -125,4 +125,4 @@ enforcement ladder](https://github.com/mozilla/diversity).
125125

126126
For answers to common questions about this code of conduct, see the FAQ at
127127
https://www.contributor-covenant.org/faq. Translations are available at
128-
https://www.contributor-covenant.org/translations.
128+
https://www.contributor-covenant.org/translations.

docs/DRIVER_INFO.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ The Windows driver (uvclower.sys) is a UVC **lower filter** that adds vendor-spe
3838
**Platform Support:**
3939
- Windows x86 (32-bit): `x86/uvclower.sys`
4040
- Windows x64 (64-bit): `x64/uvclower.sys`
41-
- Catalog: `uvclower.cat`
41+
- Catalogue: `uvclower.cat`
4242

4343
**Driver Functions:**
4444
- UVC filter for video capture
@@ -53,7 +53,7 @@ Based on the official driver configuration:
5353
### Video Interfaces
5454
- **HDMI Input**: 1x HDMICapture device
5555
- **UVC Compliance**: Full UVC 1.0+ compliance
56-
- **Color Spaces**:
56+
- **Colour Spaces**:
5757
- YUV 4:2:0 (NV12, YU12) - Standard 8-bit
5858
- **P010** (10-bit HDR) - Native 10-bit format support
5959
- **Max Resolution**: 4K UHD (3840x2160)
@@ -65,7 +65,7 @@ Based on the official driver configuration:
6565
- **USB Speed**: USB 3.0 / USB 3.1
6666
- **Interface Type**: USB Video Class (UVC)
6767

68-
## Optimization for Linux
68+
## Optimisation for Linux
6969

7070
### v4l2-ctl Device Information
7171

@@ -132,7 +132,7 @@ Based on the official driver specifications:
132132
Video Resolution: 3840x2160 (4K)
133133
Framerate: 30 fps (stable)
134134
Pixel Format: YU12 (Planar YUV 4:2:0)
135-
Color Space: Rec.709 / BT.709
135+
Colour Space: Rec.709 / BT.709
136136

137137
# Alternative (lower resource)
138138
Video Resolution: 1920x1080 (Full HD)
@@ -163,7 +163,7 @@ The device is detected by:
163163
- Creates /dev/videoX nodes
164164

165165
3. **v4l2 framework**:
166-
- Provides standardized API
166+
- Provides standardised API
167167
- Supports hardware acceleration (if available)
168168

169169
## Stability Tips for Linux
@@ -241,7 +241,7 @@ The P010 v4l2 support patches and prebuilt kernels are maintained by Alexander W
241241

242242
- **Driver Source**: [Build.0.15.12](https://www.mediafire.com/file/41l9pmpp2wqn6ks/25173+Build.0.15.12.zip/file)
243243
- **P010 Kernel Patches**: [P010_for_V4L2 (workspace root)](../../../P010_for_V4L2)
244-
- **Linux Optimization**: [WAYLAND_OPTIMISATION.md](WAYLAND_OPTIMISATION.md)
244+
- **Linux Optimisation**: [WAYLAND_OPTIMISATION.md](WAYLAND_OPTIMISATION.md)
245245
- **Buffer Troubleshooting**: [BUFFER_CORRUPTION.md](BUFFER_CORRUPTION.md)
246246
- **Safe Launcher**: [scripts/obs-safe-launch.sh](../scripts/obs-safe-launch.sh)
247247

docs/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Stabilise high-throughput USB capture devices for OBS on Linux. Provides auto-re
1010
- **Auto-reconnect** — Monitors device and restarts feed on disconnect
1111
- **USB reset & driver rebind** — Recovers from device hangs without reboot
1212
- **Performance optimisations** — Disables USB autosuspend, optimises power settings
13-
- **HDR passthrough** — Configurable color handling modes
13+
- **HDR passthrough** — Configurable colour handling modes
1414
- **Optional overlay** — Add logo/watermark from URL or file
1515
- **Format auto-detection** — Detects best resolution/fps during install
1616
- **Wayland graphics optimisation** — Fixes OBS crashes on Wayland with explicit sync and PipeWire support
@@ -66,14 +66,14 @@ A comprehensive interactive maintenance system is available for troubleshooting
6666
sudo ./scripts/maintenance.sh
6767
```
6868

69-
This menu provides access to 9 specialized recovery tools:
69+
This menu provides access to 9 specialised recovery tools:
7070

7171
| Tool | Description | Use When |
7272
|------|-------------|----------|
7373
| **detect_device** | Enumerate USB video devices | Device not found or caps unclear |
7474
| **disable_overlay** | Remove on-screen logos/OSD | Capture has unwanted watermarks |
7575
| **hard_reset** | Unbind/rebind USB driver | Device unresponsive but enumerated |
76-
| **optimise_device** | Disable autosuspend, optimize power | Timeouts, USB power errors |
76+
| **optimise_device** | Disable autosuspend, optimise power | Timeouts, USB power errors |
7777
| **pick_delogo** | Visually select logo region | Need to identify overlay position |
7878
| **repair** | Full recovery workflow | Device broken, try complete reset |
7979
| **simulate_disconnect** | Test device authority toggle | Testing/diagnostics only |
@@ -124,7 +124,7 @@ For detailed buffer corruption diagnosis, see **[BUFFER_CORRUPTION.md](BUFFER_CO
124124
|--------|---------|
125125
| [`install.sh`](../scripts/install.sh) | Interactive setup: detect device, install services, v4l2loopback |
126126
| [`validate_capture.sh`](../scripts/validate_capture.sh) | Test device for corruption, timeouts, USB power issues |
127-
| [`optimise_device.sh`](../scripts/optimise_device.sh) | Disable autosuspend, optimize USB power for device |
127+
| [`optimise_device.sh`](../scripts/optimise_device.sh) | Disable autosuspend, optimise USB power for device |
128128
| [`optimise_drivers.sh`](../scripts/optimise_drivers.sh) | Fix OBS Wayland crashes (Nvidia/AMD/Intel) |
129129
| [`auto_reconnect.sh`](../scripts/auto_reconnect.sh) | Monitor device, auto-restart on disconnect |
130130
| [`parse_formats.sh`](../scripts/parse_formats.sh) | Auto-detect best resolution/fps from device |
@@ -156,21 +156,21 @@ All settings in `/etc/default/usb-capture`:
156156

157157
### HDR Modes
158158

159-
| Mode | Behavior |
159+
| Mode | Behaviour |
160160
|------|----------|
161161
| `0` | Auto — trust device (may delay startup) |
162162
| `1` | Force HDR interpretation + tonemap to SDR |
163163
| `2` | Force HDR passthrough (fastest startup) **← default** |
164164
| `3` | Force SDR interpretation |
165165

166-
Most devices auto-handle HDR internally. Mode 2 provides fastest startup without color issues.
166+
Most devices auto-handle HDR internally. Mode 2 provides fastest startup without colour issues.
167167

168168
## OBS Setup
169169

170170
### Standard Setup
171171

172172
1. Add **Video Capture Device** source
173-
2. Select `/dev/video10` (labeled "USB_Capture_Loop")
173+
2. Select `/dev/video10` (labelled "USB_Capture_Loop")
174174
3. Resolution/FPS auto-detected
175175

176176
If device not visible:
@@ -325,7 +325,7 @@ nvidia-smi # Check current version
325325
sudo ./scripts/optimise_drivers.sh --amd
326326
```
327327

328-
Ensures AMDGPU driver is optimised for Wayland, enables color block compression.
328+
Ensures AMDGPU driver is optimised for Wayland, enables colour block compression.
329329

330330
### Intel GPU
331331

@@ -428,7 +428,7 @@ lsusb
428428
sudo nano /etc/udev/rules.d/99-usb-capture-optimisation.rules
429429
```
430430

431-
Add the rule (customize VID:PID for your device):
431+
Add the rule (customise VID:PID for your device):
432432
```udev
433433
ACTION=="add", SUBSYSTEM=="usb", ATTR{idVendor}=="3188", ATTR{idProduct}=="1000", ATTR{power/control}="on", ATTR{power/autosuspend_delay_ms}="-1"
434434
```

docs/USB_STABILITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ source ~/.bashrc
239239
cd /home/jnxlr/PRO/WEB/CST/op-cap
240240
make install-safe-launcher
241241

242-
# 3. Run driver optimization (creates wrapper)
242+
# 3. Run driver optimisation (creates wrapper)
243243
sudo make optimise-drivers
244244

245245
# 4. Disable autosuspend

docs/WAYLAND_OPTIMISATION.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ export PIPEWIRE_LATENCY=64/48000 # Optimise PipeWire audio
113113

114114
#### AMD Configuration
115115
```bash
116-
export RADEON_ENABLE_ACE=1 # Enable color block compression
116+
export RADEON_ENABLE_ACE=1 # Enable colour block compression
117117
export QT_QPA_PLATFORM=wayland
118118
export GDK_BACKEND=wayland
119119
export LIBVA_DRIVER_NAME=radeonsi # VA-API hardware acceleration
@@ -306,8 +306,8 @@ export __NV_PM=0
306306

307307
1. **Settings > Video:**
308308
- Renderer: GPU-based (OpenGL/Vulkan)
309-
- Color Space: Native (recommended)
310-
- Color Range: Full (when available)
309+
- Colour Space: Native (recommended)
310+
- Colour Range: Full (when available)
311311

312312
2. **Settings > Advanced:**
313313
- Hardware Acceleration: Enable (checked)

ffmpeg/feed.sh

100755100644
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ FPS=${4:-${USB_CAPTURE_FPS:-30}}
1616
INPUT_FORMAT=${5:-${USB_CAPTURE_FORMAT:-NV12}}
1717

1818
# HDR handling modes:
19-
# 0 = auto (trust device, no color interpretation)
20-
# 1 = force HDR interpretation (BT.2020/PQ) + tonemap to SDR (use if colors blown out)
19+
# 0 = auto (trust device, no colour interpretation)
20+
# 1 = force HDR interpretation (BT.2020/PQ) + tonemap to SDR (use if colours blown out)
2121
# 2 = force HDR interpretation (BT.2020/PQ) + passthrough NV12 - DEFAULT
2222
# 3 = force SDR interpretation (Rec.709)
2323
HDR_MODE=${USB_CAPTURE_HDR_MODE:-2}
@@ -107,7 +107,7 @@ if [ -n "$INPUT_PIX_FMT" ]; then
107107
INPUT_FMT_OPT="-input_format $INPUT_PIX_FMT"
108108
fi
109109

110-
# HDR mode: set input color metadata and output pixel format
110+
# HDR mode: set input colour metadata and output pixel format
111111
HDR_INPUT_OPTS=""
112112
HDR_OUTPUT_OPTS=""
113113
HDR_FILTER=""
@@ -120,7 +120,7 @@ case "$HDR_MODE" in
120120
OUTPUT_PIX_FMT="yuv420p"
121121
;;
122122
2)
123-
# HDR passthrough: keep NV12, propagate color metadata to output
123+
# HDR passthrough: keep NV12, propagate colour metadata to output
124124
# This is what allows OBS/downstream to classify the stream as HDR
125125
echo " HDR Mode 2: BT.2020/PQ passthrough, NV12 preserved to loopback"
126126
HDR_INPUT_OPTS="-color_primaries bt2020 -color_trc smpte2084 -colorspace bt2020nc"
@@ -137,7 +137,7 @@ case "$HDR_MODE" in
137137
;;
138138
*)
139139
# Mode 0: Auto
140-
echo " HDR Mode 0: Auto (trusting device color reporting, NV12 preserved)"
140+
echo " HDR Mode 0: Auto (trusting device colour reporting, NV12 preserved)"
141141
OUTPUT_PIX_FMT="nv12"
142142
;;
143143
esac
@@ -178,7 +178,7 @@ elif [ -n "$FINAL_VF" ]; then
178178
-vcodec rawvideo -pix_fmt "$OUTPUT_PIX_FMT" $HDR_OUTPUT_OPTS \
179179
-f v4l2 -nostdin "$OUT" || echo "FFmpeg stopped"
180180
else
181-
# Clean passthrough: no filter, just relay with color metadata
181+
# Clean passthrough: no filter, just relay with colour metadata
182182
LD_PRELOAD="${FFMPEG_LD_PRELOAD}" V4L2_HDR_SHIM_DEVICE="$OUT" \
183183
ffmpeg -hide_banner -loglevel info \
184184
-thread_queue_size 16 -rtbufsize 256M \

scripts/extract_driver_info.sh

100755100644
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ The Windows driver (uvclower.sys) is a UVC **lower filter** that adds vendor-spe
6969
**Platform Support:**
7070
- Windows x86 (32-bit): \`x86/uvclower.sys\`
7171
- Windows x64 (64-bit): \`x64/uvclower.sys\`
72-
- Catalog: \`uvclower.cat\`
72+
- Catalogue: \`uvclower.cat\`
7373
7474
**Driver Functions:**
7575
- UVC filter for video capture
@@ -84,7 +84,7 @@ Based on the official driver configuration:
8484
### Video Interfaces
8585
- **HDMI Input**: 1x HDMICapture device
8686
- **UVC Compliance**: Full UVC 1.0+ compliance
87-
- **Color Space**: YUV 4:2:0 (NV12, YU12)
87+
- **Colour Space**: YUV 4:2:0 (NV12, YU12)
8888
- **Max Resolution**: 4K UHD (3840x2160)
8989
- **Max Framerate**: Up to 60 fps (hardware dependent)
9090
@@ -93,7 +93,7 @@ Based on the official driver configuration:
9393
- **USB Speed**: USB 3.0 / USB 3.1
9494
- **Interface Type**: USB Video Class (UVC)
9595
96-
## Optimization for Linux
96+
## Optimisation for Linux
9797
9898
### v4l2-ctl Device Information
9999
@@ -117,7 +117,7 @@ Based on the official driver specifications:
117117
Video Resolution: 3840x2160 (4K)
118118
Framerate: 30 fps (stable)
119119
Pixel Format: YU12 (Planar YUV 4:2:0)
120-
Color Space: Rec.709 / BT.709
120+
Colour Space: Rec.709 / BT.709
121121
122122
# Alternative (lower resource)
123123
Video Resolution: 1920x1080 (Full HD)
@@ -148,7 +148,7 @@ The device is detected by:
148148
- Creates /dev/videoX nodes
149149
150150
3. **v4l2 framework**:
151-
- Provides standardized API
151+
- Provides standardised API
152152
- Supports hardware acceleration (if available)
153153
154154
## Stability Tips for Linux
@@ -208,7 +208,7 @@ Common UGREEN models with uvclower driver:
208208
## File Locations
209209
210210
- **Driver Source**: \`driver/Build.0.15.12/Drivers/\`
211-
- **Linux Optimization** [WAYLAND_OPTIMISATION.md](WAYLAND_OPTIMISATION.md)
211+
- **Linux Optimisation** [WAYLAND_OPTIMISATION.md](WAYLAND_OPTIMISATION.md)
212212
- **Buffer Troubleshooting**: [BUFFER_CORRUPTION.md](BUFFER_CORRUPTION.md)
213213
- **Safe Launcher**: [scripts/obs-safe-launch.sh](../scripts/obs-safe-launch.sh)
214214

0 commit comments

Comments
 (0)