| Both sides previous revision
Previous revision
Next revision
|
Previous revision
|
dev:device_files [2022/01/21 20:27]
tedfelix |
dev:device_files [2025/01/21 20:32] (current)
tedfelix [Editing with the GUI] |
| |
| Device files are stored in ~/.local/share/rosegarden/library. The files themselves are in xml format, gzipped. | Device files are stored in ~/.local/share/rosegarden/library. The files themselves are in xml format, gzipped. |
| |
| ===== Examining An Existing .rgd File ===== | |
| |
| When working on .rgd files, it's nice to have the following "rgless" script handy. It will decompress and display the xml for you: | |
| |
| <code bash> | |
| #!/bin/sh | |
| |
| # Display an rg/rgd file using less... | |
| |
| cp "$1" "$1.xml.gz" | |
| gzip -d "$1.xml.gz" | |
| less "$1.xml" | |
| rm "$1.xml" | |
| </code> | |
| |
| Be sure to put this script someplace it can be found by bash. E.g. ~/bin. | |
| |
| ==== GM.rgd ==== | ==== GM.rgd ==== |
| |
| $ cd ~/.local/share/rosegarden/library | $ cd ~/.local/share/rosegarden/library |
| $ rgless GM.rgd | $ zless GM.rgd |
| |
| There are three main kinds of tags: ''<bank>'', ''<controls>'', and ''<keymapping>''. | There are three main kinds of tags: ''<bank>'', ''<controls>'', and ''<keymapping>''. |
| The ''<control>'' tags define each controller. The above set of six controllers will be in almost every .rgd file and should appear as above. | The ''<control>'' tags define each controller. The above set of six controllers will be in almost every .rgd file and should appear as above. |
| |
| The ipbposition numbers should be as above for those controllers. For all others, the numbers should be "-1". This prevents them from appearing on the UI unless the user explicitly asks for them. | The colourindex values allow a selection from among 5 colors (see the "generalmap" colourmap from autoload.rg): |
| | |
| | ^ colourindex ^ Color ^ |
| | | 0 | default (peach) | |
| | | 1 | Red pastel | |
| | | 2 | Green pastel | |
| | | 3 | Orange pastel | |
| | | 4 | Yellow pastel | |
| | |
| | The ipbposition numbers should be as above for those controllers. For all others, the numbers should be "-1". This prevents them from appearing on the UI unless the user explicitly asks for them. ipbposition values are organized from left to right and then top to bottom. This table shows the organization along with the controllers that historically have occupied each position: |
| | |
| | | 0 (pan) | 1 (chorus) | |
| | | 2 (volume) | 3 (reverb) | |
| |
| ==== Keymapping Tags ==== | ==== Keymapping Tags ==== |
| If your synth implements variations across bank selects (like General MIDI 2), consider using variations mode. The ''<device>'' tag's "variation" attribute can be set to MSB or LSB based on which part of the bank select number changes for the variations. | If your synth implements variations across bank selects (like General MIDI 2), consider using variations mode. The ''<device>'' tag's "variation" attribute can be set to MSB or LSB based on which part of the bank select number changes for the variations. |
| |
| To find some examples, use rgdgrep (below) to search the device library for variation="lsb" or variation="msb". | To find some examples, use zgrep (see below) to search the device library for variation="lsb" or variation="msb". |
| |
| Warning: For variations mode to work, every PC that has variations must be present in the first bank. Here's an example that will not work: | Warning: For variations mode to work, every PC that has variations must be present in the first bank. Here's an example that will not work: |
| (Note that there is no PC 2 in the first bank!) | (Note that there is no PC 2 in the first bank!) |
| |
| Second Bank, variation 1, (variations="lsb"): | Second Bank, variation 1, (variation="lsb"): |
| |
| ^ BS MSB ^ BS LSB ^ PC ^ Patch Name ^ | ^ BS MSB ^ BS LSB ^ PC ^ Patch Name ^ |
| That Violin sound in the second bank will never show up in variations mode because there is no Program Change 2 in the first bank. | That Violin sound in the second bank will never show up in variations mode because there is no Program Change 2 in the first bank. |
| |
| ==== rgdgrep ==== | ==== Searching the Device Library ==== |
| |
| The following ''rgdgrep'' script can be used to search all the installed .rgd files: | Use the zgrep command to search all the installed .rgd files: |
| |
| <code bash> | $ zgrep Expression ~/.local/share/rosegarden/library/*.rgd |
| #!/bin/bash | |
| | |
| # Search for a string in the installed rgd files. | |
| | |
| for rgdfile in ~/.local/share/rosegarden/library/*.rgd | |
| do | |
| shortname=${rgdfile##*/} | |
| gzip -dc "$rgdfile" | grep --label "$shortname" -H -i $1 | |
| done | |
| </code> | |
| |
| ===== Starting from Scratch ===== | ===== Starting from Scratch ===== |
| |
| * Device owner's manual should have the information you need. | * Device owner's manual should have the information you need. |
| | |
| * Find a similar .rgd file and use that as a starting point. | * Find a similar .rgd file and use that as a starting point. |
| * txt2rgd.py | |
| * ins2rgd.pl | * [[https://sourceforge.net/p/rosegarden/git/ci/master/tree/scripts/txt2rgd.py|txt2rgd.py]] - Script to convert a text file with bank selects, program changes, and voice names into an .rgd file. |
| | |
| | * [[https://sourceforge.net/p/rosegarden/git/ci/master/tree/scripts/ins2rgd.pl|ins2rgd.pl]] - Script to convert a Cakewalk .ins instrument file into an .rgd file. |
| |
| ===== Making changes ===== | ===== Making changes ===== |
| ===== Editing with the GUI ===== | ===== Editing with the GUI ===== |
| |
| * Basic process | * The bank/program editor is built into the "Manage MIDI Banks and Programs" dialog. (Studio > Manage MIDI Devices > Banks...) |
| * Limitations | * The Key Mapping editor is there as well. From the menu: Edit > Add Key Mapping to create a new key mapping, and select it in the tree to edit it. |
| | * The controller editor is built into the Manage Controllers dialog. (Studio > Manage MIDI Devices > Controllers...) |
| | * Loading and saving of everything (banks, program changes, keymaps, and controllers) is done via the "Manage MIDI Banks and Programs" dialog menu: File > Import... and File > Export.... |
| |
| ===== Checklist ===== | ===== Checklist ===== |
| ===== Utilities ===== | ===== Utilities ===== |
| |
| //TODO: Attach a tar.gz file with all the scripts.// | //TODO: Get all the scripts into the source code scripts directory and link to them. See txt2rgd.py above.// |
| |
| ===== References ===== | ===== References ===== |
