epoc32/include/imageframeconst.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) 2006-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
//
williamr@2
    15
williamr@2
    16
/**
williamr@2
    17
 @file
williamr@2
    18
 @publishedAll
williamr@2
    19
 @released
williamr@2
    20
*/
williamr@2
    21
williamr@2
    22
#ifndef IMAGEFRAMECONST_H
williamr@2
    23
#define IMAGEFRAMECONST_H
williamr@2
    24
williamr@2
    25
williamr@2
    26
#include <imageframeformats.hrh>
williamr@2
    27
#include <imageframeconst.hrh>
williamr@2
    28
williamr@2
    29
williamr@2
    30
/** 
williamr@2
    31
Constant which defines the maximum number of planes within TFrameLayout. 
williamr@2
    32
*/
williamr@2
    33
const TInt KMaxPlanesInFrame = 4;
williamr@2
    34
williamr@2
    35
/** 
williamr@2
    36
Identifier for TFrameFormat type. 
williamr@2
    37
 @see KIclImageFrameFormatUidValue
williamr@2
    38
*/ 
williamr@2
    39
static const TUid KUidIclImageFrameFormat   = {KIclImageFrameFormatUidValue};
williamr@2
    40
williamr@2
    41
/** 
williamr@2
    42
Identifier for TFrameLayout type.
williamr@2
    43
 @see KIclImageFrameLayoutUidValue
williamr@2
    44
*/ 
williamr@2
    45
static const TUid KUidIclImageFrameLayout	= {KIclImageFrameLayoutUidValue};
williamr@2
    46
williamr@2
    47
williamr@2
    48
/* Format Uids */
williamr@2
    49
williamr@2
    50
/** 
williamr@2
    51
    TFrameFormat format code.
williamr@2
    52
    
williamr@2
    53
    Format Description:
williamr@2
    54
    YUV Monochrome image format.
williamr@2
    55
    Planar, 8 bit per pixel. 
williamr@2
    56
    Single Y plane for monochrome images.
williamr@2
    57
    Pixel order: Y00Y01..
williamr@2
    58
    @note greyscale values, 0=black, 255=white.
williamr@2
    59
williamr@2
    60
    Equivalent to ECam format code CCamera::EFormatMonochrome.
williamr@2
    61
    
williamr@2
    62
    Equivalent to Video FourCC code Y800, Y8.
williamr@2
    63
    
williamr@2
    64
    @see CCamera::TFormat
williamr@2
    65
    @see KFormatYUVMonochromeUidValue
williamr@2
    66
*/
williamr@2
    67
const TUid KUidFormatYUVMonochrome = {KFormatYUVMonochromeUidValue};
williamr@2
    68
williamr@2
    69
/** 
williamr@2
    70
    TFrameFormat format code.
williamr@2
    71
    
williamr@2
    72
    Format Description:
williamr@2
    73
    YUV 4:2:2 image format. 
williamr@2
    74
    Interleaved, 16 bits per pixel, 8 bits per sample.
williamr@2
    75
    Pixel order: UY0VY1.
williamr@2
    76
williamr@2
    77
    Equivalent to ECam format code CCamera::EFormatYUV422.
williamr@2
    78
    
williamr@2
    79
    Equivalent to Video FourCC code UYVY.
williamr@2
    80
    
williamr@2
    81
    @see CCamera::TFormat
williamr@2
    82
    @see KFormatYUV422InterleavedUidValue  
williamr@2
    83
*/
williamr@2
    84
const TUid KUidFormatYUV422Interleaved = {KFormatYUV422InterleavedUidValue};
williamr@2
    85
williamr@2
    86
/** 
williamr@2
    87
    TFrameFormat format code.
williamr@2
    88
    
williamr@2
    89
    Format Description:
williamr@2
    90
	YUV 4:2:0 image format.
williamr@2
    91
    Planar, 12 bits per pixel.
williamr@2
    92
    8 bit Y plane followed by 8 bit 2x2 subsampled U and V planes.
williamr@2
    93
    Pixel order: Y00Y01Y02Y03...U0...V0...
williamr@2
    94
    
williamr@2
    95
    Equivalent to ECam format code CCamera::EFormatYUV420Planar.
williamr@2
    96
    
williamr@2
    97
    Equivalent to Video FourCC code I420.
williamr@2
    98
    
williamr@2
    99
    @see CCamera::TFormat
williamr@2
   100
    @see KFormatYUV420PlanarUidValue  
williamr@2
   101
*/
williamr@2
   102
const TUid KUidFormatYUV420Planar 		= {KFormatYUV420PlanarUidValue};
williamr@2
   103
williamr@2
   104
