adjust parameter names

Author: frett27

README.md

@@ -10,7 +10,7 @@ This **library** provides a **synthetizer** for making music from samples (.wav
 
 
 
-The Synthetizer take on one side the samples, and on the other side the Notes to play. Each Wav can be reused for multiple play. 
+The Synthetizer takes on one side the samples, and on the other side the Notes to play. Each Wav can be reused for multiple play. 
 
 
 
@@ -34,17 +34,19 @@ The API now works on Windows and Linux (Rpi). A conditional compilation, dependi
 
 Implementing your own file format reading is possible in populating the **SoundSample** type. Additional contribution can permit to handle more input file format.
 
-#### Synthetizer capabilities
+#### Synthetizer capabilities 
 
-- 0.05 ms lattency for the moment, suitable for a lot of applications
+- Real Time Playing and Offline Playing
 - The max number of voice depends on the hardware provided, there is no hardcoded limitations, one can change the **MAX_VOICES** constant, and see whether it match the requierments. (As the number of polyphonie is increased, the processing may be heavier and can lead to increase the jitter and buffer sizes).
 - Parametrized volume for each playing sound.
 - Resampling : currently Nearest neighborhood algorithm (can be improved)
+- Variable Output frequency, permit to adjust CPU consumption
 
 #### Current Drivers
 
 - Win32 SoundDriver
-- Alsa SoundDriver
+- Alsa SoundDriver (*nix platforms)
+- PCM 16 bit Wav Output, using a cross plateform.
 
 
 Can be extended outside the library, depending on needs. Theses drivers show how to implement one.
@@ -58,62 +60,58 @@ Below, an example of the use of the synthetizer in 5 mins:
 
 
 ```pascal
- procedure Test_Open_And_Play_A_Sample(T : in out Test_Case'Class) is
-
-    use Synth.Synthetizer;
-      S : Synthetizer_Type;
-      D : Synth.Driver.Sound_Driver_Access;
-      Sample : Synth.SoundSample;
-      Sample2 : Synth.SoundSample;
-      V,V1 : Voice;
-   begin
-
-      Put_Line("Load the Sound Driver, from WIN32/Linux driver");
-      Synth.Driver.Open (Driver => D);
-      
-      Put_Line("Open the synth");
-      Open (D => D, S => S);
-      
-      Put_Line("Load the sample test.wav");
-
-      Synth.Wav.Load ("test-files/test.wav", Sample);
-      Synth.Wav.Load ("test-files/test.wav", Sample2);
-
-      Sample.Note_Frequency := 440.0; -- the sample is a A, 440 Hz
-
-      Put_Line("Play Sound");
-      Play(Synt         => S,
-           S            => Sample,
-           Frequency    => 440.0,
-           Channel      => 1,
-           Opened_Voice => V1);
+ 
+with Synth.Driver;
+with Synth.Wav;
+
+with Synth;use Synth;
+with Synth.Synthetizer;use Synth.Synthetizer;
+
+with Ada.Text_IO;use Ada.Text_IO;
+
+
+procedure Test_Play is
+   Device : Driver.Sound_Driver_Access;
+   Sample : SoundSample;
+   S : Synthetizer_Type;
+   V : Voice;
+
+begin
+
+   -- Default Driver, opening, using the
+   -- default 44100 Khz output
+   Synth.Driver.Open (Device);
+
+   Put_Line("Load wav");
+   Synth.Wav.Load(FileName => "test-files/test.wav",
+                  Sample => Sample);
 
-      -- wait a bit to ear the 1st sound
-      delay 0.5;
+   Sample.Note_Frequency := MIDICode_To_Frequency(65);
+   Sample.Cant_Stop := false;
 
-      Sample2.Note_Frequency := 440.0;
-      Put_Line("Play Sound");
+   Put_Line("Open synth");
+
+   Open(Driver_Access => Device,
+        Synt => S);
+
+   Put_Line("Play sound " & Integer'Image(Sample.Mono_Data'Length));
+
+   for I in 0..10 loop
       Play(Synt         => S,
-           S            => Sample2,
-           Frequency    => 880.0,  -- play the second sample at a +1 Octave
-           Channel      => 1,
+           S            => Sample,
+           Frequency    => MIDICode_To_Frequency(65 + I),
            Opened_Voice => V);
-      Put_Line("Stop the Voice :" & Voice'Image(V1));
-      
-      -- stop the 1st sample, given the Opened Voice
-      Stop(Synt => S, Opened_Voice => V1);
+      delay(0.3);
+      Stop(S, V);
+   end loop;
 
-      -- wait to ear the 2nd sample
-      delay 2.0;
+   delay(3.0);
 
+   Close(Synt => S);
 
-      S.Close;
 
-   exception
-            when E : others =>
-               Synth.DumpException(E);
+end;
 
-   end;
 ```
 
 
@@ -122,8 +120,6 @@ Below, an example of the use of the synthetizer in 5 mins:
 
 The synthetizer behave nicely, there are no large amount or synchro between components. Playing Midi file is really amazing, and the quality for a first shot is quite interessing, be can be improved.
 
-CPU consumption is not large, but on typical computer, process priority has to be upgraded to populate the sound buffer.
-
 
 
 ## Next actions
@@ -133,21 +129,22 @@ Version 0.1:
 - ~~Fix Memory Leak for Win32 driver~~
 - ~~Eval portaudio for output rendering (X Plateform sound toolkit)~~
 - ~~Add Alsa Driver for linux plateforms~~
-- Add Wav Driver for debugging purpose or to disk exports
-- Interfaçing with C, Java for consuming the library
+- ~~Add Wav Driver for debugging purpose or to disk exports~~
+- Ahead of time playin
 
 Version 0.2: 
 
-- Improving Sound quality, add filters
+- Improving Sound quality, add numeric filters, and additional effects
+- Digital Signal processing : Permit to have Low / High Bandwidth filters, Compressors, Volume regulation, FadeIn / FadeOut
+- Lattency detection, permitting to have both online and offline playin
+
+Mid Term Version :
 
-Version 0.3:
+- Interfaçing with C, Java for consuming the library
 
 - Porting to Spark, remove the task part for embedded usage
 
-  ​
 
 ### Areas That can be covered next (if time permit)
 
-Digital Signal processing : Permit to have Low / High Bandwidth filters, Compressors, Volume regulation, FadeIn / FadeOut
-
 FM generators : The current buffers are filled with Wav samples, but a short abstraction can be done to introduce signal generators and modulators to extends the use to "analog like" synthetizers.

src/synth-synthetizer.adb

@@ -28,17 +28,17 @@ package body Synth.Synthetizer is
    ----------
 
    procedure Open
-     (D : Driver.Sound_Driver_Access;
-      S :    out Synthetizer_Type;
+     (Driver_Access : Driver.Sound_Driver_Access;
+      Synt :    out Synthetizer_Type;
       Buffer_Size : Natural := Natural (0.05 * 44_100.0 / 2.0);
       Buffers_Number : Positive := 1)
    is
    begin
 
       --  human perceived sound within 0.05 s
 
-      S := new Synthetizer_Structure_Type;
-      S.Init (D             => D,
+      Synt := new Synthetizer_Structure_Type;
+      Synt.Init (D            => Driver_Access,
               NBBuffer => Buffers_Number,
               Buffer_Length => Buffer_Size);
 
@@ -51,9 +51,9 @@ package body Synth.Synthetizer is
    -- Close --
    -----------
 
-   procedure Close (S : in out Synthetizer_Type) is
+   procedure Close (Synt : in out Synthetizer_Type) is
    begin
-      S.Close;
+      Synt.Close;
    exception
       when E : others =>
          DumpException (E);
@@ -306,7 +306,7 @@ package body Synth.Synthetizer is
              * 1_000_000.0 / Long_Float (Task_Driver_Frequency)));
 
          --  must be late in the pipeline,
-         --  TODO: change it
+         --  TODO: improve it
          Last_Clock := Clock - 10 * Task_Buffer_Number * Time_Jitter; -- attention
 
          Init_Clock := Last_Clock;
@@ -746,12 +746,12 @@ package body Synth.Synthetizer is
    function "/"(f : Play_Second; f2 : Float) return Play_Second is
    begin
       return f / Play_Second (f2);
-   end;
+   end "/";
 
    function "*"(f : Play_Second; f2 : Float) return Play_Second is
    begin
       return f * Play_Second (f2);
-   end;
+   end "*";
 
    --  forward
    procedure Internal_Process_Buffer (VSA : Voice_Structure_Type;

src/synth-synthetizer.ads

@@ -69,13 +69,13 @@ package Synth.Synthetizer is
 
    --  open the synth device
    procedure Open
-     (D : Driver.Sound_Driver_Access;
-      S :    out Synthetizer_Type;
+     (Driver_Access : Driver.Sound_Driver_Access;
+      Synt :    out Synthetizer_Type;
       Buffer_Size : Natural := Natural (0.05 * 44_100.0 / 2.0);
       Buffers_Number : Positive := 1);
 
    --  close the synth
-   procedure Close (S : in out Synthetizer_Type);
+   procedure Close (Synt : in out Synthetizer_Type);
 
    ----------
    -- Play --

src/synth.ads

@@ -46,6 +46,8 @@ package Synth is
 
       Mono_Data : Frame_Array_Access;
 
+      -- if can't stop is true, the sound will be played
+      -- until the end (can't be stopped)
       Cant_Stop : Boolean;
 
       case HasLoop is