WaveSwissKnife 0.2.0.20120302

data/AUTHORS

@@ -0,0 +1,4 @@
+= Muriel Salvan (muriel@x-aeon.com)
+* 0.0.1.20101110
+* 0.1.0.20110830
+* 0.2.0.20120302

data/ChangeLog

@@ -0,0 +1,31 @@
+= WaveSwissKnife Release History
+
+== 0.2.0.20120302 (Beta)
+
+* Shipping gems in platform-independent architecture.
+* Adapted to standard C extensions handling to make the Gem architecture independent.
+* Adapted to standard RubyGems extensions format to deliver a Ruby gem instead of an architecture specific one.
+* Sorted the output of available actions in the help screen.
+* Corrected C code to make it compile correctly with Ruby 1.9.
+* Ignored mkmf.log files in GIT.
+* Adapted release information to last version of RubyPackager.
+* Adapted release information to last version of rUtilAnts.
+* Removed rdoc warning in documentation.
+* Updated Copyright information.
+* Updated email address of Muriel Salvan.
+* Adapted comments to match a better RDoc syntax.
+* Adapted to new version of rUtilAnts.
+
+== 0.1.0.20110830 (Beta)
+
+* Migrated repository to git.
+* Updated copyright information
+* Made regression 100% successful.
+* Migrated TODO list to Trackers.
+* Made building extensions report errors correctly.
+* Bug correction: Reading FFT samples could not be performed.
+
+== 0.0.1.20101110 (Alpha)
+
+* Initial public release.
+

data/Credits

@@ -0,0 +1,3 @@
+= Projects used by WaveSwissKnife
+
+= People that helped a lot in developing WaveSwissKnife

data/LICENSE

@@ -0,0 +1,31 @@
+
+The license stated herein is a copy of the BSD License (modified on July 1999).
+The AUTHOR mentionned below refers to the list of people involved in the
+creation and modification of any file included in the delivered package.
+This list is found in the file named AUTHORS.
+The AUTHORS and LICENSE files have to be included in any release of software
+embedding source code of this package, or using it as a derivative software.
+
+Copyright (c) 2010 - 2012 Muriel Salvan (muriel@x-aeon.com)
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+   3. The name of the author may not be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
+IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY
+OF SUCH DAMAGE.

data/README

@@ -0,0 +1,15 @@
+= WaveSwissKnife
+
+Command-line utility handling Wave files.
+
+== Where is the documentation ?
+
+Check the website at http://waveswissknife.sourceforge.net
+
+== Who wrote it ?
+
+Check the AUTHORS[link:AUTHORS.html] file.
+
+== What is the license ?
+
+You can find out in the LICENSE[link:LICENSE.html] file.

data/ReleaseInfo

@@ -0,0 +1,8 @@
+
+# This file has been generated by RubyPackager during a delivery.
+# More info about RubyPackager: http://rubypackager.sourceforge.net
+{
+  :version => '0.2.0.20120302',
+  :tags => [ 'Beta' ],
+  :dev_status => 'Beta'
+}

data/bin/WSK.rb

@@ -0,0 +1,14 @@
+#!env ruby
+#--
+# Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+# Main file
+
+require 'rUtilAnts/Logging'
+RUtilAnts::Logging::install_logger_on_object
+require 'WSK/Common'
+require 'WSK/Launcher'
+
+exit WSK::Launcher.new.execute(ARGV)

data/ext/WSK/AnalyzeUtils/AnalyzeUtils.c

