Merge pull request #3 from supercollider/chapter-29

Chapter 29

Author: muellmusik

Ch 29 Writing Unit Generator Plug-ins/.gitignore

@@ -0,0 +1 @@
+build**

Ch 29 Writing Unit Generator Plug-ins/CMakeLists.txt

@@ -0,0 +1,107 @@
+cmake_minimum_required (VERSION 3.5)
+
+set(PROJECT "Flanger")
+message(STATUS "Project name is ${PROJECT}")
+project (${PROJECT})
+
+# Specify the source file
+set(FILENAME "Figure_29-10_Flanger_2.cpp") # old-style version
+# set(FILENAME "Figure_29-10b_Flanger_2 C++ interface.cpp") # modern C++ version
+
+include (CheckCXXCompilerFlag)
+
+# set default build type to Release
+if (NOT CMAKE_BUILD_TYPE)
+ set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Build type" FORCE)
+endif()
+message(STATUS "Build type: ${CMAKE_BUILD_TYPE}")
+
+set(SC_PATH "" CACHE PATH "Path to SuperCollider source code")
+message(STATUS "SC_PATH: ${SC_PATH}")
+include_directories(${SC_PATH}/include/plugin_interface)
+include_directories(${SC_PATH}/include/common)
+include_directories(${SC_PATH}/common)
+
+if (WIN32)
+ set(SC_INSTALLDIR "$ENV{LOCALAPPDATA}/SuperCollider/Extensions/" CACHE PATH "Installation directoy")
+elseif(APPLE)
+ set(SC_INSTALLDIR "~/Library/Application Support/SuperCollider/Extensions/" CACHE PATH "Installation directoy")
+else()
+ set(SC_INSTALLDIR "~/.local/share/SuperCollider/Extensions/" CACHE PATH "Installation directoy")
+endif()
+message(STATUS "SC_INSTALLDIR: ${SC_INSTALLDIR}")
+
+option(SUPERNOVA "Build plugins for supernova" OFF)
+message(STATUS "Build Supernova version: ${SUPERNOVA}")
+
+# no library prefix!
+set(CMAKE_SHARED_MODULE_PREFIX "")
+# set plugin extension
+if (APPLE OR WIN32)
+ set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
+endif()
+
+if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
+ set(CMAKE_COMPILER_IS_CLANG 1)
+endif()
+
+if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)
+ # hide all symbols by default
+ add_definitions(-fvisibility=hidden)
+
+ CHECK_CXX_COMPILER_FLAG(-msse HAS_SSE)
+ if (HAS_SSE)
+ add_compile_options(-msse)
+ endif()
+
+ CHECK_CXX_COMPILER_FLAG(-msse2 HAS_SSE2)
+ if (HAS_SSE2)
+ add_compile_options(-msse2)
+ endif()
+
+ # it's safe to assume at least SSE3
+ CHECK_CXX_COMPILER_FLAG(-msse3 HAS_SSE3)
+ if (HAS_SSE3)
+ add_compile_options(-msse3)
+ endif()
+
+ CHECK_CXX_COMPILER_FLAG(-mfpmath=sse HAS_FPMATH_SSE)
+ if (HAS_FPMATH_SSE)
+ add_compile_options(-mfpmath=sse)
+ endif()
+
+ option(NATIVE "Optimize for this machine (not portable!)" OFF)
+ if (NATIVE)
+ add_compile_options(-march=native)
+ endif()
+
+ if (CMAKE_COMPILER_IS_CLANG)
+ add_compile_options(-stdlib=libc++)
+ endif()
+endif()
+
+if(MINGW)
+ add_compile_options(-mstackrealign)
+endif()
+
+add_library(${PROJECT} MODULE ${FILENAME})
+
+if(SUPERNOVA)
+ add_library(${PROJECT}_supernova MODULE ${FILENAME})
+ target_compile_definitions(${PROJECT}_supernova PRIVATE SUPERNOVA)
+ target_include_directories(${PROJECT}_supernova PRIVATE ${SC_PATH}/external_libraries/nova-tt)
+ # for <boost/atomic.hpp>
+ target_include_directories(${PROJECT}_supernova PRIVATE ${SC_PATH}/external_libraries/boost)
+endif()
+
+# installation
+
+install(TARGETS ${PROJECT} DESTINATION "${SC_INSTALLDIR}/${PROJECT}/plugins")
+
+if (SUPERNOVA)
+ install(TARGETS ${PROJECT}_supernova DESTINATION "${SC_INSTALLDIR}/${PROJECT}/plugins")
+endif()
+
+install(FILES "Flanger.sc" DESTINATION "${SC_INSTALLDIR}/${PROJECT}/classes")
+install(FILES "Flanger.schelp" DESTINATION "${SC_INSTALLDIR}/${PROJECT}/HelpSource/Classes")
+install(FILES "README.md" "LICENSE.txt" DESTINATION "${SC_INSTALLDIR}/${PROJECT}")

