add example 01b demonstrating Tim's C++ header

Author: Nathan Ho

01-BoringMixer/BoringMixer.cpp renamed to 01a-BoringMixer/BoringMixer.cpp

@@ -17,11 +17,11 @@ static void BoringMixer_Ctor(BoringMixer* unit);
 // it MUST be named "PluginName_Ctor", and the argument must be "unit."
 void BoringMixer_Ctor(BoringMixer* unit) {
     // in later examples, we will initialize state variables here.
-    
+
     // set a calculation function. for now, we only have one calculation function.
     SETCALC(BoringMixer_next);
     // calculate one sample of output.
-    // this allows plugging into other ugens with initial-rate inputs 
+    // this allows plugging into other ugens with initial-rate inputs
     BoringMixer_next(unit, 1);
 }
 
@@ -30,8 +30,11 @@ void BoringMixer_Ctor(BoringMixer* unit) {
 // Don't change the names of the arguments, or the helper macros won't work.
 void BoringMixer_next(BoringMixer* unit, int inNumSamples) {
 
-    // IN and OUT are helper macros that return audio-rate input and output buffers.
+    // IN and OUT are helper macros that return audio-rate input and output buffers. These are known as "wire buffers."
     // In old ugens you'll see ZIN and ZOUT, which are not recommended.
+
+    // scsynth saves memory by aliasing wire buffers. In this case, "out" and "left" are the same. You should either
+    // be mindful of this behavior or turn it off in the PluginLoad section.
     float *left = IN(0); // first input
     float *right = IN(1); // second input
     float *out = OUT(0); // first output
@@ -48,5 +51,6 @@ PluginLoad(BoringMixerUGens) {
     ft = inTable; // store pointer to InterfaceTable
     // DefineSimpleUnit is one of four macros defining different kinds of ugens.
     // In later examples involving memory allocation, we'll see DefineDtorUnit.
+    // You can disable aliasing by using DefineSimpleCantAliasUnit and DefineDtorCantAliasUnit.
     DefineSimpleUnit(BoringMixer);
 }

01-BoringMixer/BoringMixer.sc renamed to 01a-BoringMixer/BoringMixer.sc

@@ -0,0 +1,48 @@
+// This is an alternate way to write the BoringMixer plugin using a newer C++ header (introduced in 2010).
+
+// Using SC_PlugIn.hpp instead of SC_PlugIn.h. SC_PlugIn.hpp includes SC_PlugIn.h. C++ and old-fashioned ugens can
+// coexist in the same file.
+#include "SC_PlugIn.hpp"
+
+static InterfaceTable *ft;
+
+// Inherits from SCUnit, not Unit.
+// Also note that the constructor, destructor, and calc functions are methods of the SCUnit.
+struct BoringMixer2 : public SCUnit {
+public:
+    // Constructor function
+    BoringMixer2() {
+        // New way of setting calc function.
+        set_calc_function<BoringMixer2, &BoringMixer2::next>();
+        next(1);
+    }
+
+    // If you want a destructor, you would declare "~BoringMixer2() { ... }" here.
+
+private:
+    // You can declare state variables here.
+
+    // Calc function
+    void next(int inNumSamples) {
+        // Note, there is no "unit" variable here, so you can't use a lot of the traditional helper macros. That's why
+        // the C++ header offers replacements.
+
+        // in and out are methods of SCUnit that replace IN and OUT.
+        // ins are const float*, not float*.
+        const float* left = in(0);
+        const float* right = in(1);
+        float* outbuf = out(0);
+
+        for (int i = 0; i < inNumSamples; i++) {
+            outbuf[i] = (left[i] + right[i]) * 0.5;
+        }
+    }
+};
+
+PluginLoad(BoringMixer2UGens) {
+    ft = inTable;
+    // registerUnit takes the place of the Define*Unit functions. It automatically checks for the presence of a
+    // destructor function.
+    // However, it does not seem to be possible to disable buffer aliasing with the C++ header.
+    registerUnit<BoringMixer2>(ft, "BoringMixer2");
+}

01-BoringMixer/CMakeLists.txt renamed to 01a-BoringMixer/CMakeLists.txt

@@ -0,0 +1,13 @@
+BoringMixer2 : UGen {
+    *ar { |left, right|
+        ^this.multiNew('audio', left, right);
+    }
+    checkInputs {
+        [0, 1].do { |i|
+            (inputs[i].rate != 'audio').if {
+                ^"input % is not audio rate".format(i).throw;
+            };
+        };
+        ^this.checkValidInputs;
+    }
+}

01b-BoringMixer/BoringMixer.cpp

@@ -0,0 +1,69 @@
+cmake_minimum_required (VERSION 2.8)
+set(PROJECT "BoringMixer")
+project (${PROJECT})
+
+include_directories(${SC_PATH}/include/plugin_interface)
+include_directories(${SC_PATH}/include/common)
+include_directories(${SC_PATH}/common)
+
+
+set(CMAKE_SHARED_MODULE_PREFIX "")
+if(APPLE OR WIN32)
+set(CMAKE_SHARED_MODULE_SUFFIX ".scx")
+endif()
+
+option(CPP11 "Build with c++11." ON)
+
+if(CMAKE_COMPILER_IS_GNUCXX OR CMAKE_COMPILER_IS_CLANG)
+    add_definitions(-fvisibility=hidden)
+
+    include (CheckCCompilerFlag)
+    include (CheckCXXCompilerFlag)
+
+    CHECK_C_COMPILER_FLAG(-msse HAS_SSE)
+    CHECK_CXX_COMPILER_FLAG(-msse HAS_CXX_SSE)
+
+    if (HAS_SSE)
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse")
+    endif()
+    if (HAS_CXX_SSE)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse")
+    endif()
+
+    CHECK_C_COMPILER_FLAG(-msse2 HAS_SSE2)
+    CHECK_CXX_COMPILER_FLAG(-msse2 HAS_CXX_SSE2)
+
+    if (HAS_SSE2)
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -msse2")
+    endif()
+    if (HAS_CXX_SSE2)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -msse2")
+    endif()
+
+    CHECK_C_COMPILER_FLAG(-mfpmath=sse HAS_FPMATH_SSE)
+    CHECK_CXX_COMPILER_FLAG(-mfpmath=sse HAS_CXX_FPMATH_SSE)
+
+    if (HAS_FPMATH_SSE)
+        set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mfpmath=sse")
+    endif()
+    if (HAS_CXX_FPMATH_SSE)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mfpmath=sse")
+    endif()
+
+    if(NATIVE)
+        add_definitions(-march=native)
+    endif()
+
+    if(CPP11)
+        set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -std=c++11")
+        if(CMAKE_COMPILER_IS_CLANG)
+            set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -stdlib=libc++")
+        endif()
+    endif()
+endif()
+if(MINGW)
+    set(CMAKE_C_FLAGS "${CMAKE_C_FLAGS} -mstackrealign")
+    set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -mstackrealign")
+endif()
+
+add_library(${PROJECT} MODULE BoringMixer.cpp)