comparison quickspec.cpp @ 5:5f3c32dc6e17

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

 
 #include <math.h>
 #include <memory.h>
 #include "quickspec.h"
 
-
-//---------------------------------------------------------------------------
-/*
+/** \file quickspec.h */
+
+//---------------------------------------------------------------------------
+/**
   method TQuickSpectrogram::TQuickSpectrogram:
 
   In: AParent: pointer argument for calling G, if G is specified
       AnId: integer argument for calling G, if G is specified
       G: pointer to a function that supplies buffers used for FFT, 0 by default

 	free8(fwin);
   free(fhbi);
 }//~TQuickSpectrogram
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::A: accesses amplitude spectrogram by frame
 
   In: fr: frame index, 0-based
 
   Returns pointer to amplitude spectrum of the fr'th frame, NULL if N/A

   if (Frame[fr]<0 || !Valid[fr]) CalculateSpectrum(fr);
   return fA[Frame[fr]];
 }//A
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::AddBuffer: increases internal buffer by BufferSize frames. Allocated buffers
   beyond Capacity frames will not be indexed or used by TQuickSpectrogram.
 */
 void TQuickSpectrogram::AddBuffer()
 {

     else break;
   }
   BufferCount++;
 }//AddBuffer
 
-/*
+/**
   method TQuickSpectrogram::AddBuffer: increase internal buffer by a multiple of BufferSize so that
   it will be enough to host another AddFrCount frames.
 */
 void TQuickSpectrogram::AddBuffer(int AddFrCount)
 {
   while (FrCount+AddFrCount>BufferSize*BufferCount) AddBuffer();
 }//AddBuffer
 
 //---------------------------------------------------------------------------
-/*
+/**
   function IntToDouble: copy content of integer array to double array
 
   In: in: pointer to integer array
       BytesPerSample: number of bytes each integer takes
       Count: size of integer array, in integers

   if (BytesPerSample==1){unsigned char* in8=(unsigned char*)in; for (int k=0; k<Count; k++) *(out++)=*(in8++)-128.0;}
   else if (BytesPerSample==2) {__int16* in16=(__int16*)in; for (int k=0; k<Count; k++) *(out++)=*(in16++);}
   else {__pint24 in24=(__pint24)in; for (int k=0; k<Count; k++) *(out++)=*(in24++);}
 }//IntToDouble
 
-/*
+/**
   function CalculateSpectrum: calculate spectrum of a signal in integer format
 
   In: Data[Wid]: integer array hosting waveform data
       BytesPerSample: number of bytes each integer in Data[] takes
       win[Wid]: window function used for computing spectrum

     Amp[j]=sqrt(x[j].x*x[j].x+x[j].y*x[j].y);
     if (Arg) Arg[j]=(x[j].y==0 && x[j].x==0)?0:atan2(x[j].y, x[j].x);
   }
 }//CalculateSpectrum
 
-/*
+/**
   function CalculateSpectrum: calculate spectrum of a signal in integer format, allowing the signal
   length $eff be shorter than the DFT size Wid.
 
   In: Data[eff]: integer array hosting waveform data
       BytesPerSample: number of bytes each integer in Data[] takes

   }
   else
     CalculateSpectrum(Data, BytesPerSample, win, Amp, Arg, Wid, w, x, hbi);
 }//CalculateSpectrum
 
-/*
+/**
   method TQuickSpectrogram::CalculateSpectrum: computes spectrogram at fr'th frame.
 
   In: fr: index to the frame whose spectrum is to be computed. fr must be between 0 and Capacity-1.
 */
 void __fastcall TQuickSpectrogram::CalculateSpectrum(int fr)

   //tag this frame as computed and valid
   Valid[fr]=1;
 }//CalculateSpectrum
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::FreeBuffers: discards all computed spectra and free all internal buffers.
   This returns the TQuickSpectrogram to its initial state before any frame is accessed. After calling
   FreeBuffers() all frames will be recomputed when they are accessed.
 */
 void TQuickSpectrogram::FreeBuffers()

     if (usex) {free(fSpec); fSpec=0;}
   }
 }//FreeBuffers
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Invalidate: renders all frames that have overlap with interval [From, To],
   measured in samples, as invalid. Invalid frames are recomputed when they are accessed again.
 
   In: [From, To]: an interval spectrogram over which needs to be updated.
 

   }
   return result;
 }//Invalidate
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Ph: accesses phase spectrogram by frame
 
   In: fr: frame index, 0-based
 
   Returns pointer to phase spectrum of the fr'th frame, NULL if N/A

   if (Frame[fr]<0 || !Valid[fr]) CalculateSpectrum(fr);
   return fPh[Frame[fr]];
 }//Ph
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::SetFrCapacity: sets the capacity, i.e. the maximal number of frames handled
   by this TQuickSpectrogram.
 
   In: AnFrCapacity: the new Capacity, in frames
 

   }
   Capacity=AnFrCapacity;
 }//SetFrCapacity
 
 //---------------------------------------------------------------------------
-/*
+/**
   method TQuickSpectrogram::Ph: accesses complex spectrogram by frame
 
   In: fr: frame index, 0-based
 
   Returns pointer to complex spectrum of the fr'th frame, NULL if N/A