README.md


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


    Contents⊕
  
  
  JSyn
  
  Using JSyn in Your
  Project
  Building JSyn
  
  Build Using Ant
  Build Using Gradle
  Test Using Gradle
  
  
JSyn
JSyn is a modular audio synthesizer for Java by Phil Burk.
You can use JSyn to create unit generators, such as oscillators,
filters, and envelopes. Units can be connected together and controlled
in real-time from a Java program.
More information about JSyn, including documentation, is at:
http://www.softsynth.com/jsyn/
Pre-compiled JSyn JAR files are at:
http://www.softsynth.com/jsyn/developers/download.php
The JSyn source code is available at:
https://github.com/philburk/jsyn
Using JSyn in Your Project
If your project is not using gradle then build or download the JSyn
jar file and add it to your classpath. See Build section below.
If you are using gradle then you can simply add a dependency on JSyn
to your project. The easiest way is to use jitpack to add the latest
release from GitHub.
For Groovy gradle files use:
repositories {
    maven { url  "https://jitpack.io" }
}

dependencies {
    implementation "com.github.philburk:jsyn:latest.release"
}
The syntax is slightly different if you are using ".kts" files.
repositories {
    maven { url = uri("https://jitpack.io") }
}

dependencies {
    implementation("com.github.philburk:jsyn:latest.release")
}
Building JSyn
You can build JSyn using either Ant or Gradle.
Note that if you clone the repository then you will end up with a
folder called "jsyn". But if you download the ZIP file it will be called
"jsyn-master".
Build Using Ant
You may need to install Ant first. On Mac you can do:
brew install ant
Then enter:
cd jsyn   # or jsyn-master
ant
The resulting jar will be placed in "dist/lib/".
To run the built-in test App on a desktop, enter something like
this:
java -jar dist/lib/jsyn-20230410.jar
but with the correct date.
To create javadocs enter:
ant docs
Build Using Gradle
Enter:
cd jsyn   # or jsyn-master
./gradlew assemble
The resulting jar will be placed in "build/libs/". To run the
built-in test App on a desktop, enter something like this:
java -jar build/libs/jsyn-17.1.0.jar
but with the correct version.
Test Using Gradle
To run the unit tests, enter:
cd jsyn
./gradlew test