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 and computer keyboard input


Although you can operate virtual controls with the mouse once a sample set is loaded, Hauptwerk is primarily played and controlled by MIDI. Except for menu items that require a file selection or prompt, all menu items can also be triggered by MIDI. You can also set up short-cut keys on your computer keyboard to trigger virtual controls and menu items.

Once installed and configured, Hauptwerk can thus operate fully without a computer monitor, mouse or keyboard, allowing it to be integrated into a MIDI organ console or voice expander, and also allowing full control from a MIDI sequencer or other device.

The Advanced Edition of Hauptwerk can also produce MIDI output to control external MIDI organ console controls (such as solenoid-actuated draw-knobs), status lamps, real external pipework, voice expanders and LCD panels to label controls appropriately for the sample set loaded, all of which are covered in the MIDI output section.

This section will give an overview of the MIDI input configuration and the corresponding setting screens. We will not describe all of the individual settings on those screens here, since comprehensive documentation is available for each setting and screen by clicking on the pointer/question-mark icon immediately to the left of a screen's OK button:

Question-mark help


... then clicking onto the screen background or a specific setting for a detailed explanation of its function.

This section is mainly applicable for using Hauptwerk as stand-alone software. If you are using it with a sequencer (as a VST plug-in or otherwise), then, apart from adjusting the MIDI input port selections, the default configuration installed with Hauptwerk will usually be appropriate.

With all settings screens, the lists of objects are shown in the left-hand panes, and the current objects' details are shown on the right. Use the Insert and Delete buttons to create or delete objects. You cannot delete an object if other screens reference it; you must first go to the referencing screen(s) and delete all such referencing objects; see the settings screens section for more details.

Important: The set of objects installed initially with Hauptwerk are simply examples, so you can delete or adjust them to suit your MIDI hardware and software. If your MIDI configuration differs substantially from the defaults, you may prefer to delete all of the objects on the various input settings screens and then recreate them all from scratch.

For stand-alone use, the General settings menu input screens describe the physical MIDI hardware that you have and wish to use with Hauptwerk:

General settings menu


The Organ settings menu input screens then describe how that physical hardware should be mapped to the virtual controls present in the sample set currently loaded. A different mapping can be stored for each sample set:

Organ settings menu


In almost all cases, the screens under the Organ settings menu show one object in the browse list for each equivalent virtual object in the sample set that you currently have loaded. In the right-hand pane you can then select the input object by which you wish it to be controlled, or 'none' if you do not wish it to be controlled remotely. As an example, look at the Connect keyboard MIDI inputs to organ keyboards screen:

Connect keyboard MIDI inputs to organ keyboards


