Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::format::OfflineRenderHost Class Reference

General-purpose offline renderer over a ProcessorFactory. More...

#include <offline_render_host.hpp>

Public Member Functions

 OfflineRenderHost (ProcessorFactory factory)
bool prepare (const OfflineRenderConfig &config)
bool prepared () const noexcept
const OfflineRenderConfig & config () const noexcept
OfflineRenderResult render (const OfflineRenderOptions &options)
OfflineRenderResult render (const OfflineRenderOptions &options, std::function< bool()> should_continue)
 Versioned cancellation/deadline seam for control-thread callers.
HeadlessHost & headless () noexcept
const HeadlessHost & headless () const noexcept

Detailed Description

General-purpose offline renderer over a ProcessorFactory.

This is intentionally layered above HeadlessHost rather than replacing it: HeadlessHost remains the one-block seam, while OfflineRenderHost owns multi-block stepping, final-block shortening, input silence padding, and sample-accurate event slicing. Callers must pass MIDI and parameter events sorted by absolute frame. Nested event sample offsets are ignored and rewritten relative to each process block.

Constructor & Destructor Documentation

◆ OfflineRenderHost()

pulp::format::OfflineRenderHost::OfflineRenderHost ( ProcessorFactory factory)
explicit

Member Function Documentation

◆ config()

const OfflineRenderConfig & pulp::format::OfflineRenderHost::config ( ) const
inlinenoexcept

◆ headless() [1/2]

const HeadlessHost & pulp::format::OfflineRenderHost::headless ( ) const
inlinenoexcept

◆ headless() [2/2]

HeadlessHost & pulp::format::OfflineRenderHost::headless ( )
inlinenoexcept

◆ prepare()

bool pulp::format::OfflineRenderHost::prepare ( const OfflineRenderConfig & config)

◆ prepared()

bool pulp::format::OfflineRenderHost::prepared ( ) const
inlinenoexcept

◆ render() [1/2]

OfflineRenderResult pulp::format::OfflineRenderHost::render ( const OfflineRenderOptions & options)

◆ render() [2/2]

OfflineRenderResult pulp::format::OfflineRenderHost::render ( const OfflineRenderOptions & options,
std::function< bool()> should_continue )

Versioned cancellation/deadline seam for control-thread callers.

The guard runs before each process block; false stops without success.


The documentation for this class was generated from the following file: