aboutsummaryrefslogtreecommitdiff
path: root/doc/tutorials/externals-howto/HOWTO-externals-de.tex
blob: 73b2eedbd1b305f536f3b5c5e2d3bc1320a793cf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
% format latexg -*- latex -*-

\documentclass[12pt, a4paper,austrian, titlepage]{article}


%% HOWTO write an external for Pd
%% Copyright (c) 2001-2006 by IOhannes m zm�lnig
%%
%%  Permission is granted to copy, distribute and/or modify this document
%%  under the terms of the GNU Free Documentation License, Version 1.2
%%  or any later version published by the Free Software Foundation;
%%  with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
%%  Texts.  A copy of the license is included in the LICENSE.txt file.

%sprache
\usepackage[latin1]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{babel}

% add hypertext support (fine for latex2html)
\usepackage{html}

% add landscape support (for rotating text through 90deg)
\usepackage{lscape}


%\begin{latexonly}
% pdf kompatibilit�t
\newif\ifpdf
\ifx\pdfoutput\undefined
  \pdffalse     % we are not running PDFLatex
\else
  \pdfoutput=1  % yes, we are running PDFLatex
  \pdftrue
\fi

\latexhtml{
\ifpdf
  \usepackage[pdftex]{graphicx}
  \pdfcompresslevel=9
\else
  \usepackage{graphicx}
\fi
}{
\usepackage{graphicx}
}


\title{
HOWTO \\
write an External \\
for {\em Pure data}
}

