User Guide  for  Hauptwerk
About Hauptwerk
Welcome
What is it?
What is it used for?
Licensing
Installation
Prerequisites
Background
Installing
Upgrading
Backups
Quick start
Stand-alone
MIDI sequencing
VSTi plug-in
Background
Tour of a pipe organ
Using Hauptwerk
The virtual console
Settings screens
Menus
The File menu
Loading sample sets
Combination files
The registration sequencer
Temperaments
Audio routing and multi-channel audio
Activation and reset
Capture mode
Recording audio
Master tuning
The transposer
MIDI input
MIDI output
Re-directable inputs
Component installer
Importing v1 organs
MIDI organ consoles
MIDI sequencing
Organ design tools
Performance tuning
General options
Sample set options
Voicing
Reference
MIDI implementation
Troubleshooting
Creating sample sets

MIDI organ consoles


The quick start: stand-alone section covers basic configuration, and the MIDI input and MIDI output sections describe how MIDI input and output are configured generally. The MIDI implementation section also describes the range of MIDI messages Hauptwerk supports for its various types of objects.

Note that MIDI output facilities are only available in the Advanced Edition of Hauptwerk.

This section is intended to provide additional reference and suggestions for configuration when Hauptwerk is to be used as an 'engine' for a MIDI organ console or voice expander.

On a MIDI console, you may wish to include:
  • MIDI output from the physical keyboards to control Hauptwerk's virtual keyboards.
  • MIDI output (usually MIDI note-on/off messages) from the physical draw-knobs/tabs to control Hauptwerk's virtual stops, couplers, tremulants and other latching switches.
  • MIDI output (usually MIDI program change messages) from the physical pistons/buttons to control Hauptwerk's virtual pistons.
  • MIDI control change output from physical swell and crescendo pedals.
  • Additional MIDI buttons (usually also MIDI program change messages) to trigger Hauptwerk's essential menu functions.
  • MIDI input (usually note-on/off) to control physical draw-knob solenoids or draw-knob/tab state lamps in response to changes from Hauptwerk's combination system.
  • A small number of additional indicator lamps to show Hauptwerk's system statuses (error, active, etc.).
  • If you will be using multiple sample sets, then possibly also LCD panels for each physical console control so that Hauptwerk can display a label by it, appropriate to the sample set loaded.
If you intend to use Hauptwerk 'headless' - without a computer monitor, mouse or computer keyboard - the the process is as follows:
  • It is simplest to choose the installation option to make Hauptwerk start automatically when the computer boots. If you have already installed Hauptwerk and did not choose that option, the same effect can be achieved on Windows systems by copying the short-cut from which you launch Hauptwerk into the Start | Programs | Startup program group.
  • If you have not already done so, follow the Quick start: stand-alone section to perform initial configuration.
  • Use the component installer to install the sample set(s) that you intend to use with Hauptwerk.
  • Configure Hauptwerk's MIDI input and MIDI output systems fully for use with your console, ensuring that all essential menu functions (such as File | Shut computer down) are assigned to MIDI buttons. You may also wish to assign Hauptwerk's system status outputs to MIDI indicator lamps or similar.
  • Configure multi-channel audio if required.
  • Test the configuration thoroughly and re-configure/repeat as necessary.
  • Load the sample set that you wish to use as the default.
  • Select Functions | Enter capture mode.
  • Select Organ | Set current organ as stand-by organ 1.
  • Select Functions | Leave capture mode.
  • Select Organ | Unload organ.
  • Finally, use General settings | General options to set Organ loading mode when Hauptwerk starts to 'Load and activate first stand-by organ'.
  • Re-boot the computer and check that Hauptwerk starts and loads the sample set automatically.
  • You may also need to configure you computer's BIOS to ignore the absence of a mouse or keyboard when booting. Consult your computer documentation.
  • Detach the monitor, mouse and keyboard from the computer and re-boot again to verify that everything is still working properly.
If you are building a MIDI organ console, or converting an old organ console for MIDI for use with Hauptwerk, the MIDI implementation section has the definitive information on what is supported by Hauptwerk. However, if there are no other factors, you may simply wish to design the MIDI implementation of the console to match Hauptwerk's default MIDI configuration, to minimise the time taken to re-configure Hauptwerk.

