inet::VoIPStreamReceiver Class Reference

#include <VoIPStreamReceiver.h>

Inheritance diagram for inet::VoIPStreamReceiver:

Classes
class	Connection

Public Member Functions
	VoIPStreamReceiver ()
	~VoIPStreamReceiver ()
virtual bool	handleOperationStage (LifecycleOperation *operation, int stage, IDoneCallback *doneCallback) override
	Perform one stage of a lifecycle operation. More...
Public Member Functions inherited from inet::ILifecycle
virtual	~ILifecycle ()

Protected Member Functions
virtual void	initialize (int stage) override
virtual int	numInitStages () const override
virtual void	handleMessage (cMessage *msg) override
virtual void	finish () override
virtual void	createConnection (VoIPStreamPacket *vp)
virtual void	checkSourceAndParameters (VoIPStreamPacket *vp)
virtual void	closeConnection ()
virtual void	decodePacket (VoIPStreamPacket *vp)

Protected Attributes
int	localPort = -1
simtime_t	playoutDelay
const char *	resultFile = nullptr
UDPSocket	socket
Connection	curConn

Static Protected Attributes
static simsignal_t	rcvdPkSignal = registerSignal("rcvdPk")
static simsignal_t	dropPkSignal = registerSignal("dropPk")
static simsignal_t	lostSamplesSignal = registerSignal("lostSamples")
static simsignal_t	lostPacketsSignal = registerSignal("lostPackets")
static simsignal_t	packetHasVoiceSignal = registerSignal("packetHasVoice")
static simsignal_t	connStateSignal = registerSignal("connState")
static simsignal_t	delaySignal = registerSignal("delay")

Constructor & Destructor Documentation

inet::VoIPStreamReceiver::VoIPStreamReceiver ( )

inline

{}

inet::VoIPStreamReceiver::~VoIPStreamReceiver

(

)

{
    closeConnection();
}

Member Function Documentation

void inet::VoIPStreamReceiver::checkSourceAndParameters ( VoIPStreamPacket *  vp )

protectedvirtual

Referenced by handleMessage().

{
    ASSERT(!curConn.offline);

    UDPDataIndication *udpCtrl = check_and_cast<UDPDataIndication *>(vp->getControlInfo());
    if (curConn.srcAddr != udpCtrl->getSrcAddr()
        || curConn.srcPort != udpCtrl->getSrcPort()
        || curConn.destAddr != udpCtrl->getDestAddr()
        || curConn.destPort != udpCtrl->getDestPort()
        || vp->getSsrc() != curConn.ssrc)
        throw cRuntimeError("Voice packet received from third party during a voice session (concurrent voice sessions not supported)");

    if (vp->getCodec() != curConn.codec
        || vp->getSampleBits() != curConn.sampleBits
        || vp->getSampleRate() != curConn.sampleRate
        || vp->getSamplesPerPacket() != curConn.samplesPerPacket
        || vp->getTransmitBitrate() != curConn.transmitBitrate
        )
        throw cRuntimeError("Cannot change voice encoding parameters a during session");
}

void inet::VoIPStreamReceiver::closeConnection ( )

protectedvirtual

Referenced by finish(), and ~VoIPStreamReceiver().

{
    if (!curConn.offline) {
        curConn.offline = true;
        avcodec_close(curConn.decCtx);
        avcodec_free_context(&curConn.decCtx);
        curConn.outFile.close();
        emit(connStateSignal, -1L);    // so that sum() yields the number of active sessions
    }
}

void inet::VoIPStreamReceiver::createConnection ( VoIPStreamPacket *  vp )

protectedvirtual

Referenced by handleMessage().

{
    ASSERT(curConn.offline);

    UDPDataIndication *udpCtrl = check_and_cast<UDPDataIndication *>(vp->getControlInfo());

    curConn.srcAddr = udpCtrl->getSrcAddr();
    curConn.srcPort = udpCtrl->getSrcPort();
    curConn.destAddr = udpCtrl->getDestAddr();
    curConn.destPort = udpCtrl->getDestPort();
    curConn.seqNo = vp->getSeqNo() - 1;
    curConn.timeStamp = vp->getTimeStamp();
    curConn.ssrc = vp->getSsrc();
    curConn.codec = (enum AVCodecID)(vp->getCodec());
    curConn.sampleBits = vp->getSampleBits();
    curConn.sampleRate = vp->getSampleRate();
    curConn.transmitBitrate = vp->getTransmitBitrate();
    curConn.samplesPerPacket = vp->getSamplesPerPacket();
    curConn.lastPacketFinish = simTime() + playoutDelay;

    curConn.pCodecDec = avcodec_find_decoder(curConn.codec);
    if (curConn.pCodecDec == nullptr)
        throw cRuntimeError("Codec %d not found", curConn.codec);

    curConn.decCtx = avcodec_alloc_context3(curConn.pCodecDec);
    curConn.decCtx->bit_rate = curConn.transmitBitrate;
    curConn.decCtx->sample_rate = curConn.sampleRate;
    curConn.decCtx->channels = 1;
    curConn.decCtx->bits_per_coded_sample = curConn.sampleBits;

    int ret = avcodec_open2(curConn.decCtx, curConn.pCodecDec, nullptr);
    if (ret < 0)
        throw cRuntimeError("could not open decoding codec %d (%s): err=%d", curConn.codec, curConn.pCodecDec->name, ret);

    curConn.openAudio(resultFile);
    curConn.offline = false;
    emit(connStateSignal, 1);
}

void inet::VoIPStreamReceiver::decodePacket ( VoIPStreamPacket *  vp )

protectedvirtual

Referenced by handleMessage().

{
    switch (vp->getType()) {
        case VOICE:
            emit(packetHasVoiceSignal, 1);
            break;

        case SILENCE:
            emit(packetHasVoiceSignal, 0);
            break;

        default:
            throw cRuntimeError("The received VoIPStreamPacket has unknown type %d", vp->getType());
    }
    uint16_t newSeqNo = vp->getSeqNo();
    if (newSeqNo > curConn.seqNo + 1)
        emit(lostPacketsSignal, newSeqNo - (curConn.seqNo + 1));

    if (simTime() > curConn.lastPacketFinish) {
        int lostSamples = ceil(SIMTIME_DBL((simTime() - curConn.lastPacketFinish) * curConn.sampleRate));
        ASSERT(lostSamples > 0);
        EV_INFO << "Lost " << lostSamples << " samples\n";
        emit(lostSamplesSignal, lostSamples);
        curConn.writeLostSamples(lostSamples);
        curConn.lastPacketFinish += lostSamples * (1.0 / curConn.sampleRate);
        FINGERPRINT_ADD_EXTRA_DATA(lostSamples);
    }
    emit(delaySignal, curConn.lastPacketFinish - vp->getCreationTime());
    curConn.seqNo = newSeqNo;

    int len = vp->getBytes().getDataArraySize();
    uint8_t buff[len];
    vp->getBytes().copyDataToBuffer(buff, len);
    curConn.writeAudioFrame(buff, len);
    FINGERPRINT_ADD_EXTRA_DATA2((const char *)buff, len);
}

void inet::VoIPStreamReceiver::finish ( )

overrideprotectedvirtual

{
    EV_TRACE << "Sink finish()" << endl;
    closeConnection();
}

void inet::VoIPStreamReceiver::handleMessage ( cMessage *  msg )

overrideprotectedvirtual

{
    if (msg->getKind() == UDP_I_ERROR) {
        delete msg;
        return;
    }

    VoIPStreamPacket *vp = check_and_cast<VoIPStreamPacket *>(msg);
    bool ok = true;
    if (curConn.offline)
        createConnection(vp);
    else {
        checkSourceAndParameters(vp);
        ok = vp->getSeqNo() > curConn.seqNo && vp->getTimeStamp() > curConn.timeStamp;
    }

    if (ok) {
        emit(rcvdPkSignal, vp);
        decodePacket(vp);
    }
    else
        emit(dropPkSignal, msg);

    delete msg;
}