@@ -0,0 +1,272 @@
+/**
+ * Copyright (c) 2009 - 2012 Muriel Salvan (muriel@x-aeon.com)
+ * Licensed under the terms specified in LICENSE file. No warranty is provided.
+ **/
+
+#include "ruby.h"
+#include <math.h>
+#include <stdio.h>
+#include <CommonUtils.h>
+
+// Structure used to compute sum of squares
+typedef struct {
+  unsigned long long int high;
+  unsigned long long int low;
+} t128bits;
+
+// Structure used to give variables to iteration process
+typedef struct {
+  long long int * maxValues;
+  long long int * minValues;
+  long long int * sumValues;
+  long long int * absSumValues;
+  t128bits * squareSumValues;
+} tAnalyzeStruct;
+
+/** Add a 64 bits unsigned integer to a 128 bits unsigned integer
+ *
+ * Parameters::
+ * * *ioPtrVal* (<em>t128bits*</em>): The 128 bits integer to modify
+ * * *iAddValue* (<em>const unsigned long long int</em>): The value to add
+ **/
+inline void add128bits(t128bits* ioPtrVal, const unsigned long long int iAddValue) {
+  unsigned long long int lOldLow = ioPtrVal->low;
+
+  ioPtrVal->low += iAddValue;
+  // check for overflow of low 64 bits, add carry to high
+  if (ioPtrVal->low < lOldLow)
+    ++ioPtrVal->high;
+}
+
+/** Create empty arrays of long long integers to be used for various sums
+ *
+ * Parameters::
+ * * *iSelf* (_FFT_): Self
+ * * *iValNbrChannels* (_Integer_): Number of channels
+ * * *iValInitialValue* (_Integer_): Initial value
+ * Return::
+ * * _Object_: An encapsulated array for computation
+ **/
+static VALUE analyzeutils_init64bitsArray(
+  VALUE iSelf,
+  VALUE iValNbrChannels,
+  VALUE iValInitialValue) {
+  VALUE rValContainer;
+  int lNbrChannels = FIX2INT(iValNbrChannels);
+  long long int lInitialValue = FIX2LONG(iValInitialValue);
+
+  long long int * lSumArray = ALLOC_N(long long int, lNbrChannels);
+  int lIdxChannel;
+  for (lIdxChannel = 0; lIdxChannel < lNbrChannels; ++lIdxChannel) {
+    lSumArray[lIdxChannel] = lInitialValue;
+  }
+
+  // Encapsulate it
+  rValContainer = Data_Wrap_Struct(rb_cObject, NULL, free, lSumArray);
+
+  return rValContainer;
+}
+
+/** Create empty arrays of 128 bits integers to be used for various sums
+ *
+ * Parameters::
+ * * *iSelf* (_FFT_): Self
+ * * *iValNbrChannels* (_Integer_): Number of channels
+ * Return::
+ * * _Object_: An encapsulated array for computation
+ **/
+static VALUE analyzeutils_init128bitsArray(
+  VALUE iSelf,
+  VALUE iValNbrChannels) {
+  VALUE rValContainer;
+  int lNbrChannels = FIX2INT(iValNbrChannels);
+
+  t128bits * lSumArray = ALLOC_N(t128bits, lNbrChannels);
+  // Fill it with 0
+  memset(lSumArray, 0, lNbrChannels*sizeof(t128bits));
+
+  // Encapsulate it
+  rValContainer = Data_Wrap_Struct(rb_cObject, NULL, free, lSumArray);
+
+  return rValContainer;
+}
+
+/**
+ * Process a value read from an input buffer for the Analyze function.
+ * Use the trigo cache.
+ *
+ * Parameters::
+ * * *iValue* (<em>const tSampleValue</em>): The value being read
+ * * *iIdxSample* (<em>const tSampleIndex</em>): Index of this sample
+ * * *iIdxChannel* (<em>const int</em>): Channel corresponding to the value being read
+ * * *iPtrArgs* (<em>void*</em>): additional arguments. In fact a <em>tAnalyzeStruct*</em>.
+ * Return::
+ * * _int_: The return code:
+ * ** 0: Continue iteration
+ * ** 1: Break all iterations
+ * ** 2: Skip directly to the next sample (don't call us for other channels of this sample)
+ */
+int analyzeutils_processValue_Analyze(
+  const tSampleValue iValue,
+  const tSampleIndex iIdxSample,
+  const int iIdxChannel,
+  void* iPtrArgs) {
+  // Interpret parameters
+  tAnalyzeStruct* lPtrVariables = (tAnalyzeStruct*)iPtrArgs;
+
+  if (iValue > lPtrVariables->maxValues[iIdxChannel]) {
+    lPtrVariables->maxValues[iIdxChannel] = iValue;
+  }
+  if (iValue < lPtrVariables->minValues[iIdxChannel]) {
+    lPtrVariables->minValues[iIdxChannel] = iValue;
+  }
+  lPtrVariables->sumValues[iIdxChannel] += iValue;
+  lPtrVariables->absSumValues[iIdxChannel] += abs(iValue);
+  add128bits(&(lPtrVariables->squareSumValues[iIdxChannel]), ((long long int)iValue)*((long long int)iValue));
+
+  return 0;
+}
+
+/** Complete the arrays of sums for analyzis
+ * 
+ * Parameters::
+ * * *iSelf* (_FFT_): Self
+ * * *iValInputRawBuffer* (_String_): The input raw buffer
+ * * *iValNbrBitsPerSample* (_Integer_): The number of bits per sample
+ * * *iValNbrSamples* (_Integer_): The number of samples
+ * * *iValNbrChannels* (_Integer_): The number of channels
+ * * *ioValMaxValues* (_Object_): Container of the max values array (should be initialized with init64bitsArray)
+ * * *ioValMinValues* (_Object_): Container of the min values array (should be initialized with init64bitsArray)
+ * * *ioValSumValues* (_Object_): Container of the sum values array (should be initialized with init64bitsArray)
+ * * *ioValAbsSumValues* (_Object_): Container of the abs sum values array (should be initialized with init64bitsArray)
+ * * *ioValSquareSumValues* (_Object_): Container of the square sum values array (should be initialized with init128bitsArray)
+ **/
+static VALUE analyzeutils_completeAnalyze(
+  VALUE iSelf,
+  VALUE iValInputRawBuffer,
+  VALUE iValNbrBitsPerSample,
+  VALUE iValNbrSamples,
+  VALUE iValNbrChannels,
+  VALUE ioValMaxValues,
+  VALUE ioValMinValues,
+  VALUE ioValSumValues,
+  VALUE ioValAbsSumValues,
+  VALUE ioValSquareSumValues) {
+  // Translate Ruby objects
+  tSampleIndex iNbrSamples = FIX2LONG(iValNbrSamples);
+  int iNbrChannels = FIX2INT(iValNbrChannels);
+  int iNbrBitsPerSample = FIX2LONG(iValNbrBitsPerSample);
+  char* lPtrRawBuffer = RSTRING_PTR(iValInputRawBuffer);
+  // Get the arrays
+  tAnalyzeStruct lProcessParams;
+  Data_Get_Struct(ioValMaxValues, long long int, lProcessParams.maxValues);
+  Data_Get_Struct(ioValMinValues, long long int, lProcessParams.minValues);
+  Data_Get_Struct(ioValSumValues, long long int, lProcessParams.sumValues);
+  Data_Get_Struct(ioValAbsSumValues, long long int, lProcessParams.absSumValues);
+  Data_Get_Struct(ioValSquareSumValues, t128bits, lProcessParams.squareSumValues);
+
+  // Parse the data
+  commonutils_iterateThroughRawBuffer(
+    lPtrRawBuffer,
+    iNbrBitsPerSample,
+    iNbrChannels,
+    iNbrSamples,
+    0,
+    &analyzeutils_processValue_Analyze,
+    &lProcessParams
+  );
+
+  return Qnil;
+}
+
+/** Get a Bignum Ruby arrays out of a 64bits C integers array
+ *
+ * Parameters::
+ * * *iSelf* (_FFT_): Self
+ * * *iValArray* (_Object_): Container of the array (should be initialized with init64bitsArray)
+ * * *iValNbrItems* (_Integer_): The number of items in the array
+ * Return::
+ * * <em>list<Integer></em>: Corresponding Ruby array
+ **/
+static VALUE analyzeutils_getRuby64bitsArray(
+  VALUE iSelf,
+  VALUE iValArray,
+  VALUE iValNbrItems) {
+  // Translate Ruby objects
+  int lNbrItems = FIX2INT(iValNbrItems);
+  // Get the array
+  long long int * lArray;
+  Data_Get_Struct(iValArray, long long int, lArray);
+  // The C-array of the final result
+  VALUE lFinalArray[lNbrItems];
+
+  // Buffer that stores string representation of long long int for Ruby RBigNum
+  char lStrValue[128];
+  int lIdxItem;
+  for (lIdxItem = 0; lIdxItem < lNbrItems; ++lIdxItem) {
+    sprintf(lStrValue, "%lld", lArray[lIdxItem]);
+    lFinalArray[lIdxItem] = rb_cstr2inum(lStrValue, 10);
+  }
+
+  return rb_ary_new4(lNbrItems, lFinalArray);
+}
+
+/** Get a Bignum Ruby arrays out of a 128bits C integers array
+ *
+ * Parameters::
+ * * *iSelf* (_FFT_): Self
+ * * *iValArray* (_Object_): Container of the array (should be initialized with init128bitsArray)
+ * * *iValNbrItems* (_Integer_): The number of items in the array
+ * Return::
+ * * <em>list<Integer></em>: Corresponding Ruby array
+ **/
+static VALUE analyzeutils_getRuby128bitsArray(
+  VALUE iSelf,
+  VALUE iValArray,
+  VALUE iValNbrItems) {
+  // Translate Ruby objects
+  int lNbrItems = FIX2INT(iValNbrItems);
+  // Get the array
+  t128bits * lArray;
+  Data_Get_Struct(iValArray, t128bits, lArray);
+  // The C-array of the final result
+  VALUE lFinalArray[lNbrItems];
+  // Operations that will be used
+  ID lPlusID = rb_intern("+");
+  ID lMultiplyID = rb_intern("*");
+
+  // Buffer that stores string representation of long long int for Ruby RBigNum
+  char lStrValue[128];
+  int lIdxItem;
+  VALUE lValHigh;
+  VALUE lValLow;
+  VALUE lValHighShifted;
+  // We will need to multiply High part by 2^64
+  VALUE lValShiftFactor = rb_cstr2inum("18446744073709551616", 10);
+  for (lIdxItem = 0; lIdxItem < lNbrItems; ++lIdxItem) {
+    sprintf(lStrValue, "%llu", lArray[lIdxItem].high);
+    lValHigh = rb_cstr2inum(lStrValue, 10);
+    sprintf(lStrValue, "%llu", lArray[lIdxItem].low);
+    lValLow = rb_cstr2inum(lStrValue, 10);
+    lValHighShifted = rb_funcall(lValHigh, lMultiplyID, 1, lValShiftFactor);
+    lFinalArray[lIdxItem] = rb_funcall(lValHighShifted, lPlusID, 1, lValLow);
+  }
+
+  return rb_ary_new4(lNbrItems, lFinalArray);
+}
+
+// Initialize the module
+void Init_AnalyzeUtils() {
+  VALUE lWSKModule;
+  VALUE lAnalyzeUtilsModule;
+  VALUE lAnalyzeUtilsClass;
+  
+  lWSKModule = rb_define_module("WSK");
+  lAnalyzeUtilsModule = rb_define_module_under(lWSKModule, "AnalyzeUtils");
+  lAnalyzeUtilsClass = rb_define_class_under(lAnalyzeUtilsModule, "AnalyzeUtils", rb_cObject);
+  rb_define_method(lAnalyzeUtilsClass, "init64bitsArray", analyzeutils_init64bitsArray, 2);
+  rb_define_method(lAnalyzeUtilsClass, "init128bitsArray", analyzeutils_init128bitsArray, 1);
+  rb_define_method(lAnalyzeUtilsClass, "completeAnalyze", analyzeutils_completeAnalyze, 9);
+  rb_define_method(lAnalyzeUtilsClass, "getRuby64bitsArray", analyzeutils_getRuby64bitsArray, 2);
+  rb_define_method(lAnalyzeUtilsClass, "getRuby128bitsArray", analyzeutils_getRuby128bitsArray, 2);
+}

data/ext/WSK/AnalyzeUtils/extconf.rb

@@ -0,0 +1,7 @@
+#--
+# Copyright (c) 2012 Muriel Salvan (murielsalvan@users.sourceforge.net)
+# Licensed under the terms specified in LICENSE file. No warranty is provided.
+#++
+
+require "#{File.dirname(__FILE__)}/../CommonBuild"
+create_makefile('AnalyzeUtils')