// Copyright (c) 2001-2009 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:

//

#include "ImageClientMain.h"

#include "ImageConversionPriv.h"

#include "icl/ImagePlugin.h"

#include "icl/ImageConstruct.h"

#include "ImageConversion.h"

const TInt KMaxDstBufferSize = 4096;

/* IMAGE DECODER PRIVATE */

CImageDecoderPriv::CImageDecoderPriv(CImageDecodeConstruct* aConstruct, MImageDecoderPrivSupport* aSupport)

	: CActive(CActive::EPriorityIdle), iImageType(CImageDecoder::EImageTypeMain), iConstruct(aConstruct), iSupport(aSupport), iReadOnly(EFalse), iUseBufferReadOptimization(ETrue)

	{

	ASSERT(aConstruct != NULL);

	ASSERT(aSupport != NULL);

	CActiveScheduler::Add(this);

	}

void CImageDecoderPriv::SetFileL(RFs& aFs, const TDesC& aSourceFilename, const CImageDecoder::TOptions aOptions)

	{

	iFs = &aFs;

	iOptions = aOptions;

	iImageParameterData.SetFilenamePtr(&aSourceFilename);

	delete iContent;

	iContent = NULL;

	delete iData;

	iData = NULL;

	iReadOnly=ETrue;

	TRAPD(err, iContent = CContent::NewL(*iImageParameterData.SourceFilenamePtr(), EContentShareReadOnly));

	if (err!= KErrNone && err != KErrNoMemory)

		{

		iReadOnly=EFalse;

		iContent = CContent::NewL(*iImageParameterData.SourceFilenamePtr(), EContentShareReadWrite);

		}

	User::LeaveIfNull(iContent);

	iData = iContent->OpenContentL(iIntent, (iUniqueId) ? static_cast<TDesC&>(*iUniqueId) : KDefaultContentObject());

	//Try to find if content is DRM

    TInt value = -1;

    TInt getAttrResult =iContent->GetAttribute(EIsProtected, value);

    if(getAttrResult != KErrNone || value!=0)

        {

        //either we had an error from getAttribute or  EIsProtected is not set to 0 (false)

        //Could be DRM content, don't apply iUseBufferReadOptimization

        iUseBufferReadOptimization = EFalse;

        }   

	iCachedDataSize = -1;

    }

void CImageDecoderPriv::SetFileL(RFile& aFile, const CImageDecoder::TOptions aOptions)

	{

	iOptions = aOptions;

	User::LeaveIfError(aFile.Name(iFileName));

	iImageParameterData.SetFilenamePtr(&iFileName);

	delete iContent;

	iContent = NULL;

	delete iData;

	iData = NULL;

	iContent = CContent::NewL(aFile);

	iData = iContent->OpenContentL(iIntent, (iUniqueId) ? static_cast<TDesC&>(*iUniqueId) : KDefaultContentObject());

	//Try to find if content is DRM

    TInt value = -1;

    TInt getAttrResult =iContent->GetAttribute(EIsProtected, value);

    if(getAttrResult != KErrNone || value!=0)

        {

        //either we had an error from getAttribute or EIsProtected is not set to 0 (false)

        //Could be DRM content, don't apply iUseBufferReadOptimization

        iUseBufferReadOptimization = EFalse;

        }   

	iCachedDataSize = -1;        

	}

void CImageDecoderPriv::SetDataL(RFs& aFs, const TDesC8& aSourceData, const CImageDecoder::TOptions aOptions)

	{

	iFs = &aFs;

	iOptions = aOptions;

	iImageParameterData.SetDataPtr(&aSourceData);

	}

CImageDecoderPriv* CImageDecoderPriv::NewL(CImageDecodeConstruct* aConstruct, MImageDecoderPrivSupport* aSupport)

	{

	CImageDecoderPriv* self = new (ELeave) CImageDecoderPriv(aConstruct, aSupport);

	return self;

	}

CImageDecoderPriv::~CImageDecoderPriv()

	{

	ASSERT(!IsActive());

	if (iPlugin)

		iPlugin->Cleanup();

	iFrameInfo.ResetAndDestroy();

	iFrameData.ResetAndDestroy();

	delete iImageReadCodec; // Created in ScanDataL()

	delete iData;

	delete iContent;

	delete iPlugin;

	delete iUniqueId;

	}

