1 /*

     2 * Copyright (c) 2007 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:    Class for parsing a SDP.*

    15 */

    16 

    17 

    18 

    19 

    20 #ifndef CDVRSDPPARSER_H

    21 #define CDVRSDPPARSER_H

    22 

    23 // INCLUDES

    24 #include <e32base.h>

    25 

    26 // CONSTANTS

    27 // None

    28 

    29 // MACROS

    30 // None

    31 

    32 // DATA TYPES

    33 // None

    34 

    35 // FORWARD DECLARATIONS

    36 // None

    37 

    38 // CLASS DECLARATION

    39 

    40 /**

    41 *  Class that parses SDP. Not fully but enough to set up a 

    42 *  rtp stream from rtsp based on information extracted by this class.

    43 *

    44 *  @lib CommonRecordingEngine.lib

    45 *  @since Series 60 3.0

    46 */

    47 class CDvrSdpParser : public CBase

    48     {

    49 

    50 public: // Data types

    51 

    52     /**

    53     * Enum for indicating contents of the rtp stream(s).

    54     */

    55     enum TDvrPacketProvidings

    56         {

    57         EDvrAudioOnly = 0,     /**< This packet source feeds only audio stream */

    58         EDvrVideoOnly,         /**< This packet source feeds only video stream */

    59         EDvrBothAudioAndVideo, /**< This packet source feeds audio and video */

    60         EDvrNoProgramAtAll,    /**< Nothing useful found */

    61         EDvrSourceCount        /**< Final number of different sources */

    62         };    

    63 

    64     /**

    65     * Defines media point struct.

    66     */

    67     struct SMediaPoint

    68         {

    69         /*

    70         * Start point of media in SDP.

    71         */

    72         TInt iStart;

    73             

    74         /*

    75         * Length in bytes of media in SDP.

    76         */

    77         TInt iLength;

    78             

    79         };

    80             

    81 public: // Constructors and destructor

    82 

    83     /**

    84     * Two-phased constructor.

    85     * @return CDvrSdpParser pointer to CDvrSdpParser class.

    86     */

    87     IMPORT_C static CDvrSdpParser* NewL();

    88 

    89     /**

    90     * Two-phased constructor.

    91     */

    92     IMPORT_C static CDvrSdpParser* NewLC();

    93 

    94     /**

    95     * Destructor.

    96     */

    97     IMPORT_C virtual ~CDvrSdpParser();

    98 

    99 public: // New functions

   100 

   101     /**

   102     * Method that is used to give SDP to this class.

   103     * "PLAY rtsp://vishnu.wipsl.com/oops/winter_fun.mp4/ RTSP/1.0\r\n..."

   104     * @since Series 60 3.0

   105     * @param aSDP is the SDP data.

   106     * @param aBaseUrl is the rtsp url used to fetch this sdp.

   107     *        If it is not available, a (NULL,0) descriptor needs to be passed.

   108     *        It will be used to construct media urls in case where there is no

   109     *        absolute media urls in the sdp. 

   110     * @return none.

   111     */

   112     IMPORT_C void TryParseL( const TDesC8 &aSdp ,

   113                              const TDesC8 &aBaseUrl );

   114 

   115     /**

   116     * Parses SDP file.

   117     * @since Series 60 3.0

   118     * @param aSDP is the SDP data.

   119     * @return none.

   120     */

   121     IMPORT_C void TryParseL( const TDesC8& aSdp );

   122 

   123     /**

   124     * Method for adding new SDP line.

   125     * @since Series 60 3.0

   126     * @param aStreamId a section where to add the string.

   127     *        KErrNotFound: common part

   128     *        0 (usually) : video

   129     *		 1 (usually) : audio

   130     *        2 (usually) : subtitle (not supported yet)

   131     * @param aLine a string to add.

   132     * @rerturn a system wide error code.

   133     */

   134     IMPORT_C void NewLineL( const TInt aStreamId,

   135                             const TDesC8& aLine ); 

   136 

   137     /**

   138     * Method for getting SDP data.

   139     * @since Series 60 3.0

   140     * @param aSdp a pointer to SDP data.

   141     * @rerturn KErrNone if SDP available, otherwise KErrNotFound.

   142     */

   143     IMPORT_C TInt GetSdp( TPtrC8& aSdp ); 

   144 

   145     /** 

   146     * Method for asking whether audio and/or video is included.

   147     * @since Series 60 3.0

   148     * @param none.

   149     * @return indication about stream contents.

   150     */

   151     IMPORT_C CDvrSdpParser::TDvrPacketProvidings SupportedContent( void );

   152         

   153     /**

   154     * Method for getting attributes related to session.

   155     * @since Series 60 3.0

   156     * @param none.

   157     * @rerturn array of strings, may be empty.

   158     */

   159     IMPORT_C RArray<TPtrC8>& SessionAttributes( void ); 

   160 

   161     /**

   162     * Method for getting attributes related to session.

   163     * @since Series 60 3.0

   164     * @param none.

   165     * @rerturn array of strings, may be empty.

   166     */

   167     IMPORT_C RArray<TPtrC8>& VideoAttributes( void ); 

   168     

   169     /**

   170     * Method for getting attributes related to session.

   171     * @since Series 60 3.0

   172     * @param none.

   173     * @rerturn array of strings, may be empty.

   174     */

   175     IMPORT_C RArray<TPtrC8>& AudioAttributes( void ); 

   176     

   177     /**

   178     * Method for getting all data streams related to session.

   179     * @since Series 60 3.0

   180     * @param none.

   181     * @rerturn array of strings, may be empty.

   182     */

   183     IMPORT_C RArray<TPtrC8>& DataStreams( void ); 

   184 

   185     /**

   186     * Method for getting Ipv6 of the SDP having been parsed.

   187     * @since Series 60 3.0

   188     * @param none.

   189     * @return ETrue if SDP had Ipv6 address in it.

   190     */

   191     IMPORT_C TBool IsIpv4Sdp( void ); 

   192 

   193     /**

   194     * Method for getting multicastness of the SDP having been parsed.

   195     * @since Series 60 3.0

   196     * @param none.

   197     * @return ETrue if SDP had multicast characteristics in it.

   198     */

   199     IMPORT_C TBool IsMultiCastSdp( void ); 

   200 

   201     /**

   202     * Method for getting audio control addr e.g. the text from sdp line

   203     * that begins with a=control: and is located in audio media block

   204     * @since Series 60 3.0

   205     * @param none.

   206     * @return a audio control addr.

   207     */

   208     IMPORT_C TPtrC8 AudioControlAddr( void ); 

   209 

   210     /**

   211     * Method for getting video control addr e.g. the text from sdp line

   212     * that begins with a=control: and is located in video media block

   213     * @since Series 60 3.0

   214     * @param none.

   215     * @return a video control addr.

   216     */

   217     IMPORT_C TPtrC8 VideoControlAddr( void ); 

   218 

   219     /**

   220     * Method for getting audio ip addr e.g. the text from sdp line

   221     * that begins with c=IN IP... : and is located in audio media block

   222     * @since Series 60 3.0

   223     * @param none.

   224     * @return video control addr. ownership is NOT transferred. may be NULL.

   225     */

   226     IMPORT_C TPtrC8 AudioIpAddr( void ); 

   227     

   228     /**

   229     * Method for getting video ip addr e.g. the text from sdp line

   230     * that begins with c=IN IP... : and is located in video media block

   231     * @since Series 60 3.0

   232     * @param none.

   233     * @return video control addr. ownership is NOT transferred. may be NULL.

   234     */

   235     IMPORT_C TPtrC8 VideoIpAddr( void ); 

   236 

   237     /**

   238     * Getter for audio port.

   239     * @since Series 60 3.0

   240     * @param none.

   241     * @return a audio port number.

   242     */

   243     IMPORT_C TInt AudioPort( void ); 

   244 

   245     /**

   246     * Getter for video port.

   247     * @since Series 60 3.0

   248     * @param none.

   249     * @return a video port number.

   250     */

   251     IMPORT_C TInt VideoPort( void ); 

   252 

   253     /**

   254     * Getter for audio bitrate.

   255     * @since Series 60 3.0

   256     * @param none.

   257     * @return a audio bit rate.

   258     */

   259     IMPORT_C TInt AudioBitrate( void ); 

   260 

   261     /**

   262     * Getter for video bitrate.

   263     * @since Series 60 3.0

   264     * @param none.

   265     * @return a video bit rate.

   266     */

   267     IMPORT_C TInt VideoBitrate( void ); 

   268     

   269     /**

   270     * Getter for audio stream id.

   271     * @since Series 60 3.0

   272     * @param none.

   273     * @return a audio stream id.

   274     */

   275     IMPORT_C TInt AudioStreamId( void ); 

   276 

   277     /**

   278     * Getter for video stream id.

   279     * @since Series 60 3.0

   280     * @param none.

   281     * @return a video stream id.

   282     */

   283     IMPORT_C TInt VideoStreamId( void ); 

   284     

   285     /**

   286     * Getter for video timer granularity

   287     * @since Series 60 3.0

   288     * @param none.

   289     * @return Video stream timestamp granularity as 1/s.

   290     */

   291     IMPORT_C TUint32 VideoTimerGranularity( void ); 

   292 

   293     /**

   294     * Getter for audio timer granularity

   295     * @since Series 60 3.0

   296     * @param none.

   297     * @return Audio stream timestamp granularity as 1/s.

   298     */

   299     IMPORT_C TUint32 AudioTimerGranularity( void ); 

   300 

   301     /**

   302     * Checker method for SDP representing realnetworks realmedia content

   303     * @since Series 60 3.0

   304     * @param none.

   305     * @return ETrue if sdp presents realmedia stream.

   306     */

   307     IMPORT_C TBool IsRealMediaContent( void );

   308 

   309     /**

   310     * Media identifier for audio. From a=rtpmap:96 H264/90000

   311 	* the number 96. Usually value is 96 for video and 

   312 	* 97 for audio but might be other

   313     * @since Series 60 3.0

   314     * @param none.

   315     * @return Media id

   316     */

   317 	IMPORT_C TInt MediaIdentifierAudio( void );

   318     /**

   319     * Media identifier for video. From a=rtpmap:96 H264/90000

   320 	* the number 96. Usually value is 96 for video and 

   321 	* 97 for audio but might be other

   322     * @since Series 60 3.0

   323     * @param none.

   324     * @return Media id.

   325     */

   326 	IMPORT_C TInt MediaIdentifierVideo( void );

   327 

   328     /**

   329     * Checker method for SDP representing livestream.

   330     * @since Series 60 3.0

   331     * @param none.

   332     * @return ETrue if sdp presents livestream.

   333     */

   334     IMPORT_C TBool IsLiveStream( void );

   335 

   336 protected: // Constructors and destructor

   337 

   338     /**

   339     * C++ default constructor.

   340     */

   341     CDvrSdpParser();

   342 

   343     /**

   344     * By default Symbian 2nd phase constructor is private.

   345     * @param a a reference to socket server .

   346     */

   347     void ConstructL();

   348             

   349 private: // New methods

   350 

   351     /**

   352     * Finds media(s) from SDP file.

   353     * @since Series 60 3.0

   354     * @param aSDP is the SDP data.

   355     * @return none.

   356     */

   357     void FindMediasL( const TDesC8& aSdp );

   358 

   359     /**

   360     * Finds media(s) from SDP file.

   361     * @since Series 60 3.0

   362     * @param aPoints a array for media points.

   363     * @return none.

   364     */

   365     void MakeMediaBuffersL( RArray<SMediaPoint>& aPoints );

   366 

   367     /**

   368     * Finds session attributes from SDP file.

   369     * @since Series 60 3.0

   370     * @param aPoints a array for media points.

   371     * @return none.

   372     */

   373     void FindSessionAttributesL( RArray<SMediaPoint>& aPoints );

   374 

   375     /**

   376     * Finds media(s) from SDP file.

   377     * @since Series 60 3.0

   378     * @param aStreamId a section where to add the string.

   379     * @param aLine a string to add.

   380     * @return none.

   381     */

   382     void InserNewLineL( TInt aStreamId,

   383                         const TDesC8& aLine );

   384 

   385     /**

   386     * Method for finding points of medias in SDP.

   387     * @since Series 60 3.0

   388     * @param aPoints a array for media points.

   389     * @rerturn none.

   390     */

   391     void FindMediaPointsL( RArray<SMediaPoint>& aPoints ); 

   392     

   393     /**

   394     * Method for finding next media section start in SDP.

   395     * @since Series 60 3.0

   396     * @param aPtr a pointer to buffer where serch from.

   397     * @rerturn a next media section start point.

   398     */

   399     TInt MediaSectionStart( const TDesC8& aPtr );

   400     

   401     /**

   402     * Append media info from media section to array.

   403     * @since Series 60 3.0

   404     * @param aMediaPtr a pointer to buffer of media section.

   405     * @param aAddress a IP address of media.

   406     * @return none.

   407     */

   408     void UpdateMediaInfoL( const TDesC8& aMediaPtr,

   409                            HBufC8*& aAddress );

   410 

   411     /**

   412     * Finds IP addr from a buffer.

   413     * @since Series 60 3.0

   414     * @param aPtr a pointer to buffer where to search.

   415     * @return a IP address if found.

   416     */

   417     HBufC8* GetIpAddrL( const TDesC8& aPtr );

   418 

   419     /**

   420     * Getter for clock rate of media.

   421     * @since Series 60 3.0

   422     * @param aPtr a pointer to buffer where serch from.

   423     * @return a clock rate value of the media.

   424     */

   425     TUint GetClockRateL( const TDesC8& aPtr );

   426 

   427     /**

   428     * Append media info from media section to array.

   429     * @since Series 60 3.0

   430     * @param aMediaPtr a pointer to buffer of media section.

   431     * @param aControlAddr a control address of media.

   432     * @return none.

   433     */

   434     void GetControlL( const TDesC8& aMediaPtr,

   435                       HBufC8*& aControlAddr );

   436 

   437     /**

   438     * Method for checking if addr is multicast addr.

   439     * @since Series 60 3.0

   440     * @param aCLine is c= line from SDP.

   441     * @return none.

   442     */

   443     void CheckForMulticast( const TDesC8& aLine );

   444 

   445     /**

   446     * Method that picks up all attribute lines from sdp

   447     * block and stores them in given array

   448     * @since Series 60 3.0

   449     * @param aSdpSection is section from sdp. In practice m=video section

   450     *        or m=audio section or the common section from beginning.

   451     * @aAttributeList is an array where each attribute-line is stored.

   452     */

   453     void FindAttributesL ( const TDesC8& aSdpSection, 

   454                            RArray<TPtrC8>& aAttributeList ); 

   455                                

   456     /**

   457     * Method that picks up all data stream lines from sdp.

   458     * @since Series 60 3.0

   459     * @param aSdpSection is section from sdp. In practice m=video section

   460     *        or m=audio section or the common section from beginning.

   461     * @aStreamsList is an array where each data stream-line is stored.

   462     * @return none.

   463     */

   464     void FindDataStreamsL( const TDesC8& aSdpSection,

   465                            RArray<TPtrC8>& aStreamsList ); 

   466                                

   467     /**

   468     * Reads integer value from a buffer.

   469     * @since Series 60 3.0

   470     * @param aPtr a pointer to buffer where serch from.

   471     * @param aKeyword a keyword for line.

   472     * @return a integer value base on keyword.

   473     */

   474     TInt GetIntL( const TDesC8& aPtr,

   475                   const TDesC8& aKeyword );

   476 

   477     /**

   478     * Reads string value from a buffer.

   479     * @since Series 60 3.0

   480     * @param aPtr a pointer to buffer where serch from.

   481     * @param aKeyword a keyword for line.

   482     * @return a buffer base on keyword.

   483     */

   484     HBufC8* GetStringL( const TDesC8& aPtr,

   485                         const TDesC8& aKeyword );

   486 

   487     /**

   488     * Finds location where keyword data start.

   489     * @since Series 60 3.0

   490     * @param aPtr a pointer to buffer where serch from.

   491     * @param aKeyword a keyword for line.

   492     * @return a point in buffer where keyword data start.

   493     */

   494     TInt FindStart( const TDesC8& aPtr,

   495                     const TDesC8& aKeyword );

   496 

   497     /**

   498     * Finds location where keyword data ends.

   499     * @since Series 60 3.0

   500     * @param aPtr a pointer to buffer where serch from.

   501     * @param aStart a point where keyword data starts.

   502     *        Return a point to line change.

   503     * @param aIgnoreSpace if true, points to the line feed only if.

   504     * @return a point in buffer where keyword data end.

   505     */

   506     TInt GetLen( const TDesC8& aPtr,

   507                  const TInt aStart,

   508                  const TBool aIgnoreSpace = EFalse );

   509                  

   510     /**

   511     * Finds smaller non error value integer.

   512     * @since Series 60 3.0

   513     * @param aValue1 a value 1 for comparison.

   514     * @param aValue2 a value 2 for comparison.

   515     * @return smaller integer if one or both inputs are positive,

   516               otherwise return KErrNotFound.

   517     */

   518     TInt MinNonError( const TInt aValue1, 

   519                       const TInt aValue2 );

   520 

   521     /**

   522     * Convert a string to unsigned integer.

   523     * @since Series 60 3.0

   524     * @param aString a string to convert.

   525     * @return a integer value base on string.

   526     */

   527     TUint StrToUint( const TDesC8& aString );

   528 

   529     /**

   530     * Delete variables.

   531     * @since Series 60 3.0

   532     * @param none.

   533     * @return none.

   534     */

   535     void DeleteVariables( void );

   536 

   537 private: // Data

   538 

   539     /**

   540     * Pointer to actual SDP text being parsed.

   541     */

   542     HBufC8* iSdp; 

   543 

   544     /**

   545     * String containing (possible) base url.

   546     */

   547     HBufC8* iBaseUrl; 

   548         

   549     /**

   550     * IP in common section.

   551     */

   552     HBufC8* iCommonIp;

   553     

   554     /**

   555     * Media section buffer(s)

   556     */

   557     RArray<TPtrC8> iMediaBuf;

   558         

   559     /**

   560     * Media attributes for both audio and video.

   561     */

   562     RArray<TPtrC8> iSessionAttributes; 

   563     

   564     /**

   565     * Media attributes for audio not containing a=control attr.

   566     */

   567     RArray<TPtrC8> iAudioAttributes; 

   568     

   569     /**

   570     * Media attributes for video not containing a=control attr.

   571     */

   572     RArray<TPtrC8> iVideoAttributes; 

   573     

   574     /**

   575     * Data streams found from SDP.

   576     */

   577     RArray<TPtrC8> iDataStreams; 

   578     

   579     /**

   580     * Url that may be used to SETUP iAudioControlAddr RTSP/1.0\r.

   581     */

   582     HBufC8* iAudioControlAddr;

   583     

   584     /**

   585     * Url that may be used to SETUP iVideoControlAddr RTSP/1.0\r.

   586     */

   587     HBufC8* iVideoControlAddr;

   588     

   589     /**

   590     * Ip number from audio block from c=IP.. line.

   591     */

   592     HBufC8* iAudioIpAddr;

   593     

   594     /**

   595     * Ip number from video block from c=IP.. line.

   596     */

   597     HBufC8* iVideoIpAddr;

   598         

   599     /**

   600     * Audio port or KErrNotFound if not available.

   601     */

   602     TInt iAudioPort;

   603     

   604     /**

   605     * Video port or KErrNotFound if not available.

   606     */

   607     TInt iVideoPort;

   608     

   609     /**

   610     * Subtitle port or KErrNotFound if not available.

   611     */

   612     TInt iTitlePort;

   613     

   614     /**

   615     * Audio bitrate or KErrNotFound if not available.

   616      */

   617     TInt iAudioBitrate; 

   618     

   619     /**

   620     * Video bitrate or KErrNotFound if not available.

   621     */

   622     TInt iVideoBitrate; 

   623     

   624     /**

   625     * Audio strema id.

   626     */

   627     TInt iAudioStreamId; 

   628     

   629     /**

   630     * Video stream id.

   631     */

   632     TInt iVideoStreamId; 

   633     

   634     /**

   635     * How much is one video rtp timer tick in wall clock time

   636     * (usually 1/90000 seconds).

   637     */

   638     TUint32 iVideoTimerGranularity;

   639     

   640     /**

   641     * How much is one audio rtp timer tick in wall clock time

   642     * (usually 1/<samplerate> seconds).

   643     */

   644     TUint32 iAudioTimerGranularity; 

   645 

   646     /**

   647     * If the sdp parsed was Ipv4 or not.

   648     */

   649     TBool iIsIpv4; 

   650     

   651     /**

   652     * If the sdp parsed was multicast or not.

   653     */

   654     TBool iIsMulticast; 

   655 

   656 	/**

   657 	* Media identifier for audio. From a=rtpmap:96 H264/90000 the number 96.

   658 	* Usually value 96 is for video and 97 for audio, but might be other.

   659 	*/

   660 	TInt iMediaIdentifierAudio;

   661 	

   662 	/**

   663 	* Media identifier for video. 

   664 	*/

   665 	TInt iMediaIdentifierVideo;

   666     

   667     };

   668 

   669 #endif // CDVRSDPPARSER_H

   670 

   671 // End of file