| 1 |
<!DOCTYPE html> |
| 2 |
<HTML lang="en"> |
| 3 |
<HEAD> |
| 4 |
<meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| 5 |
<TITLE>Pd Manual - Table of contents</TITLE> |
| 6 |
<meta http-equiv="content-type" content="text/html; charset=UTF-8"> |
| 7 |
<link rel="stylesheet" type="text/css" href="resources/pdmanual.css" media="screen"> |
| 8 |
<link rel="icon" href="resources/favicon.ico"> |
| 9 |
</HEAD> |
| 10 |
|
| 11 |
<BODY> |
| 12 |
|
| 13 |
<div class="nav nav-top"> |
| 14 |
<div class="nav-forward"><A href="1.introduction.htm">Chapter 1: Introduction ></A></div> |
| 15 |
</div> |
| 16 |
|
| 17 |
|
| 18 |
<div id="toc"> |
| 19 |
|
| 20 |
<IMG id="logo" src="resources/icon.png" ALT="pd icon"> |
| 21 |
|
| 22 |
<H1>Pure Data Manual</H1> |
| 23 |
<H2>Updated for Pd version 0.56-4</H2> |
| 24 |
<H3>Table of contents:</H3> |
| 25 |
<OL> |
| 26 |
<LI> <A href="1.introduction.htm" id="s1"><b>Introduction</b></A> |
| 27 |
<OL> |
| 28 |
<LI> <A href="1.introduction.htm#s1.1">Guide to the documentation</A></LI> |
| 29 |
<LI> <A href="1.introduction.htm#s1.2">The Help menu</A></LI> |
| 30 |
<LI> <A href="1.introduction.htm#s1.3">Other resources</A></LI> |
| 31 |
<LI> <A href="1.introduction.htm#s1.4">Other flavors</A></LI> |
| 32 |
</OL> |
| 33 |
</LI> |
| 34 |
<LI> <A href="2.theory.of.operation.htm" id="s2"><b>Theory of operation</b></A> |
| 35 |
<OL> |
| 36 |
<LI> <A href="2.theory.of.operation.htm#s2.1">Overview</A> |
| 37 |
<OL> |
| 38 |
<LI> <A href="2.theory.of.operation.htm#s2.1.1">The main window, canvases, and printout</A></LI> |
| 39 |
<LI> <A href="2.theory.of.operation.htm#s2.1.2">Object boxes</A></LI> |
| 40 |
<LI> <A href="2.theory.of.operation.htm#s2.1.3">Message and GUI boxes</A></LI> |
| 41 |
<LI> <A href="2.theory.of.operation.htm#s2.1.4">Patches and files</A></LI> |
| 42 |
</OL> |
| 43 |
</LI> |
| 44 |
<LI> <A href="2.theory.of.operation.htm#s2.2">Editing Pd patches</A> |
| 45 |
<OL> |
| 46 |
<LI> <A href="2.theory.of.operation.htm#s2.2.1">Edit and run mode</A></LI> |
| 47 |
<LI> <A href="2.theory.of.operation.htm#s2.2.2">Creating boxes</A></LI> |
| 48 |
<LI> <A href="2.theory.of.operation.htm#s2.2.3">Selecting items and moving them or "tidying them up"</A></LI> |
| 49 |
<LI> <A href="2.theory.of.operation.htm#s2.2.4">Delete, cut, copy and paste boxes</A></LI> |
| 50 |
<LI> <A href="2.theory.of.operation.htm#s2.2.5">Changing the text of objects, messages and comments</A></LI> |
| 51 |
<LI> <A href="2.theory.of.operation.htm#s2.2.6">Connecting and disconnecting boxes</A></LI> |
| 52 |
<LI> <A href="2.theory.of.operation.htm#s2.2.7">Context menu for 'Properties', 'Open' and 'Help'</A></LI> |
| 53 |
</OL> |
| 54 |
</LI> |
| 55 |
<LI> <A href="2.theory.of.operation.htm#s2.3">Advanced patch editing</A> |
| 56 |
<OL> |
| 57 |
<LI> <A href="2.theory.of.operation.htm#s2.3.1">Tab navigation</A></LI> |
| 58 |
<LI> <A href="2.theory.of.operation.htm#s2.3.2">Autopatching</A></LI> |
| 59 |
<LI> <A href="2.theory.of.operation.htm#s2.3.3">Duplicate connections</A></LI> |
| 60 |
<LI> <A href="2.theory.of.operation.htm#s2.3.4">Managing connections with the shift key</A></LI> |
| 61 |
<LI> <A href="2.theory.of.operation.htm#s2.3.5">(Dis)Connect selection</A></LI> |
| 62 |
<LI> <A href="2.theory.of.operation.htm#s2.3.6">Triggerize</A></LI> |
| 63 |
<LI> <A href="2.theory.of.operation.htm#s2.3.7">Paste replace</A></LI> |
| 64 |
</OL> |
| 65 |
</LI> |
| 66 |
<LI> <A href="2.theory.of.operation.htm#s2.4">Messages</A> |
| 67 |
<OL> |
| 68 |
<LI> <A href="2.theory.of.operation.htm#s2.4.1">Message types (selectors)</A></LI> |
| 69 |
<LI> <A href="2.theory.of.operation.htm#s2.4.2">Floats and numerical precision</A></LI> |
| 70 |
<LI> <A href="2.theory.of.operation.htm#s2.4.3">Depth first message passing</A></LI> |
| 71 |
<LI> <A href="2.theory.of.operation.htm#s2.4.4">Hot and cold inlets and right to left outlet order</A></LI> |
| 72 |
<LI> <A href="2.theory.of.operation.htm#s2.4.5">Message boxes</A></LI> |
| 73 |
<LI> <A href="2.theory.of.operation.htm#s2.4.6">Escaping characters</A></LI> |
| 74 |
</OL> |
| 75 |
</LI> |
| 76 |
<LI> <A href="2.theory.of.operation.htm#s2.5">Audio signals</A> |
| 77 |
<OL> |
| 78 |
<LI> <A href="2.theory.of.operation.htm#s2.5.1">Sample rate and format</A></LI> |
| 79 |
<LI> <A href="2.theory.of.operation.htm#s2.5.2">Tilde objects and audio connections</A></LI> |
| 80 |
<LI> <A href="2.theory.of.operation.htm#s2.5.3">Converting audio to and from messages</A></LI> |
| 81 |
<LI> <A href="2.theory.of.operation.htm#s2.5.4">Switching and blocking</A></LI> |
| 82 |
<LI> <A href="2.theory.of.operation.htm#s2.5.5">Nonlocal signal connections</A></LI> |
| 83 |
<LI> <A href="2.theory.of.operation.htm#s2.5.6">Multichannel signals</A></LI> |
| 84 |
</OL> |
| 85 |
</LI> |
| 86 |
<LI> <A href="2.theory.of.operation.htm#s2.6">Scheduling</A> |
| 87 |
<OL> |
| 88 |
<LI> <A href="2.theory.of.operation.htm#s2.6.1">Audio and messages</A></LI> |
| 89 |
<LI> <A href="2.theory.of.operation.htm#s2.6.2">Computation load</A></LI> |
| 90 |
<LI> <A href="2.theory.of.operation.htm#s2.6.3">Determinism</A></LI> |
| 91 |
</OL> |
| 92 |
</LI> |
| 93 |
<LI> <A href="2.theory.of.operation.htm#s2.7">Semantics</A> |
| 94 |
<OL> |
| 95 |
<LI> <A href="2.theory.of.operation.htm#s2.7.1">Creation of objects</A></LI> |
| 96 |
<LI> <A href="2.theory.of.operation.htm#s2.7.2">Persistence of data</A></LI> |
| 97 |
<LI> <A href="2.theory.of.operation.htm#s2.7.3">Message passing</A></LI> |
| 98 |
<LI> <A href="2.theory.of.operation.htm#s2.7.4">Inlets and lists</A></LI> |
| 99 |
<LI> <A href="2.theory.of.operation.htm#s2.7.5">Special cases for 0/1-element lists</A></LI> |
| 100 |
<LI> <A href="2.theory.of.operation.htm#s2.7.6">Dollar signs</A></LI> |
| 101 |
</OL> |
| 102 |
</LI> |
| 103 |
<LI> <A href="2.theory.of.operation.htm#s2.8">Subpatches</A> |
| 104 |
<OL> |
| 105 |
<LI> <A href="2.theory.of.operation.htm#s2.8.1">Abstractions</A></LI> |
| 106 |
<LI> <A href="2.theory.of.operation.htm#s2.8.2">Graph-on-parent subpatches</A></LI> |
| 107 |
</OL> |
| 108 |
</LI> |
| 109 |
<LI> <A href="2.theory.of.operation.htm#s2.9">Arrays</A></LI> |
| 110 |
<LI> <A href="2.theory.of.operation.htm#s2.10">Data structures</A> |
| 111 |
<OL> |
| 112 |
<LI> <A href="2.theory.of.operation.htm#s2.10.1">Traversal</A></LI> |
| 113 |
<LI> <A href="2.theory.of.operation.htm#s2.10.2">Accessing and changing data</A></LI> |
| 114 |
<LI> <A href="2.theory.of.operation.htm#s2.10.3">Editing</A></LI> |
| 115 |
<LI> <A href="2.theory.of.operation.htm#s2.10.4">Limitations</A></LI> |
| 116 |
</OL> |
| 117 |
</LI> |
| 118 |
<LI> <A href="2.theory.of.operation.htm#s2.11">Pd vs. MAX</A> |
| 119 |
<OL> |
| 120 |
<LI> <A href="2.theory.of.operation.htm#s2.11.1">Differences between Pd and MAX</A></LI> |
| 121 |
<LI> <A href="2.theory.of.operation.htm#s2.11.2">Running Pd inside MAX with the [pd~] external</A></LI> |
| 122 |
<LI> <A href="2.theory.of.operation.htm#s2.11.3">The Cyclone library</A></LI> |
| 123 |
</OL> |
| 124 |
</LI> |
| 125 |
</OL> |
| 126 |
</LI> |
| 127 |
<LI> <A href="3.installing.configuring.htm" id="s3"><b>Installing and configuring Pd</b></A> |
| 128 |
<OL> |
| 129 |
<LI> <A href="3.installing.configuring.htm#s3.1">Installing Pd</A> |
| 130 |
<OL> |
| 131 |
<LI> <A href="3.installing.configuring.htm#s3.1.1">macOS</A></LI> |
| 132 |
<LI> <A href="3.installing.configuring.htm#s3.1.2">Microsoft Windows</A></LI> |
| 133 |
<LI> <A href="3.installing.configuring.htm#s3.1.3">Linux</A></LI> |
| 134 |
</OL> |
| 135 |
</LI> |
| 136 |
<LI> <A href="3.installing.configuring.htm#s3.2">Running Pd via the command line</A></LI> |
| 137 |
<LI> <A href="3.installing.configuring.htm#s3.3">Testing and configuring Audio and MIDI</A> |
| 138 |
<OL> |
| 139 |
<LI> <A href="3.installing.configuring.htm#s3.3.1">Audio settings</A></LI> |
| 140 |
<LI> <A href="3.installing.configuring.htm#s3.3.2">MIDI settings</A></LI> |
| 141 |
</OL> |
| 142 |
</LI> |
| 143 |
<LI> <A href="3.installing.configuring.htm#s3.4">Path and startup</A> |
| 144 |
<OL> |
| 145 |
<LI> <A href="3.installing.configuring.htm#s3.4.1">Startup flags</A> |
| 146 |
<OL> |
| 147 |
<LI> <a href="3.installing.configuring.htm#s3.4.1.1">Font flags</a></LI> |
| 148 |
<LI> <a href="3.installing.configuring.htm#s3.4.1.2">Path flag</a></LI> |
| 149 |
<LI> <a href="3.installing.configuring.htm#s3.4.1.3">Flags for Audio and MIDI multiple devices and |
| 150 |
sleepgrain</a></LI> |
| 151 |
<LI> <a href="3.installing.configuring.htm#s3.4.1.4">Sample rate flag</a></LI> |
| 152 |
<LI> <a href="3.installing.configuring.htm#s3.4.1.5">Audio buffer size and block size flags</a></LI> |
| 153 |
</OL> |
| 154 |
</LI> |
| 155 |
</OL> |
| 156 |
</LI> |
| 157 |
</OL> |
| 158 |
</LI> |
| 159 |
<LI> <A href="4.externals.htm" id="s4"><b>Externals</b></A> |
| 160 |
<OL> |
| 161 |
<LI><a href="4.externals.htm#s4.1">External objects & libraries</a> |
| 162 |
<OL> |
| 163 |
<LI><a href="4.externals.htm#s4.1.1">Vanilla objects, internals & externals </a></LI> |
| 164 |
<LI><a href="4.externals.htm#s4.1.2">Types of external objects </a> |
| 165 |
<OL> |
| 166 |
<LI><a href="4.externals.htm#s4.1.2.1">Compiled objects</a></LI> |
| 167 |
<LI><a href="4.externals.htm#s4.1.2.2">Abstractions</a></LI> |
| 168 |
</OL> |
| 169 |
</LI> |
| 170 |
<LI><a href="4.externals.htm#s4.1.3">External libraries</a></LI> |
| 171 |
<LI><a href="4.externals.htm#s4.1.4">Types of external libraries</a></LI> |
| 172 |
<LI><a href="4.externals.htm#s4.1.5">Wrapping up section 4.1</a></LI> |
| 173 |
</OL> |
| 174 |
</LI> |
| 175 |
<LI><a href="4.externals.htm#s4.2">GUI (.tcl) plugins</a></LI> |
| 176 |
<LI><a href="4.externals.htm#s4.3">Installing externals and GUI plugins</a> |
| 177 |
<OL> |
| 178 |
<LI><a href="4.externals.htm#s4.3.1">Where to include externals and GUI plugins </a></LI> |
| 179 |
<LI><a href="4.externals.htm#s4.3.2">How to download externals and GUI plugins from Pd</a></LI> |
| 180 |
</OL> |
| 181 |
</LI> |
| 182 |
<LI><a href="4.externals.htm#s4.4">Loading externals</a> |
| 183 |
<OL> |
| 184 |
<LI><a href="4.externals.htm#s4.4.1">Using the [declare] object</a> |
| 185 |
<OL> |
| 186 |
<LI><a href="4.externals.htm#s4.4.1.1">[declare -path] </a></LI> |
| 187 |
<LI><a href="4.externals.htm#s4.4.1.2">[declare -lib] </a></LI> |
| 188 |
</OL> |
| 189 |
</LI> |
| 190 |
<LI><a href="4.externals.htm#s4.4.2">Load via path and startup</a> |
| 191 |
<OL> |
| 192 |
<LI><a href="4.externals.htm#s4.4.2.1">User added path</a></LI> |
| 193 |
<LI><a href="4.externals.htm#s4.4.2.2">Startup </a></LI> |
| 194 |
</OL> |
| 195 |
</LI> |
| 196 |
<LI><a href="4.externals.htm#s4.4.3">Load using slash declarations</a></LI> |
| 197 |
</OL> |
| 198 |
</LI> |
| 199 |
<LI><a href="4.externals.htm#s4.5">How external binaries are loaded </a> |
| 200 |
<OL> |
| 201 |
<LI><a href="4.externals.htm#s4.5.1">Overriding objects (externals and native)</a></LI> |
| 202 |
</OL> |
| 203 |
</LI> |
| 204 |
<LI><a href="4.externals.htm#s4.6">Search order in Pd for objects and files</a></LI> |
| 205 |
</OL> |
| 206 |
</LI> |
| 207 |
<LI> <A href="5.current.status.htm" id="s5"><b>Current status</b></A> |
| 208 |
<OL> |
| 209 |
<LI> <A href="5.current.status.htm#s5.1">Release notes</A></LI> |
| 210 |
</OL> |
| 211 |
</LI> |
| 212 |
<LI> <A href="6.building.from.source.htm" id="s6"><b>Building Pd from source</b></A> |
| 213 |
<OL> |
| 214 |
<LI> <A href="6.building.from.source.htm#s6.1">Requirements</A></LI> |
| 215 |
<LI> <A href="6.building.from.source.htm#s6.2">General autotools build steps</A></LI> |
| 216 |
<LI> <A href="6.building.from.source.htm#s6.3">Building Pd for Linux</A></LI> |
| 217 |
<LI> <A href="6.building.from.source.htm#s6.4">Building Pd for BSD</A> |
| 218 |
<OL> |
| 219 |
<LI><a href="6.building.from.source.htm#s6.4.1">FreeBSD</a></LI> |
| 220 |
<LI><a href="6.building.from.source.htm#s6.4.2">OpenBSD </a></LI> |
| 221 |
<LI><a href="6.building.from.source.htm#s6.4.3">NetBSD </a></LI> |
| 222 |
</OL> |
| 223 |
</LI> |
| 224 |
<LI> <A href="6.building.from.source.htm#s6.5">Building Pd for macOS</A> |
| 225 |
<OL> |
| 226 |
<LI><a href="6.building.from.source.htm#s6.5.1">macOS app bundle</a></LI> |
| 227 |
<LI><a href="6.building.from.source.htm#s6.5.2">Supplementary macOS build scripts</a></LI> |
| 228 |
<LI><a href="6.building.from.source.htm#s6.5.3">Preferences </a></LI> |
| 229 |
<LI><a href="6.building.from.source.htm#s6.5.4">Code signing</a></LI> |
| 230 |
<LI><a href="6.building.from.source.htm#s6.5.5">Privacy permissions </a></LI> |
| 231 |
<LI><a href="6.building.from.source.htm#s6.5.6">Font issues with macOS 10.15+ </a></LI> |
| 232 |
<LI><a href="6.building.from.source.htm#s6.5.7">Dark mode</a></LI> |
| 233 |
<LI><a href="6.building.from.source.htm#s6.5.8">Debugging releases</a></LI> |
| 234 |
</OL> |
| 235 |
</LI> |
| 236 |
<LI> <A href="6.building.from.source.htm#s6.6">Building Pd for Microsoft Windows</A> |
| 237 |
<OL> |
| 238 |
<LI><a href="6.building.from.source.htm#s6.6.1">Building a Pd application</a></LI> |
| 239 |
<LI><a href="6.building.from.source.htm#s6.6.2">Pd application directory</a> |
| 240 |
<OL> |
| 241 |
<LI><a href="6.building.from.source.htm#s6.6.2.1">Windows app bundle helpers</a></LI> |
| 242 |
</OL> |
| 243 |
</LI> |
| 244 |
<LI><a href="6.building.from.source.htm#s6.6.3">pdfontloader </a></LI> |
| 245 |
<LI><a href="6.building.from.source.htm#s6.6.4">ASIO support</a></LI> |
| 246 |
</OL> |
| 247 |
</LI> |
| 248 |
<LI> <A href="6.building.from.source.htm#s6.7">Cross-compilation for Windows on Linux</A></LI> |
| 249 |
<LI> <A href="6.building.from.source.htm#s6.8">Makefile build</A></LI> |
| 250 |
<LI> <A href="6.building.from.source.htm#s6.9">Troubleshooting</A></LI> |
| 251 |
</OL> |
| 252 |
</LI> |
| 253 |
</OL> |
| 254 |
</div> |
| 255 |
<div class="nav nav-bottom"> |
| 256 |
<div class="nav-back"></div> |
| 257 |
<div class="nav-home"></div> |
| 258 |
<div class="nav-forward"><A href="1.introduction.htm">Chapter 1: Introduction ></A></div> |
| 259 |
</div> |
| 260 |
</BODY> |
| 261 |
</HTML> |