void CImageDecoderPriv::Cleanup()

	{

	delete iReadBuffer; iReadBuffer = NULL;	

	}

void CImageDecoderPriv::CreatePluginL()

	{

	iPlugin = iConstruct->NewPluginL();

	iPlugin->iProperties = this;

	}

/**

@see CImageDecoder::SetImageTypeL

*/

void CImageDecoderPriv::SetImageTypeL(TInt aImageType)

	{

	if (aImageType == iImageType)

		{

		return;

		}

	if ( (aImageType == CImageDecoder::EImageTypeThumbnail) &&

		 (iThumbnailData == NULL) )

		{

		User::Leave(KErrNotFound);

		}

	TInt prevImageType = iImageType;	

	iImageType = aImageType;

	// Delete the old read codec - a new one will be instantiated by the 

	// plugin on notification of Image Type change.

	delete iImageReadCodec;

	iImageReadCodec = NULL;

	iCurrentFrame = 0;

	iPosition = 0;

	TRAPD(err,iPlugin->NotifyImageTypeChangeL(aImageType));

	if(err != KErrNone)

		{

		delete iImageReadCodec;

		iImageReadCodec = NULL;

		// Try to switch back to the main image

		iImageType = prevImageType;

		TRAPD(err2,iPlugin->NotifyImageTypeChangeL(prevImageType));

		if (err2 != KErrNone)

			{

			// Switching back to the main image type shouldn't fail as corrupt as it has been done once before 

			// when creating the decoder.

			__ASSERT_DEBUG( (err2 != KErrCorrupt), Panic( EInvalidFunctionLeave ) );

			User::Leave(err2);

			}

		// We report the thumbnail problem to the application

		User::Leave(err);

		}

	}

void CImageDecoderPriv::SetThumbnailData(HBufC8* aThumbnailData)

	{

	// The buffer containing the thumbnail data is owned by the plugin

	iThumbnailData = aThumbnailData;

	}

/*

Disable optimization of this function by the VC compiler.

This function suffers from the known behaviour of setjmp()/longjmp()

used by the TRAP() harness in that register variables can be 'stomped'

by the longjmp/leave process. 

*/

#ifdef __VC32__

#pragma optimize("",off)

#endif  // __VC32__

void CImageDecoderPriv::Convert(RThread& aRequestThread, TRequestStatus* aRequestStatus, CFbsBitmap& aDestination, TInt aFrameNumber)

	{

	if (IsActive())

		Panic(EConvertCalledWhileBusy);

	iRequestThread = &aRequestThread;

	iConvStatus = aRequestStatus;

 	*iConvStatus = KRequestPending;

	iCurrentFrame = aFrameNumber;

	if (iCurrentFrame < 0 || iCurrentFrame >= iFrameInfo.Count())

		{

		RequestComplete(KErrArgument);

		return;

		}

	if (aDestination.Handle() == 0)

		Panic(ENoDestinationBitmap);

   if(aDestination.ExtendedBitmapType()!=KNullUid)

        {

        RequestComplete(KErrNotSupported);

        return;

        }

	iDestination = &aDestination;

	iDestinationHandle = iDestination->Handle();

	iDestinationSize = iDestination->SizeInPixels();

	iDestinationMask = NULL;

	TRAPD(error, iPlugin->InitConvertL());

	if (error!=KErrNone)

		RequestComplete(error);

	else

		SelfComplete(KErrNone);

	}

#ifdef __VC32__

#pragma optimize("",on)

#endif  // __VC32__

