SchedulerCompiler Class Reference

Compile a list of FAUST signals into a vector C++ class. More...

#include <compile_sched.hh>

Inheritance diagram for SchedulerCompiler:

Collaboration diagram for SchedulerCompiler:

Public Member Functions
	SchedulerCompiler (const string &name, const string &super, int numInputs, int numOutputs)
	SchedulerCompiler (Klass *k)
virtual void	compileMultiSignal (Tree L)
Public Member Functions inherited from VectorCompiler
	VectorCompiler (const string &name, const string &super, int numInputs, int numOutputs)
	VectorCompiler (Klass *k)
Public Member Functions inherited from ScalarCompiler
	ScalarCompiler (const string &name, const string &super, int numInputs, int numOutputs)
	ScalarCompiler (Klass *k)
virtual void	compileSingleSignal (Tree lsig)
Public Member Functions inherited from Compiler
	Compiler (const string &name, const string &super, int numInputs, int numOutputs, bool vec)
	Compiler (Klass *k)
virtual	~Compiler ()
Klass *	getClass ()
void	setDescription (Description *descr)
Description *	getDescription ()

Protected Member Functions
virtual void	vectorLoop (const string &tname, const string &dlname, const string &cexp)
	Generate the code for a (short) delay line. More...
virtual void	dlineLoop (const string &tname, const string &dlname, int delay, const string &cexp)
	Generate the code for a (short) delay line. More...
Protected Member Functions inherited from VectorCompiler
virtual string	CS (Tree sig)
	Compile a signal. More...
virtual string	generateCode (Tree sig)
	Main code generator dispatch. More...
virtual void	generateCodeRecursions (Tree sig)
virtual string	generateCodeNonRec (Tree sig)
virtual string	generateLoopCode (Tree sig)
	Compile a signal. More...
virtual string	generateCacheCode (Tree sig, const string &exp)
	Generate cache code for a signal if needed. More...
virtual void	generateDelayLine (const string &ctype, const string &vname, int mxd, const string &exp)
	Generate code for the delay mecchanism without using temporary variables. More...
virtual string	generateVariableStore (Tree sig, const string &exp)
virtual string	generateFixDelay (Tree sig, Tree exp, Tree delay)
	Generate code for accessing a delayed signal. More...
virtual string	generateDelayVec (Tree sig, const string &exp, const string &ctype, const string &vname, int mxd)
	Generate code for the delay mecchanism. More...
virtual string	generateWaveform (Tree sig)
bool	needSeparateLoop (Tree sig)
	Test if a signal need to be compiled in a separate loop. More...
Protected Member Functions inherited from ScalarCompiler
virtual string	forceCacheCode (Tree sig, const string &exp)
string	getFreshID (const string &prefix)
void	compilePreparedSignalList (Tree lsig)
Tree	prepare (Tree L0)
Tree	prepare2 (Tree L0)
bool	getCompiledExpression (Tree sig, string &name)
	Test if a signal is already compiled. More...
string	setCompiledExpression (Tree sig, const string &name)
	Set the string of a compiled expression is already compiled. More...
void	setVectorNameProperty (Tree sig, const string &vecname)
	Set the vector name property of a signal, the name of the vector used to store the previous values of the signal to implement a delay. More...
bool	getVectorNameProperty (Tree sig, string &vecname)
	Get the vector name property of a signal, the name of the vector used to store the previous values of the signal to implement a delay. More...
int	getSharingCount (Tree t)
void	setSharingCount (Tree t, int count)
void	sharingAnalysis (Tree t)
void	sharingAnnotation (int vctxt, Tree t)
string	generateXtended (Tree sig)
	retrieve the type annotation of sig More...