/**     
williamr@2
   105
	TFrameFormat format code.
williamr@2
   106
	
williamr@2
   107
	Format Description:
williamr@2
   108
	YUV 4:2:0 image format.
williamr@2
   109
    Planar, 12 bits per pixel.
williamr@2
   110
    8 bit Y plane followed by 8 bit 2x2 subsampled V and U planes.
williamr@2
   111
    Pixel order: Y00Y01Y02Y03...V0...U0...
williamr@2
   112
    
williamr@2
   113
    No equivalent ECam format code.
williamr@2
   114
    
williamr@2
   115
    Equivalent to Video FourCC code YV12.
williamr@2
   116
    
williamr@2
   117
    @see CCamera::TFormat
williamr@2
   118
    @see KFormatYUV420InterleavedUidValue  
williamr@2
   119
*/
williamr@2
   120
const TUid KUidFormatYUV420PlanarReversed = {KFormatYUV420PlanarReversedUidValue};
williamr@2
   121
williamr@2
   122
/** 
williamr@2
   123
	TFrameFormat format code.
williamr@2
   124
	
williamr@2
   125
	Format Description:
williamr@2
   126
	RGB Packed image format. 
williamr@2
   127
    Interleaved in triplets, 12 bits per pixel.
williamr@2
   128
    Pixel order: BGR - 4 bits per pixel with red in the least significant bits
williamr@2
   129
    and the 4 most significant bits unused. 
williamr@2
   130
williamr@2
   131
    Equivalent to ECam format code CCamera::EFormat16bitRGB444.
williamr@2
   132
    
williamr@2
   133
    No equivalent Video FourCC code.
williamr@2
   134
    
williamr@2
   135
    @see CCamera::TFormat
williamr@2
   136
    @see KFormat16bitRGB444InterleavedUidValue      
williamr@2
   137
*/
williamr@2
   138
const TUid KUidFormat16bitRGB444Interleaved = {KFormat16bitRGB444InterleavedUidValue};
williamr@2
   139
williamr@2
   140
/** 
williamr@2
   141
	TFrameFormat format code.
williamr@2
   142
	
williamr@2
   143
	Format Description:
williamr@2
   144
	RGB Packed image format. 
williamr@2
   145
    Interleaved in triplets, 16 bits per pixel. 
williamr@2
   146
    Pixel order: BGR - 5 bits per pixel for red and blue and 6 bits for green,
williamr@2
   147
    with red in the least significant bits.
williamr@2
   148
	 
williamr@2
   149
    Equivalent to ECam format code  CCamera::EFormat16bitRGB565.
williamr@2
   150
    
williamr@2
   151
    No equivalent Video FourCC code.
williamr@2
   152
    
williamr@2
   153
    @see CCamera::TFormat     
williamr@2
   154
    @see KFormat16BitRGB565InterleavedUidValue      
williamr@2
   155
*/
williamr@2
   156
const TUid KUidFormat16BitRGB565Interleaved = {KFormat16BitRGB565InterleavedUidValue};
williamr@2
   157
williamr@2
   158
/** 
williamr@2
   159
	TFrameFormat format code.
williamr@2
   160
	
williamr@2
   161
	Format Description:
williamr@2
   162
	RGB Packed image format. 
williamr@2
   163
    Interleaved in triplets, 32 bits per pixel. 
williamr@2
   164
    Pixel order: BGR - 8 bits per pixel with red in the least significant bits
williamr@2
   165
    and the 8 most significant bits unused. 
williamr@2
   166
    
williamr@2
   167
    Equivalent to ECam format code CCamera::EFormat32BitRGB888.
williamr@2
   168
    
williamr@2
   169
    No equivalent Video FourCC code. 
williamr@2
   170
    
williamr@2
   171
    @see CCamera::TFormat 
williamr@2
   172
    @see KFormat32BitRGB888InterleavedUidValue          
williamr@2
   173
*/
williamr@2
   174
const TUid KUidFormat32BitRGB888Interleaved = {KFormat32BitRGB888InterleavedUidValue};
williamr@2
   175
williamr@2
   176
/** 
williamr@2
   177
	TFrameFormat format code.
williamr@2
   178
	
williamr@2
   179
	Format Description:
williamr@2
   180
	YUV 4:2:0 image format.
williamr@2
   181
    Interleaved, 12 bits per pixel. 
williamr@2
   182
    8 bit, 4 Y plane samples  followed by 2 8 bit U and V samples.
williamr@2
   183
    Pixel order: Y00Y01Y10Y11UV. 
williamr@2
   184
    
williamr@2
   185
    Equivalent to ECam format code 	CCamera::EFormatYUV420Interleaved.
williamr@2
   186
    
williamr@2
   187
    No equivalent Video FourCC code.  
williamr@2
   188
      
williamr@2
   189
    @see CCamera::TFormat
williamr@2
   190
    @see KFormatYUV420InterleavedUidValue    
williamr@2
   191
*/
williamr@2
   192
