MediaController::Rtsp::Commands Class Reference

Establishes and controls an RTSP stream. More...

#include <RtspCommands.h>

Public Member Functions
	Commands (const std::string &streamUri, bool isVideo)
	Constructor. More...
	~Commands ()
	Destructor. More...
bool	Options ()
	Send the OPTIONS method and read the server response. More...
bool	GetParameter ()
	Send the GET_PARAMETER method and read the server response. More...
bool	Describe (bool firstAttempt=false)
	Send the DESCRIBE method and read the server response. More...
bool	Setup (bool firstAttempt=false)
	Send the SETUP method and read the server response. More...
void	Pause ()
	Send the PAUSE method and read the server response. More...
bool	SetupStream (GstWrapper *gstwrapper, float speed=0, unsigned int unixTime=0)
	Send the PLAY method with a Range header and read the server response. More...
void	PlayStream (GstWrapper *gstwrapper)
	Create a pipe line More...
void	Teardown ()
	Send the TEARDOWN method and read the server response. More...
void	ResetPath (const std::string &streamUri)
	Reset the RTSP stream location. More...
std::string	GetSessionId () const
	Get the current session ID for the video stream. More...

Private Member Functions
void	GetSocket (const std::string &uriString, int bindPort)
	Get the existing socket connection or return a new socket. More...
void	ClearSocket ()
	Clear any existing socket connections. More...

Private Attributes
std::string	_sessionId
std::string	_baseUri
std::string	_controlUri
std::string	_uuid
SdpParser	_sdp
int	_dataPort
int	_rtcpPort
int	_cSeqNum
boost::asio::io_service	_ioService
boost::asio::ip::tcp::socket	_pSocket
boost::asio::ip::tcp::socket	_rSocket
bool	_isVideo

Detailed Description

Establishes and controls an RTSP stream.

Definition at line 13 of file RtspCommands.h.

Constructor & Destructor Documentation

Commands::Commands	(	const std::string &	streamUri,
		bool	isVideo
	)

Constructor.

Parameters

streamUri	The location of the RTSP stream.
isVideo	Specifies wheather this command handles audio or video.

Definition at line 20 of file RtspCommands.cpp.

                                                        :
    _baseUri(streamUri),
    _controlUri(streamUri),
    _dataPort(0),
    _rtcpPort(0),
    _cSeqNum(0),
    _ioService(),
    _pSocket(_ioService),
    _rSocket(_ioService),
    _isVideo(isVideo) { }

MediaController::Rtsp::Commands::~Commands ( )

inline

Destructor.

Definition at line 26 of file RtspCommands.h.

                        {
                ClearSocket();
            }

Member Function Documentation

void Commands::ClearSocket ( )

private

Clear any existing socket connections.

Definition at line 394 of file RtspCommands.cpp.

{
    _pSocket.close();
    _rSocket.close();
}

bool Commands::Describe

(

bool

firstAttempt = false

)

Send the DESCRIBE method and read the server response.

