Initial addition of advanced track sounds

Author: peternewell

Source/Orts.Formats.Msts/RouteFile.cs

@@ -123,6 +123,8 @@ public Tr_RouteFile(STFReader stf)
                 new STFReader.TokenProcessor("ortscurvesmsnumber", ()=>{ CurveSMSNumber = stf.ReadIntBlock(null); }),
                 new STFReader.TokenProcessor("ortscurveswitchsmsnumber", ()=>{ CurveSwitchSMSNumber = stf.ReadIntBlock(null); }),
                 new STFReader.TokenProcessor("ortsopendoorsinaitrains", ()=>{ OpenDoorsInAITrains = stf.ReadBoolBlock(false); }),
+                new STFReader.TokenProcessor("ortsplaytracksoundsbasecontinuous", ()=>{ TrackSoundDefaultContinuousPlay = stf.ReadBoolBlock(false); }),
+                new STFReader.TokenProcessor("ortsdistancebetweentrackjoints", ()=>{ DistanceBetweenTrackJointsM = stf.ReadFloatBlock(STFReader.UNITS.Distance, null); }),
 
            });
             //TODO This should be changed to STFException.TraceError() with defaults values created
@@ -151,6 +153,8 @@ public Tr_RouteFile(STFReader stf)
         public string DefaultSignalSMS;
 		public float TempRestrictedSpeed = -1f;
         public Interpolator SuperElevationHgtpRadiusM; // Superelevation of tracks
+        public bool TrackSoundDefaultContinuousPlay = false;
+        public float DistanceBetweenTrackJointsM;
 
         // Values for calculating Tunnel Resistance - will override default values.
         public float SingleTunnelAreaM2; 

Source/Orts.Formats.Msts/SoundManagmentFile.cs

@@ -37,6 +37,9 @@ public class SharedSMSFileManager
         public static int CurveSMSNumber;
         public static int CurveSwitchSMSNumber;
         public static bool AutoTrackSound = false;
