ODF format specification

[ilyasivkov]

Hi,

Where can I found an ODF file specification? I know that it is complex, but I want to add crescendo to my CODM organ.

Thanks, Ilya.

[B. Milan]

Hello Ilya,

The CODM does not currently support crescendo pedals in Hauptwerk version 3.

You can view the full format ODF for the included St. Anne's which contains a crescendo pedal. This covers all of the required steps for you to incorporate these settings into your file if you are working in the full definition format, however it would not apply for the CODM. You would need to add any crescendo settings to the resulting ODF that Hauptwerk generates when loading the CODM file in Hauptwerk.

I would suggest that you perhaps wait for Hauptwerk 4 before going to in depth into crescendo settings as you may find some new and useful features which will save you time.

[ilyasivkov]

Hi,

I know that it is complex, but it is interested to do it.

I have made a very simple organ (in HW1 format) and Hauptwerk had generated a full ODF. I have made next steps:

• Added new Continuous controller

  Code: Select all

  <o><a>100</a><b>02 Crescendo pedal</b><c>300</c><d>Y</d><e>Y</e><h>Y</h><i>Y</i><j>25</j></o>
  

• Added new ContinuousControlStageSwitch

  Code: Select all

  <o><a>Crescendo stage 01</a><b>100</b><c>12</c><d>501</d></o>
  <o><a>Crescendo stage 02</a><b>100</b><c>48</c><d>502</d></o>
  <o><a>Crescendo stage 03</a><b>100</b><c>84</c><d>503</d></o>
  <o><a>Crescendo stage 04</a><b>100</b><c>120</c><d>504</d></o>
  

• Added new Switch

  Code: Select all

  <o><a>501</a><b>Cresc Stage 01</b><g>N</g><h>N</h></o>
  <o><a>502</a><b>Cresc Stage 02</b><g>N</g><h>N</h></o>
  <o><a>503</a><b>Cresc Stage 03</b><g>N</g><h>N</h></o>
  <o><a>504</a><b>Cresc Stage 04</b><g>N</g><h>N</h></o>
  
  <o><a>411</a><b>CrescPdSubbs16</b><g>N</g><h>N</h></o>
  <o><a>412</a><b>CrescGtPrincp8</b><g>N</g><h>N</h></o>
  <o><a>413</a><b>CrescGtOktave4</b><g>N</g><h>N</h></o>
  <o><a>414</a><b>CrescSwCopula8</b><g>N</g><h>N</h></o>
  <o><a>415</a><b>CrescSwTremlnt</b><g>N</g><h>N</h></o>
  
  <o><a>501011</a><b>Comb prog switch 501011</b><g>N</g><h>N</h><i>Y</i><k>501011</k><l>2</l><m>1</m></o>
  <o><a>501012</a><b>Comb prog switch 501012</b><g>N</g><h>N</h><i>Y</i><k>501012</k><l>2</l><m>1</m></o>
  <o><a>501013</a><b>Comb prog switch 501013</b><g>N</g><h>N</h><i>Y</i><k>501013</k><l>2</l><m>1</m></o>
  <o><a>501014</a><b>Comb prog switch 501014</b><g>N</g><h>N</h><i>Y</i><k>501014</k><l>2</l><m>1</m></o>
  <o><a>501015</a><b>Comb prog switch 501015</b><g>N</g><h>N</h><i>Y</i><k>501015</k><l>2</l><m>1</m></o>
  

• Added new Combination

  Code: Select all

  <o><a>401</a><b>Crescendo 1</b><c>501</c><f>N</f></o>
  <o><a>402</a><b>Crescendo 2</b><c>502</c><f>N</f></o>
  <o><a>403</a><b>Crescendo 3</b><c>503</c><f>N</f></o>
  <o><a>404</a><b>Crescendo 4</b><c>504</c><f>N</f></o>
  

• And the last, CombinationElement

  Code: Select all

  <o><a>309</a><b>401</b><c>411</c><g>501011</g></o>
  <o><a>310</a><b>401</b><c>412</c><g>501012</g></o>
  <o><a>311</a><b>401</b><c>413</c><g>501013</g></o>
  <o><a>312</a><b>401</b><c>414</c><g>501014</g></o>
  <o><a>313</a><b>401</b><c>415</c><g>501015</g></o>
  

