README
U
BackendSpecificError
U
BufferSize
U
BuildStreamError
U
ChannelCount
U
Data
U
DefaultStreamConfigError
U
Device
U
DeviceDescription
U
DeviceDescriptionBuilder
U
DeviceDirection
U
DeviceId
U
DeviceIdError
U
DeviceNameError
U
DeviceTrait
U
DeviceType
U
Devices
U
DevicesError
U
DevicesFiltered
U
Duration
U
FrameCount
U
FromSample
U
Host
U
HostId
U
HostTrait
U
HostUnavailable
U
I24
U
InputCallbackInfo
U
InputDevices
U
InputStreamTimestamp
U
InterfaceType
U
OutputCallbackInfo
U
OutputDevices
U
OutputStreamTimestamp
U
PauseStreamError
U
PlayStreamError
U
Sample
U
SampleFormat
U
SampleRate
U
SizedSample
U
Stream
U
StreamConfig
U
StreamError
U
StreamInstant
U
StreamTrait
U
SupportedBufferSize
U
SupportedInputConfigs
U
SupportedOutputConfigs
U
SupportedStreamConfig
U
SupportedStreamConfigRange
U
SupportedStreamConfigsError
U
U24
V
all_hosts
V
available_hosts
V
common_sample_rates
V
default_host
V
host_from_id
V
sample_cast
V
try_host_from_id

moon_cpal

A MoonBit port (subset) of RustAudio/cpal.

audio

cpal

port

Download zip

Author

moonbit-community

Version

0.11.8

License

Apache-2.0

Repository

github.com/moonbit-community/moon_cpal

Last updated

13 days ago

Downloads

342

#moon_cpal

CPAL-like audio I/O for MoonBit (native-only).

#Install

Add dependency in moon.mod:

{
  "deps": {
    "moonbit-community/moon_cpal": "0.11.6"
  }
}

moon_cpal supports native target only.

#Quick Start (Typed Output Stream)

let host = @moon_cpal.default_host()
let device = match host.default_output_device() {
  Some(d) => d
  None => fail!("no output device")
}
let cfg = try! device.default_output_config()
let stream_cfg = cfg.config()
let stream = try! device.build_output_stream_f32(
  stream_cfg,
  fn(samples, _info) {
    for i = 0; i < samples.length(); i = i + 1 {
      samples[i] = 0.0
    }
  },
  fn(err) { println("stream error: \{err}") },
  None,
)
try! stream.play()

#Quick Start (Raw Output Stream)

Use build_output_stream_raw when you need format-specific writes:

///|
let stream = try! device.build_output_stream_raw(
  stream_cfg,
  cfg.sample_format(),
  fn(data, _info) {
    match data.sample_format() {
      @moon_cpal.SampleFormat::F32 =>
        ignore(data.write_f32(Array::make(data.len(), 0.0)))
      @moon_cpal.SampleFormat::I16 =>
        ignore(data.write_i16(Array::make(data.len(), 0)))
      @moon_cpal.SampleFormat::I24 =>
        ignore(data.write_i24(Array::make(data.len(), @moon_cpal.I24::new(0))))
      _ => data.clear()
    }
  },
  fn(_err) {  },
  None,
)

Data exposes full numeric write APIs: write_i8, write_u8, write_u16, write_i16, write_u24, write_i24, write_u32, write_i32, write_f32, write_u64, write_i64, write_f64.

#Notes

Use stream.pause() / stream.close() to control lifecycle.
Use default_input_device() + build_input_stream_* for capture.

BackendSpecificError

source

using @moonbit-community/moon_cpal/core { type BackendSpecificError }

BufferSize

source

using @moonbit-community/moon_cpal/core { type BufferSize }

The buffer size requests the callback size for audio streams.

Mirrors upstream cpal::BufferSize:

Default uses the host's default callback size.
Fixed(n) requests approximately n frames per callback.

The actual callback size depends on the backend/host implementation and may differ from or vary around the requested size.

BuildStreamError

source

using @moonbit-community/moon_cpal/core { type BuildStreamError }

Error that can happen when creating a stream.

ChannelCount

source

type ChannelCount = Int

Data

source

using @moonbit-community/moon_cpal/spec { type Data }

DefaultStreamConfigError

source

using @moonbit-community/moon_cpal/core { type DefaultStreamConfigError }

May occur when attempting to request the default input or output stream config from a device.

Device

source

using @moonbit-community/moon_cpal/spec { type Device }

DeviceDescription

source

using @moonbit-community/moon_cpal/core { type DeviceDescription }

DeviceDescriptionBuilder

source

using @moonbit-community/moon_cpal/core { type DeviceDescriptionBuilder }

