Initial build of track sounds

Author: peternewell

Source/Orts.Formats.Msts/RouteFile.cs

@@ -86,9 +86,9 @@ public Tr_RouteFile(STFReader stf)
                 new STFReader.TokenProcessor("routestart", ()=>{ if (RouteStart == null) RouteStart = new RouteStart(stf); }),
                 new STFReader.TokenProcessor("environment", ()=>{ Environment = new TRKEnvironment(stf); }),
                 new STFReader.TokenProcessor("milepostunitskilometers", ()=>{ MilepostUnitsMetric = true; }),
-				new STFReader.TokenProcessor("electrified", ()=>{ Electrified = stf.ReadBoolBlock(false); }),
+                new STFReader.TokenProcessor("electrified", ()=>{ Electrified = stf.ReadBoolBlock(false); }),
                 new STFReader.TokenProcessor("overheadwireheight", ()=>{ OverheadWireHeight = stf.ReadFloatBlock(STFReader.UNITS.Distance, 6.0f);}),
- 				new STFReader.TokenProcessor("speedlimit", ()=>{ SpeedLimit = stf.ReadFloatBlock(STFReader.UNITS.Speed, 500.0f); }),
+                 new STFReader.TokenProcessor("speedlimit", ()=>{ SpeedLimit = stf.ReadFloatBlock(STFReader.UNITS.Speed, 500.0f); }),
                 new STFReader.TokenProcessor("defaultcrossingsms", ()=>{ DefaultCrossingSMS = stf.ReadStringBlock(null); }),
                 new STFReader.TokenProcessor("defaultcoaltowersms", ()=>{ DefaultCoalTowerSMS = stf.ReadStringBlock(null); }),
                 new STFReader.TokenProcessor("defaultdieseltowersms", ()=>{ DefaultDieselTowerSMS = stf.ReadStringBlock(null); }),
@@ -127,6 +127,9 @@ public Tr_RouteFile(STFReader stf)
                 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); }),
+                new STFReader.TokenProcessor("ortsconcretesleepers", ()=>{ ConcreteSleepers = stf.ReadFloatBlock(STFReader.UNITS.None, null); }),
            });
             //TODO This should be changed to STFException.TraceError() with defaults values created
             if (RouteID == null) throw new STFException(stf, "Missing RouteID");
@@ -175,6 +178,11 @@ public Tr_RouteFile(STFReader stf)
         public float ForestClearDistance = 0;
         public bool RemoveForestTreesFromRoads = false;
 
+        // Track based sounds
+        public bool TrackSoundDefaultContinuousPlay = false;
+        public float DistanceBetweenTrackJointsM;
+        public float ConcreteSleepers;
+
         // images
         public string Thumbnail;
         public string LoadingScreen;

Source/Orts.Formats.Msts/SoundManagmentFile.cs

@@ -163,6 +163,8 @@ public TrainCar LastCar
         public bool HuDIsWheelSlip;
         public bool IsBrakeSkid;
 
+        public bool TrackJointSoundSetUpInitialise = true;
+
         public bool HotBoxSetOnTrain = false;
         public int ActivityDurationS
         {
@@ -2009,6 +2011,84 @@ public virtual void Update(float elapsedClockSeconds, bool auxiliaryUpdate = tru
                 LogTrainSpeed(Simulator.ClockTime);
             }
 
+            // Initialise track joint trigger points. Sets the trigger point for the track joint reletative to other cars.
+            // This is then reset every time a track joint is triggered, and positioned the same distance apart, hence reletative positions are maintained.
+            // Only runs once at start up.
+            if (TrackJointSoundSetUpInitialise && (float)Simulator.TRK.Tr_RouteFile.DistanceBetweenTrackJointsM > 0 && Simulator.TRK.Tr_RouteFile.TrackSoundDefaultContinuousPlay)
+            {
+                var trackjointdistanceM = (float)Simulator.TRK.Tr_RouteFile.DistanceBetweenTrackJointsM;
+                var trainLengthM = 0.0f;
+                var cummulativeTrackJointDistanceM = 0.0f;
+                var remainDistanceM = (float)Simulator.TRK.Tr_RouteFile.DistanceBetweenTrackJointsM;
+
+                foreach (var car in Cars)
+                {
+                    // Initialise from the next track joint
+
+                    // if remain distance has gone negative then car has moved over the next track joint
+                    if (trackjointdistanceM > car.CarLengthM)
+                    {
+
+                        car.realTimeTrackJointDistanceM = cummulativeTrackJointDistanceM;
+                        trainLengthM += car.CarLengthM;
+                        cummulativeTrackJointDistanceM += car.CarLengthM;
+                        remainDistanceM -= car.CarLengthM;
+
+                        // Set values for printing values initially applied
+                        bool concretesleepers = false;
+
+                        if ((float)Simulator.TRK.Tr_RouteFile.ConcreteSleepers == 1)
+                        {
+                            concretesleepers = true;
+                        }
+
+                        if (Simulator.Settings.VerboseConfigurationMessages && Simulator.TRK.Tr_RouteFile.TrackSoundDefaultContinuousPlay)
+                        {
+                            Trace.TraceInformation("======================================================================================================================");
+                            Trace.TraceInformation("TType Track Sounds Initialisation - Concrete Sleepers = {0}, Track Joint Distance = {1} m", concretesleepers, (float)Simulator.TRK.Tr_RouteFile.DistanceBetweenTrackJointsM);
+                        }
+
+                        // the next track joint has been reached reset all parameters in preparation for the next pass
+                        if (remainDistanceM < 0.0f)
+                        {
+                            cummulativeTrackJointDistanceM = Math.Abs(remainDistanceM);
+                            remainDistanceM = trackjointdistanceM - cummulativeTrackJointDistanceM;
+                        }
+
+                    }
+                    // Trackjoint less then Car length 
+                    else if (trackjointdistanceM < car.CarLengthM)
+                    {
+                        car.realTimeTrackJointDistanceM = cummulativeTrackJointDistanceM;
+                        trainLengthM += car.CarLengthM;
+                        cummulativeTrackJointDistanceM += trackjointdistanceM;
+                        remainDistanceM -= car.CarLengthM;
+
+                        if (remainDistanceM < 0.0f)
+                        {
+
+                            while (Math.Abs(remainDistanceM) > trackjointdistanceM)
+                            {
+                                remainDistanceM += trackjointdistanceM;
+                            }
+
+                            cummulativeTrackJointDistanceM = Math.Abs(remainDistanceM);
+                            remainDistanceM = trackjointdistanceM - cummulativeTrackJointDistanceM;
+                        }
+                    }
+
+                    if (Simulator.Settings.VerboseConfigurationMessages && Simulator.TRK.Tr_RouteFile.TrackSoundDefaultContinuousPlay)
+                    {
+                        Trace.TraceInformation("CarID {0}, Dist from Joint = {1} m, Car Length = {2} m, Train Length = {3} m, Axle Count = {4}", car.CarID, car.realTimeTrackJointDistanceM, car.CarLengthM, trainLengthM, car.SoundAxleCount);
+                    }
+
+                }
+
+                Trace.TraceInformation("======================================================================================================================");
+
+                TrackJointSoundSetUpInitialise = false;
+            }
+
         } // end Update
 
         //================================================================================================//

Source/Orts.Simulation/Simulation/Physics/Train.cs

@@ -1890,7 +1890,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);
@@ -1947,7 +1947,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();