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
|
"""
This module provides a traceset implementation based on Riscure's Inspector traceset format (`.trs`).
"""
import struct
from enum import IntEnum
from io import BytesIO, RawIOBase, BufferedIOBase, UnsupportedOperation
from pathlib import Path
from typing import Union, Optional, BinaryIO
import numpy as np
from public import public
from .base import TraceSet
from ..trace import Trace
@public
class SampleCoding(IntEnum):
Int8 = 0x01
Int16 = 0x02
Int32 = 0x04
Float8 = 0x11
Float16 = 0x12
Float32 = 0x14
def dtype(self):
char = "f" if self.value & 0x10 else "i"
return np.dtype("<{}{}".format(char, self.value & 0x0f))
@public
class Parsers(object):
@staticmethod
def read_int(bytes):
return int.from_bytes(bytes, byteorder="little")
@staticmethod
def read_bool(bytes):
return Parsers.read_int(bytes) == 1
@staticmethod
def read_float(bytes):
return struct.unpack("<f", bytes)[0]
@staticmethod
def read_str(bytes):
return bytes.decode("ascii")
@staticmethod
def write_int(i, length=1):
return int.to_bytes(i, length=length, byteorder="little")
@staticmethod
def write_bool(b, length=1):
return Parsers.write_int(b, length=length)
@staticmethod
def write_float(f, length=None):
return struct.pack("<{}".format("e" if length == 2 else "f"), f)
@staticmethod
def write_str(s, length=None):
return s.encode("ascii")
@public
class InspectorTraceSet(TraceSet):
"""Riscure Inspector trace set format (.trs)."""
num_traces: int
num_samples: int
sample_coding: SampleCoding
data_space: int = 0
title_space: int = 0
global_title: str = "title"
description: Optional[str] = None
x_offset: int = 0
x_label: Optional[str] = None
y_label: Optional[str] = None
x_scale: float = 1
y_scale: float = 1
trace_offset: int = 0
log_scale: int = 0
scope_range: float = 0
scope_coupling: int = 0
scope_offset: float = 0
scope_impedance: float = 0
scope_id: Optional[str] = None
filter_type: int = 0
filter_frequency: float = 0
filter_range: float = 0
external_clock: bool = False
external_clock_threshold: float = 0
external_clock_multiplier: int = 0
external_clock_phase_shift: int = 0
external_clock_resampler_mask: int = 0
external_clock_resampler_enabled: bool = False
external_clock_frequencty: float = 0
external_clock_time_base: int = 0
_tag_parsers: dict = {
0x41: ("num_traces", 4, Parsers.read_int, Parsers.write_int),
0x42: ("num_samples", 4, Parsers.read_int, Parsers.write_int),
0x43: ("sample_coding", 1,
lambda bytes: SampleCoding(Parsers.read_int(bytes)),
lambda coding, length: Parsers.write_int(coding.value,
length=length)),
0x44: ("data_space", 2, Parsers.read_int, Parsers.write_int),
0x45: ("title_space", 1, Parsers.read_int, Parsers.write_int),
0x46: ("global_title", None, Parsers.read_str, Parsers.write_str),
0x47: ("description", None, Parsers.read_str, Parsers.write_str),
0x48: ("x_offset", None, Parsers.read_int, Parsers.write_int),
0x49: ("x_label", None, Parsers.read_str, Parsers.write_str),
0x4a: ("y_label", None, Parsers.read_str, Parsers.write_str),
0x4b: ("x_scale", 4, Parsers.read_float, Parsers.write_float),
0x4c: ("y_scale", 4, Parsers.read_float, Parsers.write_float),
0x4d: ("trace_offset", 4, Parsers.read_int, Parsers.write_int),
0x4e: ("log_scale", 1, Parsers.read_int, Parsers.write_int),
0x55: ("scope_range", 4, Parsers.read_float, Parsers.write_float),
0x56: ("scope_coupling", 4, Parsers.read_int, Parsers.write_int),
0x57: ("scope_offset", 4, Parsers.read_float, Parsers.write_float),
0x58: ("scope_impedance", 4, Parsers.read_float, Parsers.write_float),
0x59: ("scope_id", None, Parsers.read_str, Parsers.write_str),
0x5a: ("filter_type", 4, Parsers.read_int, Parsers.write_int),
0x5b: ("filter_frequency", 4, Parsers.read_float, Parsers.write_float),
0x5c: ("filter_range", 4, Parsers.read_float, Parsers.read_float),
0x60: ("external_clock", 1, Parsers.read_bool, Parsers.write_bool),
0x61: ("external_clock_threshold", 4, Parsers.read_float, Parsers.write_float),
0x62: ("external_clock_multiplier", 4, Parsers.read_int, Parsers.write_int),
0x63: ("external_clock_phase_shift", 4, Parsers.read_int, Parsers.write_int),
0x64: ("external_clock_resampler_mask", 4, Parsers.read_int, Parsers.write_int),
0x65: ("external_clock_resampler_enabled", 1, Parsers.read_bool, Parsers.write_bool),
0x66: ("external_clock_frequency", 4, Parsers.read_float, Parsers.write_float),
0x67: ("external_clock_time_base", 4, Parsers.read_int, Parsers.write_int)
}
@classmethod
def read(cls, input: Union[str, Path, bytes, BinaryIO]) -> "TraceSet":
"""
Read Inspector trace set from file path, bytes or file-like object.
:param input: Input file path, bytes or file-like object.
:return:
"""
if isinstance(input, bytes):
with BytesIO(input) as r:
traces, tags = InspectorTraceSet.__read(r)
elif isinstance(input, (str, Path)):
with open(input, "rb") as f:
traces, tags = InspectorTraceSet.__read(f)
elif isinstance(input, (RawIOBase, BufferedIOBase, BinaryIO)):
traces, tags = InspectorTraceSet.__read(input)
else:
raise TypeError
for trace in traces:
new = InspectorTraceSet.__scale(trace.samples, tags["y_scale"])
del trace.samples
trace.samples = new
return InspectorTraceSet(*traces, **tags)
@classmethod
def __read(cls, file):
tags = {}
while True:
tag = ord(file.read(1))
length = ord(file.read(1))
if length & 0x80:
length = Parsers.read_int(file.read(length & 0x7f))
value = file.read(length)
if tag in InspectorTraceSet._tag_parsers:
tag_name, tag_len, tag_reader, _ = InspectorTraceSet._tag_parsers[tag]
if tag_len is None or length == tag_len:
tags[tag_name] = tag_reader(value)
elif tag == 0x5f and length == 0:
break
else:
continue
result = []
for _ in range(tags["num_traces"]):
title = None if "title_space" not in tags else Parsers.read_str(
file.read(tags["title_space"]))
data = None if "data_space" not in tags else file.read(tags["data_space"])
dtype = tags["sample_coding"].dtype()
try:
samples = np.fromfile(file, dtype, tags["num_samples"])
except UnsupportedOperation:
samples = np.frombuffer(
file.read(dtype.itemsize * tags["num_samples"]), dtype,
tags["num_samples"])
result.append(Trace(samples, {"title": title, "data": data}))
return result, tags
@classmethod
def inplace(cls, input: Union[str, Path, bytes, BinaryIO]) -> "TraceSet":
raise NotImplementedError
def write(self, output: Union[str, Path, BinaryIO]):
"""
Save this trace set into a file.
:param output: An output path or file-like object.
"""
if isinstance(output, (str, Path)):
with open(output, "wb") as f:
self.__write(f)
elif isinstance(output, (RawIOBase, BufferedIOBase, BinaryIO)):
self.__write(output)
else:
raise TypeError
def __write(self, file):
for tag, tag_tuple in self._tag_parsers.items():
tag_name, tag_len, _, tag_writer = tag_tuple
if tag_name not in self._keys:
continue
tag_byte = Parsers.write_int(tag, length=1)
value_bytes = tag_writer(getattr(self, tag_name), tag_len)
length = len(value_bytes)
if length <= 0x7f:
length_bytes = Parsers.write_int(length, length=1)
else:
length_data = Parsers.write_int(length, length=(length.bit_length() + 7) // 8)
length_bytes = Parsers.write_int(
0x80 | len(length_data)) + length_data
file.write(tag_byte)
file.write(length_bytes)
file.write(value_bytes)
file.write(b"\x5f\x00")
for trace in self._traces:
if self.title_space != 0 and trace.meta["title"] is not None:
file.write(Parsers.write_str(trace.meta["title"]))
if self.data_space != 0 and trace.meta["data"] is not None:
file.write(trace.meta["data"])
unscaled = InspectorTraceSet.__unscale(trace.samples, self.y_scale, self.sample_coding)
try:
unscaled.tofile(file)
except UnsupportedOperation:
file.write(unscaled.tobytes())
del unscaled
@staticmethod
def __scale(samples: np.ndarray, factor: float):
return samples.astype("f4") * factor
@staticmethod
def __unscale(samples: np.ndarray, factor: float, coding: SampleCoding):
return (samples * (1 / factor)).astype(coding.dtype())
@property
def sampling_frequency(self) -> int:
"""The sampling frequency of the trace set."""
return int(1 / self.x_scale)
def __repr__(self):
args = ", ".join([f"{key}={getattr(self, key)!r}" for key in self._keys])
return f"InspectorTraceSet({args})"
|
