blob: c64f0887bfda02a802993972ce8bfd6e20dab5d1 [file] [log] [blame]
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +00001#
2# cl.h - Compression Library typedefs and prototypes
3#
4# 02/18/92 Original Version by Brian Knittel
5#
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +00006
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +00007#
8# originalFormat parameter values
9#
10MAX_NUMBER_OF_ORIGINAL_FORMATS = (32)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +000011
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +000012# Audio
13MONO = (0)
14STEREO_INTERLEAVED = (1)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +000015
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +000016# Video
17# YUV is defined to be the same thing as YCrCb (luma and two chroma components).
18# 422 is appended to YUV (or YCrCb) if the chroma is sub-sampled by 2
19# horizontally, packed as U Y1 V Y2 (byte order).
20# 422HC is appended to YUV (or YCrCb) if the chroma is sub-sampled by 2
21# vertically in addition to horizontally, and is packed the same as
22# 422 except that U & V are not valid on the second line.
23#
24RGB = (0)
25RGBX = (1)
26RGBA = (2)
27RGB332 = (3)
28
29GRAYSCALE = (4)
30Y = (4)
31YUV = (5)
32YCbCr = (5)
33YUV422 = (6) # 4:2:2 sampling
34YCbCr422 = (6) # 4:2:2 sampling
35YUV422HC = (7) # 4:1:1 sampling
36YCbCr422HC = (7) # 4:1:1 sampling
37
38MAX_NUMBER_OF_AUDIO_ALGORITHMS = (32)
39MAX_NUMBER_OF_VIDEO_ALGORITHMS = (32)
40
41#
42# "compressionScheme" argument values
43#
44UNCOMPRESSED_AUDIO = (0)
45G711_ULAW = (1)
46ULAW = (1)
47G711_ALAW = (2)
48ALAW = (2)
49G722 = (3)
50
51UNCOMPRESSED = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 0)
52UNCOMPRESSED_VIDEO = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 0)
53RLE = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 1)
54JPEG = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 2)
55MPEG_VIDEO = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 3)
56MVC1 = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 4)
57RTR = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 5)
58RTR1 = (MAX_NUMBER_OF_AUDIO_ALGORITHMS + 5)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +000059
60#
61# Parameters
62#
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +000063MAX_NUMBER_OF_PARAMS = (256)
64# Default Parameters
65IMAGE_WIDTH = (0)
66IMAGE_HEIGHT = (1)
67ORIGINAL_FORMAT = (2)
68INTERNAL_FORMAT = (3)
69COMPONENTS = (4)
70BITS_PER_COMPONENT = (5)
71FRAME_RATE = (6)
72COMPRESSION_RATIO = (7)
73EXACT_COMPRESSION_RATIO = (8)
74FRAME_BUFFER_SIZE = (9)
75COMPRESSED_BUFFER_SIZE = (10)
76BLOCK_SIZE = (11)
77PREROLL = (12)
78UNIQUE = (13)
79FRAME_TYPE = (14)
80OVERWRITE_MODE = (15)
81NUMBER_OF_PARAMS = (16)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +000082
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +000083# JPEG Specific Parameters
84QUALITY_FACTOR = (NUMBER_OF_PARAMS + 0)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +000085
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +000086# MPEG Specific Parameters
87SPEED = (NUMBER_OF_PARAMS + 0)
88ACTUAL_FRAME_INDEX = (NUMBER_OF_PARAMS + 1)
89
90# RTR Specific Parameters
91QUALITY_LEVEL = (NUMBER_OF_PARAMS + 0)
92
93# #define clTypeIsFloat(v) (*(float *)&(v))
94# #define clTypeIsLong(v) (*(long *)&(v))
95#
96# RATIO_1 = (65536.0)
97# #define clFloatToRatio(f) ((long)((float)(f) * RATIO_1))
98# #define clRatioToFloat(f) ((float)(f) / RATIO_1)
99# RATIO_SHIFT = (16)
100# #define clRatioMul(m, r) ((m) * (r))
101# #define clRatioToLong(r) ((r) >> RATIO_SHIFT)
102# #define clLongToRatio(r) ((r) << RATIO_SHIFT)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +0000103
104#
105# Parameter value types
106#
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +0000107ENUM_VALUE = (0) # only certain constant values are valid
108RANGE_VALUE = (1) # any value in a given range is valid
109FLOATING_ENUM_VALUE = (2) # only certain constant floating point values are valid
110FLOATING_RANGE_VALUE = (3) # any value in a given floating point range is valid
111POINTER = (4) # any legal pointer is valid
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +0000112
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +0000113#
114# Algorithm types
115#
116AUDIO = (0)
117VIDEO = (1)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +0000118
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +0000119#
120# Algorithm Functionality
121#
122DECOMPRESSOR = (1)
123COMPRESSOR = (2)
124CODEC = (3)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +0000125
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +0000126#
127# Buffer types
128#
129NONE = (0)
130FRAME = (1)
131DATA = (2)
Sjoerd Mullendere7daaa31992-09-24 10:40:03 +0000132
133#
134# error codes
135#
Sjoerd Mullender4fff13f1992-12-14 13:16:55 +0000136BAD_NOT_IMPLEMENTED = ( -1) # not impimented yet
137BAD_NO_BUFFERSPACE = ( -2) # no space for internal buffers
138BAD_BUFFER_NULL = ( -3) # null buffer pointer
139BAD_COUNT_NEG = ( -4) # negative count
140BAD_PVBUFFER = ( -5) # param/val buffer doesn't make sense
141BAD_BUFFERLENGTH_NEG = ( -6) # negative buffer length
142BAD_BUFFERLENGTH_ODD = ( -7) # odd length parameter/value buffer
143BAD_PARAM = ( -8) # invalid parameter
144BAD_COMPRESSION_SCHEME = ( -9) # compression scheme parameter invalid
145BAD_COMPRESSOR_HANDLE = (-10) # compression handle parameter invalid
146BAD_COMPRESSOR_HANDLE_POINTER = (-11) # compression handle pointer invalid
147BAD_BUFFER_HANDLE = (-12) # callback function invalid
148BAD_ALGORITHM_INFO = (-13) # algorithm info invalid
149BAD_CL_BAD_WIDTH_OR_HEIGHT = (-14) # compressor width or height invalid
150BAD_POINTER_FROM_CALLBACK_FUNCTION = (-15) # pointer from callback invalid
151JPEG_ERROR = (-16) # error from libjpeg
152NO_SEMAPHORE = (-17) # could not get semaphore
153BAD_WIDTH_OR_HEIGHT = (-18) # width or height invalid
154BAD_FRAME_COUNT = (-19) # frame count invalid
155BAD_FRAME_INDEX = (-20) # frame index invalid
156BAD_FRAME_BUFFER = (-21) # frame buffer pointer invalid
157BAD_FRAME_SIZE = (-22) # frame size invalid
158BAD_DATA_BUFFER = (-23) # data buffer pointer invalid
159BAD_DATA_SIZE = (-24) # data buffer size invalid
160BAD_TOTAL_NUMBER_OF_FRAMES = (-25) # total number of frames invalid
161BAD_IMAGE_FORMAT = (-26) # image format invalid
162BAD_BITS_PER_COMPONENT = (-27) # bits per component invalid
163BAD_FRAME_RATE = (-28) # frame rate invalid
164BAD_INSUFFICIENT_DATA_FROM_CALLBACK_FUNCTION = (-29) # insufficient data from callback invalid
165PARAM_OUT_OF_RANGE = (-30) # parameter out of range
166ADDED_ALGORITHM_ERROR = (-31) # added algorithm had a unique error
167BAD_ALGORITHM_TYPE = (-32) # bad algorithm type
168BAD_ALGORITHM_NAME = (-33) # bad algorithm name
169BAD_FRAME_INDEXING = (-34) # bad frame indexing
170BAD_BUFFERING = (-35) # bad buffering calls
171BUFFER_NOT_CREATED = (-36) # buffer not created
172BAD_BUFFER_EXISTS = (-37) # buffer already created