Merge pull request #18 from TheOnlyJoey/master

Updated Python bindings and example to Python 3

Author: adamstark

python-module/GistPythonModule.cpp

@@ -41,13 +41,13 @@ static PyObject* setSamplingFrequency (PyObject *dummy, PyObject *args)
 //=======================================================================
 static PyObject* getAudioFrameSize (PyObject *dummy, PyObject *args)
 {
-    return PyInt_FromLong((long) gist.getAudioFrameSize());
+    return PyLong_FromLong((long) gist.getAudioFrameSize());
 }
 
 //=======================================================================
 static PyObject* getSamplingFrequency (PyObject *dummy, PyObject *args)
 {
-    return PyInt_FromLong((long) gist.getSamplingFrequency());
+    return PyLong_FromLong((long) gist.getSamplingFrequency());
 }
 
 //=======================================================================
@@ -301,24 +301,33 @@ static PyMethodDef gist_methods[] = {
     {NULL, NULL, 0, NULL} /* Sentinel */
 };
 
-
+static struct PyModuleDef gist_definition = {
+    PyModuleDef_HEAD_INIT,
+    "gist",
+    "Python bindings for the Gist C++ based audio analysis library.",
+    -1,
+    gist_methods
+};
 
 //=======================================================================
-PyMODINIT_FUNC initgist (void)
+PyMODINIT_FUNC PyInit_gist (void)
 {
-    (void)Py_InitModule("gist", gist_methods);
     import_array();
+    return PyModule_Create(&gist_definition);
 }
 
 //=======================================================================
 int main (int argc, char *argv[])
 {
+    //Convert char* to const wchar_t
+    wchar_t *program = Py_DecodeLocale(argv[0], NULL);
+
     /* Pass argv[0] to the Python interpreter */
-    Py_SetProgramName(argv[0]);
+    Py_SetProgramName(program);
 
     /* Initialize the Python interpreter.  Required. */
     Py_Initialize();
 
     /* Add a static module */
-    initgist();
+    PyInit_gist();
 }

python-module/example.py

@@ -31,54 +31,54 @@
 
 # ====================== Core Time Domain Features ===================
 
-print ""
-print "--- CORE TIME DOMAIN FEATURES ---"
-print ""
-print "RMS:", gist.rms()
-print "Peak Energy:", gist.peakEnergy()
-print "Zero Crossing Rate:", gist.zeroCrossingRate()
-print ""
+print("")
+print("--- CORE TIME DOMAIN FEATURES ---")
+print("")
+print("RMS:", gist.rms())
+print("Peak Energy:", gist.peakEnergy())
+print("Zero Crossing Rate:", gist.zeroCrossingRate())
+print("")
 
 # ====================== Core Frequency Domain Features ===================
 
-print "--- CORE FREQUENCY DOMAIN FEATURES ---"
-print ""
-print "Spectral Centroid: ", gist.spectralCentroid()
-print "Spectral Crest:", gist.spectralCrest()
-print "Spectral Flatness:", gist.spectralFlatness()
-print "Spectral Rolloff:", gist.spectralRolloff()
-print "Spectral Kurtosis:", gist.spectralKurtosis()
-print ""
+print("--- CORE FREQUENCY DOMAIN FEATURES ---")
+print("")
+print("Spectral Centroid: ", gist.spectralCentroid())
+print("Spectral Crest:", gist.spectralCrest())
+print("Spectral Flatness:", gist.spectralFlatness())
+print("Spectral Rolloff:", gist.spectralRolloff())
+print("Spectral Kurtosis:", gist.spectralKurtosis())
+print("")
 
 # ========================= Onset Detection Functions =======================
 
-print "--- ONSET DETECTION FUNCTIONS ---"
-print ""
-print "Energy Difference:", gist.energyDifference()
-print "Spectral Difference:", gist.spectralDifference()
-print "Spectral Difference (half-wave rectified):", gist.spectralDifferenceHWR()
-print "Complex Spectral Difference:", gist.complexSpectralDifference()
-print "High Frequency Content:", gist.highFrequencyContent()
-print ""
+print("--- ONSET DETECTION FUNCTIONS ---")
+print("")
+print("Energy Difference:", gist.energyDifference())
+print("Spectral Difference:", gist.spectralDifference())
+print("Spectral Difference (half-wave rectified):", gist.spectralDifferenceHWR())
+print("Complex Spectral Difference:", gist.complexSpectralDifference())
+print("High Frequency Content:", gist.highFrequencyContent())
+print("")
 
 # ========================= Pitch =======================
 
-print "--- PITCH ---"
-print ""
-print "Pitch:", gist.pitch()
-print ""
+print("--- PITCH ---")
+print("")
+print("Pitch:", gist.pitch())
+print("")
 
 # ======================= Spectra ========================
 
-print "--- SPECTRA ---"
-print ""
+print("--- SPECTRA ---")
+print("")
 magnitudeSpectrum = gist.magnitudeSpectrum()
-print "Magnitude Spectrum has", magnitudeSpectrum.size, "samples"
+print("Magnitude Spectrum has", magnitudeSpectrum.size, "samples")
 
 melFrequencySpectrum = gist.melFrequencySpectrum()
-print "Mel-Frequency Spectrum has", melFrequencySpectrum.size, "samples"
+print("Mel-Frequency Spectrum has", melFrequencySpectrum.size, "samples")
 
 mfccs = gist.mfccs()
-print "MFCCs has", mfccs.size, "samples"
+print("MFCCs has", mfccs.size, "samples")
 
 

python-module/setup.py

@@ -2,6 +2,16 @@
 # build command : python setup.py build build_ext --inplace
 from numpy.distutils.core import setup, Extension
 import os, numpy
+import sys
+
+if not sys.version_info.major == 3 and sys.version_info.minor >= 6:
+      print ("")
+      print ("Python Version Error")
+      print ("")
+      print ("This script must be run using Python 3.6 or later.")
+      print ("You are trying to run it using Python " + str (sys.version_info.major) + "." + str (sys.version_info.minor))
+      print ("")
+      exit()
 
 name = 'gist'
 sources = [