Home    News    Components    Get ViTooKi    Documentation    Community    Developers    @sf.net  

Info

Last update:
12 Feb 2007

Documentation

Doxygen LXR

RTSP Class Reference

<class description="" goes="" here=""> <short description=""> More...

#include <RTSP.hpp>

Inheritance diagram for RTSP:

List of all members.

Public Member Functions
bool	applyReqToSession (const char *req, u32 bytesRead, Session *ses)
bool	applyReqToSession (const char *req, u32 bytesRead, Session *ses, bool optionsCallback)
	wrapper method for applyReqToSession()
ContainerInfo *	parseResponseDescribe (const char *response, const char *url, char **serverName, list< rtx_group * > *groups=NULL)
	parses the response generated by a DESCRIBE (the SDP description) and builds a ContainerInfo object from this info.
int	parseResponseSetup (const char *buffer, int *sessionID, int *clientPort, int *serverPort, bool *unicast, char **ssrc, rtx_info *info=NULL)
	parses a reponse to a setup, returns the number of parameters successfully extracted.
void	generateDescribeForUrl (const char *url, const char *playerId, const TerminalCapabilities *tc=NULL, const UserPreferences *up=NULL)
void	generateSetup (const char *url, int trackId, int clientPort, bool unicast, u32 rtxPort=0, int sessionId=-1)
void	generatePlay (const char *url, u32 session, double startTime, double nptEnd, double maxPrefetch)
void	generatePause (const char *url, u32 session)
void	generateTeardown (const char *url, u32 session)
void	generateRedirect (const char *url, const char *newUrl, const time_t *redirectAllowedAtTimePoint=NULL)
void	generateFileNotFound ()
void	generateOk ()
void	generateSessionNotFound ()
void	generateInternalServerError ()
void	generateDestUnreachable ()
void	generateNotImplemented ()
void	generateBadCMD ()
void	generateIllegalTransport ()
void	generateNotEnoughBandwidth ()
void	generateInvalidParameter (const int numParams, const char *const *const param)
void	generateSetParameter (const char *url, u32 session, std::map< char *, char *, struct stringCompare > *params)
void	generateGetParameter (const char *url, const u32 session, const int numParams, const char **params)
void	parseGetParameter (const char *req, u32 *session, int *numParams, char ***params)
	parses a GET_PARAMETER
void	parseSetParameter (const char *req, u32 *session, std::map< char *, char *, struct stringCompare > *params)
	will parse a SET_PARAMETER
bool	parseCMDDescribe (Session *ses, const Url *fileName, const char *remaining, char **playerId)
bool	parseCMDSetup (Session *ses, const Url *fileName, const char *const remaining, bool *hasSessionKey, int *sesKey, char **protocols, char **unicast, int *esId, int *rPort, int *rPort2, bool *hasRtxPort, u32 *clientRtxPort, char **clientAddress=NULL)
bool	parseCMDPlay (Session *ses, const Url *filename, const char *remaining, int *sessionId, double *startTime, double *endTime, double *maxPrefetch)
void	parseCMDRedirect (Session *ses, const Url *fileName, const char *remaining, char **newUrl, time_t *redirectAllowedAtTimePoint)
	newUrl and redirectAllowedAtTimePoint are out parameters.
void	generateResponseGetParameter (std::map< char *, char *, struct stringCompare > *params)
bool	generateCMDDescribeReply (Session *ses, const Url *fileName, const char *sourceServerName, const char *playerId)
bool	generateSetupReply (Session *ses, const Url *fileName, const int sesKey, const char *protocols, const char *unicast, const char *sourceAddress, const int esId, const int rPort, const int rPort2, const int lport, const u32 clientRtxPort, const u32 serverRtxPort)
void	generateCMDnotSupportedReply ()
void	generateCMDOptionsReply ()
void	incSeqNr ()
void	decSeqNr ()
int	getLastStatus () const
const char *	getBuffer () const
int	getDefaultPort () const
int	generateSessionKey ()
int	extractSessionKeyFromCMD (const char *remaining)
	returns INVALID_SESSIONID if no sessionid was found
