Merge pull request #37 from ltcptgeneral/DarellsAnnex

Updating Descriptions

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);

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;

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);

src/DarellAnnePitchEnvelope.m

@@ -4,6 +4,7 @@
 %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 logarithmic calculations
 
 % CONTRIBUTORS:
 % Person1: Darell

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 ;

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 

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);

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);

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);