string	generatePrefix (Tree sig, Tree x, Tree e)
string	generateIota (Tree sig, Tree arg)
string	generateBinOp (Tree sig, int opcode, Tree arg1, Tree arg2)
string	generateFFun (Tree sig, Tree ff, Tree largs)
string	generateInput (Tree sig, const string &idx)
string	generateOutput (Tree sig, const string &idx, const string &arg1)
string	generateTable (Tree sig, Tree tsize, Tree content)
string	generateStaticTable (Tree sig, Tree tsize, Tree content)
string	generateWRTbl (Tree sig, Tree tbl, Tree idx, Tree data)
string	generateRDTbl (Tree sig, Tree tbl, Tree idx)
string	generateSigGen (Tree sig, Tree content)
string	generateStaticSigGen (Tree sig, Tree content)
string	generateSelect2 (Tree sig, Tree sel, Tree s1, Tree s2)
	Generate a select2 code. More...
string	generateSelect3 (Tree sig, Tree sel, Tree s1, Tree s2, Tree s3)
	Generate a select3 code (using if-then-else) ((int n = sel==0)? s0 : ((sel==1)? s1 : s2)) int nn; ((nn=sel) ? ((nn==1)? s1 : s2) : s0);. More...
string	generateRecProj (Tree sig, Tree exp, int i)
	Generate code for a projection of a group of mutually recursive definitions. More...
void	generateRec (Tree sig, Tree var, Tree le)
	Generate code for a group of mutually recursive definitions. More...
string	generateIntCast (Tree sig, Tree x)
string	generateFloatCast (Tree sig, Tree x)
string	generateButton (Tree sig, Tree label)
string	generateCheckbox (Tree sig, Tree label)
string	generateVSlider (Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step)
string	generateHSlider (Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step)
string	generateNumEntry (Tree sig, Tree label, Tree cur, Tree min, Tree max, Tree step)
string	generateVBargraph (Tree sig, Tree label, Tree min, Tree max, const string &exp)
string	generateHBargraph (Tree sig, Tree label, Tree min, Tree max, const string &exp)
string	generateNumber (Tree sig, const string &exp)
string	generateFConst (Tree sig, const string &file, const string &name)
string	generateFVar (Tree sig, const string &file, const string &name)
string	generateDelayVecNoTemp (Tree sig, const string &exp, const string &ctype, const string &vname, int mxd)
	Generate code for the delay mecchanism without using temporary variables. More...
void	getTypedNames (Type t, const string &prefix, string &ctype, string &vname)
void	ensureIotaCode ()
	Generate code for a unique IOTA variable increased at each sample and used to index ring buffers. More...
int	pow2limit (int x)
	Compute the minimal power of 2 greater than x. More...
void	declareWaveform (Tree sig, string &vname, int &size)
	Generate code for a waveform. More...
Protected Member Functions inherited from Compiler
void	addIncludeFile (const string &str)
void	addLibrary (const string &str)
void	addUIWidget (Tree path, Tree widget)
	Add a widget with a certain path to the user interface tree. More...
void	generateWidgetCode (Tree fulllabel, Tree varname, Tree sig)
	Generate buildUserInterface C++ lines of code corresponding to user interface widget t. More...
void	generateUserInterfaceTree (Tree t)
	Generate buildUserInterface C++ lines of code corresponding to user interface element t. More...
void	generateUserInterfaceElements (Tree elements)
	Iterate generateUserInterfaceTree on a list of user interface elements. More...
