epoc32/include/icl/exifimagedisplayext.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// This is the extension to the plugin API for the Image Display framework
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
#ifndef EXIFIMAGEDISPLAYEXT_H
williamr@2
    19
#define EXIFIMAGEDISPLAYEXT_H
williamr@2
    20
williamr@2
    21
#include <e32base.h>
williamr@2
    22
#include <icl/imagedisplaypluginext.h>
williamr@2
    23
#include <icl/exifimagedisplay.hrh>
williamr@2
    24
williamr@2
    25
const TUid KExifImageDisplayExtensionUid={KUidExifImageDisplayExtension};
williamr@2
    26
williamr@2
    27
class MExifMetadataReader;
williamr@2
    28
williamr@2
    29
/**
williamr@2
    30
This class extends the functionality of the Image Display Library client API defined 
williamr@2
    31
in the class CImageDisplay. This extension is supported only by the EXIF-specific framework
williamr@2
    32
plug-ins. In order to invoke the extended functionality, the user needs to call the 
williamr@2
    33
CImageDisplay::ExtensionInterface( ) with the KExifImageDisplayExtensionUid interface UID
williamr@2
    34
and an interface pointer to the object of this class.
williamr@2
    35
williamr@2
    36
@publishedAll
williamr@2
    37
@released
williamr@2
    38
*/
williamr@2
    39
class MExifImageDisplayExtension :public MImageDisplayPluginExtension
williamr@2
    40
	{
williamr@2
    41
public:
williamr@2
    42
	/**
williamr@2
    43
	Obtains an MExifMetadataReader that can be used to access the EXIF metadata of the image.
williamr@2
    44
	@param aPtr A reference to a pointer to the MExifMetadataReader that can be used to access the EXIF
williamr@2
    45
				metadata of the image.
williamr@2
    46
	@return A system-wide error code.
williamr@2
    47
	*/
williamr@2
    48
	virtual TInt GetExifMetadataReader(MExifMetadataReader*& aPtr)=0;
williamr@2
    49
	
williamr@2
    50
	/**
williamr@2
    51
	Sets the level of quality for the scaling algorithm.
williamr@2
    52
	If quality level is not set by calling this function then 
williamr@2
    53
	the fastest/lowest quality algorithm is used.
williamr@2
    54
	Note: This function must be called before calling CImageDisplay::Play()
williamr@2
    55
	
williamr@2
    56
	@param aQualityLevel Quality level value for the scaling algorithm.
williamr@2
    57
				See CBitmapScaler::TQualityAlgorithm for a set of possible values.
williamr@2
    58
	@return A system-wide error code.
williamr@2
    59
	*/	
williamr@2
    60
	virtual TInt SetScaleQuality(TInt aQualityLevel)=0;
williamr@2
    61
	
williamr@2
    62
	/**
williamr@2
    63
	Sets the maximum quality reduction factor for image decoding.
williamr@2
    64
	By default, the plug-in calculates an optimal maximum reduction factor 
williamr@2
    65
	and uses it to produce a series of roughly-decoded images, passing each of 
williamr@2
    66
	them to the observer interface with the CImageDisplayPlugin::EStatusPartialFrame flag set.
williamr@2
    67
	Note: This function must be called before calling CImageDisplay::Play().
williamr@2
    68
	
williamr@2
    69
	@param aMaxReductionFactor
williamr@2
    70
				The maximum quality reduction factor.
williamr@2
    71
				Usually the maximum reduction can be specfied in range of 0-3.
williamr@2
    72
				A value of 0 means no quality reduction is allowed, so a full-quality image will be decoded as the first frame.
williamr@2
    73
				A value of 1 means (1/2)^1=1/2 of the original image quality. 
williamr@2
    74
				A value of 3 means (1/2)^3=1/8 of the original image quality. 
williamr@2
    75
				If the reduction factor is not set by calling this function then
williamr@2
    76
				the reduction factor value of 3 is used for jpeg images.
williamr@2
    77
	@return KErrArgument if the aMaxReductionFactor parameter is not in the supported range, or a system-wide error code.
williamr@2
    78
	*/	
williamr@2
    79
	virtual TInt SetMaximumReductionFactor(TInt aMaxReductionFactor)=0;
williamr@2
    80
	};
williamr@2
    81
williamr@2
    82
#endif // EXIFIMAGEDISPLAYEXT_H