Mercurial > hg > piper-vamp-js

changeset 135:c5623bf080bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Move examples to their own subdirs, tidy up a bit
author Chris Cannam <c.cannam@qmul.ac.uk>
date Fri, 11 Nov 2016 17:02:33 +0000
parents c0256c2debf5
children 704b93c2456e
files .hgignore Makefile.inc examples/Makefile.vamp-example-plugins examples/Makefile.vamp-test-plugin examples/vamp-example-plugins.cpp examples/vamp-example-plugins/Makefile examples/vamp-example-plugins/vamp-example-plugins.cpp examples/vamp-test-plugin.cpp examples/vamp-test-plugin/Makefile examples/vamp-test-plugin/vamp-test-plugin.cpp
diffstat 10 files changed, 182 insertions(+), 199 deletions(-) [+]
line wrap: on
line diff
--- a/.hgignore	Fri Nov 11 16:52:17 2016 +0000
+++ b/.hgignore	Fri Nov 11 17:02:33 2016 +0000
@@ -1,2 +1,3 @@
 syntax: glob
 *.o
+*~
--- a/Makefile.inc	Fri Nov 11 16:52:17 2016 +0000
+++ b/Makefile.inc	Fri Nov 11 17:02:33 2016 +0000
@@ -8,7 +8,7 @@
 		@echo "$$ make em"
 		@echo "  - build Javascript module using Emscripten"
 		@echo "$$ make test"
-		@echo "  - run simple load test of Javascript module using node.js"
+		@echo "  - build and run simple load test of Javascript module using node.js"
 		@echo "$$ make linux"
 		@echo "  - build native-code module on Linux (currently this is mostly for testing)"
 		@echo "$$ make clean"
@@ -71,8 +71,7 @@
 OPTFLAGS	:= -O3 -ffast-math
 
 DEFINES		:= $(DEFINES)
-
-INCLUDES		:= -I$(SRC_DIR) -I$(SDK_DIR) -I$(PIPERCPP_DIR) $(INCLUDES)
+INCLUDES	:= -I$(SRC_DIR) -I$(SDK_DIR) -I$(PIPERCPP_DIR) $(INCLUDES)
 
 em:	$(EM_MODULE)
 em:	CXX		:= em++
