MpResource.h

Go to the documentation of this file.

//  
// Copyright (C) 2006-2013 SIPez LLC.  All rights reserved.
//
// Copyright (C) 2004-2007 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 _MpResource_h_
#define _MpResource_h_

// SYSTEM INCLUDES
// APPLICATION INCLUDES
#include "os/OsDefs.h"
#include "os/OsRWMutex.h"
#include "os/OsStatus.h"
#include "os/OsMsgQ.h"
#include "utl/UtlContainable.h"
#include "utl/UtlString.h"
#include "mp/MpBuf.h"
#include "mp/MpResNotificationMsg.h"

// DEFINES
// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpFlowGraphBase;
class MpFlowGraphMsg;
class MpResourceMsg;


class MpResource : public UtlString
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

   friend class MpFlowGraphBase;

   typedef enum
   {
      NOT_VISITED,
      IN_PROGRESS,
      FINISHED
   } VisitState;

   enum
   {
      ASSOCIATED_LATENCY=-1, 
      INF_LATENCY=-1 
   };

static const UtlContainableType TYPE; 

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


   MpResource(const UtlString& rName, int minInputs, int maxInputs,
              int minOutputs, int maxOutputs);

   virtual ~MpResource();


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


   virtual UtlBoolean disable();
   static OsStatus disable(const UtlString& namedResource,
                           OsMsgQ& fgQ);
   virtual UtlBoolean enable();
   static OsStatus enable(const UtlString& namedResource,
                          OsMsgQ& fgQ);
   virtual void reset();

   static OsStatus setNotificationsEnabled(UtlBoolean enable,
                                           const UtlString& namedResource,
                                           OsMsgQ& fgQ);
   UtlBoolean handleMessages(OsMsgQ& msgQ);
   virtual UtlBoolean processFrame() = 0;
   void setVisitState(int newState);
   OsStatus sendNotification(MpResNotificationMsg::RNMsgType msgType);
   OsStatus sendNotification(MpResNotificationMsg& msg);
   virtual void setConnectionId(MpConnectionID connectionId);
   virtual void setStreamId(int streamId);
   virtual int getStreamId(void);

   virtual OsStatus pushBuffer(int inputPort, MpBufPtr& inputBuffer);

   virtual void reassignSSRC(void);


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


   static void resourceInfo(MpResource* pResource, int index);

   MpFlowGraphBase* getFlowGraph() const;
   void getInputInfo(int inPortIdx, MpResource*& rpUpstreamResource,
                     int& rUpstreamPortIdx);
   const UtlString &getName() const;

   void getOutputInfo(int outPortIdx, MpResource*& rpDownstreamResource,
                      int& rDownstreamPortIdx);
   int getVisitState();
   int maxInputs() const;

   int maxOutputs() const;

   int minInputs() const;

   int minOutputs() const;

   int numInputs() const;

   int numOutputs() const;

   virtual MpConnectionID getConnectionId(void) const;

   int reserveFirstUnconnectedInput();
   int reserveFirstUnconnectedOutput();
   UtlContainableType getContainableType() const;

   virtual OsStatus getCurrentLatency(int &latency, int input=0, int output=0) const;

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


   UtlBoolean isEnabled() const;

   UtlBoolean isInputConnected(int portIdx);
   UtlBoolean isInputUnconnected(int portIdx);
   UtlBoolean isOutputConnected(int portIdx);
   UtlBoolean isOutputUnconnected(int portIdx);
   UtlBoolean areNotificationsEnabled() const;
   virtual UtlBoolean isAsynchInput(int inputIndex);


/* //////////////////////////// PROTECTED ///////////////////////////////// */
protected:

   // Conn is a local class definition

   struct Conn
   {
      MpResource* pResource;    
      int         portIndex;    
      UtlBoolean  reserved;     
   };

   MpFlowGraphBase* mpFlowGraph;   
   MpConnectionID mConnectionId;   
   int            mStreamId;       
   UtlBoolean    mIsEnabled;       

   OsRWMutex    mRWMutex;          

   MpBufPtr*    mpInBufs;          
   MpBufPtr*    mpOutBufs;         
   Conn*        mpInConns;         
   Conn*        mpOutConns;        
   int          mMaxInputs;        
   int          mMaxOutputs;       
   int          mMinInputs;        
   int          mMinOutputs;       
   int          mNumActualInputs;  
   int          mNumActualOutputs; 
   int          mVisitState;       
   UtlBoolean   mNotificationsEnabled; 
   OsBSem       mLock;             

   static const OsTime sOperationQueueTimeout;

   virtual UtlBoolean handleMessage(MpFlowGraphMsg& fgMsg);
   virtual UtlBoolean handleMessage(MpResourceMsg& rMsg);
   virtual UtlBoolean handleEnable();

   virtual UtlBoolean handleDisable();

   void setInputBuffer(int inPortIdx, const MpBufPtr &pBuf);

   OsStatus postMessage(MpFlowGraphMsg& rMsg);
   OsStatus postMessage(MpResourceMsg& rMsg);
   UtlBoolean pushBufferDownsream(int outPortIdx, const MpBufPtr &pBuf);
   virtual OsStatus setFlowGraph(MpFlowGraphBase* pFlowGraph);
   virtual OsStatus setNotificationsEnabled(UtlBoolean enable);
   virtual UtlBoolean connectInput(MpResource& rFrom, int fromPortIdx, int toPortIdx);
   virtual UtlBoolean connectOutput(MpResource& rTo, int toPortIdx, int fromPortIdx);
   virtual UtlBoolean disconnectInput(int inPortIdx);
   virtual UtlBoolean disconnectOutput(int outPortIdx);
   void setName(const UtlString& rName);

/* //////////////////////////// PRIVATE /////////////////////////////////// */
private:

   MpResource(const MpResource& rMpResource);

   MpResource& operator=(const MpResource& rhs);

};

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

#endif  // _MpResource_h_