The following sections describe the default configuration installed with Hauptwerk, and make the assumption that all MIDI messages for a given channel are sent and received on the same port. The port used for each MIDI input channel can be adjusted on the General settings | MIDI input paths screen, and that for output on the General settings | MIDI output paths screen.

Important: The following sections are not requirements; they merely describe the default installed configuration in case you wish to use it unaltered. If you change the configuration via the MIDI input or output options on the General settings or Organ settings menus, then the following information may no longer apply, and you must instead use the values that you have configured.

In particular, since any of the default configuration can be changed as required, there are no restrictions on the MIDI channels and message types that can be used to control any given virtual organ control. For example, if you wish all draw-knobs to be controlled by MIDI note-on/off messages on a single MIDI channel, then simply create or select a MIDI input path with General settings | Switch (MIDI) inputs for that MIDI port and channel, change the MIDI input path settings for the relevant switches on the General settings | Switch (MIDI) inputs screen to use that path, re-assign their event (note) numbers as required, and optionally delete other switch (MIDI) inputs that you do not intend to use.


Keyboards

For the default configuration, set the MIDI keyboards' MIDI channels as follows, using standard note-on/off to control the virtual keys:
  • Keyboards: div. 1 (Pedal) - channel 1.
  • Keyboards: div. 2 (Great) - channel 2.
  • Keyboards: div. 3 (Swell) - channel 3.
  • Keyboards: div. 4 (Choir) - channel 4.
  • Keyboards: div. 5 (Solo) - channel 5.
If you wish to use theatre organ second-touch, you must create additional keyboard MIDI input objects (and possibly additional MIDI input paths) using the General settings | Keyboard MIDI inputs screen.


Continuous controls (swell pedals, crescendo pedals, etc.)

For the default configuration, set the MIDI expression pedals to send on the following MIDI channels and MIDI continuous controller numbers:
  • Crescendos: general - channel 7, controller number 2 (breath control).
  • Swells: div. 1 (Pedal) - channel 1, controller number 1 (modulation wheel).
  • Swells: div. 2 (Great) - channel 2, controller number 1 (modulation wheel).
  • Swells: div. 3 (Swell) - channel 3, controller number 1 (modulation wheel).
  • Swells: div. 4 (Choir) - channel 4, controller number 1 (modulation wheel).
  • Swells: div. 5 (Solo) - channel 5, controller number 1 (modulation wheel).
  • Swells: general - channel 7, controller number 1 (modulation wheel).

Virtual pistons

To trigger a sample set's virtual pistons using the default configuration, send a MIDI program change message with the following channels and program numbers:
  • Combination pistons: div. 1 (Pedal) - channel 1, prog. 1-10.
  • Combination pistons: div. 2 (Great) - channel 2, prog. 1-10.
  • Combination pistons: div. 3 (Swell) - channel 3, prog. 1-10.
  • Combination pistons: div. 4 (Choir) - channel 4, prog. 1-10.
  • Combination pistons: div. 5 (Solo) - channel 5, prog. 1-10.

  • Combination pistons: general - channel 7, prog.1-20.
  • General cancel - channel 7, prog. 64.


Virtual stops

Send MIDI note-on/off messages to turn the virtual stop switches on and off using the default configuration, with the following channels and note numbers:
  • Stops: div. 1 (Pedal) - channel 8, notes 36-67.
  • Stops: div. 2 (Great) - channel 9, notes 36-67.
  • Stops: div. 3 (Swell) - channel 10, notes 36-67.
  • Stops: div. 4 (Choir) - channel 11, notes 36-67.
  • Stops: div. 5 (Solo) - channel 12, notes 36-67.

In order to view or adjust which stops are assigned to which note numbers, load the sample set then use the Organ settings | Connect switch MIDI inputs to organ switches screen to select the organ stops in the browse list, and view or change the input switches to which they are assigned.

Set each physical solenoid-actuated/illuminated draw-knob/tab to be controlled by a note-on/off message with the same channel and note number that it sends.


Virtual couplers

