## Chapter 6: Building Pd from source

This chapter offers in depth details on how to build Pd from its source code and install it on different operating systems (macOS, Linux, BSD & Windows).

### 6.1. Requirements

Pd is built on the commandline using traditional Unix-style tools. The source distribution comes with two build systems:

- autotools: easy to use, many compilation options (recommended for most users)
- makefile: smaller & simpler, used for Pd binary downloads

The core build requirements are:

- Unix command shell: bash, dash, etc
- C compiler chain: gcc/clang & make

And a core runtime requirement is:

- Tcl/Tk: Tk wish shell

Optional features:

- autotools: autoconf, automake, & libtool (if building with the autotools)
- gettext: build localizations in the po directory
- JACK: audio server support
- FFTW: use the optimized FFTW Fast Fourier Transform library

### 6.2. General autotools build steps

Building Pd using the GNU autotools involves the following steps for all platforms:

- 1. configure: detect & set library and platform options
- 2. make: compile Pd, associated tools, and resource files (ie. translations)
- 3. install: install the Pd binaries and resources onto your system

Overview:

    cd path/to/pd
    ./autogen.sh
    ./configure
    make

Note: Additional platform-specific options and build targets are listed in following sections.

Start by opening a commandline shell and navigating to the Pd source directory:

    cd path/to/pd

First generate the configure script and various build files by running:

    ./autogen.sh

Next configure Pd with the default options for your platform:

    ./configure

You can verify the configuration options that the configure step script prints:

    pd 0.55.0 is now configured

    Platform:             Mac OSX
    Debug build:          no
    Universal build:      no
    Localizations:        no
    Source directory:     .
    Installation prefix:  /usr/local

    ...

    audio APIs:           PortAudio
    midi APIs:            PortMidi

If you want to change these options, you can specify/override the configure script settings on the commandline:

    # change install prefix to /usr
    ./configure --prefix /usr

    # build Pd with the JACK audio server backend
    ./configure --enable-jack

    # build Pd using a system installed PortAudio
    ./configure --without-local-portaudio

If you need to run Pd through a debugger (like gdb), you can build Pd with debugging symbols using the "--enable-debug" flag.

    # build Pd with debugging information
    ./configure --enable-debug

An important configure option for some platforms is `--enable-universal` which allows you to specify the desired architecture(s) when building Pd. For Intel and AMD processors, 32 bit is called "i386" and 64 bit is "x86_64". By default, Pd is built for the architecture of the current system, however you may want a 32 bit Pd to work with existing 32 bit externals on a 64 bit system. You can override the defaults with `--enable-universal`:

    # build 32 bit Pd
    ./configure --enable-universal=i386

    # build 64 bit Pd
    ./configure --with-universal=x86_64

You can compile a "Double precision" Pd (aka "Pd64") with:

    ./configure --with-floatsize=64

The full list of available configuration options can printed by running:

    ./configure --help

Now that Pd is configured, build by running:

    make

Building should take a minute or two. If compilation was successful, in Linux, you can run Pd from the build directory without installing it:

    cd bin
    ./pd

You need to create an app so you can use your build in macOS and Windows.

    make app

To install to your Linux system using the configuration prefix (default `/usr/local`), do:

    sudo make install

You can also to a custom location via:

    make install DESTDIR=~/pd-xxx prefix=/

Once installed, you should now be able to run Pd from the commandline:

    pd

If want to uninstall, make sure Pd is configured and then run:

    sudo make uninstall

If you compiled Pd using the `--enable-universal` configure option and want to double check which architectures Pd was built with, use the "file" command:

    # examine binary in the src directory
    $ file src/pd
    ...
    src/pd: Mach-O 64-bit executable x86_64

    # look at pd inside a macOS .app bundle
    $ file Pd.app/Contents/Resources/bin/pd
    ...
    Pd-0.55.0.app/Contents/Resources/bin/pd: Mach-O 64-bit executable x86_64

More details specific to each platform follow next.

### 6.3. Building Pd for Linux

Platform requirements:

- ALSA: Linux sound library (recommended)
- OSS: historical precursor to ALSA, generally not used
- JACK: JACK audio server (optional)

Install the core build requirements using your distribution's package manager. For Debian, you can install the compiler chain, autotools, & gettext with:

    sudo apt-get install build-essential automake autoconf libtool gettext

For libraries, you will need to install the "development" versions which include the source code header files. In Debian, the ALSA development package is called "libasound2-dev":

    sudo apt-get install libasound2-dev

Similarly, optional development libraries can be also be installed to for additional features. Install the JACK development files on Debian:

    sudo apt-get install libjack-jackd2-dev

