native/include/call_manager_service_proxy.h

/*
 * Copyright (C) 2021-2022 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef CALL_MANAGER_SERVICE_PROXY_H
#define CALL_MANAGER_SERVICE_PROXY_H

#include <cfloat>
#include <cstdio>
#include <string>
#include <vector>

#include "iremote_broker.h"
#include "iremote_proxy.h"
#include "pac_map.h"

#include "call_ability_callback_ipc_interface_code.h"
#include "call_manager_inner_type.h"
#include "call_manager_service_ipc_interface_code.h"
#include "i_call_manager_service.h"
#include "telephony_log_wrapper.h"

namespace OHOS {
namespace Telephony {
class CallManagerServiceProxy : public IRemoteProxy<ICallManagerService> {
public:
    /**
     * CallManagerServiceProxy
     *
     * @param impl
     */
    explicit CallManagerServiceProxy(const sptr<IRemoteObject> &impl);
    virtual ~CallManagerServiceProxy() = default;

    /**
     * RegisterCallBack
     *
     * @brief Register callback
     * @param callback[in], callback function pointer
     * @return Returns 0 on success, others on failure.
     */
    int32_t RegisterCallBack(const sptr<ICallAbilityCallback> &callback) override;

    /**
     * UnRegisterCallBack
     *
     * @brief unregister callback
     * @return Returns 0 on success, others on failure.
     */
    int32_t UnRegisterCallBack() override;

    /**
     * ObserverOnCallDetailsChange
     *
     * @brief execute when observe OnCallDetailsChange
     * @return Returns 0 on success, others on failure.
     */
    int32_t ObserverOnCallDetailsChange() override;

    /**
     * DialCall
     *
     * @brief Dial a phone call
     * @param number[in], dial param.
     * @param extras[in], extras date.
     * @return Returns callId when the value is greater than zero, others on failure.
     */
    int32_t DialCall(std::u16string number, AppExecFwk::PacMap &extras) override;

    /**
     * MakeCall
     *
     * @brief Make a phone call
     * @param number[in], call param.
     * @return Returns 0 on success, others on failure.
     */
    int32_t MakeCall(std::string number) override;

    /**
     * AnswerCall
     *
     * @brief Answer a phone call
     * @param callId[in], call id
     * @param videoState[in], 0: audio, 1: video
     * @return Returns 0 on success, others on failure.
     */
    int32_t AnswerCall(int32_t callId, int32_t videoState) override;

    /**
     * RejectCall
     *
     * @brief Reject a phone call
     * @param callId[in], call id
     * @param rejectWithMessage[in], Whether to enter the reason for rejection,true:yes false:no
     * @param textMessage[in], The reason you reject the call
     * @return Returns 0 on success, others on failure.
     */
    int32_t RejectCall(int32_t callId, bool rejectWithMessage, std::u16string textMessage) override;

    /**
     * HangUpCall
     *
     * @brief Hang up the phone
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t HangUpCall(int32_t callId) override;

    /**
     * GetCallState
     *
     * @brief Obtain the call status of the device
     * @return Returns call state.
     */
    int32_t GetCallState() override;

    /**
     * HoldCall
     *
     * @brief Park a phone call
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t HoldCall(int32_t callId) override;

    /**
     * UnHoldCall
     *
     * @brief Activate a phone call
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t UnHoldCall(int32_t callId) override;

    /**
     * SwitchCall
     *
     * @brief Switch the phone
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t SwitchCall(int32_t callId) override;

    /**
     * HasCall
     *
     * @brief Is there Call
     * @return Returns true on has call, others on there is no call.
     */
    bool HasCall() override;

    /**
     * IsNewCallAllowed
     *
     * @brief Can I initiate a call
     * @param enabled[out], whether allow new calls
     * @return Returns interface processing results.
     */
    int32_t IsNewCallAllowed(bool &enabled) override;

    /**
     * SetMuted
     *
     * @brief Mute the Microphone
     * @param isMute[in], mute state
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetMuted(bool isMute) override;

    /**
     * MuteRinger
     *
     * @brief Call mute
     * @return Returns 0 on success, others on failure.
     */
    int32_t MuteRinger() override;

    /**
     * SetAudioDevice
     *
     * @brief Setting the Audio Channel
     * @param audioDevice[in], contain audioDeviceType and address
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetAudioDevice(const AudioDevice &audioDevice) override;

    /**
     * IsRinging
     *
     * @brief Whether the ringing
     * @param enabled[out], true on ringing, false on there is no ringing
     * @return Returns interface processing results.
     */
    int32_t IsRinging(bool &enabled) override;

    /**
     * IsInEmergencyCall
     *
     * @brief Is there an emergency call
     * @param enabled[out], true on emergency call, false on no emergency call
     * @return Returns interface processing results.
     */
    int32_t IsInEmergencyCall(bool &enabled) override;

    /**
     * StartDtmf
     *
     * @brief Enable and send DTMF
     * @param callId[in], call id
     * @param str[in], Characters sent
     * @return Returns 0 on success, others on failure.
     */
    int32_t StartDtmf(int32_t callId, char str) override;

    /**
     * StopDtmf
     *
     * @brief Stop the DTMF
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t StopDtmf(int32_t callId) override;

    int32_t PostDialProceed(int32_t callId, bool proceed) override;

    /**
     * GetCallWaiting
     *
     * @brief Gets whether the call waiting service of the current account is enabled
     * @param slotId[in], The slot id
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetCallWaiting(int32_t slotId) override;

    /**
     * SetCallWaiting
     *
     * @brief Set the call waiting function for the current account
     * @param slotId[in], The slot id
     * @param activate[in], Activation of switch
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCallWaiting(int32_t slotId, bool activate) override;

    /**
     * GetCallRestriction
     *
     * @brief Gets the call restriction information of the specified account
     * @param slotId[in], The slot id
     * @param type[in], Call Restriction type
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetCallRestriction(int32_t slotId, CallRestrictionType type) override;

    /**
     * SetCallRestriction
     *
     * @brief Set the call restriction function for the current account
     * @param slotId[in], The slot id
     * @param info[in], Call restriction information
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCallRestriction(int32_t slotId, CallRestrictionInfo &info) override;

    /**
     * SetCallRestrictionPassword
     *
     * @brief Set the call restriction password function for the current account
     * @param slotId[in], The slot id
     * @param fac[in], Call restriction type
     * @param oldPassword[in], Old password of call restriction type
     * @param newPassword[in], New password of call restriction type
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCallRestrictionPassword(
        int32_t slotId, CallRestrictionType fac, const char *oldPassword, const char *newPassword) override;

    /**
     * GetCallTransferInfo
     *
     * @brief Gets the call transfer information of the current account
     * @param slotId[in], The slot id
     * @param type[in], Call Transfer Type
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetCallTransferInfo(int32_t slotId, CallTransferType type) override;

    /**
     * SetCallTransferInfo
     *
     * @brief Set the call transfer function for the current account
     * @param slotId[in], The slot id
     * @param info[in], Call Transfer Information
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCallTransferInfo(int32_t slotId, CallTransferInfo &info) override;

    /**
     * CanSetCallTransferTime
     *
     * @brief confirm whether IMS can set call transfer time.
     * @param slotId[in], The slot id
     * @param result[out], The result of can set or not
     * @return Returns true on can set, others on can not set.
     */
    int32_t CanSetCallTransferTime(int32_t slotId, bool &result) override;

    /**
     * CombineConference
     *
     * @brief Merge calls to form a conference
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t CombineConference(int32_t mainCallId) override;

    /**
     * SeparateConference
     *
     * @brief Separates a specified call from a conference call
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t SeparateConference(int32_t callId) override;

    /**
     * KickOutFromConference
     *
     * @brief Hangup a specified call from a conference call
     * @param callId[in], call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t KickOutFromConference(int32_t callId) override;

    /**
     * JoinConference
     *
     * @brief Bring someone into a meeting
     * @param callId[in], The call id
     * @param numberList[in], List of calls to join the conference
     * @return Returns 0 on success, others on failure.
     */
    int32_t JoinConference(int32_t callId, std::vector<std::u16string> &numberList) override;

    /**
     * SetCallPreferenceMode
     *
     * @brief Setting the Call Type
     * @param slotId[in], The slot id
     * @param mode[in], Preference Mode
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCallPreferenceMode(int32_t slotId, int32_t mode) override;

    /**
     * ControlCamera
     *
     * @brief Open or close camera
     * @param callId[in], The call id
     * @param cameraId[in], The camera id
     * @return Returns 0 on success, others on failure.
     */
    int32_t ControlCamera(int32_t callId, std::u16string &cameraId) override;

    /**
     * SetPreviewWindow
     *
     * @brief Set the location and size of the preview window for videos captured by the local camera.
     * @param callId[in], The call id
     * @param surfaceId[in], Window information
     * @param surface[in], Window information
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetPreviewWindow(int32_t callId, std::string &surfaceId, sptr<Surface> surface) override;

    /**
     * SetDisplayWindow
     *
     * @brief Sets the location and size of the remote video window.
     * @param callId[in], The call id
     * @param surfaceId[in], Window information
     * @param surface[in], Window information
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetDisplayWindow(int32_t callId, std::string &surfaceId, sptr<Surface> surface) override;

    /**
     * SetCameraZoom
     *
     * @brief Sets the local camera zoom scale
     * @param zoomRatio[in], Camera scale
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetCameraZoom(float zoomRatio) override;

    /**
     * SetPausePicture
     *
     * @brief APP sets the screen of the remote video freeze immediately.
     * If the APP does not call this interface when making a video call,
     * the last frame before the remote video freeze is displayed by default
     * @param callId[in], The call id
     * @param path[in], Local Picture address
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetPausePicture(int32_t callId, std::u16string &path) override;

    /**
     * SetDeviceDirection
     *
     * @brief Set the rotation Angle of the local device. The default value is 0
     * @param callId[in], The call id
     * @param rotation[in], Rotation Angle
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetDeviceDirection(int32_t callId, int32_t rotation) override;

    /**
     * IsEmergencyPhoneNumber
     *
     * @brief Is it an emergency call
     * @param number[in], Phone number to be formatted
     * @param slotId[in], The slot id
     * @param enabled[out] result of is it an emergency call
     * @return Returns 0 on success, others on failure.
     */
    int32_t IsEmergencyPhoneNumber(std::u16string &number, int32_t slotId, bool &enabled) override;

    /**
     * FormatPhoneNumber
     *
     * @brief Formatting a phone number
     * @param number[in], Phone number to be formatted
     * @param countryCode[in], Country code of the phone number
     * @param formatNumber[out] Formatting a phone number
     * @return Returns 0 on success, others on failure.
     */
    int32_t FormatPhoneNumber(
        std::u16string &number, std::u16string &countryCode, std::u16string &formatNumber) override;

    /**
     * FormatPhoneNumberToE164
     *
     * @brief Formatting a phone number
     * @param number[in]. Phone number to be formatted
     * @param countryCode[in], Country code of the phone number
     * @param formatNumber[out] Formatting a phone number
     * @return Returns 0 on success, others on failure.
     */
    int32_t FormatPhoneNumberToE164(
        std::u16string &number, std::u16string &countryCode, std::u16string &formatNumber) override;

    /**
     * GetMainCallId
     *
     * @brief Obtain the ID of the primary call in a conference
     * @param callId[in], Id of a call in a conference
     * @return Returns main call id, -1 on not call id.
     */
    int32_t GetMainCallId(int32_t callId, int32_t &mainCallId) override;

    /**
     * GetSubCallIdList
     *
     * @brief Obtain the list of neutron call ids
     * @param callId[in], Id of a call in a conference
     * @param callIdList[out], the list of neutron call ids
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetSubCallIdList(int32_t callId, std::vector<std::u16string> &callIdList) override;

    /**
     * GetCallIdListForConference
     *
     * @brief Obtain the callId list of all calls in a conference
     * @param callId[in], Id of a call in a conference
     * @param callIdList[out], the callId list of all calls in a conference
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetCallIdListForConference(int32_t callId, std::vector<std::u16string> &callIdList) override;

    /**
     * GetImsConfig
     *
     * @brief Obtain the IMS service configuration
     * @param slotId[in], The slot id
     * @param item[in]
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetImsConfig(int32_t slotId, ImsConfigItem item) override;

    /**
     * SetImsConfig
     *
     * @brief Example Set the IMS service configuration
     * @param slotId[in], The slot id
     * @param item[in]
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetImsConfig(int32_t slotId, ImsConfigItem item, std::u16string &value) override;

    /**
     * GetImsFeatureValue
     *
     * @brief Gets the value of the IMS function item of the specified network type
     * @param slotId[in], The slot id
     * @param info[in], FeatureType
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetImsFeatureValue(int32_t slotId, FeatureType type) override;

    /**
     * SetImsFeatureValue
     *
     * @brief Set the value of the IMS function item of the specified network type
     * @param slotId[in], The slot id
     * @param info[in], FeatureType
     * @param value[in]
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetImsFeatureValue(int32_t slotId, FeatureType type, int32_t value) override;

    /**
     * UpdateImsCallMode
     *
     * @brief Setting the Call Mode
     * @param callId[in], The call id
     * @param mode[in], Calling patterns
     * @return Returns 0 on success, others on failure.
     */
    int32_t UpdateImsCallMode(int32_t callId, ImsCallMode mode) override;

    /**
     * EnableImsSwitch
     *
     * @brief Start VoLte
     * @param slotId[in], The slot id
     * @return Returns 0 on success, others on failure.
     */
    int32_t EnableImsSwitch(int32_t slotId) override;

    /**
     * DisableImsSwitch
     *
     * @brief Stop VoLte
     * @param slotId[in], The slot id
     * @return Returns 0 on success, others on failure.
     */
    int32_t DisableImsSwitch(int32_t slotId) override;

    /**
     * IsImsSwitchEnabled
     *
     * @brief Whether to enable VoLte
     * @param slotId[in], The slot id
     * @param enabled[out], The result of enable or not
     * @return Returns 0 on success, others on failure.
     */
    int32_t IsImsSwitchEnabled(int32_t slotId, bool &enabled) override;

    /**
     * SetVoNRState
     *
     * @brief Set VoNR State
     * @param slotId[in], The slot id
     * @param state[in], The state of VoNR
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetVoNRState(int32_t slotId, int32_t state) override;

    /**
     * GetVoNRState
     *
     * @brief Get VoNR State
     * @param slotId[in], The slot id
     * @param state[out], The result of VoNR state ON or OFF
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetVoNRState(int32_t slotId, int32_t &state) override;

    /**
     * StartRtt
     *
     * @brief Enable and send RTT information
     * @param callId[in], The call id
     * @param msg[in], RTT information
     * @return Returns 0 on success, others on failure.
     */
    int32_t StartRtt(int32_t callId, std::u16string &msg) override;

    /**
     * StopRtt
     *
     * @brief Close the RTT
     * @param callId[in], The call id
     * @return Returns 0 on success, others on failure.
     */
    int32_t StopRtt(int32_t callId) override;

    /**
     * ReportOttCallDetailsInfo
     *
     * @brief report ott call details info
     * @param ottVec[in], ott call status detail info list
     * @return Returns 0 on success, others on failure.
     */
    int32_t ReportOttCallDetailsInfo(std::vector<OttCallDetailsInfo> &ottVec) override;

    /**
     * ReportOttCallEventInfo
     *
     * @brief report ott call event info
     * @param eventInfo[in], ott call event detail info
     * @return Returns 0 on success, others on failure.
     */
    int32_t ReportOttCallEventInfo(OttCallEventInfo &eventInfo) override;

    /**
     * CloseUnFinishedUssd
     *
     * @brief Close Unfinished ussd function for the current account
     * @param slotId[in], The slot id
     * @return Returns 0 on success, others on failure.
     */
    int32_t CloseUnFinishedUssd(int32_t slotId) override;

    /**
     * Handle special code from dialer.
     *
     * @param specialCode[in], special code
     * @return Returns 0 on success, others on failure.
     */
    int32_t InputDialerSpecialCode(const std::string &specialCode) override;

    /**
     * Remove missed incoming call notification.
     *
     * @return Returns 0 on success, others on failure.
     */
    int32_t RemoveMissedIncomingCallNotification() override;

    /**
     * SetVoIPCallState
     *
     * @brief Set VoIP Call State
     * @param state[in], The state of VoIP Call
     * @return Returns 0 on success, others on failure.
     */
    int32_t SetVoIPCallState(int32_t state) override;

    /**
     * GetVoNRState
     *
     * @brief Get VoIP Call State
     * @param state[out], The VoIP Call state
     * @return Returns 0 on success, others on failure.
     */
    int32_t GetVoIPCallState(int32_t &state) override;

    /**
     * GetProxyObjectPtr
     *
     * @brief get callManager proxy object ptr
     * @param proxyType[in], proxy type
     * @return Returns nullptr on failure, others on success.
     */
    sptr<IRemoteObject> GetProxyObjectPtr(CallManagerProxyType proxyType) override;

    /**
     * ReportAudioDeviceInfo
     *
     * @brief report audio device info
     * @return Returns 0 on success, others on failure.
     */
    int32_t ReportAudioDeviceInfo() override;

    /**
     * CancelCallUpgrade
     *
     * @brief cancel upgrade to video call
     * @param callId[in], The call id
     *
     * @return Returns 0 on success, others on failure.
     */
    int32_t CancelCallUpgrade(int32_t callId) override;

    /**
     * RequestCameraCapabilities
     *
     * @brief request camera capabilities
     * @param callId[in], The call id
     *
     * @return Returns 0 on success, others on failure.
     */
    int32_t RequestCameraCapabilities(int32_t callId) override;

    /**
     * RegisterVoipCallManagerCallback
     *
     * @brief notify voip register callstatus call back
     * @return Returns 0 on success, others on failure.
     */
    int32_t RegisterVoipCallManagerCallback() override;

    /**
     * @brief notify voip unregister callstatus callback
     *
     * @return Returns 0 on success, others on failure.
     */
    int32_t UnRegisterVoipCallManagerCallback() override;

    /**
     * SendCallUiEvent
     *
     * @brief send call ui event
     * @return Returns 0 on success, others on failure.
     */
    int32_t SendCallUiEvent(int32_t callId, std::string &eventName) override;

private:
    int32_t SendRequest(CallManagerInterfaceCode code);
    int32_t SendRequest(CallManagerInterfaceCode code, MessageParcel &dataParcel, MessageParcel &replyParcel);

private:
    static inline BrokerDelegator<CallManagerServiceProxy> delegator_;
};
} // namespace Telephony
} // namespace OHOS

#endif // CALL_MANAGER_SERVICE_PROXY_H