From 8c8570ea75f374163c0a40bd3c004b091eb0ae9a Mon Sep 17 00:00:00 2001
From: Darell Chua Yun Da <darell27@gmail.com>
Date: Fri, 10 Dec 2021 05:33:09 +0800
Subject: [PATCH] Updating Descriptions

---
 src/AmpEnvelopeSelect.m             |  8 ++++++++
 src/DarellAmplitudeEnvelope.m       | 11 +++++++++++
 src/DarellAnneLinearPitchEnvelope.m | 15 +++++++++++++++
 src/DarellAnnePitchEnvelope.m       |  1 +
 src/DarellbandpassFilter.m          | 12 ++++++++++++
 src/Equalizer_Darell.m              | 11 +++++++++++
 src/FilterSelect.m                  |  8 ++++++++
 src/PitchEnvelopeSelect.m           |  8 ++++++++
 src/SoundGeneratorSelect.m          |  8 ++++++++
 9 files changed, 82 insertions(+)

diff --git a/src/AmpEnvelopeSelect.m b/src/AmpEnvelopeSelect.m
index 1492f51..885204a 100644
--- a/src/AmpEnvelopeSelect.m
+++ b/src/AmpEnvelopeSelect.m
@@ -1,3 +1,11 @@
+%Written by Darell 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+%Pass-through function used by app
+
 function output = AmpEnvelopeSelect(input, Fs, attack,decay,sustain,release,number)
     if(number == "Option 1")
         output = DarellAmplitudeEnvelope(input, Fs, attack,decay,sustain,release);
diff --git a/src/DarellAmplitudeEnvelope.m b/src/DarellAmplitudeEnvelope.m
index 985c347..f3036ff 100644
--- a/src/DarellAmplitudeEnvelope.m
+++ b/src/DarellAmplitudeEnvelope.m
@@ -1,3 +1,14 @@
+%Written by Darell
+%Creates a Linear Amplitude Envelope 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+% fs is the sampling frequency
+% attack, decay, release are in percentages of the period
+% sustain is in the percentage of amplitude
+
 function output = DarellAmplitudeEnvelope(input, Fs, attack,decay,sustain,release) %percentages for attack, decay, sustain, release
     len = length(input);
     T = (len-1)/Fs;
diff --git a/src/DarellAnneLinearPitchEnvelope.m b/src/DarellAnneLinearPitchEnvelope.m
index 4cf61f6..7893537 100644
--- a/src/DarellAnneLinearPitchEnvelope.m
+++ b/src/DarellAnneLinearPitchEnvelope.m
@@ -1,4 +1,19 @@
 %Written by Darell and Anne
+%If there is a frequency of 200Hz:
+%1. it needs to ramp up a frequency from 0Hz to the 200Hz over the attack time
+%2. It needs to ramp down to a set sustained frequency over the decay time e.g. 160Hz < 200Hz
+%3. It maintains this 160Hz until the release time
+%4. Release time: It decays from 160Hz further all the way back to 0Hz. 
+%This envelope uses linear calculations
+
+% CONTRIBUTORS:
+% Person1: Darell
+% Person2: Anne
+
+% DOCUMENTATION:
+% fs is the sampling frequency
+% attack, decay, release are in percentages of the period
+% sustain is in the percentage of amplitude
 
 function output = DarellAnneLinearPitchEnvelope(input, Fs, attack,decay,sustain,release) %percentages for attack, decay, sustain, release
     len = length(input);
diff --git a/src/DarellAnnePitchEnvelope.m b/src/DarellAnnePitchEnvelope.m
index dc147f6..4287eba 100644
--- a/src/DarellAnnePitchEnvelope.m
+++ b/src/DarellAnnePitchEnvelope.m
@@ -1,4 +1,5 @@
 %Written by Darell and Anne
+%This envelope uses linear calculations
 
 function output = DarellAnnePitchEnvelope(input, Fs, attack,decay,sustain,release) %percentages for attack, decay, sustain, release
     len = length(input);
diff --git a/src/DarellbandpassFilter.m b/src/DarellbandpassFilter.m
index fd23c4b..c271137 100644
--- a/src/DarellbandpassFilter.m
+++ b/src/DarellbandpassFilter.m
@@ -1,3 +1,15 @@
+%Written by Darell 
+%uses fourier transform to get the series of all signals
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+% fs is the sampling frequency
+% y is the signal input
+% LOW and HIGH are used for the band of frequency
+% MEDIUM IS NOT USED
+
 function output_y = DarellbandpassFilter(y,Fs,LOW,MED,HIGH)
     Len = length(y);
     F = Fs * (-Len/2 : (Len/2 - 1))/Len ;
diff --git a/src/Equalizer_Darell.m b/src/Equalizer_Darell.m
index 1d9e5df..7d36f76 100644
--- a/src/Equalizer_Darell.m
+++ b/src/Equalizer_Darell.m
@@ -1,3 +1,14 @@
+%Written by Darell 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+% fs is the sampling frequency
+% input is the signal input
+% EQplot is the curve generated by the EQ in the app. it should look like /----\ when everthing is set to 1 
+
+
 function output = Equalizer_Darell(input,EQplot,Fs)
 %It's an EQ written by Darell
 %   Split into frequencies and multiply by EQ 
diff --git a/src/FilterSelect.m b/src/FilterSelect.m
index 1fb7596..cc37307 100644
--- a/src/FilterSelect.m
+++ b/src/FilterSelect.m
@@ -1,3 +1,11 @@
+%Written by Darell 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+%Pass-through function used by app
+
 function output = FilterSelect(input,Fs,LOW,MED,HIGH,number)
     if(number == "Option 1")
         output = DarellbandpassFilter(input,Fs,LOW,MED,HIGH);
diff --git a/src/PitchEnvelopeSelect.m b/src/PitchEnvelopeSelect.m
index 7cd04c5..997d30f 100644
--- a/src/PitchEnvelopeSelect.m
+++ b/src/PitchEnvelopeSelect.m
@@ -1,3 +1,11 @@
+%Written by Darell 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+%Pass-through function used by app
+
 function output = PitchEnvelopeSelect(input, Fs, attack,decay,sustain,release,number)
     if(number == "Option 1")
         output = DarellAnnePitchEnvelope(input, Fs, attack,decay,sustain,release);
diff --git a/src/SoundGeneratorSelect.m b/src/SoundGeneratorSelect.m
index b964821..df0c711 100644
--- a/src/SoundGeneratorSelect.m
+++ b/src/SoundGeneratorSelect.m
@@ -1,3 +1,11 @@
+%Written by Darell 
+
+% CONTRIBUTORS:
+% Person1: Darell
+
+% DOCUMENTATION:
+%Pass-through function used by app
+
 function output = SoundGeneratorSelect(amplitude, frequency, phase, fs, duration, duty,number)
     if(number == "Option 1")
         output = generate_sine(amplitude, frequency, phase, fs, duration, duty);