VoiceWorks Plus MIDI System Exclusive Version 1.00

Transcription

1 TC-IVL VoiceWorks Plus MIDI System Exclusive Version 1.00 Last Modified: December 17th, 2005 Introduction This document describes how to control and configure VoiceWorks Plus through standard MIDI System Exclusive communication. Hexadecimal Notation Many values in this document are presented in hexadecimal notation. Hexadecimal numbers will be prefixed with 0x. Example: Hexadecimal 0x123 = Decimal 291 Decimal 123 = Hexadecimal 0x7B VoiceWorks Plus SYSEX message template: Every SYSEX package VoiceWorks Plus sends and receives must conform to the following template: 0xF0 MIDI System exclusive message start 0x00 3 byte manufactors ID for TC-Helicon 0x x38... <Device ID> System exclusive device ID (user parameter) 0x51 VoiceWorks Plus model ID <Message ID> VoiceWorks Plus message type identifier <Data> Start of message data... Variable number of data bytes based on message type 0xF7 MIDI System exclusive message terminator Data Packing (28-bit words to 4x7-bit bytes, or 14-bit words to 2x7-bit bytes) The idea of data packing is to take a 14 or 28-bit value and split it into 7-bit segments, so that it can be sent easily with SYSEX. SYSEX data can only be 7 bits in size. Below is an example of how 14-bit and 28-bit signed integers can be converted into SYSEX strings using Visual Basic for Applications: Function create_hex(val As Integer) As String ' Creates a nicely formatted hex string from a value create_hex = Hex(val) If Len(create_hex) = 1 Then create_hex = "0" & create_hex Page 1

2 End Function Function create_14_compliment(byval val As Long) As String Dim msb As Integer Dim lsb As Integer Dim msb_s As String Dim lsb_s As String Dim temp As Long temp = val ' deal with negative numbers If val < 0 Then temp = val End If msb = Int(temp / 128) lsb = temp - (msb * 128) ' create hex string from values msb_s = create_hex(msb) lsb_s = create_hex(lsb) ' and return the sysex data portion create_14_compliment = msb_s & " " & lsb_s End Function Function create_28_compliment(byval val As Long) As String Dim msb As Integer Dim msb2 As Integer Dim msb3 As Integer Dim lsb As Integer Dim msb_s As String Dim msb2_s As String Dim msb3_s As String Dim lsb_s As String Dim temp As Long temp = val ' deal with negative numbers If val < 0 Then temp = * val End If msb = Int(temp / 128) msb2 = Int(temp / 16384) msb3 = Int(temp / ) lsb = temp - ((msb * 128) + (msb2 * 16384) + (msb3 * )) ' create hex string from values msb_s = create_hex(msb) msb2_s = create_hex(msb2) msb3_s = create_hex(msb3) lsb_s = create_hex(lsb) Page 2

3 ' and return the sysex data portion create_28_compliment = msb3_s & " " & msb2_s & " " & msb_s & " " & lsb_s End Function Preset numbers Preset numbers are represented in SYSEX messages using 14-bit data packing. Preset zero references the currently loaded preset (possibly being edited by the user). Presets numbered 1 through 99 reference all factory presets. Numbers between 100 and 198 represent user. Requesting a user preset that does not exist will cause VoiceWorks Plus to return an empty preset notification message. Checksum Checksums are 1 byte, holding the 7 least significant bits of the sum of all bytes contributing to the checksum. Example: If the byte values used in a checksum calculation were the series 1,2,3,...,126 their sum total would be Dividing 8001 by 128 leaves a remainder of 65, which becomes the checksum byte. Message data format The format of the data of each SYSEX message type varies. Below are descriptions for each message type, explaining their specific data formatting requirements. SYSEX message type Request Preset Request Parameter Request Setup Notification Message Preset Data Parameter Data Setup Data Set Editor Mode Presets Utility Identifier 0x45 0x47 0x15 0x34 0x20 0x22 0x13 0x53 0x54 VoiceWorks Plus Data Request messages The following describes the data part of the standard SYSEX message template. Request Preset 0x45: <Data> is 2 bytes (packed 14-bit integer) representing the number of the preset requested. See above for a description of preset number representation. The data transmitted by VoiceWorks Plus upon receiving this message will be formatted as a Preset Data message. Request Parameter 0x47: Page 3

