Thorsten Bus 9e3e719806 feat(library): add readers + writers for all ProPresenter global libraries and theme bundles

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.

2026-05-03 21:40:09 +02:00

1.7 KiB

Raw Permalink Blame History

Stage Library API

PHP module for reading, modifying, and writing the global ProPresenter Stage file.

Quick Reference

use ProPresenter\Parser\StageFileReader;
use ProPresenter\Parser\StageFileWriter;

$library = StageFileReader::read('/path/to/Stage');

foreach ($library->getLayouts() as $layout) {
    $layout->getName();
    $layout->getUuid();
    $layout->getSlide(); // ?\Rv\Data\Slide
}

StageFileWriter::write($library, '/path/to/Stage');

File Layout

The Stage file is the protobuf-serialised Rv\Data\Stage\Document from stage.proto.

Field	Type	Description
`application_info`	`ApplicationInfo`	ProPresenter metadata
`layouts`	repeated `Stage.Layout`	Stage display layouts

StageLibrary

$library->getDocument();
$library->getLayouts();
$library->getLayoutByUuid('0455...'); // case-insensitive
$library->getLayoutByName('Default StageDisplay');
$library->addLayout($layout);
$library->removeLayout($uuid);
$library->count();
$library->getApplicationInfo();

StageLayout

$layout->getName();
$layout->setName('New name');
$layout->getUuid();
$layout->setUuid('...');
$layout->getSlide();
$layout->getProto();

The slide is exposed as the raw Rv\Data\Slide protobuf because stage layouts can contain complex arrangements.

CLI Tool

php bin/parse-stage.php /path/to/Stage

Key Files

File	Purpose
`src/StageFileReader.php`	Reads the `Stage` file
`src/StageFileWriter.php`	Writes the `Stage` file
`src/StageLibrary.php`	Document wrapper and indexes
`src/StageLayout.php`	Single layout wrapper
`bin/parse-stage.php`	CLI summary tool

1.7 KiB Raw Permalink Blame History