Please look at the General settings | Switch (MIDI) inputs screen for the full list. We will only list the commonly-used couplers here. Send MIDI note-on/off messages to turn the virtual switches on and off using the default configuration, with the following channels and note numbers:
  • Couplers: div. 2 (Great) to div. 1 (Pedal) - channel 8, note 74.
  • Couplers: div. 3 (Swell) to div. 1 (Pedal) - chan. 8, note 79.
  • Couplers: div. 3 (Swell) to div. 1 (Pedal) oct. - chan. 8, note 80.
  • Couplers: div. 4 (Choir) to div. 1 (Pedal) - chan. 8, note 84.
  • Couplers: div. 4 (Choir) to div. 1 (Pedal) oct. - chan. 8, note 85.
  • Couplers: div. 5 (Solo) to div. 1 (Pedal) - chan. 8, note 89.
  • Couplers: div. 5 (Solo) to div. 1 (Pedal) oct. - chan. 8, note 90.

  • Couplers: div. 1 (Pedal) to div. 2 (Great) bass - chan. 9, note 71.
  • Couplers: div. 3 (Swell) to div. 2 (Great) sub-oct. - chan. 9, note 78.
  • Couplers: div. 3 (Swell) to div. 2 (Great) - chan. 9, note 79.
  • Couplers: div. 3 (Swell) to div. 2 (Great) oct. - chan. 9, note 80.
  • Couplers: div. 4 (Choir) to div. 2 (Great) sub-oct. - chan. 9, note 83.
  • Couplers: div. 4 (Choir) to div. 2 (Great) - chan. 9, note 84.
  • Couplers: div. 4 (Choir) to div. 2 (Great) oct. - chan. 9, note 85.
  • Couplers: div. 5 (Solo) to div. 2 (Great) sub-oct. - chan. 9, note 88.
  • Couplers: div. 5 (Solo) to div. 2 (Great) - chan. 9, note 89.
  • Couplers: div. 5 (Solo) to div. 2 (Great) oct. - chan. 9, note 90.

  • Couplers: div. 1 (Pedal) to div. 3 (Swell) bass - chan. 10, note 71.
  • Couplers: div. 3 (Swell) sub-oct. - chan. 10, note 78.
  • Couplers: div. 3 (Swell) unison off - chan. 10, note 79.
  • Couplers: div. 3 (Swell) oct. - chan. 10, note 80.
  • Couplers: div. 4 (Choir) to div. 3 (Swell) sub-oct. - chan. 10, note 83.
  • Couplers: div. 4 (Choir) to div. 3 (Swell) - chan. 10, note 84.
  • Couplers: div. 4 (Choir) to div. 3 (Swell) oct. - chan. 10, note 85.
  • Couplers: div. 5 (Solo) to div. 3 (Swell) sub-oct. - chan. 10, note 88.
  • Couplers: div. 5 (Solo) to div. 3 (Swell) - chan. 10, note 89.
  • Couplers: div. 5 (Solo) to div. 3 (Swell) oct. - chan. 10, note 90.

  • Couplers: div. 1 (Pedal) to div. 4 (Choir) bass - chan. 11, note 71.
  • Couplers: div. 3 (Swell) to div. 4 (Choir) sub-oct. - chan. 11, note 78.
  • Couplers: div. 3 (Swell) to div. 4 (Choir) - chan. 11, note 79.
  • Couplers: div. 3 (Swell) to div. 4 (Choir) oct. - chan. 11, note 80.
  • Couplers: div. 4 (Choir) sub-oct. - chan. 11, note 83.
  • Couplers: div. 4 (Choir) unison off - chan. 11, note 84.
  • Couplers: div. 4 (Choir) oct. - chan. 11, note 85.
  • Couplers: div. 5 (Solo) to div. 4 (Choir) sub-oct. - chan. 11, note 88.
  • Couplers: div. 5 (Solo) to div. 4 (Choir) - chan. 11, note 89.
  • Couplers: div. 5 (Solo) to div. 4 (Choir) oct. - chan. 11, note 90.

  • Couplers: div. 5 (Solo) sub-oct. - chan. 12, note 88.
  • Couplers: div. 5 (Solo) unison off - chan. 12, note 89.
  • Couplers: div. 5 (Solo) oct. - chan. 12, note 90.

