GUIDOScoreMap.h

Go to the documentation of this file.

#ifndef GUIDOScoreMap_H
#define GUIDOScoreMap_H

/*
  GUIDO Library
  Copyright (C) 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

*/

#ifdef WIN32
# pragma warning (disable : 4661)       // don't know how to solve it
#endif

#include "GUIDOExport.h"
#include "GUIDOEngine.h"
#include "TRect.h"

#include <utility>
#include <vector>
#include <map>
#include <iostream>


//------------------------------------------------------------------------------
// graphic elements selector definitions
typedef enum { 
    kGuidoPage, kGuidoSystem, kGuidoSystemSlice, kGuidoStaff, /*kGuidoMeasure,*/ kGuidoBar, kGuidoEvent, 
    kGuidoScoreElementEnd
} GuidoElementSelector;

// graphic elements type definitions
typedef enum { 
    kNote = 1, kRest, kEmpty, kBar, kRepeatBegin, kRepeatEnd, kStaff, kSystemSlice, kSystem, kPage
} GuidoElementType;

// elements infos struct
typedef struct {
    GuidoElementType type;      
    int              staffNum;  
    int              voiceNum;  
    int              midiPitch; 
} GuidoElementInfos;


//----------------------------------------------------------------------
class_export TimeSegment: public std::pair<GuidoDate, GuidoDate>
{
    public:
                 TimeSegment () {}
                 TimeSegment (const TimeSegment& s) : std::pair<GuidoDate, GuidoDate>(s.first, s.second) {}
                 TimeSegment (const GuidoDate& a, const GuidoDate& b) : std::pair<GuidoDate, GuidoDate>(a, b) {}
        virtual ~TimeSegment () {}

        void print(std::ostream& out) const;                    
        bool empty() const;                                     
        bool intersect(const TimeSegment& ts) const;            
        bool include(const GuidoDate& date) const;              
        bool include(const TimeSegment& ts) const;              
        bool operator < (const TimeSegment& ts) const;          
        bool operator == (const TimeSegment& ts) const;
        TimeSegment operator & (const TimeSegment& ts) const;   
};

typedef std::vector<std::pair<TimeSegment, FloatRect> > Time2GraphicMap;

inline std::ostream& operator << (std::ostream& out, const GuidoDate& d) {
    out << d.num << "/" << d.denom;
    return out;
}

inline std::ostream& operator << (std::ostream& out, const TimeSegment& s) { 
    s.print(out); 
    return out;
}


//------------------------------------------------------------------------------
// mapping collector abstract class definition
class MapCollector
{
    public:
        virtual ~MapCollector() {}
        
        virtual void Graph2TimeMap( const FloatRect& box, const TimeSegment& dates, const GuidoElementInfos& infos ) = 0;
};

//------------------------------------------------------------------------------
class RectInfos {
        TimeSegment         fTime;
        GuidoElementInfos   fInfos;
    public:
                 RectInfos (const TimeSegment& ts, const GuidoElementInfos& infos) : fTime(ts), fInfos(infos) {}
        virtual ~RectInfos () {}
        
        const TimeSegment&          time() const    { return fTime; }
        const GuidoElementInfos&    infos() const   { return fInfos; }
};

typedef std::pair<FloatRect, RectInfos>  MapElement;



//------------------------------------------------------------------------------
// time mapping collector abstract class definition
class TimeMapCollector
{
    public:
        virtual ~TimeMapCollector() {}

        virtual void Time2TimeMap( const TimeSegment& from, const TimeSegment& to ) = 0;
};

#ifdef __cplusplus
extern "C" {
#endif

GUIDOAPI(GuidoErrCode)  GuidoGetMap( CGRHandler gr, int pagenum, float width, float height, 
                                     GuidoElementSelector sel, MapCollector& f);


GUIDOAPI(GuidoErrCode)  GuidoGetPageMap( CGRHandler gr, int pagenum, float w, float h, Time2GraphicMap& outmap);

GUIDOAPI(GuidoErrCode)  GuidoGetStaffMap( CGRHandler gr, int pagenum, float w, float h, int staff, Time2GraphicMap& outmap);

GUIDOAPI(GuidoErrCode)  GuidoGetVoiceMap( CGRHandler gr, int pagenum, float w, float h, int voice, Time2GraphicMap& outmap);

GUIDOAPI(GuidoErrCode)  GuidoGetSystemMap( CGRHandler gr, int pagenum, float w, float h, Time2GraphicMap& outmap);

GUIDOAPI(bool)  GuidoGetTime( const GuidoDate& date, const Time2GraphicMap map, TimeSegment& t, FloatRect& r);

GUIDOAPI(bool)  GuidoGetPoint( float x, float y, const Time2GraphicMap map, TimeSegment& t, FloatRect& r);

#ifdef WIN32
    __declspec(deprecated("Deprecated function (not maintained code)."))
#endif
GUIDOAPI(GuidoErrCode)  GuidoGetSVGMap( GRHandler gr, int pagenum, GuidoElementSelector sel, std::vector<MapElement>& outMap) GUIDOAPI_deprecated;

GUIDOAPI(GuidoErrCode)  GuidoGetTimeMap( CARHandler gr, TimeMapCollector& f);


#ifdef __cplusplus
}
#endif

#endif