looklook 0.6.0

Descriptive signal synthesiser.
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

// Copyright 2026 Gabriel Bjørnager Jensen.
//
// This file is part of LOOKLOOK.
//
// LOOKLOOK is free software: you can redistribute
// it and/or modify it under the terms of the GNU
// Affero General Public License as published by
// the Free Software Foundation, either version 3
// of the License, or (at your option) any later
// version.
//
// LOOKLOOK is distributed in the hope that it will
// be useful, but WITHOUT ANY WARRANTY; without
// even the implied warranty of MERCHANTABILITY or
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Affero General Public License for more details.
//
// You should have received a copy of the GNU Af-
// fero General Public License along with LOOKLOOK.
// If not, see <https://www.gnu.org/licenses/>.

//! The [`Signal`] type.

mod encode;
mod render;

use crate::signal::Mode;

/// A rendered signal.
#[derive(Clone, Debug)]
#[derive_const(Default)]
pub struct Signal {
	/// The render mode.
	mode: Mode,

	/// The raw signal data.
	///
	/// Note that the contents of this buffer are
	/// currently big-endian (for the sake of the
	/// emulated platform.)
	data: Vec<u8>,
}

impl Signal {
	/// Constructs a new, empty signal.
	#[inline]
	#[must_use]
	pub const fn new() -> Self {
		// NOTE: The default value for `Mode` has a render
		// size of zero, so we can just as well use a de-
		// fault vector.
		Default::default()
	}

	/// Overwrites the signal mode.
	///
	/// The signal buffer is cleared and reallocated to
	/// fit the new mode's needs.
	#[inline]
	pub fn set_mode(&mut self, mode: Mode) {
		self.mode = mode;
		let new_size = self.mode.sample_count();

		// Remember that we do not guarantee specific
		// values for existing data.
		self.data.resize(new_size, 0);
	}

	/// Borrows the mode.
	#[inline]
	#[must_use]
	pub const fn mode(&self) -> &Mode {
		&self.mode
	}

	/// Retrieves the signal size.
	///
	/// This is always equal to the value returned by
	/// [`sample_count`] when used on the current mode,
	/// although this method uses a cached value
	/// instead.
	///
	/// [`sample_count`]: Mode::sample_count
	#[inline]
	#[must_use]
	pub const fn size(&self) -> usize {
		self.data.len()
	}

	/// Tests if the signal is empty.
	#[inline]
	#[must_use]
	pub const fn is_empty(&self) -> bool {
		self.data.is_empty()
	}

	/// Borrows the raw signal data.
	///
	/// The format of the data returned by this method
	/// is unspecified.
	#[inline]
	#[must_use]
	pub const fn data(&self) -> &[u8] {
		&self.data
	}

	/// Mutably borrows the raw signal data.
	///
	/// The format of the data returned by this method
	/// is unspecified.
	#[inline]
	#[must_use]
	pub const fn data_mut(&mut self) -> &mut [u8] {
		&mut self.data
	}
}

impl Drop for Signal {
	#[inline(always)]
	fn drop(&mut self) {}
}