Tree	prepareUserInterfaceTree (Tree t)
	Remove fake root folder if not needed (that is if the UI is completely enclosed in one folder. More...
void	generateMacroInterfaceTree (const string &pathname, Tree t)
	Generate user interface macros corresponding to user interface element t. More...
void	generateMacroInterfaceElements (const string &pathname, Tree elements)
	Iterate generateMacroInterfaceTree on a list of user interface elements. More...
void	generateWidgetMacro (const string &pathname, Tree fulllabel, Tree varname, Tree sig)
	Generate user interface macros corresponding to a user interface widget. More...

Additional Inherited Members
Protected Attributes inherited from ScalarCompiler
property< string >	fCompileProperty
property< string >	fVectorProperty
property< pair< string, string > >	fStaticInitProperty
property< pair< string, string > >	fInstanceInitProperty
Tree	fSharingKey
OccMarkup	fOccMarkup
bool	fHasIota
Protected Attributes inherited from Compiler
Klass *	fClass
bool	fNeedToDeleteClass
Tree	fUIRoot
Description *	fDescription
Static Protected Attributes inherited from ScalarCompiler
static map< string, int >	fIDCounters

Detailed Description

Compile a list of FAUST signals into a vector C++ class.

Definition at line 37 of file compile_sched.hh.

Constructor & Destructor Documentation

SchedulerCompiler::SchedulerCompiler ( const string &  name, const string &  super, int  numInputs, int  numOutputs  )

inline

Definition at line 42 of file compile_sched.hh.

        : VectorCompiler(name,super,numInputs,numOutputs)
        {}

SchedulerCompiler::SchedulerCompiler ( Klass *  k )

inline

Definition at line 46 of file compile_sched.hh.

                                 : VectorCompiler(k)
    {}

Member Function Documentation

void SchedulerCompiler::compileMultiSignal ( Tree  L )

virtual

Reimplemented from VectorCompiler.

Definition at line 30 of file compile_sched.cpp.

References Klass::addExecCode(), Klass::addSharedDecl(), Klass::addZone3(), Klass::buildTasksList(), Klass::closeLoop(), VectorCompiler::CS(), Compiler::fClass, Compiler::fDescription, Compiler::fUIRoot, Compiler::generateMacroInterfaceTree(), Compiler::generateUserInterfaceTree(), hd(), Klass::inputs(), isList(), Klass::openLoop(), Klass::outputs(), ScalarCompiler::prepare(), Compiler::prepareUserInterfaceTree(), subst(), T(), tl(), Description::ui(), xcast(), and xfloat().

{
    //contextor recursivness(0);
    L = prepare(L);     // optimize, share and annotate expression
    
    for (int i = 0; i < fClass->inputs(); i++) {
        fClass->addZone3(subst("$1* input$0 = &input[$0][fIndex];", T(i), xfloat()));
    }
    for (int i = 0; i < fClass->outputs(); i++) {
       fClass->addZone3(subst("$1* output$0 = &output[$0][fIndex];", T(i), xfloat()));
    }
                
    fClass->addSharedDecl("fullcount"); 
    fClass->addSharedDecl("input"); 
    fClass->addSharedDecl("output"); 
    
    for (int i = 0; isList(L); L = tl(L), i++) {
        Tree sig = hd(L);
        fClass->openLoop("count");
        fClass->addExecCode(subst("output$0[i] = $2$1;", T(i), CS(sig), xcast()));
        fClass->closeLoop(sig);
    }
    
    // Build tasks list 
    fClass->buildTasksList();
    
    generateUserInterfaceTree(prepareUserInterfaceTree(fUIRoot));
    generateMacroInterfaceTree("", prepareUserInterfaceTree(fUIRoot));
    if (fDescription) {
        fDescription->ui(prepareUserInterfaceTree(fUIRoot));
    }
}

Here is the call graph for this function:

void SchedulerCompiler::dlineLoop ( const string &  tname, const string &  dlname, int  delay, const string &  cexp  )

protectedvirtual

Generate the code for a (short) delay line.

Parameters

k	the c++ class where the delay line will be placed.
l	the loop where the code will be placed.
tname	the name of the C++ type (float or int)
dlname	the name of the delay line (vector) to be used.
delay	the maximum delay
cexp	the content of the signal as a C++ expression

Reimplemented from VectorCompiler.

Definition at line 95 of file compile_sched.cpp.

References Klass::addDeclCode(), Klass::addExecCode(), Klass::addFirstPrivateDecl(), Klass::addInitCode(), Klass::addPostCode(), Klass::addPreCode(), Klass::addSharedDecl(), Klass::addZone2(), Compiler::fClass, gMaxCopyDelay, gVecSize, ScalarCompiler::pow2limit(), subst(), and T().

{
    if (delay < gMaxCopyDelay) {
        
        // Implementation of a copy based delayline
        
        // create names for temporary and permanent storage  
        string  buf = subst("$0_tmp", dlname);          
        string  pmem= subst("$0_perm", dlname);
        
        // constraints delay size to be multiple of 4
        delay = (delay+3)&-4;
        
        // allocate permanent storage for delayed samples
        string  dsize   = T(delay);
        fClass->addDeclCode(subst("$0 \t$1[$2];", tname, pmem, dsize));
        
        // init permanent memory
        fClass->addInitCode(subst("for (int i=0; i<$1; i++) $0[i]=0;", pmem, dsize)); 
        
        // compute method
        
        // -- declare a buffer and a "shifted" vector
        fClass->addSharedDecl(buf);
        
        // -- variables moved as class fields...
        fClass->addDeclCode(subst("$0 \t$1[$2+$3];", tname, buf, T(gVecSize), dsize));
        
        fClass->addFirstPrivateDecl(dlname);
        fClass->addZone2(subst("$0* \t$1 = &$2[$3];", tname, dlname, buf, dsize));
        
        // -- copy the stored samples to the delay line
        fClass->addPreCode(subst("for (int i=0; i<$2; i++) $0[i]=$1[i];", buf, pmem, dsize));
        
        // -- compute the new samples
        fClass->addExecCode(subst("$0[i] = $1;", dlname, cexp));
        
        // -- copy back to stored samples
        fClass->addPostCode(subst("for (int i=0; i<$2; i++) $0[i]=$1[count+i];", pmem, buf, dsize));
        
    } else {
        
        // Implementation of a ring-buffer delayline
        
        // the size should be large enough and aligned on a power of two
        delay   = pow2limit(delay + gVecSize);
        string  dsize   = T(delay);
        string  mask    = T(delay-1);
        
        // create names for temporary and permanent storage  
        string  idx = subst("$0_idx", dlname);
        string  idx_save = subst("$0_idx_save", dlname);
        
        // allocate permanent storage for delayed samples
        fClass->addDeclCode(subst("$0 \t$1[$2];", tname, dlname, dsize));
        fClass->addDeclCode(subst("int \t$0;", idx));
        fClass->addDeclCode(subst("int \t$0;", idx_save));
        
        // init permanent memory
        fClass->addInitCode(subst("for (int i=0; i<$1; i++) $0[i]=0;", dlname, dsize)); 
        fClass->addInitCode(subst("$0 = 0;", idx));
        fClass->addInitCode(subst("$0 = 0;", idx_save));
        
        // -- update index
        fClass->addPreCode(subst("$0 = ($0+$1)&$2;", idx, idx_save, mask));
        
        // -- compute the new samples
        fClass->addExecCode(subst("$0[($2+i)&$3] = $1;", dlname, cexp, idx, mask));
        
        // -- save index
        fClass->addPostCode(subst("$0 = count;", idx_save));
    }
}

Here is the call graph for this function:

void SchedulerCompiler::vectorLoop ( const string &  tname, const string &  vecname, const string &  cexp  )

protectedvirtual

Generate the code for a (short) delay line.

Parameters

k	the c++ class where the delay line will be placed.
l	the loop where the code will be placed.
tname	the name of the C++ type (float or int)
dlname	the name of the delay line (vector) to be used.
delay	the maximum delay
cexp	the content of the signal as a C++ expression

Reimplemented from VectorCompiler.

Definition at line 73 of file compile_sched.cpp.

References Klass::addDeclCode(), Klass::addExecCode(), Klass::addSharedDecl(), Compiler::fClass, gVecSize, subst(), and T().

{  
    // -- declare the vector
    fClass->addSharedDecl(vecname);
    
    // -- variables moved as class fields...
    fClass->addDeclCode(subst("$0 \t$1[$2];", tname, vecname, T(gVecSize)));
    
    // -- compute the new samples
    fClass->addExecCode(subst("$0[i] = $1;", vecname, cexp));
}

Here is the call graph for this function:

---

The documentation for this class was generated from the following files:

• compile_sched.hh
• compile_sched.cpp