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 98 99 100 101 102 103 104 105 106 107 108 109
//! Rust bindings for JACK, a real-time audio and midi library. //! //! # Server //! //! JACK provides a high priority server to manipulate audio and midi across applications. The rust //! jack crate does not provide server creation functionality, so a server has to be set up with the //! `jackd` commandline tool, `qjackctl` the gui tool, or another method. //! //! # Client //! //! Typically, applications connect clients to the server. For the rust jack crate, a connection can //! be made with `client::Client::new`, which returns a `client::Client`. //! //! The `Client` can query the server for information, register ports, and manage connections for //! ports. //! //! To commence processing audio/midi and other information in real-time, rust jack provides the //! `Client::activate_async`, which consumes the `Client`, an object that implements //! `NotificationHandler` and an object that implements `ProcessHandler` and returns a //! `AsyncClient`. `AsyncClient` processes the data in real-time with the provided handlers. //! //! # Port //! //! A `Client` may obtain port information through the `Client::port_by_id` and //! `Client::port_by_name` methods. These ports can be used to manage connections or to obtain port //! metadata, though their port data (audio buffers and midi buffers) cannot be accessed safely. //! //! Ports can be registered with the `Client::register_port` method. This requires a `PortSpec`. The //! jack crate comes with common specs such as `AudioIn`, `AudioOut`, `MidiIn`, and //! `MidiOut`. //! //! To access the data of registered ports, use their specialized methods within a `ProcessHandler` //! callback. For example, `Port<AudioIn>::as_mut_slice` returns a audio buffer that can be written //! to. pub use crate::client::{ AsyncClient, Client, ClientOptions, ClientStatus, ClosureProcessHandler, CycleTimes, NotificationHandler, ProcessHandler, ProcessScope, CLIENT_NAME_SIZE, }; pub use crate::jack_enums::{Control, Error, LatencyType}; pub use crate::logging::{ error_callback, info_callback, reset_error_callback, reset_info_callback, set_error_callback, set_info_callback, }; pub use crate::port::{ AudioIn, AudioOut, MidiIn, MidiIter, MidiOut, MidiWriter, Port, PortFlags, PortSpec, RawMidi, Unowned, PORT_NAME_SIZE, PORT_TYPE_SIZE, }; pub use crate::primitive_types::{Frames, PortId, Time}; pub use crate::ringbuffer::{RingBuffer, RingBufferReader, RingBufferWriter}; pub use crate::transport::{ Transport, TransportBBT, TransportBBTValidationError, TransportPosition, TransportState, TransportStatePosition, }; //only expose metadata if enabled #[cfg(feature = "metadata")] pub use crate::properties::*; /// Create and manage client connections to a JACK server. mod client; /// Create and manage JACK ring buffers. mod ringbuffer; /// Control error and info logging from JACK. mod logging; /// Enum types in jack. mod jack_enums; mod jack_utils; /// Types for safely interacting with port data from JACK. mod port; /// Platform independent types. mod primitive_types; /// Transport. mod transport; /// Properties mod properties; /// Return JACK's current system time in microseconds, using the JACK clock /// source. pub fn get_time() -> primitive_types::Time { unsafe { jack_sys::jack_get_time() } } #[cfg(test)] mod test { use super::*; use std::{thread, time}; #[test] fn time_can_get_time() { get_time(); } #[test] fn time_is_monotonically_increasing() { let initial_t = get_time(); thread::sleep(time::Duration::from_millis(100)); let later_t = get_time(); assert!(initial_t < later_t, "failed {} < {}", initial_t, later_t); } }