williamr@2: /* williamr@2: * Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: * All rights reserved. williamr@2: * This component and the accompanying materials are made available williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: * which accompanies this distribution, and is available williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: * williamr@2: * Initial Contributors: williamr@2: * Nokia Corporation - initial contribution. williamr@2: * williamr@2: * Contributors: williamr@2: * williamr@2: * Description: williamr@2: * Name : SdpFmtAttributeField.h williamr@2: * Part of : SDP Codec williamr@2: * Interface : SDK API, SDP Codec API williamr@2: * Version : 1.0 williamr@2: * williamr@2: */ williamr@2: williamr@2: williamr@2: williamr@2: #ifndef CSDPFMTATTRIBUTEFIELD_H williamr@2: #define CSDPFMTATTRIBUTEFIELD_H williamr@2: williamr@2: // INCLUDES williamr@2: #include williamr@2: #include williamr@2: #include "_sdpdefs.h" williamr@2: williamr@2: // FORWARD DECLARATIONS williamr@2: class RReadStream; williamr@2: class RWriteStream; williamr@2: class CSdpAttributeField; williamr@2: class TSdpRtpmapValue; williamr@2: williamr@2: // CLASS DECLARATION williamr@2: /** williamr@2: * @publishedAll williamr@2: * @released williamr@2: * williamr@2: * This class encapsulates the attribute field of the Session Description williamr@2: * Protocol for media format/payload type level attributes. Media and session williamr@2: * level attributes are supported by the CSdpAttributeField class. williamr@2: * williamr@2: * The normative reference for correct formatting and values is williamr@2: * draft-ietf-mmusic-sdp-new-14 unless specified otherwise in williamr@2: * member documentation. The implementation supports this normative williamr@2: * reference, but does not enforce it fully. williamr@2: * williamr@2: * @lib sdpcodec.lib williamr@2: */ williamr@2: class CSdpFmtAttributeField : public CBase williamr@2: { williamr@2: public: // Constructors and destructor williamr@2: /** williamr@2: * Constructs a new media format level attribute field. williamr@2: * williamr@2: * @param aText A string containing a correctly williamr@2: * formatted field value terminated by a CRLF. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpFmtAttributeField* DecodeL( const TDesC8& aText ); williamr@2: williamr@2: /** williamr@2: * Constructs a new media format level attribute field and adds the williamr@2: * pointer to the cleanup stack. williamr@2: * williamr@2: * @param aText A string containing a correctly williamr@2: * formatted field value terminated by a CRLF. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpFmtAttributeField* DecodeLC( const TDesC8& aText); williamr@2: williamr@2: /** williamr@2: * Constructs a new media level format attribute field. williamr@2: * williamr@2: * @param aAttribute The attribute name. It can be a pre-defined williamr@2: * name in the SDP string pool or defined by the client. williamr@2: * @param aFormat A valid format/payload identifier williamr@2: * used in the format list of the media description. williamr@2: * @param aValue A valid attribute value or an empty williamr@2: * descriptor to omit the value part. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpFmtAttributeField* NewL( williamr@2: RStringF aAttribute, const TDesC8& aFormat, const TDesC8& aValue ); williamr@2: williamr@2: /** williamr@2: * Constructs a new media format level attribute field and adds the williamr@2: * pointer to the cleanup stack. williamr@2: * williamr@2: * @param aAttribute The attribute name. It can be a pre-defined williamr@2: * name in the SDP string pool or defined by the client. williamr@2: * @param aFormat A valid format/payload identifier williamr@2: * used in the format list of the media description. williamr@2: * @param aValue A valid attribute value or an empty williamr@2: * descriptor to omit the value part. williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C static CSdpFmtAttributeField* NewLC( williamr@2: RStringF aAttribute, const TDesC8& aFormat, const TDesC8& aValue ); williamr@2: williamr@2: /** williamr@2: * Deletes the resources held by the instance. williamr@2: */ williamr@2: IMPORT_C ~CSdpFmtAttributeField(); williamr@2: williamr@2: public: // New functions williamr@2: williamr@2: /** williamr@2: * Outputs the field formatted according to SDP syntax and including williamr@2: * the terminating CRLF. williamr@2: * williamr@2: * @param aStream Stream used for output. On return williamr@2: * the stream includes correctly formatted attribute field. williamr@2: */ williamr@2: IMPORT_C void EncodeL( RWriteStream& aStream ) const; williamr@2: williamr@2: /** williamr@2: * Creates a new instance that is equal to the target. williamr@2: * williamr@2: * @return a new instance. williamr@2: */ williamr@2: IMPORT_C CSdpFmtAttributeField * CloneL() const; williamr@2: williamr@2: /** williamr@2: * Compares this instance to another for equality. williamr@2: * williamr@2: * @param aObj The instance to compare to. williamr@2: * @return ETrue if equal, EFalse if not. williamr@2: */ williamr@2: IMPORT_C TBool operator== ( const CSdpFmtAttributeField& aObj ) const; williamr@2: williamr@2: /** williamr@2: * Gets the attribute. williamr@2: * williamr@2: * @return The attribute name. The name can be pre-defined williamr@2: * name in the SDP string table or defined by the client. williamr@2: */ williamr@2: IMPORT_C RStringF Attribute() const; williamr@2: williamr@2: /** williamr@2: * Gets the format. williamr@2: * williamr@2: * @return The format. williamr@2: */ williamr@2: IMPORT_C const TDesC8& Format() const; williamr@2: williamr@2: /** williamr@2: * Gets the attribute value. williamr@2: * williamr@2: * @return The value or an empty descriptor if there is no value part. williamr@2: */ williamr@2: IMPORT_C const TDesC8& Value() const; williamr@2: williamr@2: /** williamr@2: * Sets the attribute, format/payload type and attribute value. williamr@2: * williamr@2: * @param aAttribute A valid attribute name. It can be a williamr@2: * pre-defined name in the SDP string pool or defined by williamr@2: * the client. williamr@2: * @param aFormat A valid format/payload identifier williamr@2: * used in the formatlist of the media description. williamr@2: * @param aValue A valid attribute value or an empty williamr@2: * descriptor to omit the value part. williamr@2: * @leave KErrSdpCodecMediaAttributeField if aAttribute is not rtpmap williamr@2: * or fmtp attribute. williamr@2: */ williamr@2: IMPORT_C void SetL( williamr@2: RStringF aAttribute, const TDesC8& aFormat, const TDesC8& aValue ); williamr@2: williamr@2: public: // Internal to codec williamr@2: williamr@2: /** williamr@2: * Externalizes the object to stream williamr@2: * williamr@2: * @param aStream Stream where the object's state will be stored williamr@2: */ williamr@2: void ExternalizeL( RWriteStream& aStream ) const; williamr@2: williamr@2: /** williamr@2: * Creates object from the stream data williamr@2: * williamr@2: * @param aStream Stream where the object's state will be read williamr@2: * @return Initialized object williamr@2: */ williamr@2: static CSdpFmtAttributeField* InternalizeL( RReadStream& aStream ); williamr@2: williamr@2: /** williamr@2: * Returns attribute field williamr@2: * williamr@2: * @return Attribute field williamr@2: */ williamr@2: const CSdpAttributeField* AttributeField() const; williamr@2: williamr@2: private: // New methods williamr@2: williamr@2: /** williamr@2: * Creates object from the stream data. williamr@2: * Does the "2nd phase construction" of internalization. williamr@2: * williamr@2: * @param aStream Stream where the object's state will be read williamr@2: */ williamr@2: void DoInternalizeL( RReadStream& aStream ); williamr@2: williamr@2: /** williamr@2: * Formats value parameters williamr@2: * williamr@2: * @param aField Attribute field object williamr@2: */ williamr@2: void FormatValueParamsL( CSdpAttributeField* aField ); williamr@2: williamr@2: private: // Construction and destruction williamr@2: williamr@2: /** williamr@2: * Constructor williamr@2: */ williamr@2: CSdpFmtAttributeField(); williamr@2: williamr@2: /** williamr@2: * Second phase construction williamr@2: * williamr@2: * @param aText A string containing a correctly formatted field value williamr@2: * terminated by a CRLF. williamr@2: */ williamr@2: void ConstructL( const TDesC8& aText ); williamr@2: williamr@2: /** williamr@2: * Second phase construction williamr@2: * williamr@2: * @param aAttribute The attribute from the pre-defined SDP string williamr@2: * table or defined by the user williamr@2: * @param aFormat A valid format/payload identifier used in the format williamr@2: * list of the media description. williamr@2: * @param aValue A valid attribute value or an empty descriptor williamr@2: * to omit the value part. williamr@2: */ williamr@2: void ConstructL( williamr@2: RStringF aAttribute, const TDesC8& aFormat, const TDesC8& aValue ); williamr@2: williamr@2: williamr@2: /** williamr@2: * Decode format parameter from string williamr@2: * williamr@2: * @param aText A text includeing format parameter. williamr@2: */ williamr@2: void DecodeFormatL(const TDesC8& aText); williamr@2: williamr@2: __DECLARE_TEST; williamr@2: williamr@2: private: williamr@2: williamr@2: RStringPool iPool; williamr@2: CSdpAttributeField* iAttributeField; williamr@2: /** Pointer to the format part*/ williamr@2: TPtrC8 iFormat; williamr@2: /** Pointer to the format parameters*/ williamr@2: TPtrC8 iValuePart; williamr@2: }; williamr@2: williamr@2: #endif // CSDPFMTATTRIBUTEFIELD_H