sl@0: // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // in its implementation.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file The interface to an example camera device driver which uses Shared Chunks
sl@0:  @publishedPartner
sl@0:  @prototype 9.1
sl@0: */
sl@0: 
sl@0: #ifndef __CAMERA1_H__
sl@0: #define __CAMERA1_H__
sl@0: 
sl@0: #include <e32cmn.h>
sl@0: #include <e32ver.h>
sl@0: #ifndef __KERNEL_MODE__
sl@0: #include <e32std.h>
sl@0: #endif
sl@0: 
sl@0: /**
sl@0: User interface for 'Camera1'
sl@0: */
sl@0: class RCamera1 : public RBusLogicalChannel
sl@0: 	{
sl@0: public:
sl@0: 	/**
sl@0: 	Structure for holding driver capabilities information
sl@0: 	(Just a version number in this example.)
sl@0: 	*/
sl@0: 	class TCaps
sl@0: 		{
sl@0: 	public:
sl@0: 		TVersion iVersion;
sl@0: 		};
sl@0: 
sl@0: 	/**
sl@0: 	Structure for holding driver configuration data
sl@0: 	*/
sl@0: 	class TConfig
sl@0: 		{
sl@0: 	public:
sl@0: 		TSize iImageSize;			/**< Size of image in pixels */
sl@0: 		TInt iImageBytesPerPixel;	/**< Number of bytes used to represent a single pixel */
sl@0: 		TInt iFrameRate;			/**< Speed to capture images at in frames per second*/
sl@0: 		TInt iNumImageBuffers;		/**< Number of simultanious images the client wishes to process */
sl@0: 		};
sl@0: 	typedef TPckgBuf<TConfig> TConfigBuf;
sl@0: 
sl@0: #ifndef __KERNEL_MODE__
sl@0: public:
sl@0: 	TInt Open();
sl@0: 	void Close();
sl@0: 	TInt GetConfig(TConfigBuf& aConfig);
sl@0: 	TInt SetConfig(const TConfigBuf& aConfig);
sl@0: 	TInt StartCapture();
sl@0: 	TInt EndCapture();
sl@0: 	void CaptureImage(TRequestStatus& aStatus, TInt aReleaseImage=-1);
sl@0: 	void CaptureImageCancel();
sl@0: 	TInt ReleaseImage(TInt aReleaseImage);
sl@0: 	TInt Duplicate(const RThread& aSrc,TOwnerType aType=EOwnerProcess);
sl@0: 	inline RChunk ImageChunk() const;
sl@0: private:
sl@0: 	RChunk iChunk;   /**< The chunk into which captured images will be placed */
sl@0: #endif
sl@0: 
sl@0: public:
sl@0: 	inline static const TDesC& Name();
sl@0: 	inline static TVersion VersionRequired();
sl@0: 
sl@0: private:
sl@0: 	/**
sl@0: 	Enumeration of Control messages.
sl@0: 	*/
sl@0: 	enum TControl
sl@0: 		{
sl@0: 		EGetConfig,
sl@0: 		ESetConfig,
sl@0: 		EStartCapture,
sl@0: 		EEndCapture,
sl@0: 		ECaptureImage,
sl@0: 		EReleaseImage
sl@0: 		};
sl@0: 
sl@0: 	/**
sl@0: 	Enumeration of Request messages.
sl@0: 	(None used in this example)
sl@0: 	*/
sl@0: 	enum TRequest
sl@0: 		{
sl@0: 		ENumRequests,
sl@0: 		EAllRequests = (1<<ENumRequests)-1
sl@0: 		};
sl@0: 
sl@0: 	// Kernel side LDD channel is a friend
sl@0: 	friend class DCamera1Channel;
sl@0: 	};
sl@0: 
sl@0: /**
sl@0:   The driver's name
sl@0: 
sl@0:   @return The name of the driver
sl@0: 
sl@0:   @internalComponent
sl@0: */
sl@0: inline const TDesC& RCamera1::Name()
sl@0: 	{
sl@0: 	_LIT(KCamera1Name,"CAMERA1");
sl@0: 	return KCamera1Name;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   The driver's version
sl@0: 
sl@0:   @return The version number of the driver
sl@0: 
sl@0:   @internalComponent
sl@0: */
sl@0: inline TVersion RCamera1::VersionRequired()
sl@0: 	{
sl@0: 	const TInt KMajorVersionNumber=1;
sl@0: 	const TInt KMinorVersionNumber=0;
sl@0: 	const TInt KBuildVersionNumber=KE32BuildVersionNumber;
sl@0: 	return TVersion(KMajorVersionNumber,KMinorVersionNumber,KBuildVersionNumber);
sl@0: 	}
sl@0: 
sl@0: /*
sl@0:   NOTE: The following methods would normally be exported from a seperate client DLL
sl@0:   but are included inline in this header file for convenience.
sl@0: */
sl@0: 
sl@0: #ifndef __KERNEL_MODE__
sl@0: 
sl@0: /**
sl@0:   Open a logical channel to the driver
sl@0: 
sl@0:   @return One of the system wide error codes.
sl@0: */
sl@0: TInt RCamera1::Open()
sl@0: 	{
sl@0: 	return DoCreate(Name(),VersionRequired(),KNullUnit,NULL,NULL,EOwnerProcess);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Close a logical channel to the driver
sl@0: */
sl@0: void RCamera1::Close()
sl@0: 	{
sl@0: 	iChunk.Close();
sl@0: 	RBusLogicalChannel::Close();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Get the current configuration settings.
sl@0: 
sl@0:   @param aConfig A structure which will be filled with the configuration settings.
sl@0: 
sl@0:   @return KErrNone
sl@0: */
sl@0: TInt RCamera1::GetConfig(TConfigBuf& aConfig)
sl@0: 	{
sl@0: 	return DoControl(EGetConfig,(TAny*)&aConfig);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Set the current configuration settings.
sl@0: 
sl@0:   @param aConfig The new configuration settings to be used.
sl@0: 
sl@0:   @return KErrInUse if image capturing is already in progress
sl@0:           KErrArgument if any configuration values are invalid.
sl@0: 		  KErrNone otherwise
sl@0: 
sl@0:   @post On success, iChunk will contain the handle of the chunk used to
sl@0:         contain captured images.
sl@0: */
sl@0: TInt RCamera1::SetConfig(const TConfigBuf& aConfig)
sl@0: 	{
sl@0: 	iChunk.Close(); // The following call will give us a new handle
sl@0: 	return iChunk.SetReturnedHandle(DoControl(ESetConfig,(TAny*)&aConfig));
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Start the image capture process.
sl@0: 
sl@0:   @return KErrNotReady if SetConfig() has not been previously called.
sl@0:           KErrNone otherwise.
sl@0: 
sl@0:   @pre The driver must have been previousely initialised by a call to SetConfig()
sl@0: */
sl@0: TInt RCamera1::StartCapture()
sl@0: 	{
sl@0: 	return DoControl(EStartCapture);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   End the image capturing process.
sl@0:   Also performs CaptureImageCancel()
sl@0: */
sl@0: TInt RCamera1::EndCapture()
sl@0: 	{
sl@0: 	return DoControl(EEndCapture);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Get the next available image and optionally release an already captured image.
sl@0:   Only one request may be pending at any time.
sl@0: 
sl@0:   @param aStatus The request status signaled when an image is available (or on error).
sl@0:                  The result value is the offset within iChunk where the capture image resides;
sl@0: 		         or set to one of the system wide error codes when an error occurs:
sl@0: 				 KErrNotReady if StartCapture() hasn't been previousely called,
sl@0: 				 KErrInUse if there is already a pending CaptureImage() request,
sl@0: 				 KErrOverflow if the client already has all the images buffers.
sl@0: 
sl@0:   @param aReleaseImage The chunk offset of an image which the client has finished processing.
sl@0:                        Set to -1 to indicate 'no image'
sl@0: 
sl@0:   @pre Image capturing must have been started with StartCapture()
sl@0: */
sl@0: void RCamera1::CaptureImage(TRequestStatus& aStatus,TInt aReleaseImage)
sl@0: 	{
sl@0: 	aStatus=KRequestPending;
sl@0: 	DoControl(ECaptureImage,(TAny*)&aStatus,(TAny*)aReleaseImage);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Cancel a previous CaptureImage() request
sl@0: */
sl@0: void RCamera1::CaptureImageCancel()
sl@0: 	{
sl@0: 	DoCancel(1<<ECaptureImage);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Release an already captured image.
sl@0: 
sl@0:   This makes the images buffer available again for the driver to capture images into.
sl@0: 
sl@0:   @param aReleaseImage The chunk offset of the image to be released.
sl@0:                        This is a value returned by a CaptureImage() request.
sl@0: */
sl@0: TInt RCamera1::ReleaseImage(TInt aReleaseImage)
sl@0: 	{
sl@0: 	return DoControl(EReleaseImage,(TAny*)aReleaseImage);
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Override of RHandleBase::Duplicate.
sl@0:   This takes care of also duplicating other resources owned by this object.
sl@0:   @param aSrc  A reference to the thread containing the handle which is to be 
sl@0:                duplicated for this thread.
sl@0:   @param aType An enumeration whose enumerators define the ownership of this 
sl@0:                handle. If not explicitly specified, EOwnerProcess is taken
sl@0:                as default.
sl@0:   @return KErrNone, if successful; otherwise, one of the other system wide error 
sl@0:           codes.
sl@0:   @see RHandleBase::Duplicate
sl@0: */
sl@0: TInt RCamera1::Duplicate(const RThread& aSrc,TOwnerType aType)
sl@0: 	{
sl@0: 	// Duplicate handle to channel
sl@0: 	TInt r=RHandleBase::Duplicate(aSrc,aType);
sl@0: 	if(r==KErrNone && iChunk.Handle()!=KNullHandle)
sl@0: 		{
sl@0: 		// Duplicate handle to chunk
sl@0: 		r = iChunk.Duplicate(aSrc,aType);
sl@0: 		if(r!=KErrNone)
sl@0: 			RHandleBase::Close(); // Undo channel open
sl@0: 		}
sl@0: 	if(r!=KErrNone)
sl@0: 		iChunk.SetHandle(KNullHandle); // On error, clear chunk handle
sl@0: 	return r;
sl@0: 	}
sl@0: 
sl@0: /**
sl@0:   Obtain the chunk into which captured images will be placed.
sl@0:   This chunk may change after calls to SetConfig().
sl@0: 
sl@0:   @return The chunk
sl@0: 
sl@0:   @pre The driver must have been configured using SetConfig()
sl@0: */
sl@0: inline RChunk RCamera1::ImageChunk() const
sl@0: 	{
sl@0: 	return iChunk;
sl@0: 	}
sl@0: 
sl@0: #endif  // !__KERNEL_MODE__
sl@0: 
sl@0: #endif
sl@0: