MidiVid Home

MVPlug.h

Go to the documentation of this file.

/*

    MVPlug.h - MidVid Plugin class definition

*/

#pragma once
#ifndef MVPLUG_H
#define MVPLUG_H

#include "MidiVidInterface.h"
#include "TagStream.h"

class MVPlugDesc;
class MVBasePlug;
class MVPlug;

const long MVP_Header_Version = 0x00000300;

#define MVExport extern "C" __declspec(dllexport)



#ifndef MIDIVID_APP // Exporting from DLL to MidVid -------------------------------

MVExport long mvpGetVersion(void);

MVExport long mvpGetNumPlugs(void);

MVExport MVPlugDesc *mvpGetPlugDesc(long WhichPlug);

#endif

// ----------------------------------------------------------------------------
typedef enum {
    PlugType_Event = 0,         
    PlugType_Video = 1,         
    PlugType_Audio = 2,         
    PlugType_AudioVideo = 3,    

    PlugType_Source = 4,        
} MVPlugType;


// ----------------------------------------------------------------------------
struct MVGuid
{
    DWORD   Data1;
    WORD    Data2;
    WORD    Data3;
    BYTE    Data4[8];
};

inline bool operator==(const MVGuid &lhs, const MVGuid &rhs)
{
    return memcmp(&lhs, &rhs, sizeof(MVGuid)) == 0;
}


// ----------------------------------------------------------------------------
class MVPlugDesc
{
public:
    virtual ~MVPlugDesc() {;}

    virtual MVPlugType GetType(void) = 0;       
    virtual const MVGuid &GetGUID(void) = 0;    

    virtual const char *GetClass(void) = 0;     
    virtual const char *GetName(void) = 0;      
    virtual const char *GetDesc(void) = 0;      
    virtual MVBasePlug *CreatePlug(void) = 0;   
};


// ----------------------------------------------------------------------------
class MVBasePlug
{
public:
    MVBasePlug() : pMVI(0) {;}

    virtual ~MVBasePlug() {;}
    void SetInterface(MidiVidInterface &MVI) {pMVI = &MVI;}

    virtual MVPlugType GetType(void) = 0;       
    virtual const MVGuid &GetGUID(void) = 0;    

    MidiVidInterface *pMVI;
};


typedef void (*FormatKnobValueFunc)(int Value, char Output[32], MVPlug *pPlugin, int Index);


// ----------------------------------------------------------------------------
struct MVParamInfo
{
    int         MinValue;       
    int         MaxValue;       
    int         Default;        
    bool        bWrap;          
    DWORD       ParamID;        
    const char  *pName;         
    FormatKnobValueFunc pFunc;  
};


// ----------------------------------------------------------------------------
class MVPlug : public MVBasePlug
{
public:
    // ------------------------------------------------------------------------
    // Maintained by MidiVid, accessible to plugins

    BYTE    Velocity;           
    BYTE    Channel;            
    WORD    StartChan;          
    // ------------------------------------------------------------------------

    MVPlug() {StartChan = 0;}                                       
    virtual ~MVPlug() {;}                                           

    virtual long GetNumFiles(void) = 0;                             
    virtual const char *GetFileName(long WhichFile) = 0;            
    virtual void SetFileName(long WhichFile, char *pNewName) = 0;   

    virtual bool Startup(void) = 0;

    virtual bool Shutdown(void) = 0;

    virtual bool Assign(HWND hCallWnd) = 0;                         

    virtual void NoteOn(void) = 0;                                  
    virtual void NoteOff(void) = 0;                                 
    virtual void Tick(DWORD dwTimeDelt) = 0;                        
    virtual bool Sustain(void) = 0;                                 

    virtual bool Load(TagStream &f) = 0;                            
    virtual bool Save(TagStream &f) = 0;                            


    virtual int NumParameters(void) = 0;                            
    virtual bool ParameterVisible(int Index) = 0;                   
    virtual MVParamInfo *GetParamInfo(int Param) = 0;               
    virtual int GetParameter(int Index) = 0;                        
    virtual void SetParameter(int Index, int Value) = 0;            
};

#include "MVSourcePlug.h"

#endif

---

MidiVid GPU Version 1.0 Copyright (c) 2005 Jason Dorie and VUTAG

Generated on: Sun Jan 25 23:45:41 2009