Builder for constructing a DeviceDescription.

This is primarily intended for backend implementations to gradually build up descriptions with whatever metadata is available.

DeviceDirection

source

using @moonbit-community/moon_cpal/core { type DeviceDirection }

DeviceId

source

using @moonbit-community/moon_cpal/core { type DeviceId }

DeviceIdError

source

using @moonbit-community/moon_cpal/core { type DeviceIdError }

DeviceNameError

source

using @moonbit-community/moon_cpal/core { type DeviceNameError }

An error that may occur while attempting to retrieve a device name.

DeviceTrait

source

using @moonbit-community/moon_cpal/traits { trait DeviceTrait }

CPAL-like trait surface (from traits.rs in upstream).

DeviceType

source

using @moonbit-community/moon_cpal/core { type DeviceType }

Devices

source

type Devices = Iter[@moonbit-community/moon_cpal/spec.Device
Device]

Iterator types (upstream exports named iterator structs; here we expose Iter aliases).

DevicesError

source

using @moonbit-community/moon_cpal/core { type DevicesError }

An error that might occur while attempting to enumerate devices.

DevicesFiltered

source

using @moonbitlang/core/builtin { type Iter as DevicesFiltered }

Iterator of devices wrapped in a filter (upstream: DevicesFiltered).

Duration

source

using @moonbit-community/moon_cpal/core { type Duration }

A minimal duration type used by the ported StreamInstant arithmetic.

Upstream uses std::time::Duration (non-negative). Here we keep the same invariant.

FrameCount

source

type FrameCount = Int

FromSample

source

using @moonbit-community/moon_cpal/core { trait FromSample }

Sample and conversion traits/types (from samples_formats.rs in upstream).

Host

source

using @moonbit-community/moon_cpal/spec { type Host }

HostId

source

using @moonbit-community/moon_cpal/core { type HostId }

HostTrait

source

using @moonbit-community/moon_cpal/traits { trait HostTrait }

CPAL-like trait surface (from traits.rs in upstream).

HostUnavailable

source

using @moonbit-community/moon_cpal/core { type HostUnavailable }

I24

source

using @moonbit-community/moon_cpal/core { type I24 }

InputCallbackInfo

source

using @moonbit-community/moon_cpal/core { type InputCallbackInfo }

Information relevant to a single call to the user's input stream data callback.

InputDevices

source

using @moonbitlang/core/builtin { type Iter as InputDevices }

A host's device iterator yielding only input devices (upstream: InputDevices).

InputStreamTimestamp

source

using @moonbit-community/moon_cpal/core { type InputStreamTimestamp }

A timestamp associated with a call to an input stream's data callback.

InterfaceType

source

using @moonbit-community/moon_cpal/core { type InterfaceType }

OutputCallbackInfo

source

using @moonbit-community/moon_cpal/core { type OutputCallbackInfo }

Information relevant to a single call to the user's output stream data callback.

OutputDevices

source

using @moonbitlang/core/builtin { type Iter as OutputDevices }

A host's device iterator yielding only output devices (upstream: OutputDevices).

OutputStreamTimestamp

source

using @moonbit-community/moon_cpal/core { type OutputStreamTimestamp }

A timestamp associated with a call to an output stream's data callback.

PauseStreamError

source

using @moonbit-community/moon_cpal/core { type PauseStreamError }

PlayStreamError

source

using @moonbit-community/moon_cpal/core { type PlayStreamError }

Sample

source

using @moonbit-community/moon_cpal/core { trait Sample }

Sample and conversion traits/types (from samples_formats.rs in upstream).

SampleFormat

source

using @moonbit-community/moon_cpal/core { type SampleFormat }

SampleRate

source

type SampleRate = Int

SizedSample

source

using @moonbit-community/moon_cpal/core { trait SizedSample }

Sample and conversion traits/types (from samples_formats.rs in upstream).

Stream

source

using @moonbit-community/moon_cpal/spec { type Stream }

StreamConfig

source

using @moonbit-community/moon_cpal/core { type StreamConfig }

StreamError

source

using @moonbit-community/moon_cpal/core { type StreamError }

StreamInstant

source

using @moonbit-community/moon_cpal/core { type StreamInstant }

Monotonic timestamp associated with a stream.

StreamTrait

source

using @moonbit-community/moon_cpal/traits { trait StreamTrait }

CPAL-like trait surface (from traits.rs in upstream).

SupportedBufferSize

source

using @moonbit-community/moon_cpal/core { type SupportedBufferSize }

SupportedInputConfigs

source

type SupportedInputConfigs = Iter[@moonbit-community/moon_cpal/core.SupportedStreamConfigRange
SupportedStreamConfigRange]