In case you are using jackd1 instead of jackd2, use:

    sudo apt-get install libjack-dev

Most distributions come with Tcl/Tk installed, so you should be able to run Pd after it is built.

Once your build system is set up, you can follow the general autotools build steps to build Pd.

### 6.4. Building Pd for BSD

Building Pd for the various BSD variants is similar to the Linux way. The major difference is the used package manager (and the names of the packages), you’ll want to install.

#### 6.4.1. FreeBSD

(Tested on FreeBSD-13)

Install the core build requirements:

    sudo pkg install gcc automake autoconf libtool gettext gmake

You may install one (or more) libraries (depending on your needs). It seems that with FreeBSD-13, there are ALSA and JACK packages available:

    sudo pkg install alsa-lib jackit

Once your build system is set up, you can follow the general autotools build steps to build Pd, but make sure to use `gmake` (aka “GNU make”). The ordinary BSD `make` will not suffice!

    ./autogen.sh
    ./configure --deken-os=FreeBSD MAKE=gmake
    gmake

    sudo gmake install

#### 6.4.2. OpenBSD

(Tested on OpenBSD-7)

Install the core build requirements:

    sudo pkg_add gcc automake autoconf libtool gettext-tools gmake

(If there are multiple versions for one or more of the packages, pick your favourite or the newest one).

You may install one (or more) libraries (depending on your needs). It seems that with OpenBSD-7, there are only JACK packages available:

    sudo pkg_add jack

By default, OpenBSD installs all its packages into `/usr/local/`, but the compiler does not look for headers resp. libraries in this directory. We can instruct autotools to automatically consider these directories by creating a file `/usr/local/share/config.site`:

    cat | sudo tee /usr/local/share/config.site>/dev/null << EOF
    CPPFLAGS="-I/usr/local/include \$CPPFLAGS"
    LDFLAGS="-L/usr/local/lib \$LDFLAGS"
    EOF

Also, because OpenBSD allows to coinstall multiple versions of the autotools (with no “default”), we must specify which version we want to use:

    export AUTOCONF_VERSION=$(ls -S /usr/local/bin/autoconf-* | sed -e 's|.*-||' | sort -n | tail -1)
    export AUTOMAKE_VERSION=$(ls -S /usr/local/bin/automake-* | sed -e 's|.*-||' | sort -n | tail -1)

Now that your build system is set up, you can follow the general autotools build steps to build Pd, but make sure to use `gmake` (aka “GNU make”). The ordinary BSD `make` will not suffice!

    ./autogen.sh
    ./configure --deken-os=OpenBSD --enable-jack MAKE=gmake
    gmake

    sudo gmake install

#### 6.4.3. NetBSD

(Tested on NetBSD-9)

Install the core build requirements:

    sudo pkgin install gcc automake autoconf libtool gettext-tools gmake

You may install one (or more) libraries (depending on your needs). It seems that with NetBSD-9, there are JACK and ALSA packages available, but the ALSA packages seem to be broken. OSS appears to be built-in.

    sudo pkgin install jack

By default, NetBSD installs all its packages into `/usr/pkg/`, but the compiler does not look for headers resp. libraries in this directory. We can instruct autotools to automatically consider these directories by creating a file ‘/usr/pkg/share/config.site’:

    cat | sudo tee /usr/pkg/share/config.site>/dev/null << EOF
    CPPFLAGS="-I/usr/pkg/include \$CPPFLAGS"
    LDFLAGS="-L/usr/pkg/lib -Wl,-R/usr/pkg/lib \$LDFLAGS"
    EOF

Now that your build system is set up, you can follow the general autotools build steps to build Pd, but make sure to use `gmake` (aka “GNU make”). The ordinary BSD `make` will not suffice!

    ./autogen.sh
    ./configure --deken-os=NetBSD --prefix=/usr/pkg --disable-alsa --enable-jack MAKE=gmake
    gmake

    sudo gmake install

### 6.5. Building Pd for macOS

macOS is built on top of a BSD system and the bash commandline can be accessed with the Terminal application in the `/Applications/Utility` directory.

The clang compiler and associated tools are provided by Apple. If you are running macOS 10.9+, you do not need to install the full Xcode application and can install the Commandline Tools Package only by running the following:

    xcode-select --install

For macOS versions earlier than 10.9, you will need to install Xcode from the Mac App Store or downloaded from http://developer.apple.com

Tcl/Tk is already included macOS.

To install the autotools, gettext, and libraries for additional features, you can use one of the open source package managers for macOS:

