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

//

/**

 @file

 @internalComponent

*/

#include <mtp/cmtptypedevicepropdesc.h>

#include <mtp/mtpdatatypeconstants.h>

#include <mtp/mtpprotocolconstants.h>

#include "mtpdatatypespanic.h"

// Dataset constants

const TUint CMTPTypeDevicePropDesc::KFlat1ChunkSize(5);

const TUint CMTPTypeDevicePropDesc::KNumChunksWithoutForm(EIdFormFlagChunk + 1);

const TUint CMTPTypeDevicePropDesc::KNumChunksWithForm(EIdFormChunk + 1);

const TUint CMTPTypeDevicePropDescEnumerationForm::KNumberOfValuesChunk(0);

const TUint CMTPTypeDevicePropDescEnumerationForm::KValueChunks(1);

// Dataset element metadata    

const CMTPTypeCompoundBase::TElementInfo CMTPTypeDevicePropDesc::iElementMetaData[CMTPTypeDevicePropDesc::ENumElements] = 

    {

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT16,    0,                  KMTPTypeUINT16Size}},   // EDevicePropertyCode

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT16,    2,                  KMTPTypeUINT16Size}},   // EDatatype

        {EIdFlat1Chunk,         EMTPTypeFlat,       {EMTPTypeUINT8,     4,                  KMTPTypeUINT8Size}},    // EGetSet

        {EIdDefaultValueChunk,  EMTPTypeReference,  {EMTPTypeUndefined, KMTPNotApplicable,  KMTPNotApplicable}},    // EFactoryDefaultValue

        {EIdCurrentValueChunk,  EMTPTypeReference,  {EMTPTypeUndefined, KMTPNotApplicable,  KMTPNotApplicable}},    // ECurrentValue

        {EIdFormFlagChunk,      EMTPTypeUINT8,      {EMTPTypeUINT8,     KMTPNotApplicable,  KMTPNotApplicable}},    // EFormFlag

        {EIdFormChunk,          EMTPTypeReference,  {EMTPTypeUndefined, KMTPNotApplicable,  KMTPNotApplicable}},    // EForm

    };

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

