summaryrefslogtreecommitdiff
path: root/include/SFML/Audio/.svn/text-base/SoundRecorder.hpp.svn-base
blob: 9f4767e668e70c5fc0fc235f7c2b6e02e2aad086 (plain)
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
////////////////////////////////////////////////////////////
//
// SFML - Simple and Fast Multimedia Library
// Copyright (C) 2007-2008 Laurent Gomila (laurent.gom@gmail.com)
//
// This software is provided 'as-is', without any express or implied warranty.
// In no event will the authors be held liable for any damages arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it freely,
// subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented;
//    you must not claim that you wrote the original software.
//    If you use this software in a product, an acknowledgment
//    in the product documentation would be appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such,
//    and must not be misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source distribution.
//
////////////////////////////////////////////////////////////

#ifndef SFML_SOUNDRECORDER_HPP
#define SFML_SOUNDRECORDER_HPP

////////////////////////////////////////////////////////////
// Headers
////////////////////////////////////////////////////////////
#include <SFML/System/Thread.hpp>
#include <vector>


namespace sf
{
////////////////////////////////////////////////////////////
/// SoundRecorder is an interface for capturing sound data,
/// it is meant to be used as a base class
////////////////////////////////////////////////////////////
class SFML_API SoundRecorder : private Thread
{
public :

    typedef bool (*FuncType)(const Int16*, std::size_t, void*);

    ////////////////////////////////////////////////////////////
    /// Construct the sound recorder with a callback function
    /// for processing captured samples
    ///
    /// \param Callback : Callback for processing captured samples
    /// \param UserData : Data to pass to the callback function (NULL by default)
    ///
    ////////////////////////////////////////////////////////////
    SoundRecorder(FuncType Callback, void* UserData = NULL);

    ////////////////////////////////////////////////////////////
    /// Virtual destructor
    ///
    ////////////////////////////////////////////////////////////
    virtual ~SoundRecorder();

    ////////////////////////////////////////////////////////////
    /// Start the capture.
    /// Warning : only one capture can happen at the same time
    ///
    /// \param SampleRate : Sound frequency (the more samples, the higher the quality)
    ///                    (44100 by default = CD quality)
    ///
    ////////////////////////////////////////////////////////////
    void Start(unsigned int SampleRate = 44100);

    ////////////////////////////////////////////////////////////
    /// Stop the capture
    ///
    ////////////////////////////////////////////////////////////
    void Stop();

    ////////////////////////////////////////////////////////////
    /// Get the sample rate
    ///
    /// \return Frequency, in samples per second
    ///
    ////////////////////////////////////////////////////////////
    unsigned int GetSampleRate() const;

    ////////////////////////////////////////////////////////////
    /// Tell if the system supports sound capture.
    /// If not, this class won't be usable
    ///
    /// \return True if audio capture is supported
    ///
    ////////////////////////////////////////////////////////////
    static bool CanCapture();

protected :

    ////////////////////////////////////////////////////////////
    /// Default constructor
    ///
    ////////////////////////////////////////////////////////////
    SoundRecorder();

private :

    ////////////////////////////////////////////////////////////
    /// Process a new chunk of recorded samples
    ///
    /// \param Samples :      Pointer to the new chunk of recorded samples
    /// \param SamplesCount : Number of samples pointed by Samples
    ///
    /// \return False to stop recording audio data, true to continue
    ///
    ////////////////////////////////////////////////////////////
    virtual bool ProcessSamples(const Int16* Samples, std::size_t SamplesCount);

    ////////////////////////////////////////////////////////////
    /// /see Thread::Run
    ///
    ////////////////////////////////////////////////////////////
    virtual void Run();

    ////////////////////////////////////////////////////////////
    /// Get the available captured samples and process them
    ///
    ////////////////////////////////////////////////////////////
    void ProcessCapturedSamples();

    ////////////////////////////////////////////////////////////
    /// Clean up the recorder internal resources
    ///
    ////////////////////////////////////////////////////////////
    void CleanUp();

    ////////////////////////////////////////////////////////////
    // Member data
    ////////////////////////////////////////////////////////////
    FuncType           myCallback;    ///< Callback for processing captured samples
    void*              myUserData;    ///< User data to pass to the processing callback
    std::vector<Int16> mySamples;     ///< Buffer to store captured samples
    unsigned int       mySampleRate;  ///< Sample rate
    bool               myIsCapturing; ///< Capturing state
};

} // namespace sf


#endif // SFML_SOUNDRECORDER_HPP