//////////////////////////////////////////////////////////// // // SFML - Simple and Fast Multimedia Library // Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org) // // 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_H #define SFML_SOUNDRECORDER_H //////////////////////////////////////////////////////////// // Headers //////////////////////////////////////////////////////////// #include #include #include #include typedef sfBool (*sfSoundRecorderStartCallback)(void*); ///< Type of the callback used when starting a capture typedef sfBool (*sfSoundRecorderProcessCallback)(const sfInt16*, size_t, void*); ///< Type of the callback used to process audio data typedef void (*sfSoundRecorderStopCallback)(void*); ///< Type of the callback used when stopping a capture //////////////////////////////////////////////////////////// /// \brief Construct a new sound recorder from callback functions /// /// \param onStart Callback function which will be called when a new capture starts (can be NULL) /// \param onProcess Callback function which will be called each time there's audio data to process /// \param onStop Callback function which will be called when the current capture stops (can be NULL) /// \param userData Data to pass to the callback function (can be NULL) /// /// \return A new sfSoundRecorder object (NULL if failed) /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API sfSoundRecorder* sfSoundRecorder_create(sfSoundRecorderStartCallback onStart, sfSoundRecorderProcessCallback onProcess, sfSoundRecorderStopCallback onStop, void* userData); //////////////////////////////////////////////////////////// /// \brief Destroy a sound recorder /// /// \param soundRecorder Sound recorder to destroy /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API void sfSoundRecorder_destroy(sfSoundRecorder* soundRecorder); //////////////////////////////////////////////////////////// /// \brief Start the capture of a sound recorder /// /// The \a sampleRate parameter defines the number of audio samples /// captured per second. The higher, the better the quality /// (for example, 44100 samples/sec is CD quality). /// This function uses its own thread so that it doesn't block /// the rest of the program while the capture runs. /// Please note that only one capture can happen at the same time. /// /// \param soundRecorder Sound recorder object /// \param sampleRate Desired capture rate, in number of samples per second /// /// \return True, if start of capture was successful /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API sfBool sfSoundRecorder_start(sfSoundRecorder* soundRecorder, unsigned int sampleRate); //////////////////////////////////////////////////////////// /// \brief Stop the capture of a sound recorder /// /// \param soundRecorder Sound recorder object /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API void sfSoundRecorder_stop(sfSoundRecorder* soundRecorder); //////////////////////////////////////////////////////////// /// \brief Get the sample rate of a sound recorder /// /// The sample rate defines the number of audio samples /// captured per second. The higher, the better the quality /// (for example, 44100 samples/sec is CD quality). /// /// \param soundRecorder Sound recorder object /// /// \return Sample rate, in samples per second /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API unsigned int sfSoundRecorder_getSampleRate(const sfSoundRecorder* soundRecorder); //////////////////////////////////////////////////////////// /// \brief Check if the system supports audio capture /// /// This function should always be called before using /// the audio capture features. If it returns false, then /// any attempt to use sfSoundRecorder will fail. /// /// \return sfTrue if audio capture is supported, sfFalse otherwise /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API sfBool sfSoundRecorder_isAvailable(void); //////////////////////////////////////////////////////////// /// \brief Set the processing interval /// /// The processing interval controls the period /// between calls to the onProcessSamples function. You may /// want to use a small interval if you want to process the /// recorded data in real time, for example. /// /// Note: this is only a hint, the actual period may vary. /// So don't rely on this parameter to implement precise timing. /// /// The default processing interval is 100 ms. /// /// \param soundRecorder Sound recorder object /// \param interval Processing interval /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API void sfSoundRecorder_setProcessingInterval(sfSoundRecorder* soundRecorder, sfTime interval); //////////////////////////////////////////////////////////// /// \brief Get a list of the names of all availabe audio capture devices /// /// This function returns an array of strings (null terminated), /// containing the names of all availabe audio capture devices. /// If no devices are available then NULL is returned. /// /// \param count Pointer to a variable that will be filled with the number of modes in the array /// /// \return An array of strings containing the names /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API const char** sfSoundRecorder_getAvailableDevices(size_t* count); //////////////////////////////////////////////////////////// /// \brief Get the name of the default audio capture device /// /// This function returns the name of the default audio /// capture device. If none is available, NULL is returned. /// /// \return The name of the default audio capture device (null terminated) /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API const char* sfSoundRecorder_getDefaultDevice(); //////////////////////////////////////////////////////////// /// \brief Set the audio capture device /// /// This function sets the audio capture device to the device /// with the given name. It can be called on the fly (i.e: /// while recording). If you do so while recording and /// opening the device fails, it stops the recording. /// /// \param soundRecorder Sound recorder object /// \param The name of the audio capture device /// /// \return sfTrue, if it was able to set the requested device /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API sfBool sfSoundRecorder_setDevice(sfSoundRecorder* soundRecorder, const char* name); //////////////////////////////////////////////////////////// /// \brief Get the name of the current audio capture device /// /// \param soundRecorder Sound recorder object /// /// \return The name of the current audio capture device /// //////////////////////////////////////////////////////////// CSFML_AUDIO_API const char* sfSoundRecorder_getDevice(sfSoundRecorder* soundRecorder); #endif // SFML_SOUNDRECORDER_H