cpal/src/emscripten/mod.rs

use std::marker::PhantomData;
use std::os::raw::c_char;
use std::os::raw::c_int;
use std::os::raw::c_void;

use CreationError;
use Format;
use FormatsEnumerationError;
use Sample;
use UnknownTypeBuffer;

extern {
    fn emscripten_set_main_loop_arg(_: extern fn(*mut c_void), _: *mut c_void, _: c_int, _: c_int);
    fn emscripten_run_script(script: *const c_char);
    fn emscripten_run_script_int(script: *const c_char) -> c_int;
}

// The emscripten backend works by having a global variable named `_cpal_audio_contexts`, which
// is an array of `AudioContext` objects. A voice ID corresponds to an entry in this array.
//
// Creating a voice creates a new `AudioContext`. Destroying a voice destroys it.

// TODO: handle latency better ; right now we just use setInterval with the amount of sound data
// that is in each buffer ; this is obviously bad, and also the schedule is too tight and there may
// be underflows

pub struct EventLoop;
impl EventLoop {
    #[inline]
    pub fn new() -> EventLoop {
        EventLoop
    }

    #[inline]
    pub fn run<F>(&self, mut callback: F) -> !
        where F: FnMut(VoiceId, UnknownTypeBuffer)
    {
        unsafe {
            // The `run` function uses `emscripten_set_main_loop_arg` to invoke a Rust callback
            // repeatidely. The job of this callback is to fill the content of the audio buffers.

            // The first argument of the callback function (a `void*`) is a casted pointer to the
            // `callback` parameter that was passed to `run`.

            extern "C" fn callback_fn<F>(callback_ptr: *mut c_void)
                where F: FnMut(VoiceId, UnknownTypeBuffer)
            {
                unsafe {
                    let num_contexts = emscripten_run_script_int("(function() {
                        if (window._cpal_audio_contexts)
                            return window._cpal_audio_contexts.length;
                        else
                            return 0;
                        })()\0".as_ptr() as *const _);

                    // TODO: this processes all the voices, even those from maybe other event loops
                    // this is not a problem yet, but may become one in the future?
                    for voice_id in 0 .. num_contexts {
                        let callback_ptr = &mut *(callback_ptr as *mut F);

                        let buffer = Buffer {
                            temporary_buffer: vec![0.0; 44100 * 2 / 3],
                            voice_id: voice_id,
                            marker: PhantomData,
                        };

                        callback_ptr(VoiceId(voice_id), ::UnknownTypeBuffer::F32(::Buffer { target: Some(buffer) }));
                    }
                }
            }

            let callback_ptr = &mut callback as *mut F as *mut c_void;
            emscripten_set_main_loop_arg(callback_fn::<F>, callback_ptr, 3, 1);
            
            unreachable!()
        }
    }

    #[inline]
    pub fn build_voice(&self, _: &Endpoint, format: &Format)
                       -> Result<VoiceId, CreationError>
    {
        // TODO: find an empty element in the array first, instead of pushing at the end, in case
        // the user creates and destroys lots of voices?

        let num = unsafe {
            emscripten_run_script_int(concat!(r#"(function() {
                if (!window._cpal_audio_contexts)
                    window._cpal_audio_contexts = new Array();
                window._cpal_audio_contexts.push(new AudioContext());
                return window._cpal_audio_contexts.length - 1;
                })()"#, "\0").as_ptr() as *const _)
        };

        Ok(VoiceId(num))
    }

    #[inline]
    pub fn destroy_voice(&self, voice_id: VoiceId) {
        unsafe {
            let script = format!("
                if (window._cpal_audio_contexts)
                    window._cpal_audio_contexts[{}] = null;\0", voice_id.0);
            emscripten_run_script(script.as_ptr() as *const _)
        }
    }

    #[inline]
    pub fn play(&self, voice_id: VoiceId) {
        unsafe {
            let script = format!("
                if (window._cpal_audio_contexts)
                    if (window._cpal_audio_contexts[{v}])
                        window._cpal_audio_contexts[{v}].resume();\0", v = voice_id.0);
            emscripten_run_script(script.as_ptr() as *const _)
        }
    }

    #[inline]
    pub fn pause(&self, voice_id: VoiceId) {
        unsafe {
            let script = format!("
                if (window._cpal_audio_contexts)
                    if (window._cpal_audio_contexts[{v}])
                        window._cpal_audio_contexts[{v}].suspend();\0", v = voice_id.0);
            emscripten_run_script(script.as_ptr() as *const _)
        }
    }
}

// Index within the `_cpal_audio_contexts` global variable in Javascript.
#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct VoiceId(c_int);

// Detects whether the `AudioContext` global variable is available.
fn is_webaudio_available() -> bool {
    unsafe {
        emscripten_run_script_int(concat!(r#"(function() {
                if (!AudioContext) { return 0; } else { return 1; }
            })()"#, "\0").as_ptr() as *const _) != 0
    }
}

// Content is false if the iterator is empty.
pub struct EndpointsIterator(bool);
impl Default for EndpointsIterator {
    fn default() -> EndpointsIterator {
        // We produce an empty iterator if the WebAudio API isn't available.
        EndpointsIterator(is_webaudio_available())
    }
}
impl Iterator for EndpointsIterator {
    type Item = Endpoint;
    #[inline]
    fn next(&mut self) -> Option<Endpoint> {
        if self.0 {
            self.0 = false;
            Some(Endpoint)
        } else {
            None
        }
    }
}

#[inline]
pub fn default_endpoint() -> Option<Endpoint> {
    if is_webaudio_available() {
        Some(Endpoint)
    } else {
        None
    }
}

#[derive(Clone, Debug, PartialEq, Eq)]
pub struct Endpoint;

impl Endpoint {
    #[inline]
    pub fn supported_formats(
        &self)
        -> Result<SupportedFormatsIterator, FormatsEnumerationError> {
        // TODO: right now cpal's API doesn't allow flexibility here
        //       "44100" and "2" (channels) have also been hard-coded in the rest of the code ; if
        //       this ever becomes more flexible, don't forget to change that
        Ok(vec![Format {
            channels: vec![::ChannelPosition::BackLeft, ::ChannelPosition::BackRight],
            samples_rate: ::SamplesRate(44100),
            data_type: ::SampleFormat::F32,
        }].into_iter())
    }

    #[inline]
    pub fn name(&self) -> String {
        "Default endpoint".to_owned()
    }
}

pub type SupportedFormatsIterator = ::std::vec::IntoIter<Format>;

pub struct Buffer<'a, T: 'a> where T: Sample {
    temporary_buffer: Vec<T>,
    voice_id: c_int,
    marker: PhantomData<&'a mut T>,
}

impl<'a, T> Buffer<'a, T> where T: Sample {
    #[inline]
    pub fn buffer(&mut self) -> &mut [T] {
        &mut self.temporary_buffer
    }

    #[inline]
    pub fn len(&self) -> usize {
        self.temporary_buffer.len()
    }

    #[inline]
    pub fn finish(self) {
        unsafe {
            // TODO: **very** slow
            let src_data = self.temporary_buffer.iter().map(|&b| b.to_f32().to_string() + ", ").fold(String::new(), |mut a, b| { a.push_str(&b); a });

            debug_assert_eq!(self.temporary_buffer.len() % 2, 0);       // TODO: num channels

            let script = format!("(function() {{
                    if (!window._cpal_audio_contexts)
                        return;
                    var context = window._cpal_audio_contexts[{voice_id}];
                    if (!context)
                        return;
                    var buffer = context.createBuffer({num_channels}, {buf_len} / {num_channels}, 44100);
                    var src = [{src_data}];
                    for (var channel = 0; channel < {num_channels}; ++channel) {{
                        var buffer_content = buffer.getChannelData(channel);
                        for (var i = 0; i < {buf_len} / {num_channels}; ++i) {{
                            buffer_content[i] = src[i * {num_channels} + channel];
                        }}
                    }}
                    var node = context.createBufferSource();
                    node.buffer = buffer;
                    node.connect(context.destination);
                    node.start();
                }})()\0",
                    num_channels = 2,
                    voice_id = self.voice_id,
                    buf_len = self.temporary_buffer.len(),
                    src_data = src_data);

            emscripten_run_script(script.as_ptr() as *const _)
        }
    }
}