Ch 29 Writing Unit Generator Plug-ins/Figure_29-10_Flanger_2.cpp

@@ -8,12 +8,12 @@ static InterfaceTable *ft;
 struct Flanger : public Unit {
  // it is a convention to use some kind of prefix (or postfix)
  // to distinguish member variables from local variables
- float mRate;
+ float mModRate;
  float mDelaysize;
  float mAdvance;
  float mReadpos;
  int mWritepos;
-// a pointer to the memory we'll use for our internal delay
+ // a pointer to the memory we'll use for our internal delay
  float *mDelayline;
 };
 
@@ -27,90 +27,81 @@ void Flanger_Ctor(Flanger *unit) {
  // Rather than using rate directly, we're going to calculate the size of
  // jumps we must make each time to scan through the delayline at "rate"
  unit->mAdvance = ((unit->mDelaysize * rate) / SAMPLERATE) + 1.0f;
- unit->mRate = rate;
+ unit->mModRate = rate;
  unit->mWritepos = 0;
  unit->mReadpos = 0;
-
-// Allocate the delay line
+
+ // Allocate the delay line
  unit->mDelayline = (float*)RTAlloc(unit->mWorld, (int)unit->mDelaysize * sizeof(float));
  // Check the result of RTAlloc because it can fail if the RT pool is too small!
- if (!unit->mDelayline)
- {
- Print("RTAlloc failed!");
- // clear outputs, set calc function and set done
- ClearUnitOutputs(unit, 1);
- SETCALC(ClearUnitOutputs);
- unit->mDone = true;
- return;
- }
+ ClearUnitIfMemFailed(unit->mDelayline);
  // Set the delay line to zeros.
  memset(unit->mDelayline, 0, unit->mDelaysize * sizeof(float));
-
-// IMPORTANT: This tells scsynth the name of the calculation function for this UGen.
-SETCALC(Flanger_next);
-
-// Should also calc 1 sample's worth of output - ensures each ugen's "pipes" are "primed"
-Flanger_next(unit, 1);
+
+ // IMPORTANT: This tells scsynth the name of the calculation function for this UGen.
+ SETCALC(Flanger_next);
+
+ // Should also calc 1 sample's worth of output - ensures each ugen's "pipes" are "primed"
+ Flanger_next(unit, 1);
 }
 
 void Flanger_next(Flanger *unit, int inNumSamples) {
-float *in = IN(0);
+ float *in = IN(0);
  float *out = OUT(0);
 
  // "rate" and "depth" can be modulated at control rate
  float currate = IN0(1);
-float depth = IN0(2);
-
+ float depth = IN0(2);
+
  // The compiler doesn't know that "out" can't possibly point
  // to one of our members, so it would have to reload them from
  // memory on every loop iteration. To prevent this from happening,
  // we temporarily store them in local variables.
- float rate = unit->mRate;
+ float rate = unit->mModRate;
  float advance = unit->mAdvance;
  float readpos = unit->mReadpos;
  int writepos = unit->mWritepos;
  const float delaysize = unit->mDelaysize; // this one is fixed
  float *delayline = unit->mDelayline;
-
+
  if (rate != currate) {
-// rate input needs updating
-rate = currate;
- advance = ((delaysize * rate * 2) / SAMPLERATE) + 1.0f;
-}
-
+ // rate input needs updating
+ rate = currate;
+ advance = ((delaysize * rate) / SAMPLERATE) + 1.0f;
+ }
+
  for (int i = 0; i < inNumSamples; ++i) {
  float val = in[i];
-
-// Write to the delay line
-delayline[writepos++] = val;
+
+ // Write to the delay line
+ delayline[writepos++] = val;
  if(writepos == delaysize)
-writepos = 0;
-
-// Read from the delay line
+ writepos = 0;
+
+ // Read from the delay line
  float delayed = delayline[(int)readpos];
  readpos += advance;
-// Update position, NB we may be moving forwards or backwards (depending on input)
+ // Update position, NB we may be moving forwards or backwards (depending on input)
  while(readpos >= delaysize)
-readpos -= delaysize;
+ readpos -= delaysize;
  while(readpos < 0)
-readpos += delaysize;
-
-// Mix dry and wet together, and output them
-out[i] = val + (delayed * depth);
-}
-
+ readpos += delaysize;
+
+ // Mix dry and wet together, and output them
+ out[i] = val + (delayed * depth);
+ }
+
  // store them back