- homebrew: https://brew.sh (recommended)
- macports: https://www.macports.org

Follow the package manager set up instructions and then install the software you need. For example, to install the autotools & gettext using Homebrew:

    brew install automake autoconf libtool pkg-config gettext
    brew link --force gettext

By default, Pd is built for the current system architecture, usually 64 bit. If you want to override this you can use the `--enable-universal` configure option which allows you to specify the desired architecture(s) when building Pd. For Intel/AMD processors, 32 bit is called "i386" and 64 bit is "x86_64". For Apple Silicon processors (M1, M2, etc), the 64 bit architecture is called "arm64". By default, Pd is built for the architecture of the current system, however you may want a 32 bit Pd to work with existing 32 bit externals on a 64 bit system. You can override the defaults with `--enable-universal`: you want to override this you can use the `--enable-universal` configure option, as mentioned in the main Autotools Build section. On macOS, running this option without arguments will build a "fat" Pd for all architectures supported by the compiler:

- macOS 10.6: i386, x86_64, ppc
- macOS 10.7+: i386, x86_64
- macOS 10.15: x86_64
- macOS 11+: x86_64, arm64

Note: a "fat" Pd may not work on all systems and/or be able to load both 32 or 64 bit externals. Additionally, you can specify multiple architectures directly:

    # build a "fat" Pd for both 32 and 64 bit Intel
    # may not work on all systems
    ./configure --enable-universal=i386,x86_64

    # build a "fat" Pd for all detected architectures (macOS: i386, x86_64, ppc)
    # may not work on all systems
    ./configure --enable-universal

The JACK audio server is supported by Pd on macOS. By default, Pd can use either the official 64-bit builds for macOS 10.12+ from https://jackaudio.org or the older, 32-bit Jack OS X runtime framework if one is installed on the system. Optionally, Pd can also be built with Jack installed via Homebrew or Macports, however the runtime framework support must be disabled:

    brew install jack
    ./configure --disable-jack-framework --enable-jack

You should now be ready to build Pd by following the general autotools build steps. Once built, there are two options for installation:

- build a standalone macOS application (recommended)
- install to your system as a commandline program

To build the Pd macOS application, simply run:

    make app

This builds Pd-#.##.#.app in the Pd source directory which can be then be double-clicked and/or copied to `/Applications`. For more info & options regarding the Pd .app bundle, see 6.5.1. macOS app bundle.

If you want to have both the Pd application and use Pd from the commandline, add command aliases to the binaries inside the .app to your `~/.bash_profile`:

    WHICHPD="Pd-0.55-0"
    alias pd="/Applications/$WHICHPD.app/Contents/Resources/bin/pd"
    alias pdsend="/Applications/$WHICHPD.app/Contents/Resources/bin/pdsend"
    alias pdreceive="/Applications/$WHICHPD.app/Contents/Resources/bin/pdreceive"

Next, reload the profile by either opening a new Terminal window or running:

    source ~/.bash_profile

If you install Pd to your system with "make install", the Tk 8.5.9 currently included with the system (as of macOS 10.14) is buggy and should not be used. It is recommended to install a newer version, either via Homebrew or from the ActiveState Tcl/Tk downloads.

To see which version the Pd GUI is using: set the log level to 4 & look for the Tk version log line in the Pd window.

Another option is to set the Tk Wish command Pd uses to launch the GUI. At start, Pd does a quick search in the "usual places" for Wish and chooses the first path that exists. Versions of macOS up to 10.12 also ship with Tcl/Tk 8.4 which works fine and this wish can be invoked by Pd using the full path `/usr/bin/wish8.4`. You can configure Pd to use this search path first with:

    ./configure --with-wish=/usr/bin/wish8.4

To see Pd's path search info, run Pd with the -verbose flag:

    pd -verbose

Note: Pd installed to your system or run from the build/bin directory will not use the default font and will be missing the various macOS GUI hints (such as retina rendering) which are specified by the Info.plist file inside the .app bundle. Again, it is recommended to build a .app and use the aforementioned aliases to provide the pd command.

#### 6.5.1. macOS app bundle

Directory pure-data/mac contains support files for building a Pure Data macOS application bundle and supplementary build scripts for compiling Pd on Macintosh systems, as it is built for the ‘vanilla’ releases on msp.ucsd.edu.

In a nutshell, a monolithic macOS “application” is simply a directory structure treated as a single object by the OS. Inside this bundle are the compiled binaries, resource files, and contextual information. You can look inside any application by either navigating inside it from the commandline or by right-clicking on it in Finder and choosing “Show Package Contents.”

The basic layout is:

    Pd-0.55-0.app/Contents
      Info.plist  <- contextual info: version string, get info string, etc
      /Frameworks <- embedded Tcl/Tk frameworks (optional)
      /MacOS/Pd   <- renamed Wish bundle launcher
      /Resources
        /bin      <- pd binaries
        /doc      <- built in docs & help files
        /extra    <- core externals
        /font     <- included fonts
        /po       <- text translation files
        /src      <- Pd source header files
        /tcl      <- Pd GUI scripts

The Pure Data GUI utilizes the Tk windowing shell aka “Wish” at runtime. Creating a Pure Data .app involves using a precompiled Wish.app as a wrapper by copying the Pd binaries and resources inside of it.

##### 6.5.1.1. macOS App bundle helpers

- osx-app.sh: creates a Pd .app bundle for macOS using a Tk Wish.app wrapper
- tcltk-wish.sh: downloads and builds a Tcl/Tk Wish.app for macOS

These scripts complement the autotools build system described in INSTALL.txt and are meant to be run after Pd is configured and built. The following usage, for example, downloads and builds a 32 bit Tk 8.6.6 Wish.app which is used to create a macOS Pd-0.55-0.app:

    mac/tcltk-wish.sh --arch i386 8.6.6
    mac/osx-app.sh --wish Wish-8.6.6.app 0.55-0

Both osx-app.sh & tcltck-wish.sh have extensive help output using the `--help` commandline option:

    mac/osx-app.sh --help
    mac/tcltk-wish.sh --help

The osx-app.sh script automates building the Pd .app bundle and is used in the `make app` makefile target. This default action can be invoked manually after Pd is built:

    mac/osx-app.sh 0.55-0

This builds a `Pd-0.55-0.app` using the included Wish. If you omit the version argument, a `Pd.app` is built. The version argument is only used as a suffix to the file name and contextual version info is pulled from configure script output.

A pre-built universal (32/64 bit) Tk 8.6.10+ Wish with patches applied is included with the Pd source distribution and works across the majority of macOS versions up to 10.15. This is the default Wish.app when using `osx-app.sh`. If you want to use a different Wish.app (a newer version, a custom build, a system version), you can specify the donor via commandline options, for example:

    # build Pd-0.55-0.app using Tk 8.6 installed to the system
    mac/osx-app.sh --system-tk 8.6 0.55-0

If you want Pd to use a newer version of Tcl/Tk, but do not want to install to it to your system, you can build Tcl/Tk as embedded frameworks inside of the Pd .app bundle. This has the advantage of portability to other systems.

The tcltk-wish.sh script automates building a Wish.app with embedded Tcl/Tk, either from the release distributions or from a git clone:

    # build Wish-8.6.6.app with embedded Tcl/Tk 8.6.6
    mac/tcltk-wish.sh 8.6.6

    # build Wish-master-git.app from the latest Tcl/Tk master branch from git
    mac/tcltk-wish.sh --git master-git

You can also specify which architectures to build (32 bit, 64 bit, or both):

    # build 32 bit Wish-8.6.6.app with embedded Tcl/Tk 8.6.6
    mac/tcltk-wish.sh --arch i386 8.6.6

    # build universal (32 & 64 bit)
    mac/tcltk-wish.sh --universal 8.6.6

Once your custom Wish.app is built, you can use it as the .app source for osx-app.sh with the -w/–wish option:

    # build Pd with a custom Tcl/Tk 8.6.6 Wish
    mac/osx-app.sh -w Wish-8.6.6.app

Downloading and building Tcl/Tk takes some time. If you are doing lots of builds of Pd and/or are experimenting with different versions of Tcl/Tk, building the embedded Wish.apps you need with tcltk-wish.sh can save you some time as they can be reused when (re)making the Pd .app bundle.

Usually, it’s best to use stable releases of Tcl/Tk. However, there are times when building from the current development version is useful. For instance, if there is a bug in the Tcl/Tk sources and the generated Wish.app crashes on your system, you can then see if there is a fix for this in the Tcl/Tk development version on GitHub. If so, then you can test by using the tcltk-wish.sh `--git` commandline option. Oftentimes, these kinds of issues will appear with a newer version of macOS before they have been fixed by the open source community.

Additionally, Pd uses an older version of Tcl/Tk for backwards compatibility on macOS. As such, small bugfixes from newer versions may need to be backported for the Pd GUI. Currently, this is handled in the tcltk-wish.sh script by applying custom patches to either the Tcl and/or Tk source trees. To skip applying patches, use the tcltk-wish.sh `--no-patches` commandline option. See `mac/patches/README.txt` for more info.

#### 6.5.2. Supplementary macOS build scripts

- build-macosx: builds a 32 bit Pd .app bundle using src/makefile.mac
- build-mac64: builds a 64 bit Pd .app bundle using src/makefile.mac

These scripts automate building Pd with the fallback makefiles in the src directory.

To build a 32 bit Pd, copy this “mac” directory somewhere like `~/mac`. Also copy a source tarball there, such as pd-0.55-0.src.tar.gz. Then cd to `~/mac` and type:

    ./build-macosx 0.55-0

If all goes well, you’ll soon see a new app appear named Pd-0.55-0.app.

If you want to build a 64 bit Pd, perform the same steps and use the build-mac64 script:

    ./build-mac64 0.55-0

Note: The “wish-shell.tgz” is an archive of this app I found on my mac: `/System/Library/Frameworks/Tk.framework/Versions/8.4/Resources/Wish Shell.app`

A smarter version of the scripts ought to be able to find that file automatically on your system so I wouldn’t have to include it here.

#### 6.5.3. Preferences

The Pure Data preferences are saved in the macOS “defaults” preference system using the following domains:

- `org.puredata.pd`: core settings (audio devices, search paths, etc)
- `org.puredata.pd.pd-gui`: GUI settings (recent files, last opened location, etc)

The files themselves live in your user home folder and use the .plist extension:

    ~/Library/Preferences/org.puredata.pd.plist
    ~/Library/Preferences/org.puredata.pd.pd-gui.plist

These files use the Apple Property List XML format and shouldn’t be edited directly. You can look inside, edit, and/or delete these using the `defaults` commandline utility in Terminal:

    # print the contents of the core settings
    defaults read org.puredata.pd

    # delete the current GUI settings
    defaults delete org.puredata.pd.pd-gui

    # set the startup flag in the core settings
    defaults write org.puredata.pd -array-add flags '-lib Gem'

Some important per-application settings required by the GUI include:

- `NSRecentDocuments`: string array, list of recently opened files
- `NSQuitAlwaysKeepsWindows`: false, disables default 10.7+ window state saving
- `ApplePressAndHoldEnabled`: false, disables character compose popup, enables key repeat for all keys
- `NSRequiresAquaSystemAppearance`: true, disables dark mode for Pd GUI on 10.14+

These are set in:

    tcl/pd_guiprefs.tcl

#### 6.5.4. Code signing

As of Pd 0.51, the mac/osx-app.sh script performs “ad-hoc code signing” in order to set entitlements to open un-validated dynamic libraries on macOS 10.15+. This is required due to the new security settings. Note: ad-hoc signing doesn’t actually sign the .app bundle with an account certificate, so the unidentified developer warning is still shown when the downloaded .app is run for the first time.

#### 6.5.5. Privacy permission

The macOS 10.14 release introduced system privacy permissions for actions applications can undertake on a user account, such as accessing files or reading microphone or camera input. When an application is started for the first time and tries to access something that is covered by the privacy settings, a permissions prompt is displayed by the system requesting access. The action is then allowed or denied and this setting is saved and applied when the application is run again in the future.

As of macOS 10.15, running Pd will request access for the following:

- Files and Folders: Documents
- Files and Folders: Desktop
- Microphone

Additionally, using an external such as Gem for camera input will request access to the Camera.

The current permissions can be changed in Privacy panel in System Preferences. They can also be reset on the commandline using the `tccutil` command and the Pd .app bundle id:

    # reset Pd's Microphone privacy setting
    tccutil reset Microphone org.puredata.pd.pd-gui

    # reset all of Pd's privacy settings
    tccutil reset All org.puredata.pd.pd-gui

#### 6.5.6. Font issues with macOS 10.15+

macOS 10.15 added further changes to font rendering beginning with 10.14, with the weird result that Pd’s default font, DejaVu Sans Mono, renders thinner and with narrower letter spacing than system fonts. This results in objects on the patch canvas being wider than their inner text and text selection positioning being off.

To remedy this for now, Pd 0.51-3 changed Pd’s default font for macOS to Menlo which is included with the system since 10.6. Menlo is based on Bitstream Vera Mono and DejaVu Sans Mono, so there should be no issues with patch sizing or positioning.

#### 6.5.7. Dark mode

Pd currently disables Dark Mode support by setting the NSRequiresAquaSystemAppearance key to true in both the app bundle’s Info.plist and the GUI defaults preference file. This restriction may be removed in the future once Dark Mode is handled in the GUI.

#### 6.5.8. Debugging releases

On macOS 10.15+, apps must be signed with an entitlement to allow debugging. This is good for security, but bad if you want to run Pd in lldb to figure out why your custom external is crashing.

To make this work, the entitlement can be added to an existing Pd release .app bundle using the `codesign` command in Terminal (steps by Pierre Alexandre Tremblay):

- Extract the current Pd entitlements from the internal pd binary:

        codesign -d /Applications/Pd-0.53-2.app/Contents/Resources/bin/pd \
        --entitlements :~/Desktop/pd-entitlements.xml

- Edit pd-entitlements.xml on your Desktop, add the following key, and save:

        <key>com.apple.security.get-task-allow</key>
        <true/>

- Re-sign the pd binary with the updated entitlements:

        codesign -s - --deep --force --options=runtime \
        --entitlements ~/Desktop/pd-entitlements.xml \
        /Applications/Pd-0.53-2.app/Contents/Resources/bin/pd

Now Pd can be run with lldb using:

    lldb /Applications/Pd-0.53-2.app/Contents/Resources/bin/pd

Note: Re-signing using an ad-hoc identifier will work on the development system, but running the Pd .app bundle on another system will result in security warnings as the original signature and notarization are invalid.

### 6.6. Building Pd for Microsoft Windows

Pd on Windows can be built with either MinGW or Cygwin which provide the core build requirements: a compiler chain & shell environment.

It is recommended to use the Msys2 distribution which provides both a Unix command shell and MinGW. Download the Msys2 "x86_64" 64 bit installer (or "i686" if you are using 32 bit Windows) from:

http://www.msys2.org/

Then install to the default location (`C:\msys32` or `C:\msys64`) and follow the setup/update info on the Msys2 webpage.

Msys2 provides both 32 and 64 MinGW and command shells. As of Pd 0.50, the Pd release is 64 bit for Windows, so it is recommended to set up and use the MinGW 64 bit shell. If you want to build a 32 bit Pd, similarly use the MinGW 32 bit shell. Due to how MinGW is designed, you cannot build a 64 bit Pd with a 32 bit MinGW and vice versa. This also means the Pd configure `--enable-universal` build option has no effect in MinGW.

Note: Msys2 development seems to change frequently, so some of the package names below may have changed after this document was written.

Open an Msys2 shell and install the compiler chain, autotools, & gettext via:

    # The MINGW_PACKAGE_PREFIX variable is automatically set by MinGW
    # On MinGW64, it is MINGW_PACKAGE_PREFIX=mingw-w64-x86_64
    # On MinGW32, it is MINGW_PACKAGE_PREFIX=mingw-w64-i686
    pacman -S make autoconf automake libtool \
              ${MINGW_PACKAGE_PREFIX}-toolchain ${MINGW_PACKAGE_PREFIX}-clang \
              ${MINGW_PACKAGE_PREFIX}-gettext

Install git if you want to clone the Pd sources from Github, etc:

    pacman -S git

and/or the nsis installer tool if you want to build the Pd Windows installer:

    # 64 bit
    pacman -S mingw-w64-x86_64-nsis

    # 32 bit
    pacman -S mingw-w64-i686-nsis

Note: You can also search for packages in Msys2 with:

    pacman -S -s <searchterm>

Once the packages are installed, you should now be ready to build Pd by following the general autotools build steps.

The following audio APIs are available on Windows and can be enabled/disabled via their configure flags:

- MMIO: `--enable-mmio` or `--disable-mmio` (default enabled)
- ASIO: `--enable-asio` or `--disable-asio` (default enabled, if found)
- JACK: `--enable-jack` or `--disable-jack`

For example, to build Pd without MMIO support:

    ./configure --disable-mmio

Note: Because of license restrictions, Pd cannot distribute the ASIO SDK source files. If you want to build Pd with ASIO support, see 6.6.4 Windows ASIO support for further instructions.

Once built Pd is built, you can either:

- build a Pd application directory for Windows (recommended)
- build a Windows installer

A Pd application directory is essentially a self-contained Pd package which should run out of the box. To build, simply use:

    make app

This will create a "pd-VERSION" directory (ie. pd-0.48.1) which can then be used by running pd.exe in the bin directory and placed wherever on your system. More info & options regarding the Pd app directory is provided next

To build a .msi Windows installer for Pd, see msw/build-nsi.sh.

Note: The standard `make install` requires Tcl/Tk and won't work outside your Cygwin/Msys2 environment (if at all).

#### 6.6.1. Building a Pd application

Directory pure-data/msw contains support files for building a Pure Data Windows application, as it is built for the ‘vanilla’ releases on msp.ucsd.edu.

