Code/CryPlugins/CryLobby/Module/CryVoice.cpp

   1 // Copyright 2001-2018 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #include "StdAfx.h"
   4 #include "CryVoice.h"
   5
   6 #if USE_CRY_VOICE
   7
   8 CCryVoice::CCryVoice(CCryLobby* pLobby, CCryLobbyService* pService)
   9 {
  10         assert(pLobby);
  11         assert(pService);
  12
  13         m_pLobby = pLobby;
  14         m_pService = pService;
  15
  16         for (uint32 i = 0; i < MAX_REMOTE_TALKERS; i++)
  17         {
  18                 m_pRemoteUsers[i] = NULL;
  19         }
  20
  21         for (uint32 i = 0; i < MAX_LOCAL_TALKERS; i++)
  22         {
  23                 m_localUserFlags[i] = LUF_IS_MUTED; // Initialize with muted mic so the user doesn't accidentally sends voice data unwanted
  24
  25                 for (uint32 j = 0; j < MAX_REMOTE_TALKERS; j++)
  26                 {
  27                         m_pUserRelationship[i][j] = NULL;
  28                 }
  29         }
  30 }
  31
  32 ECryLobbyError CCryVoice::Initialise()
  33 {
  34         m_notificationTimer = CTimeValue(0.0f);
  35
  36         for (uint32 i = 0; i < m_numRemoteTalkers; i++)
  37         {
  38                 assert(m_pRemoteUsers[i]);
  39                 m_pRemoteUsers[i]->m_remoteUserFlags = 0;
  40                 m_pRemoteUsers[i]->m_userID = NULL;
  41         }
  42
  43         return eCLE_Success;
  44 }
  45
  46 CryVoiceRemoteUserID CCryVoice::RegisterRemoteUser(CryLobbyConnectionID connectionID, CryUserID remoteUserID)
  47 {
  48         CryVoiceRemoteUserID id = GetRemoteUser(remoteUserID);
  49
  50         if (id == CryVoiceInvalidRemoteUserID)
  51         {
  52                 for (uint32 i = 0; i < m_numRemoteTalkers; i++)
  53                 {
  54                         SRemoteUser* pRemoteUser = m_pRemoteUsers[i];
  55
  56                         assert(pRemoteUser);
  57
  58                         if (!(pRemoteUser->m_remoteUserFlags & UF_REGISTERED))
  59                         {
  60                                 pRemoteUser->m_remoteUserFlags |= (UF_REGISTERED | UF_REQUEST_MICROPHONE_STATUS);
  61                                 pRemoteUser->m_remoteUserFlags &= ~(UF_IS_SPEAKING | UF_IS_MICROPHONE_CONNECTED | UF_SEND_MICROPHONE_STATUS);
  62                                 pRemoteUser->m_connectionID = connectionID;
  63                                 pRemoteUser->m_userID = remoteUserID;
  64
  65                                 for (uint32 j = 0; j < m_numLocalTalkers; j++)
  66                                 {
  67                                         SUserRelationship* pRelationship = m_pUserRelationship[j][i];
  68
  69                                         assert(pRelationship);
  70
  71                                         pRelationship->m_relationshipFlags |= (RF_MUTED_GAME | RF_PLAYBACK_ON);
  72                                         pRelationship->m_relationshipFlags &= ~RF_MUTED_EXTERNAL;
  73                                 }
  74
  75                                 return i;
  76                         }
  77                 }
  78         }
  79
  80         return id;
  81 }
  82
  83 void CCryVoice::UnRegisterRemoteUser(CryVoiceRemoteUserID user)
  84 {
  85         assert(m_pRemoteUsers[user]);
  86
  87         m_pRemoteUsers[user]->m_remoteUserFlags &= ~UF_REGISTERED;
  88         m_pRemoteUsers[user]->m_remoteUserFlags &= ~UF_SEND_MICROPHONE_STATUS;
  89         m_pRemoteUsers[user]->m_remoteUserFlags &= ~UF_REQUEST_MICROPHONE_STATUS;
  90         m_pRemoteUsers[user]->m_userID = NULL;
  91 }
  92
  93 CryVoiceRemoteUserID CCryVoice::GetRemoteUser(CryUserID remoteUser)
  94 {
  95         for (uint32 i = 0; i < m_numRemoteTalkers; i++)
  96         {
  97                 SRemoteUser* pRemoteUser = m_pRemoteUsers[i];
  98
  99                 assert(pRemoteUser);
 100
 101                 if ((pRemoteUser->m_remoteUserFlags & UF_REGISTERED) && pRemoteUser->m_userID.IsValid() && (pRemoteUser->m_userID == remoteUser))
 102                 {
 103                         return i;
 104                 }
 105         }
 106
 107         return CryVoiceInvalidRemoteUserID;
 108 }
 109
 110 void CCryVoice::Mute(uint32 localUser, CryUserID remoteUser, bool mute)
 111 {
 112         CryVoiceRemoteUserID remoteUserID = GetRemoteUser(remoteUser);
 113
 114         if (remoteUserID != CryVoiceInvalidRemoteUserID)
 115         {
 116                 assert(m_pUserRelationship[localUser][remoteUserID]);
 117                 if (mute)
 118                 {
 119                         m_pUserRelationship[localUser][remoteUserID]->m_relationshipFlags |= RF_MUTED_GAME;
 120                 }
 121                 else
 122                 {
 123                         m_pUserRelationship[localUser][remoteUserID]->m_relationshipFlags &= ~RF_MUTED_GAME;
 124                 }
 125         }
 126 }
 127
 128 void CCryVoice::MuteLocalPlayer(uint32 localUser, bool mute)
 129 {
 130         if (mute)
 131         {
 132                 m_localUserFlags[localUser] |= LUF_IS_MUTED;
 133         }
 134         else
 135         {
 136                 m_localUserFlags[localUser] &= ~LUF_IS_MUTED;
 137         }
 138 }
 139
 140 bool CCryVoice::IsMuted(uint32 localUser, CryUserID remoteUser)
 141 {
 142         CryVoiceRemoteUserID remoteUserID = GetRemoteUser(remoteUser);
 143
 144         if (remoteUserID != CryVoiceInvalidRemoteUserID)
 145         {
 146                 assert(m_pUserRelationship[localUser][remoteUserID]);
 147                 return ((m_pUserRelationship[localUser][remoteUserID]->m_relationshipFlags & RF_MUTED_GAME) == RF_MUTED_GAME);
 148         }
 149
 150         return false;
 151 }
 152
 153 void CCryVoice::MuteExternally(uint32 localUser, CryUserID remoteUser, bool mute)
 154 {
 155         //-- Does nothing
 156 }
 157
 158 bool CCryVoice::IsMutedExternally(uint32 localUser, CryUserID remoteUser)
 159 {
 160         CryVoiceRemoteUserID remoteUserID = GetRemoteUser(remoteUser);
 161
 162         if (remoteUserID != CryVoiceInvalidRemoteUserID)
 163         {
 164                 assert(m_pUserRelationship[localUser][remoteUserID]);
 165                 return ((m_pUserRelationship[localUser][remoteUserID]->m_relationshipFlags & RF_MUTED_EXTERNAL) == RF_MUTED_EXTERNAL);
 166         }
 167
 168         return false;
 169 }
 170
 171 bool CCryVoice::IsSpeaking(uint32 localUser, CryUserID remoteUser)
 172 {
 173         CryVoiceRemoteUserID remoteUserID = GetRemoteUser(remoteUser);
 174
 175         if (remoteUserID != CryVoiceInvalidRemoteUserID)
 176         {
 177                 assert(m_pRemoteUsers[remoteUserID]);
 178                 assert(m_pUserRelationship[localUser][remoteUserID]);
 179
 180                 return (((m_pRemoteUsers[remoteUserID]->m_remoteUserFlags & (UF_REGISTERED | UF_IS_SPEAKING)) == (UF_REGISTERED | UF_IS_SPEAKING)) && ((m_pUserRelationship[localUser][remoteUserID]->m_relationshipFlags & RF_PLAYBACK_ON) == RF_PLAYBACK_ON));
 181         }
 182         else
 183         {
 184                 CryUserID localUserID = m_pService->GetUserID(localUser);
 185                 if (localUserID == remoteUser)
 186                 {
 187                         return IsSpeaking(localUser);
 188                 }
 189         }
 190
 191         return false;
 192 }
 193
 194 bool CCryVoice::IsMicrophoneConnected(CryUserID userID)
 195 {
 196         CryVoiceRemoteUserID remoteUserID = GetRemoteUser(userID);
 197
 198         if (remoteUserID != CryVoiceInvalidRemoteUserID)
 199         {
 200                 assert(m_pRemoteUsers[remoteUserID]);
 201
 202                 return ((m_pRemoteUsers[remoteUserID]->m_remoteUserFlags & UF_REGISTERED) && (m_pRemoteUsers[remoteUserID]->m_remoteUserFlags & UF_IS_MICROPHONE_CONNECTED));
 203         }
 204
 205         return false;
 206 }
 207
 208 void CCryVoice::Tick(CTimeValue tv)
 209 {
 210         if (tv.GetSeconds() - m_notificationTimer.GetSeconds() > CLobbyCVars::Get().minMicrophonNotificationInterval)
 211         {
 212                 for (uint32 i = 0; i < m_numRemoteTalkers; i++)
 213                 {
 214                         SRemoteUser* pRemoteUser = m_pRemoteUsers[i];
 215                         assert(pRemoteUser);
 216
 217                         if (pRemoteUser->m_remoteUserFlags & UF_REGISTERED)
 218                         {
 219                                 if (pRemoteUser->m_remoteUserFlags & UF_SEND_MICROPHONE_STATUS)
 220                                 {
 221                                         SendMicrophoneNotification(i);
 222                                 }
 223                                 if (pRemoteUser->m_remoteUserFlags & UF_REQUEST_MICROPHONE_STATUS)
 224                                 {
 225                                         SendMicrophoneRequest(i);
 226                                 }
 227                         }
 228                 }
 229
 230                 m_notificationTimer = tv;
 231         }
 232 }
 233
 234 #endif // USE_CRY_VOICE