Definition at line 97 of file RtspCommands.cpp.

                                         {
    // Increment the value for the CSeq field.
    _cSeqNum++;

    // Send the DESCRIBE request in the following format:
    // DESCRIBE {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Accept: application/sdp
    GetSocket(this->_controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kDescribe << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    requestStream << kHeaderAccept << kColonSpace << kSdpMimeType << kTwoNewLines;
    try { write(_pSocket, request); }
    catch (...) { return false; }

    // Parse the server response.
    Response resp = ProcessResponse(_pSocket);
    if (resp.statusCode != kStatusCode200) { return false; }
    // Parse the session description information.
    SdpParser& parser = this->_sdp;
    parser.Parse(resp.content);
    MediaDescription md;
    if (_isVideo)
        md = parser.GetFirstVideo();
    else
        md = parser.GetFirstAudio();

    if (!firstAttempt) {
        // Set up the pipeline variables to use the correct values based on the transport protocol.
        this->_dataPort = md.isMulticast ? md.port : _pSocket.local_endpoint().port();
        this->_rtcpPort = md.isMulticast ? md.port + 1 : _rSocket.local_endpoint().port();
    }

    if (!parser.sessionControlUri.empty() && parser.sessionControlUri != "*")
        this->_controlUri = parser.sessionControlUri;

    return true;
}

bool Commands::GetParameter

(

)

Send the GET_PARAMETER method and read the server response.

Definition at line 71 of file RtspCommands.cpp.

                            {
    // Increment the value for the CSeq field.
    _cSeqNum++;

    // Send the GET_PARAMETER request in the following format:
    // GET_PARAMETER {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Session: {_session}
    GetSocket(this->_controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kGetParameter << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    requestStream << kHeaderSession << kColonSpace << _sessionId << kTwoNewLines;
    try { write(_pSocket, request); }
    catch (...) { return false; }

    // Parse the server response.
    Response resp = ProcessResponse(_pSocket);
    if (resp.statusCode != kStatusCode200) { return false; }

    return true;
}

std::string MediaController::Rtsp::Commands::GetSessionId ( ) const

inline

Get the current session ID for the video stream.

Returns

The session ID.

Definition at line 83 of file RtspCommands.h.

{ return _sessionId; }

void Commands::GetSocket ( const std::string &  uriString, int  bindPort  )

private

Get the existing socket connection or return a new socket.

Parameters

uriString	The location of the media.
bindPort	The initial port to bind to.

Definition at line 347 of file RtspCommands.cpp.

                                                              {
    string ip, port;
    Extract(uriString, ip, port);

    boost::system::error_code ec;
    boost::asio::ip::tcp::endpoint endpoint = _pSocket.remote_endpoint(ec);
    if (ec) {
        _pSocket.open(boost::asio::ip::tcp::v4());
        _pSocket.bind(boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), 0));
        _rSocket.open(boost::asio::ip::tcp::v4());
        _rSocket.bind(boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), 0));

        boost::asio::ip::tcp::resolver resolver(_ioService);
        boost::asio::ip::tcp::resolver::query query(ip, port);
        boost::asio::ip::tcp::resolver::iterator endpointIterator = resolver.resolve(query);
        boost::asio::ip::tcp::resolver::iterator end;

        boost::system::error_code error = boost::asio::error::host_not_found;
        while (error && endpointIterator != end) {
            _pSocket.connect(*endpointIterator++, error);
        }
    }
    else if (endpoint.address().to_string() != ip || to_string(endpoint.port()) != port) {
        _pSocket.shutdown(boost::asio::socket_base::shutdown_both);
        _pSocket.close();
        _rSocket.close();
        _pSocket.open(boost::asio::ip::tcp::v4());
        _pSocket.set_option(boost::asio::ip::tcp::socket::reuse_address(true));
        _pSocket.bind(boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), bindPort));
        _rSocket.open(boost::asio::ip::tcp::v4());
        _rSocket.bind(boost::asio::ip::tcp::endpoint(boost::asio::ip::tcp::v4(), 0));

        boost::asio::ip::tcp::resolver resolver(_ioService);
        boost::asio::ip::tcp::resolver::query query(ip, port);
        boost::asio::ip::tcp::resolver::iterator endpointIterator = resolver.resolve(query);
        boost::asio::ip::tcp::resolver::iterator end;

        boost::system::error_code error = boost::asio::error::host_not_found;
        while (error && endpointIterator != end) {
            _pSocket.connect(*endpointIterator++, error);
        }
    }
}

bool Commands::Options

(

)

Send the OPTIONS method and read the server response.

Definition at line 31 of file RtspCommands.cpp.

                       {
    // Reset the value for the CSeq field.
    _cSeqNum = 0;

    // Send the OPTIONS request in the following format:
    // OPTIONS {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    GetSocket(this->_controlUri, this->_dataPort);
    this->_dataPort = _pSocket.local_endpoint().port();
    this->_rtcpPort = _rSocket.local_endpoint().port();
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kOptions << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kTwoNewLines;
    try { write(_pSocket, request); }
    catch (...) { return false; }

    // Parse the server response.
    Response resp = ProcessResponse(_pSocket);
    if (resp.statusCode == kStatusCode301 || resp.statusCode == kStatusCode302) {
        // Set the playback URI to the redirect location.
        typedef std::map<std::string, std::string>::iterator it_type;
        for (it_type iterator = resp.headers.begin(); iterator != resp.headers.end(); ++iterator) {
            string name = iterator->first;
            std::transform(name.begin(), name.end(), name.begin(), ::tolower);
            if (name == kLowerCaseHeaderLocation) {
                this->_controlUri = iterator->second;
                Options();
                break;
            }
        }
    }
    
    if (resp.statusCode != kStatusCode200) { return false; }
    
    return true;
}

void Commands::Pause

(

)

Send the PAUSE method and read the server response.

