MpResourceTopology.h

Go to the documentation of this file.

//
// Copyright (C) 2006-2015 SIPez LLC.  All rights reserved.
//
// $$

// Author: Dan Petrie <dpetrie AT SIPez DOT com>

#ifndef _MpResourceTopology_h_
#define _MpResourceTopology_h_

// SYSTEM INCLUDES
#include <mp/MpTypes.h>
#include <os/OsStatus.h>
#include <utl/UtlString.h>
#include <utl/UtlDList.h>
#include <utl/UtlHashMap.h>

// APPLICATION INCLUDES
// DEFINES
#define DEFAULT_FROM_FILE_RESOURCE_NAME "FromFile1"
#define DEFAULT_FROM_INPUT_DEVICE_RESOURCE_NAME "FromMic1"
#define DEFAULT_BRIDGE_RESOURCE_NAME "Bridge1"
#define DEFAULT_VIDEO_MIXER_RESOURCE_NAME "VideoMixer1"
#define DEFAULT_SPEAKER_SELECTOR_RESOURCE_NAME "SpeakerSelector1"
#define DEFAULT_TONE_GEN_RESOURCE_NAME "ToneGen1"
#define DEFAULT_TONE_DETECT_RESOURCE_NAME "ToneDetect"
#define DEFAULT_TO_OUTPUT_DEVICE_RESOURCE_NAME "ToSpeaker1"
#define DEFAULT_SPEEX_PREPROCESS_RESOURCE_NAME "SpeexPreprocess"
#define DEFAULT_NULL_RESOURCE_NAME "Null1"
#define DEFAULT_RTP_INPUT_RESOURCE_NAME "InRtp-%d"
#define DEFAULT_VIDEO_RTP_INPUT_RESOURCE_NAME "InVideoRtp-%d"
#define DEFAULT_DECODE_RESOURCE_NAME "Decode-%d"
#define DEFAULT_RTP_OUTPUT_RESOURCE_NAME "OutRtp-%d"
#define DEFAULT_VIDEO_RTP_OUTPUT_RESOURCE_NAME "OutVideoRtp-%d"
#define DEFAULT_ENCODE_RESOURCE_NAME "Encode-%d"
#define DEFAULT_RECORDER_RESOURCE_NAME "CallRecorder"
#define DEFAULT_TO_OUTPUT_SPLITTER_RESOURCE_NAME "ToOutputSplitter1"
#define DEFAULT_VAD_RESOURCE_NAME "Vad"
#define DEFAULT_VOICE_ACTIVITY_NOTIFIER_RESOURCE_NAME "VoiceActivityNotifier"
#define DEFAULT_DELAY_RESOURCE_NAME "Delay"
#define DEFAULT_NOTCH_FILTER_RESOURCE_NAME "NotchFilter"

#define CONNECTION_NAME_SUFFIX "-%d"
#define STREAM_NAME_SUFFIX "-%d"
#define MIC_NAME_SUFFIX "-Mic"
#define SPEAKER_NAME_SUFFIX "-Spkr"
#define AEC_OUTPUT_BUFFER_RESOURCE_NAME_SUFFIX "-outBuffer"
#define AEC_NAME_SUFFIX "-AEC"
#define DIRECTION_IN_SUFFIX "-In"
#define DIRECTION_OUT_SUFFIX "-Out"

#define VIRTUAL_NAME_LOCAL_STREAM_OUTPUT "StreamOutput" MIC_NAME_SUFFIX

#define VIRTUAL_NAME_LOCAL_STREAM_INPUT "StreamInput" SPEAKER_NAME_SUFFIX

#define VIRTUAL_NAME_RTP_STREAM_OUTPUT "StreamOutput" CONNECTION_NAME_SUFFIX

#define VIRTUAL_NAME_CONNECTION_PORTS  "ConnectionPorts"

// MACROS
// EXTERNAL FUNCTIONS
// EXTERNAL VARIABLES
// CONSTANTS
// STRUCTS
// TYPEDEFS
// FORWARD DECLARATIONS
class MpResourceFactory;
class UtlHashMapIterator;

class MpResourceTopology
{
/* //////////////////////////// PUBLIC //////////////////////////////////// */
public:

    enum MpLogicalPortTypes
    {
        MP_TOPOLOGY_NEXT_AVAILABLE_PORT = -1
    };

    typedef UtlHashMapIterator* VirtualPortIterator;