4 <Data> is 2 bytes (packed 14-bit integer) representing the Universal Parameter Identifier. See the parameter table for a list of accessible parameters and their Ids. The data transmitted by VoiceWorks Plus upon receiving this message will be formatted as a Parameter Data message (see below for complete description). Request Setup Data 0x15: <Data> is 1 byte. The value of this byte is ignored. The data transmitted by VoiceWorks Plus upon receiving this message will be formatted as a Setup Data message. VoiceWorks Plus Data messages Notification message (Preset Receive, Empty Preset) 0x34: <Data> is 1 byte. If Data=1, the VoiceWorks Plus has successfully received a Preset Data message Sometimes VoiceWorks Plus needs to reorganize its internal preset bank after receiving a SYSEX preset. While this is happening, VoiceWorks Plus has to ignore incoming preset SYSEX packages. If this happens while you are dumping several presets to the unit, you might lose a preset in transmission without realizing it. This situation can be avoided by waiting for VoiceWorks Plus to send this message indicating that the preset was successfully stored, before attempting to send the next. For a non-programmatic solution to this problem, refer to the section on Buffering Presets. If Data=2, VoiceWorks Plus is reporting that the last requested user preset is non-existent. VoiceWorks Plus allows the user to save user presets nonconsecutively. This message allows for scanning the VoiceWorks Plus to determine which user presets have been created. If Data=3, VoiceWorks Plus is reporting that the user attempted to overwrite a factory preset with a SYSEX preset message. VoiceWorks Plus will only accept presets with numbers in the user bank range ( ). If Data=4, VoiceWorks Plus is reporting that that the last received preset had an incompatible version number and was therefore rejected. Preset Data 0x20: Presets are sent in a series of SYSEX messages. This is done to enhance compatibility with MIDI devices that cannot handle large SYSEX data messages. Each package contains the preset information along with 50 parameters. The last package may contain empty parameters. The total number of packages required for a preset can be calculated by taking the ceiling of the number of preset parameters divided by 50. Page 4

5 <Data> is organized as follows 2 bytes Preset number (14-bit packed) 15 bytes Preset name (unpacked - ASCII characters) 2 bytes Preset Set Version (14-bit packed) 2 bytes Total number of parameters in preset (14-bit packed) 1 byte Package Number (1 is the first package) 200 bytes(cs) The bit preset parameters for current package. 1 byte Checksum The preset name is null terminated. VoiceWorks Plus can display names 22 characters in length. Refer to the preset table to see how the preset parameters fit into each package. On requesting a preset, VoiceWorks Plus will automatically send all necessary packages. VoiceWorks Plus must receive preset packages sequentially and completely before it will process the information. Note: The checksum is calculated only on the data marked with (cs). Parameter data 0x22: <Data> is 6 bytes. The first two bytes identify the Universal Parameter ID. The last four bytes determine the value of the parameter represented as a 28-bit 2 s complement signed value. If a value exceeds the limits of the parameter, the value will be automatically limited. Setup Data 0x13: Like presets, setup data packages are also sent as a series of SYSEX messages. <Data> is organized as follows 2 bytes Preset Set Version (14-bit packed) 2 bytes Total number of parameters in setup (14-bit packed) 1 byte Package Number 200 bytes(cs) The bit preset parameters for current package. 1 byte Checksum Refer to the setup table to see how the preset parameters fit into each package. On requesting a setup package, VoiceWorks Plus will automatically send all necessary packages. VoiceWorks Plus must receive setup packages sequentially and completely before it will process the information. VoiceWorks Plus Editor Mode Messages Set Editor Mode 0x53: <Data> is 1 byte. A value of zero turns off Editor Mode and a value of 1 turns it on. In Editor mode, VoiceWorks Plus echoes all parameter changes (via the front panel user interface controls) to SYSEX as Parameter Data, instead of forcing the user to request parameter data manually. Presets Utility 0x54: Page 5

6 <Data> is 1 byte. Sending 50 erases the user bank. 1 means enable preset buffering, 0 means disable buffering and commit buffer to the file system. The size and complexity of VoiceWorks Plus presets makes it difficult for the unit to keep up with a large number of incoming SYSEX presets. To support the reception of an entire user bank, the buffer presets function was created. Enabling preset buffering causes VoiceWorks Plus to store all incoming presets temporarily without processing them, allowing it to keep up with full-rate MIDI. Once all presets have been received, disabling buffering causes VoiceWorks Plus to process and write all presets to its non-volatile file system. Using the Utility menu to dump all presets automatically wraps the entire preset dump with these messages. An alternative to using this feature is to programmatically rely on the notification messages. I.e. wait for a preset received success message before sending the next. Example: F F7 (enable buffering) F E *** many presets *** F7 F F7 (disable buffering) Page 6