There is an entry in the left-hand browse pane for each virtual keyboard provided by the sample set loaded (St. Anne's, Moseley).

Important: It is essential to understand the distinction between the General settings and the Organ settings menus: the screens and their settings found under the General settings menu are mainly used to define your MIDI and audio hardware and apply to all sample sets. For example you would use the General settings | Keyboard MIDI inputs screen to list the MIDI keyboards you have attached to the computer. The default settings are just defaults; update or rename them to reflect your own hardware (or software) with which Hauptwerk will be used. The Organ settings menu instead stores settings that are specific to whichever sample set is currently loaded. Changing a setting on one of its screens only affects that sample set. The Organ settings menu is mainly used to map the virtual organ's controls to your hardware. For example, the Organ settings | Connect keyboard MIDI inputs to organ keyboards screen allows you to select which of your MIDI keyboards (that you defined on the General settings | Keyboard MIDI inputs screen) you want to map/connect to which of the virtual organ keyboards provided by the sample set. Thus configuring Hauptwerk is a two-stage process: first list/configure your MIDI hardware via the General settings menu, then load each sample set and use the screens on the Organ settings menu to map your hardware to the corresponding virtual organ objects.


MIDI input paths

All of Hauptwerk's MIDI input is configured in terms of MIDI input paths, which are simply an abstraction of the combination of a computer MIDI input port and MIDI channel together, given a meaningful name. For each distinct combination of MIDI input port and MIDI channel that you wish to use to feed MIDI data to Hauptwerk you should create a single MIDI input path object using the General settings | MIDI input paths screen:

MIDI input paths


Ensure that you have one MIDI input path object for each distinct combination of MIDI input port and channel that your hardware or sequencer will use. There are no restrictions on which MIDI channels and ports can be used to control any of Hauptwerk's virtual controls. For example, if you have MIDI draw-knobs, you can arrange it so that each sends MIDI messages on any port and channel that is convenient.

However, as explained in the section on the transposer section, note that the transposer is applied at the MIDI input path level, so you may prefer not to mix MIDI keyboards and switches on the same port/channel combination if you intend to use the transposer.

If it helps to clarify that MIDI input paths are nothing more than an abstraction of MIDI port and channel, assuming you are just using one MIDI input port, simply rename each input path entry according to the MIDI channel selected for it. For example, since MIDI channel 2 is selected by default for the path whose default name is 'Keyboards: div 2 (Great)', change the name of that path from 'Keyboards: div 2 (Great)' to 'MIDI channel 2'. Repeat for each of the others. For consistency, you might then want to insert additional entries for the remainder of the 16 possible MIDI channels.


Keyboard MIDI inputs

Use the General settings | Keyboard MIDI inputs screen to list each MIDI keyboard from which you wish to play Hauptwerk:

Keyboard MIDI inputs


For example, if you have two MIDI keyboards and a MIDI pedalboard, then ensure that objects are listed for the three, and that the correct Input path is selected for the MIDI input port and MIDI channel used by each keyboard. Delete any objects that you will not be using.

The MIDI event type/value settings should always be set to 'Normal' unless you are configuring a 'second touch' theatre organ manual; see the question-mark help for more details.

It is important to set the Default organ keyboard setting appropriately, since it is used to define the initial mappings to a sample set's virtual keyboards whenever a sample set is loaded for the first time.

The Organ settings | Connect keyboard MIDI inputs to organ keyboards screen is used to adjust the mapping between input keyboards and virtual keyboards for a sample set if the default mapping (determined by the Default organ keyboard setting) is not appropriate:

Connect keyboard MIDI inputs to organ keyboards



Re-directable keyboard MIDI inputs

The re-directable inputs allow you to control more virtual keyboards than you have physical MIDI keyboards. You can connect at most two MIDI keyboards in this way, and flip them between virtual keyboards using the Functions | Select route N for re-directable keyboard M menu functions. Four possible 'routes' (virtual keyboards) are allowed from each re-directable keyboard. See the re-directable inputs section for further details.

Use the General settings | Re-directable keyboard MIDI inputs screen to define which, if any, MIDI keyboards you have which you would like to use in this way:

Re-directable keyboard MIDI inputs


If you do not wish to use any MIDI keyboards as re-directable inputs, simply set the Input path to 'none' for both objects.

The Organ settings | Connect re-directable keyboard MIDI inputs to organ keyboards screen is used to define how each of the four routes for each of the two re-directable keyboards are to be connected to virtual keyboards, and thus which virtual keyboards can be controlled from each of the two possible re-directable keyboards:

Mapping re-directable keyboards



Continuous control MIDI inputs

Use the General settings | Continuous control MIDI inputs screen to list all MIDI continuous controllers you have and with which you wish to control Hauptwerk's virtual continuous controls:

Continuous control MIDI inputs


See the virtual console section for an explanation of Hauptwerk's virtual continuous controls. Most commonly they are used to represent swell and crescendo pedals. The most common type of MIDI continuous controllers used with Hauptwerk are MIDI expression pedals.

Set the Controller number to match the MIDI continuous controller number sent by the MIDI device. The most common controller numbers are:
  • 1 - Modulation wheel.
  • 4 - Foot controller.
  • 6 - Data entry control.
  • 7 - Main volume.
Again, you should ensure that the Default organ control is specified when possible, so that the MIDI controller is automatically mapped to the sample set's appropriate virtual continuous control when a sample set is loaded for the first time.

Some electronic organ consoles have expression pedals that do not cover the full 0-127 range of MIDI controller values. You can use the Minimum value and Maximum value settings to stretch the ranges of such controls to cover the full range.

The Organ settings | Connect continuous control MIDI inputs to organ continuous controls screen is used to adjust the mapping between input continuous controls and virtual continuous controls for a sample set if the default mapping (determined by the Default organ control setting) is not appropriate:

Mapping continuous controls



Switch (MIDI) inputs

Use the General settings | Switch (MIDI) inputs screen to list all MIDI buttons/switches and computer keys that you have and with which you wish to control Hauptwerk's virtual switch controls (such as virtual draw-knobs and pistons) and to delete any objects that are not relevant for your hardware:

Switch (MIDI) inputs


You need to specify the message that your hardware switch sends when it is engaged (the 'engaging event') and when it is disengaged (the 'disengaging event'). Any message type and MIDI input path can be used for either, with no restrictions.

Note that for MIDI note-on/off messages the Event number setting specifies the MIDI note number, with numbering starting from zero. For MIDI program change messages it specifies the program number, with numbering starting from one.

If your MIDI switch (or computer key) sends a message only as you press it down, and not when it is released, as is usual for push-buttons/pistons, then set the the disengaging event type to 'automatic', so that Hauptwerk will keep its logical representation of the switch synchronised with the state of the physical switch. Do not tick Engaging event toggles? for such buttons.

Engaging event toggles? exists to cater for one special and unusual MIDI implementation situation only. It should be ticked if and only if:
  • your MIDI switch changes state physically (e.g. it is a mechanical or illuminated draw-knob or tab), and
  • it remains in that state (it is 'latching'), and
  • it sends exactly the same MIDI message when your turn it on to when you turn it off.
One particular manufacturer of digital organ uses this MIDI implementation, but we know of no other cases.

As with keyboard MIDI inputs and continuous control MIDI inputs, it is important to specify the Default organ switch setting when possible, since it greatly simplifies configuration of each new sample set loaded.

The Organ settings | Connect switch (MIDI) inputs to organ switches screen is used to adjust the mapping between input switches and virtual switches for a sample set if the default mapping (determined by the Default organ switch setting) is not appropriate:

Mapping switch inputs


See also the question-mark help for the Effect when engaged/disengaged settings:

Question-mark help


See the MIDI implementation section for a list of computer key codes.


Menu functions activated by switch (MIDI) inputs

Use the General settings | Menu functions activated by switch (MIDI) inputs screen to connect your MIDI switches or computer keys to Hauptwerk's menu functions, so that they can be triggered remotely:

Menu functions activated by switch (MIDI) inputs


You cannot insert or delete objects in this screen, since the object list always shows the list of all menu functions that allow remote triggering. For each menu function, either select the switch (MIDI) input that you wish to use, or select 'none' if you do not wish to control it remotely. Note that you can select up to four switch (MIDI) inputs to trigger any given menu function. This might be useful, for example, for registration sequencer controls, where you might want a toe piston and a thumb piston both to be able to trigger the 'next frame' function.

The menu function is always triggered as the switch input is engaged, and never when it is disengaged.


Rank MIDI inputs

The General settings | Rank MIDI inputs screen allows you to feed MIDI input directly into Hauptwerk's virtual pipe ranks, bypassing its virtual keyboards, key actions, couplers and so forth. It thus allows you to use Hauptwerk like a simple multi-timbral voice expander, with each rank responding directly on a separate MIDI channel:

Rank MIDI inputs


There is no default mapping setting for the ranks, so you must map them manually with Organ settings | Connect rank MIDI inputs to organ ranks.


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.