cpal 0.18.2

Low-level cross-platform audio I/O library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! Background real-time thread promotion.

use std::{
    sync::{
        atomic::{AtomicBool, AtomicU32, Ordering},
        Arc,
    },
    thread::{self, JoinHandle, Thread},
};

use crate::{
    host::{emit_error, ErrorCallbackArc},
    Error, ErrorKind, FrameCount, SampleRate,
};

pub(crate) struct RtPromoter {
    pending_frames: Arc<AtomicU32>,
    shutdown: Arc<AtomicBool>,
    handle: Thread,
    join: Option<JoinHandle<()>>,
}

impl RtPromoter {
    /// Must be called on the thread that will run the audio callbacks: `get_current_thread_info`
    /// captures the calling thread's identity, to promote later from the background thread.
    pub(crate) fn spawn(error_callback: ErrorCallbackArc, rate: SampleRate) -> Option<Self> {
        let thread_info = match audio_thread_priority::get_current_thread_info() {
            Ok(info) => info,
            Err(e) => {
                emit_error(&error_callback, Error::from(e));
                return None;
            }
        };

        let pending_frames = Arc::new(AtomicU32::new(0));
        let shutdown = Arc::new(AtomicBool::new(false));
        let pending_frames_bg = pending_frames.clone();
        let shutdown_bg = shutdown.clone();
        let error_callback_bg = error_callback.clone();

        let join = thread::Builder::new()
            .name("cpal_rt_promote".to_owned())
            .spawn(move || loop {
                if shutdown_bg.load(Ordering::Relaxed) {
                    return;
                }
                let frames = pending_frames_bg.swap(0, Ordering::Relaxed);
                if frames != 0 {
                    if let Err(e) = audio_thread_priority::promote_thread_to_real_time(
                        thread_info,
                        frames,
                        rate,
                    ) {
                        emit_error(&error_callback_bg, Error::from(e));
                    }
                    continue;
                }
                thread::park();
            });
        let join = match join {
            Ok(j) => j,
            Err(e) => {
                emit_error(
                    &error_callback,
                    Error::with_message(
                        ErrorKind::ResourceExhausted,
                        format!("failed to create real-time promotion thread: {e}"),
                    ),
                );
                return None;
            }
        };

        Some(Self {
            pending_frames,
            shutdown,
            handle: join.thread().clone(),
            join: Some(join),
        })
    }

    /// Hands a promotion request to the background thread; never blocks.
    pub(crate) fn request(&self, frames: FrameCount) {
        self.pending_frames.store(frames, Ordering::Relaxed);
        self.handle.unpark();
    }
}

impl Drop for RtPromoter {
    fn drop(&mut self) {
        self.shutdown.store(true, Ordering::Relaxed);
        self.handle.unpark();
        if let Some(join) = self.join.take() {
            let _ = join.join();
        }
    }
}