1 # SPDX-License-Identifier: MIT
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 from bt2
import native_bt
, object, utils
6 from bt2
import message
as bt2_message
8 from bt2
import stream
as bt2_stream
9 from bt2
import event_class
as bt2_event_class
10 from bt2
import packet
as bt2_packet
11 from bt2
import port
as bt2_port
12 from bt2
import clock_class
as bt2_clock_class
16 class _MessageIterator(collections
.abc
.Iterator
):
18 raise NotImplementedError
21 class _UserComponentInputPortMessageIterator(object._SharedObject
, _MessageIterator
):
22 _get_ref
= staticmethod(native_bt
.message_iterator_get_ref
)
23 _put_ref
= staticmethod(native_bt
.message_iterator_put_ref
)
25 def __init__(self
, ptr
):
26 self
._current
_msgs
= []
31 if len(self
._current
_msgs
) == self
._at
:
32 status
, msgs
= native_bt
.bt2_self_component_port_input_get_msg_range(
35 utils
._handle
_func
_status
(
36 status
, 'unexpected error: cannot advance the message iterator'
38 self
._current
_msgs
= msgs
41 msg_ptr
= self
._current
_msgs
[self
._at
]
44 return bt2_message
._create
_from
_ptr
(msg_ptr
)
46 def can_seek_beginning(self
):
47 (status
, res
) = native_bt
.message_iterator_can_seek_beginning(self
._ptr
)
48 utils
._handle
_func
_status
(
50 'cannot check whether or not message iterator can seek its beginning',
54 def seek_beginning(self
):
55 # Forget about buffered messages, they won't be valid after seeking.
56 self
._current
_msgs
.clear()
59 status
= native_bt
.message_iterator_seek_beginning(self
._ptr
)
60 utils
._handle
_func
_status
(status
, 'cannot seek message iterator beginning')
62 def can_seek_ns_from_origin(self
, ns_from_origin
):
63 utils
._check
_int
64(ns_from_origin
)
64 (status
, res
) = native_bt
.message_iterator_can_seek_ns_from_origin(
65 self
._ptr
, ns_from_origin
67 utils
._handle
_func
_status
(
69 'cannot check whether or not message iterator can seek given ns from origin',
73 def seek_ns_from_origin(self
, ns_from_origin
):
74 utils
._check
_int
64(ns_from_origin
)
76 # Forget about buffered messages, they won't be valid after seeking.
77 self
._current
_msgs
.clear()
80 status
= native_bt
.message_iterator_seek_ns_from_origin(
81 self
._ptr
, ns_from_origin
83 utils
._handle
_func
_status
(
84 status
, 'message iterator cannot seek given ns from origin'
88 def can_seek_forward(self
):
89 return native_bt
.message_iterator_can_seek_forward(self
._ptr
)
92 class _MessageIteratorConfiguration
:
93 def __init__(self
, ptr
):
96 def can_seek_forward(self
, value
):
97 utils
._check
_bool
(value
)
98 native_bt
.self_message_iterator_configuration_set_can_seek_forward(
102 can_seek_forward
= property(fset
=can_seek_forward
)
105 # This is extended by the user to implement component classes in Python. It
106 # is created for a given output port when an input port message iterator is
107 # created on the input port on the other side of the connection.
109 # Its purpose is to feed the messages that should go out through this output
111 class _UserMessageIterator(_MessageIterator
):
112 def __new__(cls
, ptr
):
113 # User iterator objects are always created by the native side,
114 # that is, never instantiated directly by Python code.
116 # The native code calls this, then manually calls
117 # self.__init__() without the `ptr` argument. The user has
118 # access to self.component during this call, thanks to this
119 # self._bt_ptr argument being set.
121 # self._bt_ptr is NOT owned by this object here, so there's nothing
122 # to do in __del__().
123 self
= super().__new
__(cls
)
127 def _bt_init_from_native(self
, config_ptr
, self_output_port_ptr
):
128 self_output_port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
129 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
131 config
= _MessageIteratorConfiguration(config_ptr
)
132 self
.__init
__(config
, self_output_port
)
134 def __init__(self
, config
, self_output_port
):
138 def _component(self
):
139 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._bt
_ptr
)
143 port_ptr
= native_bt
.self_message_iterator_borrow_port(self
._bt
_ptr
)
144 assert port_ptr
is not None
145 return bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
146 port_ptr
, native_bt
.PORT_TYPE_OUTPUT
151 return int(self
._bt
_ptr
)
154 def _is_interrupted(self
):
155 return bool(native_bt
.self_message_iterator_is_interrupted(self
._bt
_ptr
))
157 def _user_finalize(self
):
163 def _bt_next_from_native(self
):
164 # this can raise anything: it's catched by the native part
167 except StopIteration:
172 utils
._check
_type
(msg
, bt2_message
._MessageConst
)
174 # The reference we return will be given to the message array.
175 # However, the `msg` Python object may stay alive, if the user has kept
176 # a reference to it. Acquire a new reference to account for that.
177 msg
._get
_ref
(msg
._ptr
)
180 def _bt_can_seek_beginning_from_native(self
):
181 # Here, we mimic the behavior of the C API:
183 # - If the iterator has a _user_can_seek_beginning method,
184 # read it and use that result.
185 # - Otherwise, the presence or absence of a `_user_seek_beginning`
186 # method indicates whether the iterator can seek beginning.
187 if hasattr(self
, '_user_can_seek_beginning'):
188 can_seek_beginning
= self
._user
_can
_seek
_beginning
()
189 utils
._check
_bool
(can_seek_beginning
)
190 return can_seek_beginning
192 return hasattr(self
, '_user_seek_beginning')
194 def _bt_seek_beginning_from_native(self
):
195 self
._user
_seek
_beginning
()
197 def _bt_can_seek_ns_from_origin_from_native(self
, ns_from_origin
):
198 # Return whether the iterator can seek ns from origin using the
199 # user-implemented seek_ns_from_origin method. We mimic the behavior
202 # - If the iterator has a _user_can_seek_ns_from_origin method,
203 # call it and use its return value.
204 # - Otherwise, if there is a `_user_seek_ns_from_origin` method,
205 # we presume it's possible.
207 if hasattr(self
, '_user_can_seek_ns_from_origin'):
208 can_seek_ns_from_origin
= self
._user
_can
_seek
_ns
_from
_origin
(ns_from_origin
)
209 utils
._check
_bool
(can_seek_ns_from_origin
)
210 return can_seek_ns_from_origin
212 return hasattr(self
, '_user_seek_ns_from_origin')
214 def _bt_seek_ns_from_origin_from_native(self
, ns_from_origin
):
215 self
._user
_seek
_ns
_from
_origin
(ns_from_origin
)
217 def _create_message_iterator(self
, input_port
):
218 utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
220 if not input_port
.is_connected
:
221 raise ValueError('input port is not connected')
226 ) = native_bt
.bt2_message_iterator_create_from_message_iterator(
227 self
._bt
_ptr
, input_port
._ptr
229 utils
._handle
_func
_status
(status
, 'cannot create message iterator object')
230 assert msg_iter_ptr
is not None
232 return _UserComponentInputPortMessageIterator(msg_iter_ptr
)
234 def _create_event_message(self
, event_class
, parent
, default_clock_snapshot
=None):
235 utils
._check
_type
(event_class
, bt2_event_class
._EventClass
)
237 if event_class
.stream_class
.supports_packets
:
238 utils
._check
_type
(parent
, bt2_packet
._Packet
)
240 utils
._check
_type
(parent
, bt2_stream
._Stream
)
242 if default_clock_snapshot
is not None:
243 if event_class
.stream_class
.default_clock_class
is None:
245 'event messages in this stream must not have a default clock snapshot'
248 utils
._check
_uint
64(default_clock_snapshot
)
250 if event_class
.stream_class
.supports_packets
:
251 ptr
= native_bt
.message_event_create_with_packet_and_default_clock_snapshot(
252 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
255 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
256 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
259 if event_class
.stream_class
.default_clock_class
is not None:
261 'event messages in this stream must have a default clock snapshot'
264 if event_class
.stream_class
.supports_packets
:
265 ptr
= native_bt
.message_event_create_with_packet(
266 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
269 ptr
= native_bt
.message_event_create(
270 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
274 raise bt2
._MemoryError('cannot create event message object')
276 return bt2_message
._EventMessage
(ptr
)
278 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
279 utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
280 ptr
= native_bt
.message_message_iterator_inactivity_create(
281 self
._bt
_ptr
, clock_class
._ptr
, clock_snapshot
285 raise bt2
._MemoryError('cannot create inactivity message object')
287 return bt2_message
._MessageIteratorInactivityMessage
(ptr
)
289 def _create_stream_beginning_message(self
, stream
, default_clock_snapshot
=None):
290 utils
._check
_type
(stream
, bt2_stream
._Stream
)
292 ptr
= native_bt
.message_stream_beginning_create(self
._bt
_ptr
, stream
._ptr
)
294 raise bt2
._MemoryError('cannot create stream beginning message object')
296 msg
= bt2_message
._StreamBeginningMessage
(ptr
)
298 if default_clock_snapshot
is not None:
299 msg
._default
_clock
_snapshot
= default_clock_snapshot
303 def _create_stream_end_message(self
, stream
, default_clock_snapshot
=None):
304 utils
._check
_type
(stream
, bt2_stream
._Stream
)
306 ptr
= native_bt
.message_stream_end_create(self
._bt
_ptr
, stream
._ptr
)
308 raise bt2
._MemoryError('cannot create stream end message object')
310 msg
= bt2_message
._StreamEndMessage
(ptr
)
312 if default_clock_snapshot
is not None:
313 msg
._default
_clock
_snapshot
= default_clock_snapshot
317 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
318 utils
._check
_type
(packet
, bt2_packet
._Packet
)
320 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
321 if default_clock_snapshot
is None:
323 "packet beginning messages in this stream must have a default clock snapshot"
326 utils
._check
_uint
64(default_clock_snapshot
)
327 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
328 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
331 if default_clock_snapshot
is not None:
333 "packet beginning messages in this stream must not have a default clock snapshot"
336 ptr
= native_bt
.message_packet_beginning_create(self
._bt
_ptr
, packet
._ptr
)
339 raise bt2
._MemoryError('cannot create packet beginning message object')
341 return bt2_message
._PacketBeginningMessage
(ptr
)
343 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
344 utils
._check
_type
(packet
, bt2_packet
._Packet
)
346 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
347 if default_clock_snapshot
is None:
349 "packet end messages in this stream must have a default clock snapshot"
352 utils
._check
_uint
64(default_clock_snapshot
)
353 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
354 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
357 if default_clock_snapshot
is not None:
359 "packet end messages in this stream must not have a default clock snapshot"
362 ptr
= native_bt
.message_packet_end_create(self
._bt
_ptr
, packet
._ptr
)
365 raise bt2
._MemoryError('cannot create packet end message object')
367 return bt2_message
._PacketEndMessage
(ptr
)
369 def _create_discarded_events_message(
370 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
372 utils
._check
_type
(stream
, bt2_stream
._Stream
)
374 if not stream
.cls
.supports_discarded_events
:
375 raise ValueError('stream class does not support discarded events')
377 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
378 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
380 'discarded events have default clock snapshots for this stream class'
383 utils
._check
_uint
64(beg_clock_snapshot
)
384 utils
._check
_uint
64(end_clock_snapshot
)
386 if beg_clock_snapshot
> end_clock_snapshot
:
388 'beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})'.format(
389 beg_clock_snapshot
, end_clock_snapshot
393 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
394 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
397 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
399 'discarded events have no default clock snapshots for this stream class'
402 ptr
= native_bt
.message_discarded_events_create(self
._bt
_ptr
, stream
._ptr
)
405 raise bt2
._MemoryError('cannot discarded events message object')
407 msg
= bt2_message
._DiscardedEventsMessage
(ptr
)
409 if count
is not None:
414 def _create_discarded_packets_message(
415 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
417 utils
._check
_type
(stream
, bt2_stream
._Stream
)
419 if not stream
.cls
.supports_discarded_packets
:
420 raise ValueError('stream class does not support discarded packets')
422 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
423 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
425 'discarded packets have default clock snapshots for this stream class'
428 utils
._check
_uint
64(beg_clock_snapshot
)
429 utils
._check
_uint
64(end_clock_snapshot
)
431 if beg_clock_snapshot
> end_clock_snapshot
:
433 'beginning default clock snapshot value ({}) is greater than end default clock snapshot value ({})'.format(
434 beg_clock_snapshot
, end_clock_snapshot
438 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
439 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
442 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
444 'discarded packets have no default clock snapshots for this stream class'
447 ptr
= native_bt
.message_discarded_packets_create(self
._bt
_ptr
, stream
._ptr
)
450 raise bt2
._MemoryError('cannot discarded packets message object')
452 msg
= bt2_message
._DiscardedPacketsMessage
(ptr
)
454 if count
is not None: