EMD 567C-16 F9PH Non Turbo (Roots) 1500HP

 EMD 16-567C F9PH        11/16/2013
    DN0_4chnl_x6_F9PH.SPJ Version 1.4
SDF:  DN0_4chnl_x6_F9PH
BASE CODE:    DN0_4chnl_x6 -- Discrete Notching,  4 Channel, SDF Ver 2
SOUND SET:    EMD 16-567C F9PH
CHANNELS:    4
SERIES:        6

Author:  John McMasters    Custom sound scheme. Sept 25, 2013 NOT for resale.
    (C) Copyright John McMasters 2013, used with permission.

EMD 16-567C F9PH
 ----------------------------------------------------------------------------
     INTRODUCTION
  ----------------------------------------------------------------------------
   This is the Sound Definition Langauge (SDL) file for a project that can be
   used for a typical diesel locomotive. Supported
   sound effects include bell, dynamic brakes, air brake system,
   and coupler crash.
 

  ----------------------------------------------------------------------------
     DESIGN NOTES
  ----------------------------------------------------------------------------
NOTE:
CV155    Notching mode should(must) be =1: 0 = Auto, 1 = Semi auto, 2 = Manual [1]    
    Features:
    Discrete notching with transitions
    Auto coupler/coupler slack sounds
    Auto braking with variations; Moving manual brakes; Hand brake or Dynamics
    Auto distance event (grade crossing) option
    Directional Toots option
    Multiple air sounds
    Bell and Horn Selector
    Sander
    Wheel/track sounds
    Boxcar boom and other user defined sounds
    Selectable notch 1-8 control
    Estop is a motor control; startup motor interlock
    Operator can select AUX with F19 to turn on the auxiliary diesel generator for passenger consists.
    Configuration CV for option disables
    Series 6 extended features are exploited (additional CV range above 155, Xplay long sounds)

    Changes:
    1) interlock scatter events for when motor disabled 6/10/2013
    2) fix bug notch acceleration comparison to us NOTCH_MASK to only compare bits0-7
    3) fixed waver on volt change 6/30/2013
    4) fix coupler slack when not moving 6/30/2013
    5) adjust running volume 7/1/2013
     6)    Replaced     ;; #INCLUDE    "C:\SPJ_Projects\sdn136\SERIES6_SND_MACS.INC" WITH
         #INCLUDE    "C:\SPJ_Projects\sdn136\SERIES6_snd16_macs.inc" for handles greater than 64 7/26/2013
    7)     disable motor run during start sounds -- WKSB_RUN_MASK,MERGE_ALL_MASK
        ;set the RUN bit to enable 7/24/2013
    8)     Maximise running volume: MASTER VOLUME CV58 SHOULD BE LESS THAN 60% OF
        MAX (about=8) . CV140 PRIME_VOLUME SHOULD LESS THAN about 60 7/27/2013
    9)    Normalize sounds 8/5/2013
    10)    Fix HEP interlock missing tests 8/6/2013
    11)     Revise CV extended list 8/7/2013
    12)    Remove RUNUP_INTERLOCK 8/9/2013
    13)    Activate bit2 disable startup 9/18/2013
    14)    Reverted to cv132 notch rate of =127 default 10/7/2013
    15)    Replace _DIESEL_9/15/2013
    16)    Remove decelerate to stop routine 9/16/2013
    17)    F3 OFF directional toots 9/22/2013
    18)    F15-SANDER F16-MISC  USER CHATTER 9/23/2013
    19)    Final Copyright 9/23/2013
    20)     Modify runup, inc_12 10/5/2013
    21)     Re-write NOTCH_VALUE0_9, all discreet notching routines 10/7/2013
    22)     Revise NOTCH_VALUE0_9 transitions AND RUN IN 2-8 IDLE only run1 10/10/2013
    23)    Removed Decrease to idle and  revise IDLE/not moving Phase
    24)    Move EStop to F8 on with F9 on 10/22/2013 (EStop will disable motor movement) F8 alone will just mute sounds.
    25)    Skip startup sounds when F8 is already on 10/22/2013
    26)    Play hand brake on F5 when stopped (remove F11 for other functions)
    27)    Move F13 to F11
    28)    Revise EStop on with F14
    29)    Revise Horn and bell timing 10/30/2013
    30)    On transition from idle notch up when delte = 0     11/4/2013 []ncrease to run]
    31)    Brake lock out motor on F9 stopped    11/7/2013
    32)    Revise volume levels by -20 11/7/2013
    33)    Add bell select CV157 [SCV_157_SEL_BELL]    11/7/2013    BELL, GRADE CROSSING
    34)    Remove HEP and add AUX routines    11/15/2013
