|
coastline 0.0.4
|
Common event playback state with overridable media, device, and stream operations. More...
#include <earplayback.h>


Public Member Functions | |
| ~EarPlayback () | |
| Invoke the base finalisation hook without releasing playback resources or derived storage. | |
| void | SetEarPlaybackFlags (std::uint16_t flags) |
| Store source flags without validation or reinitialisation. | |
| int | GetStatus () |
| int | IsActive () |
| void | MarkComplete () |
| Request completion for the next completion check without stopping the device immediately. | |
| int | GetEarPlaybackMute () |
| int | IsEarPlaybackStreaming () |
| int | ResetPlaybackCompletion () |
| Withdraw a request to complete the playback. | |
| void | ClearPlaybackCompletion () |
| Withdraw a request to complete the playback. | |
| virtual void | ReleaseEarPlaybackResources () |
| Release registered playback through the virtual closure hook. | |
| virtual void | SetEarPlaybackDirectionalMatrix (std::uint16_t direction, std::uint16_t matrix) |
| Store directional matrix identifiers without resolving an entry or updating output. | |
| virtual void | SetEarPlaybackDirectionalGain (std::uint16_t direction, double gain, std::uint16_t matrix) |
| Update cached directional gain for registered playback and restart active smoothing. | |
| virtual void | ProcessEarPlaybackSmoothing () |
| Apply a frequency, gain, and pan smoothing pass to the current device buffer. | |
| virtual void | SetPlaybackSuppressionParameters (std::uint32_t enabled, std::uint16_t marker) |
| Store suppression controls without starting or stopping playback. | |
| virtual void | SetEarPlaybackStartPosition (double position) |
| Store an ordered nonzero start position and mark it specified; zero and NaN are ignored. | |
| virtual void | SetEarPlaybackStartMilliseconds (std::uint16_t milliseconds) |
| Store an absolute start offset for wave-stream preparation. | |
| virtual void | SetReservedPlaybackEventControl (std::uint32_t control) |
| Store a backend-specific event control value without applying it immediately. | |
| virtual int | InitializeEarPlayback (const void *source, int streaming, int looping) |
| Initialise implementation-specific media; the base implementation does not change state. | |
| virtual int | StartEarPlayback () |
| Post an enabled start notification, attempt device playback, and mark successful starts active. | |
| virtual int | PauseEarPlayback () |
| Mark playback paused and attempt to stop the device buffer without clearing active state. | |
| virtual int | ResumeEarPlayback () |
| Attempt a restart when paused and active, then clear paused status. | |
| virtual void | CompleteEarPlayback () |
| Perform implementation-specific completion; the base implementation does not change state. | |
| virtual void | ApplyPreset (EarWaveSample *preset) |
| Apply implementation-specific preset data; the base implementation ignores the request. | |
| virtual std::uint32_t | GetEarPlaybackMediaLength () |
| virtual void | SetEarPlaybackMute (int muted) |
| Store mute state and refresh cached directional gain without stopping playback or timers. | |
| virtual void | SetBackendPlaybackOverrideEnabled (int enabled) |
| Store the implementation-specific playback override marker. | |
| virtual void | SetEarPlaybackFrequencyScale (double scale) |
| Clamp an ordered changed scale to 0..6.5535 and recalculate frequency from the base rate. | |
| virtual void | SetEarPlaybackBaseFrequencyScale (double scale) |
| Store the initial frequency multiplier without validation or device updates. | |
| virtual void | SetCachedBackendPlaybackParameter (double value) |
| Store an ordered changed backend parameter and invoke the parameter-change hook. | |
| virtual int | IsBufferedEarPlaybackComplete () |
| Check requested completion or active device state and refill a stream half when necessary. | |
| virtual void | SetEarPlaybackLooping (int enabled) |
| Store looping state without changing the currently playing buffer's device flags. | |
| virtual void | SetEarPlaybackNotification (std::uint32_t flags, std::uint16_t event) |
| Store notification controls for later playback transitions. | |
Protected Member Functions | |
| virtual void | CloseRegisteredEarPlayback () |
| Stop and release a registered buffer, post an enabled closure notification, and unregister playback. | |
| virtual void | OnPlaybackWaveSampleAttached (EarWaveSample *sample) |
| Respond to sample attachment; the base implementation ignores the notification. | |
| virtual int | IsDirectSoundBufferStopped () |
| Query the device buffer; a non-null buffer is required. | |
| EarPlayback () | |
| Initialise inactive playback and smoothing defaults without allocating media or a buffer. | |
| void | SetPlaybackBufferBytes (std::uint32_t bytes) |
| Store buffer capacity without reallocating storage. | |
| void | SetStreamHalfBytes (std::uint32_t bytes) |
| Store the refill-half capacity without changing the buffer. | |
| void | DisablePlaybackStreaming () |
| Clear the streaming marker without changing device looping flags. | |
| std::uint16_t | GetPlaybackStartMilliseconds () const |
| bool | HasPlaybackStartPosition () const |
| void | SpecifyPlaybackStartPosition () |
| Mark the stored start position specified without changing its value. | |
| void | SetPlaybackStreamingAndLooping (int isStreaming, int isLooping) |
| Store stream and loop markers without validation or device changes. | |
| double | GetPlaybackBaseFrequencyScale () const |
| void | SetPlaybackBaseFrequency (std::uint32_t value) |
| Store base frequency without updating the current device frequency. | |
| void | SetPlaybackHandle (std::uint32_t handle) |
| Store a registration handle without modifying the playback registry. | |
| std::uint32_t | GetPlaybackHandle () const |
| HRESULT | CreateDirectSoundPlaybackBuffer (IDirectSound *device, _DSBUFFERDESC *description) |
| Create a Windows device buffer; an existing buffer must be released before replacement. | |
| void | ResetPlaybackBufferFrequency () |
| Reset current frequency to the initialised base frequency without updating the device. | |
| std::uint32_t | GetPlaybackBufferBytes () const |
| bool | HasNonStreamingStartPosition () const |
| double | GetPlaybackStartPosition () const |
| void | ClearPlaybackStartPosition () |
| Clear the specified marker and reset the start position to zero. | |
| EarDirectSoundPlaybackState::Buffer * | GetDirectSoundBuffer () const |
| std::uint32_t | IncrementLoopDrainCount () |
| void | EndStreamingPlaybackLoop () |
| Clear both loop and stream markers without stopping the device immediately. | |
| std::uint16_t | GetPlaybackSourceFlags () const |
| bool | IsPlaybackLooping () const |
| bool | HasPlaybackHandle () const |
| void | DisablePlaybackLooping () |
| Clear the looping marker without changing device playback flags. | |
| std::uint32_t | GetStreamHalfIndex () const |
| std::uint32_t | GetStreamHalfBytes () const |
| void | FlipStreamHalfIndex () |
| Toggle the refill-half index between zero and one. | |
Protected Attributes | |
| std::uint32_t | playbackHandle |
| Playback registry key, or zero when unregistered. | |
| std::uint32_t | reservedEventControl |
| Implementation-specific event control, including in-memory MIDI source length in bytes. | |
| std::uint32_t | notificationFlags |
| Notification bits for starts (1) and registered closures (2). | |
| std::uint16_t | notificationEvent |
| Event identifier included in window notifications. | |
| std::uint16_t | flags |
| Source flags interpreted by derived media implementations; base construction omits them. | |
| int | looping |
| Nonzero while looping is requested. | |
| int | streaming |
| Nonzero while media requires half-buffer refills. | |
| int | completionRequested |
| Nonzero after completion is requested or detected. | |
| std::uint32_t | streamHalfIndex |
| Next streaming half to refill, initially one. | |
| int | active |
| Nonzero after successful playback starts, including during a pause. | |
| int | muted |
| Nonzero when muted; cached gain remains available for unmuting. | |
| int | status |
| Pause status, zero when unpaused. | |
| int | backendOverrideEnabled |
| Nonzero when implementation-specific position or frequency overrides are enabled. | |
| std::uint32_t | suppressionEnabled |
| Nonzero when spatial suppression processing is enabled. | |
| int | startPositionSpecified |
| Nonzero when startPosition is specified rather than merely stored. | |
| std::uint16_t | suppressionMarker |
| Suppression role, with one suppressing base device starts. | |
| std::uint16_t | startMilliseconds |
| Wave-stream initial offset in milliseconds, or zero when disabled. | |
| std::uint16_t | matrixId |
| Selected directional matrix handle, initially 16. | |
| std::uint16_t | directionIndex |
| Selected directional row index, normally 0..127. | |
| double | previousGain |
| Linear gain at the start of the current smoothing transition. | |
| double | targetGain |
| Target linear gain before directional and master attenuation. | |
| EarDirectionalMatrixEntry | previousMatrixEntry |
| Directional pan and gain at the start of the current smoothing transition. | |
| EarDirectionalMatrixEntry | targetMatrixEntry |
| Target directional pan and gain resolved from the selected matrix. | |
| std::uint32_t | frequency |
| Target sample frequency in hertz before device range clamping. | |
| std::uint32_t | previousFrequency |
| Sample frequency in hertz at the start of the smoothing transition. | |
| std::uint8_t | unknown6c [2] |
| Unrecovered bytes retained at the original object offset. | |
| std::uint16_t | smoothingPass |
| Smoothing pass index; zero selects the target directly. | |
| std::uint32_t | bufferBytes |
| Decoded device sample-buffer capacity in bytes. | |
| std::uint32_t | streamHalfBytes |
| Decoded byte count in each streaming half. | |
| double | startPosition |
| Implementation-specific start position, usually a fraction of media length. | |
| double | frequencyScale |
| Current dimensionless playback frequency multiplier. | |
| double | baseFrequencyScale |
| Initial frequency multiplier applied while preparing media. | |
| std::uint32_t | baseFrequency |
| Initial sample frequency in hertz; derived initialisation must assign it. | |
| double | cachedBackendParameter |
| Cached implementation-specific parameter, initially -1. | |
| std::uint32_t | loopDrainCount |
| Number of post-data streaming refills used while draining non-looping playback. | |
| EarDirectSoundPlaybackState | directSound |
| Device buffer reference and cached byte cursors; resource release is explicit. | |
Common event playback state with overridable media, device, and stream operations.
ReleaseEarPlaybackResources() must run before destruction to release device resources. The destructor is non-virtual and does not release registered playback by itself.
| EarPlayback::~EarPlayback | ( | ) |
Invoke the base finalisation hook without releasing playback resources or derived storage.
|
protected |
Initialise inactive playback and smoothing defaults without allocating media or a buffer.
Derived initialisation must set source flags and base frequency before reading them.
| void EarPlayback::SetEarPlaybackFlags | ( | std::uint16_t | flags | ) |
Store source flags without validation or reinitialisation.
| flags | The source and resource-management flag bits for the media implementation. |
| int EarPlayback::GetStatus | ( | ) |
| int EarPlayback::IsActive | ( | ) |
| void EarPlayback::MarkComplete | ( | ) |
Request completion for the next completion check without stopping the device immediately.
| int EarPlayback::GetEarPlaybackMute | ( | ) |
| int EarPlayback::IsEarPlaybackStreaming | ( | ) |
| int EarPlayback::ResetPlaybackCompletion | ( | ) |
Withdraw a request to complete the playback.
| void EarPlayback::ClearPlaybackCompletion | ( | ) |
Withdraw a request to complete the playback.
|
virtual |
Release registered playback through the virtual closure hook.
Derived implementations also release their media storage here.
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Store directional matrix identifiers without resolving an entry or updating output.
| direction | The directional row index, normally 0..127. |
| matrix | The built-in or registered matrix handle. |
|
virtual |
Update cached directional gain for registered playback and restart active smoothing.
Output changes during ProcessEarPlaybackSmoothing(). Muted playback preserves cached gain. Unregistered playback ignores the request. Negative gain is not clamped; NaN can be stored when the direction or matrix changes but otherwise does not trigger an update.
| direction | The directional row index, normally 0..127. |
| gain | The linear gain; values above one request the previously cached gain. |
| matrix | The built-in or registered matrix handle. |
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Apply a frequency, gain, and pan smoothing pass to the current device buffer.
Inactive playback resets the pass counter. Global smoothing settings determine progression.
|
virtual |
Store suppression controls without starting or stopping playback.
| enabled | The suppression-enable marker, with zero disabling suppression. |
| marker | The suppression role; one suppresses base device starts when enabled. |
|
virtual |
Store an ordered nonzero start position and mark it specified; zero and NaN are ignored.
| position | The backend-specific position, usually a fraction of media length. |
|
virtual |
Store an absolute start offset for wave-stream preparation.
| milliseconds | The start offset in milliseconds; zero disables the offset. |
|
virtual |
Store a backend-specific event control value without applying it immediately.
| control | The control value, used as a byte count for an in-memory MIDI source. |
|
virtual |
Initialise implementation-specific media; the base implementation does not change state.
| source | The implementation-specific source representation, unused by the base. |
| streaming | The requested streaming marker, unused by the base. |
| looping | The requested looping marker, unused by the base. |
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Post an enabled start notification, attempt device playback, and mark successful starts active.
Enabled suppression with role one reports success without starting the base device buffer.
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Mark playback paused and attempt to stop the device buffer without clearing active state.
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Attempt a restart when paused and active, then clear paused status.
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
protectedvirtual |
Stop and release a registered buffer, post an enabled closure notification, and unregister playback.
An absent playback handle suppresses all closure work.
Reimplemented in CdAudioPlayback, MidiPlayback, and PcmWaveStream.
|
virtual |
Perform implementation-specific completion; the base implementation does not change state.
|
virtual |
Apply implementation-specific preset data; the base implementation ignores the request.
| preset | The preset, unused. |
|
protectedvirtual |
Respond to sample attachment; the base implementation ignores the notification.
| sample | The borrowed sample pointer, unused by the base. |
|
virtual |
Reimplemented in CdAudioPlayback.
|
virtual |
Store mute state and refresh cached directional gain without stopping playback or timers.
| muted | The mute marker, with nonzero indicating mute. |
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
virtual |
Store the implementation-specific playback override marker.
| enabled | The override marker, with nonzero indicating enabled. |
|
virtual |
Clamp an ordered changed scale to 0..6.5535 and recalculate frequency from the base rate.
Unordered comparisons preserve the existing value. Output updates during smoothing.
| scale | The dimensionless frequency multiplier; base frequency must be initialised. |
|
virtual |
Store the initial frequency multiplier without validation or device updates.
| scale | The dimensionless multiplier applied during derived media initialisation. |
|
virtual |
Store an ordered changed backend parameter and invoke the parameter-change hook.
Unordered comparisons preserve the existing value.
| value | The implementation-specific parameter, without validation. |
|
virtual |
Check requested completion or active device state and refill a stream half when necessary.
Non-streaming looping playback and inactive playback do not complete without a request.
Reimplemented in CdAudioPlayback, and MidiPlayback.
|
protectedvirtual |
Query the device buffer; a non-null buffer is required.
|
virtual |
Store looping state without changing the currently playing buffer's device flags.
| enabled | The looping marker, with nonzero indicating enabled. |
|
virtual |
Store notification controls for later playback transitions.
| flags | Bit zero enables start messages; bit one enables registered-closure messages. |
| event | The event identifier included in notification messages. |
|
inlineprotected |
Store buffer capacity without reallocating storage.
| bytes | The total decoded sample-buffer capacity in bytes. |
|
inlineprotected |
Store the refill-half capacity without changing the buffer.
| bytes | The decoded byte count in each streaming half. |
|
inlineprotected |
Clear the streaming marker without changing device looping flags.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Mark the stored start position specified without changing its value.
|
inlineprotected |
Store stream and loop markers without validation or device changes.
| isStreaming | The streaming marker, with nonzero indicating enabled. |
| isLooping | The looping marker, with nonzero indicating enabled. |
|
inlineprotected |
|
inlineprotected |
Store base frequency without updating the current device frequency.
| value | The base sample rate in hertz. |
|
inlineprotected |
Store a registration handle without modifying the playback registry.
| handle | The playback handle, or zero for unregistered playback. |
|
inlineprotected |
|
protected |
Create a Windows device buffer; an existing buffer must be released before replacement.
| device | The non-null borrowed DirectSound device used for creation. |
| description | The non-null buffer descriptor required by DirectSound. |
|
inlineprotected |
Reset current frequency to the initialised base frequency without updating the device.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Clear the specified marker and reset the start position to zero.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Clear both loop and stream markers without stopping the device immediately.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Clear the looping marker without changing device playback flags.
|
inlineprotected |
|
inlineprotected |
|
inlineprotected |
Toggle the refill-half index between zero and one.
|
protected |
Playback registry key, or zero when unregistered.
|
protected |
Implementation-specific event control, including in-memory MIDI source length in bytes.
|
protected |
Notification bits for starts (1) and registered closures (2).
|
protected |
Event identifier included in window notifications.
|
protected |
Source flags interpreted by derived media implementations; base construction omits them.
|
protected |
Nonzero while looping is requested.
|
protected |
Nonzero while media requires half-buffer refills.
|
protected |
Nonzero after completion is requested or detected.
|
protected |
Next streaming half to refill, initially one.
|
protected |
Nonzero after successful playback starts, including during a pause.
|
protected |
Nonzero when muted; cached gain remains available for unmuting.
|
protected |
Pause status, zero when unpaused.
|
protected |
Nonzero when implementation-specific position or frequency overrides are enabled.
|
protected |
Nonzero when spatial suppression processing is enabled.
|
protected |
Nonzero when startPosition is specified rather than merely stored.
|
protected |
Suppression role, with one suppressing base device starts.
|
protected |
Wave-stream initial offset in milliseconds, or zero when disabled.
|
protected |
Selected directional matrix handle, initially 16.
|
protected |
Selected directional row index, normally 0..127.
|
protected |
Linear gain at the start of the current smoothing transition.
|
protected |
Target linear gain before directional and master attenuation.
|
protected |
Directional pan and gain at the start of the current smoothing transition.
|
protected |
Target directional pan and gain resolved from the selected matrix.
|
protected |
Target sample frequency in hertz before device range clamping.
|
protected |
Sample frequency in hertz at the start of the smoothing transition.
|
protected |
Unrecovered bytes retained at the original object offset.
|
protected |
Smoothing pass index; zero selects the target directly.
|
protected |
Decoded device sample-buffer capacity in bytes.
|
protected |
Decoded byte count in each streaming half.
|
protected |
Implementation-specific start position, usually a fraction of media length.
|
protected |
Current dimensionless playback frequency multiplier.
|
protected |
Initial frequency multiplier applied while preparing media.
|
protected |
Initial sample frequency in hertz; derived initialisation must assign it.
|
protected |
Cached implementation-specific parameter, initially -1.
|
protected |
Number of post-data streaming refills used while draining non-looping playback.
|
protected |
Device buffer reference and cached byte cursors; resource release is explicit.