MidiVid Home

MVSourcePlug.h

Go to the documentation of this file.

/*

    MVSourcePlug.h - MidVid Stream Source Plugin class definition

*/

#pragma once
#ifndef MVSOURCEPLUG_H__
#define MVSOURCEPLUG_H__

// Use the string "MVSourceChooserClass" as the class name for your custom control when you
// wish to display the standard file source chooser control on your plugin config panel.

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

    virtual bool IsFileSource(void) = 0;                
    virtual bool IsAnimated(void) = 0;                  
    virtual int NumExtensions(void) = 0;                
    virtual const char *GetExtension(int Num) = 0;      
    virtual const char *GetIdentifier(void) {return 0;} 

    virtual bool IsConfigurable(void) {return false;}   
    virtual bool Configure(HWND hWnd) {return true;}    

    virtual bool LoadConfig(TagStream &f) {return true;}    
    virtual bool SaveConfig(TagStream &f) {return true;}    
};


// ----------------------------------------------------------------------------
struct MVSourceInfo
{
    bool        bHasVideo, bHasAudio;
    int         Width, Height;
    D3DFORMAT   Format;
};

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

    virtual bool IsConfigurable(void) {return false;}   
    virtual bool IsFiniteLength(void) {return true;}    
    virtual bool Configure(HWND hWnd) {return true;}    

    // It is the responsibility of the plugin using a given source to call these two functions to load / save the configuration of a stream if required
    virtual bool LoadConfig(TagStream &f) {return true;}
    virtual bool SaveConfig(TagStream &f) {return true;}


    // These two functions must be called, if necessary, before calling the Open() function on a stream
    virtual void SetLoopPlay(bool bLoop) = 0;       
    virtual void SetPlayAudio(bool bAud) = 0;       
    virtual void SetForcePow2(bool bPow2) = 0;      

    virtual bool Open(const char *pFilename) = 0;   
    virtual bool GetInfo(MVSourceInfo &Info) = 0;   

    virtual bool HasAudio(void) = 0;                
    virtual void SetVolume(BYTE Val) = 0;           
    virtual void SetPan(BYTE Val) = 0;              

    virtual bool NoteOn(BYTE Velocity) = 0;         

    // Use these two functions to retrieve the info needed to render the source
    virtual Texture GetTexture(void) = 0;           
    virtual D3DXVECTOR2 *GetCoords(void) = 0;       

    virtual bool NoteOff(void) = 0;                 
    virtual void Close(void) = 0;                   

    virtual void Reset(void) = 0;                   

    // Return true on success, false on error
    virtual bool Update(int msElapsed, bool &bAtEnd, bool &bFrameChanged) = 0;      
};


/*
MVSourcePlug::IsConfigurable(void)                  //!< Can this source be configured? (local, per-stream)
MVSourcePlug::IsFiniteLength(void) {return true;}   //!< AVI or MPEG = true, BMP or VidCap = false
MVSourcePlug::Configure(HWND hWnd) {return true;}   //!< Execute configuration for the source (local, per-stream options only)

// It is the responsibility of the plugin using a given source to call these two functions to load / save the configuration of a stream if required
MVSourcePlug::LoadConfig(TagFile &f) {return true;} //!< Read the source config from the indicated file
MVSourcePlug::SaveConfig(TagFile &f) {return true;} //!< Write the source config to the indicated file


// These two functions must be called, if necessary, before calling the Open() function on a stream
MVSourcePlug::SetLoopPlay(bool bLoop) = 0;      //!< For file sources - Specify that the file should loop back to the beginning during playback
MVSourcePlug::SetPlayAudio(bool bAud) = 0;      //!< For file sources - Specify that the file should stream audio during playback (if available)
MVSourcePlug::SetForcePow2(bool bPow2) = 0;     //!< Enforce power-of-two sizing, scaling if necessary, as tiling will be used

MVSourcePlug::Open(const char *pFilename) = 0;  //!< Open the file (files) or just initialize the source (non-files) - true = success
MVSourcePlug::GetInfo(MVSourceInfo &Info) = 0;  //!< Retrieve information about the opened source

MVSourcePlug::HasAudio(void) = 0;               //!< Does the opened source contain audio data?
MVSourcePlug::SetVolume(BYTE Val) = 0;          //!< 0 - 127 == off to full
MVSourcePlug::SetPan(BYTE Val) = 0;             //!< 0 - 127 == left to right (64 = center)

MVSourcePlug::NoteOn(BYTE Velocity) = 0;            //!< To be called within NoteOn in the host plugin.  Velocity = 0 - 127

// Use these two functions to retrieve the info needed to render the source
MVSourcePlug::GetTexture(void) = 0;         //!< Retrieve the texture used to render the stream
MVSourcePlug::GetCoords(void) = 0;      //!< Retrieve the upper left & lower right texture coordinates the image resides in

MVSourcePlug::NoteOff(void) = 0;                    //!< To be called within NoteOff in the host plugin
MVSourcePlug::Close(void) = 0;                  //!< Close the stream, deallocate resources

MVSourcePlug::Reset(void) = 0;                  //!< "Manually" rewind the file back to the beginning

// Return true if you've completed a cycle, false if there are more frames
MVSourcePlug::Update(int msElapsed) = 0;            //!< Update the position in the file stream by the elapsed time
*/


#endif

---

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

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