empty MTP DevicePropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode. 

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewL(TUint16 aPropertyCode)

    {

    CMTPTypeDevicePropDesc* self = NewLC(aPropertyCode);

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

empty MTP DevicePropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode. A pointer to the data type is placed on

the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewLC(TUint16 aPropertyCode)

    {    

    CMTPTypeDevicePropDesc* self = new (ELeave) CMTPTypeDevicePropDesc(); 

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, NULL);

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

MTP DevicePropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode, and the specified FORM. 

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewL(TUint16 aPropertyCode, const MMTPType& aForm)

    {

    CMTPTypeDevicePropDesc* self = NewLC(aPropertyCode, aForm);

    CleanupStack::Pop(self); 

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

MTP DevicePropDesc dataset type with the default Datatype and Form Flag 

defined for the specified PropertyCode, and the specified FORM. A pointer 

to the data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewLC(TUint16 aPropertyCode, const MMTPType& aForm)

    {    

    CMTPTypeDevicePropDesc* self = new (ELeave) CMTPTypeDevicePropDesc(); 

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, &aForm);

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

MTP DevicePropDesc dataset type with the default Datatype defined for the 

specified PropertyCode, and the specified Form Flag and FORM.  

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aGetSet The Get/Set flag of the DevicePropDesc.

@param aFormFlag The required Form Flag of the DevicePropDesc.

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewL(TUint16 aPropertyCode, TUint8 aGetSet, TUint8 aFormFlag, const MMTPType* aForm)

    {

    CMTPTypeDevicePropDesc* self = NewLC(aPropertyCode, aGetSet, aFormFlag, aForm);

    CleanupStack::Pop(self);

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an 

MTP DevicePropDesc dataset type with the default Datatype defined for the 

specified PropertyCode, and the specified Form Flag and FORM. A pointer 

to the data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aGetSet The Get/Set flag of the DevicePropDesc.

@param aFormFlag The required Form Flag of the DevicePropDesc.

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewLC(TUint16 aPropertyCode, TUint8 aGetSet, TUint8 aFormFlag, const MMTPType* aForm)

    {

    CMTPTypeDevicePropDesc* self = new (ELeave) CMTPTypeDevicePropDesc(); 

    CleanupStack::PushL(self); 

    TPropertyInfo info;

    PropertyInfoL(aPropertyCode, info);

    info.iGetSet    = aGetSet;

    info.iFormFlag  = aFormFlag;

    self->ConstructL(aPropertyCode, info, aForm);

    return self;    

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an  

MTP DevicePropDesc dataset type with the specified values.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aInfo The MTP DevicePropDesc dataset characteristics (meta data).

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/    

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewL(TUint16 aPropertyCode, const TPropertyInfo& aInfo, const MMTPType* aForm)

    {

    CMTPTypeDevicePropDesc* self = CMTPTypeDevicePropDesc::NewLC(aPropertyCode, aInfo, aForm); 

    CleanupStack::Pop(self);

    return self; 

    }

/**

MTP DevicePropDesc dataset factory method. This method is used to create an  

MTP DevicePropDesc dataset type with the specified values. A pointer to the 

data type is placed on the cleanup stack.

@param aPropertyCode The ObjectPropertyCode of the property being described by 

the DevicePropDesc dataset.

@param aInfo The MTP DevicePropDesc dataset characteristics (meta data).

@param aForm The optional DevicePropDesc FORM dataset.

@return A pointer to the MTP DevicePropDesc dataset type. Ownership IS 

transfered.

@leave KErrNotSupported, if a FORM dataset is not defined for the property.

@leave One of the system wide error codes, if unsuccessful.

*/ 

EXPORT_C CMTPTypeDevicePropDesc* CMTPTypeDevicePropDesc::NewLC(TUint16 aPropertyCode, const TPropertyInfo& aInfo, const MMTPType* aForm)

    {

    CMTPTypeDevicePropDesc* self = new (ELeave) CMTPTypeDevicePropDesc(); 

    CleanupStack::PushL(self); 

    self->ConstructL(aPropertyCode, aInfo, aForm);

    return self;    

    }

/**

Destructor.

*/

EXPORT_C CMTPTypeDevicePropDesc::~CMTPTypeDevicePropDesc()

    {

    iChunkFlat1.Close();

    iChunkDefaultValue.Close();

    iChunkCurrentValue.Close();

    iChunkForm.Close();

    }

EXPORT_C TInt CMTPTypeDevicePropDesc::FirstWriteChunk(TPtr8& aChunk)

    {  

    /* 

    Reset the type in preparation for the data stream, by deleting all

    except the first chunk.

    */

    for (TUint i(ChunkCount() - 1); (i >= (EIdFlat1Chunk + 1)); i--)

        {

        ChunkRemove(i);

        }

    // Setup the write chunk pointer.

    TInt err(UpdateWriteSequenceErr(CMTPTypeCompoundBase::FirstWriteChunk(aChunk)));

    switch (err)

        {

    case KMTPChunkSequenceCompletion:

        err = KErrNone;

        // Don't break, fall through to set the write sequence state.

    case KErrNone:

        // Set the write sequence state.

        iWriteSequenceState = EWriteFlat1Chunk; 

        /* 

        Set the write sequence completion state. Initially assume that the 

        DevicePropDesc has a FORM field. If no FORM field is subsequently

        detected in the write data stream then the completion state is 

        adjusted accordingly.

        */

        iWriteSequenceCompletionState = EWriteFormChunk;

        break;

    default:

        break;

        }

    return  err;

    }

EXPORT_C TInt CMTPTypeDevicePropDesc::NextWriteChunk(TPtr8& aChunk)

    {

    TInt err(KMTPChunkSequenceCompletion);

    if (iWriteSequenceState != EWriteIdle)

        {

        err = UpdateWriteSequenceErr(CMTPTypeCompoundBase::NextWriteChunk(aChunk));

        if ((iWriteSequenceErr == KMTPChunkSequenceCompletion) && (iWriteSequenceState != EWriteIdle))

            {

            err = KErrNone;

            }   

        }    

    return err;

    }

EXPORT_C TUint CMTPTypeDevicePropDesc::Type() const

    {

    return EMTPTypeDevicePropDescDataset;

    }

EXPORT_C TBool CMTPTypeDevicePropDesc::CommitRequired() const

    {

    return ETrue;

    }

EXPORT_C MMTPType* CMTPTypeDevicePropDesc::CommitChunkL(TPtr8& aChunk)

    {

    if (iWriteSequenceErr == KMTPChunkSequenceCompletion)

        {

        switch (iWriteSequenceState)

            {

        case EWriteFlat1Chunk:     

            /* 

            Datatype is available, allocate sufficient chunk storage for 

            and append the EFactoryDefaultValue and ECurrentValue chunks.

            */

            iChunkDefaultValue.Close();

            iChunkDefaultValue.OpenL(Uint16L(EDatatype));

            ChunkAppendL(iChunkDefaultValue);

            break;

        case EWriteDefaultValueChunk:

            iChunkCurrentValue.Close();

            iChunkCurrentValue.OpenL(Uint16L(EDatatype));

            ChunkAppendL(iChunkCurrentValue);                        

            break;

        case EWriteCurrentValueChunk:

        	ChunkAppendL(iChunkFormFlag);

        	break;

        case EWriteFormFlagChunk: 

            /* 

            FormFlag and Datatype are available, allocate sufficient storage for 

            and append the FORM chunk.

            */

            {

            iChunkForm.Close();

            TUint8 flag(Uint8L(EFormFlag));

            iChunkForm.SetMeta(flag, Uint16L(EDatatype));

            if (HasFormField(flag))

                {

                iChunkForm.OpenL(iElementInfo[EIdFormChunk].iType);

                ChunkAppendL(iChunkForm);

                SetExpectedChunkCount(KNumChunksWithForm);

                }

            else

                {

                // Adjust the write sequence completion state.            

                iWriteSequenceCompletionState = EWriteFormFlagChunk;

                }   

            }

            break;

        case EWriteFormChunk:

        case EWriteIdle:

        default:

            break;

            }

    if (iWriteSequenceState < iWriteSequenceCompletionState)

        {

        iWriteSequenceState++;

        }

    else

        {

        iWriteSequenceState = EWriteIdle;

        }

    }

    if (CMTPTypeCompoundBase::CommitRequired())

        {

        CMTPTypeCompoundBase::CommitChunkL(aChunk);

        }

    return NULL;

    }

void CMTPTypeDevicePropDesc::PropertyInfoL(TUint16 aPropertyCode, TPropertyInfo& aInfo)

    {    

    switch (aPropertyCode)

        {        

    case EMTPDevicePropCodeUndefined:

        aInfo.iDataType     = EMTPTypeUndefined;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeBatteryLevel:

        aInfo.iDataType     = EMTPTypeUINT8;

        aInfo.iFormFlag     = ERangeForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFunctionalMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeImageSize:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeCompressionSetting:

        aInfo.iDataType     = EMTPTypeUINT8;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeWhiteBalance:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeRGBGain:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFNumber:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFocalLength:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFocusDistance:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFocusMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeExposureMeteringMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeFlashMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeExposureTime:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeExposureProgramMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeExposureIndex:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeExposureBiasCompensation:

        aInfo.iDataType     = EMTPTypeINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeDateTime:

        aInfo.iDataType     = EMTPTypeString;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeCaptureDelay:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeStillCaptureMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeContrast:

        aInfo.iDataType     = EMTPTypeUINT8;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeSharpness:

        aInfo.iDataType     = EMTPTypeUINT8;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeDigitalZoom:

        aInfo.iDataType     = EMTPTypeUINT8;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeEffectMode:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = EEnumerationForm;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeBurstNumber:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeBurstInterval:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeTimelapseNumber:

        aInfo.iDataType     = EMTPTypeUINT16;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;

    case EMTPDevicePropCodeTimelapseInterval:

        aInfo.iDataType     = EMTPTypeUINT32;

        aInfo.iFormFlag     = ENone;

        aInfo.iGetSet       = EReadOnly;

        break;