;    35)     Initial idle trim CV167    fix 11/25/2013

    Objectives:
     1) Use 4 channels (voices) avoiding previous version
        interruptions.
    2) Assign large 44KHz 16bit sound samples for best
        audio results
    3) optional startup sounds disable when F0 is on
    4) Feature disable CV169 is HEX values to disable features like HEP mode:
        bit0 disable HEP diesel ARTICULATED steam
        bit1 disable hard automatic braking
        bit2 disable startup sounds
        bit3 disable Fans
        bit4 disable toots on direction change    
        bit5 disable grade crossing random play
        bit6 disable bell    
        bit7 fuel prime once for Gen1 diesels OR
             multiple start warning bells Gen2
    6) F21-F28 Select Notch 1-8
 
 ----------------------------------
      FUNCTION KEYS DEFINED:   
 ----------------------------------
(A) Function Key Usage:  
F0-     Lights  [disables startup sounds when on during initialization]
F1-     Bell
F2-     Horn    CV150 selects Horn type    ( 0=normal 2=playable default 0)            
F3-        Auto Coupler    coupler clank and BRAKE if F3 is ON,  is dir chng and last PK spd below e.g. CV151
                 [Autocoupler/brake set by  CV151 max spd] F15 on for un-coupler
                 [Leave F3 on for auto coupler]    
    Toggle OFF plays directional toots
F4-        Air features disable  F4 is ON =disable AIR sound/FEATURES, trig BLOWOFF/drier then compressor ONE time
                     [F4 off enables pop-off, drier and compressor]
F5-     Dynamic brake fans    [Handbrake while stopped.  Handbrake loop will PLAY until F5 Off]     
F6-     Notch UP    If CV155 is not 00 F6 is ON  trig BLOWOFF/drier then compressor ONE time /NOTCH UP...
             IF any manual notching: F6 is NOTCH UP and F7 is NOTCH DOWN!!
F7-     Notch down    [If CV155 is not 00 F7 is CROSSING HORN WHEN
                 AUTOMATIC notching selected in SCV155=0]
             F7 ON Is now notch down for EVENT, integrate -VE in SPEED_DELTA
F8-     Mute control    [F8 to ON is muted to cv volume, F8 off, set REG volume]
F9-     Brake squeal    [Leave F9 on for auto brakes]
F10-     Grade crossing horn sequence    [Bell stays on until F10 off]
F11-    UNCoupling     (disables toots on F3)
F12-    Wheel Squeal    (continuous when moving) [Disables bell on F6]
F13-     
F14-    EStop Shutdown    (disables motor movement until OFF)
F15-    SANDER
F16-    MISC  USER CHATTER
F17-    BoxCar Boom
F18-     MISC  USER SND
F19-    Enables AUX generator
F20-    MISC  USER SND
F21-F28 Select Notch 1-8 7/17/2013

