From c4154b063f1cdbd1f987fd9edda11922e0fc1454 Mon Sep 17 00:00:00 2001 From: Olli Date: Sat, 12 May 2018 18:39:43 +0300 Subject: [PATCH] Corrected typos in source code comments --- README.html | 1 + config/am_include.mk | 2 +- include/FIFOSampleBuffer.h | 2 +- include/SoundTouch.h | 2 +- source/SoundStretch/Makefile.am | 2 +- source/SoundTouch/BPMDetect.cpp | 2 +- source/SoundTouch/FIFOSampleBuffer.cpp | 4 ++-- source/SoundTouch/RateTransposer.h | 2 +- source/SoundTouch/TDStretch.cpp | 4 ++-- source/SoundTouchDLL/SoundTouchDLL.cpp | 4 ++-- source/SoundTouchDLL/SoundTouchDLL.h | 4 ++-- source/SoundTouchDLL/SoundTouchDLL.pas | 2 +- source/csharp-example/MainWindow.xaml.cs | 2 +- source/csharp-example/SoundProcessor.cs | 8 ++++---- 14 files changed, 21 insertions(+), 20 deletions(-) diff --git a/README.html b/README.html index 28d3a89..400bee0 100644 --- a/README.html +++ b/README.html @@ -865,6 +865,7 @@ submitted bugfixes:

  • Takashi Iwai
  • Thomas Klausner
  • Lu Zhihe
    • +
  • Luzpaz
  • Tony Mechelynck
  • Mathias Möhl
  • Yuval Naveh
    • diff --git a/config/am_include.mk b/config/am_include.mk index feb0195..612aa5d 100644 --- a/config/am_include.mk +++ b/config/am_include.mk @@ -19,7 +19,7 @@ ## Place - Suite 330, Boston, MA 02111-1307, USA ## These are common definitions used in all Makefiles -## It is actually included when a makefile.am is coverted to Makefile.in +## It is actually included when a makefile.am is converted to Makefile.in ## by automake, so it's ok to have @MACROS@ that will be set by configure AM_CPPFLAGS=-I$(top_srcdir)/include diff --git a/include/FIFOSampleBuffer.h b/include/FIFOSampleBuffer.h index d8704b2..4f494a8 100644 --- a/include/FIFOSampleBuffer.h +++ b/include/FIFOSampleBuffer.h @@ -119,7 +119,7 @@ public: /// 'putSamples(numSamples)' function. SAMPLETYPE *ptrEnd( uint slackCapacity ///< How much free capacity (in samples) there _at least_ - ///< should be so that the caller can succesfully insert the + ///< should be so that the caller can successfully insert the ///< desired samples to the buffer. If necessary, the function ///< grows the buffer size to comply with this requirement. ); diff --git a/include/SoundTouch.h b/include/SoundTouch.h index 6cb8d15..26e2b85 100644 --- a/include/SoundTouch.h +++ b/include/SoundTouch.h @@ -320,7 +320,7 @@ public: /// Changes a setting controlling the processing system behaviour. See the /// 'SETTING_...' defines for available setting ID's. /// - /// \return 'true' if the setting was succesfully changed + /// \return 'true' if the setting was successfully changed bool setSetting(int settingId, ///< Setting ID number. see SETTING_... defines. int value ///< New setting value. ); diff --git a/source/SoundStretch/Makefile.am b/source/SoundStretch/Makefile.am index 6ed5146..59af9cd 100644 --- a/source/SoundStretch/Makefile.am +++ b/source/SoundStretch/Makefile.am @@ -30,7 +30,7 @@ bin_PROGRAMS=soundstretch noinst_HEADERS=RunParameters.h WavFile.h -# extra files to include in distrubution tarball +# extra files to include in distribution tarball EXTRA_DIST=soundstretch.dsp soundstretch.dsw soundstretch.sln soundstretch.vcproj ## for every name listed under bin_PROGRAMS, you have a _SOURCES. This lists diff --git a/source/SoundTouch/BPMDetect.cpp b/source/SoundTouch/BPMDetect.cpp index 3032749..2c24d9e 100644 --- a/source/SoundTouch/BPMDetect.cpp +++ b/source/SoundTouch/BPMDetect.cpp @@ -261,7 +261,7 @@ void BPMDetect::inputSamples(const SAMPLETYPE *samples, int numSamples) buffer->putSamples(decimated, decSamples); } - // when the buffer has enought samples for processing... + // when the buffer has enough samples for processing... while ((int)buffer->numSamples() >= windowLen + xcorr_update_sequence) { // ... calculate autocorrelations for oldest samples... diff --git a/source/SoundTouch/FIFOSampleBuffer.cpp b/source/SoundTouch/FIFOSampleBuffer.cpp index b3f84cd..1c117b0 100644 --- a/source/SoundTouch/FIFOSampleBuffer.cpp +++ b/source/SoundTouch/FIFOSampleBuffer.cpp @@ -131,7 +131,7 @@ void FIFOSampleBuffer::putSamples(uint nSamples) // // Parameter 'slackCapacity' tells the function how much free capacity (in // terms of samples) there _at least_ should be, in order to the caller to -// succesfully insert all the required samples to the buffer. When necessary, +// successfully insert all the required samples to the buffer. When necessary, // the function grows the buffer size to comply with this requirement. // // When using this function as means for inserting new samples, also remember @@ -158,7 +158,7 @@ SAMPLETYPE *FIFOSampleBuffer::ptrBegin() } -// Ensures that the buffer has enought capacity, i.e. space for _at least_ +// Ensures that the buffer has enough capacity, i.e. space for _at least_ // 'capacityRequirement' number of samples. The buffer is grown in steps of // 4 kilobytes to eliminate the need for frequently growing up the buffer, // as well as to round the buffer size up to the virtual memory page size. diff --git a/source/SoundTouch/RateTransposer.h b/source/SoundTouch/RateTransposer.h index 87f1dff..d8656a8 100644 --- a/source/SoundTouch/RateTransposer.h +++ b/source/SoundTouch/RateTransposer.h @@ -138,7 +138,7 @@ public: /// Use this function instead of "new" operator to create a new instance of this class. /// This function automatically chooses a correct implementation, depending on if - /// integer ot floating point arithmetics are to be used. + /// integer or floating point arithmetics are to be used. // static RateTransposer *newInstance(); /// Returns the output buffer object diff --git a/source/SoundTouch/TDStretch.cpp b/source/SoundTouch/TDStretch.cpp index 228889b..864df29 100644 --- a/source/SoundTouch/TDStretch.cpp +++ b/source/SoundTouch/TDStretch.cpp @@ -367,7 +367,7 @@ int TDStretch::seekBestOverlapPositionFull(const SAMPLETYPE *refPos) // with improved precision // // Based on testing: -// - This algorithm gives on average 99% as good match as the full algorith +// - This algorithm gives on average 99% as good match as the full algorithm // - this quick seek algorithm finds the best match on ~90% of cases // - on those 10% of cases when this algorithm doesn't find best match, // it still finds on average ~90% match vs. the best possible match @@ -524,7 +524,7 @@ void TDStretch::clearCrossCorrState() void TDStretch::calcSeqParameters() { // Adjust tempo param according to tempo, so that variating processing sequence length is used - // at varius tempo settings, between the given low...top limits + // at various tempo settings, between the given low...top limits #define AUTOSEQ_TEMPO_LOW 0.5 // auto setting low tempo range (-50%) #define AUTOSEQ_TEMPO_TOP 2.0 // auto setting top tempo range (+100%) diff --git a/source/SoundTouchDLL/SoundTouchDLL.cpp b/source/SoundTouchDLL/SoundTouchDLL.cpp index 3591f29..d20027c 100644 --- a/source/SoundTouchDLL/SoundTouchDLL.cpp +++ b/source/SoundTouchDLL/SoundTouchDLL.cpp @@ -308,7 +308,7 @@ SOUNDTOUCHDLL_API void __cdecl soundtouch_clear(HANDLE h) /// Changes a setting controlling the processing system behaviour. See the /// 'SETTING_...' defines for available setting ID's. /// -/// \return 'nonzero' if the setting was succesfully changed +/// \return 'nonzero' if the setting was successfully changed SOUNDTOUCHDLL_API int __cdecl soundtouch_setSetting(HANDLE h, int settingId, ///< Setting ID number. see SETTING_... defines. int value ///< New setting value. @@ -484,7 +484,7 @@ SOUNDTOUCHDLL_API void __cdecl bpm_putSamples(HANDLE h, /// Feed 'numSamples' sample frames from 'samples' into the BPM detection handler. -/// 16bit int sample format verson. +/// 16bit int sample format version. SOUNDTOUCHDLL_API void __cdecl bpm_putSamples_i16(HANDLE h, const short *samples, unsigned int numSamples) diff --git a/source/SoundTouchDLL/SoundTouchDLL.h b/source/SoundTouchDLL/SoundTouchDLL.h index 5472d48..5876259 100644 --- a/source/SoundTouchDLL/SoundTouchDLL.h +++ b/source/SoundTouchDLL/SoundTouchDLL.h @@ -157,7 +157,7 @@ SOUNDTOUCHDLL_API void __cdecl soundtouch_clear(HANDLE h); /// Changes a setting controlling the processing system behaviour. See the /// 'SETTING_...' defines for available setting ID's. /// -/// \return 'nonzero' if the setting was succesfully changed, otherwise zero +/// \return 'nonzero' if the setting was successfully changed, otherwise zero SOUNDTOUCHDLL_API int __cdecl soundtouch_setSetting(HANDLE h, int settingId, ///< Setting ID number. see SETTING_... defines. int value ///< New setting value. @@ -214,7 +214,7 @@ SOUNDTOUCHDLL_API void __cdecl bpm_putSamples(HANDLE h, ); /// Feed 'numSamples' sample frames from 'samples' into the BPM detector. -/// 16bit int sample format verson. +/// 16bit int sample format version. SOUNDTOUCHDLL_API void __cdecl bpm_putSamples_i16(HANDLE h, const short *samples, ///< Pointer to sample buffer. unsigned int numSamples ///< Number of samples in buffer. Notice diff --git a/source/SoundTouchDLL/SoundTouchDLL.pas b/source/SoundTouchDLL/SoundTouchDLL.pas index c3e9dcc..e87e599 100644 --- a/source/SoundTouchDLL/SoundTouchDLL.pas +++ b/source/SoundTouchDLL/SoundTouchDLL.pas @@ -118,7 +118,7 @@ type // Changes a setting controlling the processing system behaviour. See the // 'SETTING_...' defines for available setting ID's. // - // \return 'TRUE' if the setting was succesfully changed + // \return 'TRUE' if the setting was successfully changed TSoundTouchSetSetting = function (Handle: TSoundTouchHandle; SettingId: Integer; //< Setting ID number. see SETTING_... defines. Value: Integer //< New setting value. diff --git a/source/csharp-example/MainWindow.xaml.cs b/source/csharp-example/MainWindow.xaml.cs index 5028cf4..74df8d7 100644 --- a/source/csharp-example/MainWindow.xaml.cs +++ b/source/csharp-example/MainWindow.xaml.cs @@ -39,7 +39,7 @@ namespace csharp_example /// - /// Display SoundTouch library version string in status bar. This also indicates whether the DLL was loaded succesfully or not ... + /// Display SoundTouch library version string in status bar. This also indicates whether the DLL was loaded successfully or not ... /// private void DisplaySoundTouchVersion() { diff --git a/source/csharp-example/SoundProcessor.cs b/source/csharp-example/SoundProcessor.cs index 7bc2a70..d8f4d42 100644 --- a/source/csharp-example/SoundProcessor.cs +++ b/source/csharp-example/SoundProcessor.cs @@ -185,7 +185,7 @@ namespace csharp_example /// /// Start / resume playback /// - /// true if succesful, false if audio file not open + /// true if successful, false if audio file not open public bool Play() { if (waveOut == null) return false; @@ -201,7 +201,7 @@ namespace csharp_example /// /// Pause playback /// - /// true if succesful, false if audio not playing + /// true if successful, false if audio not playing public bool Pause() { if (waveOut == null) return false; @@ -218,7 +218,7 @@ namespace csharp_example /// /// Stop playback /// - /// true if succesful, false if audio file not open + /// true if successful, false if audio file not open public bool Stop() { if (waveOut == null) return false; @@ -238,7 +238,7 @@ namespace csharp_example /// - /// Proxy event handler for receiving playback stoped event from WaveOut + /// Proxy event handler for receiving playback stopped event from WaveOut /// protected void EventHandler_stopped(object sender, StoppedEventArgs args) {