+        public static bool PlayDefaultTrackSoundsContinuous = false;
+        public static float DistanceBetweenTrackJointsM;
+        public static bool CarOnSwitch = false;
 
         public static SoundManagmentFile Get(string path)
         {
@@ -198,7 +201,7 @@ public struct CurvePoint
 
     public class VolumeCurve
     {
-        public enum Controls { None, DistanceControlled, SpeedControlled, Variable1Controlled, Variable1_2Controlled, Variable1_3Controlled, Variable1_4Controlled, Variable2Controlled, Variable2BoosterControlled, Variable3Controlled, BrakeCylControlled, CurveForceControlled };
+        public enum Controls { None, DistanceControlled, SpeedControlled, Variable1Controlled, Variable1_2Controlled, Variable1_3Controlled, Variable1_4Controlled, Variable2Controlled, Variable2BoosterControlled, Variable3Controlled, BrakeCylControlled, CurveForceControlled, AngleofAttackControlled, CarFrictionControlled, WheelRpMControlled, TrackJointControlled, SwitchControlled };
 
         public Controls Control = Controls.None;
         public float Granularity = 1.0f;
@@ -222,6 +225,11 @@ public VolumeCurve(STFReader stf)
                 case "variable3controlled": Control = Controls.Variable3Controlled; break;
                 case "brakecylcontrolled": Control = Controls.BrakeCylControlled; break;
                 case "curveforcecontrolled": Control = Controls.CurveForceControlled; break;
+                case "angleofattackcontrolled": Control = Controls.AngleofAttackControlled; break;
+                case "carfrictioncontrolled": Control = Controls.CarFrictionControlled; break;
+                case "wheelrpmcontrolled": Control = Controls.WheelRpMControlled; break;
+                case "trackjointcontrolled": Control = Controls.TrackJointControlled; break;
+                case "switchcontrolled": Control = Controls.SwitchControlled; break;
                 default: STFException.TraceWarning(stf, "Crash expected: Skipped unknown VolumeCurve/Frequencycurve type " + type); stf.SkipRestOfBlock(); return;
             }
             stf.ParseBlock(new STFReader.TokenProcessor[] {
@@ -343,7 +351,7 @@ public Discrete_Trigger(STFReader f)
     public class Variable_Trigger : Trigger
     {
         public enum Events { Speed_Inc_Past, Speed_Dec_Past, Distance_Inc_Past, Distance_Dec_Past,
-        Variable1_Inc_Past, Variable1_2_Inc_Past, Variable1_3_Inc_Past, Variable1_4_Inc_Past, Variable1_Dec_Past, Variable1_2_Dec_Past, Variable1_3_Dec_Past, Variable1_4_Dec_Past, Variable2_Inc_Past, Variable2_Dec_Past, Variable3_Inc_Past, Variable3_Dec_Past, BrakeCyl_Inc_Past, BrakeCyl_Dec_Past, CurveForce_Inc_Past, CurveForce_Dec_Past
+            Variable1_Inc_Past, Variable1_2_Inc_Past, Variable1_3_Inc_Past, Variable1_4_Inc_Past, Variable1_Dec_Past, Variable1_2_Dec_Past, Variable1_3_Dec_Past, Variable1_4_Dec_Past, Variable2_Inc_Past, Variable2_Dec_Past, Variable3_Inc_Past, Variable3_Dec_Past, BrakeCyl_Inc_Past, BrakeCyl_Dec_Past, CurveForce_Inc_Past, CurveForce_Dec_Past, AngleofAttack_Inc_Past, AngleofAttack_Dec_Past, WheelRpM_Dec_Past, WheelRPM_Inc_Past, TrackJoints_Inc_Past, TrackJoints_Dec_Past, CarOnSwitch_Inc_Past, CarOnSwitch_Dec_Past,
         };
 
         public Events Event;
@@ -389,6 +397,14 @@ public Variable_Trigger(STFReader f)
                 case "brakecyl_dec_past": Event = Events.BrakeCyl_Dec_Past; break;
                 case "curveforce_inc_past": Event = Events.CurveForce_Inc_Past; break;
                 case "curveforce_dec_past": Event = Events.CurveForce_Dec_Past; break;
+                case "angleofattack_inc_past": Event = Events.AngleofAttack_Inc_Past; break;
+                case "angleofattack_dec_past": Event = Events.AngleofAttack_Dec_Past; break;
+                case "wheelrpm_inc_past": Event = Events.WheelRPM_Inc_Past; break;
+                case "wheelrpm_dec_past": Event = Events.WheelRpM_Dec_Past; break;
+                case "trackjoints_inc_past": Event = Events.TrackJoints_Inc_Past; break;
+                case "trackjoints_dec_past": Event = Events.TrackJoints_Dec_Past; break;
+                case "caronswitch_inc_past": Event = Events.CarOnSwitch_Inc_Past; break;
+                case "caronswitch_dec_past": Event = Events.CarOnSwitch_Dec_Past; break;
             }
 
 

Source/Orts.Simulation/Simulation/RollingStocks/MSTSWagon.cs

@@ -1863,7 +1863,7 @@ public override void Save(BinaryWriter outf)
 
             outf.Write(WheelBrakeSlideProtectionActive);
             outf.Write(WheelBrakeSlideProtectionTimerS);
-            outf.Write(AngleOfAttackRad);
+            outf.Write(AngleOfAttackmRad);
             outf.Write(DerailClimbDistanceM);
             outf.Write(DerailPossible);
             outf.Write(DerailExpected);
@@ -1920,7 +1920,7 @@ public override void Restore(BinaryReader inf)
 
             WheelBrakeSlideProtectionActive = inf.ReadBoolean();
             WheelBrakeSlideProtectionTimerS = inf.ReadInt32();
-            AngleOfAttackRad = inf.ReadSingle();
+            AngleOfAttackmRad = inf.ReadSingle();
             DerailClimbDistanceM = inf.ReadSingle();
             DerailPossible = inf.ReadBoolean();
             DerailExpected = inf.ReadBoolean();

Source/Orts.Simulation/Simulation/RollingStocks/TrainCar.cs

@@ -204,7 +204,7 @@ public static Interpolator SteamHeatBoilerFuelUsageGalukpH()
         public bool DerailmentCoefficientEnabled = true;
         public float MaximumWheelFlangeAngleRad;
         public float WheelFlangeLengthM;
-        public float AngleOfAttackRad;
+        public float AngleOfAttackmRad;
         public float DerailClimbDistanceM;
         public bool DerailPossible = false;
         public bool DerailExpected = false;
@@ -583,6 +583,9 @@ public Direction Direction
         protected SmoothedData CurveForceFilter = new SmoothedData(0.75f);
         public float CurveForceNFiltered;
 
+        protected SmoothedData CurveSquealAoAmRadFilter = new SmoothedData(0.75f);
+        public float CurveSquealAoAmRadFiltered;
+
         public float TunnelForceN;  // Resistive force due to tunnel, in Newtons
         public float FrictionForceN; // in Newtons ( kg.m/s^2 ) unsigned, includes effects of curvature
         public float BrakeForceN;    // current braking force applied to slow train (Newtons) - will be impacted by wheel/rail friction
@@ -980,6 +983,11 @@ public virtual void Update(float elapsedClockSeconds)
                 CurrentElevationPercent = -CurrentElevationPercent;
             }
 
+            AngleOfAttackmRad = GetAngleofAttackmRad();
+            
+            CurveSquealAoAmRadFilter.Update(elapsedClockSeconds, AngleOfAttackmRad);
+            CurveSquealAoAmRadFiltered = CurveSquealAoAmRadFilter.SmoothedValue;
+
             UpdateCurveSpeedLimit(); // call this first as it will provide inputs for the curve force.
             UpdateCurveForce(elapsedClockSeconds);
             UpdateTunnelForce();
@@ -1693,10 +1701,6 @@ public void UpdateTrainDerailmentRisk(float elapsedClockSeconds)
                     // Calculate Nadal derailment coefficient limit
                     NadalDerailmentCoefficient = ((float) Math.Tan(MaximumWheelFlangeAngleRad) - wagonAdhesion) / (1f + wagonAdhesion * (float) Math.Tan(MaximumWheelFlangeAngleRad));
 
-                    // Calculate Angle of Attack - AOA = sin-1(2 * bogie wheel base / curve radius)
-                    AngleOfAttackRad = (float)Math.Asin(2 * RigidWheelBaseM / CurrentCurveRadiusM);
-                    var angleofAttackmRad = AngleOfAttackRad * 1000f; // Convert to micro radians
-
                     // Calculate the derail climb distance - uses the general form equation 2.4 from the above publication
                     var parameterA_1 = ((100 / (-1.9128f * MathHelper.ToDegrees(MaximumWheelFlangeAngleRad) + 146.56f)) + 3.1f) * Me.ToIn(WheelFlangeLengthM);
 
@@ -1710,7 +1714,7 @@ public void UpdateTrainDerailmentRisk(float elapsedClockSeconds)
 
                     var parameterB = parameterB_1 + parameterB_2;
 
-                    DerailClimbDistanceM = Me.FromFt( (float)((parameterA * parameterB * Me.ToIn(WheelFlangeLengthM)) / ((angleofAttackmRad + (parameterB * Me.ToIn(WheelFlangeLengthM))))) );
+                    DerailClimbDistanceM = Me.FromFt((float)((parameterA * parameterB * Me.ToIn(WheelFlangeLengthM)) / ((AngleOfAttackmRad + (parameterB * Me.ToIn(WheelFlangeLengthM))))));
 
                     // calculate the time taken to travel the derail climb distance
                     var derailTimeS = DerailClimbDistanceM / AbsSpeedMpS;
@@ -1781,6 +1785,25 @@ public void UpdateTrainDerailmentRisk(float elapsedClockSeconds)
 
         #endregion
 
+        /// <summary>
+        /// Get the Angle of attack for a car as it goes through a curve
+        /// </summary>
+        /// <returns>angle in micro radians</returns>
+        /// 
+        public float GetAngleofAttackmRad()
+        {
+            if (CurrentCurveRadiusM > 0)
+            {
+                // Calculate Angle of Attack - AOA = sin-1(2 * bogie wheel base / curve radius)
+                var angleofAttackmRad = (float)Math.Asin(2 * RigidWheelBaseM / CurrentCurveRadiusM) * 1000f; // Convert to micro radians
+                return angleofAttackmRad;
+            }
+            else
+            {
+                return 0;
+            }
+        }
+
         /// <summary>
         /// Get the current direction that curve is heading relative to the train.
         /// </summary>
@@ -2259,6 +2282,7 @@ public virtual void Save(BinaryWriter outf)
             outf.Write(CarHeatCurrentCompartmentHeatJ);
             outf.Write(CarSteamHeatMainPipeSteamPressurePSI);
             outf.Write(CarHeatCompartmentHeaterOn);
+            outf.Write(CurveSquealAoAmRadFiltered);
         }
 
         // Game restore
@@ -2282,6 +2306,8 @@ public virtual void Restore(BinaryReader inf)
             CarHeatCurrentCompartmentHeatJ = inf.ReadSingle();
             CarSteamHeatMainPipeSteamPressurePSI = inf.ReadSingle();
             CarHeatCompartmentHeaterOn = inf.ReadBoolean();
+            CurveSquealAoAmRadFiltered = inf.ReadSingle();
+            CurveSquealAoAmRadFilter.ForceSmoothValue(CurveSquealAoAmRadFiltered);
             FreightAnimations?.LoadDataList?.Clear();
         }
 

