Cyclone: A set of Pure Data objects cloned from

Max/MSP
Cyclone expands Pure Data with objects cloned from cycling74's Max/MSP and
provides some good level of compatibility between the two environments.

Pure Data (or just "Pd") project is found at: https://sourceforge.net/p/pure-data

/pure-data/ci/master/tree/
or in its github mirror https://github.com/pure-data/pure-data. The offical
download page is here: http://msp.ucsd.edu/software.html

Max is found at: https://cycling74.com/

Copyright © 2003-2020 - Krzysztof Czaja, Hans-Christoph Steiner, Fred Jan

Kraan, Alexandre Porres, Derek Kwan, Matt Barber and others.

This work is free. You can redistribute it and/or modify it under the terms of the
BSD-3-Clause (aka Revised BSD License). See License.txt https://github.com/po
rres/pd-cyclone/blob/cyclone0.4/LICENSE.txt and https://opensource.org/licen
ses/BSD-3-Clause for more details.

Current Release: Cyclone 0.5-3 (this release needs at least Pd Vanilla 0.51-0)

Released August 21st 2020

Find Cyclone's latest releases at: https://github.com/porres/pd-cyclone/release

s or directly via Pd's external manager (Help => Find Externals). Please report
bugs at https://github.com/porres/pd-cyclone/issues.

About Cyclone:
Cyclone 0.5-3 needs at least Pd Vanilla 0.51-0 (current version is 0.51-1) and
does not run on Pd-Extended or Pd-l2ork/Purr Data.

Outdated versions of cyclone are available in Pd Extended (now an abandoned

project) and Purr Data. Pd-Extended carries older 0.1 versions and Purr Data still
carries an outdated Cyclone 0.2 release (which on its own is not yet fully ported
either to Purr Data). The latest versions of cyclone (0.3-0 onwards) are only fully
supported in Pd Vanilla so far.

The original author of Cyclone (Krzysztof Czaja) abandoned it in 2005 at version

0.1-alpha55. Cyclone was then incorporated and available in Pd-Extended,
where it only a had a minor update in 2013 (0.1-alpha56) under the maintenance
of Hans-Christoph Steiner, right before Cyclone and Pd Extended were
abandoned altogether. Under a new maintenance phase by Fred Jan Kraan, 0.1-
alpha57 and Cyclone 0.2 beta versions were released, still closely related to the
previous '0.1-alpha' releases and mostly compliant to Max 4.0!

Cyclone 0.3-0 was the major overhaul in cyclone, where almost all of its objects
got updated to the latest Max 7 version (Max 7.3.5). Many bugs were also fixed,
the documentation was rewritten from scratch and new objects were included.
Here's the aftermath:

62 updated objects;
65 fixed objects (including updated objects);
40 new objects;
Newly written documentation

Check the provided CHANGELOG.txt file for the details in all version changes.

Currently, cyclone still pursues compatibilty to Max 7.3.5 with minor issues still
in the way, but one object will not get fully updated, which is comment (it
misses 'bubble' stuff from Max 6+).

Cyclone is still not compatible to the new Max 8 version, this is still not in the
radar for implementartion plans. Hopefully, functionalities added in cyclone
objects in Max 8 might be included in future versions of Cyclone. Nonetheless,
things like 'mc' compatiblity won't likely be possible or make it to cyclone!

Installing Cyclone:
You can compile Cyclone from the source provided in this repository for the
current bleeding edge last state or download one of the more stable compiled
releases from https://github.com/porres/pd-cyclone/releases. A good
alternative is simply to use Pd's own external download manager (a.k.a deken
plugin), just click on the "find externals" option under the Help menu and
search for Cyclone.
When installing cyclone, make sure the Cyclone folder is included in a folder that
Pd searches for, such as ~/Documents/Pd/externals - which is what Pd
suggests you to do (since version 0.48-0).

