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 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388
//! # sunvox-sys //! //! FFI bindings to the Sunvox library (http://warmplace.ru/soft/sunvox). // --- Crate attributes --- // #![allow(non_camel_case_types)] // --- ==== --- // // --- External crates --- // extern crate libc; // --- ==== --- // // --- Use --- // use libc::{c_void, c_int, c_uint, c_char, c_uchar, c_short, c_ushort}; // --- ==== --- // /// Single note off. pub const NOTECMD_NOTE_OFF: c_int = 128; /// Notes of all synths off. pub const NOTECMD_ALL_NOTES_OFF: c_int = 129; /// Stop and clean all synths. pub const NOTECMD_CLEAN_SYNTHS: c_int = 130; pub const NOTECMD_STOP: c_int = 131; pub const NOTECMD_PLAY: c_int = 132; // I can't find these in the official header file, but they're defined in // https://github.com/metrasynth/sunvox-dll-python/blob/master/sunvox/types.py /// Change the pitch of a currently playing note. pub const NOTECMD_SET_PITCH: c_int = 133; /// Apply effect in this note cell to the corresponding one in the previous track. pub const NOTECMD_PREV_TRACK: c_int = 134; /// A single note cell in a pattern. #[repr(C)] #[derive(Clone, Debug)] pub struct sunvox_note { /// The note column. /// /// - 0: Nothing. /// - 1 to 127 inclusive: A normal note. /// - 128+: See the `NOTECMD` constants. pub note: c_uchar, /// The velocity column (note velocity). /// /// - 0: Empty (default). /// - 1 to 129 inclusive: The specified velocity + 1. pub vel: c_uchar, /// The module column (module to affect). /// /// - 0: Empty (none). /// - 1 to 255 inclusive: The specified module + 1. pub module: c_uchar, /// Padding. pub nothing: c_uchar, /// The value of the controller/effect column. /// /// Interpreted as a hexadecimal number, the first two digits are the /// controller of the selected module to affect, and the last two digits /// are the number of an effect. Set a pair of digits to zero to /// ignore that part. pub ctl: c_ushort, /// The value of the controller/effect parameter column. pub ctl_val: c_ushort, } /// Supresses debug output from the SunVox library. pub const SV_INIT_FLAG_NO_DEBUG_OUTPUT: c_uint = 1 << 0; /// Interaction with sound card is on the user side. /// /// See `sv_audio_callback()`. pub const SV_INIT_FLAG_USER_AUDIO_CALLBACK: c_uint = 1 << 1; /// Audio is signed 16-bit (`c_short`). pub const SV_INIT_FLAG_AUDIO_INT16: c_uint = 1 << 2; /// Audio is float (`c_float`). pub const SV_INIT_FLAG_AUDIO_FLOAT32: c_uint = 1 << 3; /// Audio callback and song modification functions are in a single thread. pub const SV_INIT_FLAG_ONE_THREAD: c_uint = 1 << 4; pub const SV_MODULE_FLAG_EXISTS: c_int = 1; pub const SV_MODULE_FLAG_EFFECT: c_int = 2; pub const SV_MODULE_INPUTS_OFF: c_int = 16; pub const SV_MODULE_INPUTS_MASK: c_int = 255 << SV_MODULE_INPUTS_OFF; pub const SV_MODULE_OUTPUTS_OFF: c_int = 16 + 8; pub const SV_MODULE_OUTPUTS_MASK: c_int = 255 << SV_MODULE_OUTPUTS_OFF; pub const SV_STYPE_INT16: c_int = 0; pub const SV_STYPE_INT32: c_int = 1; pub const SV_STYPE_FLOAT32: c_int = 2; pub const SV_STYPE_FLOAT64: c_int = 3; #[link(name = "sunvox")] extern "C" { /// Gets the next piece of SunVox audio. /// /// With `sv_audio_callback()` you can ignore the built-in SunVox sound /// output mechanism and use some other sound system. Set the /// `SV_INIT_FLAG_USER_AUDIO_CALLBACK` flag when calling `sv_init()` if /// you want to use this function. /// /// # Parameters /// /// - buf: Destination buffer. If `SV_INIT_FLAG_AUDIO_INT16` was passed to /// `sv_init()`, this is a buffer of `c_short`s. If `SV_INIT_FLAG_AUDIO_FLOAT32` /// was passed, this is a buffer of `c_float`s. Stereo data will be interleaved /// in this buffer: LRLR... ; where the LR is one frame (Left+Right channels). /// - frames: Number of frames in destination buffer. /// - latency: Audio latency (in frames). /// - out_time: Output time (in ticks). /// /// The `out_time` parameter is elaborated on a little bit in this thread: /// http://www.warmplace.ru/forum/viewtopic.php?f=12&t=4152 /// /// For normal use, pass the value of `sv_get_ticks()`, as detailed in that /// thread. pub fn sv_audio_callback(buf: *mut c_void, frames: c_int, latency: c_int, out_time: c_uint) -> c_int; /// Opens a slot. /// /// A slot is like an instance of the SunVox engine. Each slot can have a /// single project loaded at a time. The library supports up to four slots, /// 0 to 3 inclusive. This call appears to hang if called with a number /// outside this range. /// /// Returns 0 on success, -1 on failure. Failure conditions include the /// slot already being open. /// /// I say "like" an instance of the engine because I think all slots share /// the same tick counter, which you can get by calling `sv_get_ticks()`. pub fn sv_open_slot(slot: c_int) -> c_int; /// Closes a slot. See `sv_open_slot()` for more details. pub fn sv_close_slot(slot: c_int) -> c_int; /// Locks a slot. /// /// There are a few functions that need to be called between a /// `sv_lock_slot()`/`sv_unlock_slot()` pair. These are marked with /// "USE LOCK/UNLOCK!". pub fn sv_lock_slot(slot: c_int) -> c_int; /// Unlocks a slot. See `sv_lock_slot()` for more details. pub fn sv_unlock_slot(slot: c_int) -> c_int; /// Initializes the library. /// /// The `flags` parameter takes either zero (for default options), or a /// number of `SV_INIT_FLAG_xxx` constants ORed together. pub fn sv_init(dev: *const c_char, freq: c_int, channels: c_int, flags: c_uint) -> c_int; /// Deinitializes the library. pub fn sv_deinit() -> c_int; /// Gets the internal sample type of the SunVox engine. /// /// Returns one of the `SV_STYPE_xxx` constants. /// /// Use it to get the scope buffer type from `get_module_scope()` function. pub fn sv_get_sample_type() -> c_int; /// Loads a SunVox project file into the specified slot. pub fn sv_load(slot: c_int, name: *const c_char) -> c_int; /// Loads a SunVox project from file data in memory. TEST pub fn sv_load_from_memory(slot: c_int, data: *mut c_void, data_size: c_uint) -> c_int; /// Starts playing the project from the current play cursor position. pub fn sv_play(slot: c_int) -> c_int; /// Starts playing the project from the beginning. pub fn sv_play_from_beginning(slot: c_int) -> c_int; /// Stops playing the project. The play cursor stays where it is. pub fn sv_stop(slot: c_int) -> c_int; /// Enables or disables autostop. /// /// - 0: Disable autostop. /// - 1: Enable autostop. /// /// When disabled, the project plays in a loop. pub fn sv_set_autostop(slot: c_int, autostop: c_int) -> c_int; /// Gets whether the project is stopped (ie. not playing). /// /// Returns 0 if it is playing, 1 if it is stopped. pub fn sv_end_of_song(slot: c_int) -> c_int; /// Rewinds the project to the beginning. pub fn sv_rewind(slot: c_int, line_num: c_int) -> c_int; /// Sets the volume of the project. pub fn sv_volume(slot: c_int, vol: c_int) -> c_int; /// Causes an event to occur as though it had been played in a pattern. /// /// `track_num` is in the range 0 to 15 inclusive, and refers to the track /// number in a special hidden pattern. pub fn sv_send_event(slot: c_int, track_num: c_int, note: c_int, vel: c_int, module: c_int, ctl: c_int, ctl_val: c_int) -> c_int; /// Gets the line number of the play cursor. pub fn sv_get_current_line(slot: c_int) -> c_int; /// Gets the line number of the play in fixed point format: 27.5 /// /// TODO: Figure out exactly what this means. /// I'm guessing it means 27 bits for the integer part and 5 bits for the /// fractional part. pub fn sv_get_current_line2(slot: c_int) -> c_int; /// Gets the current signal level/amplitude for a given audio channel /// in the range 0 to 255 inclusive. pub fn sv_get_current_signal_level(slot: c_int, channel: c_int) -> c_int; /// Gets the name of the currently loaded project. /// /// Returns NULL if no project is loaded. pub fn sv_get_song_name(slot: c_int) -> *const c_char; /// Gets the Beats Per Minute of the currently loaded project. /// /// Returns zero if no project is loaded. pub fn sv_get_song_bpm(slot: c_int) -> c_int; /// Gets the Ticks Per Line of the currently loaded project. /// /// Returns zero if no project is loaded. pub fn sv_get_song_tpl(slot: c_int) -> c_int; /// Gets the currently loaded song's length in audio samples/frames. pub fn sv_get_song_length_frames(slot: c_int) -> c_uint; /// Gets the currently loaded song's length in pattern lines. pub fn sv_get_song_length_lines(slot: c_int) -> c_uint; /// Creates a new module. USE LOCK/UNLOCK! pub fn sv_new_module(slot: c_int, _type: *const c_char, name: *const c_char, x: c_int, y: c_int, z: c_int) -> c_int; /// Removes the specified module. USE LOCK/UNLOCK! pub fn sv_remove_module(slot: c_int, mod_num: c_int) -> c_int; /// Connects the source to the destination. USE LOCK/UNLOCK! pub fn sv_connect_module(slot: c_int, source: c_int, destination: c_int) -> c_int; /// Disconnects the source from the destination. USE LOCK/UNLOCK! pub fn sv_disconnect_module(slot: c_int, source: c_int, destination: c_int) -> c_int; /// Loads a module. /// /// Supported file formats: `sunsynth`, `xi`, `wav`, `aiff` pub fn sv_load_module(slot: c_int, file_name: *const c_char, x: c_int, y: c_int, z: c_int) -> c_int; /// Loads a sample to an existing Sampler. /// /// To replace the whole sampler, set `sample_slot` to -1. pub fn sv_sampler_load(slot: c_int, sampler_module: c_int, file_name: *const c_char, sample_slot: c_int) -> c_int; /// Gets the number of modules in the currently loaded project? /// /// Does not seem to directly correspond to that. /// TODO: Investigate this. /// /// Returns zero if no project is loaded. pub fn sv_get_number_of_modules(slot: c_int) -> c_int; pub fn sv_get_module_flags(slot: c_int, mod_num: c_int) -> c_uint; pub fn sv_get_module_inputs(slot: c_int, mod_num: c_int) -> *mut c_int; pub fn sv_get_module_outputs(slot: c_int, mod_num: c_int) -> *mut c_int; pub fn sv_get_module_name(slot: c_int, mod_num: c_int) -> *const c_char; pub fn sv_get_module_xy(slot: c_int, mod_num: c_int) -> c_uint; pub fn sv_get_module_color(slot: c_int, mod_num: c_int) -> c_int; pub fn sv_get_module_scope(slot: c_int, mod_num: c_int, channel: c_int, buffer_offset: *mut c_int, buffer_size: *mut c_int) -> *mut c_void; /// Return value: received number of samples (may be less or equal to `samples_to_read`). pub fn sv_get_module_scope2(slot: c_int, mod_num: c_int, channel: c_int, read_buf: *mut c_short, samples_to_read: c_uint) -> c_uint; pub fn sv_get_number_of_module_ctls(slot: c_int, mod_num: c_int) -> c_int; pub fn sv_get_module_ctl_name(slot: c_int, mod_num: c_int, ctl_num: c_int) -> *const c_char; pub fn sv_get_module_ctl_value(slot: c_int, mod_num: c_int, ctl_num: c_int, scaled: c_int) -> c_int; pub fn sv_get_number_of_patterns(slot: c_int) -> c_int; pub fn sv_get_pattern_x(slot: c_int, pat_num: c_int) -> c_int; pub fn sv_get_pattern_y(slot: c_int, pat_num: c_int) -> c_int; pub fn sv_get_pattern_tracks(slot: c_int, pat_num: c_int) -> c_int; pub fn sv_get_pattern_lines(slot: c_int, pat_num: c_int) -> c_int; /// How to use sv_get_pattern_data(): /// /// - `int pat_tracks = sv_get_pattern_tracks(slot, pat_num);` /// - `sunvox_note* data = sv_get_pattern_data(slot, pat_num);` /// - `sunvox_note* n = &data[ line_number * pat_tracks + track_number ];` /// - ... and then do someting with note n pub fn sv_get_pattern_data(slot: c_int, pat_num: c_int) -> *mut sunvox_note; /// USE LOCK/UNLOCK! pub fn sv_pattern_mute(slot: c_int, pat_num: c_int, mute: c_int) -> c_int; /// Gets the current tick counter (from 0 to 0xFFFFFFFF). /// /// SunVox engine uses its own time space, measured in ticks. pub fn sv_get_ticks() -> c_uint; /// Gets the number of SunVox ticks per second. pub fn sv_get_ticks_per_second() -> c_uint; }