const TUid KUidFormatYUV420Interleaved 		= {KFormatYUV420InterleavedUidValue};
williamr@2
   193
williamr@2
   194
/** 
williamr@2
   195
	TFrameFormat format code.
williamr@2
   196
williamr@2
   197
	Format Description:
williamr@2
   198
	YUV 4:2:2 image format. 
williamr@2
   199
    Interleaved, 16 bits per pixel, 8 bits per sample.
williamr@2
   200
    Pixel order: Y1VY0U.
williamr@2
   201
williamr@2
   202
    Equivalent to ECam format code CCamera::EFormatYUV422Reversed.
williamr@2
   203
    
williamr@2
   204
    No equivalent Video FourCC code.
williamr@2
   205
    
williamr@2
   206
    @see CCamera::TFormat
williamr@2
   207
    @see KFormatYUV422InterleavedReversedUidValue
williamr@2
   208
*/
williamr@2
   209
const TUid KUidFormatYUV422InterleavedReversed = {KFormatYUV422InterleavedReversedUidValue};
williamr@2
   210
williamr@2
   211
/** 
williamr@2
   212
	TFrameFormat format code.
williamr@2
   213
williamr@2
   214
	Format Description:
williamr@2
   215
	YUV 4:2:2 image format. 
williamr@2
   216
    Interleaved, 16 bits per pixel, 8 bits per sample.
williamr@2
   217
    Pixel order: Y0Y1UV.
williamr@2
   218
williamr@2
   219
    No equivalent ECam format code.
williamr@2
   220
    
williamr@2
   221
    No equivalent Video FourCC code.
williamr@2
   222
    
williamr@2
   223
    @see CCamera::TFormat
williamr@2
   224
    @see KFormatYYUV422InterleavedUidValue
williamr@2
   225
*/
williamr@2
   226
const TUid KUidFormatYYUV422Interleaved = {KFormatYYUV422InterleavedUidValue};
williamr@2
   227
williamr@2
   228
/** 
williamr@2
   229
	TFrameFormat format code.
williamr@2
   230
williamr@2
   231
	Format Description:
williamr@2
   232
	YUV 4:2:2 image format. 
williamr@2
   233
    Planar, 16 bits per pixel, 8 bits per sample.
williamr@2
   234
    Pixel order: Y00Y01Y02Y03...U00U02...V00V02...
williamr@2
   235
williamr@2
   236
    No equivalent ECam format code.
williamr@2
   237
    
williamr@2
   238
    No equivalent Video FourCC code.
williamr@2
   239
    
williamr@2
   240
    @see CCamera::TFormat
williamr@2
   241
    @see KFormatYUV422PlanarUidValue
williamr@2
   242
*/
williamr@2
   243
const TUid KUidFormatYUV422Planar = {KFormatYUV422PlanarUidValue};
williamr@2
   244
williamr@2
   245
/** 
williamr@2
   246
	TFrameFormat format code.
williamr@2
   247
williamr@2
   248
	Format Description:
williamr@2
   249
	YUV 4:4:4 image format. 
williamr@2
   250
    Planar, 24 bits per pixel, 8 bits per sample.
williamr@2
   251
    Pixel order: Y00Y01Y02Y03...U00U01U02U03...V00V01V02V03...
williamr@2
   252
williamr@2
   253
    No equivalent ECam format code.
williamr@2
   254
    
williamr@2
   255
    No equivalent Video FourCC code.
williamr@2
   256
    
williamr@2
   257
    @see CCamera::TFormat
williamr@2
   258
    @see KFormatYUV444PlanarUidValue
williamr@2
   259
*/
williamr@2
   260
const TUid KUidFormatYUV444Planar = {KFormatYUV444PlanarUidValue};
williamr@2
   261
williamr@2
   262
/** 
williamr@2
   263
	TFrameFormat format code.
williamr@2
   264
	
williamr@2
   265
	Format Description:
williamr@2
   266
	YUV 4:4:4 image format.
williamr@2
   267
    Interleaved, 24 bit per pixel, 8 bits per sample.
williamr@2
   268
    Pixel order: Y00U00V00 Y01U01V01... 
williamr@2
   269
	
williamr@2
   270
    Equivalent to ECam format code CCamera::EFormatYUV444.
williamr@2
   271
    
williamr@2
   272
    No equivalent Video FourCC code. 
williamr@2
   273
    
williamr@2
   274
    @see CCamera::TFormat
williamr@2
   275
    @see KFormatYUV444InterleavedUidValue    
williamr@2
   276
*/
williamr@2
   277
const TUid KUidFormatYUV444Interleaved 		= {KFormatYUV444InterleavedUidValue};
williamr@2
   278
williamr@2
   279
