SMS_Header Struct Reference

structure for the header of an SMS file More...

#include <sms.h>

Data Fields
int	iSmsMagic
int	iHeadBSize
int	nFrames
int	iFrameBSize
int	iSamplingRate
int	iFormat
int	nTracks
int	iFrameRate
int	iStochasticType
int	nStochasticCoeff
int	iEnvType
int	nEnvCoeff
int	iMaxFreq
sfloat	fResidualPerc
int	nTextCharacters
char *	pChTextCharacters

---

Detailed Description

structure for the header of an SMS file

This header contains all the information necessary to read an SMS file, prepare memory and synthesizer parameters.

The header also contains variable components for additional information that may be stored along with the analysis, such as descriptors or text.

The first four members of the Header are necessary in this order to correctly open the .sms files created by this library.

iSampleRate contains the samplerate of the analysis signal because it is necessary to know this information to recreate the residual spectrum.

In the first release, the descriptors are not used, but are here because they were implemented in previous versions of this code (in the 90's). With time, the documentation will be updated to reflect which members of the header are useful in manipulations, and what functions to use for these manipulatinos

---

Field Documentation

sfloat SMS_Header::fResidualPerc

percentage of the residual to original

Referenced by sms_initHeader().

int SMS_Header::iEnvType

type of envelope representation

Referenced by sms_fillHeader().

int SMS_Header::iFormat

type of data format

See also:

SMS_Format

Referenced by sms_allocFrameH(), sms_fillHeader(), sms_frameSizeB(), and sms_initHeader().

int SMS_Header::iFrameBSize

size in bytes of each data frame

Referenced by sms_fillHeader(), sms_getFrame(), sms_initHeader(), and sms_writeFrame().

int SMS_Header::iFrameRate

rate in Hz of data frames

Referenced by sms_fillHeader(), sms_initHeader(), and sms_initSynth().

int SMS_Header::iHeadBSize

size in bytes of header

Referenced by sms_getFrame(), sms_initHeader(), sms_writeFile(), and sms_writeHeader().

int SMS_Header::iMaxFreq

maximum frequency of peaks (also corresponds to the last bin of the specEnv

Referenced by sms_fillHeader(), sms_initHeader(), sms_initModify(), and sms_initSynth().

int SMS_Header::iSamplingRate

samplerate of analysis signal (necessary to recreate residual spectrum

Referenced by sms_fillHeader(), and sms_initSynth().

int SMS_Header::iSmsMagic

identification constant

Referenced by sms_initHeader(), and sms_writeHeader().

int SMS_Header::iStochasticType

type stochastic representation

Referenced by sms_allocFrameH(), sms_fillHeader(), sms_frameSizeB(), sms_initHeader(), and sms_initSynth().

int SMS_Header::nEnvCoeff

number of cepstral coefficents per frame

Referenced by sms_allocFrameH(), sms_fillHeader(), sms_frameSizeB(), sms_initHeader(), sms_initModify(), and sms_initSynth().

int SMS_Header::nFrames

number of data frames

Referenced by sms_fillHeader(), and sms_initHeader().

int SMS_Header::nStochasticCoeff

number of stochastic coefficients per frame

Referenced by sms_allocFrameH(), sms_fillHeader(), sms_frameSizeB(), sms_initHeader(), and sms_initSynth().

int SMS_Header::nTextCharacters

number of text characters

Referenced by sms_fillHeader(), sms_initHeader(), sms_writeFile(), and sms_writeHeader().

int SMS_Header::nTracks

number of sinusoidal tracks per frame

Referenced by sms_allocFrameH(), sms_fillHeader(), sms_frameSizeB(), sms_initHeader(), and sms_initSynth().

char* SMS_Header::pChTextCharacters

Text string relating to the sound

Referenced by sms_fillHeader(), and sms_initHeader().

---

The documentation for this struct was generated from the following file:

• /Users/richardeakin/projects/libsms/trunk/src/sms.h