External iterator type. Iterator[X] is a mutable type: iterators internally maintain mutable state to advance iteration. All read operations on Iterator will advance the iterator, and would give different result when called multiple times.

SupportedOutputConfigs

source

type SupportedOutputConfigs = Iter[@moonbit-community/moon_cpal/core.SupportedStreamConfigRange
SupportedStreamConfigRange]

SupportedStreamConfig

source

using @moonbit-community/moon_cpal/core { type SupportedStreamConfig }

A single supported stream configuration (as opposed to a range).

Mirrors cpal's SupportedStreamConfig shape used by default_*_config.

SupportedStreamConfigRange

source

using @moonbit-community/moon_cpal/core { type SupportedStreamConfigRange }

SupportedStreamConfigsError

source

using @moonbit-community/moon_cpal/core { type SupportedStreamConfigsError }

Error that can happen when enumerating the list of supported configs.

U24

source

using @moonbit-community/moon_cpal/core { type U24 }

all_hosts

source

fn all_hosts() -> Array[@moonbit-community/moon_cpal/core.HostId
HostId]

available_hosts

source

fn available_hosts() -> Array[@moonbit-community/moon_cpal/core.HostId
HostId]

common_sample_rates

source

fn common_sample_rates() -> Array[Int]

Re-export of CPAL common sample rates table.

default_host

source

fn default_host() -> @moonbit-community/moon_cpal/spec.Host
Host

host_from_id

source

fn host_from_id(id : @moonbit-community/moon_cpal/core.HostId
HostId) -> @moonbit-community/moon_cpal/spec.Host
Host raise @moonbit-community/moon_cpal/core.HostUnavailable
HostUnavailable

sample_cast

source

fn[A : @moonbit-community/moon_cpal/core.Sample
Sample, B : @moonbit-community/moon_cpal/core.Sample
Sample] sample_cast(x : A) -> B

Re-export of upstream-like sample conversion helper.

try_host_from_id

source

fn try_host_from_id(id : @moonbit-community/moon_cpal/core.HostId
HostId) -> @moonbit-community/moon_cpal/spec.Host
Host?

Source Files

lib_native.mbt

Site source Report issue Packages Build queue Skills Statistics

moon_cpal

#moon_cpal

#Install

#Quick Start (Typed Output Stream)

#Quick Start (Raw Output Stream)

#Notes

#BackendSpecificError

#BufferSize

#BuildStreamError

#ChannelCount

#Data

#DefaultStreamConfigError

#Device

#DeviceDescription

#DeviceDescriptionBuilder

#DeviceDirection

#DeviceId

#DeviceIdError

#DeviceNameError

#DeviceTrait

#DeviceType

#Devices

#DevicesError

#DevicesFiltered

#Duration

#FrameCount

#FromSample

#Host

#HostId

#HostTrait

#HostUnavailable

#I24

#InputCallbackInfo

#InputDevices

#InputStreamTimestamp

#InterfaceType

#OutputCallbackInfo

#OutputDevices

#OutputStreamTimestamp

#PauseStreamError

#PlayStreamError

#Sample

#SampleFormat

#SampleRate

#SizedSample

#Stream

#StreamConfig

#StreamError

#StreamInstant

#StreamTrait

#SupportedBufferSize

#SupportedInputConfigs

#SupportedOutputConfigs

#SupportedStreamConfig

#SupportedStreamConfigRange

#SupportedStreamConfigsError

#U24

#all_hosts

#available_hosts

#common_sample_rates

#default_host

#host_from_id

#sample_cast

#try_host_from_id

Source Files

BackendSpecificError

BufferSize

BuildStreamError

ChannelCount

Data

DefaultStreamConfigError

Device

DeviceDescription

DeviceDescriptionBuilder

DeviceDirection

DeviceId

DeviceIdError

DeviceNameError

DeviceTrait

DeviceType

Devices

DevicesError

DevicesFiltered

Duration

FrameCount

FromSample

Host

HostId

HostTrait

HostUnavailable

I24

InputCallbackInfo

InputDevices

InputStreamTimestamp

InterfaceType

OutputCallbackInfo

OutputDevices

OutputStreamTimestamp

PauseStreamError

PlayStreamError

Sample

SampleFormat

SampleRate

SizedSample

Stream

StreamConfig

StreamError

StreamInstant

StreamTrait

SupportedBufferSize

SupportedInputConfigs

SupportedOutputConfigs

SupportedStreamConfig

SupportedStreamConfigRange

SupportedStreamConfigsError

U24

all_hosts

available_hosts

common_sample_rates

default_host

host_from_id

sample_cast

try_host_from_id