All switches are displayed (I also added image sets and instances - it is easy), but turning Crescendo and it's switches have no effect.

WHY?

[mdyde]

Hello Ilya,

Very sorry - I'm afraid we don't provide support for the full organ definition format, except to major sample set producers (since the format is very complex and often takes a lot of time and assistance to master). We do have a format reference guide available for licensed Hauptwerk users. I just had a quick look in our sales database and I didn't find a record of you having a licence, but if you do (e.g. under a different email address), or if you buy one, please then just contact us by email and we can send you the guide. (The guide covers, amongst many other things, how to de-compress ODF XML files, which is also covered in this topic: http://forum.hauptwerk.com/viewtopic.php?f=13&t=8125.)

However, as Brett mentioned, I too would strongly advise instead just waiting for the forthcoming Hauptwerk v4 (which we're working very hard to have released soon), since that will natively allow you to have crescendos with your CODM organs.

Hope that helps to some degree.

[Morse]

Hello Ilya,

Until now, I was the only one crazy enough to try and add crescendo pedals to completed organ ODFs. Hauptwerk ver4 does have a crescendo capability that will probably satisfy most users, so I agree with Brett that you should wait for it before expending too much time on your own.

However, since you seem determined, here a few pointers. First, you need to uncompact the ODF so that you can see what you are working on. Then I think you should run my Crescendo utility on your ODF and observe all the statements that it adds to the ODF. There are a lot of them. Most of your questions will be answered by looking at such an example. You can get my Crescendo utility from my website on the "Gourmet Hauptwerk" page. http://almorse.net

But really, unless you don't have enough to do, I don't think this effort is worth your time.

[sable]

Hi,

I saw the following quote:

[...] We do have a format reference guide available for licensed Hauptwerk users.[...]

Is the ODF format reference guide, for Hauptwerk 4, available to registered users? I'd like to play with things that are not possible to do with CODM (building a real crescendo, etc.).

Thanks.

[mdyde]

Hello Sable,

I've sent you a private email with the details.

[sable]

I've sent you a private email with the details.

Thanks, Martin. This is so great!

[wos]

Hello,

I would like to create an ODF for HW4. Where can I get a documentation of the CODM format?

regards
Wolfgang

[mdyde]

Hello Wolfgang,

You can find the full format specification in the CODM user's guide, which is on the Help menu in Hauptwerk.

Some example CODM organ definitions are also installed with Hauptwerk to get you started, which the guide covers too.

[wos]

Hello Martin,

ExampleCustomOrgan1.Organ_Hauptwerk_xml is too complex for CODM-Beginners.

I can't find a description for the ObjecType "TextInstance" or "TextStyle" for example in the [Custom Organ Design Module user guide]...

I do not know what the following means: "<o><a>3</a><e>5</e><k>39</k><c>4</c><j>Y</j><l>Y</l>"
I suppose that this is a compressed notation? Is this a generated file?

You wrote in this Topic:

(which covers the 'full' non-CODM ODF format and is intended for sample set producers, sent on request only).

Can I get this document?


Best regards
Wolfgang

[mdyde]

Hello Wolfgang,

You're looking at a compiled, 'full-format' organ definition file (ODF), not the CODM ODF. The CODM ODFs, which you need to look at and use as a basis for your own CODM ODFs, are located in the following folder:

[Hauptwerk installation folder]/HauptwerkUserData/CustomOrganDefinitions

(The 'full' compiled ODF format isn't meant to be user-editable, whereas CODM ODFs are specifically designed to be fairly easy and quick to learn and use.)

If you have a read through the CODM user's guide, it covers in full how CODM ODFs are meant to be used and compiled.

[wos]

I see. Ok, thank you Martin.

[wos]

Hello Martin,

I would like to develop a tool for create a Hauptwerk-ODF with all options. I want to support the full set of commands for Hauptwerk4 (not a subset with CODM). Is it possible that I can have the documentation of the full ODF format?

Best regards
Wolfgang

[B. Milan]

Hello Wolfgang,

I've sent you an email regarding this.