| 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 - Chapter 1: Introduction</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 |
<BODY> |
| 11 |
|
| 12 |
<div class="nav nav-top"> |
| 13 |
<div class="nav-back"></div> |
| 14 |
<div class="nav-home"><A href="index.htm#s1">Table of contents</A></div> |
| 15 |
<div class="nav-forward"><A href="2.theory.of.operation.htm">Chapter 2: Theory of operation ></A></div> |
| 16 |
</div> |
| 17 |
|
| 18 |
<div id="corpus"> |
| 19 |
|
| 20 |
<IMG id="logo" src="resources/icon.png" ALT="pd icon"> |
| 21 |
|
| 22 |
<H2>Chapter 1: Introduction</H2> |
| 23 |
|
| 24 |
<P> This is the official HTML manual for Pure Data, a patchable |
| 25 |
computer music environment for audio analysis, synthesis and digital |
| 26 |
signal processing in real time (aka "Live Electronics"). Pd can be |
| 27 |
extended with third-party libraries for additional computer music |
| 28 |
features, multimedia capabilities and more, making Pd a programming |
| 29 |
environment also for video, graphics, interfacing with arduino, etc.</P> |
| 30 |
|
| 31 |
<P> Pd is commonly used for live music performance, VeeJaying, sound effects, |
| 32 |
composition, audio analysis, interfacing with sensors, using cameras, |
| 33 |
controlling robots, designing apps, procedural audio for games or even |
| 34 |
interacting with websites. Because all of these various media are handled as |
| 35 |
digital data within the program, many fascinating opportunities for |
| 36 |
cross-synthesis between them exist. Sound can be used to manipulate video, |
| 37 |
which could then be streamed over the internet to another computer which might |
| 38 |
analyze that video and use it to control a motor-driven installation and whatnot.</P> |
| 39 |
|
| 40 |
<P> The latest version of this manual is found online |
| 41 |
at <A href="http://msp.ucsd.edu/software.html"> |
| 42 |
http://msp.ucsd.edu/software.html</A>, |
| 43 |
along with the downloads of the |
| 44 |
latest Pd releases.</P> |
| 45 |
|
| 46 |
<H3> <A href="#s1.1" id="s1.1"> 1.1. Guide to Pd's documentation </A> </H3> |
| 47 |
|
| 48 |
<P> Besides this HTML manual, you'll find the 'doc' folder with more documentation |
| 49 |
resources in Pd's installation folder, which is also accessible through the |
| 50 |
<b>Help menu</b>. Here's an overview of its structure:</P> |
| 51 |
|
| 52 |
<PRE> |
| 53 |
Pd/ |
| 54 |
├── doc/ |
| 55 |
├── 1.manual/ |
| 56 |
├── 2.control.examples/ |
| 57 |
├── 3.audio.examples/ |
| 58 |
├── 4.data.structures/ |
| 59 |
├── 5.reference/ |
| 60 |
├── 6.externs/ |
| 61 |
├── 7.stuff/ |
| 62 |
├── 8.topics/ |
| 63 |
</PRE> |
| 64 |
|
| 65 |
<UL> |
| 66 |
<LI>The first subfolder <b>1.manual</b> includes this HTML manual and consists of 6 sections: |
| 67 |
<UL> |
| 68 |
<LI>This <A href="1.introduction.htm"> introduction </A></LI> |
| 69 |
<LI>A <A href="2.theory.of.operation.htm"> theory of operations</A>, explaining how Pd works</LI> |
| 70 |
<LI>Instructions on <A href="3.installing.configuring.htm"> installing and configuring Pd</A></LI> |
| 71 |
<LI>Information on managing <A href="4.externals.htm"> externals </A></LI> |
| 72 |
<LI>The <A href="5.current.status.htm"> changelog </A></LI> |
| 73 |
<LI>Instructions on <A href="6.building.from.source.htm"> building Pd from source </A></LI> |
| 74 |
</UL> |
| 75 |
</LI> |
| 76 |
<LI>Next, there's a series of tutorial patches, starting with <b>2.control.examples</b>, |
| 77 |
which serve as an introduction to Pd's "control" structure (as opposed to audio |
| 78 |
functions which are covered next).</LI> |
| 79 |
<LI><b>3.audio.examples</b> includes a set of examples that are also part of Miller |
| 80 |
Puckette's book "The Theory and Technique of Electronic Music". |
| 81 |
The book is freely available online at |
| 82 |
<A href="http://msp.ucsd.edu/techniques.htm"> http://msp.ucsd.edu/techniques.htm</A>.</LI> |
| 83 |
<LI><b>4.data.structures</b> is the last tutorial, giving an introduction to Pd's Data |
| 84 |
Structures feature, also described in this manual in section |
| 85 |
<A href="2.theory.of.operation.htm#s2.10">2.10 Data Structures</A>.</LI> |
| 86 |
<LI>In the <b>5.reference</b> folder, you find the help patches for all objects.</LI> |
| 87 |
<LI>The <b>6.externs</b> folder includes instructions on how to write externals, |
| 88 |
including sample C code for different use cases. More information on externals |
| 89 |
is found in <a href="4.externals.htm">Chapter 4: Externals </a> of this manual.</LI> |
| 90 |
<LI>In the <b>7.stuff</b> folder, you'll find additional patches to explore.</LI> |
| 91 |
<LI>The last subfolder <b>8.topics</b> includes extra documentation with more details on |
| 92 |
specific topics that is referred in the help files.</LI> |
| 93 |
</UL> |
| 94 |
|
| 95 |
<H3> <A href="#s1.2" id="s1.2"> 1.2. The Help menu </A> </H3> |
| 96 |
|
| 97 |
<P> This section describes Pd's <b>Help menu</b>, which offers shortcuts |
| 98 |
to the documentation and other resources. "HTML Manual..." (or "Pd Help" on macOS) opens |
| 99 |
this HTML manual.</P> |
| 100 |
|
| 101 |
<figure> |
| 102 |
<IMG src="resources/1.2.1.png" ALT="pd help"> |
| 103 |
<figcaption><u>Fig. 1.2.1</u> The Help menu</figcaption> |
| 104 |
</figure> |
| 105 |
|
| 106 |
<P> The "Browser..." entry opens Pd's internal file document browser. The |
| 107 |
"Pure Data" folder shown on top of this file browser points to the 'doc' |
| 108 |
folder (just explained above) and it's a quick way to navigate and open |
| 109 |
the manual, particular help files, examples from the tutorials, etc.</P> |
| 110 |
|
| 111 |
<figure> |
| 112 |
<IMG src="resources/1.2.2.png" ALT="browser"> |
| 113 |
<figcaption><u>Fig. 1.2.2</u> The Help browser accessing the Pd's documentation folder</figcaption> |
| 114 |
</figure> |
| 115 |
|
| 116 |
<P> In this browser window, you'll also find the 'externals' installed on your |
| 117 |
system. By default, Pd comes with an 'extra' library, so you'll find these |
| 118 |
externals here even if you have not yet installed anything.</P> |
| 119 |
|
| 120 |
<P> The "List of objects" entry of the <b>Help menu</b> opens a patch that |
| 121 |
includes a list of all native objects with brief explanations.</P> |
| 122 |
|
| 123 |
<figure> |
| 124 |
<IMG src="resources/1.2.3.png" ALT="list of objects"> |
| 125 |
<figcaption><u>Fig. 1.2.3</u> The help-intro patch with a list of all internal objects</figcaption> |
| 126 |
</figure> |
| 127 |
|
| 128 |
<P> The "puredata.info" entry opens <a href="http://www.pure-data.info/"> |
| 129 |
pure-data.info</a>, an extensive Pd community website that aims to be the central |
| 130 |
resource for Pd, from downloads to forums, member pages, extra documentation resources |
| 131 |
and a patch exchange.</P> |
| 132 |
|
| 133 |
<P> The "Check for updates" entry opens a <a href="https://pdlatest.puredata.info/">webpage |
| 134 |
with recent Pd releases</a>, so you can check if there is a new Pd version for download</P> |
| 135 |
|
| 136 |
<P> The "Report a bug" entry opens the <a href="https://bugs.puredata.info/">Pd |
| 137 |
issue tracker</a>, where you can find known bugs and also report new ones.</P> |
| 138 |
|
| 139 |
<H3> <A href="#s1.3" id="s1.3"> 1.3. Other resources </A> </H3> |
| 140 |
|
| 141 |
<P> The Pd source code is found on github, on the |
| 142 |
<A href=https://github.com/pure-data/pure-data/> Pd GitHub project page</A>. This project |
| 143 |
also includes a repository that focuses on Pd's documentation, called |
| 144 |
<A href=https://github.com/pure-data/pddp>pddp (Pure Data Documentation Project)</A>. |
| 145 |
This repository also has an <A href=https://github.com/pure-data/pddp/issues> issue tracker</A> |
| 146 |
for issues related to the documentation.</P> |
| 147 |
|
| 148 |
<P> Most of the interesting news related to Pd show up on the Pd mailing list, |
| 149 |
maintained by IOhannes zmölnig. To subscribe or browse the archives, |
| 150 |
visit: <A href="https://lists.puredata.info/listinfo/pd-list"> |
| 151 |
https://lists.puredata.info/listinfo/pd-list</A>. This is the best source of |
| 152 |
recent information regarding installation problems and bugs. It is perfectly |
| 153 |
reasonable to post "beginner" questions on this list; alternatively you can |
| 154 |
contact [email protected] for help. Many extensions for Pd also get announced on the |
| 155 |
mailing list.</P> |
| 156 |
|
| 157 |
<P> Other community resources online include the <A href="http://forum.pdpatchrepo.info/"> |
| 158 |
Pd forum</A>, a <A href="https://telegram.me/puredata ">Pd telegram group</A>, a |
| 159 |
<A href="https://www.facebook.com/groups/4729684494 ">Facebook group</A> and a |
| 160 |
<A href="https://discord.gg/bcPZcKQkmW">Discord channel</A>. Here, you can find many users |
| 161 |
that can help you with basic instructions and troubleshooting as well as other interactions |
| 162 |
with the community.</P> |
| 163 |
|
| 164 |
<H3> <A href="#s1.4" id="s1.4"> 1.4. Other flavors </A> </H3> |
| 165 |
|
| 166 |
<P> Pure Data, being an open source project, can be forked into alternative projects that |
| 167 |
are developed independently. These forks are also known as "different flavors" of Pd. |
| 168 |
This manual covers the official Pure Data distribution by Miller Puckette, which is also |
| 169 |
known as the "Vanilla" flavor of Pd, so it's commonly referred to "Pd Vanilla".</P> |
| 170 |
|
| 171 |
<P> Other Pd flavors mainly focus on two things, modifying the GUI to offer more user-friendliness |
| 172 |
and extending its default features with pre-installed externals. Notably, the PlugData fork |
| 173 |
also allows you to run Pd as a plugin in any DAW.</P> |
| 174 |
|
| 175 |
<P> A very important and historical flavor of Pd was Pd-extended, which has been discontinued |
| 176 |
in 2014. This used to come with a vast collection of externals. Many Pure Data tutorials |
| 177 |
out there are based on this distribution. You can still follow Pd-extended tutorials if you |
| 178 |
install the necessary libraries, but note that these tutorials are very outdated and don't |
| 179 |
include many goodies that have been included in Pd Vanilla over the last years, like the |
| 180 |
<b>[clone]</b> object, <b>[savestate]</b>, <b>[file]</b>, multichannel connections and many |
| 181 |
more.</P> |
| 182 |
|
| 183 |
<P> The currently active and main flavors of Pd are presented on the front page |
| 184 |
of <A href="https://puredata.info/"> https://puredata.info/</A>. Note that some |
| 185 |
forks may introduce incompatibilities and not be fully up to date with Pd Vanilla. |
| 186 |
For forks that are fully compatible, the information in this manual should also apply |
| 187 |
for the most part.</P> |
| 188 |
|
| 189 |
</div> |
| 190 |
<div class="nav nav-bottom"> |
| 191 |
<div class="nav-back"></div> |
| 192 |
<div class="nav-home"><A href="index.htm#s1">Table of contents</A></div> |
| 193 |
<div class="nav-forward"><A href="2.theory.of.operation.htm">Chapter 2: Theory of operation ></A></div> |
| 194 |
</div> |
| 195 |
|
| 196 |
</BODY> |
| 197 |
</HTML> |