/** 
williamr@2
   280
	TFrameFormat format code.
williamr@2
   281
	
williamr@2
   282
	Format Description:
williamr@2
   283
	YUV 4:2:0 image format.
williamr@2
   284
    Semiplanar, 12 bits per pixel, 8-bit per sample. 
williamr@2
   285
    Y plane followed by an interleaved U/V plane with 2x2 subsampling.
williamr@2
   286
    Pixel order: Y00Y01Y02Y03...U0V0...
williamr@2
   287
    
williamr@2
   288
    Equivalent to ECam format code 	CCamera::EFormatYUV420SemiPlanar.
williamr@2
   289
    
williamr@2
   290
    Equivalent to Video FourCC code 	NV12. 
williamr@2
   291
    
williamr@2
   292
    @see CCamera::TFormat    
williamr@2
   293
    @see KFormatYUV420SemiPlanarUidValue    
williamr@2
   294
*/
williamr@2
   295
const TUid KUidFormatYUV420SemiPlanar 		= {KFormatYUV420SemiPlanarUidValue};
williamr@2
   296
williamr@2
   297
williamr@2
   298
/* Colour spaces */
williamr@2
   299
williamr@2
   300
/** 
williamr@2
   301
TFrameFormat image frame color space for YCbCr.
williamr@2
   302
 @see KColourSpaceYCbCrUidValue
williamr@2
   303
*/
williamr@2
   304
const TUid KUidColourSpaceYCbCr = {KColourSpaceYCbCrUidValue};
williamr@2
   305
williamr@2
   306
/** 
williamr@2
   307
TFrameFormat image frame color space for YUV.
williamr@2
   308
 @see KColourSpaceYUVUidValue
williamr@2
   309
*/
williamr@2
   310
const TUid KUidColourSpaceYUV = {KColourSpaceYUVUidValue};
williamr@2
   311
williamr@2
   312
/** 
williamr@2
   313
TFrameFormat image frame color space for RGB.
williamr@2
   314
 @see KColourSpaceRGBUidValue
williamr@2
   315
*/
williamr@2
   316
const TUid KUidColourSpaceRGB = {KColourSpaceRGBUidValue};
williamr@2
   317
williamr@2
   318
williamr@2
   319
/* Sampling */
williamr@2
   320
williamr@2
   321
/** 
williamr@2
   322
TFrameFormat frame sampling for monochrome image data.
williamr@2
   323
 @see KSamplingMonochromeUidValue
williamr@2
   324
*/
williamr@2
   325
const TUid KUidSamplingMonochrome = {KSamplingMonochromeUidValue};
williamr@2
   326
williamr@2
   327
/** 
williamr@2
   328
TFrameFormat frame sampling for YUV444 image data.
williamr@2
   329
 @see KSamplingColor444UidValue
williamr@2
   330
*/
williamr@2
   331
const TUid KUidSamplingColor444 = {KSamplingColor444UidValue};
williamr@2
   332
williamr@2
   333
/** 
williamr@2
   334
TFrameFormat frame sampling for YUV422 image data.
williamr@2
   335
 @see KSamplingColor422UidValue
williamr@2
   336
*/
williamr@2
   337
const TUid KUidSamplingColor422 = {KSamplingColor422UidValue};
williamr@2
   338
williamr@2
   339
/** 
williamr@2
   340
TFrameFormat frame sampling for YUV420 image data.
williamr@2
   341
 @see KSamplingColor420UidValue
williamr@2
   342
*/
williamr@2
   343
const TUid KUidSamplingColor420 = {KSamplingColor420UidValue};
williamr@2
   344
williamr@2
   345
/** 
williamr@2
   346
TFrameFormat frame sampling for YUV411 image data.
williamr@2
   347
 @see KSamplingColor411UidValue
williamr@2
   348
*/
williamr@2
   349
const TUid KUidSamplingColor411 = {KSamplingColor411UidValue};
williamr@2
   350
williamr@2
   351
williamr@2
   352
/** 
williamr@2
   353
Specific JPEG ImageFrame Decoder/Encoder option for the ConvertFrame API.
williamr@2
   354
 @see KOptionConvertFrameUidValue
williamr@2
   355
*/
williamr@2
   356
const TUid KUidOptionConvertFrame = {KOptionConvertFrameUidValue};
williamr@2
   357
williamr@2
   358
/** 
williamr@2
   359
Specific JPEG ImageFrame Decoder option for the RecommendBufferSize API.
williamr@2
   360
This option allows the client of the decoder to obtain the recommended size for a ImageFrame 
williamr@2
   361
and allocate memory accordingly.
williamr@2
   362
 @see KRecommendBufferSizeUidValue
williamr@2
   363
*/
williamr@2
   364
const TUid KUidOptionRecommendBufferSize = {KOptionRecommendBufferSizeUidValue};
williamr@2
   365
williamr@2
   366
#endif // IMAGEFRAMECONST_H