epoc32/include/faxdefn.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
child 4 837f303aceeb
equal deleted inserted replaced
1:666f914201fb 2:2fe1408b6811
     1 faxdefn.h
     1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     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
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 // FaxDefn Header
       
    15 // 
       
    16 //
       
    17 
       
    18 
       
    19 
       
    20 /**
       
    21  @file
       
    22  @publishedAll
       
    23  @released
       
    24 */
       
    25 
       
    26 #ifndef __FAXDEFN_H
       
    27 #define	__FAXDEFN_H
       
    28 
       
    29 #include <e32std.h>
       
    30 
       
    31 //
       
    32 // Fax class definition
       
    33 //
       
    34 /** Defines the fax modem classes supported by the fax client.
       
    35 
       
    36 The fax class refers to the command set used to control the modem. 
       
    37 
       
    38 @publishedAll
       
    39 @released
       
    40 */
       
    41 enum TFaxClass
       
    42 	{
       
    43 	/** Automatic detection of the fax modem class. */
       
    44 	EClassAuto=0,
       
    45 	/** Fax class 1 */
       
    46 	EClass1=1,
       
    47 	/** Fax class 2 */
       
    48 	EClass2=2,
       
    49 	/** Fax class 2.0 */
       
    50 	EClass2point0=4,
       
    51 	/** Fax class 1.0 */
       
    52 	EClass1point0=8,
       
    53 	/** Fax class 2.1 */
       
    54 	EClass2point1=16
       
    55 	};
       
    56 
       
    57 //
       
    58 // Fax phase definition
       
    59 //
       
    60 /** Fax session phases.
       
    61 
       
    62 Defines what is done if a fax session fails is dependent on the current phase. 
       
    63 @publishedAll
       
    64 @released
       
    65 */
       
    66 enum TFaxPhase
       
    67 	{
       
    68 	/** The session has not yet begun */
       
    69 	ENotYetStarted,
       
    70 	/** Phase 'A'. Establishing connection. */
       
    71 	ECallEstablishment='A',
       
    72 	/** Phase 'B'. Negotiating fax protocols. */
       
    73 	ESessionNegotiation='B',
       
    74 	/** Phase 'C'. Transferring information */
       
    75 	EDataTransfer='C',
       
    76 	/** Phase 'D'. Confirming successful send/receive. */
       
    77 	EPostPageStatus='D',
       
    78 	/** Phase 'E'. Disconnecting. */
       
    79 	EDisconnection='E'
       
    80 	};
       
    81 
       
    82 //
       
    83 // Fax resolution definition
       
    84 //
       
    85 /** Defines the supported fax resolutions. 
       
    86 
       
    87 It is also used by the fax store classes. 
       
    88 
       
    89 @publishedAll
       
    90 @released
       
    91 */
       
    92 enum TFaxResolution
       
    93 	{
       
    94 	/** Normal fax resolution 3.85 lines/mm */
       
    95 	EFaxNormal,
       
    96 	/** Fine fax resolution 7.7 lines/mm */
       
    97 	EFaxFine
       
    98 	};
       
    99 
       
   100 //
       
   101 // Fax compression definition
       
   102 //
       
   103 /** Defines the types of compression supported by the fax client.
       
   104 
       
   105 This enumeration is also used by the fax store classes. 
       
   106 
       
   107 @publishedAll
       
   108 @released
       
   109 */
       
   110 enum TFaxCompression
       
   111 	{
       
   112 	/** One-dimensional T.4 encoding. Also known as MH. */
       
   113 	EModifiedHuffman=0,
       
   114 	/** Two-dimensional T.4 encoding. Also known as MR. */
       
   115 	EModifiedRead=1,
       
   116 	/** Two-dimensional T.4 encoding including uncompressed mode. */
       
   117 	EUncompressedModifiedRead=2,
       
   118 	/** T.6 encoding. Not supported by the fax engine. Also known as MMR. */
       
   119 	EModifiedModifiedRead=3
       
   120 	};
       
   121 
       
   122 /**
       
   123 Scan Line Constants
       
   124 @publishedAll
       
   125 @released
       
   126 */
       
   127 const TInt KFaxPixelsPerScanLine(1728);
       
   128 const TInt KFaxBytesPerScanLine(216);	
       
   129 
       
   130 const TInt KFaxCmPerScanLine(215);
       
   131 const TInt KFaxScanLinesPer10Cm(385);
       
   132 const TInt KFaxFineScanLinesPer10Cm(770);
       
   133 const TInt KFaxT4MaxDesLength(896);
       
   134 const TInt KFaxLinesPerBand(64);
       
   135 
       
   136 /** Defines a buffer to hold a fax sender ID. */
       
   137 typedef TBuf<20> TFaxBufSenderId;
       
   138 /** Defines a raw scan line. 
       
   139 
       
   140 Each scan line is comprised of KFaxBytesPerScanLine (216) bytes. */
       
   141 typedef TBuf8 < KFaxBytesPerScanLine > TRawScanLine;
       
   142 
       
   143 /**
       
   144 Reverse Byte Lookup Table
       
   145 @internalComponent
       
   146 */
       
   147 const TUint8 KReverseByte [256] =
       
   148    {
       
   149    0x00,0x80,0x40,0xC0,0x20,0xA0,0x60,0xE0,0x10,0x90,0x50,0xD0,0x30,0xB0,0x70,0xF0,
       
   150    0x08,0x88,0x48,0xC8,0x28,0xA8,0x68,0xE8,0x18,0x98,0x58,0xD8,0x38,0xB8,0x78,0xF8,
       
   151    0x04,0x84,0x44,0xC4,0x24,0xA4,0x64,0xE4,0x14,0x94,0x54,0xD4,0x34,0xB4,0x74,0xF4,
       
   152    0x0C,0x8C,0x4C,0xCC,0x2C,0xAC,0x6C,0xEC,0x1C,0x9C,0x5C,0xDC,0x3C,0xBC,0x7C,0xFC,
       
   153    0x02,0x82,0x42,0xC2,0x22,0xA2,0x62,0xE2,0x12,0x92,0x52,0xD2,0x32,0xB2,0x72,0xF2,
       
   154    0x0A,0x8A,0x4A,0xCA,0x2A,0xAA,0x6A,0xEA,0x1A,0x9A,0x5A,0xDA,0x3A,0xBA,0x7A,0xFA,
       
   155    0x06,0x86,0x46,0xC6,0x26,0xA6,0x66,0xE6,0x16,0x96,0x56,0xD6,0x36,0xB6,0x76,0xF6,
       
   156    0x0E,0x8E,0x4E,0xCE,0x2E,0xAE,0x6E,0xEE,0x1E,0x9E,0x5E,0xDE,0x3E,0xBE,0x7E,0xFE,
       
   157    0x01,0x81,0x41,0xC1,0x21,0xA1,0x61,0xE1,0x11,0x91,0x51,0xD1,0x31,0xB1,0x71,0xF1,
       
   158    0x09,0x89,0x49,0xC9,0x29,0xA9,0x69,0xE9,0x19,0x99,0x59,0xD9,0x39,0xB9,0x79,0xF9,
       
   159    0x05,0x85,0x45,0xC5,0x25,0xA5,0x65,0xE5,0x15,0x95,0x55,0xD5,0x35,0xB5,0x75,0xF5,
       
   160    0x0D,0x8D,0x4D,0xCD,0x2D,0xAD,0x6D,0xED,0x1D,0x9D,0x5D,0xDD,0x3D,0xBD,0x7D,0xFD,
       
   161    0x03,0x83,0x43,0xC3,0x23,0xA3,0x63,0xE3,0x13,0x93,0x53,0xD3,0x33,0xB3,0x73,0xF3,
       
   162    0x0B,0x8B,0x4B,0xCB,0x2B,0xAB,0x6B,0xEB,0x1B,0x9B,0x5B,0xDB,0x3B,0xBB,0x7B,0xFB,
       
   163    0x07,0x87,0x47,0xC7,0x27,0xA7,0x67,0xE7,0x17,0x97,0x57,0xD7,0x37,0xB7,0x77,0xF7,
       
   164    0x0F,0x8F,0x4F,0xCF,0x2F,0xAF,0x6F,0xEF,0x1F,0x9F,0x5F,0xDF,0x3F,0xBF,0x7F,0xFF
       
   165    } ;
       
   166 
       
   167 #endif