1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
#ifndef QMPCOREPUBLIC_H
#define QMPCOREPUBLIC_H
#include <cstdint>
#include <vector>
#include <string>
#ifdef _WIN32
#define EXPORTSYM __declspec(dllexport)
#else
#define EXPORTSYM __attribute__ ((visibility ("default")))
#endif
//This struct is used by event reader callbacks and event handler callbacks
//as caller data struct
class SEventCallBackData
{
public:
uint32_t time,type,p1,p2;
SEventCallBackData(uint32_t _t,uint32_t _p1,uint32_t _p2,uint32_t _tm){type=_t;p1=_p1;p2=_p2;time=_tm;}
};
//Generic callback function that can be used for hooking the core.
//"userdata" is set when you register the callback function.
class IMidiCallBack
{
public:
IMidiCallBack(){}
virtual void callBack(void* callerdata,void* userdata)=0;
virtual ~IMidiCallBack(){}
};
//Main plugin interface.
class qmpPluginIntf
{
public:
qmpPluginIntf(){}
virtual ~qmpPluginIntf(){}
virtual void init(){}
virtual void deinit(){}
virtual const char* pluginGetName(){return "";}
virtual const char* pluginGetVersion(){return "";}
};
//Visualization plugin pinterface. If your plugin implements a visualization,
//you should implement this pinterface.
class qmpVisualizationIntf
{
public:
qmpVisualizationIntf(){}
virtual void show()=0;
virtual void close()=0;
virtual void start()=0;
virtual void stop()=0;
virtual void pause()=0;
virtual void reset()=0;
virtual ~qmpVisualizationIntf(){}
};
#ifdef QMP_MAIN
extern "C"{
#endif
//The API class provided by the core. Plugins use this class to interact with
//the core.
class qmpPluginAPI
{
public:
virtual ~qmpPluginAPI();
virtual uint32_t getDivision();
virtual uint32_t getRawTempo();
virtual double getRealTempo();
virtual uint32_t getTimeSig();
virtual int getKeySig();
virtual uint32_t getNoteCount();
virtual uint32_t getMaxTick();
virtual uint32_t getCurrentPolyphone();
virtual uint32_t getMaxPolyphone();
virtual uint32_t getCurrentTimeStamp();
virtual uint32_t getCurrentPlaybackPercentage();
virtual int getChannelCC(int ch,int cc);
virtual int getChannelPreset(int ch);
virtual void playerSeek(uint32_t percentage);
virtual double getPitchBend(int ch);
virtual bool getChannelMask(int ch);
virtual std::string getTitle();
virtual std::wstring getWTitle();
virtual std::string getChannelPresetString(int ch);
//WARNING!!: This function should be called from event reader callbacks only and
//it is somehow dangerous -- other plugins might be unaware of the removal of the
//event. The design might be modified afterward.
virtual void discardLastEvent();
//WARNING!!: This function should be called from event reader callbacks only and
//it is somehow dangerous -- other plugins might be unaware of the event change.
//The design might be modified afterward.
virtual void commitEventChange(SEventCallBackData d);
virtual int registerVisualizationIntf(qmpVisualizationIntf* intf);
virtual void unregisterVisualizationIntf(int intfhandle);
virtual int registerEventReaderIntf(IMidiCallBack* cb,void* userdata);
virtual void unregisterEventReaderIntf(int intfhandle);
virtual int registerEventHandlerIntf(IMidiCallBack* cb,void* userdata);
virtual void unregisterEventHandlerIntf(int intfhandle);
virtual int registerFileReadFinishedHandlerIntf(IMidiCallBack* cb,void* userdata);
virtual void unregisterFileReadFinishedHandlerIntf(int intfhandle);
//if desc=="", the option won't be visible in the settings form.
//it will only show up in the configuration file.
virtual void registerOptionInt(std::string tab,std::string desc,std::string key,int min,int max,int defaultval);
virtual int getOptionInt(std::string key);
virtual void setOptionInt(std::string key,int val);
virtual void registerOptionUint(std::string tab,std::string desc,std::string key,unsigned min,unsigned max,unsigned defaultval);
virtual unsigned getOptionUint(std::string key);
virtual void setOptionUint(std::string key,unsigned val);
virtual void registerOptionBool(std::string tab,std::string desc,std::string key,bool defaultval);
virtual bool getOptionBool(std::string key);
virtual void setOptionBool(std::string key,bool val);
virtual void registerOptionDouble(std::string tab,std::string desc,std::string key,double min,double max,double defaultval);
virtual double getOptionDouble(std::string key);
virtual void setOptionDouble(std::string key,double val);
virtual void registerOptionString(std::string tab,std::string desc,std::string key,std::string defaultval);
virtual std::string getOptionString(std::string key);
virtual void setOptionString(std::string key,std::string val);
virtual void registerOptionEnumInt(std::string tab,std::string desc,std::string key,std::vector<std::string> options,int defaultval);
virtual int getOptionEnumInt(std::string key);
virtual void setOptionEnumInt(std::string key,int val);
};
#ifdef QMP_MAIN
}
#endif
//The entry type for the plugin. Your plugin should implement
//qmpPluginIntf* qmpPluginGetInterface(qmpPluginAPI* api)
//as its entry point. A pointer to the core API is also passed to the plugin
//through the parameter. This function should return a pointer to a class
//that implementes the plugin pinterface (qmpPluginIntf).
typedef qmpPluginIntf*(*qmpPluginEntry)(qmpPluginAPI*);
#endif // QMPCOREPUBLIC_H
|
