src/bindings/python/bt2/bt2/graph.py

   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
  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
  28 import functools
  29 from bt2 import port as bt2_port
  30 from bt2 import logging as bt2_logging
  31 import bt2
  32
  33
  34 def _graph_port_added_listener_from_native(
  35     user_listener, component_ptr, component_type, port_ptr, port_type
  36 ):
  37     component = bt2_component._create_component_from_ptr_and_get_ref(
  38         component_ptr, component_type
  39     )
  40     port = bt2_port._create_from_ptr_and_get_ref(port_ptr, port_type)
  41     user_listener(component, port)
  42
  43
  44 def _graph_ports_connected_listener_from_native(
  45     user_listener,
  46     upstream_component_ptr,
  47     upstream_component_type,
  48     upstream_port_ptr,
  49     downstream_component_ptr,
  50     downstream_component_type,
  51     downstream_port_ptr,
  52 ):
  53     upstream_component = bt2_component._create_component_from_ptr_and_get_ref(
  54         upstream_component_ptr, upstream_component_type
  55     )
  56     upstream_port = bt2_port._create_from_ptr_and_get_ref(
  57         upstream_port_ptr, native_bt.PORT_TYPE_OUTPUT
  58     )
  59     downstream_component = bt2_component._create_component_from_ptr_and_get_ref(
  60         downstream_component_ptr, downstream_component_type
  61     )
  62     downstream_port = bt2_port._create_from_ptr_and_get_ref(
  63         downstream_port_ptr, native_bt.PORT_TYPE_INPUT
  64     )
  65     user_listener(
  66         upstream_component, upstream_port, downstream_component, downstream_port
  67     )
  68
  69
  70 class Graph(object._SharedObject):
  71     _get_ref = staticmethod(native_bt.graph_get_ref)
  72     _put_ref = staticmethod(native_bt.graph_put_ref)
  73
  74     def __init__(self):
  75         ptr = native_bt.graph_create()
  76
  77         if ptr is None:
  78             raise bt2._MemoryError('cannot create graph object')
  79
  80         super().__init__(ptr)
  81
  82     def add_component(
  83         self,
  84         component_class,
  85         name,
  86         params=None,
  87         obj=None,
  88         logging_level=bt2_logging.LoggingLevel.NONE,
  89     ):
  90         if isinstance(component_class, bt2_component._SourceComponentClass):
  91             cc_ptr = component_class._ptr
  92             add_fn = native_bt.bt2_graph_add_source_component
  93             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
  94         elif isinstance(component_class, bt2_component._FilterComponentClass):
  95             cc_ptr = component_class._ptr
  96             add_fn = native_bt.bt2_graph_add_filter_component
  97             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
  98         elif isinstance(component_class, bt2_component._SinkComponentClass):
  99             cc_ptr = component_class._ptr
 100             add_fn = native_bt.bt2_graph_add_sink_component
 101             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
 102         elif issubclass(component_class, bt2_component._UserSourceComponent):
 103             cc_ptr = component_class._bt_cc_ptr
 104             add_fn = native_bt.bt2_graph_add_source_component
 105             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
 106         elif issubclass(component_class, bt2_component._UserSinkComponent):
 107             cc_ptr = component_class._bt_cc_ptr
 108             add_fn = native_bt.bt2_graph_add_sink_component
 109             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
 110         elif issubclass(component_class, bt2_component._UserFilterComponent):
 111             cc_ptr = component_class._bt_cc_ptr
 112             add_fn = native_bt.bt2_graph_add_filter_component
 113             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
 114         else:
 115             raise TypeError(
 116                 "'{}' is not a component class".format(
 117                     component_class.__class__.__name__
 118                 )
 119             )
 120
 121         utils._check_str(name)
 122         utils._check_log_level(logging_level)
 123         base_cc_ptr = component_class._bt_component_class_ptr()
 124
 125         if obj is not None and not native_bt.bt2_is_python_component_class(base_cc_ptr):
 126             raise ValueError('cannot pass a Python object to a non-Python component')
 127
 128         params = bt2.create_value(params)
 129         params_ptr = params._ptr if params is not None else None
 130
 131         status, comp_ptr = add_fn(
 132             self._ptr, cc_ptr, name, params_ptr, obj, logging_level
 133         )
 134         utils._handle_func_status(status, 'cannot add component to graph')
 135         assert comp_ptr
 136         return bt2_component._create_component_from_ptr(comp_ptr, cc_type)
 137
 138     def connect_ports(self, upstream_port, downstream_port):
 139         utils._check_type(upstream_port, bt2_port._OutputPort)
 140         utils._check_type(downstream_port, bt2_port._InputPort)
 141         status, conn_ptr = native_bt.graph_connect_ports(
 142             self._ptr, upstream_port._ptr, downstream_port._ptr
 143         )
 144         utils._handle_func_status(status, 'cannot connect component ports within graph')
 145         assert conn_ptr
 146         return bt2_connection._Connection._create_from_ptr(conn_ptr)
 147
 148     def add_port_added_listener(self, listener):
 149         if not callable(listener):
 150             raise TypeError("'listener' parameter is not callable")
 151
 152         fn = native_bt.bt2_graph_add_port_added_listener
 153         listener_from_native = functools.partial(
 154             _graph_port_added_listener_from_native, listener
 155         )
 156
 157         listener_ids = fn(self._ptr, listener_from_native)
 158         if listener_ids is None:
 159             raise bt2._Error('cannot add listener to graph object')
 160
 161         return utils._ListenerHandle(listener_ids, self)
 162
 163     def add_ports_connected_listener(self, listener):
 164         if not callable(listener):
 165             raise TypeError("'listener' parameter is not callable")
 166
 167         fn = native_bt.bt2_graph_add_ports_connected_listener
 168         listener_from_native = functools.partial(
 169             _graph_ports_connected_listener_from_native, listener
 170         )
 171
 172         listener_ids = fn(self._ptr, listener_from_native)
 173         if listener_ids is None:
 174             raise bt2._Error('cannot add listener to graph object')
 175
 176         return utils._ListenerHandle(listener_ids, self)
 177
 178     def run_once(self):
 179         status = native_bt.graph_run_once(self._ptr)
 180         utils._handle_func_status(status, 'graph object could not run once')
 181
 182     def run(self):
 183         status = native_bt.graph_run(self._ptr)
 184
 185         try:
 186             utils._handle_func_status(status, 'graph object stopped running')
 187         except bt2.Stop:
 188             # done
 189             return
 190         except Exception:
 191             raise
 192
 193     def add_interrupter(self, interrupter):
 194         utils._check_type(interrupter, bt2_interrupter.Interrupter)
 195         native_bt.graph_add_interrupter(self._ptr, interrupter._ptr)
 196
 197     def interrupt(self):
 198         native_bt.graph_interrupt(self._ptr)
 199
 200     def create_output_port_message_iterator(self, output_port):
 201         utils._check_type(output_port, bt2_port._OutputPort)
 202         msg_iter_ptr = native_bt.port_output_message_iterator_create(
 203             self._ptr, output_port._ptr
 204         )
 205
 206         if msg_iter_ptr is None:
 207             raise bt2._MemoryError('cannot create output port message iterator')
 208
 209         return bt2_message_iterator._OutputPortMessageIterator(msg_iter_ptr)