1 # The MIT License (MIT)
3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
5 # Permission is hereby granted, free of charge, to any person obtaining a copy
6 # of this software and associated documentation files (the "Software"), to deal
7 # in the Software without restriction, including without limitation the rights
8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 # copies of the Software, and to permit persons to whom the Software is
10 # furnished to do so, subject to the following conditions:
12 # The above copyright notice and this permission notice shall be included in
13 # all copies or substantial portions of the Software.
15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 from bt2
import native_bt
, object, utils
24 from bt2
import message
as bt2_message
25 import collections
.abc
26 from bt2
import component
as bt2_component
27 from bt2
import stream
as bt2_stream
28 from bt2
import event_class
as bt2_event_class
29 from bt2
import packet
as bt2_packet
30 from bt2
import port
as bt2_port
31 from bt2
import clock_class
as bt2_clock_class
35 class _MessageIterator(collections
.abc
.Iterator
):
37 raise NotImplementedError
40 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
41 def __init__(self
, ptr
):
42 self
._current
_msgs
= []
47 if len(self
._current
_msgs
) == self
._at
:
48 status
, msgs
= self
._get
_msg
_range
(self
._ptr
)
49 utils
._handle
_func
_status
(
50 status
, 'unexpected error: cannot advance the message iterator'
52 self
._current
_msgs
= msgs
55 msg_ptr
= self
._current
_msgs
[self
._at
]
58 return bt2_message
._create
_from
_ptr
(msg_ptr
)
61 def can_seek_beginning(self
):
62 res
= self
._can
_seek
_beginning
(self
._ptr
)
65 def seek_beginning(self
):
66 # Forget about buffered messages, they won't be valid after seeking..
67 self
._current
_msgs
.clear()
70 status
= self
._seek
_beginning
(self
._ptr
)
71 utils
._handle
_func
_status
(status
, 'cannot seek message iterator beginning')
74 # This is created when a component wants to iterate on one of its input ports.
75 class _UserComponentInputPortMessageIterator(_GenericMessageIterator
):
76 _get_msg_range
= staticmethod(native_bt
.bt2_self_component_port_input_get_msg_range
)
77 _get_ref
= staticmethod(
78 native_bt
.self_component_port_input_message_iterator_get_ref
80 _put_ref
= staticmethod(
81 native_bt
.self_component_port_input_message_iterator_put_ref
83 _can_seek_beginning
= staticmethod(
84 native_bt
.self_component_port_input_message_iterator_can_seek_beginning
86 _seek_beginning
= staticmethod(
87 native_bt
.self_component_port_input_message_iterator_seek_beginning
91 # This is created when the user wants to iterate on a component's output port,
92 # from outside the graph.
93 class _OutputPortMessageIterator(_GenericMessageIterator
):
94 _get_msg_range
= staticmethod(native_bt
.bt2_port_output_get_msg_range
)
95 _get_ref
= staticmethod(native_bt
.port_output_message_iterator_get_ref
)
96 _put_ref
= staticmethod(native_bt
.port_output_message_iterator_put_ref
)
97 _can_seek_beginning
= staticmethod(
98 native_bt
.port_output_message_iterator_can_seek_beginning
100 _seek_beginning
= staticmethod(
101 native_bt
.port_output_message_iterator_seek_beginning
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. It is also
108 # created when an output port message iterator is created on this output port.
110 # Its purpose is to feed the messages that should go out through this output
112 class _UserMessageIterator(_MessageIterator
):
113 def __new__(cls
, ptr
):
114 # User iterator objects are always created by the native side,
115 # that is, never instantiated directly by Python code.
117 # The native code calls this, then manually calls
118 # self.__init__() without the `ptr` argument. The user has
119 # access to self.component during this call, thanks to this
120 # self._bt_ptr argument being set.
122 # self._bt_ptr is NOT owned by this object here, so there's nothing
123 # to do in __del__().
124 self
= super().__new
__(cls
)
128 def _bt_init_from_native(self
, self_output_port_ptr
):
129 self_output_port
= bt2_port
._create
_self
_from
_ptr
_and
_get
_ref
(
130 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
132 self
.__init
__(self_output_port
)
134 def __init__(self
, output_port
):
138 def _component(self
):
139 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._bt
_ptr
)
143 return int(self
._bt
_ptr
)
146 def _is_interrupted(self
):
147 return bool(native_bt
.self_message_iterator_is_interrupted(self
._bt
_ptr
))
149 def _user_finalize(self
):
155 def _bt_next_from_native(self
):
156 # this can raise anything: it's catched by the native part
159 except StopIteration:
164 utils
._check
_type
(msg
, bt2_message
._Message
)
166 # The reference we return will be given to the message array.
167 # However, the `msg` Python object may stay alive, if the user has kept
168 # a reference to it. Acquire a new reference to account for that.
169 msg
._get
_ref
(msg
._ptr
)
173 def _bt_can_seek_beginning_from_native(self
):
174 # Here, we mimic the behavior of the C API:
176 # - If the iterator has a _user_can_seek_beginning attribute,
177 # read it and use that result.
178 # - Otherwise, the presence or absence of a `_seek_beginning`
179 # method indicates whether the iterator can seek beginning.
180 if hasattr(self
, '_user_can_seek_beginning'):
181 can_seek_beginning
= self
._user
_can
_seek
_beginning
182 utils
._check
_bool
(can_seek_beginning
)
183 return can_seek_beginning
185 return hasattr(self
, '_user_seek_beginning')
187 def _bt_seek_beginning_from_native(self
):
188 self
._user
_seek
_beginning
()
190 def _create_input_port_message_iterator(self
, input_port
):
191 utils
._check
_type
(input_port
, bt2_port
._UserComponentInputPort
)
193 msg_iter_ptr
= native_bt
.self_component_port_input_message_iterator_create_from_message_iterator(
194 self
._bt
_ptr
, input_port
._ptr
197 if msg_iter_ptr
is None:
198 raise bt2
.CreationError('cannot create message iterator object')
200 return _UserComponentInputPortMessageIterator(msg_iter_ptr
)
202 def _create_event_message(
203 self
, event_class
, parent
=None, default_clock_snapshot
=None
205 utils
._check
_type
(event_class
, bt2_event_class
._EventClass
)
207 if event_class
.stream_class
.supports_packets
:
208 utils
._check
_type
(parent
, bt2_packet
._Packet
)
210 utils
._check
_type
(parent
, bt2_stream
._Stream
)
212 if default_clock_snapshot
is not None:
213 if event_class
.stream_class
.default_clock_class
is None:
215 'event messages in this stream must not have a default clock snapshot'
218 utils
._check
_uint
64(default_clock_snapshot
)
220 if event_class
.stream_class
.supports_packets
:
221 ptr
= native_bt
.message_event_create_with_packet_and_default_clock_snapshot(
222 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
225 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
226 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
229 if event_class
.stream_class
.default_clock_class
is not None:
231 'event messages in this stream must have a default clock snapshot'
234 if event_class
.stream_class
.supports_packets
:
235 ptr
= native_bt
.message_event_create_with_packet(
236 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
239 ptr
= native_bt
.message_event_create(
240 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
244 raise bt2
._MemoryError('cannot create event message object')
246 return bt2_message
._EventMessage
(ptr
)
248 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
249 utils
._check
_type
(clock_class
, bt2_clock_class
._ClockClass
)
250 ptr
= native_bt
.message_message_iterator_inactivity_create(
251 self
._bt
_ptr
, clock_class
._ptr
, clock_snapshot
255 raise bt2
._MemoryError('cannot create inactivity message object')
257 return bt2_message
._MessageIteratorInactivityMessage
(ptr
)
259 def _create_stream_beginning_message(self
, stream
, default_clock_snapshot
=None):
260 utils
._check
_type
(stream
, bt2_stream
._Stream
)
262 ptr
= native_bt
.message_stream_beginning_create(self
._bt
_ptr
, stream
._ptr
)
264 raise bt2
._MemoryError('cannot create stream beginning message object')
266 msg
= bt2_message
._StreamBeginningMessage
(ptr
)
268 if default_clock_snapshot
is not None:
269 msg
._default
_clock
_snapshot
= default_clock_snapshot
273 def _create_stream_end_message(self
, stream
, default_clock_snapshot
=None):
274 utils
._check
_type
(stream
, bt2_stream
._Stream
)
276 ptr
= native_bt
.message_stream_end_create(self
._bt
_ptr
, stream
._ptr
)
278 raise bt2
._MemoryError('cannot create stream end message object')
280 msg
= bt2_message
._StreamEndMessage
(ptr
)
282 if default_clock_snapshot
is not None:
283 msg
._default
_clock
_snapshot
= default_clock_snapshot
287 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
288 utils
._check
_type
(packet
, bt2_packet
._Packet
)
290 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
291 if default_clock_snapshot
is None:
293 "packet beginning messages in this stream must have a default clock snapshot"
296 utils
._check
_uint
64(default_clock_snapshot
)
297 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
298 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
301 if default_clock_snapshot
is not None:
303 "packet beginning messages in this stream must not have a default clock snapshot"
306 ptr
= native_bt
.message_packet_beginning_create(self
._bt
_ptr
, packet
._ptr
)
309 raise bt2
._MemoryError('cannot create packet beginning message object')
311 return bt2_message
._PacketBeginningMessage
(ptr
)
313 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
314 utils
._check
_type
(packet
, bt2_packet
._Packet
)
316 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
317 if default_clock_snapshot
is None:
319 "packet end messages in this stream must have a default clock snapshot"
322 utils
._check
_uint
64(default_clock_snapshot
)
323 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
324 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
327 if default_clock_snapshot
is not None:
329 "packet end messages in this stream must not have a default clock snapshot"
332 ptr
= native_bt
.message_packet_end_create(self
._bt
_ptr
, packet
._ptr
)
335 raise bt2
._MemoryError('cannot create packet end message object')
337 return bt2_message
._PacketEndMessage
(ptr
)
339 def _create_discarded_events_message(
340 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
342 utils
._check
_type
(stream
, bt2_stream
._Stream
)
344 if not stream
.cls
.supports_discarded_events
:
345 raise ValueError('stream class does not support discarded events')
347 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
348 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
350 'discarded events have default clock snapshots for this stream class'
353 utils
._check
_uint
64(beg_clock_snapshot
)
354 utils
._check
_uint
64(end_clock_snapshot
)
355 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
356 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
359 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
361 'discarded events have no default clock snapshots for this stream class'
364 ptr
= native_bt
.message_discarded_events_create(self
._bt
_ptr
, stream
._ptr
)
367 raise bt2
._MemoryError('cannot discarded events message object')
369 msg
= bt2_message
._DiscardedEventsMessage
(ptr
)
371 if count
is not None:
376 def _create_discarded_packets_message(
377 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
379 utils
._check
_type
(stream
, bt2_stream
._Stream
)
381 if not stream
.cls
.supports_discarded_packets
:
382 raise ValueError('stream class does not support discarded packets')
384 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
385 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
387 'discarded packets have default clock snapshots for this stream class'
390 utils
._check
_uint
64(beg_clock_snapshot
)
391 utils
._check
_uint
64(end_clock_snapshot
)
392 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
393 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
396 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
398 'discarded packets have no default clock snapshots for this stream class'
401 ptr
= native_bt
.message_discarded_packets_create(self
._bt
_ptr
, stream
._ptr
)
404 raise bt2
._MemoryError('cannot discarded packets message object')
406 msg
= bt2_message
._DiscardedPacketsMessage
(ptr
)
408 if count
is not None: