Skip to content

Latest commit

 

History

History
203 lines (184 loc) · 8.46 KB

SETUP.md

File metadata and controls

203 lines (184 loc) · 8.46 KB
Raw

Xcode project to write Max/MSP and Pd externals

Steps to create a new project

Create the project

  1. Create a new project:
    • macOS > Framework & Library > Bundle
    • Name: Max
    • Bundle extension: mxo
  2. Add a new target:
    • macOS > Framework & Library > Library
    • Product name: Pd
    • Framework: None (Plain C/C++ Library)
    • Type: Dynamic
  3. Rename the project to template~:
    • Uncheck the targets from the project content items
    • Close the project
    • Reorganize the files in Finder following the next structure:
        DAO-MaxMSP-Pd
        ├── _COMMON_
        │   ├── ConfigMax.xcconfig
        │   ├── ConfigPd.xcconfig
        |   └── Info.plist
        ├── _SDK_
        │   ├── max-sdk (git submodule)
        │   └── pure-data (git submodule)
        └── template~
            ├── Products
            │   ├── template.maxpat
            │   └── template.pd
            ├── Source
            │   ├── template~common.c
            │   ├── template~common.h
            │   ├── template~max.c
            │   └── template~pd.c
            └── Xcode
                └── template~.xcodeproj

Setup the project

  1. Open the project
  2. Delete the folder Max in Xcode's project navigator
  3. Add a New Group without Folder named Config:
    • Add the ConfigMax.xcconfig and ConfigPd.xcconfig files
  4. Select the project info:
    • Set the configuration targets for debug and release
  5. Select the Max target and delete the next build settings (to select the custom configuration):
    • Installation Directory
    • Skip Install
    • Info.plist File
    • Product Bundle Identifier
    • Product name
  6. Select the Pd target and delete the next build settings (to select the custom configuration):
    • Executable prefix
    • Info.plist File
    • Product name
  7. Add a scheme named All:
    • Add both targets to its Build phase
    • Manage schemes and check the Shared box in every scheme
  8. Edit the Max and Pd schemes and add the executables for debugging:
    • For Max: /Applications/Max.app
    • For Pd: /Applications/Pd.app/Contents/Resources/bin/pd

Add source code

  1. Add a New Group without Folder named Source
    • Add new source files and select the corresponding target membership for each file:
      • template~common.c (Max)
      • template~common.h
      • template~max.c (Both)
      • template~pd.c (Pd)

Code, build, and enjoy!

Steps to copy an existing project

  1. Copy an existing project and paste it into a folder with the new name
  2. Open the Xcode project
  3. Rename the project (and the targets)
  4. Rename all the source files:
    • Separator ~ for msp and _ for max objects
  5. Search for all occurrences of the old name and replace them with the new name:
    • Search for oldname replace with newname
    • If the new external is a max-only object:
      • Search for oldname~ replace with newname
      • In the Pd initialization routine name: void name_tilde_setup(void), remove _tilde
    • Adjust indentation in the initialization of the class
  6. Close the Xcode project and delete the DerivedData folder
  7. Open the Xcode project and build and test the externals

Visual Studio project to write Max/MSP and Pd externals

Steps to create a new project

Create the project

  1. Create a Win32 Console application:
    • Name it template~.vcxproj
    • DLL
    • Empty project
  2. Close the project
  3. Reorganize the file in Windows Explorer following the next structure:
        DAO-MaxMSP-Pd
        ├── _COMMON_
        │   ├── ConfigMax.props
        │   └── ConfigPd.props
        ├── _SDK_
        │   ├── max-sdk (git submodule)
        │   └── pure-data (git submodule)
        │       └── src/pd.lib (manually added from the installed application folder)
        └── template~
            ├── Products
            │   ├── template.maxpat
            │   └── template.pd
            ├── Source
            │   ├── template~common.c
            │   ├── template~common.h
            │   ├── template~max.c
            │   └── template~pd.c
            └── VisualStudio
                ├── template~.vcxproj
                └── template~.vcxproj.user

Setup the project

  1. Open the project
  2. Open the Build Configuration Manager
  3. Rename the Project Configurations to MaxDebug and MaxRelease
  4. Create new configurations called PdDebug and PdRelease based on the two existing ones
  5. Open the Property Manager
  6. Add the existing property sheets to the configurations of Max and Pd
  7. Open the Project Properties:
    • Select All Configurations and All Platforms
    • Debugging > Command > $(APPLICATION)

Add source code

  1. Add new C files
    • template~common.c
    • template~common.h
    • template~max.c
    • template~pd.c
  2. Exclude Max and Pd source files from build:
    • Right-click on the file template~max.c and select Properties
      • Select All Platforms
      • For Configurations PdDebug and PdRelease, select Exclude From Build = Yes
    • Right-click on the file template~pd.c and select Properties
      • Select All Platforms
      • For Configurations MaxDebug and MaxRelease, select Exclude From Build = Yes

Add custom target to clean project

  1. Right-click on the project and select Unload Project
    • Right-click on the project and select Edit target~.vcxproj
    • Paste the next text before the tag </Project>:
    <Target Name="AfterClean">
	<Delete Files="$(PRODUCTS)\$(ProjectName).$(EXTENSION)" ContinueOnError="true" />
</Target>
    • Close the text editor of the project
    • Right-click on the project and select Reload Project

Code, build, and enjoy!

Steps to copy an existing project

  1. Copy an existing project and paste it into a folder with the new name
  2. Rename the Visual Studio project and the source code files:
    • Separator ~ for msp and _ for max objects
  3. Open the project and the source code files with a text editor (not with Visual Studio)
  4. Search for all occurrences of the old name and replace them with the new name:
    • Search for oldname replace with newname
    • If the new external is a max-only object:
      • Search for oldname~ replace with newname_
      • In the Pd initialization routine name: void name_tilde_setup(void), remove _tilde
    • Adjust indentation in the initialization of the class
  5. Open the Visual Studio project and build and test the externals

Makefiles to build Pd externals (for macOS, Windows, and Linux)

The makefile in the folder of each external detects the name of the external to build, so no action is needed to create a new project when copying an existing project as a template. The local makefile in each external's folder calls a global makefile located in the _COMMON_ folder. This global makefile is shared among all externals in the repository and defines the build targets. The makefile also detects the operating system and the right target is selected accordingly. The variable BBB=1 can be passed to cross-compile the externals for the BeagleBone Black + Bela Cape from a host operating system (cross-compilation was tested only on macOS using the Linaro toolchain).

Below is the folder structure that is assumed:

        DAO-MaxMSP-Pd
        ├── _COMMON_
        │   └── MakefilePd.mk (the global makefile)
        ├── _SDK_
        │   └── pure-data (git submodule)
        └── template~
            ├── Products
            │   ├── _main.pd (used to run the Pd patch on the BBB+Bela)
            │   ├── template.maxpat
            │   └── template.pd
            ├── Source
            │   ├── template~common.c
            │   ├── template~common.h
            │   ├── template~max.c
            │   └── template~pd.c
            └── Makefile
                └── Makefile.mk (the local makefile)