From bb55254fe32d1337146f1f4abbe6baa1731f11d2 Mon Sep 17 00:00:00 2001 From: groogy Date: Thu, 25 Nov 2010 15:12:33 +0000 Subject: [PATCH] Added SoundBufferRecorder. git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1710 4e206d99-4929-0410-ac5d-dfc041789085 --- .../sfml-audio/audio/SoundBufferRecorder.cpp | 198 ++++++++++++++++++ .../sfml-audio/audio/SoundBufferRecorder.hpp | 31 +++ .../ruby/sfml-audio/audio/SoundRecorder.cpp | 2 +- 3 files changed, 230 insertions(+), 1 deletion(-) create mode 100644 bindings/ruby/sfml-audio/audio/SoundBufferRecorder.cpp create mode 100644 bindings/ruby/sfml-audio/audio/SoundBufferRecorder.hpp diff --git a/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.cpp b/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.cpp new file mode 100644 index 000000000..b80ca9e90 --- /dev/null +++ b/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.cpp @@ -0,0 +1,198 @@ +/* rbSFML - Copyright (c) 2010 Henrik Valter Vogelius Hansson - groogy@groogy.se + * 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. + */ + +#include "SoundBufferRecorder.hpp" +#include "main.hpp" +#include + +VALUE globalSoundBufferRecorderClass; + +/* External classes */ +extern VALUE globalSoundRecorderClass; +extern VALUE globalSoundBufferClass; + +class rbSoundBufferRecorder : public sf::SoundBufferRecorder +{ +public: + rbSoundBufferRecorder() + { + } + + void Init( VALUE rubySelf ) + { + mySelf = rubySelf; + myOnStartID = rb_intern( "onStart" ); + myOnStopID = rb_intern( "onStop" ); + myOnProcessSamplesID = rb_intern( "onProcessSamples" ); + } + +protected: + virtual bool OnStart() + { + if( rb_respond_to( mySelf, myOnStartID ) == 0 ) + { + return true; + } + else + { + if( rb_funcall( mySelf, myOnStartID, 0 ) == Qfalse ) + { + return false; + } + else + { + return true; + } + } + } + + virtual void OnStop() + { + if( rb_respond_to( mySelf, myOnStopID ) != 0 ) + { + rb_funcall( mySelf, myOnStopID, 0 ); + } + } + + virtual bool OnProcessSamples( const sf::Int16 *someSamples, std::size_t someCount ) + { + VALUE samples = rb_ary_new2( someCount ); + for(unsigned long index = 0; index < someCount; index++) + { + rb_ary_store( samples, index, INT2FIX( someSamples[index] ) ); + } + + if( rb_funcall( mySelf, myOnProcessSamplesID, 2, samples, INT2FIX( someCount ) ) == Qfalse ) + { + return false; + } + else + { + return true; + } + } + + VALUE mySelf; + ID myOnStartID; + ID myOnStopID; + ID myOnProcessSamplesID; +}; + + +static void SoundBufferRecorder_Free( rbSoundBufferRecorder * anObject ) +{ + delete anObject; +} + +static VALUE SoundBufferRecorder_GetBuffer( VALUE self ) +{ + sf::SoundBufferRecorder *object = NULL; + Data_Get_Struct( self, sf::SoundBufferRecorder, object ); + const sf::SoundBuffer &buffer = object->GetBuffer(); + VALUE rbData = Data_Wrap_Struct( globalSoundBufferClass, 0, 0, const_cast< sf::SoundBuffer * >( &buffer ) ); + rb_iv_set( rbData, "@__owner_ref", self ); + return rbData; +} + +static VALUE SoundBufferRecorder_New( int argc, VALUE *args, VALUE aKlass ) +{ + rbSoundBufferRecorder *object = new rbSoundBufferRecorder(); + VALUE rbData = Data_Wrap_Struct( aKlass, 0, SoundBufferRecorder_Free, object ); + rb_obj_call_init( rbData, argc, args ); + return rbData; +} + +void Init_SoundBufferRecorder( void ) +{ +/* SFML namespace which contains the classes of this module. */ + VALUE sfml = rb_define_module( "SFML" ); +/* Abstract base class for capturing sound data. + * + * SFML::SoundRecorder provides a simple interface to access the audio recording capabilities of the computer + * (the microphone). + * + * As an abstract base class, it only cares about capturing sound samples, the task of making something useful with + * them is left to the derived class. Note that SFML provides a built-in specialization for saving the captured data + * to a sound buffer (see sf::SoundBufferRecorder). + * + * A derived class has only one virtual function to override: + * + * - onProcessSamples provides the new chunks of audio samples while the capture happens + * + * Moreover, two additionnal virtual functions can be overriden as well if necessary: + * + * - onStart is called before the capture happens, to perform custom initializations + * - onStop is called after the capture ends, to perform custom cleanup + * + * The audio capture feature may not be supported or activated on every platform, thus it is recommended to check + * its availability with the isAvailable() function. If it returns false, then any attempt to use an audio recorder + * will fail. + * + * It is important to note that the audio capture happens in a separate thread, so that it doesn't block the rest of + * the program. In particular, the OnProcessSamples and OnStop virtual functions (but not OnStart) will be called from + * this separate thread. It is important to keep this in mind, because you may have to take care of synchronization + * issues if you share data between threads. + * + * Usage example: + * + * class CustomRecorder < SFML::SoundRecorder + * def onStart() # optional + * # Initialize whatever has to be done before the capture starts + * ... + * + * # Return true to start playing + * return true + * end + * + * def onProcessSamples( samples, samplesCount ) + * # Do something with the new chunk of samples (store them, send them, ...) + * ... + * + * # Return true to continue playing + * return true + * end + * + * def onStop() # optional + * # Clean up whatever has to be done after the capture ends + * ... + * end + * end + * + * # Usage + * if CustomRecorder.isAvailable() + * recorder = CustomRecorder.new + * recorder.start() + * ... + * recorder.stop() + * end + */ + globalSoundBufferRecorderClass = rb_define_class_under( sfml, "SoundBufferRecorder", globalSoundRecorderClass ); + + // Class methods + rb_define_singleton_method( globalSoundBufferRecorderClass, "new", SoundBufferRecorder_New, -1 ); + + // Instance methods + rb_define_method( globalSoundRecorderClass, "getBuffer", SoundBufferRecorder_GetBuffer, 0 ); + + // Instance Aliases + rb_define_alias( globalSoundRecorderClass, "buffer", "getBuffer" ); +} diff --git a/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.hpp b/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.hpp new file mode 100644 index 000000000..35b634a98 --- /dev/null +++ b/bindings/ruby/sfml-audio/audio/SoundBufferRecorder.hpp @@ -0,0 +1,31 @@ +/* rbSFML - Copyright (c) 2010 Henrik Valter Vogelius Hansson - groogy@groogy.se + * 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_RUBYEXT_SOUND_BUFFER_RECORDER_HEADER_ +#define SFML_RUBYEXT_SOUND_BUFFER_RECORDER_HEADER_ + +#include "ruby.h" + +// Ruby initiation function +void Init_SoundBufferRecorder( void ); + +#endif // SFML_RUBYEXT_SOUND_BUFFER_RECORDER_HEADER_ diff --git a/bindings/ruby/sfml-audio/audio/SoundRecorder.cpp b/bindings/ruby/sfml-audio/audio/SoundRecorder.cpp index dfde9a1d3..d8ed2344e 100644 --- a/bindings/ruby/sfml-audio/audio/SoundRecorder.cpp +++ b/bindings/ruby/sfml-audio/audio/SoundRecorder.cpp @@ -20,7 +20,7 @@ * source distribution. */ -#include "SoundStream.hpp" +#include "SoundRecorder.hpp" #include "main.hpp" #include