(B) Diesel Sound FX defined CV's:     [decoder CV8=8  reset value in brackets]
CV58  Master Volume, 0-15, 0= max, (F8 used for Mute) [7]
CV60  Scheme select CV, 0=Steam/Diesel    [0]
CV122 Product TYpe, 12 = Digitrax SFX sound decoder Read Only Value
CV123 Hardware Version        Read Only Value
CV132 Diesel Notch rate        64-127    [64]
CV133 Steam Chuff/CAM config, 128=>EXT cam, 1-127=>DRIVER dia in inches[63]
CV134 Steam gear ratio trim, 32=100% ratio,    [32]
CV135 Volume when Muted                0-64    [0]
CV139 Set to trigger distance event    0-64    [30]
CV140 Prime Mover Volume            0-64     [58]
CV141 Bell Volume                    0-64    [52]
CV142 Horn Volume                     0-64    [61]
CV143 AIR feature volume, drier, compressor, brake release Air sounds Volume 0-64 [59]
CV144 Dynamic brake volume 0-64 DIESEL DYNAMIC brake volume     [60]
CV145 Miscellaneous volume 0-64    [58]
CV146 Delay between Bells 1-100    [04]
CV147 Time between Drier cycles Users normally reset drier rate to 10 or more    [22]
CV148 Time between Compressor cycles    [30]
CV149 Compressor run time                [24]
CV150 HORN selector 0=normal 2=playable    [0]
CV151 Speed limit FOR AUTOMATIC COUPLER/BRAKE on DIR chng. about 1/2MPH per unit [38]
CV152 defines USER code for this SDF
CV153 SUB id  SCHEME/SDF
CV154 STEAM blowdown volume    [45]
CV155 fact default is AUTO NOTCHING; CV54 needs to be zero for F7 Notch UP  [1]
CV156 is 540mS HORN delay for SHORT    [1] slows horn attack
CV157 is FOR bell selection         [00]
CV158 is
CV159 is
CV160 is VARIANT id
CV161    Power Reverser volume    0-64    [50]
CV162      Grate Shaker Volume        0-64    [50]
CV163    Water fill/Coal fill Volume    0-64    [54]
CV164    Compressor Volume        0-64    [48]
CV165    Steam Boiler Volume/Diesel Fan Volume    0-64    [35]
CV166    Coupler Slack Volume    0-64    [32]
CV167     Initial Idle Trim         0,16,32    [16] {IS hex 0x00 notch1, 0x10 notch2, 0x20 notch3}
CV168   Stoker Volume            0-64    [51]
CV169 is HEX values to disable features like HEP mode:
;                        bit0 disable ARTICULATED steam HEP diesel OR GEN1 Transition sounds
;                        bit1 disable hard automatic braking
;                        bit2 disable startup sounds
;                        bit3 disable Fans
;                        bit4 disable toots on direction change    
;                        bit5 disable grade crossing random play
;                        bit6 disable bell                
;                        bit7 fuel prime once for Gen1 diesels OR multiple start warning bells Gen2
CV170 Safety Run Time    0-64    [22]
CV171 ALT HORN volume    0-64    [60]
CV172 Water Pump Cycle Time        0-64     [31]
CV173 Cutoff Speed for Auto Cyl. blow down        0-64    [22]
CV174 Air Compressor run time        0-255    [31]
CV175 Stoker/oil pump run time        0-255    [18]        
CV176 F28_user run time scattered sounds    0-255    [20]
   
=================================
(C) General Notes

This is a functional tested version of a project using individual sound recordings for each prime mover notch setting. These
prime mover sounds can be played in three modes determined by CV155: automatic, semi-automatic and manual notching. In auto
mode, the prime mover notch is determined by the current speed setting, and is adjustable using CV132. In semi-auto mode,
the same is true but it is possible to "throttle up" to higher notches using F6 and F7, if you want your engine to sound
like it is working harder. Manual mode offers full control of the notch setting using F6 and F7, so you can throttle down
to idle and turn on dynamic braking while coasting downgrade.

Other features available in this project include:
- Automatic grade crossing horn sequence with bell
- Optional highball and backup horn signals while stopped
- Dynamic brakes at speed or standing
- handbrake while stopped
- Automatic coupler sounds when changing direction at low speeds
- Automatic brake squeal sounds when decelerating to a stop
- Manual brake squeal on F9 and moving
- Additional user-defined sounds on F14 and F15

This sound project has been assembled from Digitrax-supplied sound clips as well as new sounds from custom recordings.
Additional custom 16bit 44KHz files were used to edit individual sound fragments (WAV files for each file handle).
It will be a copyrighted project on acceptance by Digitrax.
Thanks are due to A.J. Ireland for their prior work in developing sound projects.

** Switching speed is enabled by setting CV 54 to 1 with back EMF or 3 without back EMF

For CV155=01 ["Semi_automatic Notching"],  the Prime mover lowest Notch setting is set by
 the throttle speed setting. F6 (ON) can increase the Notch and F7 (ON) will decrease the
 Prime mover to the minimum notch set by current throttle setting.

The sound volume is controlled by Master Volume CV58 as well as any individual sound
volume CVs.  The Default for CV58 is 5 but can be set 0-15 from a Throttle or the sim-
ulated throttle in SoundLoader.  Individual sound volume CVs can be set 0-64.


Problems and exceptions:
 NOTCH RATE (CV132)
  Default is CV132=127 but that bunches the notches at the lower portion
  of the throttle range.  64-127 or higher is OK when your motor takes very little current.
  A value of 71 will spread the notches across the whole range, but may leave your
  engine moving too fast. It should run at scale speeds and notch.
 
------[end SDF/DECODER definition]--------------