MprFromStream.h

Go to the documentation of this file.

//  
// Copyright (C) 2006 SIPez LLC. 
// Licensed to SIPfoundry under a Contributor Agreement. 
//
// Copyright (C) 2004-2006 SIPfoundry Inc.
// Licensed by SIPfoundry under the LGPL license.
//
// Copyright (C) 2004-2006 Pingtel Corp.  All rights reserved.
// Licensed to SIPfoundry under a Contributor Agreement.
//
// $$

#ifndef DISABLE_STREAM_PLAYER // [

#ifndef _MprFromStream_h_
#define _MprFromStream_h_

// SYSTEM INCLUDES

// APPLICATION INCLUDES
#include "mp/dtmflib.h"
#include "mp/MpFlowGraphMsg.h"
#include "mp/MpAudioResource.h"
#include "mp/StreamDefs.h"

#include "mp/MpStreamFeeder.h"
#include "os/OsLockingList.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
typedef struct tagSTREAMDESC
{
    StreamHandle    handle ;
    MpStreamFeeder* pFeeder ;

} STREAMDESC ;
// FORWARD DECLARATIONS



class MprFromStream : public MpAudioResource
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

/* ============================ CREATORS ================================== */


   MprFromStream(const UtlString& rName);
     //:Constructor

   virtual
   ~MprFromStream();
     //:Destructor


/* ============================ MANIPULATORS ============================== */


   OsStatus realize(Url urlSource,
                    int flags,
                    StreamHandle &handle,                    
                    OsNotification* event = NULL);

   OsStatus realize(UtlString* pBuffer,
                    int flags,
                    StreamHandle &handle,
                    OsNotification* event = NULL);

   OsStatus prefetch(StreamHandle handle);

   OsStatus play(StreamHandle handle);

   OsStatus rewind(StreamHandle handle);

   OsStatus pause(StreamHandle handle);
   
   OsStatus stop(StreamHandle handle) ;

   OsStatus destroy(StreamHandle handle) ;

   OsStatus getFlags(StreamHandle handle, int& flags) ;


/* ============================ ACCESSORS ================================= */



/* ============================ INQUIRY =================================== */



/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:
   OsStatus setStreamSource(MpStreamFeeder *pFeeder) ;
   MpStreamFeeder* getStreamSource() ;

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:
   typedef enum
   {     
      SOURCE_PLAY = MpFlowGraphMsg::RESOURCE_SPECIFIC_START,
      SOURCE_PAUSE,
      SOURCE_REWIND,
      SOURCE_STOP,
      SOURCE_DESTROY,
      SOURCE_RENDER
   } AddlMsgTypes;


   OsNotification* mpNotify;
   MpStreamFeeder* mpStreamRenderer;
   FeederEvent     mEventState;
   UtlBoolean      mbStreamChange;
   int             miStreamCount;      
   OsLockingList   mStreamList;        

   virtual UtlBoolean doProcessFrame(MpBufPtr inBufs[],
                                     MpBufPtr outBufs[],
                                     int inBufsSize,
                                     int outBufsSize,
                                     UtlBoolean isEnabled,
                                     int samplesPerFrame,
                                     int samplesPerSecond);

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& rMsg);

   UtlBoolean handleRender(MpStreamFeeder* pFeeder);
   UtlBoolean handlePlay(MpStreamFeeder* pFeeder);
   UtlBoolean handleRewind(MpStreamFeeder* pFeeder);
   UtlBoolean handlePause(MpStreamFeeder* pFeeder);
   UtlBoolean handleStop(MpStreamFeeder* pFeeder);
   UtlBoolean handleDestroy(MpStreamFeeder* pFeeder);
   

   MprFromStream(const MprFromStream& rMprFromStream);

   MprFromStream& operator=(const MprFromStream& rhs);

   MpStreamFeeder* getStreamFeeder(StreamHandle handle) ;

   MpStreamFeeder* removeStreamFeeder(StreamHandle handle) ;
   void destroyFeeders() ;

};

/* ============================ INLINE METHODS ============================ */

#endif  /* _MprFromStream_h_ */

#endif // DISABLE_STREAM_PLAYER ]