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 <cstdint> 20 #include <map> 21 #include <list> 22 #include "napi/native_api.h" 23 #include "napi/native_common.h" 24 #include "napi/native_node_api.h" 25 #include "avsession_log.h" 26 #include "audio_system_manager.h" 27 #include "avsession_info.h" 28 #include "want_agent.h" 29 #include "napi_base_context.h" 30 #include "ability.h" 31 #include "media_info_holder.h" 32 #include "media_info.h" 33 #include "av_file_descriptor.h" 34 35 /* check condition related to argc/argv, return and logging. */ 36 #define CHECK_ARGS_RETURN_VOID(context, condition, message, code) \ 37 do { \ 38 if (!(condition)) { \ 39 (context)->status = napi_invalid_arg; \ 40 (context)->errMessage = std::string(message); \ 41 (context)->errCode = code; \ 42 SLOGE("test (" #condition ") failed: " message); \ 43 return; \ 44 } \ 45 } while (0) 46 47 #define CHECK_STATUS_RETURN_VOID(context, message, code) \ 48 do { \ 49 if ((context)->status != napi_ok) { \ 50 (context)->errMessage = std::string(message); \ 51 (context)->errCode = code; \ 52 SLOGE("test (context->status == napi_ok) failed: " message); \ 53 return; \ 54 } \ 55 } while (0) 56 57 /* check condition, return and logging if condition not true. */ 58 #define CHECK_RETURN(condition, message, retVal) \ 59 do { \ 60 if (!(condition)) { \ 61 SLOGE("test (" #condition ") failed: " message); \ 62 return retVal; \ 63 } \ 64 } while (0) 65 66 #define CHECK_RETURN_VOID(condition, message) \ 67 do { \ 68 if (!(condition)) { \ 69 SLOGE("test (" #condition ") failed: " message); \ 70 return; \ 71 } \ 72 } while (0) 73 74 namespace OHOS::AVSession { 75 class NapiUtils { 76 public: 77 static int32_t ConvertSessionType(const std::string& typeString); 78 static std::string ConvertSessionType(int32_t type); 79 80 /* napi_value <-> bool */ 81 static napi_status GetValue(napi_env env, napi_value in, bool& out); 82 static napi_status SetValue(napi_env env, const bool& in, napi_value& out); 83 84 /* napi_value <-> int32_t */ 85 static napi_status GetValue(napi_env env, napi_value in, int32_t& out); 86 static napi_status SetValue(napi_env env, const int32_t& in, napi_value& out); 87 88 /* napi_value <-> uint32_t */ 89 static napi_status GetValue(napi_env env, napi_value in, uint32_t& out); 90 static napi_status SetValue(napi_env env, const uint32_t& in, napi_value& out); 91 92 /* napi_value <-> int64_t */ 93 static napi_status GetValue(napi_env env, napi_value in, int64_t& out); 94 static napi_status SetValue(napi_env env, const int64_t& in, napi_value& out); 95 96 /* napi_value <-> double */ 97 static napi_status GetValue(napi_env env, napi_value in, double& out); 98 static napi_status SetValue(napi_env env, const double& in, napi_value& out); 99 100 /* napi_value <-> std::string */ 101 static napi_status GetValue(napi_env env, napi_value in, std::string& out); 102 static napi_status SetValue(napi_env env, const std::string& in, napi_value& out); 103 104 /* napi_value <-> AppExecFwk::ElementName */ 105 static napi_status SetValue(napi_env env, const AppExecFwk::ElementName& in, napi_value& out); 106 107 /* napi_value <-> AVSessionDescriptor */ 108 static napi_status SetValue(napi_env env, const AVSessionDescriptor& in, napi_value& out); 109 110 /* napi_value <-> MMI::KeyEvent::KeyItem */ 111 static napi_status GetValue(napi_env env, napi_value in, MMI::KeyEvent::KeyItem& out); 112 static napi_status SetValue(napi_env env, const std::optional<MMI::KeyEvent::KeyItem> in, napi_value& out); 113 114 /* napi_value <-> MMI::KeyEvent */ 115 static napi_status GetValue(napi_env env, napi_value in, std::shared_ptr<MMI::KeyEvent>& out); 116 static napi_status SetValue(napi_env env, const std::shared_ptr<MMI::KeyEvent>& in, napi_value& out); 117 118 /* napi_value <-> AbilityRuntime::WantAgent::WantAgent */ 119 static napi_status GetValue(napi_env env, napi_value in, AbilityRuntime::WantAgent::WantAgent*& out); 120 static napi_status SetValue(napi_env env, AbilityRuntime::WantAgent::WantAgent& in, napi_value& out); 121 122 /* napi_value <-> AAFwk::WantParams */ 123 static napi_status GetValue(napi_env env, napi_value in, AAFwk::WantParams& out); 124 static napi_status SetValue(napi_env env, const AAFwk::WantParams& in, napi_value& out); 125 126 /* napi_value <-> AVMetaData */ 127 static napi_status GetValue(napi_env env, napi_value in, AVMetaData& out); 128 static napi_status SetValue(napi_env env, const AVMetaData& in, napi_value& out); 129 130 /* napi_value <-> AVMediaDescription */ 131 static napi_status GetValue(napi_env env, napi_value in, AVMediaDescription& out); 132 static napi_status SetValue(napi_env env, const AVMediaDescription& in, napi_value& out); 133 134 /* napi_value <-> AVQueueItem */ 135 static napi_status GetValue(napi_env env, napi_value in, AVQueueItem& out); 136 static napi_status SetValue(napi_env env, const AVQueueItem& in, napi_value& out); 137 138 /* napi_value <-> std::vector<AVQueueItem> */ 139 static napi_status GetValue(napi_env env, napi_value in, std::vector<AVQueueItem>& out); 140 static napi_status SetValue(napi_env env, const std::vector<AVQueueItem>& in, napi_value& out); 141 142 /* napi_value <-> AVPlaybackState */ 143 static napi_status GetValue(napi_env env, napi_value in, AVPlaybackState& out); 144 static napi_status SetValue(napi_env env, const AVPlaybackState& in, napi_value& out); 145 146 /* napi_value <-> AVCastPlayerState */ 147 static napi_status GetValue(napi_env env, napi_value in, AVCastPlayerState& out); 148 static napi_status SetValue(napi_env env, const AVCastPlayerState& in, napi_value& out); 149 150 /* napi_value <-> std::vector<std::string> */ 151 static napi_status GetValue(napi_env env, napi_value in, std::vector<std::string>& out); 152 static napi_status SetValue(napi_env env, const std::vector<std::string>& in, napi_value& out); 153 154 /* napi_value <-> std::vector<uint8_t> */ 155 static napi_status GetValue(napi_env env, napi_value in, std::vector<uint8_t>& out); 156 static napi_status SetValue(napi_env env, const std::vector<uint8_t>& in, napi_value& out); 157 158 /* napi_value <-> std::vector<int32_t> */ 159 static napi_status GetValue(napi_env env, napi_value in, std::vector<int32_t>& out); 160 static napi_status SetValue(napi_env env, const std::vector<int32_t>& in, napi_value& out); 161 162 /* napi_value <-> std::vector<uint32_t> */ 163 static napi_status GetValue(napi_env env, napi_value in, std::vector<uint32_t>& out); 164 static napi_status SetValue(napi_env env, const std::vector<uint32_t>& in, napi_value& out); 165 166 /* napi_value <-> std::vector<int64_t> */ 167 static napi_status GetValue(napi_env env, napi_value in, std::vector<int64_t>& out); 168 static napi_status SetValue(napi_env env, const std::vector<int64_t>& in, napi_value& out); 169 170 /* napi_value <-> std::vector<double> */ 171 static napi_status GetValue(napi_env env, napi_value in, std::vector<double>& out); 172 static napi_status SetValue(napi_env env, const std::vector<double>& in, napi_value& out); 173 174 /* std::vector<AVSessionDescriptor> <-> napi_value */ 175 static napi_status SetValue(napi_env env, const std::vector<AVSessionDescriptor>& in, napi_value& out); 176 177 /* OutputDeviceInfo <-> napi_value */ 178 static napi_status GetValue(napi_env env, napi_value in, OutputDeviceInfo& out); 179 static napi_status SetValue(napi_env env, const OutputDeviceInfo& in, napi_value& out); 180 181 static napi_status GetOptionalString(napi_env env, napi_value in, DeviceInfo& out); 182 183 /* DeviceInfo <-> napi_value */ 184 static napi_status GetValue(napi_env env, napi_value in, DeviceInfo& out); 185 static napi_status SetValue(napi_env env, const DeviceInfo& in, napi_value& out); 186 187 /* MediaInfoHolder <-> napi_value */ 188 static napi_status GetValue(napi_env env, napi_value in, MediaInfoHolder& out); 189 static napi_status SetValue(napi_env env, const MediaInfoHolder& in, napi_value& out); 190 191 /* napi_value <-> MediaInfo */ 192 static napi_status GetValue(napi_env env, napi_value in, MediaInfo& out); 193 static napi_status SetValue(napi_env env, const MediaInfo& in, napi_value& out); 194 195 /* napi_value <-> AVFileDescriptor */ 196 static napi_status GetValue(napi_env env, napi_value in, AVFileDescriptor& out); 197 static napi_status SetValue(napi_env env, const AVFileDescriptor& in, napi_value& out); 198 199 /* napi_get_named_property wrapper */ 200 template <typename T> GetNamedProperty(napi_env env,napi_value in,const std::string & prop,T & value)201 static inline napi_status GetNamedProperty(napi_env env, napi_value in, const std::string& prop, T& value) 202 { 203 bool hasProp = false; 204 napi_status status = napi_has_named_property(env, in, prop.c_str(), &hasProp); 205 if ((status == napi_ok) && hasProp) { 206 napi_value inner = nullptr; 207 status = napi_get_named_property(env, in, prop.c_str(), &inner); 208 if ((status == napi_ok) && (inner != nullptr)) { 209 return GetValue(env, inner, value); 210 } 211 } 212 return napi_invalid_arg; 213 }; 214 215 /* napi_unwrap with napi_instanceof */ 216 static napi_status Unwrap(napi_env env, napi_value in, void** out, napi_value constructor); 217 218 static bool Equals(napi_env env, napi_value value, napi_ref copy); 219 static bool TypeCheck(napi_env env, napi_value value, napi_valuetype expectType); 220 221 static napi_value GetUndefinedValue(napi_env env); 222 223 static napi_status GetPropertyNames(napi_env env, napi_value in, std::vector<std::string>& out); 224 225 static napi_status GetDateValue(napi_env env, napi_value value, double& result); 226 static napi_status SetDateValue(napi_env env, double time, napi_value& result); 227 static napi_status GetRefByCallback(napi_env env, std::list<napi_ref> callbackList, napi_value callback, 228 napi_ref& callbackRef); 229 230 static napi_status GetStageElementName(napi_env env, napi_value in, AppExecFwk::ElementName& out); 231 static napi_status GetFaElementName(napi_env env, AppExecFwk::ElementName& out); 232 static napi_status GetValue(napi_env env, napi_value in, AppExecFwk::ElementName& out); 233 static napi_status GetValue(napi_env env, napi_value in, SessionToken& out); 234 static napi_status GetValue(napi_env env, napi_value in, AudioStandard::DeviceRole& out); 235 static napi_status GetValue(napi_env env, napi_value in, AudioStandard::DeviceType& out); 236 static napi_status GetValue(napi_env env, napi_value in, AudioStandard::AudioDeviceDescriptor& out); 237 static napi_status GetValue(napi_env env, napi_value in, std::vector<AudioStandard::AudioDeviceDescriptor>& out); 238 static napi_status GetSampleRate(napi_env env, napi_value in, AudioStandard::AudioSamplingRate& out); 239 static napi_status GetChannels(napi_env env, napi_value in, AudioStandard::AudioChannel& out); 240 static napi_status GetChannelMasks(napi_env env, napi_value in, int32_t& out); 241 static napi_status SetOutPutDeviceIdValue(napi_env env, const std::vector<std::string>& in, napi_value& out); 242 243 static constexpr int KEYEVENT_ACTION_JS_NATIVE_DELTA = 1; 244 245 static napi_status ThrowError(napi_env env, const char* napiMessage, int32_t napiCode); 246 247 static constexpr size_t ARGC_ONE = 1; 248 static constexpr size_t ARGC_TWO = 2; 249 static constexpr size_t ARGC_THREE = 3; 250 251 static constexpr size_t ARGV_FIRST = 0; 252 static constexpr size_t ARGV_SECOND = 1; 253 static constexpr size_t ARGV_THIRD = 2; 254 }; 255 } 256 #endif // NAPI_UTILS_H 257