Thorsten Buss 4d10db4f17 Initial public release

PHP 8.4 library and CLI tools to read, modify, and generate ProPresenter 7
files: songs (.pro), playlists (.proplaylist), bundles (.probundle), themes,
and the global library files (Macros, Labels, Groups, ClearGroups, CCLI,
Messages, Timers, Stage, Workspace, Props, TestPatterns, Calendar,
KeyMappings, CommunicationDevices).

Built on the MIT-licensed ProPresenter7-Proto schema by greyshirtguy
(v7.16.2). Includes 18 CLI parsers, comprehensive API docs in doc/,
binary-format specs, and a synthetic 369-test PHPUnit suite covering
RTF extraction, translation slides, ZIP64 repair, round-trip fidelity,
and end-to-end generation.

2026-05-03 22:21:01 +02:00

2.9 KiB

Raw Blame History

TestPatterns Library API

PHP module for reading and writing the global ProPresenter TestPatterns file (raw protobuf, no extension), including selected test-pattern state and saved pattern definitions.

Quick Reference

use ProPresenter\Parser\TestPatternsFileReader;
use ProPresenter\Parser\TestPatternsFileWriter;

$library = TestPatternsFileReader::read('/path/to/TestPatterns');

$library->getDisplayLocation();      // 3
$library->getSpecificScreenUuid();   // "BCDE1115-..."
$library->getPatterns();             // TestPatternData[]

TestPatternsFileWriter::write($library, '/path/to/TestPatterns');

File Layout

The TestPatterns file is the protobuf-serialised TestPatternDocument:

Field	Type	Description
`state`	`TestPatternDocument.TestPatternStateData`	Current test-pattern display state
`patterns`	repeated `TestPatternDocument.TestPatternData`	Saved pattern definitions

TestPatternStateData includes selected pattern UUID/name, display location, specific screen UUID, identify-screen flag, logo type, and optional user logo.

Reading

use ProPresenter\Parser\TestPatternsFileReader;

$library = TestPatternsFileReader::read('/Users/me/.../TestPatterns');

Throws InvalidArgumentException for missing files and RuntimeException for empty / unreadable files.

TestPatternsLibrary

Top-level wrapper around Rv\Data\TestPatternDocument. Indexes saved pattern definitions by UUID (case-insensitive) and localization key.

$library->getState();
$library->setState($stateOrNull);
$library->getSelectedPatternUuid();
$library->getSelectedPatternNameLocalizationKey();
$library->getDisplayLocation();
$library->getSpecificScreenUuid();
$library->getPatterns();
$library->count();
$library->getPatternByUuid('...');
$library->getPatternByName('Test Pattern');
$library->addPattern('Test Pattern', 'UUID');
$library->removePattern('UUID');
$library->getDocument(); // \Rv\Data\TestPatternDocument

CLI Tool

php bin/parse-test-patterns.php /path/to/TestPatterns

Output:

TestPatterns (0):
  State: selected=(none) :: name=(none) :: display_location=3 :: screen=BCDE1115-AD40-4BA4-A33A-BFFE3E87223B

Key Files

File	Purpose
`src/TestPatternsLibrary.php`	Document-level wrapper with state accessors
`src/TestPatternsFileReader.php`	Reads the `TestPatterns` file
`src/TestPatternsFileWriter.php`	Writes the `TestPatterns` file
`bin/parse-test-patterns.php`	CLI tool
`proto/testPattern.proto`	Protobuf schema
`generated/Rv/Data/TestPatternDocument.php`	Generated message class

Scope Notes

The wrapper exposes TestPatternData and TestPatternStateData protobufs directly. It does not render test patterns or interpret nested property oneofs.

2.9 KiB Raw Blame History