7 Universal Parameter ID Tables Preset Package Parameter Set Version: 0.21 SYSEX Offset Universal ID Parameter Name Min Max 0 56 Harmony Mode Harmony Key Harmony Scale Harmony Root Harmony Chord PresetControl Harmony or Model LeadShift Lead Shift Mode LeadShift Lead Shift Chromatic LeadShift Lead Shift Amount Blocks Harmony/VM Enable Blocks Correction Enable Blocks Effects Enable Blocks Harmony Enable Voice Blocks Harmony Enable Voice Blocks Harmony Enable Voice Blocks Harmony Enable Voice LeadPitchCorrect Root LeadPitchCorrect Scale LeadPitchCorrect Window LeadPitchCorrect Attack LeadPitchCorrect Amount Harmony Bend_Control Harmony Tuning Harmony Attack Harmony Decay Harmony Release Harmony Release Time Randomize Harmony Latch Harmony Hold Harmony Hold Release Harmony Detune Harmony Notes Extension Switch Harmony Shift V1 Voicing Harmony Shift V2 Voicing Harmony Shift V3 Voicing Harmony Shift V4 Voicing Harmony Scale V1 Voicing Harmony Scale V2 Voicing Harmony Scale V3 Voicing Harmony Scale V4 Voicing Harmony Chord V1 Voicing 0 19 Page 7

8 41 81 Harmony Chord V2 Voicing Harmony Chord V3 Voicing Harmony Chord V4 Voicing Harmony Gender V Harmony Gender V Harmony Gender V Harmony Gender V Harmony Humanize Style V Harmony Humanize Style V Harmony Humanize Style V Harmony Humanize Style V Harm_Infl_V1 Humaize Amount V Harm_Infl_V2 Humaize Amount V Harm_Infl_V3 Humaize Amount V Harm_Infl_V4 Humaize Amount V Harmony Smoothing Amount V Harmony Smoothing Amount V Harmony Smoothing Amount V Harmony Smoothing Amount V Harmony Vibrato Style V Harmony Vibrato Style V Harmony Vibrato Style V Harmony Vibrato Style V Harm_Vib_V1 Vibrato Amount V Harm_Vib_V2 Vibrato Amount V Harm_Vib_V3 Vibrato Amount V Harm_Vib_V4 Vibrato Amount V Harmony Portamento V Harmony Portamento V Harmony Portamento V Harmony Portamento V VoiceMixer VM Lead Pan VoiceMixer VM Lead Level HarmonyMixer Pan Voice HarmonyMixer Level Voice HarmonyMixer Pan Voice HarmonyMixer Level Voice HarmonyMixer Pan Voice HarmonyMixer Level Voice HarmonyMixer Pan Voice HarmonyMixer Level Voice LeadMixer Dry Pan LeadMixer Dry Level MicroModMixer Dry Send MicroModMixer Harm/VM Send MicroModMixer Aux Send DelayMixer Dry Send Page 8

9 DelayMixer Harm/VM Send DelayMixer Aux Send DelayMixer MicroMod Send ReverbMixer Dry Send ReverbMixer Harm/VM Send ReverbMixer Aux Send ReverbMixer Delay Send FxMixer MicroMod Level FxMixer Delay Level FxMixer Reverb Level FxMixer MicroMod Width FxMixer Delay Width FxMixer Reverb Width MicroMod Style MicroMod Detune Left MicroMod Detune Right MicroMod Mod Depth L MicroMod Mod Depth R MicroMod Mod Speed MicroMod Mod L/R Phase MicroMod Mod Wave MicroMod Delay Left MicroMod Delay Right MicroMod Feedback L MicroMod Feedback R MicroMod X Feedback L MicroMod X Feedback R MicroMod Low Cut L MicroMod Low Cut R MicroMod High Cut L MicroMod High Cut R MicroMod Phase Inverse Delay Style Delay Source Delay Tempo Delay Time L Delay Time R Delay Division L Delay Division R Delay Feedback L Delay Feedback R Delay Cross Feedback Left to Right Delay Cross Feedback Right to Left Delay Low Cut L Delay Low Cut R Delay High Cut L Delay High Cut R Page 9