As of Pd version 0.50, all releases are compiled using Dan Wilcox’s scripts, `msw-app.sh`, and optionally `tcltk-dir.sh` (which builds a version of TCL/TK in case you don’t already have one).

The Pd sources aren’t completely self-contained: Because of licensing restrictions, the ASIO support files are not included in the Pd source tree. The `msw-app.sh` script presumes you’ve downloaded the ASIO SDK and can point `msw-app.sh` to it.

It’s also possible to compile Pd using Visual C. This is not managed automatically but you can look in `how-to-use-msvc.sh`; to see how it can be done. This compiler gives different warnings which are sometimes useful, and refuses to compile code that has variable declarations in the middle of a block. It’s a good idea to test pull requests against MSVC if you can. The file `pdprototype.zip` contains all the garbage that Pd needs in addition to its own files, including tcl/tk. MSVC compilation works in 32 bits only.

The scripts `build-msw-32.sh` and `build-msw-64.sh` are the ones used by Miller to make Pd releases. These files work on Linux only and will not work out of the box unless your file tree resembles Miller’s in some ways (pd source is in `~/pd` for instance) but you can presumably make your own version if you need to.

But to first get things working, it’s best to use `msw-app.sh` and `tcltk-dir.sh` directly.

#### 6.6.2. Pd application directory

Pd for Windows is essentially a stand-alone application directory which contains the compiled binaries, resource files, and contextual information.

The basic layout is:

    pd
      /bin      <- pd binaries
      /doc      <- built in docs & help files
      /extra    <- core externals
      /font     <- included fonts
      /lib      <- embedded Tcl/Tk frameworks
      /po       <- text translation files
      /src      <- Pd source header files
      /tcl      <- Pd GUI scripts

The Pure Data GUI utilizes the Tk windowing shell aka “wish##.exe” at runtime which is included with Pd in the `/bin` directory. A Pure Data app directory includes both the Pd binaries and resources as well as a precompiled Tk.

##### 6.6.2.1. Windows app bundle helpers

- `msw-app.sh`: creates a Pd app directory for Windows using precompiled Tcl/Tk
- `tcltk-dir.sh`: downloads and builds Tcl/Tk for Windows

These scripts complement the autotools build system described in INSTALL.txt and are meant to be run after Pd is configured and built. The following usage, for example, downloads and builds 32 bit Tk 8.6.8 which is used to create a Windows pd-0.48-1 directory:

    msw/tcltk-dir.sh 8.6.8
    msw/msw-app.sh --tk tcltk-8.6.8 0.48-1

Both `msw-app.sh` & `tcltck-dir.sh` have extensive help output using the `--help` commandline option:

    msw/msw-app.sh --help
    msw/tcltk-dir.sh --help

The `msw-app.sh` script automates building the Pd app directory and is used in the `make app` makefile target. This default action can be invoked manually after Pd is built:

    msw/msw-app.sh 0.55-0

This builds a “pd-0.55-0” directory using the default copy of Tk. If you omit the version argument, a “pd” directory is built. The version argument is only used as a suffix to the directory name.

The `msw/pdprototype.tgz` archive contains the basic requirements for running Pd on Windows: a precompiled copy of Tcl/Tk and various .dll library files. This is the default Tcl/Tk when using msw-app.

If you want to use a newer Tcl/Tk version or a custom build, you can specify the version or directory via commandline options, for example:

    # create pd-0.48-1 directory, download and build Tcl/Tk 8.5.19
    msw/msw-app.sh --tk 8.5.19 0.48-1

    # create pd-0.48-1 directory, use Tcl/Tk 8.5.19 built with tcltk-dir.sh
    msw/msw-app.sh --tk tcltk-8.5.19 0.48-1

Note: Depending on which version of Tcl/Tk you want to use, you may need to set the Tk Wish command when configuring Pd. To build Pd to use Tk 8.6:

    ./configure --with-wish=wish86.exe
    make

The tcltk-dir.sh script automates building Tcl/Tk for Windows, either from the release distributions or from a git clone:

    # build tcltk-8.5.19 directory with Tcl/Tk 8.5.19
    msw/tcltk-dir.sh 8.5.19

    # build tcltk-master-git with the latest master branch from git
    msw/tcltk-dir.sh --git master-git

Once your custom Tcl/Tk is built, you can use it as the Tk directory source for msw-app.sh with the -t/–tk option:

    # build Pd with a custom Tcl/Tk 8.6.8 directory
    msw/msw-app.sh -t tcltk-8.6.8

Downloading and building Tcl/Tk takes some time. If you are doing lots of builds of Pd and/or are experimenting with different versions of Tcl/Tk, building the tcltk directories you need with tcltk-dir.sh can save you some time as they can be reused when (re)making the Pd app directory.

Usually, it’s best to use stable releases of Tcl/Tk. However, there are times when building from the current development version is useful. For instance, if there is a bug in the Tcl/Tk sources, you can then see if there is a fix for this in the Tcl/Tk development version on GitHub. If so, then you can test by using the tcltk-dir.sh `--git` commandline option.

The tcltk-dir.sh script tries to detect if it’s building in a 64 bit environment, ie. MinGW 64. If this detection fails, you can force 64 bit with the `--64bit` option:

    # force 64 bit Tcl/Tk 8.6.8 build
    tcltk-dir.sh --64bit 8.6.8

#### 6.6.3. pdfontloader

Tk cannot load local font files by default on Windows. Pd accomplishes this through a tiny, custom Tcl extension, pdfontloader.dll. On initialization, the Pd GUI tries to load pdfontloader and, if successful, tries to load the included Pd font.

Currently, pdfontloader.dll is pre-built and included within the pdprototype.tgz tarball. To build pdfontloader, see https://github.com/pure-data/pdfontloader source.

#### 6.6.4. ASIO support

In order to build ASIO support into Pd on Windows, you need to download the ASIO sources from Steinberg directly. Their license does not let us redistribute their source files.

Install the ASIO SDK by doing the following:

- 1. Download the ASIO SDK: https://www.steinberg.net/en/company/developer.html
- 2. Uncompress asiosdk2.3.zip (or higher) into pure-data/asio/
- 3. remove the version number so that you get pure-data/asio/ASIOSDK

Now build Pd and it should include ASIO as one of the audio backends.

### 6.7. Cross-compilation for Windows on Linux

You can also build a Windows binary of Pd on a Linux system, using a cross-compilation toolchain.

For Debian based systems (e.g. Ubuntu), you can install the toolchain with:

    sudo apt-get install build-essential automake autoconf libtool gettext
    sudo apt-get install mingw-w64 mingw-w64-tools
    sudo apt-get install nsis

The "mingw-w64" package will install the cross compilation toolchains for both 32bit (`g++-mingw-w64-i686`, `binutils-mingw-w64-i686`) and 64bit (`g++-mingw-w64-x86-64`, `binutils-mingw-w64-x86-64`).

The "nsis" package is purely optional, and only needed if you want to build the installer.

You must tell configure that you want to cross-compile for a given architecture via the `--host` configure flag.

For example, to build a 32 bit Pd:

    ./configure --host=i686-w64-mingw32

Similarly, to build a 64 bit Pd without ASIO support:

    ./configure --disable-asio --host=x86_64-w64-mingw32

If all went well, you should now be ready to build Pd, as explained in the instructions above in the "Windows" section:

    make app

### 6.8. Makefile build

Alternatively, and often more simply, to the autotools build, you can use the fallback makefiles in the src directory:

- `src/makefile.gnu`: GNU/Linux
- `src/makefile.mac`: macOS
- `src/makefile.msvc`: Windows with Microsoft Visual C
- `src/makefile.mingw`: Windows with MinGW GCC

On Linux, for example, run the GNU-specific makefile in the src directory:

    cd src
    make -f makefile.gnu

You can then run directly out of the bin directory without installing:

    cd ../bin
    ./pd

For Microsoft Visual C, first build Pd with the MS VC makefile and then build each external in the extra directory:

    cd src
    make -f makefile.msvc
    cd ../extra/bob~
    make pd_nt
    cd ../bonk~ && make pd_nt
    cd ../choice && make pd_nt
    cd ../fiddle~ && make pd_nt
    ...

To install Pd to your system on Linux, macOS, & MinGW (Windows), use the `install` makefile target. For Linux, this is:

    make -f makefile.gnu install

Once installed, you should now be able to run Pd from the commandline:

    pd

If want to uninstall, simply run the `uninstall` makefile target:

    make -f makefile.gnu uninstall

On macOS, you can build a clickable Pd .app bundle using the supplemental build scripts in the mac directory (see 6.5.1 macOS resources for more info).

### 6.9. Troubleshooting

Let us know if you run any issues with building or installing Pd:

- send an email to the Pd-List: https://lists.iem.at/postorius/lists/pd-list.lists.iem.at/
- open an issue: https://github.com/pure-data/pure-data/issues
- post to the Pd forum: https://forum.pdpatchrepo.info

Please include information involved with your problem such as:

- information about your system: OS version, libraries installed, etc
- configure or make output including error lines
- steps you took: configuration options, etc