forked from alvr-org/ALVR
/
connection.rs
551 lines (475 loc) · 19.2 KB
/
connection.rs
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
#![allow(clippy::if_same_then_else)]
use crate::{
decoder::{self, DECODER_INIT_CONFIG},
logging_backend::{LogMirrorData, LOG_CHANNEL_SENDER},
platform,
sockets::AnnouncerSocket,
statistics::StatisticsManager,
storage::Config,
ClientCoreEvent, EVENT_QUEUE, LIFECYCLE_STATE, STATISTICS_MANAGER,
};
use alvr_audio::AudioDevice;
use alvr_common::{
debug, error,
glam::UVec2,
info,
once_cell::sync::Lazy,
parking_lot::{Condvar, RwLock},
wait_rwlock, warn, AnyhowToCon, ConResult, ConnectionError, ConnectionState, LifecycleState,
OptLazy, ToCon, ALVR_VERSION,
};
use alvr_packets::{
ClientConnectionResult, ClientControlPacket, ClientStatistics, Haptics, ServerControlPacket,
StreamConfigPacket, Tracking, VideoPacketHeader, VideoStreamingCapabilities, AUDIO, HAPTICS,
STATISTICS, TRACKING, VIDEO,
};
use alvr_session::{settings_schema::Switch, SessionConfig};
use alvr_sockets::{
ControlSocketSender, PeerType, ProtoControlSocket, StreamSender, StreamSocketBuilder,
KEEPALIVE_INTERVAL, KEEPALIVE_TIMEOUT,
};
use serde_json as json;
use std::{
collections::HashMap,
sync::{mpsc, Arc},
thread,
time::{Duration, Instant},
};
#[cfg(target_os = "android")]
use crate::audio;
#[cfg(not(target_os = "android"))]
use alvr_audio as audio;
const INITIAL_MESSAGE: &str = concat!(
"Searching for streamer...\n",
"Open ALVR on your PC then click \"Trust\"\n",
"next to the client entry",
);
const NETWORK_UNREACHABLE_MESSAGE: &str = "Cannot connect to the internet";
// const INCOMPATIBLE_VERSIONS_MESSAGE: &str = concat!(
// "Streamer and client have\n",
// "incompatible types.\n",
// "Please update either the app\n",
// "on the PC or on the headset",
// );
const STREAM_STARTING_MESSAGE: &str = "The stream will begin soon\nPlease wait...";
const SERVER_RESTART_MESSAGE: &str = "The streamer is restarting\nPlease wait...";
const SERVER_DISCONNECTED_MESSAGE: &str = "The streamer has disconnected.";
const CONNECTION_TIMEOUT_MESSAGE: &str = "Connection timeout.";
const DISCOVERY_RETRY_PAUSE: Duration = Duration::from_millis(500);
const RETRY_CONNECT_MIN_INTERVAL: Duration = Duration::from_secs(1);
const CONNECTION_RETRY_INTERVAL: Duration = Duration::from_secs(1);
const HANDSHAKE_ACTION_TIMEOUT: Duration = Duration::from_secs(2);
const STREAMING_RECV_TIMEOUT: Duration = Duration::from_millis(500);
const MAX_UNREAD_PACKETS: usize = 10; // Applies per stream
pub static CONNECTION_STATE: Lazy<Arc<RwLock<ConnectionState>>> =
Lazy::new(|| Arc::new(RwLock::new(ConnectionState::Disconnected)));
pub static DISCONNECTED_NOTIF: Condvar = Condvar::new();
pub static CONTROL_SENDER: OptLazy<ControlSocketSender<ClientControlPacket>> =
alvr_common::lazy_mut_none();
pub static TRACKING_SENDER: OptLazy<StreamSender<Tracking>> = alvr_common::lazy_mut_none();
pub static STATISTICS_SENDER: OptLazy<StreamSender<ClientStatistics>> =
alvr_common::lazy_mut_none();
fn set_hud_message(message: &str) {
let message = format!(
"ALVR v{}\nhostname: {}\nIP: {}\n\n{message}",
*ALVR_VERSION,
Config::load().hostname,
platform::local_ip(),
);
EVENT_QUEUE
.lock()
.push_back(ClientCoreEvent::UpdateHudMessage(message));
}
fn is_streaming() -> bool {
*CONNECTION_STATE.read() == ConnectionState::Streaming
}
pub fn connection_lifecycle_loop(
recommended_view_resolution: UVec2,
supported_refresh_rates: Vec<f32>,
) {
set_hud_message(INITIAL_MESSAGE);
while *LIFECYCLE_STATE.read() != LifecycleState::ShuttingDown {
if *LIFECYCLE_STATE.read() == LifecycleState::Resumed {
if let Err(e) =
connection_pipeline(recommended_view_resolution, supported_refresh_rates.clone())
{
let message = format!("Connection error:\n{e}\nCheck the PC for more details");
set_hud_message(&message);
error!("Connection error: {e}");
}
} else {
debug!("Skip try connection because the device is sleeping");
}
*CONNECTION_STATE.write() = ConnectionState::Disconnected;
DISCONNECTED_NOTIF.notify_all();
thread::sleep(CONNECTION_RETRY_INTERVAL);
}
}
fn connection_pipeline(
recommended_view_resolution: UVec2,
supported_refresh_rates: Vec<f32>,
) -> ConResult {
let (mut proto_control_socket, server_ip) = {
let config = Config::load();
let announcer_socket = AnnouncerSocket::new(&config.hostname).to_con()?;
let listener_socket =
alvr_sockets::get_server_listener(HANDSHAKE_ACTION_TIMEOUT).to_con()?;
loop {
if *LIFECYCLE_STATE.write() != LifecycleState::Resumed {
return Ok(());
}
if let Err(e) = announcer_socket.broadcast() {
warn!("Broadcast error: {e:?}");
set_hud_message(NETWORK_UNREACHABLE_MESSAGE);
thread::sleep(RETRY_CONNECT_MIN_INTERVAL);
set_hud_message(INITIAL_MESSAGE);
return Ok(());
}
if let Ok(pair) = ProtoControlSocket::connect_to(
DISCOVERY_RETRY_PAUSE,
PeerType::Server(&listener_socket),
) {
break pair;
}
}
};
let mut connection_state_lock = CONNECTION_STATE.write();
let disconnect_notif = Arc::new(Condvar::new());
*connection_state_lock = ConnectionState::Connecting;
let microphone_sample_rate = AudioDevice::new_input(None)
.unwrap()
.input_sample_rate()
.unwrap();
proto_control_socket
.send(&ClientConnectionResult::ConnectionAccepted {
client_protocol_id: alvr_common::protocol_id(),
display_name: platform::device_model(),
server_ip,
streaming_capabilities: Some(VideoStreamingCapabilities {
default_view_resolution: recommended_view_resolution,
supported_refresh_rates,
microphone_sample_rate,
}),
})
.to_con()?;
let config_packet =
proto_control_socket.recv::<StreamConfigPacket>(HANDSHAKE_ACTION_TIMEOUT)?;
let settings = {
let mut session_desc = SessionConfig::default();
session_desc
.merge_from_json(&json::from_str(&config_packet.session).to_con()?)
.to_con()?;
session_desc.to_settings()
};
let negotiated_config =
json::from_str::<HashMap<String, json::Value>>(&config_packet.negotiated).to_con()?;
let view_resolution = negotiated_config
.get("view_resolution")
.and_then(|v| json::from_value(v.clone()).ok())
.unwrap_or(UVec2::ZERO);
let refresh_rate_hint = negotiated_config
.get("refresh_rate_hint")
.and_then(|v| v.as_f64())
.unwrap_or(60.0) as f32;
let game_audio_sample_rate = negotiated_config
.get("game_audio_sample_rate")
.and_then(|v| v.as_u64())
.unwrap_or(44100) as u32;
let streaming_start_event = ClientCoreEvent::StreamingStarted {
view_resolution,
refresh_rate_hint,
settings: Box::new(settings.clone()),
};
*STATISTICS_MANAGER.lock() = Some(StatisticsManager::new(
settings.connection.statistics_history_size,
Duration::from_secs_f32(1.0 / refresh_rate_hint),
if let Switch::Enabled(config) = settings.headset.controllers {
config.steamvr_pipeline_frames
} else {
0.0
},
));
let (mut control_sender, mut control_receiver) = proto_control_socket
.split(STREAMING_RECV_TIMEOUT)
.to_con()?;
match control_receiver.recv(HANDSHAKE_ACTION_TIMEOUT) {
Ok(ServerControlPacket::StartStream) => {
info!("Stream starting");
set_hud_message(STREAM_STARTING_MESSAGE);
}
Ok(ServerControlPacket::Restarting) => {
info!("Server restarting");
set_hud_message(SERVER_RESTART_MESSAGE);
return Ok(());
}
Err(e) => {
info!("Server disconnected. Cause: {e}");
set_hud_message(SERVER_DISCONNECTED_MESSAGE);
return Ok(());
}
_ => {
info!("Unexpected packet");
set_hud_message("Unexpected packet");
return Ok(());
}
}
let stream_socket_builder = StreamSocketBuilder::listen_for_server(
Duration::from_secs(1),
settings.connection.stream_port,
settings.connection.stream_protocol,
settings.connection.client_send_buffer_bytes,
settings.connection.client_recv_buffer_bytes,
)
.to_con()?;
if let Err(e) = control_sender.send(&ClientControlPacket::StreamReady) {
info!("Server disconnected. Cause: {e:?}");
set_hud_message(SERVER_DISCONNECTED_MESSAGE);
return Ok(());
}
let mut stream_socket = stream_socket_builder.accept_from_server(
server_ip,
settings.connection.stream_port,
settings.connection.packet_size as _,
HANDSHAKE_ACTION_TIMEOUT,
)?;
info!("Connected to server");
{
let config = &mut *DECODER_INIT_CONFIG.lock();
config.max_buffering_frames = settings.video.max_buffering_frames;
config.buffering_history_weight = settings.video.buffering_history_weight;
config.options = settings.video.mediacodec_extra_options;
}
let mut video_receiver =
stream_socket.subscribe_to_stream::<VideoPacketHeader>(VIDEO, MAX_UNREAD_PACKETS);
let mut game_audio_receiver = stream_socket.subscribe_to_stream(AUDIO, MAX_UNREAD_PACKETS);
let tracking_sender = stream_socket.request_stream(TRACKING);
let mut haptics_receiver =
stream_socket.subscribe_to_stream::<Haptics>(HAPTICS, MAX_UNREAD_PACKETS);
let statistics_sender = stream_socket.request_stream(STATISTICS);
let video_receive_thread = thread::spawn(move || {
let mut stream_corrupted = false;
while is_streaming() {
let data = match video_receiver.recv(STREAMING_RECV_TIMEOUT) {
Ok(data) => data,
Err(ConnectionError::TryAgain(_)) => continue,
Err(ConnectionError::Other(_)) => return,
};
let Ok((header, nal)) = data.get() else {
return;
};
if let Some(stats) = &mut *STATISTICS_MANAGER.lock() {
stats.report_video_packet_received(header.timestamp);
}
if header.is_idr {
stream_corrupted = false;
} else if data.had_packet_loss() {
stream_corrupted = true;
if let Some(sender) = &mut *CONTROL_SENDER.lock() {
sender.send(&ClientControlPacket::RequestIdr).ok();
}
warn!("Network dropped video packet");
}
if !stream_corrupted || !settings.connection.avoid_video_glitching {
if !decoder::push_nal(header.timestamp, nal) {
stream_corrupted = true;
if let Some(sender) = &mut *CONTROL_SENDER.lock() {
sender.send(&ClientControlPacket::RequestIdr).ok();
}
warn!("Dropped video packet. Reason: Decoder saturation")
}
} else {
if let Some(sender) = &mut *CONTROL_SENDER.lock() {
sender.send(&ClientControlPacket::RequestIdr).ok();
}
warn!("Dropped video packet. Reason: Waiting for IDR frame")
}
}
});
let game_audio_thread = if let Switch::Enabled(config) = settings.audio.game_audio {
let device = AudioDevice::new_output(None, None).to_con()?;
thread::spawn(move || {
while is_streaming() {
alvr_common::show_err(audio::play_audio_loop(
is_streaming,
&device,
2,
game_audio_sample_rate,
config.buffering.clone(),
&mut game_audio_receiver,
));
}
})
} else {
thread::spawn(|| ())
};
let microphone_thread = if matches!(settings.audio.microphone, Switch::Enabled(_)) {
let device = AudioDevice::new_input(None).to_con()?;
let microphone_sender = stream_socket.request_stream(AUDIO);
thread::spawn(move || {
while is_streaming() {
match audio::record_audio_blocking(
Arc::new(is_streaming),
microphone_sender.clone(),
&device,
1,
false,
) {
Ok(()) => break,
Err(e) => {
error!("Audio record error: {e}");
continue;
}
}
}
})
} else {
thread::spawn(|| ())
};
let haptics_receive_thread = thread::spawn(move || {
while is_streaming() {
let data = match haptics_receiver.recv(STREAMING_RECV_TIMEOUT) {
Ok(packet) => packet,
Err(ConnectionError::TryAgain(_)) => continue,
Err(ConnectionError::Other(_)) => return,
};
let Ok(haptics) = data.get_header() else {
return;
};
EVENT_QUEUE.lock().push_back(ClientCoreEvent::Haptics {
device_id: haptics.device_id,
duration: haptics.duration,
frequency: haptics.frequency,
amplitude: haptics.amplitude,
});
}
});
let (log_channel_sender, log_channel_receiver) = mpsc::channel();
let control_send_thread = thread::spawn({
let disconnect_notif = Arc::clone(&disconnect_notif);
move || {
let mut keepalive_deadline = Instant::now();
#[cfg(target_os = "android")]
let mut battery_deadline = Instant::now();
while is_streaming() && *LIFECYCLE_STATE.read() == LifecycleState::Resumed {
if let (Ok(packet), Some(sender)) = (
log_channel_receiver.recv_timeout(STREAMING_RECV_TIMEOUT),
&mut *CONTROL_SENDER.lock(),
) {
if let Err(e) = sender.send(&packet) {
info!("Server disconnected. Cause: {e:?}");
set_hud_message(SERVER_DISCONNECTED_MESSAGE);
break;
}
}
if Instant::now() > keepalive_deadline {
if let Some(sender) = &mut *CONTROL_SENDER.lock() {
sender.send(&ClientControlPacket::KeepAlive).ok();
keepalive_deadline = Instant::now() + KEEPALIVE_INTERVAL;
}
}
#[cfg(target_os = "android")]
if Instant::now() > battery_deadline {
let (gauge_value, is_plugged) = platform::get_battery_status();
if let Some(sender) = &mut *CONTROL_SENDER.lock() {
sender
.send(&ClientControlPacket::Battery(crate::BatteryPacket {
device_id: *alvr_common::HEAD_ID,
gauge_value,
is_plugged,
}))
.ok();
}
battery_deadline = Instant::now() + Duration::from_secs(5);
}
}
disconnect_notif.notify_one();
}
});
let control_receive_thread = thread::spawn({
let disconnect_notif = Arc::clone(&disconnect_notif);
move || {
let mut disconnection_deadline = Instant::now() + KEEPALIVE_TIMEOUT;
while is_streaming() {
let maybe_packet = control_receiver.recv(STREAMING_RECV_TIMEOUT);
match maybe_packet {
Ok(ServerControlPacket::InitializeDecoder(config)) => {
decoder::create_decoder(config, settings.video.force_software_decoder);
}
Ok(ServerControlPacket::Restarting) => {
info!("{SERVER_RESTART_MESSAGE}");
set_hud_message(SERVER_RESTART_MESSAGE);
disconnect_notif.notify_one();
}
Ok(_) => (),
Err(ConnectionError::TryAgain(_)) => {
if Instant::now() > disconnection_deadline {
info!("{CONNECTION_TIMEOUT_MESSAGE}");
set_hud_message(CONNECTION_TIMEOUT_MESSAGE);
disconnect_notif.notify_one();
} else {
continue;
}
}
Err(e) => {
info!("{SERVER_DISCONNECTED_MESSAGE} Cause: {e}");
set_hud_message(SERVER_DISCONNECTED_MESSAGE);
disconnect_notif.notify_one();
}
}
disconnection_deadline = Instant::now() + KEEPALIVE_TIMEOUT;
}
}
});
let stream_receive_thread = thread::spawn({
let disconnect_notif = Arc::clone(&disconnect_notif);
move || {
while is_streaming() {
match stream_socket.recv() {
Ok(()) => (),
Err(ConnectionError::TryAgain(_)) => continue,
Err(e) => {
info!("Client disconnected. Cause: {e}");
set_hud_message(SERVER_DISCONNECTED_MESSAGE);
disconnect_notif.notify_one();
}
}
}
}
});
*CONTROL_SENDER.lock() = Some(control_sender);
*TRACKING_SENDER.lock() = Some(tracking_sender);
*STATISTICS_SENDER.lock() = Some(statistics_sender);
if let Switch::Enabled(filter_level) = settings.logging.client_log_report_level {
*LOG_CHANNEL_SENDER.lock() = Some(LogMirrorData {
sender: log_channel_sender,
filter_level,
});
}
EVENT_QUEUE.lock().push_back(streaming_start_event);
*connection_state_lock = ConnectionState::Streaming;
// Unlock CONNECTION_STATE and block thread
wait_rwlock(&disconnect_notif, &mut connection_state_lock);
*connection_state_lock = ConnectionState::Disconnecting;
*CONTROL_SENDER.lock() = None;
*TRACKING_SENDER.lock() = None;
*STATISTICS_SENDER.lock() = None;
*LOG_CHANNEL_SENDER.lock() = None;
EVENT_QUEUE
.lock()
.push_back(ClientCoreEvent::StreamingStopped);
#[cfg(target_os = "android")]
{
*crate::decoder::DECODER_SINK.lock() = None;
*crate::decoder::DECODER_SOURCE.lock() = None;
}
// Remove lock to allow threads to properly exit:
drop(connection_state_lock);
video_receive_thread.join().ok();
game_audio_thread.join().ok();
microphone_thread.join().ok();
haptics_receive_thread.join().ok();
control_send_thread.join().ok();
control_receive_thread.join().ok();
stream_receive_thread.join().ok();
Ok(())
}