williamr@2: // Copyright (c) 2005-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: //
williamr@2: 
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2:  @file
williamr@2:  @publishedAll
williamr@2:  @released
williamr@2: */
williamr@2: 
williamr@2: #ifndef IMAGEFRAME_H
williamr@2: #define IMAGEFRAME_H
williamr@2: 
williamr@2: #include <e32std.h>
williamr@2: #include <e32base.h> 
williamr@2: #include <imageframeconst.h>
williamr@2: 
williamr@2: /** 
williamr@2: The base class for TFrameFormat. Users implement specific frame formats by deriving from this class. 
williamr@2: Symbian provides a particular implementation in the TFrameFormat class.
williamr@2: Each class derived from this class should be identified by a unique UID value, denoting its type.
williamr@2: All subclasses should provide implementations of DuplicateL().
williamr@2: 
williamr@2: @see TFrameFormat
williamr@2: */ 
williamr@2: class TFrameFormatBase
williamr@2: 	{
williamr@2: public:	
williamr@2: 	IMPORT_C TUid Type() const;
williamr@2: 	
williamr@2: 	/** 
williamr@2: 	Creates a duplicate instance of the frame format object on the heap.
williamr@2: 	
williamr@2: 	@return The pointer to the newly created object cast as class TFrameFormatBase. 
williamr@2: 	*/
williamr@2: 	virtual TFrameFormatBase* DuplicateL() const=0;
williamr@2: 	
williamr@2: protected:
williamr@2: 	IMPORT_C explicit TFrameFormatBase(TUid aType);
williamr@2: 	
williamr@2: private:
williamr@2: 	// reserved for future expansion
williamr@2: 	IMPORT_C virtual void Reserved1();
williamr@2: 	IMPORT_C virtual void Reserved2();
williamr@2: 	IMPORT_C virtual void Reserved3();
williamr@2: 	IMPORT_C virtual void Reserved4();
williamr@2: 	
williamr@2: private:
williamr@2: 	// Format of the specific type holder
williamr@2: 	TUid iType; 
williamr@2: 		
williamr@2: 	// reserved for future expansion
williamr@2: 	TInt iReserved1;
williamr@2: 	TInt iReserved2;
williamr@2: 	TInt iReserved3;
williamr@2: 	};
williamr@2: 
williamr@2: /** 
williamr@2: This class is a specific implementation of TFrameFormatBase. An object of this class provides 
williamr@2: colour space and sampling information based on a specific image format code. 
williamr@2: */
williamr@2: class TFrameFormat: public TFrameFormatBase
williamr@2: 	{
williamr@2: public:	
williamr@2: 	IMPORT_C explicit TFrameFormat(TUid aFormatCode);
williamr@2: 	IMPORT_C TFrameFormatBase* DuplicateL() const;
williamr@2: 	IMPORT_C TUid ColourSpace() const;
williamr@2: 	IMPORT_C TUid Sampling() const;
williamr@2: 	IMPORT_C TUid FormatCode() const;
williamr@2: 
williamr@2: 	IMPORT_C void SetColourSpace(TUid aColourSpace);	
williamr@2: 	
williamr@2: private: 
williamr@2: 	// The image frame colour space
williamr@2: 	TUid	iColourSpace;
williamr@2: 	// The frame sampling 
williamr@2: 	TUid 	iSampling;
williamr@2: 	// The image frame format code which uniquely identifies all other parameters. */  
williamr@2: 	TUid 	iFormatCode; 
williamr@2: 	};
williamr@2: 
williamr@2: /** 
williamr@2: Base class for TFrameLayout. Individual subclasses are identified by their specific UID value.
williamr@2: These classes are used to describe the memory layout of a specific Image Frame. 
williamr@2: */ 
williamr@2: class TFrameLayoutBase
williamr@2: 	{	
williamr@2: public:	
williamr@2: 	IMPORT_C TUid Type() const;
williamr@2: 	
williamr@2: 	/** 
williamr@2: 	Creates a duplicate instance of the frame layout object on the heap.
williamr@2: 	
williamr@2: 	@return The pointer to the newly created object cast as class TFrameLayoutBase. 
williamr@2: 	*/
williamr@2: 	virtual TFrameLayoutBase* DuplicateL() const=0;
williamr@2: 	
williamr@2: protected: 
williamr@2: 	IMPORT_C explicit TFrameLayoutBase(TUid aType);
williamr@2: 
williamr@2: private:
williamr@2: 	// reserved for future expansion
williamr@2: 	IMPORT_C virtual void Reserved1();
williamr@2: 	IMPORT_C virtual void Reserved2();
williamr@2: 	IMPORT_C virtual void Reserved3();
williamr@2: 	IMPORT_C virtual void Reserved4();
williamr@2: 			
williamr@2: private:
williamr@2: 	// Layout specific type holder
williamr@2: 	TUid iType; 
williamr@2: 		
williamr@2: 	// Reserved for future expansion
williamr@2: 	TInt iReserved1;
williamr@2: 	TInt iReserved2;
williamr@2: 	TInt iReserved3;
williamr@2: 	};
williamr@2: 
williamr@2: /** 
williamr@2: Class TFrameLayout is a concrete implementation of TFrameLayoutBase class.
williamr@2: It serves as a container for parameters that describe the memory organisation of 
williamr@2: the data encapsulated by a specific CImageFrame object.
williamr@2: Image data is stored in planes. Each plane is characterised by  
williamr@2: the byte offset from the start of the image frame memory, and its maximum size, 
williamr@2: current length and scanlength.
williamr@2: */	
williamr@2: class TFrameLayout: public TFrameLayoutBase
williamr@2: 	{		
williamr@2:  		
williamr@2: public:
williamr@2: 	IMPORT_C explicit TFrameLayout(TInt aPlanes);
williamr@2: 	IMPORT_C TFrameLayoutBase* DuplicateL() const;	
williamr@2: 	
williamr@2:     IMPORT_C TInt Planes() const;
williamr@2: 	IMPORT_C TInt Start(TInt aIndex) const;
williamr@2: 	IMPORT_C TInt Length(TInt aIndex) const;
williamr@2: 	IMPORT_C TInt CurrentLength(TInt aIndex) const;
williamr@2: 	IMPORT_C TInt ScanLength(TInt aIndex) const;
williamr@2: 	
williamr@2: 	IMPORT_C void SetStart(TInt aIndex, TInt aStart);
williamr@2: 	IMPORT_C void SetLength(TInt aIndex, TInt aLength );
williamr@2: 	IMPORT_C void SetCurrentLength(TInt aIndex, TInt aCurrentLength);
williamr@2: 	IMPORT_C void SetScanLength(TInt aIndex, TInt aScanLength);
williamr@2: 
williamr@2: private:
williamr@2: 	// The number of planes in this image. Value < KMaxPlanesInFrame. 
williamr@2: 	TInt iPlanes;				   
williamr@2: 	// The offset of each plane from the start of the memory referenced by this image frame. 
williamr@2: 	TInt iStart[KMaxPlanesInFrame]; 
williamr@2: 	// The length of each image plane in bytes.
williamr@2: 	TInt iLength[KMaxPlanesInFrame]; 
williamr@2: 	// The length of the data stored in each image plane in bytes.
williamr@2: 	TInt iCurrentLength[KMaxPlanesInFrame];	
williamr@2: 	// The width of the stride for each plane.
williamr@2: 	TInt iScanLength[KMaxPlanesInFrame];
williamr@2: 	};
williamr@2: 
williamr@2: /** 
williamr@2: CImageFrame class exposes an API for accessing binary image data in a uniform way.
williamr@2: It is implemented as a wrapper around TDes8 or RChunk objects. 
williamr@2: */	
williamr@2: class CImageFrame : public CBase 
williamr@2:     {
williamr@2: public:  
williamr@2:     IMPORT_C static CImageFrame* NewL(const TDes8& aBuffer, TInt aMaxBufferSize);
williamr@2:  								  
williamr@2:     IMPORT_C static CImageFrame* NewL(const TDes8& aBuffer,
williamr@2:     								  TInt aMaxBufferSize, 
williamr@2: 				 	   				  const TSize& aFrameSize, 
williamr@2: 				 					  const TFrameFormatBase& aFrameFormat,
williamr@2: 									  const TFrameLayoutBase& aFrameLayout); 
williamr@2: 										  
williamr@2: 	IMPORT_C static CImageFrame* NewL(const RChunk* aBuffer, 
williamr@2: 									  TInt aMaxBufferSize,		
williamr@2: 						   			  TInt aDataOffset);
williamr@2: 
williamr@2: 	IMPORT_C static CImageFrame* NewL(const RChunk* aBuffer,
williamr@2: 									  TInt aMaxBufferSize, 
williamr@2: 								      TInt aDataOffset, 
williamr@2: 		 					 	  	  const TSize& aFrameSize,
williamr@2: 		 					 	  	  const TFrameFormatBase& aFrameFormat,
williamr@2: 		 					 	  	  const TFrameLayoutBase& aFrameLayout); 
williamr@2:     
williamr@2: 	IMPORT_C virtual const TFrameFormatBase& FrameFormat() const;	
williamr@2: 	IMPORT_C virtual void SetFrameFormatL(const TFrameFormatBase& aFormat);
williamr@2: 	
williamr@2: 	IMPORT_C virtual const TFrameLayoutBase& FrameLayout() const;	
williamr@2: 	IMPORT_C virtual void SetFrameLayoutL(const TFrameLayoutBase& aFrameLayout);
williamr@2: 
williamr@2: 	IMPORT_C virtual const TSize& FrameSizeInPixels() const;	
williamr@2: 	IMPORT_C virtual void SetFrameSizeInPixels(const TSize& aFrameSize);
williamr@2: 
williamr@2: 	IMPORT_C virtual TDes8& Data();
williamr@2: 	IMPORT_C virtual const TDesC8& Data() const;
williamr@2: 	
williamr@2:     IMPORT_C virtual TInt MaxBufferSize() const;
williamr@2:     IMPORT_C virtual TBool IsChunk() const;
williamr@2: 
williamr@2: 	IMPORT_C virtual RChunk& DataChunk();
williamr@2: 	IMPORT_C virtual TInt DataOffset() const;
williamr@2:     
williamr@2:     IMPORT_C ~CImageFrame();
williamr@2: 	
williamr@2: protected:
williamr@2: 	IMPORT_C CImageFrame();
williamr@2: 	
williamr@2:     IMPORT_C void ConstructL(const TDes8& aBuffer, TInt aMaxBufferSize);
williamr@2:  								  
williamr@2:     IMPORT_C void ConstructL(const TDes8& aBuffer, 
williamr@2:     						 TInt aMaxBufferSize,
williamr@2: 				 	   		 const TSize& aFrameSize, 
williamr@2: 				 			 const TFrameFormatBase& aFrameFormat,
williamr@2: 							 const TFrameLayoutBase& aFrameLayout); 
williamr@2: 										  
williamr@2: 	IMPORT_C void ConstructL(const RChunk* aBuffer, 
williamr@2: 							 TInt aMaxBufferSize, 
williamr@2: 							 TInt aDataOffset);
williamr@2: 
williamr@2: 	IMPORT_C void ConstructL(const RChunk* aBuffer, 
williamr@2: 							 TInt aMaxBufferSize,
williamr@2: 						  	 TInt aDataOffset, 
williamr@2:  					 	     const TSize& aFrameSize,
williamr@2:  					 	  	 const TFrameFormatBase& aFrameFormat,									
williamr@2:  					 	  	 const TFrameLayoutBase& aFrameLayout); 
williamr@2: 
williamr@2: private: 					 	  	 
williamr@2: 	// for future development
williamr@2: 	IMPORT_C virtual void Reserved1();
williamr@2: 	IMPORT_C virtual void Reserved2();
williamr@2: 	IMPORT_C virtual void Reserved3();
williamr@2: 	IMPORT_C virtual void Reserved4();
williamr@2: 	
williamr@2: private:
williamr@2:     class CBody; 
williamr@2:     CBody* iBody;
williamr@2:     };
williamr@2: 
williamr@2: #endif // IMAGEFRAME_H