.. _stdlib_strudel_samples:

==================================
Sample bank and audio file loading
==================================

.. das:module:: strudel_samples

Module strudel_samples



++++++++++
Structures
++++++++++

.. _struct-strudel_samples-Sample:

.. das:attribute:: Sample

:Fields: * **data** : array<float> - Interleaved PCM float samples (left, right, left, right, ...).

         * **channels** : int = 1 - Channel count (1 = mono, 2 = stereo).

         * **sample_rate** : int = 48000 - Native sample rate of the decoded audio in Hz.



.. _struct-strudel_samples-SampleBank:

.. das:attribute:: SampleBank

:Fields: * **sounds** : table<string;array< :ref:`Sample <struct-strudel_samples-Sample>`>> - Map from lowercase sound name to its indexed variations (bd:0, bd:1, ...).




+++++++
Loading
+++++++

  *  :ref:`load_audio_file (path: string) : Sample <function-strudel_samples_load_audio_file_string>`
  *  :ref:`load_audio_memory (data: array\<uint8\>) : Sample <function-strudel_samples_load_audio_memory_array_ls_uint8_gr_>`
  *  :ref:`load_sound (path: string; name: string; var bank: SampleBank) <function-strudel_samples_load_sound_string_string_SampleBank>`
  *  :ref:`load_sound_memory (data: array\<uint8\>; name: string; var bank: SampleBank) <function-strudel_samples_load_sound_memory_array_ls_uint8_gr__string_SampleBank>`

.. _function-strudel_samples_load_audio_file_string:

.. das:function:: load_audio_file(path: string) : Sample

Decode a single audio file (WAV/MP3/FLAC/OGG) from disk into a Sample.
Keeps the native channel count (mono or stereo); returns an empty Sample on failure.


:Arguments: * **path** : string

.. _function-strudel_samples_load_audio_memory_array_ls_uint8_gr_:

.. das:function:: load_audio_memory(data: array<uint8>) : Sample

Decode audio bytes (WAV/MP3/FLAC/OGG) from memory into a Sample.
Uses miniaudio's memory decoder with explicit error checking; returns an empty Sample on failure.


:Arguments: * **data** : array<uint8>

.. _function-strudel_samples_load_sound_string_string_SampleBank:

.. das:function:: load_sound(path: string; name: string; bank: SampleBank)

Load a single named sound from a directory of audio files into the bank.
Files are sorted alphabetically so index :0, :1, ... matches strudel's sample indexing.


:Arguments: * **path** : string

            * **name** : string

            * **bank** :  :ref:`SampleBank <struct-strudel_samples-SampleBank>`

.. _function-strudel_samples_load_sound_memory_array_ls_uint8_gr__string_SampleBank:

.. das:function:: load_sound_memory(data: array<uint8>; name: string; bank: SampleBank)

Decode audio bytes and add the result as a single-variation sound in the bank.


:Arguments: * **data** : array<uint8>

            * **name** : string

            * **bank** :  :ref:`SampleBank <struct-strudel_samples-SampleBank>`


+++++++++
Rendering
+++++++++

  *  :ref:`render_sample (bank: SampleBank; name: string; variation: int; speed: float; begin: float = 0f; end_pos: float = 1f) : array\<float\> <function-strudel_samples_render_sample_SampleBank_string_int_float_float_float>`

.. _function-strudel_samples_render_sample_SampleBank_string_int_float_float_float:

.. das:function:: render_sample(bank: SampleBank; name: string; variation: int; speed: float; begin: float = 0f; end_pos: float = 1f) : array<float>

Render a sample slice at the given playback speed as interleaved stereo.
begin/end_pos are normalized [0.0..1.0] slice bounds used by striate/chop/loop_at;
speed resamples via miniaudio and mono input is upmixed to stereo. No gain/pan applied.


:Arguments: * **bank** :  :ref:`SampleBank <struct-strudel_samples-SampleBank>`

            * **name** : string

            * **variation** : int

            * **speed** : float

            * **begin** : float

            * **end_pos** : float