    struct ResourceDef
    {
#if defined(_MSC_VER) && (_MSC_VER <= 1200)
       // Visual Studio 6.0 is broken when it comes to statically initializing
       // an array of structs containing object references, so in this case
       // just store const char* -- Note: this means reduced functionality
       // under VS6 -- only static names and types can be used here.
       const char* resourceType;
       const char* resourceName;
#else
       const UtlString resourceType;
       const UtlString resourceName;
#endif

       MpConnectionID connectionId;
       int streamId;
    };
    struct ConnectionDef
    {
#if defined(_MSC_VER) && (_MSC_VER <= 1200)
       // See above notice about VS6 being broken
       const char* outputResourceName;
#else
       const UtlString outputResourceName;
#endif

       int outputPortIndex;

#if defined(_MSC_VER) && (_MSC_VER <= 1200)
       // See above notice about VS6 being broken
       const char* inputResourceName;
#else
       const UtlString inputResourceName;
#endif

       int inputPortIndex;
    };

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

    MpResourceTopology();

    virtual ~MpResourceTopology();

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

   OsStatus addResource(const UtlString& resourceType,
                        const UtlString& resourceName,
                        MpConnectionID connectionId = MP_INVALID_CONNECTION_ID,
                        int streamId = -1);
   OsStatus addResources(const ResourceDef *defines, int numDefines);
   OsStatus addConnection(const UtlString& outputResourceName,
                          int outputPortIndex,
                          const UtlString& inputResourceName,
                          int inputPortIndex);

   OsStatus addConnections(const ConnectionDef *defines, int numDefines);
   OsStatus addVirtualInput(const UtlString& realResourceName,
                            int realPortIndex,
                            const UtlString& virtualResourceName,
                            int virtualPortIndex);
   OsStatus addVirtualOutput(const UtlString& realResourceName,
                             int realPortIndex,
                             const UtlString& virtualResourceName,
                             int virtualPortIndex);
   OsStatus validateConnections(UtlString& firstUnconnectedResourceName,
                                UtlString& firstDanglingResourceName,
                                UtlBoolean allowExternalResources = FALSE) const;
   OsStatus validateResourceTypes(MpResourceFactory& resourceFactory,
                                  int& firstInvalidResourceIndex) const;
   static void replaceNumInName(UtlString& resourceName,
                                int resourceNum);

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

   OsStatus getResource(int resourceIndex,
                        UtlString& resourceType,
                        UtlString& resourceName,
                        MpConnectionID& connectionId,
                        int& streamId) const;

   OsStatus getResource(int resourceIndex,
                        UtlString& resourceName) const;

   OsStatus getInputVirtualResource(const UtlString &virtualName,
                                    int virtualPort,
                                    UtlString& resourceName,
                                    int &resourcePort) const;

   OsStatus getOutputVirtualResource(const UtlString &virtualName,
                                     int virtualPort,
                                     UtlString& resourceName,
                                     int &resourcePort) const;

   OsStatus getConnection(int connectionIndex,
                          UtlString& outputResourceName,
                          int& outputPortIndex,
                          UtlString& inputResourceName,
                          int& inputPortIndex);

   int getNextLogicalPortNumber();
   void initVirtualInputIterator(VirtualPortIterator &portIter);

   void freeVirtualInputIterator(VirtualPortIterator &portIter);

   OsStatus getNextVirtualInput(VirtualPortIterator &portIter,
                                UtlString& realResourceName,
                                int &realPortIndex,
                                UtlString& virtualResourceName,
                                int &virtualPortIndex);
   void initVirtualOutputIterator(VirtualPortIterator &portIter);

   void freeVirtualOutputIterator(VirtualPortIterator &portIter);

   OsStatus getNextVirtualOutput(VirtualPortIterator &portIter,
                                 UtlString& realResourceName,
                                 int &realPortIndex,
                                 UtlString& virtualResourceName,
                                 int &virtualPortIndex);
    int dumpResources(UtlString& dumpString);

    int dumpConnections(UtlString& dumpString);

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

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

   int mPriorLogicalPort;
   UtlDList mResources;
   UtlDList mConnections;
   UtlHashMap mVirtualInputs;  
   UtlHashMap mVirtualOutputs; 

   int findResourceConnections(const UtlString& resourceName,
                               UtlContainer& connectionsToTraverse) const;

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

   MpResourceTopology(const MpResourceTopology& rMpResourceTopology);

   MpResourceTopology& operator=(const MpResourceTopology& rhs);
};

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

#endif  // _MpResourceTopology_h_