---

pv_plugin_interfaces.h

Go to the documentation of this file.

/*
* ==============================================================================
*  Name        : pv_plugin_interfaces.h
*  Part of     :
*  Interface   :
*  Description : Defines the general plugin interfaces for the PV engines
*  Version     : (see RELEASE field in copyright header above)
*
* ==============================================================================
*/

#ifndef PV_PLUGIN_INTERFACES_H_INCLUDED
#define PV_PLUGIN_INTERFACES_H_INCLUDED


//  INCLUDES
#include "pv_common_symbian_types.h"

// CONSTANTS
const TInt KPVUidDataSrcPrime   = 0xFFFFFF08;
const TInt KPVUidDataSrcPlay    = 0xFFFFFF09;
const TInt KPVUidDataSrcPause   = 0xFFFFFF0A;
const TInt KPVUidDataSrcStop    = 0xFFFFFF0B;

const TInt KPVUidDataSinkPrime  = 0xFFFFFF0C;
const TInt KPVUidDataSinkPlay   = 0xFFFFFF0D;
const TInt KPVUidDataSinkPause  = 0xFFFFFF0E;
const TInt KPVUidDataSinkStop   = 0xFFFFFF0F;


const TUid KPVUidYUVFrameBuffer = {0xFFFFFF0d};


// MACROS
#define KPVUidAudioInputInterface             TPVUuid(0x194e8655,0x944c,0x402c,0xb0,0xc2,0xf7,0xbd,0xd5,0xe5,0x43,0x2f)

#define KPVUidDevSoundAudioInputInterface     TPVUuid(0x9e2c416e,0x0299,0x4775,0x88,0xfa,0x42,0x53,0xbc,0xbc,0x58,0xbf)

#define KPVUidAudioOutputInterface            TPVUuid(0xf5c5b825,0x90eb,0x4091,0xbe,0xea,0xa0,0xc3,0x9b,0xe2,0x00,0xaf)

#define KPVUidDevSoundAudioOutputInterface    TPVUuid(0x48edb46a,0x60e4,0x4e83,0xb1,0xad,0x92,0xa8,0xd4,0x07,0x04,0x7a)

#define KPVUidVideoInputInterface             TPVUuid(0xfb320151,0x6d06,0x4bd5,0xa2,0x68,0x61,0x01,0xdb,0x25,0x1c,0x0e)

#define KPVUidVideoOutputInterface            TPVUuid(0x0bb9d8a8,0x9623,0x4dec,0x84,0x0b,0xb9,0xf2,0x66,0xf8,0x4e,0x3d)

#define KPVUidProxiedInterface                TPVUuid(0xf7076653,0x6088,0x47c6,0x88,0xc1,0xb7,0xed,0x28,0xe7,0x2b,0xea)


// DATA TYPES


// FUNCTION PROTOTYPES


// FORWARD DECLARATIONS



// CLASS DECLARATION
class MPVPluginBase
{
    public:
        virtual ~MPVPluginBase() {}

        IMPORT_C virtual const RArray<TPVMIMEType *>& GetMultimediaTypesL() const = 0;

        IMPORT_C virtual void QueryUUID(const TPVMIMEType& aMimeType, RArray<TPVUuid>& aUuids, bool aExactUuidsOnly = false) = 0;

        IMPORT_C virtual void QueryInterface(const TPVUuid& aUuid, TPVInterfacePtr& aInterfacePtr) = 0;
};

//#define USE_MMF_DATA_PATH 1

#if defined USE_MMF_DATA_PATH

#define MPVDataSourceBase MDataSource
#define MPVDataSinkBase MDataSink

#else /* USE_MMF_DATA_PATH */

// forward declaration
class MPVDataSinkBase;

class MPVDataSourceBase
{
    public:
        MPVDataSourceBase(TUid aType): iDataSourceType(aType) {}
        virtual ~MPVDataSourceBase() {}

        virtual void FillBufferL(CMMFBuffer* aBuffer, MPVDataSinkBase* aConsumer, TMediaId /*aMediaId*/) = 0;

        virtual void BufferEmptiedL(CMMFBuffer* aBuffer) = 0;

        virtual TBool CanCreateSourceBuffer() = 0;

        virtual CMMFBuffer* CreateSourceBufferL(TMediaId /*aMediaId*/, TBool &/*aReference*/)
        {
            return NULL;
        }


        virtual CMMFBuffer* CreateSourceBufferL(TMediaId /*aMediaId*/, CMMFBuffer& /*aSinkBuffer*/, TBool &/*aReference*/)
        {
            return NULL;
        }


        virtual TInt SourceThreadLogon(MAsyncEventHandler& /*aEventHandler*/)
        {
            return KErrNone;
        }

        virtual void SourceThreadLogoff() {};

        virtual TInt SourcePrimeL()
        {
            return 0;
        }

        virtual TInt SourcePlayL()
        {
            return 0;
        };

        virtual TInt SourcePauseL()
        {
            return 0;
        };

        virtual TInt SourceStopL()
        {
            return 0;
        };
    private:
        TUid iDataSourceType;
};


class MPVDataSinkBase
{
    public:
        MPVDataSinkBase(TUid aType): iDataSinkType(aType) {}
        virtual ~MPVDataSinkBase() {}

        virtual void EmptyBufferL(CMMFBuffer* aBuffer, MPVDataSourceBase* aSupplier, TMediaId /*aMediaId*/) = 0;

        virtual void BufferFilledL(CMMFBuffer* aBuffer) = 0;

        virtual TBool CanCreateSinkBuffer() = 0;

        virtual CMMFBuffer* CreateSinkBufferL(TMediaId /*aMediaId*/, TBool &/*aReference*/)
        {
            return NULL;
        }

        virtual TInt SinkThreadLogon(MAsyncEventHandler& /*aEventHandler*/)
        {
            return KErrNone;
        };

        virtual void SinkThreadLogoff() {};

        virtual TInt SinkPrimeL()
        {
            return 0;
        };

        virtual TInt SinkPlayL()
        {
            return 0;
        };

        virtual TInt SinkPauseL()
        {
            return 0;
        };

        virtual TInt SinkStopL()
        {
            return 0;
        };
    private:
        TUid iDataSinkType;
};

#endif



class MPVDataSource : public MPVPluginBase, public MPVDataSourceBase
{
    public:
        MPVDataSource(TUid aSourceType) : MPVDataSourceBase(aSourceType) {}
        virtual ~MPVDataSource() {}
};


class MPVDataSink : public MPVPluginBase, public MPVDataSinkBase
{
    public:
        MPVDataSink(TUid aSinkType) : MPVDataSinkBase(aSinkType) {}
        virtual ~MPVDataSink() {}
};


class MPVDataSourceAndSink :
            public MPVPluginBase,
            public MPVDataSourceBase,
            public MPVDataSinkBase
{
    public:
        MPVDataSourceAndSink(TUid aSourceType, TUid aSinkType) :
                MPVDataSourceBase(aSourceType),
                MPVDataSinkBase(aSinkType)
        {}
        virtual ~MPVDataSourceAndSink() {}
};


class MPVAudioInput
{
    public:
        //To set data format using MIME string.
        IMPORT_C virtual void SetFormatL(const TDesC8& aFormat, const TDesC8& aFmtSpecific, TInt &aMaxRequestSize) = 0;

        //To set sample rate and number of channels using MIME string.
        IMPORT_C virtual void SetConfigL(const TDesC8& aSampleRate
                                         , const TDesC8& aChannels) = 0;

        //To cancel current command.
        IMPORT_C virtual void CancelCommand() = 0;

        //To reset hardware.
        IMPORT_C virtual TInt Reset() = 0;
};


//Additional methods for DevSound audio source.
class MPVDevSoundAudioInput
{
    public:
        IMPORT_C virtual void SetPrioritySettings(const TMMFPrioritySettings &aSettings) = 0;
        IMPORT_C virtual void SetInputFormatL(const TDesC8& aFormat, MPVDataSourceBase *) = 0;
        IMPORT_C virtual TPVAudioOutputSwitch OutputSwitch() = 0;
        IMPORT_C virtual TBool FillAmrBuffersToEnd() = 0;
};


class MPVAudioOutput
{
    public:
        //To set data format using MIME string.
        IMPORT_C virtual void SetFormatL(const TDesC8& aFormat) = 0;
        //To set sample rate and number of channels using MIME string.
        IMPORT_C virtual void SetConfigL(const TDesC8& aSampleRate
                                         , const TDesC8& aChannels) = 0;
        //To cancel current command.
        IMPORT_C virtual void CancelCommand() = 0;
        //To reset hardware.
        IMPORT_C virtual TInt Reset() = 0;
};


//Additional methods for DevSound audio sink.
class MPVDevSoundAudioOutput
{
    public:
        IMPORT_C virtual void SetPrioritySettings(const TMMFPrioritySettings &aSettings) = 0;
        IMPORT_C virtual void ConcealErrorForNextBuffer() = 0;
        IMPORT_C virtual void SetOutputFormatL(const TDesC8& aFormat, const TDesC8& aFmtSpecific, MPVDataSinkBase* aConsumer, TInt &aMaxRequestSize) = 0;
        IMPORT_C virtual TPVAudioOutputSwitch OutputSwitch() = 0;
        IMPORT_C virtual TBool FillAmrBuffersToEnd() = 0;
};


class MPVVideoInput
{
    public:

        IMPORT_C virtual void SetFormatL(const TDesC8& aFormat) = 0;

        IMPORT_C virtual void SetFrameRateL(TReal32 aFrameRate) = 0;

        IMPORT_C virtual void SetVideoFrameSizeL(const TSize& aSize) = 0;

        IMPORT_C virtual void GetVideoFrameSizeL(TSize& aSize) const = 0;
};


class MPVVideoOutput
{
    public:
        IMPORT_C virtual void SetFormatL(const TDesC8& aFormat) = 0;

        IMPORT_C virtual void SetVideoFrameSizeL(const TSize& aSize) = 0;

        IMPORT_C virtual void GetVideoFrameSizeL(TSize& aSize) const = 0;
};


typedef TAny* RPvCommServer;

typedef MPVPluginBase MPVCommServerBase;

class MPVYuvFrameBuffer
{
    public:
        virtual ~MPVYuvFrameBuffer() {}
        virtual TSize GetFrameSize()const = 0;
};


#define PV_YUV_BUFFER_DEF_WIDTH  176
#define PV_YUV_BUFFER_DEF_HEIGHT 144
class CPVMMFPointerBuffer : public CMMFDataBuffer, public MPVYuvFrameBuffer
{
    public:
        static CPVMMFPointerBuffer* NewL()
        {
            CPVMMFPointerBuffer* buf = new(ELeave) CPVMMFPointerBuffer();
            return buf;
        }
        ~CPVMMFPointerBuffer()
        {
        }
        virtual TDes8& Data()
        {
            return iPtr;
        }
        virtual const TDesC8& Data() const
        {
            return iPtr;
        }
        virtual void SetRequestSizeL(TInt aSize)
        {
            (void)(aSize);
        }
        virtual TUint BufferSize() const
        {
            return iPtr.Size();
        }
        void SetData(TUint8* aData, TInt aLength)
        {
            iPtr.Set(aData, aLength, aLength);
        }

        void SetFrameSize(const TSize& size)
        {
            iFrameSize = size;
        }

        /* MPVYuvFrameBuffer virtuals */
        virtual TSize GetFrameSize()const
        {
            return iFrameSize;
        }
    private:
        CPVMMFPointerBuffer() : CMMFDataBuffer(KPVUidYUVFrameBuffer),
                iPtr(0, 0, 0),
                iFrameSize(TSize(PV_YUV_BUFFER_DEF_WIDTH, PV_YUV_BUFFER_DEF_HEIGHT)) {};

    private:
        TPtr8 iPtr;
        TSize iFrameSize;
};
#endif //

---