diff -r 000000000000 -r 1bce908db942 ipappsrv_plat/multimedia_comms_api/inc/mcevideostream.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/ipappsrv_plat/multimedia_comms_api/inc/mcevideostream.h Tue Feb 02 01:04:58 2010 +0200 @@ -0,0 +1,237 @@ +/* +* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies). +* All rights reserved. +* This component and the accompanying materials are made available +* under the terms of "Eclipse Public License v1.0" +* which accompanies this distribution, and is available +* at the URL "http://www.eclipse.org/legal/epl-v10.html". +* +* Initial Contributors: +* Nokia Corporation - initial contribution. +* +* Contributors: +* +* Description: +* +*/ + + + + +#ifndef MCEVIDEOSTREAM_H +#define MCEVIDEOSTREAM_H + +// INCLUDES +#include +#include + +// CONSTANTS +const TMceMediaType KMceVideo = 2; + +// FORWARD DECLARATIONS +class CMceVideoCodec; + +// CLASS DECLARATION + +/** +* Class for representing unidirectional video stream. +* +* It defines the used video codecs for the stream. +* In order to be complete structure, at least one codec is required. +* +* @lib mceclient.lib +*/ +class CMceVideoStream : public CMceMediaStream + { + public: // Constructors and destructor + + /** + * Two-phased constructor. + */ + IMPORT_C static CMceVideoStream* NewL(); + + /** + * Two-phased constructor. + */ + IMPORT_C static CMceVideoStream* NewLC(); + + /** + * Destructor. + */ + IMPORT_C ~CMceVideoStream(); + + public: // Functions + + /** + * Returns the codecs available to the session. + * For CMceOutSession, array contains all codecs supported by + * terminal in default. For CMceInSession, array contains codecs + * that were offered by remote terminal, and supported by local terminal. + * Codecs are in preference order in the array. + * Codec in the first element of the array has highest preference. + * Adding, removing or replacing a codec or changing the preference + * of a codec causes the returned array to be in invalid state. + * @return codecs available for the session + */ + IMPORT_C const RPointerArray& Codecs(); + + /** + * Adds codec to the stream. The codec contains preference value + * which will define its preference when added to the stream. + * Preference of codecs with the same preference value is determined + * by order they were added to the stream. In case of bound streams, + * codec is also automatically added to the opposite direction stream. + * After adding a codec an array of codecs received with a call + * to Codecs() is not valid. + * @param aCodec codec added to the stream; ownership is transferred + */ + IMPORT_C void AddCodecL( CMceVideoCodec* aCodec ); + + /** + * Removes codec from the stream. In case of bound streams, codec is + * also automatically removed from the opposite direction stream. + * After removing a codec an array of codecs previously received with + * a call to Codecs() is not valid. + * @param aCodec codec removed from stream + */ + IMPORT_C void RemoveCodecL( CMceVideoCodec& aCodec ); + + /** + * Replaces codecs of the stream. Preference values of codecs will define + * the preference order. In case of bound streams, codecs are + * also automatically added to the opposite direction stream. + * After replacing codecs an array of codecs received with a call + * to Codecs() is not valid. + * @param aCodecs array of codecs which will replace existing codecs; + * ownership is transferred + */ + IMPORT_C void ReplaceCodecsL( RPointerArray* aCodecs ); + + /** + * Gets supported video codecs of the current stream configuration. + * Supported codecs for this video stream is affected by attached + * sinks and sources. + * @return supported video codecs of the current stream configuration + */ + IMPORT_C const RPointerArray& + SupportedVideoCodecs() const; + + public: // serialization + + /** + * Internalizes + * @param aReadStream read stream + * @param aTarget to which read to + */ + void InternalizeL( MMceComSerializationContext& aSerCtx ); + + /** + * Externalizes + * @param aWriteStream write stream + */ + void ExternalizeL( MMceComSerializationContext& aSerCtx ); + + + public: // From CMceMediaStream + + /** + * Initializes the stream. + * @param aParent the parent + * @param aDiscardUnusedCodecs + */ + void InitializeL( CMceSession& aParent, TBool aDiscardUnusedCodecs ); + + /** + * Initializes the stream. + * @param aManager the manager; ownership is not transferred + * @param aSession the Session. + */ + void InitializeL( CMceManager* aManager, CMceSession& aSession ); + + /** + * Traversal event handler. + * @param aEvent the event + * @return status if event was consumed or not or object needs update + */ + TInt EventReceivedL( TMceEvent& aEvent ); + + + /** + * Called file source wants to synchronized with stream + * @param aFile the file source + */ + void SynchronizeWithFileL( CMceFileSource& aFile ); + + /** + * Searches for codec matching with input codec instance or sdp name + * @param aCodec the search term + * @return matching codec or NULL if not found + */ + CMceCodec* FindCodec( CMceCodec& aCodec ); + + /** + * Arrange video codecs according codec preferences. + */ + void ReorderCodecsByPreferenceL( TBool aDiscardUnusedCodecs ); + + /** + * Return codecs of stream. + * @return list of codecs in the stream. + */ + const RPointerArray& BaseCodecs(); + + public: // Internal + + /** + * Removes codec + * @param aCodec + * @param aBinderOriginated + */ + void RemoveCodecL( CMceVideoCodec& aCodec, TBool aBinderOriginated ); + + protected: // From CMceMediaStream + + /** + * Determine whether current combination of source and sinks + * is allowed for spesific stream type. + * @return ETrue is combination is allowed; otherwise EFalse + */ + virtual TBool IsAllowedCombination(); + + private: + + /** + * C++ default constructor. + */ + CMceVideoStream(); + + /** + * Second-phase constructor. + */ + void ConstructL(); + + + private: // Owned data + + /** + * Codecs. + */ + RPointerArray iCodecs; + + /** + * Supported video codecs. + */ + RPointerArray iSupportedVideoCodecs; + + private: // Reserved for future use + + TAny* iReserved1; + + + //for testing + + MCE_UNIT_TEST_DEFS + + }; + +#endif