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 interrupter
as bt2_interrupter
25 from bt2
import connection
as bt2_connection
26 from bt2
import component
as bt2_component
27 from bt2
import message_iterator
as bt2_message_iterator
29 from bt2
import port
as bt2_port
30 from bt2
import logging
as bt2_logging
34 def _graph_port_added_listener_from_native(
35 user_listener
, component_ptr
, component_type
, port_ptr
, port_type
37 component
= bt2_component
._create
_component
_from
_ptr
_and
_get
_ref
(
38 component_ptr
, component_type
40 port
= bt2_port
._create
_from
_ptr
_and
_get
_ref
(port_ptr
, port_type
)
41 user_listener(component
, port
)
44 def _graph_ports_connected_listener_from_native(
46 upstream_component_ptr
,
47 upstream_component_type
,
49 downstream_component_ptr
,
50 downstream_component_type
,
53 upstream_component
= bt2_component
._create
_component
_from
_ptr
_and
_get
_ref
(
54 upstream_component_ptr
, upstream_component_type
56 upstream_port
= bt2_port
._create
_from
_ptr
_and
_get
_ref
(
57 upstream_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
59 downstream_component
= bt2_component
._create
_component
_from
_ptr
_and
_get
_ref
(
60 downstream_component_ptr
, downstream_component_type
62 downstream_port
= bt2_port
._create
_from
_ptr
_and
_get
_ref
(
63 downstream_port_ptr
, native_bt
.PORT_TYPE_INPUT
66 upstream_component
, upstream_port
, downstream_component
, downstream_port
70 class Graph(object._SharedObject
):
71 _get_ref
= staticmethod(native_bt
.graph_get_ref
)
72 _put_ref
= staticmethod(native_bt
.graph_put_ref
)
75 ptr
= native_bt
.graph_create()
78 raise bt2
._MemoryError('cannot create graph object')
87 logging_level
=bt2_logging
.LoggingLevel
.NONE
,
89 if isinstance(component_class
, bt2_component
._SourceComponentClass
):
90 cc_ptr
= component_class
._ptr
91 add_fn
= native_bt
.graph_add_source_component
92 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
93 elif isinstance(component_class
, bt2_component
._FilterComponentClass
):
94 cc_ptr
= component_class
._ptr
95 add_fn
= native_bt
.graph_add_filter_component
96 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
97 elif isinstance(component_class
, bt2_component
._SinkComponentClass
):
98 cc_ptr
= component_class
._ptr
99 add_fn
= native_bt
.graph_add_sink_component
100 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
101 elif issubclass(component_class
, bt2_component
._UserSourceComponent
):
102 cc_ptr
= component_class
._bt
_cc
_ptr
103 add_fn
= native_bt
.graph_add_source_component
104 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
105 elif issubclass(component_class
, bt2_component
._UserSinkComponent
):
106 cc_ptr
= component_class
._bt
_cc
_ptr
107 add_fn
= native_bt
.graph_add_sink_component
108 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
109 elif issubclass(component_class
, bt2_component
._UserFilterComponent
):
110 cc_ptr
= component_class
._bt
_cc
_ptr
111 add_fn
= native_bt
.graph_add_filter_component
112 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
115 "'{}' is not a component class".format(
116 component_class
.__class
__.__name
__
120 utils
._check
_str
(name
)
121 utils
._check
_log
_level
(logging_level
)
122 params
= bt2
.create_value(params
)
124 params_ptr
= params
._ptr
if params
is not None else None
126 status
, comp_ptr
= add_fn(self
._ptr
, cc_ptr
, name
, params_ptr
, logging_level
)
127 utils
._handle
_func
_status
(status
, 'cannot add component to graph')
129 return bt2_component
._create
_component
_from
_ptr
(comp_ptr
, cc_type
)
131 def connect_ports(self
, upstream_port
, downstream_port
):
132 utils
._check
_type
(upstream_port
, bt2_port
._OutputPort
)
133 utils
._check
_type
(downstream_port
, bt2_port
._InputPort
)
134 status
, conn_ptr
= native_bt
.graph_connect_ports(
135 self
._ptr
, upstream_port
._ptr
, downstream_port
._ptr
137 utils
._handle
_func
_status
(status
, 'cannot connect component ports within graph')
139 return bt2_connection
._Connection
._create
_from
_ptr
(conn_ptr
)
141 def add_port_added_listener(self
, listener
):
142 if not callable(listener
):
143 raise TypeError("'listener' parameter is not callable")
145 fn
= native_bt
.bt2_graph_add_port_added_listener
146 listener_from_native
= functools
.partial(
147 _graph_port_added_listener_from_native
, listener
150 listener_ids
= fn(self
._ptr
, listener_from_native
)
151 if listener_ids
is None:
152 raise bt2
._Error('cannot add listener to graph object')
154 return utils
._ListenerHandle
(listener_ids
, self
)
156 def add_ports_connected_listener(self
, listener
):
157 if not callable(listener
):
158 raise TypeError("'listener' parameter is not callable")
160 fn
= native_bt
.bt2_graph_add_ports_connected_listener
161 listener_from_native
= functools
.partial(
162 _graph_ports_connected_listener_from_native
, listener
165 listener_ids
= fn(self
._ptr
, listener_from_native
)
166 if listener_ids
is None:
167 raise bt2
._Error('cannot add listener to graph object')
169 return utils
._ListenerHandle
(listener_ids
, self
)
172 status
= native_bt
.graph_run(self
._ptr
)
175 utils
._handle
_func
_status
(status
, 'graph object stopped running')
182 def add_interrupter(self
, interrupter
):
183 utils
._check
_type
(interrupter
, bt2_interrupter
.Interrupter
)
184 native_bt
.graph_add_interrupter(self
._ptr
, interrupter
._ptr
)
187 native_bt
.graph_interrupt(self
._ptr
)
189 def create_output_port_message_iterator(self
, output_port
):
190 utils
._check
_type
(output_port
, bt2_port
._OutputPort
)
191 msg_iter_ptr
= native_bt
.port_output_message_iterator_create(
192 self
._ptr
, output_port
._ptr
195 if msg_iter_ptr
is None:
196 raise bt2
._MemoryError('cannot create output port message iterator')
198 return bt2_message_iterator
._OutputPortMessageIterator
(msg_iter_ptr
)