This is the repository of risset, a package manager for csound external plugins and user-defined-opcodes. The index aggregating all available packages is kept at risset-data.
risset depends only on git and python3 (>= 3.9) being installed.
pip install rissetThis will install the script "risset" into your path
In certain linux distributions (ubuntu) it is not allowed to install packages to the
system python. In that case the recommended way is to install risset within
its own virtual environment via pipx:
sudo apt install pipx
pipx install risset$ risset list
* else /1.18.2 | Miscellaneous plugins [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libelse.so
* pathtools /1.18.2 | Cross-platform path handling and string opcodes [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libpathtools.so
* klib /1.18.2 | A hashtable for csound [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libklib.so
* beosc /1.18.2 | Band-enhanced oscillators implementing the sine+noise synthesis model [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libbeosc.so
* jsfx /1.18.2 | jsfx support for csound [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libjsfx.so
* poly /1.18.2 | Multiple (parallel or sequential) instances of an opcode [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libpoly.so
* sndmeta /1.18.2 | opcodes using libsndfile [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/libsndmeta.so
* risset /1.18.2 | Opcodes to access risset package metadata [manual]
| Path: /home/em/.local/lib/csound/6.0/plugins64/librisset.so
- vst3 /0.3.0 | Host vst3 plugins in csound
- chua /0.1.0 | Implementation of a Chua oscillator
- hdf5 /0.1.0 | Read/Write signals and arrays to/from an hdf5 file
- python /0.1.0 | Opcodes to interact with an embedded python interpreter
$ risset install else jsfx
$ risset show poly
Plugin : poly
Author : Eduardo Moguillansky ([email protected])
URL : https://github.com/csound-plugins/csound-plugins.git
Version : 1.18.2
Installed : Unknown (path: /home/em/.local/lib/csound/6.0/plugins64/libpoly.so)
Manifest : No manifest (installed manually)
Abstract : Multiple (parallel or sequential) instances of an opcode
Description:
Multiple (parallel or sequential) instances of an opcode
Opcodes:
defer, poly, poly0, polyseq
Binaries:
* linux/csound>=6.17<7.0
* linux/csound>=7.0
* macos/csound>=6.17<7.0
* macos/csound>=7.0
* macos-arm64/csound>=6.17<7.0
* macos-arm64/csound>=7.0
* windows/csound>=6.17<7.0
* windows/csound>=7.0
$ risset remove poly
$ risset man poly
# mtro
## Abstract
an accurate version of metro
## Description
`mtro` is a drop-in replacement of `metro` without the
drifting over time. `metro` is implemented by adding a phase
each cycle, which results in drifting over time due to rounding errors.
`mtro` avoids this problem by keeping a counter and doing multiplication
so that the error is limited.
Following metro's implementation by default `mtro` is triggered at time=0. This
is because `i_initphase` is set to 1 by default. It is possible to make `mtro` skip the
0 trigger by setting `i_initphase` to 0.
## Syntax
kout mtro kfreq, i_initphase=1
## Arguments
* **kfreq**: the frequency of the trigger
* **i_initphase**: the initial phase (a value between 0 and 1). If set to 0, there is no trigger at time 0.
If set to 1, `mtro` triggers at time=0, similar to `metro`
## Output
* **kout**: 1 if the mtro has triggered, 0 otherwise
## Execution Time
* Performance
Update the local index to the latest state.
$ risset update
List all available plugins for your platform
$ risset list [options]
--nameonly: Output just the name of each plugin--installed: List only installed plugins--upgradeable: List only installed packages which can be upgraded--notinstalled: List only plugins which are not installed-1, --oneline: List each plugin in one line
Show information about a plugin
$ risset show <plugin>
Install one or multiple plugins
$ risset install [--force] <plugin> [<plugin2>, ...]
Install a given plugin for the current platform. Plugins are installed into
the user folder (no administrator requirements are needed). Look at the info
command to query information about the system.
--force: Installs a plugin even if the plugin with the same version is already installed
the system folder where all other builtin plugins are installed (this requires administrator rights in some platforms). Admin rights are needed for this.
Remove an installed plugin
$ risset remove <plugin>
#### documentation
Open man page as markdown in the command line
$ risset man [options] <opcode>
-s, --simplepath: Print just the path of the manual page-m, --markdown: Use the .md page instead of the .html version-e, --external: Open the man page in the default app. This is only used when opening the markdown man page.--html: Opens the .html version of the manpage in the default browser (or outputs the path with the --path option)--theme {dark,light,gruvbox-dark,gruvbox-light,material,fruity,native}: Style used when displaying markdown files (default=dark)
Open the html man page in the default browser:
$ risset man --html <opcode>
Generate/update documentation:
$ risset makedocs
Build the documentation for all defined plugins. This depends on mkdocs being installed
$ risset upgrade
Upgrade any installed plugin to the latest version
$ risset listopcodes
List installed opcodes
-l, --long: Long format
$ risset listopcodes -l
accum else Simple accumulator of scalar values
atstop else Schedule an instrument at the end of the current instrument
beadsynt beosc Band-Enhanced Oscillator-Bank
beosc beosc Band-Enhanced Oscillator
bisect else Returns the fractional index of a value within a sorted ar…ay / tab
chuap chua Simulates Chua's oscillator
crackle else generates noise based on a chaotic equation
defer poly Run an opcode at the end of current event
deref else Dereference a previously created reference to a variable
detectsilence else Detect when input falls below an amplitude threshold
dict_del klib Remove a key:value pair from a hashtable
dict_dump klib Dumps the contents of this dict as a string
dict_exists klib Returns 1 if the dict exists, 0 otherwise
dict_free klib Free a hashtable
...
$ risset download <plugin>
Download a plugin
--path PATH: Directory to download the plugin to (default: current directory)--platform: The platform of the plugin to download (default: current platform). One of linux, macos, window, macos-arm64, linux-arm64
$ risset info [options]
Outputs information about the environment as json in order to be integrated by other systems. For example, CsoundQT uses this command to read the installed plugins and their opcodes and documentation
--outfile OUTFILE: Save output to this path--full: Include all available information
Documentation for all plugins can be found here: https://csound-plugins.github.io/risset-docs/
If installed via pip, do:
pip install risset -U
If installed via git, go to the repository and do:
git pull
python setup.py install
In order to add/modify a plugin, clone risset-data
At the root of the repository there is an index file rissetindex.json, with the form:
{
"version": "1.0.0",
"plugins": {
"else": {
"url": "https://github.com/csound-plugins/csound-plugins.git",
"path": "src/else"
},
"pathtools": {
"url": "https://github.com/csound-plugins/csound-plugins.git",
"path": "src/pathtools"
},
"klib": {
"url": "https://github.com/csound-plugins/csound-plugins.git",
"path": "src/klib"
},
"beosc": {
"url": "https://github.com/csound-plugins/csound-plugins.git",
"path": "src/beosc"
},
"vst3": {
"url": "https://github.com/csound-plugins/vst3-risset.git"
}
}
}To add a plugin to the index, just extend the plugins dict. The url should point to a valid git repository, the path attribute can be used to indicate where risset.json manifest is within this repository. This allows to define multiple plugins within one repository.
Each plugin has an accompanying manifest in the .json format. The name of this file
is always risset.json
See one of the examples in https://github.com/csound-plugins/csound-plugins/tree/master/src for
more information about the manifest