Now you can install Cyclone by loading it in the startup: go to "Preferences =>
Startup", then click "New", type "Cyclone" and hit OK. Next time you restart Pd,
the Cyclone library binary will be loaded.

This library binary loads the non alphanumeric operators objects (which are: !-,
!-~, !/, !/~, !=~, %~, +=~, <=~, <~, ==~, >=~ and >~) but it also adds Cyclone's
path to Pd's preferences, so you can load the other objects from Cyclone (which
are separate binaries and abstractions).

You can also use the [declare -lib cyclone] in a patch to load the library if you
don't want to always have Cyclone loaded when Pd starts.

Loading the Cyclone binary as an object ([cyclone]) also loads the library, see its
help file for more details.

Building Cyclone for Pd Vanilla:

Since "Cyclone 0.1-alpha57", the Cyclone package has relied on the new build
system called "pd-lib-builder" by Katja Vetter (check the project in: https://gith
ub.com/pure-data/pd-lib-builder).

Compiling with pdlibbuilder

PdLibBuilder tries to find the Pd source directory at several common locations,

but when this fails, you have to specify the path yourself using the
pdincludepath variable. Example:

make pdincludepath=~/pd-0.51-0/src/ (for

Windows/MinGW add 'pdbinpath=~/pd-0.51-0/bin/)
Make Install

Use "objectsdir" to set a relative path for your build, something like:

make install objectsdir=../cyclone-build

Then move it to your preferred install folder for Pd.

Building with CMake

It is now possible to build Cyclone for Pd Vanilla or libpd using CMake. CMake is
a cross-platform, open-source build system. CMake is used to control the
software compilation process using simple platform and compiler independent
configuration files, and generate native makefiles and workspaces that can be
used in the compiler environment of your choice.
This allows native compilation via Windows (Microsoft Visual Studio), Linux
(GCC) and macOS (XCode).

Dependencies:
CMake: You can download for your platform here.
Only on Windows: pthreads library
Pure-data or libpd: sources and binaries.

If you are using MinGW, you can use the pthreadGC-3.dll included in the
maintenance/windows_dll directory in this repository. Alternatively, you can
also download it or compile it yourself from the sources here. This will typically
result in pthreadGC2.(dll/lib).

If you are using Visual Studio, you need to provide a pthreads library compiled
for Visual Studio either by downloading it or compiling it yourself. See here. Be
careful to download / compile the right version for your setup. This would
typically be pthreadVC2.(dll/lib).

Configuring the build

One way to configure CMake is to use the CMake GUI. The GUI will list the
variables that can be provided to configure the build. The variables can also be
specified in the command-line interface (See below for an example).

In this step you can select if you want to build shared libraries with
BUILD_SHARED_LIBS and if you want to build all Cyclone objects into one single
library with BUILD_SINGLE_LIBRARY (more on this below).

When using Microsoft Visual Studio (MSVC), you will be requested to provide a
path to the pthreads library and its headers using variables
CMAKE_THREAD_LIBS_INIT and PTHREADS_INCLUDE_DIR.

You will be requested to provide a path to the pure-data sources and to the pure-
data library. If building Cylone for libpd, these can also be satisfied by providing
the path to the pure-data folder inside the libpd sources and providing the path
to the libpd library. The variables are: PD_INCLUDE_DIR and PD_LIBRARY.

On macOS, you can define different deployment target and architectures from
your current system using the variables CMAKE_OSX_DEPLOYMENT_TARGET and
CMAKE_OSX_ARCHITECTURES.

You can specify additional compilation flags using the variable CMAKE_C_FLAGS.
CMake can now generate Makefiles, a MSVC solution, or an XCode project.

Building

After generation, depending on your platform you can navigate to the directory
where CMake generated the build files and then:

On Linux: run make

On Windows: open the MSVC solution and build it
On macOS: open the XCode project and build it

Of course you can also use CMake itself to build cyclone by running this on the
command line:

cd <path/to/build/files/generated/by/CMake>
cmake --build .

Building a single library

Per default Cyclone will build most of its objects as a single binary file (.so /
.dll / .dylib / .pd_darwin). The exception is the "cyclone" object/binary that
loads the non alphanumeric operators objects (which are: !-, !-~, !/, !/~, !=~,
%~, +=~, <=~, <~, ==~, >=~ and >~).

If you want you can also build all of the Cyclone objects into one
cyclone.so/dll/dylib/pd_darwin by activating the BUILD_SINGLE_LIBRARY
option.

Each one of the individual libraries contain a <name>_setup() method that will
be invoked by pure-data on library load. If you select the
BUILD_SINGLE_LIBRARY, CMake will generate the appropriate code so that all
*_setup() methods will be invoked in the main cyclone_setup().

Command-line examples

Here are a few examples of how to download, configure and build the latest
Cyclone on the command line using CMake and pure-data or libpd.

Linux:
 git clone https://github.com/pure-data/pure-data
<download pure-data binaries or build it yourself>

git clone https://github.com/porres/pd-cyclone

cd pd-cyclone
mkdir build && cd build
cmake .. -DPD_INCLUDE_DIR:PATH=pure-data/src -DPD_LIBRARY:PATH=
<path/to/pd.so/in/pure-data/binaries>
cmake --build .

Windows / MSVC:

git clone https://github.com/pure-data/pure-data

<download pure-data binaries or build it yourself>

#Clone the Cyclone repository from GitHub:

git clone https://github.com/porres/pd-cyclone
cd pd-cyclone
mkdir build && cd build
cmake .. -DCMAKE_THREAD_LIBS_INIT:PATH=</path/to/pthreadsVC2.lib> -
DPTHREADS_INCLUDE_DIR:PATH=</path/to/pthread/header/files> -
DPD_INCLUDE_DIR:PATH=pure-data/src -DPD_LIBRARY:PATH=
<path/to/pd.lib/in/pure-data/binaries>
cmake --build .

Using libpd in Linux:

# Here we compile libpd ourselves, you can skip the building steps if
you download the libpd binaries
git clone https://github.com/libpd/libpd
cd libpd
git submodule init
git submodule update
# libpd build steps:
mkdir build && cd build
cmake ..
cmake --build .
cd ../..

# Now clone the Cyclone repository

git clone https://github.com/porres/pd-cyclone
cd pd-cyclone
mkdir build && cd build
cmake .. -DPD_INCLUDE_DIR:PATH=../libpd/pure-data/src -
DPD_LIBRARY:PATH=../libpd/libs/libpd.so
cmake --build .

A Brief History of Cyclone's Development:

A Brief History of Cyclone's Development:
Excerpt from Cyclone's original Readme (by its original author Krzysztof Czaja):

"Cyclone is a library of Pure Data classes, bringing some level of

compatibility between Max/MSP and Pd environments. Although being
itself in the early stage of development, it is meant to eventually become
part of a much larger project, aiming at unification and standardization of
computer musician's tools. In its current form, cyclone is mainly for people
using both Max and Pd, and thus wanting to develop cross-platform
patches. (...)." The full original readme is provided in this repository at: htt
ps://github.com/porres/pd-cyclone/blob/master/maintenance/README_
original.txt

Cyclone's original author Krzysztof Czaja worked on it as part of his miXed

library from 2002 to 2005 and later abandoned it all together. In parallel, miXed
had been incorporated into Pd Extended and eventually ended up under the
maintenance of Hans-Christoph Steiner - the main developer and maintainer of
Pd-Extended. When Pd Extended was abandoned after its last release (from Jan
2013), Cyclone and miXed were left unmaintained as a result. In Dec-2014, Fred
Jan Kraan took over maintainance and development for cyclone (but not the rest
of the miXed library) and released 0.1-alpha57 and Cyclone 0.2 beta versions,
but decided to abandon development for it in Feb-2016.

Since February 21st 2016, further development for Cyclone started on this
repository by Alexandre Porres, Derek Kwan, Matt Barber and other
collaborators. The first stable release was Cyclone 0.3-0 from february 2019!

About Cyclone's Repositories and its Fork History:

=> Original Repository (up to version 0.1-Alpha-56):
The original repository of MiXed as part of Pd Extended - containing Cyclone
and more (such as 'toxy') - resides at https://svn.code.sf.net/p/pure-data/svn/tr
unk/externals/miXed/cyclone and the migrated repository: https://git.puredata.
info/cgit/svn2git/libraries/miXed.git/. This repository embraces work from
three different maintainance phases:

Czaja's era (until 2005 and up to 0.1-Alpha55): Czaja (the original author)
worked on Cyclone from version 01-alpha-01 (2002) to 0.1-alpha-55
(2005).
Hans era (until 2013 and 0.1-Alpha-56): Hans maintained Cyclone from
2005 to 2013. The 0.1-Alpha55 version of Cyclone is found in most of Pd-
Extended versions up to Pd-Extended 0.42-5. The last release of Pd-
Extended is 0.43-4 from Jan-2013 and it carries the 0.1-Alpha56 version of
Cyclone, which can also be found as "cyclone-v0-0extended" when
searching for externals in Pd Vanilla.
Kraan era (up to 2015): The later work in this repository was not made
available into a new release from this repository.
=> Fred Jan Kraan's Repository (0.1-Alpha57 and 0.2-beta):

Fred Jan Kraan forked the original repository to https://github.com/electrickery/

pd-miXedSon, but containing only the Cyclone library. This repository has a few
releases - see https://github.com/electrickery/pd-miXedSon/releases - it starts
with Cyclone version 0.1-alpha-57, from October 2015, which is basically the
last developments made on the original repository in its last phase. Then it
moves on to a new Cyclone 0.2 version which stopped at a beta stage in february
2016.

=> This Repository (0.3-0 and onwards):

In February 2016, Porres forked from https://github.com/electrickery/pd-miXed

Son to this repositry that resides at: https://github.com/porres/pd-cyclone. The
fork happened while cyclone was at 0.2-beta stage. Since then, Alexandre
Porres, Derek Kwan, Matt Barber and other collaborators have worked on
further developments of cyclone. The first stable release from this repository
was cyclone 0.3-0 from february 2019.

=> The 'nilwind' fork:

The 'nilwind' library is a fork of cyclone and it starts as a fork of the last stage ht
tps://github.com/electrickery/pd-miXedSon was left at. The nilwind's
repository is at https://github.com/electrickery/pd-nilwind. It's first release is
'nilwind 0.2.1', from November 2019, which is a development over cyclone 0.2-
beta. This fork of cyclone does not aim to pursue updates according to newer
versions of Max and its main concern is to keep compatibility to patches made in
the Pd-Extended era. Nonetheless, versions of cyclone 0.3 onward are also
compatible to Pd-Extended era, as the current development phase does not
introduce breaking changes and has only offered stable releases since 0.3!

About This Repository's Goals:

This repository is faithful to the original goal of Cyclone in creating an external
Pd package with a collection of objects cloned and compatible to Max/MSP
objects. Releases from this repository are stable and offer many fixes and
improves stability from earlier versions. Compatibility to newer versions of Max
is a concern, but Max compatibility was always the main goal of cyclone and
nothing really changed. No incompatibilities should arise between cyclone 0.3-0
onwards with earlier versions. This development stage of cyclone is also
concerned to provide compatibility for patches made in the Pd-Extended era. If a
regression bug is found, please report it at https://github.com/porres/pd-cyclon
e/issues.

Collaborating to Cyclone:
This repository/project is open to collaboration to anyone who wishes to work
according to the key and central goal of Max/MSP compatibility. Feel free to
collaborate.