ears 0.7.0

Easy Rust API to play audio using OpenAL
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
98
99

// The MIT License (MIT)
//
// Copyright (c) 2013 Jeremy Letang (letang.jeremy@gmail.com)
//
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
// the Software, and to permit persons to whom the Software is furnished to do so,
// subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
// FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
// COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
// IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
// CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

/*!
 * __ears__ initialization (optional).
 *
 * This module provide a unique function to initialize __ears__.
 * Use this function in the case of you don't use __ears__ for the first time
 * in you program in the main task. This prevent that the context was created
 * and destroyed in a another task.
 */

use record_context::RecordContext;
use internal::OpenAlData;

/**
 * Initialize the internal context
 *
 * # Return
 * `Ok(())` if initialization is successful, `Err(String)` otherwise
 *
 * # Example
 * ```no_run
 * ears::init().unwrap()
 * ```
 */
pub fn init() -> Result<(), String> {
    return OpenAlData::check_al_context()
}

/**
 * Initialize the input device context
 *
 * # Return
 * `Ok(RecordContext)` if initialization is successful, `Err(String)` otherwise
 *
 * # Example
 * ```no_run
 * ears::init_in().unwrap();
 * ```
 */
pub fn init_in() -> Result<RecordContext, String> {
    return OpenAlData::check_al_input_context()
}

#[cfg(test)]
mod test {
    #![allow(non_snake_case)]

    use init;
    use init_in;
	use std::thread;

    #[test]
    #[ignore]
    fn test_init_ears_OK() -> () {
        assert!(init().is_ok())
    }

    #[test]
    #[ignore]
    fn test_init_in_with_normal_init_OK() -> () {
        init();
        assert!(init_in().is_ok())
    }

    #[test]
    #[ignore]
    fn test_init_in_alone_OK() -> () {
        assert!(init_in().is_ok())
    }

    #[test]
    #[ignore]
    fn test_init_in_in_another_task_OK() -> () {
        init();
        thread::spawn(move || {
            assert!(init_in().is_err())
        });
    }
}