epoc32/include/icl/imagecodec.h
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
equal deleted inserted replaced
3:e1b950c65cb4 4:837f303aceeb
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).
     2 // All rights reserved.
     2 // All rights reserved.
     3 // This component and the accompanying materials are made available
     3 // This component and the accompanying materials are made available
     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
     4 // under the terms of "Eclipse Public License v1.0"
     5 // which accompanies this distribution, and is available
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
     7 //
     7 //
     8 // Initial Contributors:
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
     9 // Nokia Corporation - initial contribution.
    10 //
    10 //
    11 // Contributors:
    11 // Contributors:
    17 #define __IMAGECODEC_H__
    17 #define __IMAGECODEC_H__
    18 
    18 
    19 #include <e32std.h>
    19 #include <e32std.h>
    20 #include <fbs.h>
    20 #include <fbs.h>
    21 
    21 
       
    22 #ifndef SYMBIAN_ENABLE_SPLIT_HEADERS
       
    23 #include <icl/imagecodecdef.h>
       
    24 #endif
       
    25 
    22 // Pre-definitions needed to make sure everything always defined in the right order
    26 // Pre-definitions needed to make sure everything always defined in the right order
    23 class TFrameInfo;
    27 class TFrameInfo;
    24 class TImageDataBlock;
    28 class TImageDataBlock;
    25 class CFrameImageData;
    29 class CFrameImageData;
    26 
    30 
    51 	*/
    55 	*/
    52 	EFrameIncompleteRepositionRequest,
    56 	EFrameIncompleteRepositionRequest,
    53 	/** Processing of streaming block is complete.
    57 	/** Processing of streaming block is complete.
    54 	*/
    58 	*/
    55 	EBlockComplete
    59 	EBlockComplete
    56 	};
       
    57 
       
    58 /**
       
    59 @internalComponent
       
    60 
       
    61 
       
    62 Class used to shadow the descriptor supplying the image data.
       
    63 
       
    64 It maintains a flag to determine whether the descriptor contains a
       
    65 filename or the image data itself.
       
    66 
       
    67 This class is not intended for public use.
       
    68 */
       
    69 class TImageParameterData
       
    70 	{
       
    71 public:
       
    72 
       
    73 	/**
       
    74 	Flag used to determine what the descriptor contains.
       
    75 	*/
       
    76 	enum TImageParameterDataFlag
       
    77 		{
       
    78 		/** Field not set.
       
    79 		*/
       
    80 		ENull		= 0x00000000,
       
    81 
       
    82 		/** Descriptor is a filename.
       
    83 		*/
       
    84 		EFilename	= 0x00000001,
       
    85 
       
    86 		/** Descriptor contains data.
       
    87 		*/
       
    88 		EData		= 0x00000002
       
    89 		};
       
    90 
       
    91 	TImageParameterData();
       
    92 	void SetFilenamePtr(const TDesC* aSourceFilenamePtr);
       
    93 	void SetDataPtr(const TDesC8* aSourceDataPtr);
       
    94 	IMPORT_C TBool IsFilename() const;
       
    95 	IMPORT_C const TDesC* SourceFilenamePtr() const;
       
    96 	IMPORT_C const TDesC8* SourceDataPtr() const;
       
    97 
       
    98 private:
       
    99 	TImageParameterDataFlag iImageParameterDataFlag;
       
   100 	union
       
   101 		{
       
   102 		const TDesC* iSourceFilenamePtr;
       
   103 		const TDesC8* iSourceDataPtr;
       
   104 		};
       
   105 	};
    60 	};
   106 
    61 
   107 /**
    62 /**
   108 @publishedAll
    63 @publishedAll
   109 @released
    64 @released
   358 
   313 
   359 /**
   314 /**
   360 @publishedAll
   315 @publishedAll
   361 @released
   316 @released
   362 
   317 
       
   318 
   363 Provides functions to determine or set features of the codec's CImageProcessor plus
   319 Provides functions to determine or set features of the codec's CImageProcessor plus
   364 provide extra functionality for Framework Extensions.
   320 provide extra functionality for Framework Extensions.
   365 
   321 
   366 Note: 
   322 Note: 
   367 For use by plugin writers only.
   323 For use by plugin writers only.