void CImageDecoderPriv::Convert(RThread& aRequestThread, TRequestStatus* aRequestStatus, CFbsBitmap& aDestination, CFbsBitmap& aDestinationMask, TInt aFrameNumber)

	{	

	if (IsActive())

		Panic(EConvertCalledWhileBusy);

	iRequestThread = &aRequestThread;

	iConvStatus = aRequestStatus;

	*iConvStatus = KRequestPending;

	iCurrentFrame = aFrameNumber;

	if (iCurrentFrame < 0 || iCurrentFrame >= iFrameInfo.Count())

		{

		RequestComplete(KErrArgument);

		return;

		}

	if (aDestination.Handle() == 0)

		Panic(ENoDestinationBitmap);

   if(aDestination.ExtendedBitmapType()!=KNullUid || (aDestinationMask.Handle()!=0 && aDestinationMask.ExtendedBitmapType()!=KNullUid))

        {

        RequestComplete(KErrNotSupported);

        return;

        }

	iDestination = &aDestination;

	iDestinationHandle = iDestination->Handle();

	iDestinationSize = iDestination->SizeInPixels();

	if (aDestinationMask.Handle() == 0)

		Panic(ENoBitmapMask);

	else

		{

		// if we have an alpha channel mask, insist an EGray256 mask bitmap

		// else allow either an EGray2 or an EGray256 one

		// ie. for compatability allow an EGray256 mask bitmap, even if we only have binary data

		TDisplayMode maskDisplayMode = aDestinationMask.DisplayMode();

		const TFrameInfo& frameInfo = FrameInfo(iCurrentFrame);

		if (!(maskDisplayMode==EGray256 || 

			(maskDisplayMode==EGray2 && !(frameInfo.iFlags & TFrameInfo::EAlphaChannel))))

			{

			RequestComplete(KErrArgument);

			return;

			}

		// furthermore, if we have a mask, enforce is same size as destination

		if (iDestinationSize != aDestinationMask.SizeInPixels())

			{

			RequestComplete(KErrArgument);

			return;

			}

		}

	iDestinationMask = &aDestinationMask;

	iDestinationMaskHandle = iDestinationMask->Handle();

	TRAPD(error, iPlugin->InitConvertL());

	if (error!=KErrNone)

		RequestComplete(error);

	else

		SelfComplete(KErrNone);

	}

void CImageDecoderPriv::ContinueConvert(RThread& aRequestThread, TRequestStatus* aRequestStatus)

	{

	// NB Not busy and iCurrentProcessingData==true -> we previously stopped on an underflow

	// if not true we must have stopped for some other reason and ContinueConvert is illegal

	if (IsActive())

		Panic(EConvertCalledWhileBusy);

	if (!iCurrentlyProcessingData)

		Panic(EIllegalContinueConvert);

	ASSERT(iPlugin->ValidDestination()); // if legal we should have an iDestination. Whether iMask depends.

	if (iDestination->Handle() != iDestinationHandle)

		Panic(EDifferentDestinationBitmap);

	if (iDestinationMask && (iDestinationMask->Handle() != iDestinationMaskHandle))

		Panic(EDifferentDestinationMask);

	if (iDestination->SizeInPixels() != iDestinationSize)

		Panic(EModifiedDestination);

	iRequestThread = &aRequestThread;

	iConvStatus = aRequestStatus;

	*iConvStatus = KRequestPending;

	SelfComplete(KErrNone);

	return;

	}

TInt CImageDecoderPriv::DataSizeL()

    {

    TInt dataSize = iCachedDataSize;

    if (dataSize == -1)

        {

        iData->DataSizeL(dataSize);

        if(iReadOnly)

             iCachedDataSize = dataSize;

        }

    return dataSize;

    }

void CImageDecoderPriv::PrepareForProcessFrameL()

	{

	TInt localSrcLength;

	TBool srcHasGrown = EFalse;

	if (iImageParameterData.IsFilename())

		{

		ASSERT(iData);

        if(iUseBufferReadOptimization)

            {

            localSrcLength = DataSizeL();

            }

        else

            {

            iData->DataSizeL(localSrcLength);

            }

		}

	else

		{

		localSrcLength = iImageParameterData.SourceDataPtr()->Length();

		}

	if (localSrcLength > iSrcLength)

		srcHasGrown = ETrue;

	iSrcLength = localSrcLength;

	if ((iSrcDes.Length() == 0) || srcHasGrown)

		{

		// Fetch next buffer.

		// Get next block size.

		iCurrentBlockLength = iBlockLength;

		if ((iCurrentBlockLength + iPosition) > iDataLength)

			{

			// If current position + read buffer length > Data length then

			// iCurrentBlockLength = what ever's left in iDataLength

			iCurrentBlockLength = Max(0, iDataLength - iPosition);

			}

		// Get the next block of data

		TPtrC8 ptr;

		ReadDataL((iPosition + iStartPosition), ptr, iCurrentBlockLength);

		// Set iSrcDes to point at next block in the source data.

		iSrcDes.Set(ptr);

		iCurrentBlockLength = iSrcDes.Length();

		}

	iOldSrcDesLength = iSrcDes.Length();

	}

