GUIDOEngine.h

Go to the documentation of this file.

#ifndef GUIDOEngine_H
#define GUIDOEngine_H
 
/*
  GUIDO Library
  Copyright (C) 2002  Holger Hoos, Juergen Kilian, Kai Renz
  Copyright (C) 2003, 2004  Grame
 
  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
 
*/
 
#include <ostream>
#include <string>
#include <vector>
#include "VGColor.h"
#include "GUIDOExport.h"
 
 
#ifdef WIN32
    #define GUIDOAPI_deprecated
#else
    #define GUIDOAPI_deprecated __attribute__((deprecated))
#endif
 
 
class VGDevice;
 
struct NodeAR;
struct NodeGR;
typedef struct NodeAR *  ARHandler;
typedef struct NodeGR *  GRHandler;
typedef const struct NodeAR *  CARHandler;
typedef const struct NodeGR *  CGRHandler;
 
struct GuidoInitDesc
{
    VGDevice    *       graphicDevice;
 
    void *              reserved;
 
    const char *        musicFont;
    const char *        textFont;
};
 
struct GPaintStruct
{
    bool    erase;
    int     left;
    int     top;
    int     right;
    int     bottom;
};
 
 
typedef struct
{
    int num;
    int denom;
 
} GuidoDate;
 
 
#define kMaxGuidoMeterCounts    15
 
typedef struct
{
    int count[kMaxGuidoMeterCounts];
    int unit;
} GuidoMeter;
typedef GuidoMeter* GuidoMeters;
 
 
typedef enum { kTextualTempo, kUnitValueTempo, kUnitUnitTempo } TempoType;
typedef struct
{
    int voice;
    GuidoDate date;
    char text[128];
    TempoType type;
    GuidoDate unit;
    int value;
    GuidoDate unitvalue;
} GuidoTempo;
typedef GuidoTempo* GuidoTempoList;
 
struct GuidoOnDrawDesc
{
    GRHandler handle;
 
    VGDevice * hdc;
    int page;
    GPaintStruct updateRegion;
 
    int scrollx, scrolly;
 
    float reserved;
 
    int sizex, sizey;
 
    int isprint;
};
 
 
enum  { kNoBB, kPageBB, 
        kSystemsBB = 2, 
        kSystemsSliceBB = 4,
        kStavesBB = 8, 
        kMeasureBB = 0x10, 
        kEventsBB = 0x20,
};
 
 
enum GuidoInternalDevice
{
  guido_svg_with_font_spec = 0,
  guido_abstract = 1,
  guido_binary = 2
};
 
enum GuidoErrCode
{
    guidoNoErr                  = 0,
    guidoErrParse               = -1,
    guidoErrMemory              = -2,
    guidoErrFileAccess          = -3,
    guidoErrUserCancel          = -4,
    guidoErrNoMusicFont         = -5,
    guidoErrNoTextFont          = -6,
    guidoErrBadParameter        = -7,
    guidoErrInvalidHandle       = -8,
    guidoErrNotInitialized      = -9,
    guidoErrActionFailed        = -10
};
enum GuidoMapping {
    kNoMapping     =  0,
    kVoiceMapping  =  1,
    kStaffMapping  =  1<<1,
    kSystemMapping =  1<<2
};
 
 
enum { kAutoDistrib = 1, kAlwaysDistrib = 2, kNeverDistrib = 3 };
enum GRElement { kGRSlur=1, kGRDynamics, kGRArticulations, kGRText, kGRLyrics };
 
typedef struct GuidoLayoutSettings
{
    float systemsDistance;
 
    int systemsDistribution;
 
    float systemsDistribLimit;
 
    float   force;
 
    float   spring;
 
     int neighborhoodSpacing;
 
    int optimalPageFill;
 
    int resizePage2Music;
 
    float proportionalRenderingForceMultiplicator;
 
    bool checkLyricsCollisions;
    
} GuidoLayoutSettings;
 
typedef struct
{
    float width;
    float height;
    float marginleft;
    float margintop;
    float marginright;
    float marginbottom;
} GuidoPageFormat;
 
 
typedef struct
{
    GuidoLayoutSettings layoutSettings;
    GuidoPageFormat pageFormat;
} GuidoGrParameters;
 
#ifdef __cplusplus
extern "C" {
#endif
 
    GUIDOAPI GuidoErrCode   GuidoInit(GuidoInitDesc * desc);
 
    GUIDOAPI GuidoErrCode      GuidoInitWithIndependentSVG();
    GUIDOAPI void   GuidoShutdown();
 
#ifdef WIN32
    __declspec(deprecated("Deprecated function : use ARHandler GuidoFile2AR (GuidoParser *parser, const char * file) instead."))
#endif
    GUIDOAPI GuidoErrCode   GuidoParseFile(const char * filename, ARHandler* ar) GUIDOAPI_deprecated;
 
#ifdef WIN32
    __declspec(deprecated("Deprecated function : use ARHandler GuidoString2AR (GuidoParser *parser, const char * str) instead."))
#endif
    GUIDOAPI GuidoErrCode   GuidoParseString(const char * str, ARHandler* ar) GUIDOAPI_deprecated;
 
    GUIDOAPI GuidoErrCode   GuidoAR2GR(ARHandler ar, const GuidoLayoutSettings* settings, GRHandler* gr);
 
    GUIDOAPI GRHandler GuidoAR2GRParameterized(ARHandler ar, const GuidoGrParameters* gp);
 
    GUIDOAPI GuidoErrCode   GuidoUpdateGR( GRHandler gr, const GuidoLayoutSettings* settings);
 
    GUIDOAPI GuidoErrCode   GuidoShowElement( GRHandler gr, GRElement elt, bool status);
 
    GUIDOAPI float  GuidoGetNotesDensity( GRHandler gr);
 
    GUIDOAPI GuidoErrCode   GuidoUpdateGRParameterized( GRHandler gr, const GuidoGrParameters* settings);
 
    GUIDOAPI void   GuidoFreeAR (ARHandler ar);
 
    GUIDOAPI void   GuidoFreeGR (GRHandler gr);
 
    GUIDOAPI const char* GuidoGetErrorString( GuidoErrCode errCode );
 
#ifdef WIN32
    __declspec(deprecated("Deprecated function : use GUIDOAPI GuidoErrCode GuidoParserGetErrorCode (GuidoParser* p, int& line, int& col) instead."))
#endif
    GUIDOAPI int   GuidoGetParseErrorLine() GUIDOAPI_deprecated;
 
    GUIDOAPI void   GuidoGetDefaultLayoutSettings (GuidoLayoutSettings *settings);
    GUIDOAPI int    GuidoCountVoices( CARHandler inHandleAR );
    
    GUIDOAPI int    GuidoGetPageCount( CGRHandler inHandleGR );
    
    GUIDOAPI int    GuidoGetSystemCount( CGRHandler inHandleGR, int page );
 
    GUIDOAPI GuidoErrCode   GuidoDuration( CGRHandler inHandleGR, GuidoDate * date );
 
    GUIDOAPI int    GuidoFindEventPage( CGRHandler inHandleGR, const GuidoDate& date );
 
    GUIDOAPI int GuidoFindPageAt( CGRHandler inHandleGR, const GuidoDate& date );
 
    GUIDOAPI GuidoErrCode GuidoGetPageDate( CGRHandler inHandleGR, int pageNum, GuidoDate* date);
 
 
    GUIDOAPI GuidoErrCode GuidoGetMeterAt (CARHandler inHandleAR, int voicenum, const GuidoDate &date, GuidoMeter& meter);
 
 
    GUIDOAPI GuidoErrCode GuidoGetMetersAt (CARHandler inHandleAR, int voicenum, const GuidoDate &date, GuidoMeters& meters);
 
 
    GUIDOAPI GuidoErrCode GuidoFreeMeters (GuidoMeters meters);
 
 
    GUIDOAPI int GuidoGetTempoList (CARHandler inHandleAR, GuidoTempoList& tempi);
 
 
    GUIDOAPI GuidoErrCode GuidoFreeTempoList (GuidoTempoList tempi);
 
 
    GUIDOAPI GuidoErrCode   GuidoOnDraw( GuidoOnDrawDesc * desc );
 
    GUIDOAPI GuidoErrCode GuidoGR2SVG( const GRHandler handle, int page, std::ostream& out, bool embedFont, const char* font, const int mappingMode = 0 );
 
    GUIDOAPI GuidoErrCode GuidoGR2SVG1( const GRHandler handle, int page, std::ostream& out, int width, int height, bool embedFont );
 
    GUIDOAPI GuidoErrCode GuidoGR2SVGColored( const GRHandler handle, int page, std::ostream& out, const VGColor& color, bool embedFont );
 
    #ifdef WIN32
        __declspec(deprecated("Deprecated function : use GUIDOAPI GuidoErrCode GuidoGR2SVG( const GRHandler handle, int page, std::ostream& out, bool embedFont, const char* font, const int mappingMode = 0 ) instead."))
    #endif
    GUIDOAPI GuidoErrCode   GuidoSVGExport( const GRHandler handle, int page, std::ostream& out, const char* fontfile, const int mappingMode = 0 ) GUIDOAPI_deprecated;
 
    #ifdef WIN32
        __declspec(deprecated("Deprecated function : use GUIDOAPI GuidoErrCode GuidoGR2SVG( const GRHandler handle, int page, std::ostream& out, bool embedFont, const char* font, const int mappingMode = 0 ) instead."))
    #endif
    GUIDOAPI GuidoErrCode   GuidoSVGExportWithFontSpec( const GRHandler handle, int page, std::ostream& out, const char* fontfile, const char* fontspec, const int mappingMode = 0 ) GUIDOAPI_deprecated;
 
    GUIDOAPI GuidoErrCode   GuidoAbstractExport( const GRHandler handle, int page, std::ostream& out);
 
    GUIDOAPI GuidoErrCode   GuidoBinaryExport( const GRHandler handle, int page, std::ostream& out);
 
    GUIDOAPI void   GuidoDrawBoundingBoxes(int bbMap);
 
    GUIDOAPI int    GuidoGetDrawBoundingBoxes();
 
    GUIDOAPI void   GuidoGetPageFormat( CGRHandler inHandleGR, int pageNum, GuidoPageFormat* format );
 
    GUIDOAPI void   GuidoSetDefaultPageFormat( const GuidoPageFormat* format);
 
    GUIDOAPI void   GuidoGetDefaultPageFormat( GuidoPageFormat* format );
 
    GUIDOAPI void   GuidoSetStaffSize( CGRHandler inHandleGR, int staffNum, float size );
    
    GUIDOAPI float  GuidoGetStaffSize( CGRHandler inHandleGR, int staffNum );
 
    GUIDOAPI float  GuidoUnit2CM(float val);
 
    GUIDOAPI float  GuidoCM2Unit(float val);
 
    GUIDOAPI float  GuidoUnit2Inches(float val);
 
    GUIDOAPI float  GuidoInches2Unit(float val);
 
 
    GUIDOAPI GuidoErrCode   GuidoResizePageToMusic( GRHandler inHandleGR );
 
 
    GUIDOAPI void GuidoGetVersionNums(int * major, int * minor, int * sub);
 
    GUIDOAPI const char* GuidoGetVersionStr();
 
 
    GUIDOAPI GuidoErrCode GuidoCheckVersionNums(int major, int minor, int sub);
 
 
    GUIDOAPI float GuidoGetLineSpace();
 
 
    GUIDOAPI GuidoErrCode GuidoMarkVoice( ARHandler inHandleAR, int voicenum,
                                            const GuidoDate & date, const GuidoDate & duration,
                                            unsigned char red, unsigned char green, unsigned char blue );
 
 
    GUIDOAPI GuidoErrCode GuidoSetSymbolPath(ARHandler inHandleAR, const std::vector<std::string> &inPaths);
 
 
    GUIDOAPI GuidoErrCode GuidoGetSymbolPath(const ARHandler inHandleAR, std::vector<std::string> &inPathVector);
 
    GUIDOAPI long  GuidoGetParsingTime (const ARHandler ar);
 
    GUIDOAPI long   GuidoGetAR2GRTime(const GRHandler gr);
 
    GUIDOAPI long   GuidoGetOnDrawTime(const GRHandler gr);
 
#ifdef __cplusplus
}
#endif
 
 
#endif  /* GUIDOEngine_H */