Source/RunActivity/Viewer3D/Popups/HUDWindow.cs

@@ -1236,8 +1236,9 @@ void TextPageForceInfo(TableData table)
                 Viewer.Catalog.GetString("Brk Slide"),
                 Viewer.Catalog.GetString("Bear Temp"),
                 Viewer.Catalog.GetString(" "),
-                Viewer.Catalog.GetString("DerailCoeff")
-                
+                Viewer.Catalog.GetString("DrailCof"),
+                Viewer.Catalog.GetString("AoA")
+
                 );
             TableAddLine(table);
 
@@ -1266,6 +1267,7 @@ void TextPageForceInfo(TableData table)
                 TableSetCell(table, 17, "{0} {1}", FormatStrings.FormatTemperature(car.WheelBearingTemperatureDegC, car.IsMetric, false), car.DisplayWheelBearingTemperatureStatus);
                 TableSetCell(table, 18, car.Flipped ? Viewer.Catalog.GetString("Flipped") : "");
                 TableSetCell(table, 19, "{0:F2}{1}", car.DerailmentCoefficient, car.DerailExpected ? "!!!" : car.DerailPossible ? "???" : "");
+                TableSetCell(table, 20, "{0:F2}", car.AngleOfAttackmRad);
                 TableAddLine(table);
 
             }