# Python Bindings using SWIG **URL:** \ **Category:** General JUCE discussion\ **Created:** [October 1, 2014, 2:03pm UTC](https://forum.juce.com/t/python-bindings-using-swig/13655 "2014-10-01T14:03:04Z")\ **Posts on this page:** 5\ **Page:** 1

**Author:** ![synth](https://avatars.discourse-cdn.com/v4/letter/s/e9a140/32.png) [@synth](https://forum.juce.com/u/synth)\ **Post date:** [October 1, 2014, 2:03pm UTC](https://forum.juce.com/t/python-bindings-using-swig/13655/1 "2014-10-01T14:03:04Z")

Hi, I got the code for the python bindings using the SWIG library as mentioned here : http://www.juce.com/forum/topic/python-bindings?page=1 I have updated the interface file for the latest JUCE source code: JUCE.i : ``` %module(directors="1", autodoc="1") JUCE // #pragma SWIG nowarn=362 %include exception.i %include implicit.i %include typemaps.i // "#define Rectangle" in juce.h generates errors in WinGDI.h ! /\* %{ #if defined(\_WIN32) || defined(\_\_WIN32\_\_) || defined(\_\_CYGWIN\_\_) #include \ BOOL APIENTRY DllMain(HANDLE hModule, DWORD ul\_reason\_for\_call, LPVOID lpReserved) { return TRUE; } #endif // defined(\_WIN32) || defined(\_\_WIN32\_\_) || defined(\_\_CYGWIN\_\_) %} \*/ %{ #include \ %} %extend StringArray { const String &\_\_getitem\_\_(int subscript) { return self-\>StringArray::operator[](subscript); } } %rename(RelativeTimeCopy) RelativeTime::RelativeTime(const RelativeTime&) throw(); %rename(TimeCopy) Time::Time(const RelativeTime&) throw(); %rename(ArrayCopy) Array::Array(const Array&) throw(); %rename(BitArrayCopy) BitArray::BitArray(const BitArray&) throw(); %rename(OwnedArrayCopy) OwnedArray::OwnedArray(const OwnedArray&) throw(); %rename(ReferenceCountedArrayCopy) ReferenceCountedArray::ReferenceCountedArray(const ReferenceCountedArray&) throw(); %rename(ReferenceCountedObjectCopy) ReferenceCountedObject::ReferenceCountedObject(const ReferenceCountedObject&) throw(); %rename(SortedSetCopy) SortedSet::SortedSet(const SortedSet&) throw(); %rename(FileCopy) File::File(const File&) throw(); %rename(FileSearchPathCopy) FileSearchPath::FileSearchPath(const FileSearchPath&) throw(); %rename(URLCopy) URL::URL(const URL&) throw(); %rename(StringCopy) String::String(const String&) throw(); %rename(StringArrayCopy) StringArray::StringArray(const StringArray&) throw(); %rename(StringPairArrayCopy) StringPairArray::StringPairArray(const StringPairArray&) throw(); %rename(AudioSampleBufferCopy) AudioSampleBuffer::AudioSampleBuffer(const AudioSampleBuffer&); %rename(MidiMessageCopy) MidiMessage::MidiMessage(const MidiMessage&) throw(); %rename(MidiMessageSequenceCopy) MidiMessageSequence::MidiMessageSequence(const MidiMessageSequence&); // %rename(ColourCopy) Colour::Colour(const Colour&) throw(); %rename(EdgeTableCopy) EdgeTable::EdgeTable(const EdgeTable&) throw(); %rename(JustificationCopy) Justification::Justification(const Justification&) throw(); // %rename(GlyphArrangementCopy) GlyphArrangement::GlyphArrangement(cont GlyphArrangement&); %rename(TextLayoutCopy) TextLayout::TextLayout(const TextLayout&); %rename(TypefaceCopy) Typeface::Typeface(const Typeface&); %rename(AffineTransformCopy) AffineTransform::AffineTransform(const AffineTransform&) throw(); %rename(LineCopy) Line::Line(const Line&); %rename(PathCopy) Path::Path(const Path&) throw(); %rename(PointCopy) Point::Point(const Point&); %rename(RectangleList) RectangleList::RectangleList(const RectangleList&) throw(); %rename(ImageCopy) Image::Image(const Image&); %rename(KeyPressCopy) KeyPress::KeyPress(const KeyPress&) throw(); %rename(ModifierKeysCopy) ModifierKeys::ModifierKeys(const ModifierKeys&) throw(); %rename(PopupMenuCopy) PopupMenu::PopupMenu(const PopupMenu&); %rename(MouseCursorCopy) MouseCursor::MouseCursor(const MouseCursor&) throw(); // Thread::yield --\> yield is a python keyword ! %rename(handover) yield; %rename(ComponentWithName) Component::Component(const String& componentName) throw(); %{ typedef MidiMessageSequence::MidiEventHolder MidiEventHolder; %} %{ typedef ZipFile::ZipEntry ZipEntry; %} namespace JUCE { class MouseHoverDetector { public: MouseHoverDetector (const int hoverTimeMillisecs = 400); virtual ~MouseHoverDetector(); void setHoverTimeMillisecs (const int newTimeInMillisecs); void setHoverComponent (Component\* const newSourceComponent); protected: virtual void mouseHovered (int mouseX, int mouseY) = 0; virtual void mouseMovedAfterHover() = 0; }; } // // // DIRECTORS // %{ #include \ %} %feature("director"); %feature("director:except") { if($error) { PyErr\_Print(); throw Swig::DirectorMethodException(); } } %exception { try { $action; } catch(const Swig::DirectorException &e) { SWIG\_exception(SWIG\_UnknownError, e.getMessage()); } catch(const std::runtime\_error &e) { SWIG\_exception(SWIG\_RuntimeError, e.what()); } catch(const std::exception &e) { SWIG\_exception(SWIG\_UnknownError, e.what()); } catch(...) { SWIG\_exception(SWIG\_UnknownError, ""); } } // Some problems with variable length arguments %feature("nodirector") OutputStream; %feature("nodirector") FileOutputStream; %feature("nodirector") GZIPCompressorOutputStream; %feature("nodirector") MemoryOutputStream; %feature("nodirector") LookAndFeel; %feature("nodirector") NativeDesktopWindow; // Those classes are abstract but SWIG generates constructors wrappers anyway ... %ignore InputStream::InputStream; %ignore AudioFormatReader::AudioFormatReader; // Not implemented in JUCE 1.9 (bug ?) %ignore SystemStats::getEnvironmentVariable; %ignore ThreadPoolJob::setJobName; %ignore Label::actionListenerCallback; #define \_WIN32 // VisualStudio specific keywords #define \_\_int64 long long #define \_\_fastcall // JUCE specific keywords #define forcedinline #define inline\_assembly %include \ /////////////////////////////////////////////////////////////////////////////// // // JUCE CORE // /////////////////////////////////////////////////////////////////////////////// // // // JUCE CORE - BASICS // // defines juce\_UseDebuggingNewOperator --\> include it first %include \ // @see http://www.swig.org/Doc1.3/Preprocessor.html#Preprocessor\_nn5 // %include \ %include \ //%include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ // // // JUCE CORE - CONTAINERS // %include \ %include \ //%include \ %include \ %apply String &OUTPUT { String &destString }; // MemoryBlockBase::to64BitEncoding // AlignedMemoryBlock::AlignedMemoryBlock(int) is ambiguous !! // %include \ %clear String &destString; %include \ %include \ %include \ %include \ %include \ //%include \ // // // JUCE CORE - CRYPTOGRAPHY // %include \ %include \ %include \ %include \ // // // JUCE CORE - IO // %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ // Zlib don t compile // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // // // JUCE CORE - MISC // %include \ //%include \ %include \ %include \ // // // JUCE CORE - TEXT // %include \ %fragment(SWIG\_AsPtr\_frag(String),"header", fragment="SWIG\_AsCharPtrAndSize") { SWIGINTERN int SWIG\_AsPtr(String)(PyObject\* obj, String \*\*val) { static swig\_type\_info \*string\_info = SWIG\_TypeQuery("String \*"); String \*vptr; if(SWIG\_ConvertPtr(obj, (void\*\*)&vptr, string\_info, 0) != -1) { if(val) \*val = vptr; return SWIG\_OLDOBJ; } else { PyErr\_Clear(); char \*buf = 0; size\_t size = 0; if(SWIG\_AsCharPtrAndSize(obj, &buf, &size)) { if(buf) { if(val) \*val = new String(buf, size - 1); return SWIG\_NEWOBJ; } } else PyErr\_Clear(); if(val) PyErr\_SetString(PyExc\_TypeError,"a string is expected"); return 0; } } } %fragment(SWIG\_From\_frag(String),"header", fragment="SWIG\_FromCharArray") { SWIGINTERNSHORT PyObject \*SWIG\_From(String)(const String &s) { return SWIG\_FromCharArray((const char\*)(s), s.length()); } } %fragment(SWIG\_AsVal\_frag(String),"header", fragment=SWIG\_AsPtr\_frag(String)) { SWIGINTERN int SWIG\_AsVal(String)(PyObject\* obj, String \*val) { String \*s; int res = SWIG\_AsPtr(String)(obj, &s); if(res && s) { if(val) \*val = \*s; if(res == SWIG\_NEWOBJ) delete s; return res; } if(val) PyErr\_SetString(PyExc\_TypeError,"a string is expected"); return 0; } } %typemap\_asptrfromn(SWIG\_CCode(STRING), String); %include \ %include \ %include \ %include \ //%include \ %include \ %include \ // // // JUCE CORE - THREADS // %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ /////////////////////////////////////////////////////////////////////////////// // // JUCE APPLICATION FRAMEWORK // /////////////////////////////////////////////////////////////////////////////// %{ class PyJUCEApplication : public JUCE::JUCEApplication { public: PyJUCEApplication(const JUCE::String &applicationName, PyObject \*initialiseCallback, PyObject \*shutdownCallback) : applicationName(applicationName), initialiseCallback(initialiseCallback), shutdownCallback(shutdownCallback) {;} virtual void initialise(const String &commandLineParameters) { if(!initialiseCallback || (initialiseCallback == Py\_None)) return; ::PyObject \*args = ::PyTuple\_New(0); if(!args) throw this; ::PyObject \*result = ::PyObject\_Call(initialiseCallback, args, NULL); if(!result && ::PyErr\_Occurred()) { ::PyErr\_Print(); throw this; } Py\_XDECREF(args); Py\_XDECREF(result); } virtual void shutdown() { if(!shutdownCallback || (shutdownCallback == Py\_None)) return; ::PyObject \*args = ::PyTuple\_New(0); if(!args) throw this; ::PyObject \*result = ::PyObject\_Call(shutdownCallback, args, NULL); if(!result && ::PyErr\_Occurred()) { ::PyErr\_Print(); throw this; } Py\_XDECREF(args); Py\_XDECREF(result); } const String getApplicationName() { return applicationName; } private: JUCE::String applicationName; ::PyObject \*initialiseCallback, \*shutdownCallback; }; %} %inline %{ void mainLoop(const JUCE::String &applicationName, ::PyObject \*initialiseCallback = 0, ::PyObject \*shutdownCallback = 0) { JUCE::JUCEApplication::main(0, new PyJUCEApplication(applicationName, initialiseCallback, shutdownCallback)); } void quit(bool useMaximumForce = false) { JUCE::JUCEApplication::quit(useMaximumForce); } %} // We use our own Application // %include \ %include \ %include \ // // // JUCE APPLICATION FRAMEWORK - EVENTS // %include \ %include \ %include \ %include \ //%include \ %include \ %include \ %include \ //%include \ %include \ %include \ // // // JUCE APPLICATION FRAMEWORK - AUDIO // //%include \ %include \ %include \ %include \ %include \ %apply int &OUTPUT { int &hours, int &minutes, int &seconds, int &frames }; // MidiMessage::getFullFrameParameters %apply SmpteTimecodeType &OUTPUT { SmpteTimecodeType &timecodeType }; // MidiMessage::getFullFrameParameters %apply int &INOUT { int &hours, int &minutes, int &seconds, int &frames }; // MidiMessage::isMidiMachineControlGoto %apply int &INOUT { int &numBytesUsed }; // MidiMessage::readVariableLengthVal %include \ %clear int &numBytesUsed; %clear int &hours, int &minutes, int &seconds, int &frames; %clear SmpteTimecodeType &timecodeType; %clear int &hours, int &minutes, int &seconds, int &frames; %include \ %apply float &OUTPUT { float &leftVol, float &rightVol }; // MidiOutput::getVolume %include \ %clear float &leftVol, float &rightVol; %include \ %apply float &OUTPUT { float& lowestLeft, float& highestLeft, float& lowestRight, float& highestRight }; %include \ %clear float& lowestLeft, float& highestLeft, float& lowestRight, float& highestRight; %include \ %nodefault; // SWIG don t see AudioCDReader already has a contructor with arguments %include \ %makedefault; %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ // // // JUCE APPLICATION FRAMEWORK - GUI (GRAPHICS) // %extend AffineTransform { AffineTransform \_\_mul\_\_(AffineTransform \*x) { return self-\>followedBy(\*x); } %pythoncode { def transform(self, point): (x, y) = point self.transformPoint(xp, yp) return (x, y) } }; %implicit(Justification, int); %inline { int get(const Justification &justification) { return justification.getFlags(); } } //%include \ //%include \ //%include \ //%include \ %apply float &OUTPUT { float& hue, float& saturation, float& brightness }; %include \ %clear float& hue, float& saturation, float& brightness; %include \ %include \ %include \ %apply float &OUTPUT { int &originX, int &originY }; // Graphics::getUnderlyingImage %include \ %clear int &originX, int &originY; %apply int &OUTPUT { int &x, int &y }; // Justification::applyToRectangle %include \ %clear int &x, int &y; %include \ %include \ %include \ //%include \ %include \ %apply float &OUTPUT { float &left, float &top, float &right, float &bottom }; %include \ %clear float &left, float &top, float &right, float ⊥ %include \ %include \ %apply float &INOUT { float& x, float& y }; %include \ %clear float& x, float& y; %apply float &OUTPUT { float &intersectionX, float &intersectionY }; // Line::intersects %include \ %clear float &intersectionX, float &intersectionY; %apply float &OUTPUT { float &x, float &y, float &w, float &h }; // Path::getBounds %include \ %clear float &x, float &y, float &w, float &h; %include \ %include \ %include \ %apply int &INOUT { int &x1, int &y1, int &w1, int &h1 }; // Rectangle::intersectRectangles %include \ %clear int &x1, int &y1, int &w1, int &h1; %include \ // SWIG can t parse libjpeg headers // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // %include \ // Don t use GIFLoader directly in an application // %include \ // SWIG can t parse libpng headers // %include \ // %include \ %include \ %include \ %include \ %include \ // // // JUCE APPLICATION FRAMEWORK - GUI (COMPONENTS) // %include \ %include \ %include \ %include \ %apply JUCE::Colour &OUTPUT { JUCE::Colour &text, JUCE::Colour &background, JUCE::Colour &highlightText, JUCE::Colour &highlightBackground }; // LookAndFeel::getPopupMenuColours %apply int &OUTPUT { int &idealWidth, int &idealHeight }; // LookAndFeel::getIdealPopupMenuItemSize %apply JUCE::Colour &OUTPUT { JUCE::Colour &background, JUCE::Colour &textColour, JUCE::Colour &outlineColour, JUCE::Colour &buttonColour, JUCE::Colour &popupBackground, JUCE::Colour &popupText, JUCE::Colour &popupHighlight }; // LookAndFeel::getComboBoxColours // LookAndFeel::getComboBoxFonts // LookAndFeel::getSliderColours // LookAndFeel::getSliderFont // LookAndFeel::getTooltipSize %include \ %clear JUCE::Colour &background, JUCE::Colour &textColour, JUCE::Colour &outlineColour, JUCE::Colour &buttonColour, JUCE::Colour &popupBackground, JUCE::Colour &popupText, JUCE::Colour &popupHighlight; %clear int &idealWidth, int &idealHeight; %clear JUCE::Colour &text, JUCE::Colour &background, JUCE::Colour &highlightText, JUCE::Colour &highlightBackground; %include \ %include \ // Nested class MouseHoverDetector::HoverDetectorInternal is not supported by SWIG parser // Use a "manual" proxy class // %include \ %include \ %apply RectangleList &OUTPUT { RectangleList &result }; %include \ %clear RectangleList &result; %include \ %apply int &OUTPUT { int &x, int &y }; // Desktop::getMousePosition, Desktop::getLastMouseDownPosition %include \ %clear int &x, int &y; //%include \ %include \ //%include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ //%include \ //%include \ %include \ %include \ %include \ %include \ //%include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ // SWIG bug ! // %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %include \ %apply int &OUTPUT { int &x, int &y, int &w, int &h }; // NativeDesktopWindow::getBounds %apply int &OUTPUT { int &leftThickness, int &topThickness, int &bottomThickness, int &rightThickness }; // NativeDesktopWindow::getFrameSize //%include \ %clear int &x, int &y, int &w, int &h; %clear int &leftThickness, int &topThickness, int &bottomThickness, int &rightThickness; %include \ // // // JUCE APPLICATION FRAMEWORK - TOOLBAG // %include \ %include \ %include \ ``` ---

**Author:** ![synth](https://avatars.discourse-cdn.com/v4/letter/s/e9a140/32.png) [@synth](https://forum.juce.com/u/synth)\ **Post date:** [October 1, 2014, 2:06pm UTC](https://forum.juce.com/t/python-bindings-using-swig/13655/2 "2014-10-01T14:06:53Z")

I get an error when running swig : juce\modules\juce\_core\memory\juce\_Atomic.h(73) : Warning 362: operator= ignored juce\modules\juce\_core\memory\juce\_Atomic.h(76) : Warning 362: operator= ignored juce\modules\juce\_core\memory\juce\_Atomic.h(79) : Warning 321: 'set' conflicts with a built-in name in python juce\modules\juce\_core\memory\juce\_Atomic.h(91) : Warning 383: operator++ ignored juce\modules\juce\_core\memory\juce\_Atomic.h(94) : Warning 384: operator-- ignored juce\modules\juce\_core\memory\juce\_Atomic.h(146) : Error: Syntax error in input(3). This seems to do with the JUCE\_ALIGN macro at juce\_Atomic.h(146) . I wonder if anyone knows how to ensure proper macro processing with SWIG. ---

**Author:** ![jamiebullock](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/jamiebullock/32/459_2.png) [@jamiebullock](https://forum.juce.com/u/jamiebullock)\ **Post date:** [November 15, 2018, 10:49am UTC](https://forum.juce.com/t/python-bindings-using-swig/13655/3 "2018-11-15T10:49:36Z")

@synth did you get this working in the end? I notice there is [a git repo](https://github.com/abhijitnandy2011/PyJuce), what’s the status of that? Jamie ---

**Author:** ![stpope](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/stpope/32/3002_2.png) [@stpope](https://forum.juce.com/u/stpope)\ **Post date:** [August 10, 2020, 8:05pm UTC](https://forum.juce.com/t/python-bindings-using-swig/13655/4 "2020-08-10T20:05:07Z")

I’m also trying to make a SWIG interface to JUCE for python scripting of JUCE DSP networks. Does anyone have any advice? I worked through most of the start-up issues, and had to comment out several c++11-specific things, but can’t get the compile commands set up so that I don’t get a load of syntax errors in juce\_MathsFunctions.h about the type specs missing. I used to use SWIG with JUCE 4 with no problems. ---

**Author:** ![stpope](https://sea2.discourse-cdn.com/flex026/user_avatar/forum.juce.com/stpope/32/3002_2.png) [@stpope](https://forum.juce.com/u/stpope)\ **Post date:** [August 11, 2020, 12:22am UTC](https://forum.juce.com/t/python-bindings-using-swig/13655/5 "2020-08-11T00:22:32Z")

> [@stpope](#): > > he start-up issues, and had to comment out several c++11-specific things, but can’t get the compile commands set up so that I don’t get a load of syntax errors in juce\_MathsFunctions.h abou So, is there anybody out there using SWIG with JUCE?