Again set each physical solenoid-actuated/illuminated draw-knob/tab to be controlled by a note-on/off message with the same channel and note number that it sends.


Virtual tremulants

Send MIDI note-on/off messages to turn the virtual switches on and off using the default configuration, with the following channels and note numbers:
  • Tremulants: div. 1 (Pedal) main - chan. 8, note 93.
  • Tremulants: div. 1 (Pedal) Tibia - chan. 8, note 94.
  • Tremulants: div. 1 (Pedal) solo 1 - chan. 8, note 95.
  • Tremulants: div. 1 (Pedal) solo 2 - chan. 8, note 96.

  • Tremulants: div. 2 (Great) main - chan. 9, note 93.
  • Tremulants: div. 2 (Great) Tibia - chan. 9, note 94.
  • Tremulants: div. 2 (Great) solo 1 - chan. 9, note 95.
  • Tremulants: div. 2 (Great) solo 2 - chan. 9, note 96.

  • Tremulants: div. 3 (Swell) main - chan. 10, note 93.
  • Tremulants: div. 3 (Swell) Tibia - chan. 10, note 94.
  • Tremulants: div. 3 (Swell) solo 1 - chan. 10, note 95.
  • Tremulants: div. 3 (Swell) solo 2 - chan. 10, note 96.

  • Tremulants: div. 4 (Choir) main - chan. 11, note 93.
  • Tremulants: div. 4 (Choir) Tibia - chan. 11, note 94.
  • Tremulants: div. 4 (Choir) solo 1 - chan. 11, note 95.
  • Tremulants: div. 4 (Choir) solo 2 - chan. 11, note 96.

  • Tremulants: div. 5 (Solo) main - chan. 12, note 93.
  • Tremulants: div. 5 (Solo) Tibia - chan. 12, note 94.
  • Tremulants: div. 5 (Solo) solo 1 - chan. 12, note 95.
  • Tremulants: div. 5 (Solo) solo 2 - chan. 12, note 96.
Yet again set each physical solenoid-actuated/illuminated draw-knob/tab to be controlled by a note-on/off message with the same channel and note number that it sends.


Menu functions

To trigger Hauptwerk's menu functions from push-buttons using the default configuration, send MIDI program change messages on MIDI channel 7 with the following program numbers:
  • Organ | Load/assign stand-by organ 1 - prog. 21.
  • Organ | Load/assign stand-by organ 2 - prog. 22.
  • Organ | Load/assign stand-by organ 3 - prog. 23.
  • Organ | Load/assign stand-by organ 4 - prog. 24.
  • Organ | Load/assign stand-by organ 5 - prog. 25.
  • Organ | Load/assign stand-by organ 6 - prog. 26.
  • Organ | Load/assign stand-by organ 7 - prog. 27.
  • Organ | Load/assign stand-by organ 8 - prog. 28.
  • Combinations | Save combinations with an automatic filename - prog. 37.
  • Combinations | Load/assign stand-by comb. file 1 - prog. 29.
  • Combinations | Load/assign stand-by comb. file 2 - prog. 30.
  • Combinations | Load/assign stand-by comb. file 3 - prog. 31.
  • Combinations | Load/assign stand-by comb. file 4 - prog. 32.
  • Combinations | Load/assign stand-by comb. file 5 - prog. 33.
  • Combinations | Load/assign stand-by comb. file 6 - prog. 34.
  • Combinations | Load/assign stand-by comb. file 7 - prog. 35.
  • Combinations | Load/assign stand-by comb. file 8 - prog. 36.
  • Combinations | Advance registration sequencer frame - prog. 38.
  • Combinations | Decrement registration sequencer frame - prog. 39.
  • Combinations | Re-activate current registration sequencer frame - prog. 40.
  • Combinations | Go to start of registration sequencer bank 1 - prog. 41.
  • Combinations | Go to start of registration sequencer bank 2 - prog. 42.
  • Combinations | Go to start of registration sequencer bank 3 - prog. 43.
  • Combinations | Go to start of registration sequencer bank 4 - prog. 44.
  • Combinations | Go to start of registration sequencer bank 5 - prog. 45.
  • Combinations | Go to start of registration sequencer bank 6 - prog. 46.
  • Combinations | Go to start of registration sequencer bank 7 - prog. 47.
  • Combinations | Go to start of registration sequencer bank 8 - prog. 48.
  • Temperament | Equal temperament - prog. 53.
  • Temperament | Original organ tuning - prog. 54.
  • Temperament | Load/assign stand-by temperament 1 - prog. 49.
  • Temperament | Load/assign stand-by temperament 2 - prog. 50.
  • Temperament | Load/assign stand-by temperament 3 - prog. 51.
  • Temperament | Load/assign stand-by temperament 4 - prog. 52.
  • Functions | Reset - prog. 55.
  • Functions | Clear transposer - prog. 63.
  • Functions | Increment transposer by one semitone - prog. 61.
  • Functions | Decrement transposer by one semitone - prog. 62.
  • Functions | Clear master tuning - prog. 60.
  • Functions | Increment master tuning by one percent of a semitone - prog. 58.
  • Functions | Decrement master tuning by one percent of a semitone - prog. 59.