- unit->mRate = rate;
+ unit->mModRate = rate;
  unit->mAdvance = advance;
  unit->mWritepos = writepos;
  unit->mReadpos = readpos;
-}
+}
 
 void Flanger_Dtor(Flanger *unit) {
- // check in case RTFree failed in the Ctor
- if (unit->mDelayline)
- RTFree(unit->mWorld, unit->mDelayline);
-}
+ // NB: it's ok to pass NULL to RTFree()
+ RTFree(unit->mWorld, unit->mDelayline);
+}
 
 PluginLoad(InterfaceTable *inTable) {
  ft = inTable;

Ch 29 Writing Unit Generator Plug-ins/Figure_29-10b_Flanger_2 C++ interface.cpp

@@ -13,7 +13,7 @@ class Flanger : public SCUnit {
 private:
  // it is a convention to use some kind of prefix (or postfix)
  // to distinguish member variables from local variables
- float mRate;
+ float mModRate;
  float mDelaysize;
  float mAdvance;
  float mReadpos;
@@ -25,42 +25,34 @@ class Flanger : public SCUnit {
 Flanger::Flanger() {
  // Here we must initialise *all* state variables in our Flanger struct.
  mDelaysize = sampleRate() * 0.02f; // Fixed 20ms max delay
- float rate = IN0(1); // initial rate
+ float rate = in0(1); // initial rate
  // Rather than using rate directly, we're going to calculate the size of
  // jumps we must make each time to scan through the delayline at "rate"
  mAdvance = ((mDelaysize * rate) / sampleRate()) + 1.0f;
- mRate = rate;
+ mModRate = rate;
  mWritepos = 0;
  mReadpos = 0;
 
  // Allocate the delay line
  mDelayline = (float*)RTAlloc(mWorld, (int)mDelaysize * sizeof(float));
  // Check the result of RTAlloc because it can fail if the RT pool is too small!
- if (!mDelayline)
- {
- Print("RTAlloc failed!");
- // clear outputs, set calc function and set done
- ClearUnitOutputs(unit, 1);
- SETCALC(ClearUnitOutputs);
- mDone = true;
- return;
- }
+ auto unit = this;
+ ClearUnitIfMemFailed(mDelayline);
  // Set the delay line to zeros.
  memset(mDelayline, 0, mDelaysize * sizeof(float));
 
  // sets the calc function and automatically computes 1 sample.
- set_calc_function<&Flanger::next>();
+ set_calc_function<Flanger, &Flanger::next>();
 }
 
 Flanger::~Flanger() {
- // check in case RTFree failed in the Ctor
- if (mDelayline)
- RTFree(mWorld, mDelayline);
+ // NB: it's ok to pass NULL to RTFree()
+ RTFree(mWorld, mDelayline);
 }
 
-void Flanger::next(int inNumSamples ) {
- float *in = in(0);
- float *out = out(0);
+void Flanger::next(int inNumSamples) {
+ const float *input = in(0);
+ float *output = out(0);
 
  // "rate" and "depth" can be modulated at control rate
  float currate = in0(1);
@@ -70,7 +62,7 @@ void Flanger::next(int inNumSamples ) {
  // to one of our members, so it would have to reload them from
  // memory on every loop iteration. To prevent this from happening,
  // we temporarily store them in local variables.
- float rate = mRate;
+ float rate = mModRate;
  float advance = mAdvance;
  float readpos = mReadpos;
  int writepos = mWritepos;
@@ -80,11 +72,11 @@ void Flanger::next(int inNumSamples ) {
  if (rate != currate) {
  // rate input needs updating
  rate = currate;
- advance = ((delaysize * rate * 2) / SAMPLERATE) + 1.0f;
+ advance = ((delaysize * rate) / sampleRate()) + 1.0f;
  }
 
  for (int i = 0; i < inNumSamples; ++i) {
- float val = in[i];
+ float val = input[i];
 
  // Write to the delay line
  delayline[writepos++] = val;
@@ -101,11 +93,11 @@ void Flanger::next(int inNumSamples ) {
  readpos += delaysize;
 
  // Mix dry and wet together, and output them
- out[i] = val + (delayed * depth);
+ output[i] = val + (delayed * depth);
  }
 
  // store them back
- mRate = rate;
+ mModRate = rate;
  mAdvance = advance;
  mWritepos = writepos;
  mReadpos = readpos;