bool inet::VoIPStreamReceiver::handleOperationStage ( LifecycleOperation *  operation, int  stage, IDoneCallback *  doneCallback  )

overridevirtual

Perform one stage of a lifecycle operation.

Processing may be done entirely within this method, or may be a longer process that involves nonzero simulation time or several events, and is triggered by this method call.

Return value: true = "done"; false = "not yet done, will invoke doneCallback when done"

Implements inet::ILifecycle.

{
    Enter_Method_Silent();
    throw cRuntimeError("Unsupported lifecycle operation '%s'", operation->getClassName());
    //return true;
}

void inet::VoIPStreamReceiver::initialize ( int  stage )

overrideprotectedvirtual

{
    cSimpleModule::initialize(stage);

    if (stage == INITSTAGE_LOCAL) {
        // Hack for create results folder
        recordScalar("hackForCreateResultsFolder", 0);

        // Say Hello to the world
        EV_TRACE << "VoIPSinkApp initialize()" << endl;

        // read parameters
        localPort = par("localPort");
        resultFile = par("resultFile");
        playoutDelay = par("playoutDelay");

        // initialize avcodec library
        av_register_all();
    }
    else if (stage == INITSTAGE_APPLICATION_LAYER) {
        bool isOperational;
        NodeStatus *nodeStatus = dynamic_cast<NodeStatus *>(findContainingNode(this)->getSubmodule("status"));
        isOperational = (!nodeStatus) || nodeStatus->getState() == NodeStatus::UP;
        if (!isOperational)
            throw cRuntimeError("This module doesn't support starting in node DOWN state");

        socket.setOutputGate(gate("udpOut"));
        socket.bind(localPort);
    }
}

virtual int inet::VoIPStreamReceiver::numInitStages ( ) const

inlineoverrideprotectedvirtual

{ return NUM_INIT_STAGES; }

Member Data Documentation

simsignal_t inet::VoIPStreamReceiver::connStateSignal = registerSignal("connState")

staticprotected

Referenced by closeConnection(), and createConnection().

Connection inet::VoIPStreamReceiver::curConn

protected

Referenced by checkSourceAndParameters(), closeConnection(), createConnection(), decodePacket(), and handleMessage().

simsignal_t inet::VoIPStreamReceiver::delaySignal = registerSignal("delay")

staticprotected

Referenced by decodePacket().

simsignal_t inet::VoIPStreamReceiver::dropPkSignal = registerSignal("dropPk")

staticprotected

Referenced by handleMessage().

int inet::VoIPStreamReceiver::localPort = -1

protected

Referenced by initialize().

simsignal_t inet::VoIPStreamReceiver::lostPacketsSignal = registerSignal("lostPackets")

staticprotected

Referenced by decodePacket().

simsignal_t inet::VoIPStreamReceiver::lostSamplesSignal = registerSignal("lostSamples")

staticprotected

Referenced by decodePacket().

simsignal_t inet::VoIPStreamReceiver::packetHasVoiceSignal = registerSignal("packetHasVoice")

staticprotected

Referenced by decodePacket().

simtime_t inet::VoIPStreamReceiver::playoutDelay

protected

Referenced by createConnection(), and initialize().

simsignal_t inet::VoIPStreamReceiver::rcvdPkSignal = registerSignal("rcvdPk")

staticprotected

Referenced by handleMessage().

const char* inet::VoIPStreamReceiver::resultFile = nullptr

protected

Referenced by createConnection(), and initialize().

UDPSocket inet::VoIPStreamReceiver::socket

protected

Referenced by initialize().

---

The documentation for this class was generated from the following files:

• VoIPStreamReceiver.h
• VoIPStreamReceiver.cc