Struct exmod::Context

pub struct Context(_);

Module context.

Can contain only one module and provides functions for manipulating it.

Implementations

impl Context

pub fn new(module: &[u8], rate: u32) -> Result<Self, ContextError>

Create a context.

The module parameter sets a contents of the module. The rate parameter specifies a sample rate (in Hz) with which samples will be generated.

Example

use exmod::Context;

let context = Context::new(include_bytes!("module.xm"), 44100).unwrap();

pub fn as_ptr(&mut self) -> InnerContext

Returns a raw pointer to the inner context.

pub unsafe fn from_ptr(pointer: InnerContext) -> Self

Creates a context directly from the raw pointer of another context.

Safety

Pointer must be previously allocated via new function or it’s equivalent - xm_create_context_safe.

pub fn generate_sample(&mut self, output: &mut [f32])

Play the module and put a generated sample in the output slice.

Requires mutability because generating samples moves a playback cursor within context.

Create silence if the end of the module or the specified loop count is reached.

See examples crate folder for comprehensive example.

pub fn loop_count(&self) -> u8

Get the current number of playback loops of the module.

The number will increase with each loop. When the maximum number of loops is reached, calls to generate_sample will only generate silence. You can set number of loops with set_max_loop_count.

pub fn set_max_loop_count(&mut self, count: u8)

Set the max number of playback loops of the module. See also loop_count.

pub fn number_of_channels(&self) -> u16

Get the number of module channels.

pub fn module_length(&self) -> u16

Get the module length.

pub fn number_of_patterns(&self) -> u16

Get the number of module patterns.

pub fn number_of_rows(&self, pattern: u16) -> Result<u16, OutOfBoundsError>

Get the number of module rows.

pub fn number_of_instruments(&self) -> u16

Get the number of module instruments.

pub fn number_of_samples(
    &self,
    instrument: u16
) -> Result<u16, OutOfBoundsError>

Get the number of module samples.

pub fn panning_of_channel(&self, channel: u16) -> Result<f32, OutOfBoundsError>

Get the panning of specific channel.

pub fn volume_of_channel(&self, channel: u16) -> Result<f32, OutOfBoundsError>

Get the volume of specific channel.

pub fn frequency_of_channel(
    &self,
    channel: u16
) -> Result<f32, OutOfBoundsError>

Get the frequency of specific channel.

pub fn is_channel_active(&self, channel: u16) -> Result<bool, OutOfBoundsError>

Check if the channel is active.

pub fn latest_trigger_of_instrument(
    &self,
    instrument: u16
) -> Result<u64, OutOfBoundsError>

Get the latest trigger of specific instrument.

pub fn latest_trigger_of_sample(
    &self,
    instrument: u16,
    sample: u16
) -> Result<u64, OutOfBoundsError>

Get the latest trigger of specific sample.

pub fn latest_trigger_of_channel(
    &self,
    channel: u16
) -> Result<u64, OutOfBoundsError>

Get the latest trigger of specific channel.

pub fn playing_speed(&self) -> Speed

Get the module playing speed.

pub fn position(&self) -> Position

Get the current playback position.

pub fn mute_channel(
    &mut self,
    channel: u16,
    mute: bool
) -> Result<bool, OutOfBoundsError>

Mute the specific channel.

pub fn mute_instrument(
    &mut self,
    instrument: u16,
    mute: bool
) -> Result<bool, OutOfBoundsError>

Mute the specific instrument.

pub unsafe fn seek(&mut self, pattern_index: u8, row: u8, tick: u16)

Seek the playback cursor to the specified position.

Safety

Seek feature is broken by design and usually leads to access violation error, use at your own risk.

impl Context

pub unsafe fn module_name(&self) -> String

Get the module name.

Safety

The library relies that the module name will be encoded in UTF-8. If not, UB or invalid string is possible.

pub unsafe fn tracker_name(&self) -> String

Get the the name of the tracker in which the module was created.

Safety

The library relies that the tracker name will be encoded in UTF-8. If not, UB or invalid string is possible.

Trait Implementations

impl Drop for Context

fn drop(&mut self)

Executes the destructor for this type.

impl Send for Context

impl Sync for Context