Definition at line 279 of file RtspCommands.cpp.

                     {
    // Increment the value for the CSeq field.
    _cSeqNum++;

    // Send the PAUSE request in the following format:
    // PAUSE {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Session: {_sessionId}
    GetSocket(this->_controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kPause << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    requestStream << kHeaderSession << kColonSpace << this->_sessionId << kTwoNewLines;
    try { write(_pSocket, request); }
    catch (...) { return; }

    // Parse the server response.
    ProcessResponse(_pSocket);
}

void Commands::PlayStream

(

MediaController::GstWrapper *

gstwrapper

)

Create a pipe line

Definition at line 252 of file RtspCommands.cpp.

                                                               {
    if (!gstwrapper->IsPipelineActive()) {
        // Update the pipeline using the description generated above.
        gstwrapper->SetPorts(this->_dataPort, this->_rtcpPort);
        gstwrapper->SetRtcpHostIP(this->_pSocket.remote_endpoint().address().to_string());

        if (_isVideo) {
            MediaDescription md = this->_sdp.GetFirstVideo();
            if (md.isMulticast)
                gstwrapper->SetMulticastAddress(md.ip);
            if (md.payload == 26)
                md.encoding = "JPEG";

            gstwrapper->SetCaps("video" + BuildGstCaps(md));
            gstwrapper->CreateVideoRtspPipeline(md.encoding);
        }
        else {
            MediaDescription md = this->_sdp.GetFirstAudio();
            if (md.isMulticast)
                gstwrapper->SetMulticastAddress(md.ip);

            gstwrapper->SetCaps("audio" + BuildGstCaps(md));
            gstwrapper->CreateAudioRtspPipeline();
        }
    }
}

void Commands::ResetPath

(

const std::string &

streamUri

)

Reset the RTSP stream location.

Parameters

streamUri

The location of the RTSP stream.

Definition at line 332 of file RtspCommands.cpp.

                                                {
    this->_baseUri.clear();
    this->_controlUri.clear();
    this->_baseUri = this->_controlUri = streamUri;
}

bool Commands::Setup

(

bool

firstAttempt = false

)

Send the SETUP method and read the server response.

Definition at line 140 of file RtspCommands.cpp.

                                      {
    // Increment the value for the CSeq field.
    _cSeqNum++;
    MediaDescription md;
    if (_isVideo)
        md = this->_sdp.GetFirstVideo();
    else
        md = this->_sdp.GetFirstAudio();

    if (md.controlUri == "video" || md.controlUri == "audio")
        md.controlUri = _controlUri;

    // Send the SETUP request in the following format:
    // SETUP {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Transport: {md.protocol};unicast;client_port={_port}-{_port+1}
    GetSocket(md.controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kSetup << kWhitespace << md.controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    if (!firstAttempt)
        requestStream << kHeaderTransport << kColonSpace << md.protocol << kSemicolon << (md.isMulticast ? "multicast" : "unicast");
    else
        requestStream << kHeaderTransport << kColonSpace << md.protocol << kSemicolon << "unicast";

    requestStream << ";client_port=" <<this->_dataPort << "-" <<this->_rtcpPort << kTwoNewLines;
    try { write(_pSocket, request); }
    catch (...) { return false; }

    // Parse the server response.
    Response resp = ProcessResponse(_pSocket);
    if (resp.statusCode != kStatusCode200) { return false; }
    // Set the session ID using the UUID obtained from the server response.
    this->_sessionId = GetSessionUuid(resp.session);

    return true;
}

bool Commands::SetupStream	(	MediaController::GstWrapper *	gstwrapper,
		float	speed = 0,
		unsigned int	unixTime = 0
	)

Send the PLAY method with a Range header and read the server response.

Parameters

speed	The playback speed. Negative values can be used for reverse playback. A value of 0 will resume a paused stream.
unixTime	The start time for playback. A value of 0 will start a live stream.

Definition at line 181 of file RtspCommands.cpp.

                                                                                                    {
    // Increment the value for the CSeq field.
    _cSeqNum++;
    bool ret = false;

    // Send the PLAY request in the following format:
    // PLAY {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Session: {_sessionId}
    // Scale: {speed}
    // Range: clock={timeStr}
    string timeStr = Utilities::UnixTimeToRfc3339(unixTime);
    GetSocket(this->_controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kPlay << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    if (speed != 0)
        if (speed < 1.0f && speed > -1.0f)
            requestStream << kHeaderScale << kColonSpace << setprecision(1) << fixed << speed << kOneNewLine;
        else
            requestStream << kHeaderScale << kColonSpace << static_cast<int>(speed) << kOneNewLine;
    else
        requestStream << kHeaderRange << kColonSpace << "npt=0-" << kOneNewLine;

    if (unixTime != 0)
        requestStream << kHeaderRange << kColonSpace << "clock=" << timeStr.c_str() << kOneNewLine;

    requestStream << kHeaderSession << kColonSpace << this->_sessionId << kTwoNewLines;
    
    try { write(_pSocket, request); }
    catch (...) { return false; }

    // Parse the server response.
    Response resp = ProcessResponse(_pSocket);

    // If a redirect code was returned we need to tear down the current session and start a new one using the redirect location.
    if (resp.statusCode == kStatusCode301 || resp.statusCode == kStatusCode302) {
        // Set the playback URI to the redirect location.
        typedef std::map<std::string, std::string>::iterator it_type;
        for (it_type iterator = resp.headers.begin(); iterator != resp.headers.end(); ++iterator) {
            string name = iterator->first;
            std::transform(name.begin(), name.end(), name.begin(), ::tolower);
            if (name == kLowerCaseHeaderLocation) {
                this->_controlUri = iterator->second;
                break;
            }
        }

        if (int(speed) != 0)
            gstwrapper->SetMode(MediaController::Controller::kPlayback);
        else
            gstwrapper->SetMode(MediaController::Controller::kLive);

        // Send the sequence of RTSP commands needed to start a new stream using the new location.
#ifndef WIN32
        ClearSocket();
#endif
        Options();
        Describe();
        Setup();
        ret = SetupStream(gstwrapper, speed, unixTime);
    }
    else if (resp.statusCode == kStatusCode200)
        return true;

    return ret;
}

void Commands::Teardown

(

)

Send the TEARDOWN method and read the server response.

Definition at line 302 of file RtspCommands.cpp.

                        {
    // Increment the value for the CSeq field.
    _cSeqNum++;

    // Send the TEARDOWN request in the following format:
    // TEARDOWN {uri} RTSP/1.0
    // CSeq: {_cSeqNum}
    // User-Agent: Pelco VxSdk
    // Session: {_sessionId}
    GetSocket(this->_controlUri, this->_dataPort);
    boost::asio::streambuf request;
    ostream requestStream(&request);
    requestStream << kTeardown << kWhitespace << this->_controlUri << kWhitespace << kRtspVersion << kOneNewLine;
    requestStream << kHeaderCSeq << kColonSpace << _cSeqNum << kOneNewLine;
    requestStream << kHeaderUserAgent << kColonSpace << kActualUserAgent << kOneNewLine;
    requestStream << kHeaderSession << kColonSpace << this->_sessionId << kTwoNewLines;

    try { write(_pSocket, request); }
    catch (...) { return; }

    // Parse the server response.
    ProcessResponse(_pSocket);

    // Reset the value for the CSeq field.
    _cSeqNum = 0;
    // Reset the control URI
    this->_controlUri = _baseUri;
    this->_dataPort = this->_rtcpPort = 0;
}

Member Data Documentation

std::string MediaController::Rtsp::Commands::_baseUri

private

Definition at line 89 of file RtspCommands.h.

std::string MediaController::Rtsp::Commands::_controlUri

private

Definition at line 90 of file RtspCommands.h.

int MediaController::Rtsp::Commands::_cSeqNum

private

Definition at line 95 of file RtspCommands.h.

int MediaController::Rtsp::Commands::_dataPort

private

Definition at line 93 of file RtspCommands.h.

boost::asio::io_service MediaController::Rtsp::Commands::_ioService

private

Definition at line 96 of file RtspCommands.h.

bool MediaController::Rtsp::Commands::_isVideo

private

Definition at line 99 of file RtspCommands.h.

boost::asio::ip::tcp::socket MediaController::Rtsp::Commands::_pSocket

private

Definition at line 97 of file RtspCommands.h.

boost::asio::ip::tcp::socket MediaController::Rtsp::Commands::_rSocket

private

Definition at line 98 of file RtspCommands.h.

int MediaController::Rtsp::Commands::_rtcpPort

private

Definition at line 94 of file RtspCommands.h.

SdpParser MediaController::Rtsp::Commands::_sdp

private

Definition at line 92 of file RtspCommands.h.

std::string MediaController::Rtsp::Commands::_sessionId

private

Definition at line 88 of file RtspCommands.h.

std::string MediaController::Rtsp::Commands::_uuid

private

Definition at line 91 of file RtspCommands.h.

---

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

• C:/Git/VxSDK-Samples/MediaController/Include/RtspCommands.h
• C:/Git/VxSDK-Samples/MediaController/Source/RtspCommands.cpp