9e3e719806
Add full IO support for every global ProPresenter library file plus theme folders, and extend the existing Labels/Macros readers with exporters and editable accessors so every supported document is now a round-trippable, mutable object. New library readers/writers (each: FileReader, FileWriter, Library wrapper, element wrapper where applicable, CLI tool, tests, doc/api/*.md): - Groups (ProGroupsDocument) + GroupDefinition - ClearGroups (ClearGroupsDocument) + ClearGroupDefinition - CCLI (CCLIDocument) - Messages (MessageDocument) + Message - Timers (TimersDocument + Clock) + Timer - Stage (Stage.Document) + StageLayout - Workspace (ProPresenterWorkspace) + Screen - Props (PropDocument) + Prop - TestPatterns (TestPatternDocument) - Calendar (new CalendarDocument) + CalendarEvent - KeyMappings (new KeyMappingsDocument) + KeyMapping - CommunicationDevices (JSON file) + CommunicationDevice - Theme bundles (Template.Document folder + Assets/) + ThemeBundle/Slide/Asset Extensions to existing modules: - LabelsFileWriter; Label and LabelLibrary gain setters, addLabel, removeLabel, setColor / setColorHex helpers - MacrosFileWriter; Macro/MacroCollection/MacroLibrary gain UUID, name, color, image_type, image_data, trigger_on_startup setters plus add/remove for macros and collections Two new minimal proto schemas were defined for documents that lacked upstream definitions: - proto/calendar.proto - CalendarDocument with Event entries, raw bytes for the action/macro sub-messages so the schema can evolve - proto/keyMappings.proto - KeyMappingsDocument with ApplicationInfo and a forward-looking Mapping message (sample only carries the info) The Theme file turned out to be a regular Rv\Data\Template\Document, so no new proto was required for theme content; ThemeBundle layers folder + Assets/ handling on top in the same spirit as PresentationBundle. GroupDefinition is intentionally distinct from the existing Group class (which wraps song-level CueGroup) to avoid breaking song APIs. Verified with the full PHPUnit suite: 370 tests, 9200 assertions, all green; LSP diagnostics clean across src/. The unmodified reference samples for Labels, Groups, ClearGroups, TestPatterns, Calendar and KeyMappings round-trip byte-for-byte; the others round-trip with the same byte length (PHP protobuf is not canonically deterministic but re-write-after-write stabilises). doc/INDEX.md, doc/keywords.md and AGENTS.md updated so every new module is discoverable from the top level.
107 lines
2.9 KiB
Markdown
107 lines
2.9 KiB
Markdown
# 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
|
|
|
|
```php
|
|
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`](../../proto/testPattern.proto):
|
|
|
|
| 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
|
|
|
|
```php
|
|
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.
|
|
|
|
```php
|
|
$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
|
|
|
|
```bash
|
|
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.
|