Commit | Line | Data |
---|---|---|
811644b8 PP |
1 | # The MIT License (MIT) |
2 | # | |
3 | # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com> | |
4 | # | |
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: | |
11 | # | |
12 | # The above copyright notice and this permission notice shall be included in | |
13 | # all copies or substantial portions of the Software. | |
14 | # | |
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 | |
21 | # THE SOFTWARE. | |
22 | ||
23 | from bt2 import native_bt, object, utils | |
3fb99a22 PP |
24 | from bt2 import interrupter as bt2_interrupter |
25 | from bt2 import connection as bt2_connection | |
26 | from bt2 import component as bt2_component | |
811644b8 | 27 | import functools |
3fb99a22 PP |
28 | from bt2 import port as bt2_port |
29 | from bt2 import logging as bt2_logging | |
811644b8 PP |
30 | import bt2 |
31 | ||
32 | ||
cfbd7cf3 FD |
33 | def _graph_port_added_listener_from_native( |
34 | user_listener, component_ptr, component_type, port_ptr, port_type | |
35 | ): | |
3fb99a22 | 36 | component = bt2_component._create_component_from_ptr_and_get_ref( |
cfbd7cf3 FD |
37 | component_ptr, component_type |
38 | ) | |
3fb99a22 | 39 | port = bt2_port._create_from_ptr_and_get_ref(port_ptr, port_type) |
5f25509b | 40 | user_listener(component, port) |
811644b8 PP |
41 | |
42 | ||
cfbd7cf3 FD |
43 | def _graph_ports_connected_listener_from_native( |
44 | user_listener, | |
45 | upstream_component_ptr, | |
46 | upstream_component_type, | |
47 | upstream_port_ptr, | |
48 | downstream_component_ptr, | |
49 | downstream_component_type, | |
50 | downstream_port_ptr, | |
51 | ): | |
3fb99a22 | 52 | upstream_component = bt2_component._create_component_from_ptr_and_get_ref( |
cfbd7cf3 FD |
53 | upstream_component_ptr, upstream_component_type |
54 | ) | |
3fb99a22 | 55 | upstream_port = bt2_port._create_from_ptr_and_get_ref( |
cfbd7cf3 FD |
56 | upstream_port_ptr, native_bt.PORT_TYPE_OUTPUT |
57 | ) | |
3fb99a22 | 58 | downstream_component = bt2_component._create_component_from_ptr_and_get_ref( |
cfbd7cf3 FD |
59 | downstream_component_ptr, downstream_component_type |
60 | ) | |
3fb99a22 | 61 | downstream_port = bt2_port._create_from_ptr_and_get_ref( |
cfbd7cf3 FD |
62 | downstream_port_ptr, native_bt.PORT_TYPE_INPUT |
63 | ) | |
64 | user_listener( | |
65 | upstream_component, upstream_port, downstream_component, downstream_port | |
66 | ) | |
811644b8 PP |
67 | |
68 | ||
78288f58 | 69 | class Graph(object._SharedObject): |
2f16a6a2 PP |
70 | _get_ref = staticmethod(native_bt.graph_get_ref) |
71 | _put_ref = staticmethod(native_bt.graph_put_ref) | |
601c0026 | 72 | |
056deb59 PP |
73 | def __init__(self, mip_version=0): |
74 | utils._check_uint64(mip_version) | |
75 | ||
76 | if mip_version > bt2.get_maximal_mip_version(): | |
77 | raise ValueError('unknown MIP version {}'.format(mip_version)) | |
78 | ||
79 | ptr = native_bt.graph_create(mip_version) | |
811644b8 PP |
80 | |
81 | if ptr is None: | |
694c792b | 82 | raise bt2._MemoryError('cannot create graph object') |
811644b8 PP |
83 | |
84 | super().__init__(ptr) | |
85 | ||
cfbd7cf3 FD |
86 | def add_component( |
87 | self, | |
88 | component_class, | |
89 | name, | |
90 | params=None, | |
66964f3f | 91 | obj=None, |
3fb99a22 | 92 | logging_level=bt2_logging.LoggingLevel.NONE, |
cfbd7cf3 | 93 | ): |
3fb99a22 | 94 | if isinstance(component_class, bt2_component._SourceComponentClass): |
5f25509b | 95 | cc_ptr = component_class._ptr |
66964f3f | 96 | add_fn = native_bt.bt2_graph_add_source_component |
894a8df5 | 97 | cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE |
3fb99a22 | 98 | elif isinstance(component_class, bt2_component._FilterComponentClass): |
5f25509b | 99 | cc_ptr = component_class._ptr |
66964f3f | 100 | add_fn = native_bt.bt2_graph_add_filter_component |
894a8df5 | 101 | cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER |
3fb99a22 | 102 | elif isinstance(component_class, bt2_component._SinkComponentClass): |
5f25509b | 103 | cc_ptr = component_class._ptr |
66964f3f | 104 | add_fn = native_bt.bt2_graph_add_sink_component |
5f25509b | 105 | cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK |
3fb99a22 | 106 | elif issubclass(component_class, bt2_component._UserSourceComponent): |
85906b6b | 107 | cc_ptr = component_class._bt_cc_ptr |
66964f3f | 108 | add_fn = native_bt.bt2_graph_add_source_component |
5f25509b | 109 | cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE |
3fb99a22 | 110 | elif issubclass(component_class, bt2_component._UserSinkComponent): |
85906b6b | 111 | cc_ptr = component_class._bt_cc_ptr |
66964f3f | 112 | add_fn = native_bt.bt2_graph_add_sink_component |
894a8df5 | 113 | cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK |
3fb99a22 | 114 | elif issubclass(component_class, bt2_component._UserFilterComponent): |
85906b6b | 115 | cc_ptr = component_class._bt_cc_ptr |
66964f3f | 116 | add_fn = native_bt.bt2_graph_add_filter_component |
5f25509b | 117 | cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER |
811644b8 | 118 | else: |
cfbd7cf3 FD |
119 | raise TypeError( |
120 | "'{}' is not a component class".format( | |
121 | component_class.__class__.__name__ | |
122 | ) | |
123 | ) | |
811644b8 PP |
124 | |
125 | utils._check_str(name) | |
e874da19 | 126 | utils._check_log_level(logging_level) |
66964f3f PP |
127 | base_cc_ptr = component_class._bt_component_class_ptr() |
128 | ||
129 | if obj is not None and not native_bt.bt2_is_python_component_class(base_cc_ptr): | |
130 | raise ValueError('cannot pass a Python object to a non-Python component') | |
811644b8 | 131 | |
66964f3f | 132 | params = bt2.create_value(params) |
601c0026 | 133 | params_ptr = params._ptr if params is not None else None |
811644b8 | 134 | |
66964f3f PP |
135 | status, comp_ptr = add_fn( |
136 | self._ptr, cc_ptr, name, params_ptr, obj, logging_level | |
137 | ) | |
d24d5663 | 138 | utils._handle_func_status(status, 'cannot add component to graph') |
894a8df5 | 139 | assert comp_ptr |
3fb99a22 | 140 | return bt2_component._create_component_from_ptr(comp_ptr, cc_type) |
811644b8 PP |
141 | |
142 | def connect_ports(self, upstream_port, downstream_port): | |
3fb99a22 PP |
143 | utils._check_type(upstream_port, bt2_port._OutputPort) |
144 | utils._check_type(downstream_port, bt2_port._InputPort) | |
cfbd7cf3 FD |
145 | status, conn_ptr = native_bt.graph_connect_ports( |
146 | self._ptr, upstream_port._ptr, downstream_port._ptr | |
147 | ) | |
148 | utils._handle_func_status(status, 'cannot connect component ports within graph') | |
149 | assert conn_ptr | |
3fb99a22 | 150 | return bt2_connection._Connection._create_from_ptr(conn_ptr) |
811644b8 | 151 | |
5f25509b SM |
152 | def add_port_added_listener(self, listener): |
153 | if not callable(listener): | |
811644b8 PP |
154 | raise TypeError("'listener' parameter is not callable") |
155 | ||
d24d5663 | 156 | fn = native_bt.bt2_graph_add_port_added_listener |
cfbd7cf3 FD |
157 | listener_from_native = functools.partial( |
158 | _graph_port_added_listener_from_native, listener | |
159 | ) | |
811644b8 | 160 | |
5f25509b SM |
161 | listener_ids = fn(self._ptr, listener_from_native) |
162 | if listener_ids is None: | |
694c792b | 163 | raise bt2._Error('cannot add listener to graph object') |
416379bc | 164 | |
3fb99a22 | 165 | return utils._ListenerHandle(listener_ids, self) |
5f25509b SM |
166 | |
167 | def add_ports_connected_listener(self, listener): | |
168 | if not callable(listener): | |
169 | raise TypeError("'listener' parameter is not callable") | |
170 | ||
d24d5663 | 171 | fn = native_bt.bt2_graph_add_ports_connected_listener |
cfbd7cf3 FD |
172 | listener_from_native = functools.partial( |
173 | _graph_ports_connected_listener_from_native, listener | |
174 | ) | |
5f25509b SM |
175 | |
176 | listener_ids = fn(self._ptr, listener_from_native) | |
177 | if listener_ids is None: | |
694c792b | 178 | raise bt2._Error('cannot add listener to graph object') |
416379bc | 179 | |
3fb99a22 | 180 | return utils._ListenerHandle(listener_ids, self) |
811644b8 | 181 | |
8cc0e6ea PP |
182 | def run_once(self): |
183 | status = native_bt.graph_run_once(self._ptr) | |
184 | utils._handle_func_status(status, 'graph object could not run once') | |
185 | ||
811644b8 PP |
186 | def run(self): |
187 | status = native_bt.graph_run(self._ptr) | |
188 | ||
d24d5663 | 189 | try: |
9b4f9b42 | 190 | utils._handle_func_status(status, 'graph object stopped running') |
d24d5663 PP |
191 | except bt2.Stop: |
192 | # done | |
811644b8 | 193 | return |
d24d5663 PP |
194 | except Exception: |
195 | raise | |
811644b8 | 196 | |
9b4f9b42 | 197 | def add_interrupter(self, interrupter): |
3fb99a22 | 198 | utils._check_type(interrupter, bt2_interrupter.Interrupter) |
9b4f9b42 | 199 | native_bt.graph_add_interrupter(self._ptr, interrupter._ptr) |
811644b8 | 200 | |
9b4f9b42 PP |
201 | def interrupt(self): |
202 | native_bt.graph_interrupt(self._ptr) |