Csound and CsoundAC API  5.17
Public Member Functions | Data Fields | Protected Attributes
CsoundFile Class Reference

Manages a Csound Structured Data (CSD) file with facilities for creating an arrangement of selected instruments in the orchestra, and for programmatically building score files. More...

#include <CsoundFile.hpp>

+ Inheritance diagram for CsoundFile:

Public Member Functions

virtual void addArrangement (std::string instrument)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6, double p7, double p8, double p9, double p10, double p11)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6, double p7, double p8, double p9, double p10)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6, double p7, double p8, double p9)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6, double p7, double p8)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6, double p7)
virtual void addNote (double p1, double p2, double p3, double p4, double p5, double p6)
virtual void addNote (double p1, double p2, double p3, double p4, double p5)
virtual void addNote (double p1, double p2, double p3, double p4)
virtual void addNote (double p1, double p2, double p3)
virtual void addScoreLine (const std::string line)
 CsoundFile ()
virtual int exportArrangement (std::ostream &stream) const
virtual int exportArrangementForPerformance (std::string filename) const
virtual int exportArrangementForPerformance (std::ostream &stream) const
virtual int exportCommand (std::ostream &stream) const
virtual bool exportForPerformance () const
virtual int exportMidifile (std::ostream &stream) const
virtual int exportOrchestra (std::ostream &stream) const
virtual int exportScore (std::ostream &stream) const
virtual std::string generateFilename ()
virtual std::string getArrangement (int index) const
virtual int getArrangementCount () const
virtual std::string getCommand () const
virtual std::string getCSD () const
virtual std::string getFilename () const
virtual bool getInstrument (int number, std::string &definition) const
virtual bool getInstrument (std::string name, std::string &definition) const
virtual std::string getInstrument (std::string name) const
virtual std::string getInstrument (int number) const
virtual std::string getInstrumentBody (std::string name) const
virtual std::string getInstrumentBody (int number) const
virtual int getInstrumentCount () const
virtual std::map< int,
std::string > 
getInstrumentNames () const
virtual double getInstrumentNumber (std::string name) const
virtual std::string getMidiFilename () const
virtual std::string getOrcFilename () const
virtual std::string getOrchestra () const
virtual std::string getOrchestraHeader () const
virtual std::string getOutputSoundfileName () const
virtual std::string getScoFilename () const
virtual std::string getScore () const
virtual int importArrangement (std::istream &stream)
virtual int importCommand (std::istream &stream)
virtual int importFile (std::string filename)
 Imports the indicated file, which can be a Csound unified file (.csd), Csound orchestra (.orc), Csound score (.sco), standard MIDI file (.mid), or MusicXML v2 (.xml) file.
virtual int importFile (std::istream &stream)
virtual int importMidifile (std::istream &stream)
virtual int importOrchestra (std::istream &stream)
virtual int importScore (std::istream &stream)
virtual void insertArrangement (int index, std::string instrument)
virtual int load (std::string filename)
 Clears all contents of this, then imports the indicated file, which can be a Csound unified file (.csd), Csound orchestra (.orc), Csound score (.sco), standard MIDI file (.mid), or MusicXML v2 (.xml) file.
virtual int load (std::istream &stream)
virtual bool loadOrcLibrary (const char *filename=0)
virtual void removeAll ()
virtual void removeArrangement (int index)
virtual void removeArrangement ()
virtual void removeCommand ()
virtual void removeMidifile ()
virtual void removeOrchestra ()
virtual void removeScore ()
virtual int save (std::string filename) const
virtual int save (std::ostream &stream) const
virtual void setArrangement (int index, std::string instrument)
virtual void setCommand (std::string commandLine)
virtual void setCSD (std::string xml)
virtual void setFilename (std::string name)
virtual void setOrchestra (std::string orchestra)
virtual void setScore (std::string score)
virtual ~CsoundFile ()

Data Fields

std::vector< std::string > arrangement
std::string libraryFilename
 Patch library and arrangement.

Protected Attributes

std::vector< std::string > args
std::vector< char * > argv
std::string command
 CsOptions.
std::string filename
 What are we storing, anyway?
std::vector< unsigned char > midifile
 CsMidi.
std::string orchestra
 CsInstruments.
std::string score
 CsScore.

Detailed Description

Manages a Csound Structured Data (CSD) file with facilities for creating an arrangement of selected instruments in the orchestra, and for programmatically building score files.


Constructor & Destructor Documentation

virtual CsoundFile::~CsoundFile ( ) [inline, virtual]

Member Function Documentation

virtual void CsoundFile::addArrangement ( std::string  instrument) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6,
double  p7,
double  p8,
double  p9,
double  p10,
double  p11 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6,
double  p7,
double  p8,
double  p9,
double  p10 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6,
double  p7,
double  p8,
double  p9 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6,
double  p7,
double  p8 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6,
double  p7 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5,
double  p6 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4,
double  p5 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3,
double  p4 
) [virtual]
virtual void CsoundFile::addNote ( double  p1,
double  p2,
double  p3 
) [virtual]
virtual void CsoundFile::addScoreLine ( const std::string  line) [virtual]
virtual int CsoundFile::exportArrangement ( std::ostream &  stream) const [virtual]
virtual int CsoundFile::exportArrangementForPerformance ( std::string  filename) const [virtual]
virtual int CsoundFile::exportArrangementForPerformance ( std::ostream &  stream) const [virtual]
virtual int CsoundFile::exportCommand ( std::ostream &  stream) const [virtual]
virtual bool CsoundFile::exportForPerformance ( ) const [virtual]
virtual int CsoundFile::exportMidifile ( std::ostream &  stream) const [virtual]
virtual int CsoundFile::exportOrchestra ( std::ostream &  stream) const [virtual]
virtual int CsoundFile::exportScore ( std::ostream &  stream) const [virtual]
virtual std::string CsoundFile::generateFilename ( ) [virtual]
virtual std::string CsoundFile::getArrangement ( int  index) const [virtual]
virtual int CsoundFile::getArrangementCount ( ) const [virtual]
virtual std::string CsoundFile::getCommand ( ) const [virtual]
virtual std::string CsoundFile::getCSD ( ) const [virtual]
virtual std::string CsoundFile::getFilename ( ) const [virtual]
virtual bool CsoundFile::getInstrument ( int  number,
std::string &  definition 
) const [virtual]
virtual bool CsoundFile::getInstrument ( std::string  name,
std::string &  definition 
) const [virtual]
virtual std::string CsoundFile::getInstrument ( std::string  name) const [virtual]
virtual std::string CsoundFile::getInstrument ( int  number) const [virtual]
virtual std::string CsoundFile::getInstrumentBody ( std::string  name) const [virtual]
virtual std::string CsoundFile::getInstrumentBody ( int  number) const [virtual]
virtual int CsoundFile::getInstrumentCount ( ) const [virtual]
virtual std::map<int, std::string> CsoundFile::getInstrumentNames ( ) const [virtual]
virtual double CsoundFile::getInstrumentNumber ( std::string  name) const [virtual]
virtual std::string CsoundFile::getMidiFilename ( ) const [virtual]
virtual std::string CsoundFile::getOrcFilename ( ) const [virtual]
virtual std::string CsoundFile::getOrchestra ( ) const [virtual]
virtual std::string CsoundFile::getOrchestraHeader ( ) const [virtual]
virtual std::string CsoundFile::getOutputSoundfileName ( ) const [virtual]

Reimplemented in CppSound.

virtual std::string CsoundFile::getScoFilename ( ) const [virtual]
virtual std::string CsoundFile::getScore ( ) const [virtual]
virtual int CsoundFile::importArrangement ( std::istream &  stream) [virtual]
virtual int CsoundFile::importCommand ( std::istream &  stream) [virtual]
virtual int CsoundFile::importFile ( std::string  filename) [virtual]

Imports the indicated file, which can be a Csound unified file (.csd), Csound orchestra (.orc), Csound score (.sco), standard MIDI file (.mid), or MusicXML v2 (.xml) file.

The data that is read replaces existing data of that type, but leaves other types of data untouched.

The MusicXML notes become instrument number + 1, time in seconds, duration in seconds, MIDI key number, and MIDI velocity number.

virtual int CsoundFile::importFile ( std::istream &  stream) [virtual]
virtual int CsoundFile::importMidifile ( std::istream &  stream) [virtual]
virtual int CsoundFile::importOrchestra ( std::istream &  stream) [virtual]
virtual int CsoundFile::importScore ( std::istream &  stream) [virtual]
virtual void CsoundFile::insertArrangement ( int  index,
std::string  instrument 
) [virtual]
virtual int CsoundFile::load ( std::string  filename) [virtual]

Clears all contents of this, then imports the indicated file, which can be a Csound unified file (.csd), Csound orchestra (.orc), Csound score (.sco), standard MIDI file (.mid), or MusicXML v2 (.xml) file.

The MusicXML notes become instrument number + 1, time in seconds, duration in seconds, MIDI key number, and MIDI velocity number.

virtual int CsoundFile::load ( std::istream &  stream) [virtual]
virtual bool CsoundFile::loadOrcLibrary ( const char *  filename = 0) [virtual]
virtual void CsoundFile::removeAll ( ) [virtual]
virtual void CsoundFile::removeArrangement ( int  index) [virtual]
virtual void CsoundFile::removeArrangement ( ) [virtual]
virtual void CsoundFile::removeCommand ( ) [virtual]
virtual void CsoundFile::removeMidifile ( ) [virtual]
virtual void CsoundFile::removeOrchestra ( ) [virtual]
virtual void CsoundFile::removeScore ( ) [virtual]
virtual int CsoundFile::save ( std::string  filename) const [virtual]
virtual int CsoundFile::save ( std::ostream &  stream) const [virtual]
virtual void CsoundFile::setArrangement ( int  index,
std::string  instrument 
) [virtual]
virtual void CsoundFile::setCommand ( std::string  commandLine) [virtual]
virtual void CsoundFile::setCSD ( std::string  xml) [virtual]
virtual void CsoundFile::setFilename ( std::string  name) [virtual]
virtual void CsoundFile::setOrchestra ( std::string  orchestra) [virtual]
virtual void CsoundFile::setScore ( std::string  score) [virtual]

Field Documentation

std::vector<std::string> CsoundFile::args [protected]
std::vector<char *> CsoundFile::argv [protected]
std::vector<std::string> CsoundFile::arrangement
std::string CsoundFile::command [protected]

CsOptions.

std::string CsoundFile::filename [protected]

What are we storing, anyway?

Patch library and arrangement.

std::vector<unsigned char> CsoundFile::midifile [protected]

CsMidi.

std::string CsoundFile::orchestra [protected]

CsInstruments.

std::string CsoundFile::score [protected]

CsScore.