alsa
→
cmd
→
core
→
jack
→
macos
→
null
→
platform
→
spec
→
traits
→
wasapi
→
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

moon add Milky2018/moon_cpal@0.11.8

Download zip

Author

Milky2018

Version

0.11.8

License

Apache-2.0

Repository

github.com/moonbit-community/moon_cpal

Last updated

13 days ago

Downloads

README

#moon_cpal

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

#Install

Add dependency in moon.mod.json:

{
  "deps": {
    "Milky2018/moon_cpal": "0.11.1"
  }
}

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 @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
BufferSize

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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 @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

Error that can happen when creating a stream.

#
ChannelCount

source

type ChannelCount = Int

#
Data

source

using @Milky2018/moon_cpal/spec {type Milky2018/moon_cpal/spec}

#
DefaultStreamConfigError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
Device

source

using @Milky2018/moon_cpal/spec {type Milky2018/moon_cpal/spec}

#
DeviceDescription

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
DeviceDescriptionBuilder

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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 @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
DeviceId

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
DeviceIdError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
DeviceNameError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
DeviceTrait

source

using @Milky2018/moon_cpal/traits {trait Milky2018/moon_cpal/traits}

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

#
DeviceType

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
Devices

source

type Devices = Iter[@Milky2018/moon_cpal/spec.Device
Device]

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

#
DevicesError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

An error that might occur while attempting to enumerate devices.

#
DevicesFiltered

source

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

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

#
Duration

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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 @Milky2018/moon_cpal/core {trait Milky2018/moon_cpal/core}

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

#
Host

source

using @Milky2018/moon_cpal/spec {type Milky2018/moon_cpal/spec}

#
HostId

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
HostTrait

source

using @Milky2018/moon_cpal/traits {trait Milky2018/moon_cpal/traits}

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

#
HostUnavailable

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
I24

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
InputCallbackInfo

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
InputDevices

source

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

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

#
InputStreamTimestamp

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
InterfaceType

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
OutputCallbackInfo

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
OutputDevices

source

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

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

#
OutputStreamTimestamp

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
PauseStreamError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
PlayStreamError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
Sample

source

using @Milky2018/moon_cpal/core {trait Milky2018/moon_cpal/core}

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

#
SampleFormat

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
SampleRate

source

type SampleRate = Int

#
SizedSample

source

using @Milky2018/moon_cpal/core {trait Milky2018/moon_cpal/core}

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

#
Stream

source

using @Milky2018/moon_cpal/spec {type Milky2018/moon_cpal/spec}

#
StreamConfig

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
StreamError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
StreamInstant

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

Monotonic timestamp associated with a stream.

#
StreamTrait

source

using @Milky2018/moon_cpal/traits {trait Milky2018/moon_cpal/traits}

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

#
SupportedBufferSize

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
SupportedInputConfigs

source

type SupportedInputConfigs = Iter[@Milky2018/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[@Milky2018/moon_cpal/core.SupportedStreamConfigRange
SupportedStreamConfigRange]

#
SupportedStreamConfig

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

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

#
SupportedStreamConfigRange

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
SupportedStreamConfigsError

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

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

#
U24

source

using @Milky2018/moon_cpal/core {type Milky2018/moon_cpal/core}

#
all_hosts

source

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

#
available_hosts

source

fn available_hosts() -> Array[@Milky2018/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() -> @Milky2018/moon_cpal/spec.Host
Host

#
host_from_id

source

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

#
sample_cast

source

fn[A : @Milky2018/moon_cpal/core.Sample
Sample, B : @Milky2018/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 : @Milky2018/moon_cpal/core.HostId
HostId) -> @Milky2018/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