GUIDOPianoRoll.h

Go to the documentation of this file.

#ifndef GUIDOPianoRollAPI_H
#define GUIDOPianoRollAPI_H

/*
  GUIDO Library
  Copyright (C) 2014 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 "GUIDOEngine.h"
#include "GUIDOExport.h"
#include "GUIDOScoreMap.h"

class PianoRoll;

enum PianoRollType {
    kSimplePianoRoll,
    kTrajectoryPianoRoll
};

const int kCLine      =  1;
const int kCSharpLine =  1<<1;
const int kDLine      =  1<<2;
const int kDSharpLine =  1<<3;
const int kELine      =  1<<4;
const int kFLine      =  1<<5;
const int kFSharpLine =  1<<6;
const int kGLine      =  1<<7;
const int kGSharpLine =  1<<8;
const int kALine      =  1<<9;
const int kASharpLine =  1<<10;
const int kBLine      =  1<<11;
const int kAutoLines  =  0;
const int kNoLine     = -1;

typedef struct LimitParams {
    GuidoDate startDate;
    GuidoDate endDate;
    int       lowPitch;
    int       highPitch;
} LimitParams;

#ifdef __cplusplus
extern "C" {
#endif

    //---------------------------------------------------------------------------
    // the new API
    //---------------------------------------------------------------------------

    GUIDOAPI(PianoRoll *)  GuidoAR2PianoRoll(PianoRollType type, ARHandler arh);
    
    GUIDOAPI(PianoRoll *)  GuidoMidi2PianoRoll(PianoRollType type, const char *midiFileName);

    GUIDOAPI(GuidoErrCode)      GuidoDestroyPianoRoll(PianoRoll *pr);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollSetLimits(PianoRoll *pr, LimitParams limitParams);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollEnableKeyboard(PianoRoll *pr, bool enabled);
    
    GUIDOAPI(GuidoErrCode)      GuidoPianoRollGetKeyboardWidth(PianoRoll *pr, int height, float &keyboardWidth);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollEnableAutoVoicesColoration(PianoRoll *pr, bool enabled);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollSetRGBColorToVoice(PianoRoll *pr, int voiceNum, int r, int g, int b, int a);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollSetHtmlColorToVoice(PianoRoll *pr, int voiceNum, long color);
    
    GUIDOAPI(GuidoErrCode)      GuidoPianoRollEnableMeasureBars(PianoRoll *pr, bool enabled);
    
    GUIDOAPI(GuidoErrCode)      GuidoPianoRollSetPitchLinesDisplayMode(PianoRoll *pr, int mode);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollGetMap(PianoRoll *pr, int width, int height, Time2GraphicMap &outmap);

    GUIDOAPI(GuidoErrCode)      GuidoPianoRollOnDraw(PianoRoll *pr, int width, int height, VGDevice* dev);

#ifdef __cplusplus
}
#endif

#endif  /* GUIDOPianoRollAPI_H */