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
32 def _graph_port_added_listener_from_native(user_listener
,
33 component_ptr
, component_type
,
35 component
= bt2
.component
._create
_component
_from
_ptr
_and
_get
_ref
(component_ptr
, component_type
)
36 port
= bt2
.port
._create
_from
_ptr
_and
_get
_ref
(port_ptr
, port_type
)
37 user_listener(component
, port
)
40 def _graph_ports_connected_listener_from_native(user_listener
,
41 upstream_component_ptr
, upstream_component_type
,
43 downstream_component_ptr
, downstream_component_type
,
45 upstream_component
= bt2
.component
._create
_component
_from
_ptr
_and
_get
_ref
(
46 upstream_component_ptr
, upstream_component_type
)
47 upstream_port
= bt2
.port
._create
_from
_ptr
_and
_get
_ref
(
48 upstream_port_ptr
, native_bt
.PORT_TYPE_OUTPUT
)
49 downstream_component
= bt2
.component
._create
_component
_from
_ptr
_and
_get
_ref
(
50 downstream_component_ptr
, downstream_component_type
)
51 downstream_port
= bt2
.port
._create
_from
_ptr
_and
_get
_ref
(
52 downstream_port_ptr
, native_bt
.PORT_TYPE_INPUT
)
53 user_listener(upstream_component
, upstream_port
, downstream_component
, downstream_port
)
56 class Graph(object._SharedObject
):
57 _get_ref
= staticmethod(native_bt
.graph_get_ref
)
58 _put_ref
= staticmethod(native_bt
.graph_put_ref
)
61 ptr
= native_bt
.graph_create()
64 raise bt2
.CreationError('cannot create graph object')
68 def _handle_status(self
, status
, gen_error_msg
):
69 if status
== native_bt
.GRAPH_STATUS_CANCELED
:
70 raise bt2
.GraphCanceled
71 elif status
== native_bt
.GRAPH_STATUS_END
:
73 elif status
== native_bt
.GRAPH_STATUS_AGAIN
:
76 raise bt2
.Error(gen_error_msg
)
78 def add_component(self
, component_class
, name
, params
=None,
79 logging_level
=bt2
.logging
.LoggingLevel
.NONE
):
80 if isinstance(component_class
, bt2
.component
._GenericSourceComponentClass
):
81 cc_ptr
= component_class
._ptr
82 add_fn
= native_bt
.graph_add_source_component
83 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
84 elif isinstance(component_class
, bt2
.component
._GenericFilterComponentClass
):
85 cc_ptr
= component_class
._ptr
86 add_fn
= native_bt
.graph_add_filter_component
87 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
88 elif isinstance(component_class
, bt2
.component
._GenericSinkComponentClass
):
89 cc_ptr
= component_class
._ptr
90 add_fn
= native_bt
.graph_add_sink_component
91 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
92 elif issubclass(component_class
, bt2
.component
._UserSourceComponent
):
93 cc_ptr
= component_class
._cc
_ptr
94 add_fn
= native_bt
.graph_add_source_component
95 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
96 elif issubclass(component_class
, bt2
.component
._UserSinkComponent
):
97 cc_ptr
= component_class
._cc
_ptr
98 add_fn
= native_bt
.graph_add_sink_component
99 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
100 elif issubclass(component_class
, bt2
.component
._UserFilterComponent
):
101 cc_ptr
= component_class
._cc
_ptr
102 add_fn
= native_bt
.graph_add_filter_component
103 cc_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
105 raise TypeError("'{}' is not a component class".format(
106 component_class
.__class
__.__name
__))
108 utils
._check
_str
(name
)
109 utils
._check
_log
_level
(logging_level
)
110 params
= bt2
.create_value(params
)
112 params_ptr
= params
._ptr
if params
is not None else None
114 status
, comp_ptr
= add_fn(self
._ptr
, cc_ptr
, name
,
115 params_ptr
, logging_level
)
116 self
._handle
_status
(status
, 'cannot add component to graph')
118 return bt2
.component
._create
_component
_from
_ptr
(comp_ptr
, cc_type
)
120 def connect_ports(self
, upstream_port
, downstream_port
):
121 utils
._check
_type
(upstream_port
, bt2
.port
._OutputPort
)
122 utils
._check
_type
(downstream_port
, bt2
.port
._InputPort
)
123 status
, conn_ptr
= native_bt
.graph_connect_ports(self
._ptr
,
125 downstream_port
._ptr
)
126 self
._handle
_status
(status
, 'cannot connect component ports within graph')
128 return bt2
.connection
._Connection
._create
_from
_ptr
(conn_ptr
)
130 def add_port_added_listener(self
, listener
):
131 if not callable(listener
):
132 raise TypeError("'listener' parameter is not callable")
134 fn
= native_bt
.py3_graph_add_port_added_listener
135 listener_from_native
= functools
.partial(_graph_port_added_listener_from_native
,
138 listener_ids
= fn(self
._ptr
, listener_from_native
)
139 if listener_ids
is None:
140 utils
._raise
_bt
2_error
('cannot add listener to graph object')
141 return bt2
._ListenerHandle(listener_ids
, self
)
143 def add_ports_connected_listener(self
, listener
):
144 if not callable(listener
):
145 raise TypeError("'listener' parameter is not callable")
147 fn
= native_bt
.py3_graph_add_ports_connected_listener
148 listener_from_native
= functools
.partial(_graph_ports_connected_listener_from_native
,
151 listener_ids
= fn(self
._ptr
, listener_from_native
)
152 if listener_ids
is None:
153 utils
._raise
_bt
2_error
('cannot add listener to graph object')
154 return bt2
._ListenerHandle(listener_ids
, self
)
157 status
= native_bt
.graph_run(self
._ptr
)
159 if status
== native_bt
.GRAPH_STATUS_END
:
162 self
._handle
_status
(status
, 'graph object stopped running because of an unexpected error')
165 status
= native_bt
.graph_cancel(self
._ptr
)
166 self
._handle
_status
(status
, 'cannot cancel graph object')
169 def is_canceled(self
):
170 is_canceled
= native_bt
.graph_is_canceled(self
._ptr
)
171 assert(is_canceled
>= 0)
172 return is_canceled
> 0
174 def create_output_port_message_iterator(self
, output_port
):
175 utils
._check
_type
(output_port
, bt2
.port
._OutputPort
)
176 msg_iter_ptr
= native_bt
.port_output_message_iterator_create(self
._ptr
, output_port
._ptr
)
178 if msg_iter_ptr
is None:
179 raise bt2
.CreationError('cannot create output port message iterator')
181 return bt2
.message_iterator
._OutputPortMessageIterator
(msg_iter_ptr
)