forked from bwmarrin/discordgo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
voice.go
377 lines (305 loc) · 9.63 KB
/
voice.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
// Discordgo - Discord bindings for Go
// Available at https://github.com/bwmarrin/discordgo
// Copyright 2015-2016 Bruce Marriner <bruce@sqls.net>. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// This file contains code related to Discord voice suppport
package discordgo
import (
"encoding/binary"
"encoding/json"
"fmt"
"net"
"strings"
"sync"
"time"
"github.com/gorilla/websocket"
)
// ------------------------------------------------------------------------------------------------
// Code related to both Voice Websocket and UDP connections.
// ------------------------------------------------------------------------------------------------
// A Voice struct holds all data and functions related to Discord Voice support.
type Voice struct {
sync.Mutex // future use
Ready bool // If true, voice is ready to send/receive audio
Debug bool // If true, print extra logging
Chan chan struct{} // future use
UDPConn *net.UDPConn // exported for dgvoice, may change.
OP2 *voiceOP2 // exported for dgvoice, may change.
wsConn *websocket.Conn
sessionID string
token string
endpoint string
guildID string
channelID string
userID string
}
// ------------------------------------------------------------------------------------------------
// Code related to the Voice websocket connection
// ------------------------------------------------------------------------------------------------
// A voiceOP2 stores the data for the voice operation 2 websocket event
// which is sort of like the voice READY packet
type voiceOP2 struct {
SSRC uint32 `json:"ssrc"`
Port int `json:"port"`
Modes []string `json:"modes"`
HeartbeatInterval time.Duration `json:"heartbeat_interval"`
}
type voiceHandshakeData struct {
ServerID string `json:"server_id"`
UserID string `json:"user_id"`
SessionID string `json:"session_id"`
Token string `json:"token"`
}
type voiceHandshakeOp struct {
Op int `json:"op"` // Always 0
Data voiceHandshakeData `json:"d"`
}
// Open opens a voice connection. This should be called
// after VoiceChannelJoin is used and the data VOICE websocket events
// are captured.
func (v *Voice) Open() (err error) {
// TODO: How do we handle changing channels?
// Don't open a websocket if one is already open
if v.wsConn != nil {
return
}
// Connect to Voice Websocket
vg := fmt.Sprintf("wss://%s", strings.TrimSuffix(v.endpoint, ":80"))
v.wsConn, _, err = websocket.DefaultDialer.Dial(vg, nil)
if err != nil {
fmt.Println("VOICE error opening websocket:", err)
return
}
data := voiceHandshakeOp{0, voiceHandshakeData{v.guildID, v.userID, v.sessionID, v.token}}
err = v.wsConn.WriteJSON(data)
if err != nil {
fmt.Println("VOICE error sending init packet:", err)
return
}
// Start a listening for voice websocket events
// TODO add a check here to make sure Listen worked by monitoring
// a chan or bool?
go v.wsListen()
return
}
// Close closes the voice connection
func (v *Voice) Close() {
if v.UDPConn != nil {
v.UDPConn.Close()
}
if v.wsConn != nil {
v.wsConn.Close()
}
}
// wsListen listens on the voice websocket for messages and passes them
// to the voice event handler. This is automaticly called by the Open func
func (v *Voice) wsListen() {
for {
messageType, message, err := v.wsConn.ReadMessage()
if err != nil {
// TODO: Handle this problem better.
// TODO: needs proper logging
fmt.Println("Voice Listen Error:", err)
break
}
// Pass received message to voice event handler
go v.wsEvent(messageType, message)
}
return
}
// wsEvent handles any voice websocket events. This is only called by the
// wsListen() function.
func (v *Voice) wsEvent(messageType int, message []byte) {
if v.Debug {
fmt.Println("wsEvent received: ", messageType)
printJSON(message)
}
var e Event
if err := json.Unmarshal(message, &e); err != nil {
fmt.Println("wsEvent Unmarshall error: ", err)
return
}
switch e.Operation {
case 2: // READY
v.OP2 = &voiceOP2{}
if err := json.Unmarshal(e.RawData, v.OP2); err != nil {
fmt.Println("voiceWS.onEvent OP2 Unmarshall error: ", err)
printJSON(e.RawData) // TODO: Better error logging
return
}
// Start the voice websocket heartbeat to keep the connection alive
go v.wsHeartbeat(v.OP2.HeartbeatInterval)
// TODO monitor a chan/bool to verify this was successful
// Start the UDP connection
err := v.udpOpen()
if err != nil {
fmt.Println("Error opening udp connection: ", err)
return
}
// start udpKeepAlive
go v.udpKeepAlive(5 * time.Second)
// TODO: find a way to check that it fired off okay
return
case 3: // HEARTBEAT response
// add code to use this to track latency?
return
case 4:
// TODO
case 5:
// SPEAKING TRUE/FALSE NOTIFICATION
/*
{
"user_id": "1238921738912",
"ssrc": 2,
"speaking": false
}
*/
default:
fmt.Println("UNKNOWN VOICE OP: ", e.Operation)
printJSON(e.RawData)
}
return
}
type voiceHeartbeatOp struct {
Op int `json:"op"` // Always 3
Data int `json:"d"`
}
// wsHeartbeat sends regular heartbeats to voice Discord so it knows the client
// is still connected. If you do not send these heartbeats Discord will
// disconnect the websocket connection after a few seconds.
func (v *Voice) wsHeartbeat(i time.Duration) {
ticker := time.NewTicker(i * time.Millisecond)
for {
err := v.wsConn.WriteJSON(voiceHeartbeatOp{3, int(time.Now().Unix())})
if err != nil {
v.Ready = false
fmt.Println("wsHeartbeat send error: ", err)
return // TODO better logging
}
<-ticker.C
}
}
type voiceSpeakingData struct {
Speaking bool `json:"speaking"`
Delay int `json:"delay"`
}
type voiceSpeakingOp struct {
Op int `json:"op"` // Always 5
Data voiceSpeakingData `json:"d"`
}
// Speaking sends a speaking notification to Discord over the voice websocket.
// This must be sent as true prior to sending audio and should be set to false
// once finished sending audio.
// b : Send true if speaking, false if not.
func (v *Voice) Speaking(b bool) (err error) {
if v.wsConn == nil {
return fmt.Errorf("No Voice websocket.")
}
data := voiceSpeakingOp{5, voiceSpeakingData{b, 0}}
err = v.wsConn.WriteJSON(data)
if err != nil {
fmt.Println("Speaking() write json error:", err)
return
}
return
}
// ------------------------------------------------------------------------------------------------
// Code related to the Voice UDP connection
// ------------------------------------------------------------------------------------------------
type voiceUDPData struct {
Address string `json:"address"` // Public IP of machine running this code
Port uint16 `json:"port"` // UDP Port of machine running this code
Mode string `json:"mode"` // plain or ? (plain or encrypted)
}
type voiceUDPD struct {
Protocol string `json:"protocol"` // Always "udp" ?
Data voiceUDPData `json:"data"`
}
type voiceUDPOp struct {
Op int `json:"op"` // Always 1
Data voiceUDPD `json:"d"`
}
// udpOpen opens a UDP connection to the voice server and completes the
// initial required handshake. This connection is left open in the session
// and can be used to send or receive audio. This should only be called
// from voice.wsEvent OP2
func (v *Voice) udpOpen() (err error) {
host := fmt.Sprintf("%s:%d", strings.TrimSuffix(v.endpoint, ":80"), v.OP2.Port)
addr, err := net.ResolveUDPAddr("udp", host)
if err != nil {
fmt.Println("udpOpen resolve addr error: ", err)
// TODO better logging
return
}
v.UDPConn, err = net.DialUDP("udp", nil, addr)
if err != nil {
fmt.Println("udpOpen dial udp error: ", err)
// TODO better logging
return
}
// Create a 70 byte array and put the SSRC code from the Op 2 Voice event
// into it. Then send that over the UDP connection to Discord
sb := make([]byte, 70)
binary.BigEndian.PutUint32(sb, v.OP2.SSRC)
_, err = v.UDPConn.Write(sb)
if err != nil {
fmt.Println("udpOpen udp write error : ", err)
// TODO better logging
return
}
// Create a 70 byte array and listen for the initial handshake response
// from Discord. Once we get it parse the IP and PORT information out
// of the response. This should be our public IP and PORT as Discord
// saw us.
rb := make([]byte, 70)
rlen, _, err := v.UDPConn.ReadFromUDP(rb)
if err != nil {
fmt.Println("udpOpen udp read error : ", err)
// TODO better logging
return
}
if rlen < 70 {
fmt.Println("Voice RLEN should be 70 but isn't")
}
// Loop over position 4 though 20 to grab the IP address
// Should never be beyond position 20.
var ip string
for i := 4; i < 20; i++ {
if rb[i] == 0 {
break
}
ip += string(rb[i])
}
// Grab port from postion 68 and 69
port := binary.LittleEndian.Uint16(rb[68:70])
// Take the data from above and send it back to Discord to finalize
// the UDP connection handshake.
data := voiceUDPOp{1, voiceUDPD{"udp", voiceUDPData{ip, port, "plain"}}}
err = v.wsConn.WriteJSON(data)
if err != nil {
fmt.Println("udpOpen write json error:", err)
return
}
v.Ready = true
return
}
// udpKeepAlive sends a udp packet to keep the udp connection open
// This is still a bit of a "proof of concept"
func (v *Voice) udpKeepAlive(i time.Duration) {
var err error
var sequence uint64 = 0
packet := make([]byte, 8)
ticker := time.NewTicker(i)
for {
// TODO: Add a way to break from loop
binary.LittleEndian.PutUint64(packet, sequence)
sequence++
_, err = v.UDPConn.Write(packet)
if err != nil {
fmt.Println("udpKeepAlive udp write error : ", err)
return
}
<-ticker.C
}
}