epoc32/include/iclexifimageframe.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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 feature is documented in ICL_Design_EXIF.doc
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
/**
williamr@2
    19
 @file
williamr@2
    20
 @publishedAll
williamr@2
    21
 @released
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#ifndef ICLEXIFIMAGEFRAME_H
williamr@2
    25
#define ICLEXIFIMAGEFRAME_H
williamr@2
    26
williamr@2
    27
#include <imageconversion.h>
williamr@2
    28
#include <icl/imageplugin.h>
williamr@2
    29
#include <iclexif.h>
williamr@2
    30
#include "imageframe.h"
williamr@2
    31
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
This class provides access to an extension of the EXIF JPEG decoder that supports
williamr@2
    35
decoding of JPEG images held either in files or in descriptors to a destination of type CImageFrame.
williamr@2
    36
williamr@2
    37
This is an addition to the features provided by CJPEGExifDecoder.
williamr@2
    38
*/
williamr@2
    39
williamr@2
    40
class CJPEGImageFrameDecoder : public CJPEGExifDecoder
williamr@2
    41
	{
williamr@2
    42
public:
williamr@2
    43
	IMPORT_C static CJPEGImageFrameDecoder* NewL();
williamr@2
    44
	IMPORT_C ~CJPEGImageFrameDecoder();
williamr@2
    45
williamr@2
    46
	IMPORT_C void ConvertFrame(TRequestStatus* aRequestStatus, CImageFrame& aDestFrame);
williamr@2
    47
	IMPORT_C void ConvertFrame(TRequestStatus* aRequestStatus, CImageFrame& aDestFrame, TInt aFrameNumber);
williamr@2
    48
	IMPORT_C void ContinueConvertFrame(TRequestStatus* aRequestStatus);
williamr@2
    49
williamr@2
    50
	IMPORT_C TBool RecommendedBufferSize(TUid aFormatCode, TInt& bufferSize);
williamr@2
    51
	IMPORT_C TBool RecommendedBufferSize(TInt& bufferSize);
williamr@2
    52
williamr@2
    53
protected:
williamr@2
    54
	IMPORT_C CJPEGImageFrameDecoder();
williamr@2
    55
	};
williamr@2
    56
williamr@2
    57
/**
williamr@2
    58
This class provides access to an extension of the EXIF JPEG encoder that supports
williamr@2
    59
encoding JPEG images from a source of type CImageFrame to either a file or a descriptor. 
williamr@2
    60
williamr@2
    61
This is an addition to the features provided by CJPEGExifEncoder.
williamr@2
    62
*/
williamr@2
    63
williamr@2
    64
class CJPEGImageFrameEncoder : public CJPEGExifEncoder
williamr@2
    65
	{
williamr@2
    66
public:
williamr@2
    67
	IMPORT_C static CJPEGImageFrameEncoder* NewL();
williamr@2
    68
	IMPORT_C ~CJPEGImageFrameEncoder();
williamr@2
    69
williamr@2
    70
	IMPORT_C void ConvertFrame(TRequestStatus* aRequestStatus, const CImageFrame& aSrcFrame);
williamr@2
    71
	IMPORT_C void ConvertFrame(TRequestStatus* aRequestStatus, const CImageFrame& aSrcFrame, const CFrameImageData* aFrameImageData);
williamr@2
    72
williamr@2
    73
protected:
williamr@2
    74
	IMPORT_C CJPEGImageFrameEncoder();
williamr@2
    75
	};
williamr@2
    76
	
williamr@2
    77
williamr@2
    78
/**
williamr@2
    79
This is the plugin API for Image Converter Library decoder plugins relating to CImageFrames.
williamr@2
    80
williamr@2
    81
It is an extension of the ICL EXIF decoder plugin which provides a container for specific
williamr@2
    82
data required to decode a JPEG file or descriptor to a destination of type CImageFrame.
williamr@2
    83
*/
williamr@2
    84
class CJPEGImageFrameDecoderPlugin : public CJPEGExifDecoderPlugin
williamr@2
    85
	{
williamr@2
    86
public:
williamr@2
    87
	IMPORT_C ~CJPEGImageFrameDecoderPlugin();
williamr@2
    88
	IMPORT_C CImageFrame& DstImageFrame();
williamr@2
    89
	IMPORT_C TInt FrameNumber() const;
williamr@2
    90
	IMPORT_C TUid FormatCode() const;
williamr@2
    91
	IMPORT_C void SetRecommendedBufferSize(TInt aBufferSize);
williamr@2
    92
williamr@2
    93
	void SetConvertParameters(CImageFrame& aDestFrame, TInt aFrameNumber);
williamr@2
    94
	void SetFormatCode(TUid aFormatCode);
williamr@2
    95
	TInt RecommendedBufferSize();
williamr@2
    96
williamr@2
    97
protected:
williamr@2
    98
	IMPORT_C CJPEGImageFrameDecoderPlugin();
williamr@2
    99
williamr@2
   100
private:
williamr@2
   101
	// reserved for future expansion
williamr@2
   102
	IMPORT_C virtual void Reserved1();
williamr@2
   103
	IMPORT_C virtual void Reserved2();
williamr@2
   104
	IMPORT_C virtual void Reserved3();
williamr@2
   105
	
williamr@2
   106
private:
williamr@2
   107
	CImageFrame* iDstImageFrame;
williamr@2
   108
	TInt iFrameNumber;
williamr@2
   109
	TUid iFormatCode;		
williamr@2
   110
	TInt iRecommendedBufferSize;
williamr@2
   111
williamr@2
   112
	TAny* iReserved;
williamr@2
   113
	};
williamr@2
   114
williamr@2
   115
/**
williamr@2
   116
This is the plugin API for Image Converter Library encoder plugins relating to CImageFrames. 
williamr@2
   117
williamr@2
   118
It is an extension of the ICL EXIF encoder plugin which provides a container for specific
williamr@2
   119
data required to encode image data from a source of type CImageFrame to a JPEG file or descriptor.
williamr@2
   120
*/
williamr@2
   121
class CJPEGImageFrameEncoderPlugin : public CJPEGExifEncoderPlugin
williamr@2
   122
	{
williamr@2
   123
public:
williamr@2
   124
	IMPORT_C ~CJPEGImageFrameEncoderPlugin();
williamr@2
   125
	IMPORT_C const CImageFrame& SrcImageFrame() const;
williamr@2
   126
	IMPORT_C const CFrameImageData& FrameImageData() const;
williamr@2
   127
williamr@2
   128
	void SetConvertParameters(const CImageFrame& aSrcFrame, const CFrameImageData* aFrameImageData);
williamr@2
   129
williamr@2
   130
protected:
williamr@2
   131
	IMPORT_C CJPEGImageFrameEncoderPlugin();
williamr@2
   132
williamr@2
   133
private:
williamr@2
   134
	// reserved for future expansion
williamr@2
   135
	IMPORT_C virtual void Reserved1();
williamr@2
   136
	IMPORT_C virtual void Reserved2();
williamr@2
   137
	IMPORT_C virtual void Reserved3();
williamr@2
   138
		
williamr@2
   139
private:
williamr@2
   140
	const CImageFrame* iSrcImageFrame;
williamr@2
   141
	const CFrameImageData* iFrameImageData;
williamr@2
   142
williamr@2
   143
	TAny* iReserved;
williamr@2
   144
	};
williamr@2
   145
williamr@2
   146
#endif // ICLEXIFIMAGEFRAME_H