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
25 import collections
.abc
31 class _MessageIterator(collections
.abc
.Iterator
):
33 raise NotImplementedError
36 class _GenericMessageIterator(object._SharedObject
, _MessageIterator
):
37 def __init__(self
, ptr
):
38 self
._current
_msgs
= []
43 if len(self
._current
_msgs
) == self
._at
:
44 status
, msgs
= self
._get
_msg
_range
(self
._ptr
)
45 utils
._handle
_func
_status
(
46 status
, 'unexpected error: cannot advance the message iterator'
48 self
._current
_msgs
= msgs
51 msg_ptr
= self
._current
_msgs
[self
._at
]
54 return bt2
.message
._create
_from
_ptr
(msg_ptr
)
57 def can_seek_beginning(self
):
58 res
= self
._can
_seek
_beginning
(self
._ptr
)
61 def seek_beginning(self
):
62 # Forget about buffered messages, they won't be valid after seeking..
63 self
._current
_msgs
.clear()
66 status
= self
._seek
_beginning
(self
._ptr
)
67 utils
._handle
_func
_status
(status
, 'cannot seek message iterator beginning')
70 # This is created when a component wants to iterate on one of its input ports.
71 class _UserComponentInputPortMessageIterator(_GenericMessageIterator
):
72 _get_msg_range
= staticmethod(native_bt
.bt2_self_component_port_input_get_msg_range
)
73 _get_ref
= staticmethod(
74 native_bt
.self_component_port_input_message_iterator_get_ref
76 _put_ref
= staticmethod(
77 native_bt
.self_component_port_input_message_iterator_put_ref
79 _can_seek_beginning
= staticmethod(
80 native_bt
.self_component_port_input_message_iterator_can_seek_beginning
82 _seek_beginning
= staticmethod(
83 native_bt
.self_component_port_input_message_iterator_seek_beginning
87 # This is created when the user wants to iterate on a component's output port,
88 # from outside the graph.
89 class _OutputPortMessageIterator(_GenericMessageIterator
):
90 _get_msg_range
= staticmethod(native_bt
.bt2_port_output_get_msg_range
)
91 _get_ref
= staticmethod(native_bt
.port_output_message_iterator_get_ref
)
92 _put_ref
= staticmethod(native_bt
.port_output_message_iterator_put_ref
)
93 _can_seek_beginning
= staticmethod(
94 native_bt
.port_output_message_iterator_can_seek_beginning
96 _seek_beginning
= staticmethod(
97 native_bt
.port_output_message_iterator_seek_beginning
101 # This is extended by the user to implement component classes in Python. It
102 # is created for a given output port when an input port message iterator is
103 # created on the input port on the other side of the connection. It is also
104 # created when an output port message iterator is created on this output port.
106 # Its purpose is to feed the messages that should go out through this output
108 class _UserMessageIterator(_MessageIterator
):
109 def __new__(cls
, ptr
):
110 # User iterator objects are always created by the native side,
111 # that is, never instantiated directly by Python code.
113 # The native code calls this, then manually calls
114 # self.__init__() without the `ptr` argument. The user has
115 # access to self.component during this call, thanks to this
116 # self._bt_ptr argument being set.
118 # self._bt_ptr is NOT owned by this object here, so there's nothing
119 # to do in __del__().
120 self
= super().__new
__(cls
)
124 def _bt_init_from_native(self
, self_output_port_ptr
):
125 self_output_port
= bt2
.port
._create
_self
_from
_ptr
_and
_get
_ref
(
126 self_output_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
128 self
.__init
__(self_output_port
)
130 def __init__(self
, output_port
):
134 def _component(self
):
135 return native_bt
.bt2_get_user_component_from_user_msg_iter(self
._bt
_ptr
)
139 return int(self
._bt
_ptr
)
147 def _bt_next_from_native(self
):
148 # this can raise anything: it's catched by the native part
151 except StopIteration:
156 utils
._check
_type
(msg
, bt2
.message
._Message
)
158 # The reference we return will be given to the message array.
159 # However, the `msg` Python object may stay alive, if the user has kept
160 # a reference to it. Acquire a new reference to account for that.
161 msg
._get
_ref
(msg
._ptr
)
165 def _bt_can_seek_beginning_from_native(self
):
166 # Here, we mimic the behavior of the C API:
168 # - If the iterator has a _can_seek_beginning attribute, read it and use
170 # - Otherwise, the presence or absence of a `_seek_beginning`
171 # method indicates whether the iterator can seek beginning.
172 if hasattr(self
, '_can_seek_beginning'):
173 can_seek_beginning
= self
._can
_seek
_beginning
174 utils
._check
_bool
(can_seek_beginning
)
175 return can_seek_beginning
177 return hasattr(self
, '_seek_beginning')
179 def _bt_seek_beginning_from_native(self
):
180 self
._seek
_beginning
()
182 def _create_input_port_message_iterator(self
, input_port
):
183 utils
._check
_type
(input_port
, bt2
.port
._UserComponentInputPort
)
185 msg_iter_ptr
= native_bt
.self_component_port_input_message_iterator_create_from_message_iterator(
186 self
._bt
_ptr
, input_port
._ptr
189 if msg_iter_ptr
is None:
190 raise bt2
.CreationError('cannot create message iterator object')
192 return _UserComponentInputPortMessageIterator(msg_iter_ptr
)
194 def _create_event_message(
195 self
, event_class
, parent
=None, default_clock_snapshot
=None
197 utils
._check
_type
(event_class
, bt2
.event_class
._EventClass
)
199 if event_class
.stream_class
.supports_packets
:
200 utils
._check
_type
(parent
, bt2
.packet
._Packet
)
202 utils
._check
_type
(parent
, bt2
.stream
._Stream
)
204 if default_clock_snapshot
is not None:
205 if event_class
.stream_class
.default_clock_class
is None:
207 'event messages in this stream must not have a default clock snapshot'
210 utils
._check
_uint
64(default_clock_snapshot
)
212 if event_class
.stream_class
.supports_packets
:
213 ptr
= native_bt
.message_event_create_with_packet_and_default_clock_snapshot(
214 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
217 ptr
= native_bt
.message_event_create_with_default_clock_snapshot(
218 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
, default_clock_snapshot
221 if event_class
.stream_class
.default_clock_class
is not None:
223 'event messages in this stream must have a default clock snapshot'
226 if event_class
.stream_class
.supports_packets
:
227 ptr
= native_bt
.message_event_create_with_packet(
228 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
231 ptr
= native_bt
.message_event_create(
232 self
._bt
_ptr
, event_class
._ptr
, parent
._ptr
236 raise bt2
._MemoryError('cannot create event message object')
238 return bt2
.message
._EventMessage
(ptr
)
240 def _create_message_iterator_inactivity_message(self
, clock_class
, clock_snapshot
):
241 utils
._check
_type
(clock_class
, bt2
.clock_class
._ClockClass
)
242 ptr
= native_bt
.message_message_iterator_inactivity_create(
243 self
._bt
_ptr
, clock_class
._ptr
, clock_snapshot
247 raise bt2
._MemoryError('cannot create inactivity message object')
249 return bt2
.message
._MessageIteratorInactivityMessage
(ptr
)
251 def _create_stream_beginning_message(self
, stream
, default_clock_snapshot
=None):
252 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
254 ptr
= native_bt
.message_stream_beginning_create(self
._bt
_ptr
, stream
._ptr
)
256 raise bt2
._MemoryError('cannot create stream beginning message object')
258 msg
= bt2
.message
._StreamBeginningMessage
(ptr
)
260 if default_clock_snapshot
is not None:
261 msg
._default
_clock
_snapshot
= default_clock_snapshot
265 def _create_stream_end_message(self
, stream
, default_clock_snapshot
=None):
266 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
268 ptr
= native_bt
.message_stream_end_create(self
._bt
_ptr
, stream
._ptr
)
270 raise bt2
._MemoryError('cannot create stream end message object')
272 msg
= bt2
.message
._StreamEndMessage
(ptr
)
274 if default_clock_snapshot
is not None:
275 msg
._default
_clock
_snapshot
= default_clock_snapshot
279 def _create_packet_beginning_message(self
, packet
, default_clock_snapshot
=None):
280 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
282 if packet
.stream
.cls
.packets_have_beginning_default_clock_snapshot
:
283 if default_clock_snapshot
is None:
285 "packet beginning messages in this stream must have a default clock snapshot"
288 utils
._check
_uint
64(default_clock_snapshot
)
289 ptr
= native_bt
.message_packet_beginning_create_with_default_clock_snapshot(
290 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
293 if default_clock_snapshot
is not None:
295 "packet beginning messages in this stream must not have a default clock snapshot"
298 ptr
= native_bt
.message_packet_beginning_create(self
._bt
_ptr
, packet
._ptr
)
301 raise bt2
._MemoryError('cannot create packet beginning message object')
303 return bt2
.message
._PacketBeginningMessage
(ptr
)
305 def _create_packet_end_message(self
, packet
, default_clock_snapshot
=None):
306 utils
._check
_type
(packet
, bt2
.packet
._Packet
)
308 if packet
.stream
.cls
.packets_have_end_default_clock_snapshot
:
309 if default_clock_snapshot
is None:
311 "packet end messages in this stream must have a default clock snapshot"
314 utils
._check
_uint
64(default_clock_snapshot
)
315 ptr
= native_bt
.message_packet_end_create_with_default_clock_snapshot(
316 self
._bt
_ptr
, packet
._ptr
, default_clock_snapshot
319 if default_clock_snapshot
is not None:
321 "packet end messages in this stream must not have a default clock snapshot"
324 ptr
= native_bt
.message_packet_end_create(self
._bt
_ptr
, packet
._ptr
)
327 raise bt2
._MemoryError('cannot create packet end message object')
329 return bt2
.message
._PacketEndMessage
(ptr
)
331 def _create_discarded_events_message(
332 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
334 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
336 if not stream
.cls
.supports_discarded_events
:
337 raise ValueError('stream class does not support discarded events')
339 if stream
.cls
.discarded_events_have_default_clock_snapshots
:
340 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
342 'discarded events have default clock snapshots for this stream class'
345 utils
._check
_uint
64(beg_clock_snapshot
)
346 utils
._check
_uint
64(end_clock_snapshot
)
347 ptr
= native_bt
.message_discarded_events_create_with_default_clock_snapshots(
348 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
351 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
353 'discarded events have no default clock snapshots for this stream class'
356 ptr
= native_bt
.message_discarded_events_create(self
._bt
_ptr
, stream
._ptr
)
359 raise bt2
._MemoryError('cannot discarded events message object')
361 msg
= bt2
.message
._DiscardedEventsMessage
(ptr
)
363 if count
is not None:
368 def _create_discarded_packets_message(
369 self
, stream
, count
=None, beg_clock_snapshot
=None, end_clock_snapshot
=None
371 utils
._check
_type
(stream
, bt2
.stream
._Stream
)
373 if not stream
.cls
.supports_discarded_packets
:
374 raise ValueError('stream class does not support discarded packets')
376 if stream
.cls
.discarded_packets_have_default_clock_snapshots
:
377 if beg_clock_snapshot
is None or end_clock_snapshot
is None:
379 'discarded packets have default clock snapshots for this stream class'
382 utils
._check
_uint
64(beg_clock_snapshot
)
383 utils
._check
_uint
64(end_clock_snapshot
)
384 ptr
= native_bt
.message_discarded_packets_create_with_default_clock_snapshots(
385 self
._bt
_ptr
, stream
._ptr
, beg_clock_snapshot
, end_clock_snapshot
388 if beg_clock_snapshot
is not None or end_clock_snapshot
is not None:
390 'discarded packets have no default clock snapshots for this stream class'
393 ptr
= native_bt
.message_discarded_packets_create(self
._bt
_ptr
, stream
._ptr
)
396 raise bt2
._MemoryError('cannot discarded packets message object')
398 msg
= bt2
.message
._DiscardedPacketsMessage
(ptr
)
400 if count
is not None: