libmusicxml.h

/*
  MusicXML Library
  Copyright (C) Grame 2006-2013
 
  This Source Code Form is subject to the terms of the Mozilla Public
  License, v. 2.0. If a copy of the MPL was not distributed with this
  file, You can obtain one at http://mozilla.org/MPL/2.0/.
 
  Grame Research Laboratory, 11, cours de Verdun Gensoul 69002 Lyon - France
  research@grame.fr
*/
 
#ifndef __libmusicxml__
#define __libmusicxml__
 
#ifdef MSVC
# pragma warning (disable : 4786)
#endif
 
#include <iostream>
#include <string>
#include <stdio.h>
 
#include "exports.h"
 
namespace MusicXML2 
{
enum xmlErr { kNoErr, kInvalidFile, kUnsupported };
 
#ifdef __cplusplus
extern "C" {
#endif
 
class musicxmlfactory;
class xmlelement;
class xmlattribute;
 
typedef xmlelement*      TElement;
typedef xmlattribute*    TAttribute;
typedef musicxmlfactory* TFactory;
 
 
EXP float       musicxmllibVersion();
EXP const char*   musicxmllibVersionStr();
 
 
EXP float       musicxml2guidoVersion();
EXP const char*   musicxml2guidoVersionStr();
 
EXP float       musicxml2lilypondVersion();
EXP const char*   musicxml2lilypondVersionStr();
 
EXP float       musicxml2brailleVersion();
EXP const char*   musicxml2brailleVersionStr();
 
EXP xmlErr      musicxmlfile2guido  (const char *file, bool generateBars, std::ostream& out);
 
EXP xmlErr      musicxmlfd2guido  (FILE* fd, bool generateBars, std::ostream& out);
 
EXP xmlErr      musicxmlstring2guido(const char *buff, bool generateBars, std::ostream& out);
 
EXP xmlErr      musicxmlstring2guidoOnPart(const char * buffer, bool generateBars, int partFilter, std::ostream& out);
 
/*
\addtogroup Converting MusicXML to Antescofo Music Notation format
 
The library includes a high level API to convert from the MusicXML format to the
Antescofo Score Notation format. For more information about this format, 
see  http://repmus.ircam.fr/antescofo
@{
*/
 
/*
  \brief Gives the Antescofo converter version number.
  \return a version number as an integer (e.g. version 1.0.0 is returned as 100)
 
EXP int       musicxml2antescofoVersion();
  \brief Gives the Antescofo converter version as a string.
  \return a string
EXP const char*   musicxml2antescofoVersionStr();
*/
 
EXP xmlErr      musicxmlfd2antescofo  (FILE* fd, bool generateBars, std::ostream& out);
 
EXP xmlErr      musicxmlstring2antescofo(const char *buff, bool generateBars, std::ostream& out);
EXP TFactory  factoryOpen  ();
 
EXP void    factoryClose (TFactory f);
 
EXP void    factoryPrint (TFactory f, std::ostream& out);
 
 
EXP void    factoryHeader (TFactory f, const char* worknumber, const char* worktitle, const char* movementnumber, const char* movementtitle);
 
 
EXP void    factoryCreator  (TFactory f, const char* c, const char* type);
 
 
EXP void    factoryRights (TFactory f, const char* r, const char* type);
 
EXP void    factoryEncoding (TFactory f, const char* software);
 
EXP void    factoryAddPart (TFactory f, TElement part);
 
EXP void    factoryAddGroup (TFactory f, int number, const char* name, const char* abbrev, bool groupbarline, TElement* parts);
 
EXP void    factoryAddElement (TFactory f, TElement elt, TElement subelt);
 
EXP void    factoryAddElements  (TFactory f, TElement elt, TElement* subelts);
 
EXP void    factoryAddAttribute (TFactory f, TElement elt, TAttribute attr);
 
EXP TElement  factoryScorepart(TFactory f, const char* id, const char* name, const char* abbrev);
 
EXP TElement  factoryPart   (TFactory f, const char* id);
 
EXP TElement  factoryMeasure  (TFactory f, int number);
 
EXP TElement  factoryMeasureWithAttributes  (TFactory f, int number, const char* time, const char* clef, int line, int key, int division);
 
EXP TElement  factoryNote   (TFactory f, const char* step, float alter, int octave, int duration, const char* type);
 
EXP TElement  factoryDynamic  (TFactory f, int type, const char* placement);
 
EXP TElement  factoryBarline  (TFactory f, const char* location, const char* barstyle, const char *repeat);
 
EXP void    factoryTuplet (TFactory f, int actual, int normal, TElement * notes);
 
EXP void    factoryTie  (TFactory f, TElement from, TElement to);
 
EXP void    factoryNotation (TFactory f, TElement elt, TElement notation);
 
EXP void    factoryArticulation (TFactory f, TElement elt, TElement articulation);
 
EXP TElement  factoryRest   (TFactory f, int duration, const char* type);
 
EXP void    factoryChord  (TFactory f, TElement * notes);
 
 
EXP TElement  factoryElement    (TFactory f, int type);
 
EXP TElement  factoryStrElement (TFactory f, int type, const char * value);
EXP TElement  factoryIntElement (TFactory f, int type, int value);
EXP TElement  factoryFloatElement (TFactory f, int type, float value);
 
 
EXP TAttribute  factoryStrAttribute   (TFactory f, const char * name, const char* value);
EXP TAttribute  factoryIntAttribute   (TFactory f, const char * name, int value);
EXP TAttribute  factoryFloatAttribute (TFactory f, const char * name, float value);
 
EXP void    factoryFreeElement    (TFactory f, TElement elt);
 
EXP void    factoryFreeAttribute  (TFactory f, TAttribute attr);
 
#ifdef __cplusplus
}
#endif
 
}
 
#endif