Note that there are more menu functions which can be controlled by MIDI (see the General settings | Menu functions activated by switch (MIDI) inputs screen for the full list); only those configured by default are listed above. Many menu functions may take a few seconds to complete, so you should allow for this when playing.

Note also that capture mode is configured to be controlled by MIDI note-on/off messages by default so that its piston must physically be held in to keep Hauptwerk in capture mode, thus preventing accidental erasing of combinations or menu stand-by assignments; see below.


System state indicators

If you have additional indicator lamps to show Hauptwerk's system states on the console, for the default configuration they should be wired to receive MIDI note-on/off messages on MIDI channel 6 with the following note numbers:
  • MIDI and audio active - note 36.
  • Sample set ready - note 37.
  • Sample set loading - note 38.
  • System error - note 39.
  • Audio output being recorded - note 40.
  • Capture mode (combination setter) - note 41.

LCD panels

By default no LCD panels are configured in order to minimise the time taken for activation and deactivation. However, you can configure LCD settings yourself if you wish to use LCD panel output from Hauptwerk. Please consult the MIDI output section for the MIDI system exclusive message format used.

If you require a full set of default LCD panel configuration, please contact Crumhorn Labs for support.


Setter/capture piston

One of the most important switches to include on a console is the setter/capture switch. We recommend using a momentary push-button (piston) which sends a MIDI note-on message as you press it in, and a MIDI note-off message as it springs back out. Thus it is almost impossible to overwrite combinations or menu stand-by assignments accidentally, since Hauptwerk will only be in capture mode whilst the piston is physically held in.

For the default configuration, the MIDI note-on/off messages should have the following MIDI channel and note number:
  • Capture mode: note-on/off, channel 7, note 56.
If your MIDI encoder for channel 7 (the utility pistons channel in the default configuration) is set to produce MIDI program change messages instead of MIDI note-on/off messages, then you can easily change the message type or channel (input path) with the General settings | Switch (MIDI) inputs screen. Locate the 'Util: comb capture mode' object in the browse list and change the engaging and disengaging message details.

Important: note that, because Hauptwerk's menu functions can only be triggered when a switch input is engaged (not when it is disengaged), it is necessary to have two switch input objects: one to enter capture mode and one to leave it, even though they may both represent the same physical MIDI button. Thus it is the engaging event for each that must be used, but in opposite ways, whilst the disengaging event for each should be set to 'Automatic'. Look at how the two default switch inputs are configured to clarify this point.

If separate MIDI pistons are used to enter capture mode and leave it, then the configuration is more logical, but there is a much greater risk of acccidentally leaving the system in capture mode since you would not need to hold the piston in physically.


Visit Crumhorn Labs on the Internet
© Crumhorn Labs Ltd 2001-2008

Hauptwerk, Hauptwerk virtual pipe organ, Crumhorn Labs and the Crumhorn Labs and Hauptwerk logos are trademarks of Crumhorn Labs Ltd.