/**

* Issues a read operation by sending the start position

* along with the destination descriptor and size.

*

* When this function is used to read data from a file, it

* can send the start position and length in one IPC operation,

* and so avoid having to issue a seek first.

*

* Because ContentAccess::CData does not support a synchronous

* version of this API, this function takes care of waiting for

* the operation to complete, and leaves with any error code.

* This simplifies the calling code.

*

* @param   aPosition       Position in source data to read from.

* @param   aDest           The data is written into this descriptor.

* @param   aSize           Amount of data to read in bytes.

* @leave                   Any Symbian OS error code.

*/

void CImageDecoderPriv::SeekReadL(TInt aPosition, TDes8& aDest, TInt aSize)

    {

    #ifdef __WINS__

        RDebug::Printf("sr,%d,%d", aPosition, aSize);

    #endif

    TRequestStatus rs;

    TInt result=iData->Read(aPosition, aDest, aSize, rs);

    User::LeaveIfError(result);

    User::WaitForRequest(rs);

    User::LeaveIfError(rs.Int());

    }

void CImageDecoderPriv::DoConvert()

	{

	TRAPD(errCode, PrepareForProcessFrameL());

	if (errCode!=KErrNone)

		{

		RequestComplete(errCode);

		return;

		}

	TFrameState codecState = EFrameIncomplete; 

	if (iCurrentBlockLength)

		TRAP(errCode, codecState = iImageReadCodec->ProcessFrameL(iSrcDes));

	HandleProcessFrameResult(errCode, codecState);

	}

void CImageDecoderPriv::HandleProcessFrameResult(TInt aErrCode, TFrameState aCodecState)

	{

	if (aErrCode!=KErrNone)

		{

		ASSERT(aErrCode != KErrUnderflow);

		iCurrentlyProcessingData = EFalse;

		RequestComplete(aErrCode);

		return;

		}

	TInt newSrcDesLength = iSrcDes.Length();

	iPosition += iOldSrcDesLength - newSrcDesLength;

	if (aCodecState == EFrameIncompleteRepositionRequest)

		{

		TInt length   = iBlockLength;

		TInt position = iPosition + iStartPosition;

		iImageReadCodec->GetNewDataPosition(position, length);

		if (position<0)

			{

			iCurrentlyProcessingData = EFalse;

			RequestComplete(KErrCorrupt);

			return;

			}

		iPosition = position-iStartPosition;

		}

	if (aCodecState == EBlockComplete)	// Block decoded successfully

		{

		iCurrentlyProcessingData = EFalse; // To avoid call of ContinueConvert()

		RequestComplete(KErrNone);

		return;

		}

	if (aCodecState == EFrameComplete)	// Frame decoded successfully

		{

		iImageReadCodec->Complete();

		iCurrentlyProcessingData = EFalse;

		RequestComplete(KErrNone);

		return;

		}

	else if (newSrcDesLength == iOldSrcDesLength && iCurrentlyProcessingData) // Needs more data than is currently present in the buffer to make progress

		{

		//call of ContinueConvert() only

		 //The following method call is required so that codecs can get the data already decoded can be displayed

		iImageReadCodec->Complete();

		RequestComplete(KErrUnderflow);

		return;

		}

	// Each Plug-in has to trigger the active object as it needs RunL called again.

	iSrcDes.SetLength(0);

	SelfComplete(KErrNone);

	}

TBufPtr8& CImageDecoderPriv::SourceData()

	{

	return iSrcDes;

	}

void CImageDecoderPriv::RunL()

	{

	ASSERT(iStatus==KErrNone); // we don't handle errors at this point. Should only get here on KErrNone

	iPlugin->DoConvert();

	}

void CImageDecoderPriv::RequestComplete(TInt aReason)

	{

	ASSERT(iPlugin);

	iPlugin->NotifyComplete();

	ASSERT(iRequestThread);

	if (iData && aReason == KErrNone && !iIntentHasBeenExecuted)

		{

		TInt err = iData->ExecuteIntent(iIntent);

		if(err == KErrNone)

			{

			//Intent has been executed. Ensure it is not executed again for this image.

			iIntentHasBeenExecuted = ETrue;

			}

		else

			{

			aReason = err;

			}

		}