10 Reverb Style Reverb Pre Delay Reverb Room Level Reverb Decay Time Reverb Lo Color Reverb Hi Color Reverb Tail Level Transducer Style Transducer Routing Transducer Distortion Amount Transducer PreGain Transducer PostGain Transducer Low Cut Transducer High Cut Transducer Distortion Type Harmony Notes V1 Voicing Harmony Notes V2 Voicing Harmony Notes V3 Voicing Harmony Notes V4 Voicing Harmony Global Pitch Amount Harmony Global Time Amount Harmony Global Level Amount Inflection Style Inflection Amount Inflection Rand Mod Inflection Scoop Dur Inflection Scoop Amt Naturalization UV Atten Naturalization Pitch Rand Naturalization Pitch Rate Naturalization Time Rand Naturalization Time Rate Naturalization Level Rand Naturalization Level Rate Vibrato Style Vibrato Amount Vibrato Rand Mod Vibrato Rate Vibrato Depth Vibrato Onset Delay Vibrato Attack Vibrato Sustain Vibrato Release Vibrato Trem Amt Vibrato Trem Phase Breath Style Breath Amount Page 10

11 Breath Aspiration Level Breath Voice Level Resonance Style Resonance Amount Resonance Tract Ratio LeadShift Lead Shift Formant LeadShift Lead Shift Hybrid LeadShift Lead Shift Portamento LeadShift Lead Shift Smoothing Reserved For Future Use LeadShift Allow MIDI RePitching Harmony Map V12_Root Harmony Map V12_Minor Harmony Map V12_Major Harmony Map V12_Minor Harmony Map V12_Major Harmony Map V12_Perfect Harmony Map V12_Augmented Harmony Map V12_Peftect Harmony Map V12_Minor Harmony Map V12_Major Harmony Map V12_Minor Harmony Map V12_Major Harmony Map V34_Root Harmony Map V34_Minor Harmony Map V34_Major Harmony Map V34_Minor Harmony Map V34_Major Harmony Map V34_Perfect Harmony Map V34_Augmented Harmony Map V34_Peftect Harmony Map V34_Minor Harmony Map V34_Major Harmony Map V34_Minor Harmony Map V34_Major Correction Map BitField LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote LeadShift CustomNote Page 11

12 LeadShift CustomNote System Package Parameter Set Version: 0.21 SYSEX Offset Universal ID Parameter Name Min Max 0 0 Utility Input Utility DryVoiceIn Utility AuxIn Utility Output Utility Clock Utility Mic Sensitivity Utility Input Sensitivity Utility Output Level Utility Digital In Gain Utility Digital Channel Status Utility Voice Latency Compensation Utility Bypass Mode Utility MIDI Channel Utility CC Control Utility Filter Utility Program Bank Utility Bypass Utility Tuning Reference Utility Global Effect Utility Global Chord Utility Pitch Bend Range Utility Transpose Utility Keyboard Split Above/Below Utility Keyboard Split Point Utility Chord Mode Operation Utility Notes Mode Operation Utility MIDI Aftertouch Utility Expression Pedal Assignment Utility Footswitch Button Utility Footswitch Button Utility Footswitch Button Utility umod or Transducer Switch Utility Mic Phantom Power Utility Mic Input Select Utility Mic -20dB Pad PreFX LowCut Frequency PreFX Dynamics Configuration PreFX Compressor Threshold Page 12

13 38 46 PreFX Compressor Ratio PreFX Noise Gate Threshold PreFX EQ Configuration PreFX Low Shelf Frequency PreFX Low Shelf Gain PreFX High Shelf Frequency PreFX High Shelf Gain PreFX Mid Parametric Frequency PreFX Mid Parametric Gain PreFX Mid Parametric Q Factor Utility Vibrato Control Master Lead Level Master Harmony/VM Level Master Effects Level Master Output Level Miscellaneous Controllable Parameters Version 0.21 Universal ID Parameter Name Min Max 511 Harmony Custom Scale V Harmony Custom Scale V Harmony Custom Scale V Harmony Custom Scale V Select Shift Map Program Mode Select Effects Outs Select Human Rand Parm Select Effects Type Select Vibrato Envelope Control Global Vibrato Amount Control Aftertouch Control Expression Pedal Harmony Input Node 0 11 Page 13