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 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
use crate::stream;
use crate::stream::raw::{self, Buffer, StreamError};
use crate::{Point, RawPoint};
use std::io;
use std::ops::{Deref, DerefMut};
use std::sync::{mpsc, Arc, Mutex};
use std::time::Duration;
pub use lasy::InterpolationConfig;
/// The function that will be called each time a new `Frame` is requested.
pub trait RenderFn<M>: Fn(&mut M, &mut Frame) {}
impl<M, F> RenderFn<M> for F where F: Fn(&mut M, &mut Frame) {}
/// A clone-able handle around a laser stream of frames.
pub struct Stream<M> {
// A handle to the inner raw stream that drives this frame stream.
raw: raw::Stream<M>,
// A channel over which updates to the interpolation conf can be sent.
state_update_tx: mpsc::Sender<StateUpdate>,
}
// State associated with the frame stream shared between the handle and laser stream.
#[derive(Clone)]
struct State {
frame_hz: u32,
interpolation_conf: lasy::InterpolationConfig,
enable_optimisations: bool,
enable_draw_reorder: bool,
}
// Updates for the interpolation config sent from the stream handle to the laser thread.
type StateUpdate = Box<dyn FnMut(&mut State) + 'static + Send>;
/// A wrapper around the `Vec` of points being collected for the frame.
///
/// Provides a suite of methods that ease the process of submitting points.
///
/// Segments that contain more than one blank point in a row will be considered a blank segment.
pub struct Frame {
frame_hz: u32,
point_hz: u32,
latency_points: u32,
points: Vec<Point>,
}
// A type used for requesting frames from the user and feeding them to the raw buffer.
struct Requester {
last_frame_point: Option<RawPoint>,
raw_points: Vec<RawPoint>,
blank_points: Vec<RawPoint>,
}
// The type of the default function used for the `process_raw` function if none is specified.
type DefaultProcessRawFn<M> = fn(&mut M, &mut Buffer);
/// A type allowing to build a raw laser stream.
pub struct Builder<M, F, R = DefaultProcessRawFn<M>, E = raw::DefaultStreamErrorFn<M>> {
/// The laser API inner state, used to find a DAC during `build` if one isn't specified.
pub(crate) api_inner: Arc<crate::Inner>,
pub builder: stream::Builder,
pub model: M,
pub render: F,
pub process_raw: R,
pub stream_error: E,
pub frame_hz: Option<u32>,
pub interpolation_conf: lasy::InterpolationConfig,
pub enable_optimisations: bool,
pub enable_draw_reorder: bool,
}
impl<M> Stream<M> {
/// Update the `distance_per_point` field of the interpolation configuration.
///
/// The value will be updated on the laser thread prior to requesting the next frame.
///
/// Returns an `Err` if communication with the laser thread has been closed.
pub fn set_distance_per_point(&self, d: f32) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.interpolation_conf.distance_per_point = d)
.map_err(|_| mpsc::SendError(()))
}
/// Update the `blank_delay_points` field of the interpolation configuration.
///
/// The value will be updated on the laser thread prior to requesting the next frame.
///
/// Returns an `Err` if communication with the laser thread has been closed.
pub fn set_blank_delay_points(&self, ps: u32) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.interpolation_conf.blank_delay_points = ps)
.map_err(|_| mpsc::SendError(()))
}
/// Update the `radians_per_point` field of the interpolation configuration.
///
/// The value will be updated on the laser thread prior to requesting the next frame.
///
/// Returns an `Err` if communication with the laser thread has been closed.
pub fn set_radians_per_point(&self, rad: f32) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.interpolation_conf.radians_per_point = rad)
.map_err(|_| mpsc::SendError(()))
}
/// Update the rate at which the stream will attempt to present images via the DAC.
///
/// The value will be updated on the laser thread prior to requesting the next frame.
///
/// Returns an `Err` if communication with the laser thread has been closed.
pub fn set_frame_hz(&self, fps: u32) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.frame_hz = fps)
.map_err(|_| mpsc::SendError(()))
}
/// Update whether or not frame optimisations and interpolation should be enabled.
pub fn enable_optimisations(&self, enabled: bool) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.enable_optimisations = enabled)
.map_err(|_| mpsc::SendError(()))
}
/// Update whether or not draw path reordering is enabled.
///
/// When `true`, the optimisation pass will attempt to find a more optimal path for the drawing
/// of each line segment before performing interpolation.
///
/// When `false`, the draw order will follow the order in which segments were submitted via the
/// `Frame`.
///
/// By default, this value is `true`.
pub fn enable_draw_reorder(&self, enabled: bool) -> Result<(), mpsc::SendError<()>> {
self.send_frame_state_update(move |state| state.enable_draw_reorder = enabled)
.map_err(|_| mpsc::SendError(()))
}
/// Close the TCP communication thread and wait for the thread to join.
///
/// This consumes and drops the `Stream`, returning the result produced by joining the thread.
///
/// This method will block until the associated thread has been joined.
///
/// If the thread has already been closed by another handle to the stream, this will return
/// `None`.
pub fn close(self) -> Option<std::thread::Result<Result<(), StreamError>>> {
let Stream { raw, .. } = self;
raw.close()
}
// Simplify sending a `StateUpdate` to the laser thread.
fn send_frame_state_update<F>(&self, update: F) -> Result<(), mpsc::SendError<StateUpdate>>
where
F: FnOnce(&mut State) + Send + 'static,
{
let mut update_opt = Some(update);
let update_fn = move |state: &mut State| {
if let Some(update) = update_opt.take() {
update(state);
}
};
self.state_update_tx.send(Box::new(update_fn))
}
}
impl<M, F, R, E> Builder<M, F, R, E> {
/// The DAC with which the stream should be established.
pub fn detected_dac(mut self, dac: crate::DetectedDac) -> Self {
self.builder.dac = Some(dac);
self
}
/// The duration before TCP connection or communication attempts will time out.
///
/// If this value is `None` (the default case), no timeout will be applied and the stream will
/// wait forever.
pub fn tcp_timeout(mut self, tcp_timeout: Option<Duration>) -> Self {
self.builder.tcp_timeout = tcp_timeout;
self
}
/// The initial rate at which the DAC should process points per second.
///
/// This value should be no greater than the detected DAC's `max_point_hz`.
///
/// By default this value is `stream::DEFAULT_POINT_HZ`.
pub fn point_hz(mut self, point_hz: u32) -> Self {
self.builder.point_hz = Some(point_hz);
self
}
/// The initial rate at which the DAC should output frames per second.
///
/// This in combination with the `point_hz` is used to determine the `points_per_frame`. Frames
/// yielded by the user will be interpolated so that they always use exactly `points_per_frame`
/// number of points per frame.
///
/// By default, this value is `stream::DEFAULT_FRAME_HZ`.
///
/// This parameter is only meaningful while optimisations are enabled (the default). This is
/// because we may only target the frame rate by re-interpolating the desired path, and we may
/// only re-interpolate the desired path if we have the euler circuit describing the path which
/// is produced during the optimisation pass.
pub fn frame_hz(mut self, frame_hz: u32) -> Self {
self.frame_hz = Some(frame_hz);
self
}
/// The maximum latency specified as a number of points.
///
/// Each time the laser indicates its "fullness", the raw stream will request enough points
/// from the render function to fill the DAC buffer up to `latency_points`.
pub fn latency_points(mut self, points: u32) -> Self {
self.builder.latency_points = Some(points);
self
}
/// The minimum distance the interpolator can travel along an edge before a new point is
/// required.
///
/// By default, this value is `InterpolationConfig::DEFAULT_DISTANCE_PER_POINT`.
///
/// This parameter is only meaningful while optimisations are enabled (the default).
pub fn distance_per_point(mut self, dpp: f32) -> Self {
self.interpolation_conf.distance_per_point = dpp;
self
}
/// The number of points to insert at the end of a blank to account for light modulator delay.
///
/// By default, this value is `InterpolationConfig::DEFAULT_BLANK_DELAY_POINTS`.
///
/// This parameter is only meaningful while optimisations are enabled (the default).
pub fn blank_delay_points(mut self, points: u32) -> Self {
self.interpolation_conf.blank_delay_points = points;
self
}
/// The amount of delay to add based on the angle of the corner in radians.
///
/// By default, this value is `InterpolationConfig::DEFAULT_RADIANS_PER_POINT`.
///
/// This parameter is only meaningful while optimisations are enabled (the default).
pub fn radians_per_point(mut self, radians: f32) -> Self {
self.interpolation_conf.radians_per_point = radians;
self
}
/// Whether or not to enable the optimisations.
///
/// By default, this value is `true`.
pub fn enable_optimisations(mut self, enable: bool) -> Self {
self.enable_optimisations = enable;
self
}
/// Whether or not draw path reordering is enabled.
///
/// When `true`, the optimisation pass will attempt to find a more optimal path for the drawing
/// of each line segment before performing interpolation. This is only applied if
/// `enable_optimisations` is also `true`.
///
/// When `false`, the draw order will follow the order in which segments were submitted via the
/// `Frame`.
///
/// By default, this value is `true`.
pub fn enable_draw_reorder(mut self, enable: bool) -> Self {
self.enable_draw_reorder = enable;
self
}
/// Specify a function that allows for processing the raw points before submission to the DAC.
///
/// This might be useful for:
///
/// - applying post-processing effects onto the optimised, interpolated points.
/// - monitoring the raw points resulting from the optimisation and interpolation processes.
/// - tuning brightness of colours based on safety zones.
///
/// The given function will get called right before submission of the optimised, interpolated
/// buffer.
pub fn process_raw<R2>(self, process_raw: R2) -> Builder<M, F, R2, E> {
let Builder {
api_inner,
builder,
model,
render,
stream_error,
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
..
} = self;
Builder {
api_inner,
builder,
model,
render,
process_raw,
stream_error,
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
}
}
/// Specify a function that allows for handling errors that occur on the TCP stream thread.
///
/// If this method is not called, the `stream::raw::default_stream_error_fn` is used by default.
pub fn stream_error<E2>(self, stream_error: E2) -> Builder<M, F, R, E2> {
let Builder {
api_inner,
builder,
model,
render,
process_raw,
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
..
} = self;
Builder {
api_inner,
builder,
model,
render,
process_raw,
stream_error,
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
}
}
/// Build the stream with the specified parameters.
///
/// **Note:** If no `dac` was specified, this will method will block until a DAC is detected.
/// The first detected DAC is the DAC with which a stream will be established.
pub fn build(self) -> io::Result<Stream<M>>
where
M: 'static + Send,
F: 'static + RenderFn<M> + Send,
R: 'static + raw::RenderFn<M> + Send,
E: 'static + raw::StreamErrorFn<M> + Send,
{
let Builder {
api_inner,
builder,
model,
render,
process_raw,
stream_error,
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
} = self;
// Retrieve the frame rate to initialise the stream with.
let frame_hz = frame_hz.unwrap_or(stream::DEFAULT_FRAME_HZ);
// The type used for buffering frames and using them to serve points to the raw stream.
let requester = Requester {
last_frame_point: None,
raw_points: vec![],
blank_points: vec![],
};
let requester = Arc::new(Mutex::new(requester));
// A channel for updating the interpolation config.
let (state_update_tx, state_update_rx) = mpsc::channel();
let state_update_tx: mpsc::Sender<StateUpdate> = state_update_tx;
// State to live on the stream thread.
let state = Arc::new(Mutex::new(State {
frame_hz,
interpolation_conf,
enable_optimisations,
enable_draw_reorder,
}));
// A render function for the inner raw stream.
let raw_render = move |model: &mut M, buffer: &mut Buffer| {
// Check for updates and retrieve a copy of the state.
let state = {
let mut state = state.lock().expect("failed to lock");
for mut state_update in state_update_rx.try_iter() {
(*state_update)(&mut state);
}
state.clone()
};
let mut guard = requester.lock().expect("failed to lock frame requester");
guard.fill_buffer(model, &render, buffer, &state);
process_raw(model, buffer);
};
// Create the raw builder and build the raw stream.
let raw_builder = raw::Builder {
api_inner,
builder,
model,
render: raw_render,
stream_error,
};
let raw_stream = raw_builder.build()?;
let stream = Stream {
raw: raw_stream,
state_update_tx,
};
Ok(stream)
}
}
impl Frame {
/// The rate at which frames of points will be emitted by the DAC.
pub fn frame_hz(&self) -> u32 {
self.frame_hz
}
/// The rate at which these points will be emitted by the DAC.
pub fn point_hz(&self) -> u32 {
self.point_hz
}
/// The maximum number of points with which to fill the DAC's buffer.
pub fn latency_points(&self) -> u32 {
self.latency_points
}
/// The number of points emitted by the DAC per frame.
pub fn points_per_frame(&self) -> u32 {
self.point_hz / self.frame_hz
}
/// Add a sequence of consecutive points separated by blank space.
///
/// If some points already exist in the frame, this method will create a blank segment between
/// the previous point and the first point before appending this sequence.
pub fn add_points<I>(&mut self, points: I)
where
I: IntoIterator,
I::Item: AsRef<Point>,
{
for p in points {
let p = *p.as_ref();
self.add_lines([p, p].iter().cloned());
}
}
/// Add a sequence of consecutive lines.
///
/// If some points already exist in the frame, this method will create a blank segment between
/// the previous point and the first point before appending this sequence.
pub fn add_lines<I>(&mut self, points: I)
where
I: IntoIterator,
I::Item: AsRef<Point>,
{
let mut points = points.into_iter();
if let Some(&last) = self.points.last() {
if let Some(next) = points.next() {
let next = next.as_ref();
self.points.push(last.blanked());
self.points.push(next.blanked());
self.points.push(*next);
}
}
self.points.extend(points.map(|p| p.as_ref().clone()));
}
}
impl Requester {
// Fill the given buffer by requesting frames from the given user `render` function as
// required.
fn fill_buffer<M, F>(&mut self, model: &mut M, render: F, buffer: &mut Buffer, state: &State)
where
F: RenderFn<M>,
{
// If the frame rate is `0`, leave the buffer empty.
if state.frame_hz == 0 {
return;
}
// If the buffer has no points, there's nothing to fill.
if buffer.is_empty() {
return;
}
// The number of points to generate per frame.
let point_hz = buffer.point_hz();
let latency_points = buffer.latency_points();
// The starting index of the buffer we'll write to.
let mut start = 0;
// If there are still un-read points, use those first.
if !self.raw_points.is_empty() {
// If the pending range would not fill the buffer, write what we can.
if self.raw_points.len() < buffer.len() {
start = self.raw_points.len();
buffer[..start].copy_from_slice(&self.raw_points);
self.raw_points.clear();
// If we have the exact number of frames as output, write them and return.
} else if self.raw_points.len() == buffer.len() {
buffer.copy_from_slice(&self.raw_points);
self.raw_points.clear();
return;
// If we have too many points, write what we can and leave the rest.
} else {
let end = buffer.len();
buffer.copy_from_slice(&self.raw_points[..end]);
self.raw_points.drain(0..end);
return;
}
}
// The number of points to fill for each frame.
let points_per_frame = point_hz / state.frame_hz;
// If we reached this point, `self.raw_points` is empty so we should fill buffer with
// frames until it is full.
loop {
// See how many points are left to fill.
let num_points_remaining = buffer.len() - start;
// Determine how many points to fill this pass.
let num_points_to_fill = std::cmp::min(points_per_frame as usize, num_points_remaining);
// Render a frame of points.
let mut frame = Frame {
point_hz,
latency_points,
frame_hz: state.frame_hz,
points: vec![], // TODO: Reuse this buffer rather than allocating every loop.
};
render(model, &mut frame);
if state.enable_optimisations {
// If we were given no points, the user must be expecting an empty frame.
if frame.points.is_empty() {
let blank_point = self
.last_frame_point
.map(|p| p.blanked())
.unwrap_or_else(RawPoint::centered_blank);
self.raw_points
.extend((0..points_per_frame).map(|_| blank_point));
// Otherwise, we'll optimise and interpolate the given points.
} else {
// Apply draw path reordering if enabled.
let segs: Vec<lasy::Segment> = if state.enable_draw_reorder {
let segs = lasy::points_to_segments(frame.iter().cloned());
let pg = lasy::segments_to_point_graph(&frame, segs);
let eg = lasy::point_graph_to_euler_graph(&pg);
let ec = lasy::euler_graph_to_euler_circuit(&frame, &eg);
lasy::euler_circuit_to_segments(&ec, &eg).collect()
} else {
lasy::points_to_segments(frame.iter().cloned()).collect()
};
// Blank from last point of the previous frame to first point of this one.
let last_frame_point = self.last_frame_point.take();
let next_frame_first = segs.first().map(|seg| frame[seg.start as usize]);
// Retrieve the points necessary for blanking from the prev frame to the next.
inter_frame_blank_points(
last_frame_point,
next_frame_first,
state.interpolation_conf.blank_delay_points,
&mut self.blank_points,
);
// Subtract the inter-frame blank points from points per frame to maintain frame_hz.
let inter_frame_point_count = self.blank_points.len() as u32;
let target_points = if points_per_frame > inter_frame_point_count {
points_per_frame - inter_frame_point_count
} else {
0
};
// Join the inter-frame points with the interpolated frame.
let interp_conf = &state.interpolation_conf;
let mut interpolated = vec![];
lasy::interpolate_path(
&frame,
segs,
target_points,
interp_conf,
&mut interpolated,
);
// If the interpolated frame is empty there were no lit points or lines.
// In this case, we'll produce an empty frame.
if interpolated.is_empty() {
let blank_point = self
.blank_points
.last()
.map(|&p| p)
.or_else(|| last_frame_point.map(|p| p.blanked()))
.unwrap_or_else(RawPoint::centered_blank);
interpolated.extend((0..target_points).map(|_| blank_point));
}
self.raw_points.extend(self.blank_points.drain(..));
self.raw_points.extend(interpolated);
}
// Otherwise if optimisations are disabled, blank and then insert the points directly.
} else {
// Blank from last point of the previous frame to first point of this one.
let last_frame_point = self.last_frame_point.take();
let next_frame_first = frame.iter().cloned().next();
// Retrieve the points necessary for blanking from the prev frame to the next.
inter_frame_blank_points(
last_frame_point,
next_frame_first,
state.interpolation_conf.blank_delay_points,
&mut self.blank_points,
);
// Flatten the weighted frame points into raw points.
let frame_points = frame
.iter()
.flat_map(|pt| Some(pt.to_raw()).into_iter().chain(pt.to_raw_weighted()));
self.raw_points.extend(self.blank_points.drain(..));
self.raw_points.extend(frame_points);
}
// Update the last frame point.
self.last_frame_point = self.raw_points.last().map(|&p| p);
// Write the points to buffer.
let end = start + std::cmp::min(num_points_to_fill, self.raw_points.len());
let range = start..end;
buffer[range.clone()].copy_from_slice(&self.raw_points[..range.len()]);
self.raw_points.drain(..range.len());
// If this output filled the buffer, break.
if end == buffer.len() {
break;
}
// Continue looping through the next frames.
start = end;
}
}
}
impl Deref for Frame {
type Target = Vec<Point>;
fn deref(&self) -> &Self::Target {
&self.points
}
}
impl DerefMut for Frame {
fn deref_mut(&mut self) -> &mut Self::Target {
&mut self.points
}
}
impl<M> Deref for Stream<M> {
type Target = raw::Stream<M>;
fn deref(&self) -> &Self::Target {
&self.raw
}
}
// Given the last point of the previous frame and the first of the next, produce
// the points necessary to blank from one to the other.
//
// Clears the given `points` before appending the blank points if any.
fn inter_frame_blank_points(
last: Option<RawPoint>,
next: Option<Point>,
blank_delay_points: u32,
points: &mut Vec<RawPoint>,
) {
points.clear();
let (last, next) = match (last, next) {
(Some(l), Some(n)) => (l, n),
_ => return,
};
if last.position == next.position {
return;
}
let a = last.blanked().with_weight(0);
let b = next.to_raw().blanked();
points.extend(lasy::blank_segment_points(a, b, blank_delay_points));
}
// The default function used for the `process_raw` function if none is specified.
pub(crate) fn default_process_raw_fn<M>(_model: &mut M, _buffer: &mut Buffer) {}