comparison hsedit.cpp @ 5:5f3c32dc6e17

* Adjust comment syntax to permit Doxygen to generate HTML documentation; add Doxyfile

 //---------------------------------------------------------------------------
 
 #include "hsedit.h"
 #include "splines.h"
 
+/** \file hsedit.h */
+
 //---------------------------------------------------------------------------
 
-/*
+/**
   function DeFM: frequency de-modulation
 
   In: peakfr[npfr]: segmentation into FM cycles, peakfr[0]=0, peakfr[npfr-1]=Fr-1
       a1[Fr], f1[Fr]: sequence of amplitudes and frequencies
       arec[Fr]: amplitude-based weights for frequency averaging

   CubicSpline(npfr-1, aa, ab, ac, ad, frs, a, 1, 1, a2);
   CubicSpline(npfr-1, fa, fb, fc, fd, frs, f, 1, 1, f2);
   delete[] frs;
 }//DeFM
 
-/*
+/**
   function DFMSeg: segments HS frames into FM cycles
 
   In: partials[M][Fr]: HS partials
   Out: peakfr[npfr]: segmentation, peakfr[0]=0, peakfr[npfr-1]=Fr-1.
        arec[Fr]: total amplitudes of frames

   }
   peakfr[npfr++]=Fr-1;
   delete[] frec;
 }//DFMSeg
 	
-/*
+/**
   function HSAM: harmonic sinusoid amplitude modulation
 
   In: SrcHS: source harmonic sinusoid
       dep: modulation depth
       fre: modulator frequency

   for (int m=0; m<HS->M; m++)
     for (int fr=0; fr<HS->Fr; fr++)
       HS->Partials[m][fr].a=SrcHS->Partials[m][fr].a*(1+dep*cos(omg*SrcHS->Partials[m][fr].t+ph));
 }//HSAM
 
-/*
+/**
   function HSFM: harmonic sinusoid frequency modulation
 
   In: SrcHS: source harmonic sinusoid
       a: modulation extent, in semitones
       fre: modulator frequency

   for (int m=0; m<HS->M; m++)
     for (int fr=0; fr<HS->Fr; fr++)
       HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*(1+pa*cos(omg*SrcHS->Partials[m][fr].t+ph));
 }//HSFM
 
-/*
+/**
   function HSFM_SF: harmonic sinusoid frequency modulation with source-filter model
 
   In: SrcHS: source harmonic sinusoid
       a: modulation extent, in semitones
       fre: modulator frequency

     HS->Partials[m][fr].f=f1;
     HS->Partials[m][fr].a=SrcHS->Partials[m][fr].a*exp(SF->LogAF(f1)-SF->LogAF(f0));
   }
 }//HSFM_SF
 
-/*
+/**
   function: HSPitchShift: harmonic sinusoid pitch shifting
 
   In: SrcHS: source harmonic sinusoid
       ps12: amount of pitch shift, in semitones
   Out: HS: destination harmonic sinusoid

 {
   double pa=pow(2, ps12/12.0);
   for (int m=0; m<HS->M; m++) for (int fr=0; fr<HS->Fr; fr++) HS->Partials[m][fr].f=SrcHS->Partials[m][fr].f*pa;
 }//HSPitchShift
 
-/*
+/**
   function ReFM: frequency re-modulation
 
   In: partials[M][Fr]: HS partials
       amount: relative modulation depth after remodulation
       rate: relateive modulation rate after remodulation