DSPark 1.8.0
Header-only C++20 DSP for real-time and offline audio
Loading...
Searching...
No Matches
dspark::OfflineJobOptions Struct Reference

Resource and cooperative-cancellation controls for one worker operation. More...

#include <OfflineProcessing.h>

Public Attributes

int blockFrames = 4096
 
std::size_t memoryBudgetBytes = 256u * 1024u * 1024u
 
const std::atomic< bool > * cancel = nullptr
 
void * progressContext = nullptr
 
bool(* progress )(void *, OfflineProgress) = nullptr
 Returning false cancels.
 

Detailed Description

Resource and cooperative-cancellation controls for one worker operation.

memoryBudgetBytes bounds newly requested dynamic payload, including returned analysis/plan storage. It excludes caller-owned input, preexisting output/plans, allocator bookkeeping, stack state and allocations inside source/sink callbacks. Convenience owning renders also account for their provisional output. No hidden thread pool, disk I/O or global cache is created.

Definition at line 134 of file OfflineProcessing.h.

Member Data Documentation

◆ blockFrames

int dspark::OfflineJobOptions::blockFrames = 4096

Definition at line 136 of file OfflineProcessing.h.

◆ cancel

const std::atomic<bool>* dspark::OfflineJobOptions::cancel = nullptr

Definition at line 138 of file OfflineProcessing.h.

◆ memoryBudgetBytes

std::size_t dspark::OfflineJobOptions::memoryBudgetBytes = 256u * 1024u * 1024u

Definition at line 137 of file OfflineProcessing.h.

◆ progress

bool(* dspark::OfflineJobOptions::progress) (void *, OfflineProgress) = nullptr

Returning false cancels.

Definition at line 140 of file OfflineProcessing.h.

◆ progressContext

void* dspark::OfflineJobOptions::progressContext = nullptr

Definition at line 139 of file OfflineProcessing.h.


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