Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Gwion/Gwion
:musical_note: strongly-timed musical programming language
https://github.com/Gwion/Gwion
audio chuck compiler composition hacktoberfest interpreter lang language music programming-language real-time realtime-audio sound synth synthesis
Last synced: about 1 month ago
JSON representation
:musical_note: strongly-timed musical programming language
- Host: GitHub
- URL: https://github.com/Gwion/Gwion
- Owner: Gwion
- License: gpl-3.0
- Created: 2016-09-26T19:21:17.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-07T10:21:03.000Z (about 1 month ago)
- Last Synced: 2024-11-07T11:24:34.359Z (about 1 month ago)
- Topics: audio, chuck, compiler, composition, hacktoberfest, interpreter, lang, language, music, programming-language, real-time, realtime-audio, sound, synth, synthesis
- Language: C
- Homepage: https://Gwion.github.io/Gwion
- Size: 27.5 MB
- Stars: 541
- Watchers: 21
- Forks: 44
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: License.txt
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-programming-languages - Gwion - A strongly-timed programming language aimed at music creation. Heavily inspired by ChucK. (Uncategorized / Uncategorized)
- awesome-live-coding-music - Gwion - coding | Gwion (Environments)
README
# Gwion
[](https://bestpractices.coreinfrastructure.org/projects/2417)
[](https://gwion.github.io/gwion-coverage-report/master)
[](https://github.com/Gwion/Gwion)
Gwion is a programming language, aimed at making music
< Bran, our mascot, kindly provided by [neverRare](https://github.com/neverRare)
**strongly** inspired by [ChucK](http://chuck.stanford.edu/), but adding a bunch of *high-level* features,
templating, first-class functions and more.
It aims to be simple, small,
[fast](https://Gwion.github.io/Gwion/#Benchmarks/),
[extendable](https://github.com/Gwion/Gwion-plug) and [embeddable](https://github.com/Gwion/Gwion/blob/master/src/main.c#L18-L31).
Checkout the community, and join us on discord: https://discord.gg/KmHqbTKSmS.
You can also check this very nice server about programming language devlopment: https://discord.gg/4Kjt3ZE,
since a lot of improvements to gwion are discussed there.
Please also consider taking the (WIP) [*tour*](https://github.com/Gwion/GwionTour)
## Build
### Download the source
``` sh
git clone --recursive https://github.com/Gwion/Gwion
cd Gwion
make
```
### Configuring (optional)
You can get a list of config files to tweak with
``` sh
find . -name "config.mk"
```
Please rebuild to take your change into account.
```
make -C util clean
make -C ast clean
make clean
make
```
> Besides developer options, you migth want to check *USE_DOUBLE*, in util/config.mk, which set the floating point size (float or double).
> Note that the option you choose must match how you built your soundpipe library (more on soundpipe later).
## Nix - Install
To get started with Gwion, use the provided default.nix file.
Navigate to the main Gwion repository.
Enter the following command:
```bash
nix-env -if default.nix
```
This should install Gwion.
Afterwards, you can run the Gwion Interpreter with the following command:
```bash
gwion
```
The default.nix file includes a fixed commit hash. If you prefer to utilize the latest version, you'll need to update the commit hash accordingly. Here's how:
- Go to the Gwion repository on GitHub.
- Locate the commit hash of the latest version you want to use.
- Update the commit hash in the default.nix file to match the desired version.
- Save the changes.
- Re-run the installation command mentioned earlier to install the updated version of Gwion.
## Executing your first code (hello_world.gw):
This assumes you have successfully compiled gwion. To build follow [these steps](#build) . To check, if the build was successfully run
```
./gwion
```
if this gives out some error, there were problems with your compilation.
Try building again, and open a [issue](https://github.com/Gwion/Gwion/issues)
if the problem persists. We would love to help you out.
If you see no errors, Congratulations!! You have successfully compiled gwion, and can move ahead.
Create a new file "hello_world.gw" in the same directory.(You are free to use any command)
```
touch hello_world.gw
```
Open this file using your favourite text editor
```
vim hello_world.gw
```
Add the following lines to print "Hello World" (Note the semicolon at the end)
```
<<< "Hello World" >>>;
```
Save and exit the file(:wq in vim). Use the following command to run your first gwion program
```sh
./gwion hello_world.gw
```
Congratulations!! You ran your first gwion program.
## Making Sound
_This section is currently very Linux-centric. We are working to improve that. Pull requests welcome!_
Gwion relies on plugins for most of its language features, including all those that make sound. Plugins are located in the subdirectories of
`plug`. To get some sounds going under linux using jack sound server, you can build the plugins `Jack`, `Soundpipe`, and `Modules`. Make sure you have Jack installed.
Start by downloading the sources
```
git submodule update plug
cd plug
```
Starting from the Gwion base directory, to build `Jack`:
```
cd plug/Jack
make
```
This will give you a shared object file, `Jack.so`. The default place Gwion will look for plugins is in a subdir of your home directory
named `.gwplug`. So create that directory and move `Jack.so` there:
```
mkdir ~/.gwplug
mv Jack.so ~/.gwplug
```
Repeat for the other plugins mentioned. The `Soundpipe` plugin requires the [gwion-soundpipe](https://github.com/Gwion/gwion-soundpipe) library, which we hope to have build seamlessly for you when you build the `Soundpipe` module, but we're not quite there yet. For now, please clone gwion-soundpipe in the Soundpipe plugin directory `plug/Soundpipe`. Please ask for help if this isn't working.
When all those plugin `.so` files are in your `~/.gwplug` directory, you should be able to run a Gwion program that makes sound! In `plug/Modules` there's a `test.gw` program which plays a sine wave for 5 seconds. If the `gwion` you built is still in the base dir of your cloned repo, from the
`plug/Modules` subdirectory you should be able to run `../../gwion -d Jack test.gw` and hear some sound!
## Installation
It's a good idea to install Gwion now that you have tried it out. Use the following command to install it:
```
sudo make install
```
To confirm Gwion can make sound, update `hello_world.gw` to:
```
#import Modules
<<<"Sound from Gwion!">>>;
new SinOsc ~> dac;
5::second => now;
```
To run it with Jack as the driver: `gwion hello_world.gw -dJack`. Hopefully you will hear a smooth sine wave. If not, please reach out on Discord and we'll help you out.
## Documentation
Run gwion with the --cdoc flag and it will show you everything that Gwion has to offer. Like so:
`gwion --cdoc --color=always | less -R`
Online documentation is a work in progress :construction_worker: You can [view it here](https://Gwion.github.io/Gwion/). Please consider contributing 🙂
there is another site with [samples](https://gwion.github.io/GwionSamples/)
If you need help with anything just [talk to us on Discord](https://discord.gg/KmHqbTKSmS). In general the audio programming community is very friendly and the people involved with Gwion are no exception.
## Contributing / Reporting bugs
:+1: Every helping hand is welcome!!! :+1:
If there's anything you see that can make Gwion better, please let us know!
:book: Please see the [contributing](.github/CONTRIBUTING.md) page for more information.
## Acknowledgements.
The whole [Chuck](http://chuck.cs.princeton.edu/) team, for inspiration.
[Paul Batchelor](https://github.com/PaulBatchelor) and the awesome [soundpipe](https://github.com/PaulBatchelor/Soundpipe) library, that got me started.
not to forget these wonderful people ([emoji key](https://gwion.github.io/Gwion/Contributing/Contributors.html)):