\author{
johannes m zm�lnig \\
\\
{\em
\latexhtml{institut f�r elektronische musik und akustik}
{\htmladdnormalink{institut f�r elektronische musik und akustik}{http://iem.at}}
}
}

\date{}

\begin {document}
\maketitle

\hyphenation{Echt-zeit}
\hyphenation{Computer-musik-program-men}
\hyphenation{Echt-zeit-Computer-musik-pro-gramm}

\begin{abstract}
Pd ist ein graphisches Computermusiksystem in der Tradition von IRCAMs {\em ISPW-max}.

Obwohl eine F�lle von Funktionen von Pd selbst zur Verf�gung gestellt 
werden, st��t man doch manchmal an die Grenzen dessen,
das mit diesen Primitiven und ihren Kombinationen m�glich ist.

Deswegen bietet Pd die M�glichkeit, eigene Primitive (``objects'', Objekte) in komplexen
Programmiersprachen wie {\tt C/C++} zu erstellen.

In diesem Dokument soll beschrieben werden, wie man solche Primitive mit Hilfe der 
Sprache {\tt C}, in der auch Pd selbst realisiert wurde, schreibt.
\end{abstract}


\vfill
\newpage

\tableofcontents

\vfill
\newpage

\section{Voraussetzungen und Begriffsbestimmungen}

Pd bezieht sich auf das graphische Echtzeit-Computermusikprogramm von
Miller~S.~Puckette.
{\em Pure data}.

Zum Verst�ndnis dieses Dokumentes wird der Umgang mit Pd sowie
Verst�ndnis von Programmiertechniken, insbesondere {\tt C} vorausgesetzt.

Zum Schreiben von eigenen Primitiven wird weiters ein {\tt C}-Compiler,
der dem {\tt ANSI-C}-Standard gen�gt, notwendig sein.
Solche Compiler sind beispielsweise der {\em Gnu C-Compiler} (gcc) auf linux-Systemen oder
{\em Visual-C++} auf Windows-Systemen.

\subsection{Klassen, Instanzen und Objekte}
Pd ist in der Programmiersprache {\tt C} geschrieben.
Allerdings ist Pd auf Grund seiner graphischen Natur ein {\em objektorientiertes} System.
Da {\tt C} die Verwendung von Klassen nicht sehr gut unterst�tzt, ist der resultierende
Quellcode nicht so elegant wie er zum Beispiel unter {\tt C++} w�re.

Der Ausdruck {\em Klasse} bezieht sich in diesem Dokument auf die Realisierung eines
Konzeptes, bei dem Daten und Manipulatoren eine Einheit bilden.

Konkrete {\em Instanzen einer Klasse} sind {\em Objekte}.

\subsection{Internals, Externals und Libraries}
Um Begriffsverwirrungen von vorneherein auszuschlie�en, seien hier kurz die Ausdr�cke
{\em Internal}, {\em External} und {\em Library} erkl�rt.

\paragraph{Internal}
Ein {\em Internal} ist eine Klasse, die in Pd eingebaut ist.
Viele Primitive wie ``+'', ``pack'' oder ``sig\~\/`` sind {\em Internals}

\paragraph{External}
Ein {\em External} ist eine Klasse, die nicht in Pd eingebaut ist und erst zur Laufzeit
nachgeladen wird.
Sind sie einmal im Speicher von Pd, so sind {\em Externals} nicht mehr von {\em Internals} zu
unterscheiden.

\paragraph{Library}
Eine {\em Library} bezeichnet eine Sammlung von {\em Externals},
die gemeinsam in eine Bin�rdatei kompiliert werden.

{\em Library}-Dateien m�ssen eine betriebssystemabh�ngige Namenskonvention einhalten:

\begin{tabular}{c||c|c|c}
Bibliothek&linux&irix&Win32 \\
\hline
{\tt my\_lib}&{\tt  my\_lib.pd\_linux}&{\tt  my\_lib.pd\_irix}&
{\tt  my\_lib.dll}\\
\end{tabular}

Die einfachste Form einer {\em Library} beinhaltet genau ein {\em External},
das den selben Name tr�gt, wie auch die {\em Library}

Im Gegensatz zu Externals k�nnen {\em Libraries} mit bestimmten Befehlen
von Pd importiert werden.
Ist eine {\em Library} importiert worden,
so sind alle {\em Externals}, die sie beinhaltet,
in den Speicher geladen und stehen als Objekte zur Verf�gung.

Pd stellt zwei Methoden zur Verf�gung, um {\em Libraries} zu laden:
\begin{itemize}
\item mit der commandline-Option ``{\tt -lib my\_lib}''
\item durch Kreieren eines Objektes ``{\tt my\_lib}''
\end{itemize}

Die erste Methode l�dt die {\em Library} sofort beim Starten von Pd.
Dies ist die zu bevorzugende Methode f�r {\em Libraries},
die mehrere {\em Externals} beinhalten.

Die zweite Methode ist f�r {\em Libraries} zu bevorzugen, die genau
ein {\em External} mit dem selben Namen beinhalten.
Bei der zweiten Methode wird zuerst gepr�ft, ob eine Klasse namens ``my\_lib'' bereits
in den Speicher geladen ist.
Ist dies nicht der Fall\footnote
{Ist eine solche Klasse bereits im Speicher, wird ein
Objekt namens ``my\_lib'' instanziiert und der Vorgang bricht ab.
Es wird also keine neue {\em Library} geladen.
Man kann daher keine {\em Libraries} mit bereits verwendeten Klassennamen,
wie zum Beispiel ``abs'', laden.}
so werden alle Pfade untersucht,
ob darin eine Datei namens ``{\tt my\_lib.pd\_linux}''\footnote{
oder einer anderen betriebssystemabh�ngigen Dateinamenerweiterung (s.o.)}
existiert.
Wird eine solche Datei gefunden, so werden alle in ihr enthaltenen {\em Externals}
in den Speicher geladen.
Danach wird nachgesehen, ob nun eine Klasse namens ``my\_lib''
als (neu geladenes) {\em External} im Speicher existiert.
Ist dies der Fall, so wird eine Instanz dieser Klasse geschaffen.
Ansonsten wird eine Fehlermeldung ausgegeben, die Instanziierung ist gescheitert.


\section{mein erstes External: {\tt helloworld}}
Wie das beim Erlernen von Programmiersprachen so �blich ist,
beginnen wir mit ``Hello world''.

Ein Objekt soll geschaffen werden, dass jedesmal, wenn es
mit ``bang'' getriggert wird, die Zeile ``Hello world!!'' auf
die Standardausgabe schreibt.

\subsection{die Schnittstelle zu Pd}
Um ein Pd-External zu schreiben, braucht man eine wohldefinierte Schnittstelle.
Diese wird in der Datei ``m\_pd.h'' zur Verf�gung gestellt.

\begin{verbatim}
#include "m_pd.h"
\end{verbatim}


\subsection{eine Klasse und ihr Datenraum}
Als n�chstes mu� eine neue Klasse vorbereitet und der
Datenraum f�r diese Klasse definiert werden.

\begin{verbatim}
static t_class *helloworld_class;

typedef struct _helloworld {
  t_object  x_obj;
} t_helloworld;
\end{verbatim}

\verb+hello_worldclass+ wird der Zeiger auf die neue Klasse.

Die Struktur \verb+t_helloworld+ (vom Typ \verb+_helloworld+)
stellt den Datenraum der Klasse dar.
Ein unverzichtbares Element ist dabei eine Variable des Type \verb+t_object+.
In ihr werden interne Objekteigenschaften abgelegt, wie zum Beispiel
die Gr��e der Objekt-Box bei der graphischen Darstellung, aber auch
Daten �ber Inlets und Outlets.
\verb+t_object+ muss der erste Eintrag in die Struktur sein !

Da bei einer einfachen ``Hello world''-Anwendung keine Variablen gebraucht werden,
ist die Struktur ansonsten leer.

\subsection{Methodenraum}
Zu einer Klasse geh�ren neben einem Datenraum auch ein Satz von
Manipulatoren (Methoden) mit denen diese Daten manipuliert werden k�nnen.

Wird eine Message an eine Instanz unserer Klasse geschickt,
so wird eine Methoden aufgerufen.
Diese Mehtoden, die die Schnittstelle zum Messagesystem von Pd bilden, 
haben grunds�tzlich kein R�ckgabeargument, sind also vom Typ \verb+void+.

\begin{verbatim}
void helloworld_bang(t_helloworld *x)
{
  post("Hello world !!");
}
\end{verbatim}

Diese Methode hat ein �bergabeargument vom Typ \verb+t_helloworld+,
sodass wir also unseren Datenraum manipulieren k�nnten.

Da wir nur ``Hello world!'' ausgeben wollen (und ausserdem unser Datenraum
recht sp�rlich ist), verzichten wir auf eine Manipulation.

Mit dem Befehl \verb+post(char *c,...)+ wird eine Meldung an die Standardausgabe
geschickt.
Ein Zeilenumbruch wird automatisch angeh�ngt.
Ansonsten funktioniert \verb+post()+ gleich wie der {\tt C}-Befehl \verb+printf()+.

\subsection{Generierung einer neuen Klasse}
Um eine neue Klasse zu generieren, m�ssen Angaben �ber
den Datenraum und den Methodenraum dieser Klasse 
beim Laden einer Library an Pd �bergeben werden.

Wird eine neue Library ``my\_lib'' geladen,
so versucht Pd eine Funktion ``my\_lib\_setup()'' aufzurufen.
Diese Funktion (oder von ihr aufgerufene Funktionen) teilt Pd mit,
welche Eigenschaften die neuen Klassen haben.
Sie wird nur einmal, beim Laden der Library aufgerufen.

\begin{verbatim}
void helloworld_setup(void)
{
  helloworld_class = class_new(gensym("helloworld"),
        (t_newmethod)helloworld_new,
        0, sizeof(t_helloworld),
        CLASS_DEFAULT, 0);

  class_addbang(helloworld_class, helloworld_bang);
}
\end{verbatim}

\paragraph{class\_new}

Der Befehl \verb+class_new+ kreiert eine neue Klasse und gibt einen Zeiger auf diesen
Prototyp zur�ck.

Das erste Argument ist der symbolische Name der Klasse.

Die n�chsten beiden Argumente definieren Konstruktor und Destruktor der Klasse.
Wenn in einen Pd-Patch ein Objekt kreiert wird, 
instanziiert der Konstruktor \verb+(t_newmethod)helloworld_new+ diesses Objekt
und initialisiert den Datenraum.
Wird ein Pd-Patch geschlossen oder ein Objekt daraus entfernt,
so gibt der Destruktor, wenn notwendig, dynamisch reservierten Speicher wieder frei.
Der Speicherplatz f�r den Datenraum selbst wird von Pd automatisch freigegeben.
Deshalb kann in diesem Beispiel auf einen Destruktor verzichtet werden,
folglich wird dieses Argument auf ``0'' gesetzt.

Damit Pd genug Speicher f�r den Datenraum allozieren und wieder freigeben kann,
wird die Gr��e dieser Datenstruktur als viertes Argument �bergeben.

Das f�nfte Argument bestimmt, wie Klasseninstanzen graphisch dargestellt werden und 
ob sie mit anderen Objekten verkn�pfbar sind.
Der Standardwert \verb+CLASS_DEFAULT+ (oder einfacher: ``0'') bezieht sich auf
ein Objekt mit mindestens einem Inlet.
W�rde man keinen Eingang wollen (wie zum Beispiel beim Internal ``receive''),
so kann man diesen Wert auf \verb+CLASS_NOINLET+ setzen.

Die restlichen Argumente definieren die �bergabeargumente eines Objektes und deren Typ.

Bis zu sechs numerische und symbolische Objektargumente k�nnen in beliebiger Reihenfolge
mit \verb+A_DEFFLOAT+ und \verb+A_DEFSYMBOL+ angegeben werden.
Sollen mehr Argumente �bergeben werden oder die Atomtyp-Reihenfolge flexibler sein,
so bietet \verb+A_GIMME+ die �bergabe einer beliebigen Liste von Atomen.

Die Objektargumentliste wird mit ``0'' terminiert.
In unserem Beispiel sind also keine �bergabeargumente f�r die Klasse vorgesehen.

\paragraph{class\_addbang}
Jetzt muss zur Klasse noch ein Methodenraum hinzugef�gt werden.

Mit \verb+class_addbang+ wird der durch das erste Argument definierten Klasse
eine Methode f�r eine ``bang''-Message hinzuzugef�gt.
Diese Methode ist das zweite Argument.



\subsection{Konstruktor: Instanziierung eines Objektes}
Jedesmal, wenn in einem Pd-Patch ein Objekt einer Klasse kreiert wird,
schafft der mit \verb+class_new+ angegebene Konstruktor eine neue Instanz der Klasse.

Der Konstruktor ist immer vom Typ \verb+void *+

\begin{verbatim}
void *helloworld_new(void)
{
  t_helloworld *x = (t_helloworld *)pd_new(helloworld_class);

  return (void *)x;
}
\end{verbatim}

Die �bergabeargumente der Konstruktorfunktion h�ngen von den mit
\verb+class_new+ angegebenen Objektargumenten ab.

\begin{tabular}{l|l}
\verb+class_new+-Argument&Konstruktorargument\\
\hline
\verb+A_DEFFLOAT+&\verb+t_floatarg f+ \\
\verb+A_DEFSYMBOL+&\verb+t_symbol *s+ \\
\verb+A_GIMME+&\verb+t_symbol *s, int argc, t_atom *argv+
\end{tabular}

Da in diesem Beispiel keine Objektargumente existieren, hat auch
der Konstruktor keine.

Die Funktion \verb+pd_new+ reserviert Speicher f�r den Datenraum, initialisiert
die objektinternen Variablen und gibt einen Zeiger auf den Datenraum zur�ck.

Der Typ-Cast auf den Datenraum ist notwendig.

Normalerweise w�rden im Konstruktor auch die Objektvariablen initialisiert werden.
In diesem Beispiel ist dies aber nicht notwendig.

Der Konstruktor muss einen Zeiger auf den instanziierten Datenraum zur�ckgeben.

\subsection{der Code: \tt helloworld}

\begin{verbatim}
#include "m_pd.h"

static t_class *helloworld_class;

typedef struct _helloworld {
  t_object  x_obj;
} t_helloworld;

void helloworld_bang(t_helloworld *x)
{
  post("Hello world !!");
}

void *helloworld_new(void)
{
  t_helloworld *x = (t_helloworld *)pd_new(helloworld_class);

  return (void *)x;
}

void helloworld_setup(void) {
  helloworld_class = class_new(gensym("helloworld"),
        (t_newmethod)helloworld_new,
        0, sizeof(t_helloworld),
        CLASS_DEFAULT, 0);
  class_addbang(helloworld_class, helloworld_bang);
}
\end{verbatim}


\section{ein komplexes External: {\tt counter}}

Als n�chstes soll ein einfacher Z�hler als External geschrieben werden.
Ein ``bang''-Trigger soll den aktuellen Z�hlerstand am Outlet ausgeben
und anschlie�end um 1 erh�hen.

Diese Klasse unterscheidet sich nicht sonderlich von der vorherigen, 
ausser dass nun eine interne Variable ``Z�hlerstand'' ben�tigt
wird und das Ergebnis nicht mehr auf die Standardausgabe geschrieben sondern
als Message zu einem Outlet geschickt wird.

\subsection{Variablen eines Objektes}
Ein Z�hler braucht nat�rlich eine Zustandsvariable,
in der der aktueller Z�hlerstand gespeichert ist.

Solche zum Objekt geh�rigen Zustandsvariablen werden im Datenraum abgelegt.

\begin{verbatim}
typedef struct _counter {
  t_object  x_obj;
  t_int i_count;
} t_counter;
\end{verbatim}

Die Ganzzahlvariable \verb+i_count+ beschreibt den Z�hlerstand.
Nat�rlich k�nnte man sie auch als Gleitkommawert realisieren,
doch traditionell werden Z�hler ganzzahlig ausgef�hrt.

\subsection{�bergabeargumente}
F�r einen Z�hler ist es durchaus sinnvoll, wenn man den Startwert festlegen kann.
Hier soll der Startwert dem Objekt bei der Kreation �bergeben werden.

\begin{verbatim}
void counter_setup(void) {
  counter_class = class_new(gensym("counter"),
        (t_newmethod)counter_new,
        0, sizeof(t_counter),
        CLASS_DEFAULT,
        A_DEFFLOAT, 0);

  class_addbang(counter_class, counter_bang);
}
\end{verbatim}

Es ist also ein Argument zur Funktion \verb+class_new+ hinzugekommen:

\verb+A_DEFFLOAT+ teilt mit, dass das Objekt ein �bergabeargument
vom Typ \verb+t_floatarg+ hat.



\subsection{Konstruktor}
Dem Konstruktor kommen nun mehrere neue Aufgaben zu.
Zum ersten muss eine Variable initialisiert werden,
zum anderen muss auch ein Outlet f�r das Objekt geschaffen werden.
\begin{verbatim}
void *counter_new(t_floatarg f)
{
  t_counter *x = (t_counter *)pd_new(counter_class);

  x->i_count=f;
  outlet_new(&x->x_obj, &s_float);

  return (void *)x;
}
\end{verbatim}

Die Konstruktorfunktion hat jetzt ein Argument fom Typ \verb+t_floatarg+, wie es in
der Setup-Routine \verb+class_new+ deklariert worden ist.
Dieses Argument initialisiert den Z�hler.

Einer neuer Outlet wird mit der Funktion \verb+outlet_new+ geschaffen.
Das erste Argument ist ein Zeiger auf die Objektinterna,
in denen der neue Ausgang geschaffen wird.

Das zweite Argument ist eine symbolische Typbeschreibung des Ausgangs.
Da der Z�hler numerische Werte ausgeben soll, ist er vom Typ ``float''.
Sollte der Ausgang f�r Messages mit verschiedenen Selectoren verwendet werden,
so ist dieser Wert ``0''.

\verb+outlet_new+ gibt einen Zeiger auf den neuen Outlet zur�ck und speichert diesen
Zeiger in der \verb+t_object+-Variablen \verb+x_obj.ob_outlet+.
Wird nur ein Outlet verwendet, muss daher der Zeiger nicht extra im Datenraum gespeichert
werden.
Werden mehrere Outlets verwendet, so m�ssen diese Zeiger im Datenraum gespeichert werden.

\subsection{die Z�hlermethode}
Bei einem Triggerevent soll der alte Z�hlerstand ausgegeben und um eins inkrementiert werden.

\begin{verbatim}
void counter_bang(t_counter *x)
{
  t_float f=x->i_count;
  x->i_count++;
  outlet_float(x->x_obj.ob_outlet, f);
}
\end{verbatim}

Die Funktion \verb+outlet_float+ gibt an dem Outlet, auf den das erste Argument verweist,
eine Gleitkommazahl (zweites Argument) aus.

Hier wird zuerst der Z�hlerstand in eine Gleitkomma-Buffervariable gespeichert.
Danach wird er inkrementiert und dann wird erst die Buffervariable ausgegeben.

Was auf den ersten Blick unn�tig erscheint, macht bei n�herer Betrachtung Sinn:
Die Buffervariable wurde gleich als \verb+t_float+ realisiert,
da sich \verb+outlet_float+ sowieso einen Gleitkommawert erwartet
und ein Cast unvermeidlich ist.

W�rde der Z�hlerstand zuerst an den Outlet geschickt werden und
danach erst inkrementiert werden, w�rde dies unter Umst�nden zu einem etwas seltsamen
Verhalten f�hren.
Wenn n�mlich der Z�hlerausgang wieder an den Inlet zur�ckgef�hrt w�rde, der
Z�hler sich also selbst triggerte, so w�rde die Z�hlermethode erneut
aufgerufen, ohne dass der Z�hlerstand inkrementiert worden w�re.
Dies ist im Allgemeinen aber unerw�nscht.

Man kann �brigens das gleiche Ergebnis wie hier mit nur einer einzigen Zeile erreichen, 
doch sieht man das {\em Reentrant}-Problem dann nicht sehr gut.

\subsection{der Code: \tt counter}

\begin{verbatim}
#include "m_pd.h"

static t_class *counter_class;

typedef struct _counter {
  t_object  x_obj;
  t_int i_count;
} t_counter;

void counter_bang(t_counter *x)
{
  t_float f=x->i_count;
  x->i_count++;
  outlet_float(x->x_obj.ob_outlet, f);
}

void *counter_new(t_floatarg f)
{
  t_counter *x = (t_counter *)pd_new(counter_class);

  x->i_count=f;
  outlet_new(&x->x_obj, &s_float);

  return (void *)x;
}

void counter_setup(void) {
  counter_class = class_new(gensym("counter"),
        (t_newmethod)counter_new,
        0, sizeof(t_counter),
        CLASS_DEFAULT,
        A_DEFFLOAT, 0);

  class_addbang(counter_class, counter_bang);
}
\end{verbatim}


\section{ein komplexeres External: \tt counter}

Man kann nat�rlich auch einen einfache Z�hler ein bi�chen komplexer gestalten.
Es w�re zum Beispiel sinnvoll,
wenn der Z�hlerstand auf einen Startwert zur�ckgesetzt werden k�nnte,
wenn man Start- und Endwert bestimmen k�nnte und auch die Schrittweite variabel w�re.

Bei jedem Z�hler�berlauf soll ein zweiter Outlet eine ``bang''-Message schicken und der
Z�hler auf den Startwert zur�ckgesetzt werden.

\subsection{erweiterter Datenraum}

\begin{verbatim}
typedef struct _counter {
  t_object  x_obj;
  t_int i_count;
  t_float step;
  t_int i_down, i_up;
  t_outlet *f_out, *b_out;
} t_counter;
\end{verbatim}

Der Datenraum wurde also erweitert um Variablen f�r Schrittweite und Start- bzw. Stopwert.
Weiters werden Zeiger auf zwei Outlets zur Verf�gung gestellt.

\subsection{Erweiterung der Klasse}
Da nun die Klassenobjekte verschiedene Messages, wie ``set'' und ``reset'',
verstehen k�nnen sollen, mussen der Methodenraum entsprechend erweitert werden.

\begin{verbatim}
  counter_class = class_new(gensym("counter"),
        (t_newmethod)counter_new,
        0, sizeof(t_counter),
        CLASS_DEFAULT, 
        A_GIMME, 0);
\end{verbatim}

Der Klassengenerator \verb+class_new+ ist um das Objekt�bergabeargument
\verb+A_GIMME+ erweitert.
Damit kann eine dynamische Anzahl von Argumenten bei der Objektinstanziierung
verwaltet werden.

\begin{verbatim}
  class_addmethod(counter_class,
        (t_method)counter_reset,
        gensym("reset"), 0);
\end{verbatim}

\verb+class_addmethod+ f�gt einer Klasse eine Methode mit f�r einen
beliebigen Selector hinzu.

Das erste Argument ist die Klasse,
zu der die Methode (zweites Argument) hinzugef�gt wird.

Das dritte Argument ist der symbolische Selector,
der mit der Methode assoziiert wird.

Die restlichen ``0''-terminierten Argumente
beschreiben die Atomliste, die dem Selector folgt.

\begin{verbatim}
  class_addmethod(counter_class,
        (t_method)counter_set, gensym("set"),
        A_DEFFLOAT, 0);
  class_addmethod(counter_class,
        (t_method)counter_bound, gensym("bound"),
        A_DEFFLOAT, A_DEFFLOAT, 0);
\end{verbatim}

Eine Methode f�r den Selector ``set'', gefolgt von einem numerischen Wert,
wird hinzugef�gt.

F�r den Selector ``bound'', gefolgt von zwei numerischen Werten,
wird ebenfalls eine Methode zur Klasse hinzugef�gt.

\begin{verbatim}
  class_sethelpsymbol(counter_class, gensym("help-counter"));
\end{verbatim}

Clickt man mit der rechten Maustaste auf ein Pd-Objekt,
so kann man sich einen Hilfe-Patch f�r die zugeh�rige Objektklasse anzeigen lasse.
Standardm��ig wird ist dies ein Patch mit dem symbolischen Klassennamen
im Verzeichnis ``{\em doc/5.reference/}'' gesucht.
Mit dem Befehl \verb+class_sethelpsymbol+ kann ein alternativer Patch angegeben werden.

\subsection{Konstruktion von In- und Outlets}

Bei der Objektkreation sollten dem Objekt verschiedene Argumente �bergeben
werden.

\begin{verbatim}
void *counter_new(t_symbol *s, int argc, t_atom *argv)
\end{verbatim}
Durch die Argumentendeklaration in der \verb+class_new+-Funktion
mit \verb+A_GIMME+, werden dem Konstruktor folgende Argumente
�bergeben:

\begin{tabular}{c|l}
\verb+t_symbol *s+ & der symbolische Namen,\\
& mit dem das Objekt kreiert wurde \\
\verb+int argc+ & die Anzahl, der dem Objekt �bergebenen Argumente\\
\verb+t_atom *argv+ & ein Zeiger auf eine Liste von {\tt argc} Atomen
\end{tabular}

\begin{verbatim}
  t_float f1=0, f2=0;

  x->step=1;
  switch(argc){
  default:
  case 3:
    x->step=atom_getfloat(argv+2);
  case 2:
    f2=atom_getfloat(argv+1);
  case 1:
    f1=atom_getfloat(argv);
    break;
  case 0:
    break;
  }
  if (argc<2)f2=f1;
  x->i_down = (f1<f2)?f1:f2;
  x->i_up   = (f1>f2)?f1:f2;

  x->i_count=x->i_down;
\end{verbatim}

Werden drei Argumente �bergeben, so sollten dies {\em untere Z�hlergrenze},
{\em obere Z�hlergrenze} und {\em Schrittgr��e} sein.
Werden nur zwei Argumente �bergeben,
so wird die Schrittgr��e standardm��ig auf ``1'' gesetzt.
Bei nur einem Argument, sei dies der {\em Startwert} des Z�hlers,
die {\em Schrittgr��e} sei ``1''.

\begin{verbatim}
  inlet_new(&x->x_obj, &x->x_obj.ob_pd,
        gensym("list"), gensym("bound"));
\end{verbatim}
Die Funktion \verb+inlet_new+ erzeugt einen neuen ``aktiven'' Inlet.
``Aktiv'' hei�t, dass eine Klassenmethode ausgef�hrt wird,
wenn eine Message in den einen ``aktiven'' Inlet geschickt wird.

Von der Software-Architektur her ist der erste Inlet immer ``aktiv''.

Die ersten beiden Argumente der \verb+inlet_new+-Funktion
sind Zeiger auf die Objektinterna und die graphische Darstellung des Objektes.

Der symbolische Selector, der durch das dritte Argument spezifiziert wird,
wird f�r diesen Inlet durch einen anderen symbolischen Selector (viertes Argument)
substituiert.

Durch die Substitution von Selectoren kann eine Message
an einem bestimmten rechten Eingang wie eine Message mit einem bestimmten Selector
am linken Eingang betrachtet werden.

Dies bedeutet
\begin{itemize}
\item Der substituierende Selector muss mit \verb+class_addmethod+ angegeben werden.
\item Man kann einen bestimmten rechten Eingang simulieren,
indem man dem ersten Eingang eine Message mit dem Selector dieses Eingangs schickt.
\item Es ist nicht m�glich, einem rechten Eingang Methoden f�r mehr als einen Selector
zuzuweisen. Insbesondere ist es nicht m�glich, ihm eine allgemeine Methode
f�r einen beliebigen Selector zuzuweisen.
\end{itemize}

\begin{verbatim}
  floatinlet_new(&x->x_obj, &x->step);
\end{verbatim}
\verb+floatinlet_new+ generiert einen ``passiven'' Inlet f�r numerische Werte.
``Passive'' Eing�nge erlauben, dass ein Speicherplatz bestimmten Typs im
Variablenraum des Objektes von au�en direkt beschrieben werden kann.
Dadurch ist zum Beispiel eine Abfrage nach illegalen Eingaben nicht m�glich.
Das erste Argument ist dabei ein Zeiger auf die interne Objektinfrastruktur.
Das zweite Argument ist ein Zeiger auf den Speicherplatz, auf den geschrieben wird.

Es k�nnen ``passive'' Eing�nge f�r numerische (Gleitkomma\footnote{
Deswegen ist der {\tt step}-Wert des Klassendatenraums als {\tt t\_float} realisiert.})
-Werte, symbolische Werte und Pointer geschaffen werden.

\begin{verbatim}
  x->f_out = outlet_new(&x->x_obj, &s_float);
  x->b_out = outlet_new(&x->x_obj, &s_bang);
\end{verbatim}

Die von \verb+outlet_new+ zur�ckgegebenen Zeiger auf die geschaffenen Outlets,
m�ssen im Klassendatenraum gespeichert werden,
damit sie sp�ter von den Ausgaberoutinen angesprochen werden.

Die Reihenfolge der Generierung von In- und Outlets ist wichtig,
da sie der Reihenfolge der Ein- und Ausg�nge der graphischen Repr�sentation
des Objektes entsprechen.

\subsection{erweiterter Methodenraum}

Der Methode f�r die ``bang''-Message muss nat�rlich der komplexeren Z�hlerstruktur
gen�ge tun.


\begin{verbatim}
void counter_bang(t_counter *x)
{
  t_float f=x->i_count;
  t_int step = x->step;
  x->i_count+=step;
  if (x->i_down-x->i_up) {
    if ((step>0) && (x->i_count > x->i_up)) {
      x->i_count = x->i_down;
      outlet_bang(x->b_out);
    } else if (x->i_count < x->i_down) {
      x->i_count = x->i_up;
      outlet_bang(x->b_out);
    }
  }
  outlet_float(x->f_out, f);
}
\end{verbatim}

Die einzelnen Outlets werden von den \verb+outlet_...+-Funktionen �ber
die Zeiger auf diese Ausg�nge identifiziert.

Die �brigen Methoden m�ssen noch implementiert werden:

\begin{verbatim}
void counter_reset(t_counter *x)
{
  x->i_count = x->i_down;
}

void counter_set(t_counter *x, t_floatarg f)
{
  x->i_count = f;
}

void counter_bound(t_counter *x, t_floatarg f1, t_floatarg f2)
{
  x->i_down = (f1<f2)?f1:f2;
  x->i_up   = (f1>f2)?f1:f2;
}
\end{verbatim}

\subsection{der Code: \tt counter}

\begin{verbatim}
#include "m_pd.h"

static t_class *counter_class;

typedef struct _counter {
  t_object  x_obj;
  t_int i_count;
  t_float step;
  t_int i_down, i_up;
  t_outlet *f_out, *b_out;
} t_counter;

void counter_bang(t_counter *x)
{
  t_float f=x->i_count;
  t_int step = x->step;
  x->i_count+=step;

  if (x->i_down-x->i_up) {
    if ((step>0) && (x->i_count > x->i_up)) {
      x->i_count = x->i_down;
      outlet_bang(x->b_out);
    } else if (x->i_count < x->i_down) {
      x->i_count = x->i_up;
      outlet_bang(x->b_out);
    }
  }

  outlet_float(x->f_out, f);
}

void counter_reset(t_counter *x)
{
  x->i_count = x->i_down;
}

void counter_set(t_counter *x, t_floatarg f)
{
  x->i_count = f;
}

void counter_bound(t_counter *x, t_floatarg f1, t_floatarg f2)
{
  x->i_down = (f1<f2)?f1:f2;
  x->i_up   = (f1>f2)?f1:f2;
}

void *counter_new(t_symbol *s, int argc, t_atom *argv)
{
  t_counter *x = (t_counter *)pd_new(counter_class);
  t_float f1=0, f2=0;

  x->step=1;
  switch(argc){
  default:
  case 3:
    x->step=atom_getfloat(argv+2);
  case 2:
    f2=atom_getfloat(argv+1);
  case 1:
    f1=atom_getfloat(argv);
    break;
  case 0:
    break;
  }
  if (argc<2)f2=f1;

  x->i_down = (f1<f2)?f1:f2;
  x->i_up   = (f1>f2)?f1:f2;

  x->i_count=x->i_down;

  inlet_new(&x->x_obj, &x->x_obj.ob_pd,
        gensym("list"), gensym("bound"));
  floatinlet_new(&x->x_obj, &x->step);

  x->f_out = outlet_new(&x->x_obj, &s_float);
  x->b_out = outlet_new(&x->x_obj, &s_bang);

  return (void *)x;
}

void counter_setup(void) {
  counter_class = class_new(gensym("counter"),
        (t_newmethod)counter_new,
        0, sizeof(t_counter),
        CLASS_DEFAULT, 
        A_GIMME, 0);

  class_addbang  (counter_class, counter_bang);
  class_addmethod(counter_class,
        (t_method)counter_reset, gensym("reset"), 0);
  class_addmethod(counter_class, 
        (t_method)counter_set, gensym("set"),
        A_DEFFLOAT, 0);
  class_addmethod(counter_class,
        (t_method)counter_bound, gensym("bound"),
        A_DEFFLOAT, A_DEFFLOAT, 0);

  class_sethelpsymbol(counter_class, gensym("help-counter"));
}
\end{verbatim}


\section{ein Signal-External: {\tt pan\~\/}}
Signalklassen sind normale Klassen, die zus�tzlich Methoden
f�r Signale bereitstellen.

Alle Methoden und Konzepte die mit normalen Objektklassen realisierbar sind,
sind also auch mit Signalklassen zuverwirklichen.

Per Konvention enden die symbolischen Namen mit einer Tilde \~\/.

Anhand einer Klasse ``pan\~\/`` soll demonstriert werden wie Signalklassen geschrieben
werden k�nnen.

Ein Signal am linken Inlet wird mit einem Signal am zweiten Inlet gemischt.
Der Mischungsgrad wird als \verb+t_float+-Message an einen dritten Eingang festgelegt.

\subsection{Variablen einer Signalklasse}
Da eine Signalklasse nur eine erweiterte normale Klasse ist,
gibt es keine prinzipielle Unterschiede zwischen den Datenr�umen.

\begin{verbatim}
typedef struct _pan_tilde {
  t_object x_obj;

  t_sample f_pan;
  t_float  f;
} t_pan_tilde;
\end{verbatim}

Es wird nur eine Variable f�r den {\em Mischfaktor} der Panningfunktion ben�tigt.

Die Variable \verb+f+ wird gebraucht, falls kein Signal am Signalinlet liegt.
Wird dann an diesen Signalinlet ein numerischer Wert als Message geschickt,
so ersetzt dieser das Signal und wird in der Variable \verb+f+ gespeichert.

\subsection{Signalklassen}

\begin{verbatim}
void pan_tilde_setup(void) {
  pan_tilde_class = class_new(gensym("pan~"),
        (t_newmethod)pan_tilde_new,
        0, sizeof(t_pan_tilde),
        CLASS_DEFAULT, 
        A_DEFFLOAT, 0);

  class_addmethod(pan_tilde_class,
        (t_method)pan_tilde_dsp, gensym("dsp"), 0);
  CLASS_MAINSIGNALIN(pan_tilde_class, t_pan_tilde, f);
}
\end{verbatim}

Jeder Signalklasse muss eine Methode f�r die Signalverarbeitung zugeordnet werden.
Wenn die Audioengine von Pd gestartet wird, wird allen Objekten eine
Message mit dem Selector ``\verb+dsp+'' geschickt.
Alle Klassen, die eine Methode f�r die ``dsp''-Message haben, sind Signalklassen.

Signalklassen, die Signal-Inlets zur Verf�gung stellen wollen,
m�ssen dies mit dem \verb+CLASS_MAINSIGNALIN+-Makro anmelden.
Dadurch ist der erste Inlet als Signalinlet deklariert.
\verb+t_float+-Messages k�nnen nicht mehr an einen solchen Eingang
gesendet werden.

Das erste Argument des Makros ist ein Zeiger auf die Signalklasse.
Das zweite Argument ist der Typ des Datenraums der Klasse.
Das dritte Argument ist eine Dummy-Variable aus dem Datenraum, die gebraucht wird,
um bei nicht vorhandenen Signalen am Signalinlet diese durch \verb+t_float+-Messages
einfach ersetzen zu k�nnen.

\subsection{Konstruktion von Signal-In- und Outlets}

\begin{verbatim}
void *pan_tilde_new(t_floatarg f)
{
  t_pan_tilde *x = (t_pan_tilde *)pd_new(pan_tilde_class);

  x->f_pan = f;
  
  inlet_new(&x->x_obj, &x->x_obj.ob_pd, &s_signal, &s_signal);
  floatinlet_new (&x->x_obj, &x->f_pan);

  outlet_new(&x->x_obj, &s_signal);

  return (void *)x;
}
\end{verbatim}

Zus�tzliche Signal-Eing�nge werden normal mit der Routine \verb+inlet_new+
hinzugef�gt.
Die letzen beiden Argumente sind dann jeweils ein Verweis auf den symbolischen Selector
``signal'' in der lookup-Tabelle.

Signal-Outlets werden ebenfalls wie Message-Outlets generiert, deren Outlet mit dem
Selector ``signal'' versehen ist.


\subsection{DSP-Methode}
Wenn die Audio-Engine von Pd eingeschalten wird,
so teilen ihr alle Signal-Objekte mit,
welche Methode von ihrer Klasse zur digitalen Signalverarbeitung herangezogen werden soll.

Die ``DSP''-Methode hat als Argumente einen Zeiger auf den Klassendatenraum und
einen Zeiger auf ein Array von Signalen.

Die Signale im Array sind so angeordnet, dass sie am graphischen Objekt
im Uhrzeigersinn gelesen werden.\footnote{
Sofern linke und rechte Ein- und Ausgangssignale vorhanden sind, gilt also:
Zuerst kommt das linke Eingangssignal, danach die rechten Eingangssignale;
nach den rechten Ausgangssignalen kommt das linke Ausgangssignal.
}

\begin{verbatim}
void pan_tilde_dsp(t_pan_tilde *x, t_signal **sp)
{
  dsp_add(pan_tilde_perform, 5, x,
          sp[0]->s_vec, sp[1]->s_vec, sp[2]->s_vec, sp[0]->s_n);
}
\end{verbatim}

\verb+dsp_add+ f�gt eine ``Perform''-Routine (erstes Argument) zum DSP-Baum hinzu.
Das zweite Argument ist die Anzahl der nachfolgenden Zeiger auf diverse Variablen.
Welche Zeiger auf welche Variablen �bergeben werden, unterliegt keiner Beschr�nkung.

sp[0] bezeichnet hier das erste Eingangssignal, sp[1] das zweite Eingangssignal,
sp[3] das Ausgangssignal.

Die Struktur \verb+t_signal+ enth�lt einen Zeiger auf den
zugeh�rigen Signalvektor \verb+.s_vec+ (ein Array von Samples \verb+t_sample+),
sowie die L�nge dieses Signalvektors \verb+.s_n+.
Da innerhalb eines Patches alle Signalvektoren die gleiche L�nge haben,
gen�gt es, die L�nge eines dieser Vektoren abzufragen.

\subsection{perform-Routine}
Die perform-Routine ist das eigentliche DSP-Herzst�ck einer Signalklasse.

Ihr wird ein Zeiger auf ein Integer-Array �bergeben.
In diesem Array sind die Zeiger gespeichert, die mit \verb+dsp_add+ �bergeben wurden.
Sie m�ssen auf ihren urspr�nglichen Typ zur�ckgecastet werden.

Die perform-Routine mu� einen Zeiger auf Integer zur�ckgeben, der hinter den
Speicherplatz zeigt, in dem die eigenen Zeiger gespeichert sind.
Dies bedeutet, dass das R�ckgabeargument gleich dem �bergabeargument plus der
Anzahl der eigenen Zeigervariablen (wie sie als zweites Argument in
\verb+dsp_add+ angegeben wurde) plus eins.

\begin{verbatim}
t_int *pan_tilde_perform(t_int *w)
{
  t_pan_tilde *x = (t_pan_tilde *)(w[1]);
  t_sample  *in1 =    (t_sample *)(w[2]);
  t_sample  *in2 =    (t_sample *)(w[3]);
  t_sample  *out =    (t_sample *)(w[4]);
  int          n =           (int)(w[5]);

  t_sample f_pan = (x->f_pan<0)?0.0:(x->f_pan>1)?1.0:x->f_pan;

  while (n--) *out++ = (*in1++)*(1-f_pan)+(*in2++)*f_pan;

  return (w+6);
}
\end{verbatim}

In der \verb+while+-Schleife wird jedes Sample der Signalvektoren einzeln
abgearbeitet.

Eine Optimierungsroutine bei der Erstellung des DSP-Baumes wird darauf geachtet,
keine unn�tigen Kopieroperationen durchzuf�hren.
Es kann daher geschehen, dass ein Eingangs- und ein Ausgangssignal an der
gleichen Stelle im Speicher stehen.
Es ist daher in solchem Falle darauf zu achten,
dass nicht in das Ausgangssignal geschrieben wird,
bevor dort das Eingangssignal ausgelesen wurde.

\subsection{der Code: \tt pan\~\/}

\begin{verbatim}
#include "m_pd.h"

static t_class *pan_tilde_class;

typedef struct _pan_tilde {
  t_object  x_obj;
  t_sample f_pan;
  t_sample f;
} t_pan_tilde;

t_int *pan_tilde_perform(t_int *w)
{
  t_pan_tilde *x = (t_pan_tilde *)(w[1]);
  t_sample  *in1 =    (t_sample *)(w[2]);
  t_sample  *in2 =    (t_sample *)(w[3]);
  t_sample  *out =    (t_sample *)(w[4]);
  int          n =           (int)(w[5]);
  t_sample f_pan = (x->f_pan<0)?0.0:(x->f_pan>1)?1.0:x->f_pan;

  while (n--) *out++ = (*in1++)*(1-f_pan)+(*in2++)*f_pan;

  return (w+6);
}

void pan_tilde_dsp(t_pan_tilde *x, t_signal **sp)
{
  dsp_add(pan_tilde_perform, 5, x,
          sp[0]->s_vec, sp[1]->s_vec, sp[2]->s_vec, sp[0]->s_n);
}

void *pan_tilde_new(t_floatarg f)
{
  t_pan_tilde *x = (t_pan_tilde *)pd_new(pan_tilde_class);

  x->f_pan = f;
  
  inlet_new(&x->x_obj, &x->x_obj.ob_pd, &s_signal, &s_signal);
  floatinlet_new (&x->x_obj, &x->f_pan);
  outlet_new(&x->x_obj, &s_signal);

  return (void *)x;
}

void pan_tilde_setup(void) {
  pan_tilde_class = class_new(gensym("pan~"),
        (t_newmethod)pan_tilde_new,
        0, sizeof(t_pan_tilde),
        CLASS_DEFAULT, 
        A_DEFFLOAT, 0);

  class_addmethod(pan_tilde_class,
        (t_method)pan_tilde_dsp, gensym("dsp"), 0);
  CLASS_MAINSIGNALIN(pan_tilde_class, t_pan_tilde, f);
}
\end{verbatim}




\vfill
\newpage
\begin{appendix}

\section{das Message-System von \em pd}
Nicht-Audio-Daten werden �ber ein Message-System verteilt.
Jede Message besteht aus einem ``Selector'' und einer Liste von Atomen.

\subsection{Atome}

Es gibt drei Arten von Atomen:
\begin{itemize}
\item {\em A\_FLOAT}: ein numerischer Wert (Gleitkommazahl)
\item {\em A\_SYMBOL}: ein symbolischer Wert (String)
\item {\em A\_POINTER}: ein Zeiger
\end{itemize}

Numerische Werte werden immer als Floating-Point-Werte (\verb+double+) dargestellt,
auch wenn es sich um Ganzzahlwerte handelt.

Jedes Symbol wird aus Performancegr�nden in einer lookup-Tabelle abgelegt.
Der Befehl \verb+gensym+ speichert, wenn n�tig,
einen String in dieser Symboltabelle und gibt seine Addresse in der Tabelle zur�ck.

Atome vom Typ {\em A\_POINTER} haben in der Praxis
(f�r einfache Externals) eher untergeordnete Bedeutung.

Der Typ eines Atoms \verb+a+ wird im Strukturelement \verb+a.a_type+ gespeichert.

\subsection{Selectoren}

Der Selector ist ein Symbol und bestimmt, welchen Typ eine Message hat.
Es gibt f�nf vordefinierte Selectoren:
\begin{itemize}
\item ``{\tt bang}'' bezeichnet ein Triggerevent.
Die Message besteht nur aus dem Selector und enth�lt keine Liste von Atomen.
\item ``{\tt float}'' bezeichnet einen numerischen Wert. Die Liste enth�lt nur ein Atom.
\item ``{\tt symbol}'' bezeichnet einen symbolischen Wert. Die Liste enth�lt nur ein Atom.
\item ``{\tt pointer}'' bezeichnet einen Zeiger. Die Liste enth�lt nur ein Atom.
\item ``{\tt list}'' bezeichnet eine Liste von mehreren Atomen.
\end{itemize}

Da die Symbole f�r diese Selectoren relativ h�ufig verwendet werden,
kann man deren Symboltabellen-Adresse auch direkt,
ohne den Umweg �ber \verb+gensym+ abfragen:

\begin{tabular}{l||l|l}
Selector&lookup-Routine&lookup-Addresse\\
\hline
\tt bang &\verb+gensym("bang")+ & \verb+&s_bang+ \\
\tt float &\verb+gensym("float")+ & \verb+&s_float+ \\
\tt symbol &\verb+gensym("symbol")+ & \verb+&s_symbol+ \\
\tt pointer &\verb+gensym("pointer")+ & \verb+&s_pointer+ \\
\tt list &\verb+gensym("list")+ & \verb+&s_list+ \\
--- (Signal) &\verb+gensym("signal")+&\verb+&s_symbol+
\end{tabular}

Es k�nnen auch andere Selectoren verwendet werden,
doch muss dann die Empf�ngerklasse entweder selbst eine Methode
f�r diesen Selector zur verf�gung stellen,
oder eine Methode f�r ``anything'', also jeden beliebigen Selector, anbieten.

Messages die ohne Selector sofort mit einem Zahlenwert beginnen, werden automatisch
entweder als numerischer Wert (nur ein Atom) oder als Liste (mehrere Atome) erkannt.

Zum Beispiel sind also die Messages ``\verb+12.429+'' und ``\verb+float 12.429+'' ident.
Ebenfalls ident sind auch die Listen-Messages
``\verb+list 1 kleines Haus+'' und ``\verb+1 kleines Haus+''.

\section{Pd-Typen}
Da Pd auf mehreren Plattformen benutzt wird,
werden viele gew�hnliche Variablentypen, wie \verb|int|, neu definiert.
Um portablen Code zu schreiben ist es daher angebracht, die von Pd bereitgestellten
Typen zu verwenden.

Weiters gibt es viele vordefinierte Typen,
die das Leben des Programmierers vereinfachen sollten.
Pd-Typen beginnen im Allgemeinen mit \verb|t_|.

\begin{tabular}{c|l}
Pd-Type & Beschreibung \\
\hline\hline
\verb+t_atom+& Atom \\
\verb+t_float+ & Gleitkomma-Zahl \\
\verb+t_symbol+ & Symbol \\
\verb+t_gpointer+ & Zeiger (auf graphische Objekte) \\
\hline
\verb+t_int+ & Ganzzahl \\
\verb+t_signal+ & Struktur auf ein Signal \\
\verb+t_sample+ & Audio-Signalwert (Gleitkomma)\\
\verb+t_outlet+ & Outlet eines Objekts \\
\verb+t_inlet+ & Inlet eines Objekts \\
\verb+t_object+ & Objekt-Interna \\
\hline
\verb+t_class+ & eine Pd-Klasse \\
\verb+t_method+ & Zeiger auf Klassenmethode \\
\verb+t_newmethod+ & Zeiger auf Klasseninstanziierungsmethode (new-Routine) \\
\end{tabular}


\section{Wichtige Funktionen aus ``m\_pd.h''}
\subsection{Funktionen: Atome}

\subsubsection{SETFLOAT}
\begin{verbatim}
SETFLOAT(atom, f)
\end{verbatim}
Dieses Makro setzt den Typ von \verb+atom+ auf \verb+A_FLOAT+
und setzt den numerischen Wert dieses Atoms auf \verb+f+.

\subsubsection{SETSYMBOL}
\begin{verbatim}
SETSYMBOL(atom, s)
\end{verbatim}
Dieses Makro setzt den Typ von \verb+atom+ auf \verb+A_SYMBOL+
und setzt den symbolischen Wert dieses Atoms auf \verb+s+.

\subsubsection{SETPOINTER}
\begin{verbatim}
SETPOINTER(atom, pt)
\end{verbatim}
Dieses Makro setzt den Typ von \verb+atom+ auf \verb+A_POINTER+
und setzt den Zeiger-Wert dieses Atoms auf \verb+pt+.

\subsubsection{atom\_getfloat}
\begin{verbatim}
t_float atom_getfloat(t_atom *a);
\end{verbatim}
Wenn der Typ des Atoms \verb+a+ \verb+A_FLOAT+ ist, wird dessen numerischer Wert,
ansonsten ``0.0'' zur�ckgegeben.

\subsubsection{atom\_getfloatarg}
\begin{verbatim}
t_float atom_getfloatarg(int which, int argc, t_atom *argv)
\end{verbatim}
Wenn das Atom,
das in der Atomliste \verb+argv+ mit der L�nge \verb+argc+ an der Stelle \verb+which+
zu finden ist,
vom Typ \verb+A_FLOAT+ ist, wird dessen numerischer Wert,
ansonsten ``0.0'' zur�ckgegeben.

\subsubsection{atom\_getint}
\begin{verbatim}
t_int atom_getint(t_atom *a);
\end{verbatim}
Wenn der Typ des Atoms \verb+a+ \verb+A_FLOAT+ ist, wird dessen numerischer
Wert als Ganzzahlwert, ansonsten ``0'' zur�ckgegeben.

\subsubsection{atom\_getsymbol}
\begin{verbatim}
t_symbol atom_getsymbol(t_atom *a);
\end{verbatim}
Wenn der Typ des Atoms \verb+a+ \verb+A_SYMBOL+ ist, wird ein Zeiger
auf dessen Symbol ansonsten auf das Symbol ``float'' zur�ckgegeben.

\subsubsection{atom\_gensym}
\begin{verbatim}
t_symbol *atom_gensym(t_atom *a);
\end{verbatim}
Wenn der Typ des Atoms \verb+a+ \verb+A_SYMBOL+ ist, wird ein Zeiger
auf dessen Symbol zur�ckgegeben.

Atome anderen Typs werden zuerst ``sinnvoll'' in Strings umgewandelt.
Diese Strings werden, falls n�tig, in die Symbol-Tabelle eingetragen.
Die Zeiger auf das Symbol wird zur�ckgegeben.


\subsubsection{atom\_string}
\begin{verbatim}
void atom_string(t_atom *a, char *buf, unsigned int bufsize);
\end{verbatim}
Konvertiert ein Atom \verb+a+ in einen {\tt C}-String \verb+buf+.
Der char-Buffer muss selbst reserviert und seine L�nge in \verb+bufsize+ angegeben werden.

\subsubsection{gensym}
\begin{verbatim}
t_symbol *gensym(char *s);
\end{verbatim}
Pr�ft, ob f�r den C-String \verb+*s+ bereits ein Eintrag in der Symbol-lookup-Tabelle
vorhanden ist.
Ist noch kein Eintrag vorhanden, so wird einer angelegt.
Ein Zeiger auf das Symbol in der Tabelle wird zur�ckgegeben.


\subsection{Funktionen: Klassen}
\subsubsection{class\_new}
\begin{verbatim}
t_class *class_new(t_symbol *name,
        t_newmethod newmethod, t_method freemethod,
        size_t size, int flags,
        t_atomtype arg1, ...);
\end{verbatim}
Generiert eine neue Klasse mit dem symbolischen Namen \verb+name+.

\verb+newmethod+ ist eine Konstruktorfunktion,
die eine Instanz der Klasse konstruiert und einen Zeiger auf diese Instanz zur�ckgibt.

Wird manuell dynamischer Speicher reserviert,
so muss dieser bei Zerst�rung eines Objektes
mit der Destruktormethode \verb+freemethod+ (kein R�ckgabeargument)
wieder freigegeben werden.

\verb+size+ ist statische die Gr��e des Klassendatenraumes,
die mit der Funktion \verb+sizeof(t_mydata)+ berechnet werden kann.

\verb+flags+ bestimmen das Aussehen des graphischen Objektes.
Eine beliebige Kombination folgender Flags ist m�glich:

\begin{tabular}{l|l}
Flag&Bedeutung\\
\hline
\verb+CLASS_DEFAULT+ &Ein normales Objekt mit einem Inlet \\
\verb+CLASS_PD+ & \em Objekte ohne Graphikdarstellung\\
\verb+CLASS_GOBJ+ & \em reine Graphikobjekte (wie Arrays, Graphen,...)\\
\verb+CLASS_PATCHABLE+ & \em normales Objekt (mit einem Inlet) \\
\verb+CLASS_NOINLET+ & Der standardm��ige Inlet wird unterdr�ckt \\
\end{tabular}

Flags, deren Bedeutung {\em kursiv} gedruckt ist,
haben geringe Bedeutung beim Schreiben von Externals.

Die restlichen Argumente \verb+arg1,...+ definieren
die Typen die �bergabeargumente bei der Objektkreation.
H�chstens sechs typgepr�fte Argumente k�nnen einem Objekt �bergeben werden.
Die Argumententypeliste wird ``0'' terminiert.

M�gliche Argumententypen sind:

\begin{tabular}{l|l}
\verb+A_DEFFLOAT+ & ein numerischer Wert \\
\verb+A_DEFSYMBOL+ & ein symbolischer Wert \\
\verb+A_GIMME+ & eine Atomliste beliebiger L�nge und Typen \\
\end{tabular}

Sollten mehr als sechs Argumente �bergeben werden, muss man
\verb+A_GIMME+ verwenden und eine h�ndische Typpr�fung durchf�hren.

\subsubsection{class\_addmethod}
\begin{verbatim}
void class_addmethod(t_class *c, t_method fn, t_symbol *sel,
    t_atomtype arg1, ...);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ f�r
eine Message mit dem Selector \verb+sel+ hinzu.

Die restlichen Argumente \verb+arg1,...+ definieren
die Typen der Atomliste die dem Selector folgt.
H�chstens sechs typgepr�fte Argumente angegeben werden.
Sollten mehr als sechs Argumente �bergeben werden, muss man
\verb+A_GIMME+ verwenden und eine h�ndische Typpr�fung durchf�hren.

Die Argumententypeliste wird ``0'' terminiert.

M�gliche Argumententypen sind:

\begin{tabular}{l|l}
\verb+A_DEFFLOAT+ & ein numerischer Wert \\
\verb+A_DEFSYMBOL+ & ein symbolischer Wert \\
\verb+A_POINTER+ & eine Zeiger \\
\verb+A_GIMME+ & eine Atomliste beliebiger L�nge und Typen \\
\end{tabular}

\subsubsection{class\_addbang}
\begin{verbatim}
void class_addbang(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine ``bang''-Message hinzu.
Die ``bang''-Methode hat als �bergabeargument einen Zeiger auf den Klassendatenraum:

\verb+void my_bang_method(t_mydata *x);+

\subsubsection{class\_addfloat}
\begin{verbatim}
void class_addfloat(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine ``float''-Message hinzu.
Die ``float''-Methode hat als �bergabeargument einen Zeiger auf den Klassendatenraum und
ein Gleitkommaargument:

\verb+void my_float_method(t_mydata *x, t_floatarg f);+

\subsubsection{class\_addsymbol}
\begin{verbatim}
void class_addsymbol(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine ``symbol''-Message hinzu.
Die ``symbol''-Methode hat als �bergabeargument einen Zeiger auf den Klassendatenraum und
einen Zeiger auf das �bergebene Symbol:

\verb+void my_symbol_method(t_mydata *x, t_symbol *s);+

\subsubsection{class\_addpointer}
\begin{verbatim}
void class_addpointer(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine ``pointer''-Message hinzu.
Die ``pointer''-Methode hat als �bergabeargument einen Zeiger
auf den Klassendatenraum und einen Zeiger auf einen Pointer:

\verb+void my_pointer_method(t_mydata *x, t_gpointer *pt);+

\subsubsection{class\_addlist}
\begin{verbatim}
void class_addlist(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine ``list''-Message hinzu.
Die ``list''-Methode hat als �bergabeargument neben einem Zeiger
auf den Klassendatenraum einen Zeiger auf das Selectorsymbol
(immer \verb+&s_list+), 
die Anzahl der Atome in der Liste sowie einen Zeiger auf die Atomliste:

\verb+void my_list_method(t_mydata *x,+

\verb+   t_symbol *s, int argc, t_atom *argv);+


%\begin{verbatim}
%void my_list_method(t_mydata *x,
%   t_symbol *s, int argc, t_atom *argv);
%\end{verbatim}



\subsubsection{class\_addanything}
\begin{verbatim}
void class_addanything(t_class *c, t_method fn);
\end{verbatim}
F�gt der Klasse, auf die \verb+c+ zeigt, die Methode \verb+fn+ 
f�r eine beliebige Message hinzu.
Die anything-Methode hat als �bergabeargument neben einem Zeiger
auf den Klassendatenraum einen Zeiger auf das Selectorsymbol, 
die Anzahl der Atome in der Liste sowie einen Zeiger auf die Atomliste:


\verb+void my_any_method(t_mydata *x,+

\verb+   t_symbol *s, int argc, t_atom *argv);+


%\begin{verbatim}
%void my_any_method(t_mydata *x,
%   t_symbol *s, int argc, t_atom *argv);
%\end{verbatim}

\subsubsection{class\_addcreator}
\begin{verbatim}
 void class_addcreator(t_newmethod newmethod, t_symbol *s, 
    t_atomtype type1, ...);
\end{verbatim}
F�gt zu einem Konstruktor \verb+newmethod+ ein zum Klassennamen alternatives
Kreatorsymbol \verb+s+ hinzu.
Dadurch k�nnen Objekte mit dem richtigen Klassennamen und einem Aliasnamen
(zum Beispiel eine Abk�rzung, wie das Internal ``float'' bzw. ``f'') kreiert werden.

Die ``0''-terminierte Typenliste entspricht der von \verb+class_new+.

\subsubsection{class\_sethelpsymbol}
\begin{verbatim}
void class_sethelpsymbol(t_class *c, t_symbol *s);
\end{verbatim}

Clickt man mit der rechten Maustaste auf ein Pd-Objekt,
so kann man sich einen Hilfe-Patch f�r die zugeh�rige Objektklasse anzeigen lasse.
Standardm��ig wird ist dies ein Patch mit dem symbolischen Klassennamen
im Verzeichnis ``{\em doc/5.reference/}'' gesucht.

F�r die Klasse, auf die \verb+c+ zeigt, wird der Name des Hilfepatches auf den
symbolischen Wert \verb+s+ ge�ndert.

Dadurch k�nnen sich mehrere verwandte Klassen einen Hilfepatch teilen.

Pfadangaben erfolgen relativ zum Standardhilfepfad {\em doc/5.reference/}.

\subsubsection{pd\_new}
\begin{verbatim}
t_pd *pd_new(t_class *cls);
\end{verbatim}
Generiert eine neue Instanz der Klasse \verb+cls+ und gibt einen Zeiger auf diese
Instanz zur�ck.

\subsection{Funktionen: In- und Outlets}
Alle Inlet- und Outletroutinen ben�tigen eine Referenz auf die Objektinterna
der Klasseninstanz.
Die notwendige Variable vom Typ \verb+t_object+ im Datenraum wird bei der
Objektinstanziierung initialisiert.
Diese Variable mu� als \verb+owner+-Objekt den Inlet- und Outletroutinen �bergeben werden.

\subsubsection{inlet\_new}
\begin{verbatim}
t_inlet *inlet_new(t_object *owner, t_pd *dest,
      t_symbol *s1, t_symbol *s2);
\end{verbatim}
Generiert einen zus�tzlichen ``aktiven'' Inlet des Objektes, auf das \verb+owner+ zeigt.
\verb+dest+ zeigt im Allgemeinen auf ``\verb+owner.ob_pd+''.

Der Selector \verb+s1+ am neuen Inlet, wird durch den Selector \verb+s2+ substituiert.

Tritt also eine Message mit dem Selector \verb+s1+ am neuen Inlet auf,
wird die Klassenmethode f�r den Selector \verb+s2+ ausgef�hrt.

Dies bedeutet
\begin{itemize}
\item Der substituierende Selector muss mit \verb+class_addmethod+ angegeben werden.
\item Man kann einen bestimmten rechten Eingang simulieren,
indem man dem ersten Eingang eine Message mit dem Selector dieses Eingangs schickt.

Verwendet man ein leeres Symbol (\verb+gensym("")+) als Selector,
so erreicht man, dass der rechte Eingang nicht �ber den ersten angesprochen werden kann.
\item Es ist nicht m�glich, einem rechten Eingang Methoden f�r mehr als einen Selector
zuzuweisen. Insbesondere ist es nicht m�glich, ihm eine allgemeine Methode
f�r einen beliebigen Selector zuzuweisen.
\end{itemize}

\subsubsection{floatinlet\_new}
\begin{verbatim}
t_inlet *floatinlet_new(t_object *owner, t_float *fp);
\end{verbatim}
Schafft einen neuen ``passiven'' Eingang f�r das Objekt, auf das \verb+owner+ zeigt,
der es erlaubt, einen numerischen Wert von au�en direkt auf einen 
Speicherplatz \verb+fp+ zu schreiben, ohne eine eigene Methode aufzurufen.

\subsubsection{symbolinlet\_new}
\begin{verbatim}
t_inlet *symbolinlet_new(t_object *owner, t_symbol **sp);
\end{verbatim}
Schafft einen neuen ``passiven'' Eingang f�r das Objekt, auf das \verb+owner+ zeigt,
der es erlaubt, einen symbolischen Wert von au�en direkt auf einen 
Speicherplatz \verb+sp+ zu schreiben, ohne eine eigene Methode aufzurufen.

\subsubsection{pointerinlet\_new}
\begin{verbatim}
t_inlet *pointerinlet_new(t_object *owner, t_gpointer *gp);
\end{verbatim}
Schafft einen neuen ``passiven'' Eingang f�r das Objekt, auf das \verb+owner+ zeigt,
der es erlaubt, einen Zeigerwert von au�en direkt auf einen 
Speicherplatz \verb+gp+ zu schreiben, ohne eine eigene Methode aufzurufen.

\subsubsection{outlet\_new}
\begin{verbatim}
t_outlet *outlet_new(t_object *owner, t_symbol *s);
\end{verbatim}
Generiert einen neuen Ausgang f�r das Objekt, auf das \verb+owner+ zeigt.
Das Symbol, auf das \verb+s+ zeigt, zeigt den Typ des Ausgangs an.

\begin{tabular}{c|l||l}
Symbolwert & Symboladresse & Outlet-Typus \\
\hline\hline
``bang'' & \verb+&s_bang+ & Message (Bang)\\
``float'' & \verb+&s_float+ & Message (Float)\\
``symbol'' & \verb+&s_symbol+ & Message (Symbol) \\
``pointer'' & \verb+&s_gpointer+ & Message (List)\\
``list'' & \verb+&s_list+ & Message \\
--- & 0 & Message \\
\hline
``signal'' & \verb+&s_signal+ & Signal \\
\end{tabular}

Zwischen den verschiedenen Message-Outlet-Typen gibt es keinen Unterschied.
Allerdings macht es den Code leichter lesbar,
wenn schon bei der Outlet-Generierung angezeigt wird, wozu der Ausgang verwendet wird.
F�r allgemeine Message-Outlets verwendet man einen ``0''-Pointer.

Variablen vom Typ \verb+t_object+ stellen einen Zeiger auf einen Outlet zur Verf�gung.
Bei der Generierung eines neuen Outlets,
wird seine Addresse in der Objektvariablen \verb+(*owner).ob_outlet+ gespeichert.

Werden mehrere Message-Ausg�nge ben�tigt, m�ssen die Outletzeiger,
die von \verb+outlet_new+ zur�ckgegeben werden, manuell im Datenraum gespeichert werden,
um die jeweiligen Ausg�nge ansprechen zu k�nnen.

\subsubsection{outlet\_bang}
\begin{verbatim}
void outlet_bang(t_outlet *x);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine ``bang''-Message aus.

\subsubsection{outlet\_float}
\begin{verbatim}
void outlet_float(t_outlet *x, t_float f);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine ``float''-Message mit dem 
numerischen Wert \verb+f+ aus.

\subsubsection{outlet\_symbol}
\begin{verbatim}
void outlet_symbol(t_outlet *x, t_symbol *s);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine ``symbol''-Message mit dem 
symbolischen Wert von \verb+s+ aus.

\subsubsection{outlet\_pointer}
\begin{verbatim}
void outlet_pointer(t_outlet *x, t_gpointer *gp);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine ``pointer''-Message mit dem 
Zeiger \verb+gp+ aus.

\subsubsection{outlet\_list}
\begin{verbatim}
void outlet_list(t_outlet *x,
                 t_symbol *s, int argc, t_atom *argv);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine ``list''-Message mit
\verb+argc+ Atomen aus.
\verb+argv+ zeigt auf das erste Atom der Liste.

Unabh�ngig davon, auf welches Symbol \verb+s+ zeigt, wird der Selector
``list'' der Liste vorangestellt.

Aus Lesbarkeitsgr�nden sollte man aber trotzdem einen Zeiger auf das
Symbol ``list'' (\verb+gensym("list")+ oder \verb+&s_list+) angeben.

\subsubsection{outlet\_anything}
\begin{verbatim}
void outlet_anything(t_outlet *x,
                     t_symbol *s, int argc, t_atom *argv);
\end{verbatim}
Gibt am Outlet, auf den \verb+x+ zeigt, eine Message mit
dem Selector, auf den \verb+s+ zeigt, aus.
Dem Selector folgen \verb+argc+ Atome.
\verb+argv+ zeigt auf das erste Atom dieser Liste.


\subsection{Funktionen: DSP}
Soll eine Klasse Methoden zur digitalen Signalsverarbeitung zur Verf�gung stellen,
so muss ihr eine Methode f�r den Selector ``dsp'' hinzugef�gt werden.

Wird die Audio-Engine gestartet, so werden alle Objekte, die eine ``dsp''-Methode
zur Verf�gung stellen, als Instanzen von Signalklassen identifiziert.

\paragraph{DSP-Methode}

\begin{verbatim}
void my_dsp_method(t_mydata *x, t_signal **sp)
\end{verbatim}

In der ``dsp''-Methode wird mit der Funktion \verb+dsp_add+ die
Klassenroutine f�r Signalverarbeitung in den DSP-Baum eingebunden.

Neben dem eigenen Datenraum \verb+x+, wird auch ein Array von Signalen �bergeben.
Die Signale im Array sind so angeordnet, dass sie am graphischen Objekt
im Uhrzeigersinn gelesen werden.

Sofern je zwei Ein- und Ausgangssignale vorhanden sind, gilt also:

\begin{tabular}{c|r}
Zeiger & auf Signal \\
\hline\hline
sp[0] & linkes Eingangssignal \\
sp[1] & rechtes Eingangssignal \\
sp[2] & rechtes Ausgangssignal \\
sp[3] & linkes Ausgangssignal \\
\end{tabular}

Die Signalstruktur enth�lt unter anderem:

\begin{tabular}{c|l}
Strukturelement & Bedeutung \\
\hline
\verb+s_n+ & L�nge des Signalvektors \\
\verb+s_vec+ & Zeiger auf den Signalvektor \\
\end{tabular}

Der Signalvektor ist ein Array auf Samples vom Typ \verb+t_sample+.

\paragraph{Perform-Routine}
\begin{verbatim}
t_int *my_perform_routine(t_int *w)
\end{verbatim}

Der Perform-Routine die mit \verb+class_add+ in den DSP-Baum eingef�gt wurde,
wird ein Zeiger \verb+w+ auf ein (Integer-)Array �bergeben.
In diesem Array sind die Zeiger gespeichert, die mit \verb+dsp_add+ �bergeben wurden.
Sie m�ssen auf ihren urspr�nglichen Typ zur�ckgecastet werden.
Der erste Zeiger ist an der Stelle \verb+w[1]+ gespeichert !!!

Die perform-Routine mu� einen Zeiger auf Integer zur�ckgeben, der hinter den
Speicherplatz zeigt, in dem die eigenen Zeiger gespeichert sind.
Dies bedeutet, dass das R�ckgabeargument gleich dem �bergabeargument plus der
Anzahl der eigenen Zeigervariablen (wie sie als zweites Argument in
\verb+dsp_add+ angegeben wurde) plus eins.




\subsubsection{CLASS\_MAINSIGNALIN}
\begin{verbatim}
CLASS_MAINSIGNALIN(<class_name>, <class_data>, <f>);
\end{verbatim}
Das Makro \verb+CLASS_MAINSIGNALIN+ meldet an, dass die Klasse
Signal-Inlets brauchts.

Das erste Argument des Makros ist ein Zeiger auf die Signalklasse.
Das zweite Argument ist der Typ des Datenraums der Klasse.
Das dritte Argument ist eine (Dummy-)Gleitkomma-Variable aus dem Datenraum,
die gebraucht wird, um bei nicht vorhandenen Signalen am Signalinlet,
``float''-Messages wie Signale behandeln zu k�nnen.

An so kreierten Signaleing�ngen k�nnen daher keine zus�tzlichen ``float''-Messages
geschickt werden.

\subsubsection{dsp\_add}
\begin{verbatim}
void dsp_add(t_perfroutine f, int n, ...);
\end{verbatim}
F�gt dem DSP-Baum eine Perform-Routine \verb+f+ hinzu,
die jeden DSP-Zyklus neu aufgerufen wird.

Das zweite Argument \verb+n+ legt die Anzahl der nachfolgenden Zeigerargumente fest.

Welche Zeiger auf welche Variablen �bergeben werden, unterliegt keiner Beschr�nkung.
Sinnvoll sind im Allgemeinen Zeiger auf den Datenraum und auf die Signalvektoren.
Auch die L�nge der Signalvektoren sollte �bergeben werden,
um effektiv Signale manipulieren zu k�nnen.

\subsubsection{sys\_getsr}
\begin{verbatim}
float sys_getsr(void);
\end{verbatim}
Gibt die Abtastrate des Systems zur�ck.

\subsection{Funktion: Memory}
\subsubsection{getbytes}
\begin{verbatim}
void *getbytes(size_t nbytes);
\end{verbatim}
Reserviert \verb+nbytes+ Bytes und gibt einen Zeiger auf den reservierten Speicher zur�ck.

\subsubsection{copybytes}
\begin{verbatim}
void *copybytes(void *src, size_t nbytes);
\end{verbatim}
Kopiert  \verb+nbytes+ Bytes von \verb+*src+ in einen neu alloziierten Speicher.
Die Addresse dieses Speichers wird zur�ckgegeben.

\subsubsection{freebytes}
\begin{verbatim}
void freebytes(void *x, size_t nbytes);
\end{verbatim}
Gibt \verb+nbytes+ Bytes an der Addresse \verb+*x+ frei.

\subsection{Funktionen: Ausgabe}
\subsubsection{post}
\begin{verbatim}
void post(char *fmt, ...);
\end{verbatim}

Schreibt einen {\tt C}-String auf den Standarderror (Shell).

\subsubsection{error}
\begin{verbatim}
void error(char *fmt, ...);
\end{verbatim}

Schreibt einen {\tt C}-String als Fehlermeldung auf den Standarderror (Shell).
Das Objekt, das die Fehlermeldung ausgegeben hat, wird markiert und
ist �ber das Pd-Men� {\em Find->Find last error} identifizierbar.

\end{appendix}

\end{document}