int	getSeqNr ()
	returns last sequence number
Static Public Member Functions
bool	isSupportedTransport (const char *protocols)
bool	isCmdOk (const char *buf)
u32	extractSessionId (const char *buffer)
char *	replaceSessionIdWith (u32 newId, const char *buffer)
void	doTest ()
void	freeMapMemory (std::map< char *, char *, struct stringCompare > *params)
Protected Types
enum	MSG_Type {   MSG_DESCRIBE, MSG_SETUP, MSG_PLAY, MSG_PAUSE,   MSG_OPTIONS, MSG_TEARDOWN, GET_PARAMETER, SET_PARAMETER,   MSG_REDIRECT, MSG_UNKNOWN }
	returns the sessionId which will be terminated
Protected Attributes
int	seqNr
int	lastStatus
char	buffer [MSG_BUFFER_SIZE]
bool	optionsCallback
Static Protected Attributes
const char *const	allowedCommands
const int	SL_PAYLOAD_TYPE = 96
const int	TTL = 16

---

Detailed Description

<class description="" goes="" here=""> <short description="">

Author:

Michael Kropfberger and Peter Schojer

Version:

Id

RTSP.hpp,v 1.15 2006/01/20 15:37:54 mkropfbe Exp

Definition at line 75 of file RTSP.hpp.

---

Member Function Documentation

void RTSP::generateRedirect (  const char *  url, const char *  newUrl, const time_t *  redirectAllowedAtTimePoint = NULL )

Parameters: url  contains the requested file newUrl  contains the new url that the client should use for the request redirectAllowedAtTimePoint  contains the time when the client is allowed to send the request to the new location. This is an optional parameter. Definition at line 1781 of file RTSP.cpp. { int offset=sprintf(buffer,"REDIRECT %s RTSP/1.0\r\n" "CSeq: %i\r\n" "Location: %s\r\n",url,seqNr,newUrl); if(redirectAllowedAtTimePoint) { struct tm* tl=localtime(redirectAllowedAtTimePoint); char timeStr[30]; strftime(timeStr, 30, "%Y%m%dT%H%M%SZ-", tl); sprintf(offset+buffer,"Range: clock=%s\r\n\r\n",timeStr); } else sprintf(buffer+offset,"\r\n"); }

void RTSP::generateSetup (  const char *  url, int  trackId, int  clientPort, bool  unicast, u32  rtxPort = 0, int  sessionId = -1 )

Parameters: rtxPort  specifies the client port used for retransmission, set to 0 to disable retransmisson, sessionId  should be -1 if you want the server to generate a sessionid Definition at line 1297 of file RTSP.cpp. { assert(url && trackId>=0 && clientPort>0); buffer[0]=0; char* mcast[]={"multicast","unicast"}; if(rtxPort==0) { if(sessionId<=0) { sprintf(buffer,"SETUP %s/trackID=%i RTSP/1.0\r\n" "CSeq: %i\r\n" "Transport: RTP/UDP;%s;client_port=%i-%i\r\n\r\n", url,trackId, seqNr, mcast[unicast ? 1 :0],clientPort,clientPort+1); } else { sprintf(buffer,"SETUP %s/trackID=%i RTSP/1.0\r\n" "CSeq: %i\r\n" "Session: %i\r\n" "Transport: RTP/UDP;%s;client_port=%i-%i\r\n\r\n", url,trackId, sessionId, seqNr, mcast[unicast ? 1 :0],clientPort,clientPort+1); } } else { if(sessionId<=0) { sprintf(buffer,"SETUP %s/trackID=%i RTSP/1.0\r\n" "CSeq: %i\r\n" "Transport: RTP/UDP;%s;client_port=%i-%i;client_rtx_port=%u\r\n\r\n", url,trackId, seqNr, mcast[unicast ? 1 :0],clientPort,clientPort+1,rtxPort); } else { sprintf(buffer,"SETUP %s/trackID=%i RTSP/1.0\r\n" "CSeq: %i\r\n" "Session: %i\r\n" "Transport: RTP/UDP;%s;client_port=%i-%i;client_rtx_port=%u\r\n\r\n", url,trackId, sessionId, seqNr, mcast[unicast ? 1 :0],clientPort,clientPort+1,rtxPort); } } };

void RTSP::parseCMDRedirect (  Session *  ses, const Url *  fileName, const char *  remaining, char **  newUrl, time_t *  redirectAllowedAtTimePoint )

newUrl and redirectAllowedAtTimePoint are out parameters. Memory for newUrl is reserved inside the function. Make sure that *newUrl=NULL prior callingDefinition at line 1800 of file RTSP.cpp. { assert(remaining); assert(*newUrl==NULL); // otherwise mem leak created assert(redirectAllowedAtTimePoint); time(redirectAllowedAtTimePoint); *newUrl=NULL; const char* pStr=strstr(remaining,"Location:"); if(!pStr) return; while(pStr[0]==' ') pStr++; // points to first char of url const char* pStrEnd=strstr(pStr,"\r\n"); if(!pStrEnd) // invalid request return; pStrEnd--; if(pStr>=pStrEnd) return; while(pStrEnd[0]==' ') pStrEnd--; //pStrEnd points to the last Char of the Url *newUrl=new char[pStrEnd-pStr+2]; strncpy(*newUrl,pStr,pStrEnd-pStr+1); (*newUrl)[pStrEnd-pStr+1]='\0'; // now search for timepoint pStr=strstr(remaining,"Range:"); if(!pStr) return; pStr=strstr(pStr,"clock="); if(!pStr) return; pStr+=strlen("clock="); //we now point to the first char of the timestring struct tm val; if(6==sscanf(pStr,"%4i%2i%2iT%2i%2i%2i", &val.tm_year,&val.tm_mon,&val.tm_mday,&val.tm_hour,&val.tm_min,&val.tm_sec)) { time_t t=mktime(&val); *redirectAllowedAtTimePoint=t; } };

void RTSP::parseGetParameter (  const char *  req, u32 *  session, int *  numParams, char ***  params )

parses a GET_PARAMETER Parameters: req  and extracts the list of parameters specified in the request numParams  contains the number of parameters requested, or 0 on error session  contains the session identifier, or 0 on error params  contains the strings of parameters requested: (*params)[0] will contain the first Definition at line 1594 of file RTSP.cpp. { assert(session && numParams && params); *session=0; *numParams=0; *params=NULL; const char* lptr=NULL; u32 length=0; lptr=strstr(request,"Session:"); if(lptr) { lptr+=strlen("Session:"); while(*lptr==' ') lptr++; sscanf(lptr,"%u",session); } lptr=strstr(request,"Content-Length:"); if(lptr) { lptr+=strlen("Content-Length:"); while(*lptr==' ') lptr++; sscanf(lptr,"%u",&length); } if(lptr && length>0) { // count \r\n to determine numParams const char* tptr=lptr; int p=0; while((tptr=strstr(tptr,"\r\n"))!=NULL) { p++; tptr+=2; } p-=3; // one \r\n from prev line, one empty line before + one after *numParams=p; *params=new char*[p]; // now extract single params tptr=lptr; p=0; while((tptr=strstr(tptr,"\r\n"))!=NULL) { if((tptr-lptr)>2) { // not an empty line (*params)[p]=new char[tptr-lptr+1]; strncpy((*params)[p],lptr,tptr-lptr); (*params)[p][tptr-lptr]='\0'; dprintf_full("RTSP::parseGetParameter found param %s\n",(*params)[p]); p++; } lptr=(tptr+=2); // next line } } };

ContainerInfo * RTSP::parseResponseDescribe (  const char *  response, const char *  url, char **  serverName, list< rtx_group * > *  groups = NULL )

parses the response generated by a DESCRIBE (the SDP description) and builds a ContainerInfo object from this info. Definition at line 816 of file RTSP.cpp. References ContainerInfo::addESInfo(), ESInfo::enableFrameStatistic(), and ContainerInfo::setIODHandle(). Referenced by ClientSession::connect(). { assert( response && url && serverName); // check if it is really an ok message if(!strstr(response,"RTSP/1.0 200 OK")) return NULL; const char* serverBegin=strstr(response,"Server:"); if(serverBegin) { serverBegin+=strlen("Server:"); while(*serverBegin==' ') serverBegin++; const char* serverEnd=strstr(serverBegin,"\r\n"); if(serverEnd) { *serverName=new char[serverEnd-serverBegin+1]; strncpy(*serverName,serverBegin,serverEnd-serverBegin); (*serverName)[serverEnd-serverBegin]='\0'; dprintf_full("RTSP::parseResponseDescribe extracted serverName %s\n",*serverName); } else *serverName=NULL; } else *serverName=NULL; ContainerInfo * mp4Info = new ContainerInfo(url, NULL, ContainerInfo::SDP); // search rtx_groups if(groups) { const char* grp=response; while( (grp=strstr(grp,"a=group:FID"))!=NULL ) { rtx_group* group=new rtx_group(NACK,0); grp+=strlen("a=group:FID"); if(2!=sscanf( grp, "%u %u", &(group->midESInfo), &(group->rtx->mId))) { delete group; } else { dprintf_full("RTSP::parseResponseDescribe found rtx group: mid %u midES %u\n", group->rtx->mId,group->midESInfo); groups->push_back(group); } } } // we have created the groups // extract iod const char *iod = strstr(response, "mpeg4-iod:"); iod = strstr(iod, "base64,"); if (iod) { iod += 7; // points to first char of iod // iod ends with ", there shouldn't be any space within the IOD // but there can be a \n! const char *temp2 = strchr(iod, '"'); int iodSizeEncoded = temp2 - iod; u8 iodHandle[MAX_IOD_SIZE]; //decode // int iodenclen = str_base64((char*)iod, iodSizeEncoded, iodHandle, MAX_IOD_SIZE, STR_BASE64_DECODE); int iodenclen = base64decode((unsigned char*)iod, iodSizeEncoded, iodHandle, MAX_IOD_SIZE); if (iodenclen <= 0) { //wrong or no IOD dprintf_err("RTSP::parseResponseDescribe: there was a wrong/empty IOD given... ignoring...\n"); } else // set decoded IOD mp4Info->setIODHandle(iodHandle, iodenclen); } // search for a=range:npt=0- 66.47000 double durSeconds=0; const char* temp2=strstr(response,"range:"); if(temp2) { temp2=strstr(temp2,"-"); if(temp2) { temp2++; sscanf(temp2,"%lf",&durSeconds); } } const char* media=NULL; const char* endOfMedia=NULL; const char* copy=response; // search media blocks // media blocks begin with m= while ((media = strstr(copy, "\nm=")) != NULL) { //media now points to first m= media += 3; copy = media; endOfMedia = strstr(copy, "\nm="); if (!endOfMedia) { // set to end of sdp desc. endOfMedia = media + strlen(media); } // we can have two different media blocks // one normal one which describes the media // or one rtx transmission block // detect this by searching "rtx" const char* pRtx=strstr(media,"rtx"); if(pRtx > media && pRtx < endOfMedia) { // we have a rtx entry // should we ignore it ? if(groups) parseSDP_RTXBlock(media,endOfMedia,groups); } else { ESInfo* es=parseSDPMediaBlock(media,endOfMedia, durSeconds,mp4Info,groups); if(es) { // add es to mp4info es->enableFrameStatistic(); mp4Info->addESInfo(es); } else { delete mp4Info; return NULL; } } } return mp4Info; };

int RTSP::parseResponseSetup (  const char *  buffer, int *  sessionID, int *  clientPort, int *  serverPort, bool *  unicast, char **  ssrc, rtx_info *  info = NULL )

parses a reponse to a setup, returns the number of parameters successfully extracted. Every return value below two should be considered as an illegal reponse. Parameters: buffer  is an IN-param, rest are OUT-params Definition at line 1397 of file RTSP.cpp. { if(!strstr(buffer,"RTSP/1.0 200 OK")) return 0; *ssrc=NULL; const char* pBuffer=NULL; int retVal=5; if(strstr(buffer,"multicast")) *unicast=false; else *unicast=true; pBuffer=strstr(buffer,"Session: "); if(pBuffer) sscanf(pBuffer,"%*s %i",sessionID); else { dprintf_err("RTSP.parseResponseSetup: no sessionID found???\n"); return 0; } pBuffer=strstr(buffer,"client_port="); if(pBuffer) { pBuffer+=strlen("client_port="); if(1!=sscanf(pBuffer,"%i",clientPort)) return 0; } pBuffer=strstr(buffer,"server_port="); if(pBuffer) { pBuffer+=strlen("server_port="); if(1!=sscanf(pBuffer,"%i",serverPort)) return 0; } // scan for ssrc pBuffer=strstr(buffer,"ssrc="); if(pBuffer) { pBuffer+=strlen("ssrc="); *ssrc=new char[9]; strncpy(*ssrc,pBuffer,8); (*ssrc)[8]='\0'; } else retVal--; // check for rtx, rtx is not a must-param, so exclude it from retval if(info) { u32 rtxSPort=0; u32 rtxCPort=0; pBuffer=strstr(buffer,"server_rtx_port="); if(pBuffer) { sscanf( (pBuffer+strlen("server_rtx_port=")), "%u",&rtxSPort); } pBuffer=strstr(buffer,"client_rtx_port="); if(pBuffer) { sscanf( (pBuffer+strlen("client_rtx_port=")), "%u",&rtxCPort); } info->localPort=rtxCPort; info->remotePort=rtxSPort; } return retVal; };

void RTSP::parseSetParameter (  const char *  req, u32 *  session, std::map< char *, char *, struct stringCompare > *  params )

will parse a SET_PARAMETER Parameters: req,writes  into session  the session identifier, and writes into (*params)[parameterkey] the pointer to a string. You MUST free the map memory with Rtsp::freeMapMemory Definition at line 1652 of file RTSP.cpp. { assert(remaining && session && params); *session=0; const char* lptr=strstr(remaining,"Session:"); if(lptr) { lptr+=strlen("Session:"); while(*lptr==' ') ++lptr; sscanf(lptr,"%u",session); } // no session could be valid, so continue always lptr=strstr(remaining,"Content-type:"); if( !(lptr && (lptr=strstr(lptr,"text/parameters")))) { dprintf_full("RTSP::parseSetParameter illegal content: X%sX\n",remaining); return; } // lptr points to text/.. lptr=strstr(lptr,"\r\n"); if(lptr) lptr+=2; else return; remaining=lptr; while((lptr=strstr(lptr,"\r\n")) != NULL) { if(lptr-remaining>2) { // we have a line starting with remaining // ending at pos lptr // we have two strings in this line "a: b" const char* sepToken=strstr(remaining,":"); if(!sepToken) return; char* param1=new char[sepToken-remaining+1]; strncpy(param1,remaining,sepToken-remaining); param1[sepToken-remaining]='\0'; sepToken++; //skip after : while(*sepToken == ' ') ++sepToken; char* param2=new char[lptr-sepToken+1]; strncpy(param2,sepToken,lptr-sepToken); param2[lptr-sepToken]='\0'; (*params)[param1]=param2; } remaining=(lptr+=2); } };

---

Member Data Documentation

const char *const RTSP::allowedCommands [static, protected]

Initial value: "OPTIONS, DESCRIBE, SETUP, PLAY, PAUSE, TEARDOWN, GET_PARAMETER, SET_PARAMETER, REDIRECT" Definition at line 97 of file RTSP.cpp.

---

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

• RTSP.hpp
• RTSP.cpp

© ViTooKi 2003 :: [Lite version] Created with Doxygen