--- a/examples/Makefile.vamp-example-plugins	Fri Nov 11 16:52:17 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,16 +0,0 @@
-
-MODULE_NAME	:= VampExamplePlugins
-
-EXAMPLE_DIR	:= ../../vamp-plugin-sdk/examples
-
-PLUGIN_SOURCES	:= \
-		$(EXAMPLE_DIR)/ZeroCrossing.cpp \
-		$(EXAMPLE_DIR)/SpectralCentroid.cpp \
-		$(EXAMPLE_DIR)/PercussionOnsetDetector.cpp \
-		$(EXAMPLE_DIR)/FixedTempoEstimator.cpp \
-		$(EXAMPLE_DIR)/AmplitudeFollower.cpp \
-		$(EXAMPLE_DIR)/PowerSpectrum.cpp
-
-MODULE_SOURCE	:= vamp-example-plugins.cpp
-
-include ../Makefile.inc
--- a/examples/Makefile.vamp-test-plugin	Fri Nov 11 16:52:17 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,13 +0,0 @@
-
-MODULE_NAME	:= VampTestPlugin
-
-TESTPLUGIN_DIR	:= ../../vamp-test-plugin
-
-INCLUDES	:= -I$(TESTPLUGIN_DIR)
-
-PLUGIN_SOURCES	:= \
-		$(TESTPLUGIN_DIR)/VampTestPlugin.cpp
-
-MODULE_SOURCE	:= vamp-test-plugin.cpp
-
-include ../Makefile.inc
--- a/examples/vamp-example-plugins.cpp	Fri Nov 11 16:52:17 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,84 +0,0 @@
-/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
-
-/*
-    Piper
-
-    Centre for Digital Music, Queen Mary, University of London.
-    Copyright 2015-2016 QMUL.
-  
-    Permission is hereby granted, free of charge, to any person
-    obtaining a copy of this software and associated documentation
-    files (the "Software"), to deal in the Software without
-    restriction, including without limitation the rights to use, copy,
-    modify, merge, publish, distribute, sublicense, and/or sell copies
-    of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be
-    included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
-    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-    Except as contained in this notice, the names of the Centre for
-    Digital Music; Queen Mary, University of London; and Chris Cannam
-    shall not be used in advertising or otherwise to promote the sale,
-    use or other dealings in this Software without prior written
-    authorization.
-*/
-
-#include "PiperAdapter.h"
-#include "PiperPluginLibrary.h"
-
-#include "examples/ZeroCrossing.h"
-#include "examples/SpectralCentroid.h"
-#include "examples/PercussionOnsetDetector.h"
-#include "examples/FixedTempoEstimator.h"
-#include "examples/AmplitudeFollower.h"
-#include "examples/PowerSpectrum.h"
-
-using piper_vamp_js::PiperAdapter;
-using piper_vamp_js::PiperPluginLibrary;
-
-static std::string soname("vamp-example-plugins");
-
-static PiperAdapter<ZeroCrossing> zeroCrossingAdapter(soname);
-static PiperAdapter<SpectralCentroid> spectralCentroidAdapter(soname);
-static PiperAdapter<PercussionOnsetDetector> percussionOnsetAdapter(soname);
-static PiperAdapter<FixedTempoEstimator> fixedTempoAdapter(soname);
-static PiperAdapter<AmplitudeFollower> amplitudeAdapter(soname);
-static PiperAdapter<PowerSpectrum> powerSpectrumAdapter(soname);
-
-static PiperPluginLibrary library({
-    &zeroCrossingAdapter,
-    &spectralCentroidAdapter,
-    &percussionOnsetAdapter,
-    &fixedTempoAdapter,
-    &amplitudeAdapter,
-    &powerSpectrumAdapter
-});
-
-extern "C" {
-
-const char *piperRequestJson(const char *request) {
-    return library.requestJson(request);
-}
-
-const char *piperProcessRaw(int handle,
-                              const float *const *inputBuffers,
-                              int sec,
-                              int nsec) {
-    return library.processRaw(handle, inputBuffers, sec, nsec);
-}
-    
-void piperFreeJson(const char *json) {
-    return library.freeJson(json);
-}
-
-}
-
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/examples/vamp-example-plugins/Makefile	Fri Nov 11 17:02:33 2016 +0000
@@ -0,0 +1,20 @@
+
+PIPER_VAMP_JS_DIR	:= ../..
+PLUGIN_SRC_DIR		:= ../../../vamp-plugin-sdk/examples
+
+MODULE_NAME		:= VampExamplePlugins
+MODULE_SOURCE		:= vamp-example-plugins.cpp
+
+SOURCE_FILES	:= \
+		ZeroCrossing.cpp \
+		SpectralCentroid.cpp \
+		PercussionOnsetDetector.cpp \
+		FixedTempoEstimator.cpp \
+		AmplitudeFollower.cpp \
+		PowerSpectrum.cpp
+
+PLUGIN_SOURCES	:= $(addprefix $(PLUGIN_SRC_DIR)/,$(SOURCE_FILES))
+
+INCLUDES	:= -I$(PLUGIN_SRC_DIR)
+
+include $(PIPER_VAMP_JS_DIR)/Makefile.inc
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/examples/vamp-example-plugins/vamp-example-plugins.cpp	Fri Nov 11 17:02:33 2016 +0000
@@ -0,0 +1,66 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+
+/*
+    Piper
+
+    Centre for Digital Music, Queen Mary, University of London.
+    Copyright 2015-2016 QMUL.
+  
+    Permission is hereby granted, free of charge, to any person
+    obtaining a copy of this software and associated documentation
+    files (the "Software"), to deal in the Software without
+    restriction, including without limitation the rights to use, copy,
+    modify, merge, publish, distribute, sublicense, and/or sell copies
+    of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR
+    ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+    Except as contained in this notice, the names of the Centre for
+    Digital Music; Queen Mary, University of London; and Chris Cannam
+    shall not be used in advertising or otherwise to promote the sale,
+    use or other dealings in this Software without prior written
+    authorization.
+*/
+
+#include "PiperExport.h"
+
+#include "ZeroCrossing.h"
+#include "SpectralCentroid.h"
+#include "PercussionOnsetDetector.h"
+#include "FixedTempoEstimator.h"
+#include "AmplitudeFollower.h"
+#include "PowerSpectrum.h"
+
+using piper_vamp_js::PiperAdapter;
+using piper_vamp_js::PiperPluginLibrary;
+
+static std::string soname("vamp-example-plugins");
+
+static PiperAdapter<ZeroCrossing> zeroCrossingAdapter(soname);
+static PiperAdapter<SpectralCentroid> spectralCentroidAdapter(soname);
+static PiperAdapter<PercussionOnsetDetector> percussionOnsetAdapter(soname);
+static PiperAdapter<FixedTempoEstimator> fixedTempoAdapter(soname);
+static PiperAdapter<AmplitudeFollower> amplitudeAdapter(soname);
+static PiperAdapter<PowerSpectrum> powerSpectrumAdapter(soname);
+
+static PiperPluginLibrary library({
+    &zeroCrossingAdapter,
+    &spectralCentroidAdapter,
+    &percussionOnsetAdapter,
+    &fixedTempoAdapter,
+    &amplitudeAdapter,
+    &powerSpectrumAdapter
+});
+
+PIPER_EXPORT_LIBRARY(library);
+
--- a/examples/vamp-test-plugin.cpp	Fri Nov 11 16:52:17 2016 +0000
+++ /dev/null	Thu Jan 01 00:00:00 1970 +0000
@@ -1,83 +0,0 @@
-/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
-/*
-    Vamp Test Plugin
-    Copyright (c) 2013-2016 Queen Mary, University of London
-
-    Permission is hereby granted, free of charge, to any person
-    obtaining a copy of this software and associated documentation
-    files (the "Software"), to deal in the Software without
-    restriction, including without limitation the rights to use, copy,
-    modify, merge, publish, distribute, sublicense, and/or sell copies
-    of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
-
-    The above copyright notice and this permission notice shall be
-    included in all copies or substantial portions of the Software.
-
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
-    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
-    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-    Except as contained in this notice, the names of the Centre for
-    Digital Music and Queen Mary, University of London shall not be
-    used in advertising or otherwise to promote the sale, use or other
-    dealings in this Software without prior written authorization.
-*/
-
-#include "PiperAdapter.h"
-#include "PiperPluginLibrary.h"
-
-#include "VampTestPlugin.h"
-
-using piper_vamp_js::PiperAdapter;
-using piper_vamp_js::PiperAdapterBase;
-using piper_vamp_js::PiperPluginLibrary;
-
-static std::string soname("vamp-test-plugin");
-
-class Adapter : public PiperAdapterBase<VampTestPlugin>
-{
-public:
-    Adapter(bool freq) :
-        PiperAdapterBase<VampTestPlugin>(soname),
-        m_freq(freq) { }
-
-protected:
-    bool m_freq;
-
-    Vamp::Plugin *createPlugin(float inputSampleRate) const {
-        return new VampTestPlugin(inputSampleRate, m_freq);
-    }
-};
-
-static Adapter timeAdapter(false);
-static Adapter freqAdapter(true);
-
-static PiperPluginLibrary library({
-    &timeAdapter,
-    &freqAdapter
-});
-
-extern "C" {
-
-const char *piperRequestJson(const char *request) {
-    return library.requestJson(request);
-}
-
-const char *piperProcessRaw(int handle,
-                              const float *const *inputBuffers,
-                              int sec,
-                              int nsec) {
-    return library.processRaw(handle, inputBuffers, sec, nsec);
-}
-    
-void piperFreeJson(const char *json) {
-    return library.freeJson(json);
-}
-
-}
-
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/examples/vamp-test-plugin/Makefile	Fri Nov 11 17:02:33 2016 +0000
@@ -0,0 +1,11 @@
+
+PIPER_VAMP_JS_DIR	:= ../..
+PLUGIN_SRC_DIR		:= ../../../vamp-test-plugin
+
+MODULE_NAME		:= VampTestPlugin
+MODULE_SOURCE		:= vamp-test-plugin.cpp
+
+PLUGIN_SOURCES		:= $(PLUGIN_SRC_DIR)/VampTestPlugin.cpp
+INCLUDES		:= -I$(PLUGIN_SRC_DIR)
+
+include $(PIPER_VAMP_JS_DIR)/Makefile.inc
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/examples/vamp-test-plugin/vamp-test-plugin.cpp	Fri Nov 11 17:02:33 2016 +0000
@@ -0,0 +1,82 @@
+/* -*- c-basic-offset: 4 indent-tabs-mode: nil -*-  vi:set ts=8 sts=4 sw=4: */
+/*
+    Vamp Test Plugin
+    Copyright (c) 2013-2016 Queen Mary, University of London
+
+    Permission is hereby granted, free of charge, to any person
+    obtaining a copy of this software and associated documentation
+    files (the "Software"), to deal in the Software without
+    restriction, including without limitation the rights to use, copy,
+    modify, merge, publish, distribute, sublicense, and/or sell copies
+    of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be
+    included in all copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
+    CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
+    CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+    Except as contained in this notice, the names of the Centre for
+    Digital Music and Queen Mary, University of London shall not be
+    used in advertising or otherwise to promote the sale, use or other
+    dealings in this Software without prior written authorization.
+*/
+
+#include "PiperExport.h"
+
+#include "VampTestPlugin.h"
+
+using piper_vamp_js::PiperAdapter;
+using piper_vamp_js::PiperAdapterBase;
+using piper_vamp_js::PiperPluginLibrary;
+
+static std::string soname("vamp-test-plugin");
+
+/*
+   This is an example of a library that exports more than one "plugin"
+   from a single C++ class. The VampTestPlugin class is constructed
+   with an argument that determines whether it is a time- or
+   frequency-domain plugin, and the library offers both.
+
+   Where normally a library that offered two plugins would have two
+   static PiperAdapters specialised with the two plugin classes, here
+   we want two static PiperAdapters specialised with the same class
+   but different constructor arguments. This is one way to do that,
+   taking advantage of the fact that PiperAdapterBase exposes
+   createPlugin as a virtual method.
+
+   Note that a very similar mechanism is used in the standard Vamp
+   version of this plugin library.
+*/
+
+class Adapter : public PiperAdapterBase<VampTestPlugin>
+{
+public:
+    Adapter(bool freq) :
+        PiperAdapterBase<VampTestPlugin>(soname),
+        m_freq(freq) { }
+
+protected:
+    bool m_freq;
+
+    Vamp::Plugin *createPlugin(float inputSampleRate) const {
+        return new VampTestPlugin(inputSampleRate, m_freq);
+    }
+};
+
+static Adapter timeAdapter(false);
+static Adapter freqAdapter(true);
+
+static PiperPluginLibrary library({
+    &timeAdapter,
+    &freqAdapter
+});
+
+PIPER_EXPORT_LIBRARY(library);
+