vmcpdevice.hxx

Vovida 社区开源的 SIP 协议源码

#ifndef VmcpDevice_HXX
#define VmcpDevice_HXX

/* ====================================================================
 * The Vovida Software License, Version 1.0 
 * 
 * Copyright (c) 2000 Vovida Networks, Inc.  All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 
 * 3. The names "VOCAL", "Vovida Open Communication Application Library",
 *    and "Vovida Open Communication Application Library (VOCAL)" must
 *    not be used to endorse or promote products derived from this
 *    software without prior written permission. For written
 *    permission, please contact [e-mail].
 *
 * 4. Products derived from this software may not be called "VOCAL", nor
 *    may "VOCAL" appear in their name, without prior written
 *    permission of Vovida Networks, Inc.
 * 
 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE AND
 * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL VOVIDA
 * NETWORKS, INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT DAMAGES
 * IN EXCESS OF $1,000, NOR FOR ANY INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 * 
 * ====================================================================
 * 
 * This software consists of voluntary contributions made by Vovida
 * Networks, Inc. and many individuals on behalf of Vovida Networks,
 * Inc.  For more information on Vovida Networks, Inc., please see
 * <http://www.vovida.org/>.
 *
 */
static const char* const VmcpDevice_hxx_Version =
    "$Id: VmcpDevice.hxx,v 1.16 2002/03/19 21:40:17 jason Exp $";

#include "RtpSession.hxx"
#include "ResGwDevice.hxx"
#include "VMutex.h"
#include "Vmcp.h"
#include "PlayQueue.h"
#include "Recorder.h"
#include "VmTime.h"

namespace Vocal
{
    

/**
 * This class is used as a Sip Talking front end for voice mail server 
 * It talks Voice Mail Control Protocol with voicemail server.
 * It is used to control audio signals, it also handles the DTMF digits.
 */
class VmcpDevice: public ResGwDevice
{
    public:
        /// Creates a hardware object to control a single port gateway.
        VmcpDevice(char* hostName, int port,
                   Sptr < Fifo < Sptr < SipProxyEvent > > > inputQ,
                   Sptr < Fifo < Sptr < SipProxyEvent > > > outputQ );

        /// Destructor
        ~VmcpDevice(void);

        /// Starts the main processing loop of the hardware
        void* hardwareMain (void* parms);

        /// add device's socket to the fd
        /// returns 0 if successful, errorcode otherwise
        int addToFdSet (fd_set* fd);

        /// process all pending hardware events; returns 0 if successful,
        /// otherwise returns an errorcode.
        int process (fd_set* fd);

        /// start audio channel on device
        /// returns 0 if successful, errorcode otherwise
        int audioStart (const HardwareAudioRequest& request);

        /// stops audio channel on device
        /// returns 0 if successful, errorcode otherwise
        int audioStop (void);

        // process RTP audio packets
	void processRTP (); 

        /// instantiates a rtp session and reserves a rtp port
	int getRtpPort(); 

        /// release the port and deallocate the rtp session
 	void releaseRtpPort();

        /// DTMF handling callback function
        void recvRTPDTMF ( int digit, int duration );

    private:
        void provideDialToneStart();
        void provideDialToneStop();
        void provideLocalRingbackStart();
        void provideLocalRingbackStop();
        void provideBusyToneStart();
        void provideBusyToneStop();
        void provideFastBusyToneStart();
        void provideFastBusyToneStop();
        void provideCallWaitingBeepStart();
        void provideCallWaitingBeepStop();
        void provideRingStart();
        void provideRingStop();
        void provideDtmf(DeviceSignalType);
        void provideCallInfo(string, string, string);

        int audioSuspend()
        {
            return 0;
        }
        int audioResume(const HardwareAudioRequest &request)
        {
            return 0;
        }


        // output queue to notify endpoint of occurence of hardware events
        Sptr < Fifo < Sptr < SipProxyEvent > > > sessionQ;
        bool hasPlayed; 


        // VoiceMail Control Protocol stack
        Vmcp vm;

        char* myHostName;
        int myPortNumber;

        bool serverAvailable;

        struct timeval prevRtpPacketTime;

        // this is used to lock the RTP thread and the hardware thread so that
        // they don't access the hardware device simultaneously
        VMutex deviceMutex;

        string CallerId;
        string CalleeId;
        string ForwardReason;
        int NumberOfForwards;
        int fwdFlag;

        // Vmcp socket
	int ss; 	

        // RTP Stack
        RtpSession* audioStack;
        RtpPacket* inRtpPkt;
        RtpPacket* outRtpPkt;
        int packetCount;
        DTMFInterface* _DTMFInterface;

        // Player and recorder
        PlayQueue player;
        Recorder recorder;
        VmTime nextTime;

        int networkPktSize;
};
 
}


/* Local Variables: */
/* c-file-style: "stroustrup" */
/* indent-tabs-mode: nil */
/* c-file-offsets: ((access-label . -) (inclass . ++)) */
/* c-basic-offset: 4 */
/* End: */

#endif