1 /***************************************************************************
2 * Copyright (c) 2024 Microsoft Corporation
3 *
4 * This program and the accompanying materials are made available under the
5 * terms of the MIT License which is available at
6 * https://opensource.org/licenses/MIT.
7 *
8 * SPDX-License-Identifier: MIT
9 **************************************************************************/
10
11
12 /**************************************************************************/
13 /**************************************************************************/
14 /** */
15 /** GUIX Component */
16 /** */
17 /** Utility (Utility) */
18 /** */
19 /**************************************************************************/
20
21 #define GX_SOURCE_CODE
22
23
24 /* Include necessary system files. */
25
26 #include "gx_api.h"
27 #include "gx_utility.h"
28 /* define the the table of sin values for one quadrant,
29 angle value is enlarged by 4, sine value is enlarged by 256.*/
30 static GX_CONST GX_UBYTE sin_value_table[360] = {
31 0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
32 0x10, 0x11, 0x12, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1e, 0x1f, 0x20,
33 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f, 0x30,
34 0x31, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3f, 0x40, 0x41,
35 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4e, 0x4f, 0x50, 0x51,
36 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f, 0x60,
37 0x61, 0x62, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70,
38 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
39 0x80, 0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d,
40 0x8e, 0x8f, 0x90, 0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9a,
41 0x9b, 0x9c, 0x9d, 0x9e, 0x9f, 0xa0, 0xa1, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa7,
42 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xac, 0xad, 0xae, 0xaf, 0xb0, 0xb1, 0xb1, 0xb2, 0xb3, 0xb4,
43 0xb5, 0xb5, 0xb6, 0xb7, 0xb8, 0xb8, 0xb9, 0xba, 0xbb, 0xbb, 0xbc, 0xbd, 0xbe, 0xbe, 0xbf,
44 0xc0, 0xc1, 0xc1, 0xc2, 0xc3, 0xc4, 0xc4, 0xc5, 0xc6, 0xc6, 0xc7, 0xc8, 0xc9, 0xc9, 0xca,
45 0xcb, 0xcb, 0xcc, 0xcd, 0xcd, 0xce, 0xcf, 0xcf, 0xd0, 0xd1, 0xd1, 0xd2, 0xd2, 0xd3, 0xd4,
46 0xd4, 0xd5, 0xd6, 0xd6, 0xd7, 0xd7, 0xd8, 0xd9, 0xd9, 0xda, 0xda, 0xdb, 0xdc, 0xdc, 0xdd,
47 0xdd, 0xde, 0xde, 0xdf, 0xdf, 0xe0, 0xe0, 0xe1, 0xe2, 0xe2, 0xe3, 0xe3, 0xe4, 0xe4, 0xe5,
48 0xe5, 0xe6, 0xe6, 0xe7, 0xe7, 0xe8, 0xe8, 0xe8, 0xe9, 0xe9, 0xea, 0xea, 0xeb, 0xeb, 0xec,
49 0xec, 0xec, 0xed, 0xed, 0xee, 0xee, 0xee, 0xef, 0xef, 0xf0, 0xf0, 0xf0, 0xf1, 0xf1, 0xf2,
50 0xf2, 0xf2, 0xf3, 0xf3, 0xf3, 0xf4, 0xf4, 0xf4, 0xf5, 0xf5, 0xf5, 0xf6, 0xf6, 0xf6, 0xf6,
51 0xf7, 0xf7, 0xf7, 0xf8, 0xf8, 0xf8, 0xf8, 0xf9, 0xf9, 0xf9, 0xf9, 0xfa, 0xfa, 0xfa, 0xfa,
52 0xfb, 0xfb, 0xfb, 0xfb, 0xfb, 0xfc, 0xfc, 0xfc, 0xfc, 0xfc, 0xfd, 0xfd, 0xfd, 0xfd, 0xfd,
53 0xfd, 0xfd, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xfe, 0xff, 0xff, 0xff, 0xff, 0xff,
54 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff, 0xff
55 };
56
57
58 /**************************************************************************/
59 /* */
60 /* FUNCTION RELEASE */
61 /* */
62 /* _gx_utility_math_sin_5_4_0 PORTABLE C */
63 /* 6.1 */
64 /* AUTHOR */
65 /* */
66 /* Kenneth Maxwell, Microsoft Corporation */
67 /* */
68 /* DESCRIPTION */
69 /* */
70 /* This service computes the sine of the supplied angl, which is an */
71 /* old version of _gx_utility_math_sin. */
72 /* */
73 /* INPUT */
74 /* */
75 /* angle Angle to compute sine of, */
76 /* the input angle should be */
77 /* scaled by 256. */
78 /* */
79 /* OUTPUT */
80 /* */
81 /* sine Sine of supplied angle */
82 /* */
83 /* CALLS */
84 /* */
85 /* None */
86 /* */
87 /* CALLED BY */
88 /* */
89 /* Application Code */
90 /* */
91 /* RELEASE HISTORY */
92 /* */
93 /* DATE NAME DESCRIPTION */
94 /* */
95 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
96 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
97 /* resulting in version 6.1 */
98 /* */
99 /**************************************************************************/
100 #if defined(GUIX_5_4_0_COMPATIBILITY)
_gx_utility_math_sin_5_4_0(INT angle)101 INT _gx_utility_math_sin_5_4_0(INT angle)
102 {
103 INT y_sign;
104 INT sine;
105
106 /* normalize the incoming angle */
107 while (angle < 0)
108 {
109 angle += (256 * 360);
110 }
111 while (angle > (256 * 360))
112 {
113 angle -= (256 * 360);
114 }
115
116 if ((angle >= 0) && (angle <= 23040))
117 {
118 y_sign = 1;
119 }
120 else if ((angle > 23040) && (angle <= 46080))
121 {
122 angle = 46080 - angle;
123 y_sign = 1;
124 }
125 else if ((angle > 46080) && (angle <= 69120))
126 {
127 angle -= 46080;
128 y_sign = -1;
129 }
130 else
131 {
132 angle = 92160 - angle;
133 y_sign = -1;
134 }
135
136 angle = (angle + 32) >> 6;
137
138 if (angle == 360)
139 {
140 sine = 256 * y_sign;
141 }
142 else
143 {
144 sine = sin_value_table[angle] * y_sign;
145 }
146 return sine;
147 }
148 #endif
149
150 /**************************************************************************/
151 /* */
152 /* FUNCTION RELEASE */
153 /* */
154 /* _gx_utility_math_sin PORTABLE C */
155 /* 6.1 */
156 /* AUTHOR */
157 /* */
158 /* Kenneth Maxwell, Microsoft Corporation */
159 /* */
160 /* DESCRIPTION */
161 /* */
162 /* This service computes the sine of the supplied angle. */
163 /* */
164 /* INPUT */
165 /* */
166 /* angle Angle to compute sine of. */
167 /* The input angle is a fixed */
168 /* point data type, call */
169 /* GX_FIXED_VAL_MAKE to covnert */
170 /* from INT to fixed point data. */
171 /* type. */
172 /* */
173 /* OUTPUT */
174 /* */
175 /* sine Sine of supplied angle. */
176 /* The return sin is a fixed */
177 /* point math data type, call */
178 /* GX_FIXED_VAL_TO_INT to convert*/
179 /* from fixed point data type to */
180 /* int. */
181 /* */
182 /* CALLS */
183 /* */
184 /* None */
185 /* */
186 /* CALLED BY */
187 /* */
188 /* Application Code */
189 /* */
190 /* RELEASE HISTORY */
191 /* */
192 /* DATE NAME DESCRIPTION */
193 /* */
194 /* 05-19-2020 Kenneth Maxwell Initial Version 6.0 */
195 /* 09-30-2020 Kenneth Maxwell Modified comment(s), */
196 /* resulting in version 6.1 */
197 /* */
198 /**************************************************************************/
_gx_utility_math_sin(GX_FIXED_VAL angle)199 GX_FIXED_VAL _gx_utility_math_sin(GX_FIXED_VAL angle)
200 {
201 INT y_sign;
202 INT sine;
203
204 /* normalize the incoming angle */
205 while (angle < 0)
206 {
207 angle += GX_FIXED_VAL_MAKE(360);
208 }
209 while (angle > GX_FIXED_VAL_MAKE(360))
210 {
211 angle -= GX_FIXED_VAL_MAKE(360);
212 }
213
214 if (angle <= GX_FIXED_VAL_MAKE(90))
215 {
216 y_sign = 1;
217 }
218 else if (angle <= GX_FIXED_VAL_MAKE(180))
219 {
220 angle = GX_FIXED_VAL_MAKE(180) - angle;
221 y_sign = 1;
222 }
223 else if (angle <= GX_FIXED_VAL_MAKE(270))
224 {
225 angle -= GX_FIXED_VAL_MAKE(180);
226 y_sign = -1;
227 }
228 else
229 {
230 angle = GX_FIXED_VAL_MAKE(360) - angle;
231 y_sign = -1;
232 }
233
234 angle = angle + (GX_FIXED_VAL_HALF >> 2);
235 angle = GX_FIXED_VAL_TO_INT(angle << 2);
236
237 if (angle == 360)
238 {
239 sine = GX_FIXED_VAL_MAKE(y_sign);
240 }
241 else
242 {
243 sine = GX_FIXED_VAL_MAKE(sin_value_table[angle] * y_sign) >> 8;
244 }
245 return sine;
246 }
247
248