1 /*
2  * Copyright (c) 2022-2023 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  *     http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 
16 #ifndef NAPI_UTILS_H
17 #define NAPI_UTILS_H
18 
19 #include <chrono>
20 
21 #include <cstdint>
22 #include <map>
23 #include <list>
24 #include "napi/native_api.h"
25 #include "napi/native_common.h"
26 #include "napi/native_node_api.h"
27 #include "napi_avcast_picker_helper.h"
28 #include "avsession_log.h"
29 #include "audio_system_manager.h"
30 #include "avsession_info.h"
31 #include "want_agent.h"
32 #include "napi_base_context.h"
33 #include "ability.h"
34 #include "media_info_holder.h"
35 #include "media_info.h"
36 #include "av_file_descriptor.h"
37 #include "avqueue_info.h"
38 
39 /* check condition related to argc/argv, return and logging. */
40 #define CHECK_ARGS_RETURN_VOID(context, condition, message, code)               \
41     do {                                                               \
42         if (!(condition)) {                                            \
43             (context)->status = napi_invalid_arg;                         \
44             (context)->errMessage = std::string(message);                      \
45             (context)->errCode = code;                      \
46             SLOGE("test (" #condition ") failed: " message);           \
47             return;                                                    \
48         }                                                              \
49     } while (0)
50 
51 #define CHECK_STATUS_RETURN_VOID(context, message, code)                        \
52     do {                                                               \
53         if ((context)->status != napi_ok) {                               \
54             (context)->errMessage = std::string(message);                      \
55             (context)->errCode = code;                      \
56             SLOGE("test (context->status == napi_ok) failed: " message);  \
57             return;                                                    \
58         }                                                              \
59     } while (0)
60 
61 /* check condition, return and logging if condition not true. */
62 #define CHECK_RETURN(condition, message, retVal)             \
63     do {                                                     \
64         if (!(condition)) {                                  \
65             SLOGE("test (" #condition ") failed: " message); \
66             return retVal;                                   \
67         }                                                    \
68     } while (0)
69 
70 #define CHECK_RETURN_VOID(condition, message)                \
71     do {                                                     \
72         if (!(condition)) {                                  \
73             SLOGE("test (" #condition ") failed: " message); \
74             return;                                          \
75         }                                                    \
76     } while (0)
77 
78 namespace OHOS::AVSession {
79 class NapiUtils {
80 public:
81     static int32_t ConvertSessionType(const std::string& typeString);
82     static std::string ConvertSessionType(int32_t type);
83 
84     /* napi_value <-> bool */
85     static napi_status GetValue(napi_env env, napi_value in, bool& out);
86     static napi_status SetValue(napi_env env, const bool& in, napi_value& out);
87 
88     /* napi_value <-> int32_t */
89     static napi_status GetValue(napi_env env, napi_value in, int32_t& out);
90     static napi_status SetValue(napi_env env, const int32_t& in, napi_value& out);
91 
92     /* napi_value <-> uint32_t */
93     static napi_status GetValue(napi_env env, napi_value in, uint32_t& out);
94     static napi_status SetValue(napi_env env, const uint32_t& in, napi_value& out);
95 
96     /* napi_value <-> int64_t */
97     static napi_status GetValue(napi_env env, napi_value in, int64_t& out);
98     static napi_status SetValue(napi_env env, const int64_t& in, napi_value& out);
99 
100     /* napi_value <-> double */
101     static napi_status GetValue(napi_env env, napi_value in, double& out);
102     static napi_status SetValue(napi_env env, const double& in, napi_value& out);
103 
104     /* napi_value <-> std::string */
105     static napi_status GetValue(napi_env env, napi_value in, std::string& out);
106     static napi_status SetValue(napi_env env, const std::string& in, napi_value& out);
107 
108     /* napi_value <-> AppExecFwk::ElementName */
109     static napi_status SetValue(napi_env env, const AppExecFwk::ElementName& in, napi_value& out);
110 
111     /* napi_value <-> AVSessionDescriptor */
112     static napi_status SetValue(napi_env env, const AVSessionDescriptor& in, napi_value& out);
113 
114     /* napi_value <-> MMI::KeyEvent::KeyItem */
115     static napi_status GetValue(napi_env env, napi_value in, MMI::KeyEvent::KeyItem& out);
116     static napi_status SetValue(napi_env env, const std::optional<MMI::KeyEvent::KeyItem> in, napi_value& out);
117 
118     /* napi_value <-> MMI::KeyEvent */
119     static napi_status GetValue(napi_env env, napi_value in, std::shared_ptr<MMI::KeyEvent>& out);
120     static napi_status SetValue(napi_env env, const std::shared_ptr<MMI::KeyEvent>& in, napi_value& out);
121 
122     /* napi_value <-> AbilityRuntime::WantAgent::WantAgent */
123     static napi_status GetValue(napi_env env, napi_value in, AbilityRuntime::WantAgent::WantAgent*& out);
124     static napi_status SetValue(napi_env env, AbilityRuntime::WantAgent::WantAgent& in, napi_value& out);
125 
126     /* napi_value <-> AAFwk::WantParams */
127     static napi_status GetValue(napi_env env, napi_value in, AAFwk::WantParams& out);
128     static napi_status SetValue(napi_env env, const AAFwk::WantParams& in, napi_value& out);
129 
130     /* napi_value <-> AVCallMetaData */
131     static napi_status GetValue(napi_env env, napi_value in, AVCallMetaData& out);
132     static napi_status SetValue(napi_env env, const AVCallMetaData& in, napi_value& out);
133 
134     /* napi_value <-> AVCallState */
135     static napi_status GetValue(napi_env env, napi_value in, AVCallState& out);
136     static napi_status SetValue(napi_env env, const AVCallState& in, napi_value& out);
137 
138     /* napi_value <-> AVMetaData */
139     static napi_status GetValue(napi_env env, napi_value in, AVMetaData& out);
140     static napi_status SetValue(napi_env env, const AVMetaData& in, napi_value& out);
141 
142     /* napi_value <-> AVMediaDescription */
143     static napi_status GetValue(napi_env env, napi_value in, AVMediaDescription& out);
144     static napi_status SetValue(napi_env env, const AVMediaDescription& in, napi_value& out);
145 
146     /* napi_value <-> AVQueueItem */
147     static napi_status GetValue(napi_env env, napi_value in, AVQueueItem& out);
148     static napi_status SetValue(napi_env env, const AVQueueItem& in, napi_value& out);
149 
150     /* napi_value <-> std::vector<AVQueueItem> */
151     static napi_status GetValue(napi_env env, napi_value in, std::vector<AVQueueItem>& out);
152     static napi_status SetValue(napi_env env, const std::vector<AVQueueItem>& in, napi_value& out);
153 
154     /* napi_value <-> AVPlaybackState */
155     static napi_status GetValue(napi_env env, napi_value in, AVPlaybackState& out);
156     static napi_status SetValue(napi_env env, const AVPlaybackState& in, napi_value& out);
157 
158     /* napi_value <-> AVCastPlayerState */
159     static napi_status GetValue(napi_env env, napi_value in, AVCastPlayerState& out);
160     static napi_status SetValue(napi_env env, const AVCastPlayerState& in, napi_value& out);
161 
162     /* napi_value <-> std::vector<std::string> */
163     static napi_status GetValue(napi_env env, napi_value in, std::vector<std::string>& out);
164     static napi_status SetValue(napi_env env, const std::vector<std::string>& in, napi_value& out);
165 
166     /* napi_value <-> std::vector<uint8_t> */
167     static napi_status GetValue(napi_env env, napi_value in, std::vector<uint8_t>& out);
168     static napi_status SetValue(napi_env env, const std::vector<uint8_t>& in, napi_value& out);
169 
170     /* napi_value <-> std::vector<int32_t> */
171     static napi_status GetValue(napi_env env, napi_value in, std::vector<int32_t>& out);
172     static napi_status SetValue(napi_env env, const std::vector<int32_t>& in, napi_value& out);
173 
174     /* napi_value <-> std::vector<uint32_t> */
175     static napi_status GetValue(napi_env env, napi_value in, std::vector<uint32_t>& out);
176     static napi_status SetValue(napi_env env, const std::vector<uint32_t>& in, napi_value& out);
177 
178     /* napi_value <-> std::vector<int64_t> */
179     static napi_status GetValue(napi_env env, napi_value in, std::vector<int64_t>& out);
180     static napi_status SetValue(napi_env env, const std::vector<int64_t>& in, napi_value& out);
181 
182     /* napi_value <-> std::vector<double> */
183     static napi_status GetValue(napi_env env, napi_value in, std::vector<double>& out);
184     static napi_status SetValue(napi_env env, const std::vector<double>& in, napi_value& out);
185 
186     /* std::vector<AVSessionDescriptor> <-> napi_value */
187     static napi_status SetValue(napi_env env, const std::vector<AVSessionDescriptor>& in, napi_value& out);
188 
189     /* napi_value <-> AVQueueInfo */
190     static napi_status SetValue(napi_env env, const AVQueueInfo& in, napi_value& out);
191 
192     /* napi_value <-> std::vector<AVQueueInfo> */
193     static napi_status SetValue(napi_env env, const std::vector<AVQueueInfo>& in, napi_value& out);
194 
195     /* OutputDeviceInfo <-> napi_value */
196     static napi_status GetValue(napi_env env, napi_value in, OutputDeviceInfo& out);
197     static napi_status SetValue(napi_env env, const OutputDeviceInfo& in, napi_value& out);
198 
199     static napi_status GetOptionalString(napi_env env, napi_value in, DeviceInfo& out);
200 
201     /* DeviceInfo <-> napi_value */
202     static napi_status GetValue(napi_env env, napi_value in, DeviceInfo& out);
203     static napi_status SetValue(napi_env env, const DeviceInfo& in, napi_value& out);
204     static napi_status ProcessDeviceInfoParams(napi_env env, napi_value in, DeviceInfo& out);
205 
206     /* MediaInfoHolder <-> napi_value */
207     static napi_status GetValue(napi_env env, napi_value in, MediaInfoHolder& out);
208     static napi_status SetValue(napi_env env, const MediaInfoHolder& in, napi_value& out);
209 
210     /* napi_value <-> MediaInfo */
211     static napi_status GetValue(napi_env env, napi_value in, MediaInfo& out);
212     static napi_status SetValue(napi_env env, const MediaInfo& in, napi_value& out);
213 
214     /* napi_value <-> AVFileDescriptor */
215     static napi_status GetValue(napi_env env, napi_value in, AVFileDescriptor& out);
216     static napi_status SetValue(napi_env env, const AVFileDescriptor& in, napi_value& out);
217 
218     /* napi_value <-> CastDisplayInfo */
219     static napi_status SetValue(napi_env env, const CastDisplayInfo& in, napi_value& out);
220 
221     /* napi_value <-> CastDisplayInfo Array */
222     static napi_status SetValue(napi_env env, const std::vector<CastDisplayInfo>& in, napi_value& out);
223 
224     /* napi_value <-> NapiAVCastPickerOptions */
225     static napi_status GetValue(napi_env env, napi_value in, NapiAVCastPickerOptions& out);
226 
227     /* napi_get_named_property wrapper */
228     template <typename T>
GetNamedProperty(napi_env env,napi_value in,const std::string & prop,T & value)229     static inline napi_status GetNamedProperty(napi_env env, napi_value in, const std::string& prop, T& value)
230     {
231         bool hasProp = false;
232         napi_status status = napi_has_named_property(env, in, prop.c_str(), &hasProp);
233         if ((status == napi_ok) && hasProp) {
234             napi_value inner = nullptr;
235             status = napi_get_named_property(env, in, prop.c_str(), &inner);
236             if ((status == napi_ok) && (inner != nullptr)) {
237                 return GetValue(env, inner, value);
238             }
239         }
240         return napi_invalid_arg;
241     };
242 
243     /* napi_unwrap with napi_instanceof */
244     static napi_status Unwrap(napi_env env, napi_value in, void** out, napi_value constructor);
245 
246     static bool Equals(napi_env env, napi_value value, napi_ref copy);
247     static bool TypeCheck(napi_env env, napi_value value, napi_valuetype expectType);
248 
249     static napi_value GetUndefinedValue(napi_env env);
250 
251     static napi_status GetPropertyNames(napi_env env, napi_value in, std::vector<std::string>& out);
252 
253     static napi_status GetDateValue(napi_env env, napi_value value, double& result);
254     static napi_status SetDateValue(napi_env env, double time, napi_value& result);
255     static napi_status GetRefByCallback(napi_env env, std::list<napi_ref> callbackList, napi_value callback,
256         napi_ref& callbackRef);
257 
258     static napi_status GetStageElementName(napi_env env, napi_value in, AppExecFwk::ElementName& out);
259     static napi_status GetFaElementName(napi_env env, AppExecFwk::ElementName& out);
260     static napi_status GetValue(napi_env env, napi_value in, AppExecFwk::ElementName& out);
261     static napi_status GetValue(napi_env env, napi_value in, SessionToken& out);
262     static napi_status GetValue(napi_env env, napi_value in, AudioStandard::DeviceRole& out);
263     static napi_status GetValue(napi_env env, napi_value in, AudioStandard::DeviceType& out);
264     static napi_status GetValue(napi_env env, napi_value in, AudioStandard::AudioDeviceDescriptor& out);
265     static napi_status GetValue(napi_env env, napi_value in, std::vector<AudioStandard::AudioDeviceDescriptor>& out);
266     static napi_status GetSampleRate(napi_env env, napi_value in, AudioStandard::AudioSamplingRate& out);
267     static napi_status GetChannels(napi_env env, napi_value in, AudioStandard::AudioChannel& out);
268     static napi_status GetChannelMasks(napi_env env, napi_value in, int32_t& out);
269     static napi_status SetOutPutDeviceIdValue(napi_env env, const std::vector<std::string>& in, napi_value& out);
270 
271     static size_t WriteCallback(std::uint8_t *ptr, size_t size, size_t nmemb, std::vector<std::uint8_t> *imgBuffer);
272     static bool CurlSetRequestOptions(std::vector<std::uint8_t>& imgBuffer, const std::string uri);
273     static bool DoDownloadInCommon(std::shared_ptr<Media::PixelMap>& pixelMap, const std::string uri);
274 
275     static constexpr int KEYEVENT_ACTION_JS_NATIVE_DELTA = 1;
276 
277     static napi_status ThrowError(napi_env env, const char* napiMessage, int32_t napiCode);
278 
279     static constexpr size_t ARGC_ONE = 1;
280     static constexpr size_t ARGC_TWO = 2;
281     static constexpr size_t ARGC_THREE = 3;
282 
283     static constexpr size_t ARGV_FIRST = 0;
284     static constexpr size_t ARGV_SECOND = 1;
285     static constexpr size_t ARGV_THIRD = 2;
286     static constexpr size_t TIME_OUT_SECOND = 5;
287     static constexpr int HTTP_ERROR_CODE = 400;
288     static constexpr int COAP = 2;
289 };
290 }
291 #endif // NAPI_UTILS_H
292