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

   1 # SPDX-License-Identifier: MIT
   2 #
   3 # Copyright (c) 2017 Philippe Proulx <pproulx@efficios.com>
   4
   5 from bt2 import native_bt, object, utils
   6 from bt2 import interrupter as bt2_interrupter
   7 from bt2 import connection as bt2_connection
   8 from bt2 import component as bt2_component
   9 import functools
  10 from bt2 import port as bt2_port
  11 from bt2 import logging as bt2_logging
  12 import bt2
  13
  14
  15 def _graph_port_added_listener_from_native(
  16     user_listener, component_ptr, component_type, port_ptr, port_type
  17 ):
  18     component = bt2_component._create_component_from_const_ptr_and_get_ref(
  19         component_ptr, component_type
  20     )
  21     port = bt2_port._create_from_const_ptr_and_get_ref(port_ptr, port_type)
  22     user_listener(component, port)
  23
  24
  25 class Graph(object._SharedObject):
  26     _get_ref = staticmethod(native_bt.graph_get_ref)
  27     _put_ref = staticmethod(native_bt.graph_put_ref)
  28
  29     def __init__(self, mip_version=0):
  30         utils._check_uint64(mip_version)
  31
  32         if mip_version > bt2.get_maximal_mip_version():
  33             raise ValueError('unknown MIP version {}'.format(mip_version))
  34
  35         ptr = native_bt.graph_create(mip_version)
  36
  37         if ptr is None:
  38             raise bt2._MemoryError('cannot create graph object')
  39
  40         super().__init__(ptr)
  41
  42         # list of listener partials to keep a reference as long as
  43         # this graph exists
  44         self._listener_partials = []
  45
  46     def add_component(
  47         self,
  48         component_class,
  49         name,
  50         params=None,
  51         obj=None,
  52         logging_level=bt2_logging.LoggingLevel.NONE,
  53     ):
  54         if isinstance(component_class, bt2_component._SourceComponentClassConst):
  55             cc_ptr = component_class._ptr
  56             add_fn = native_bt.bt2_graph_add_source_component
  57             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
  58         elif isinstance(component_class, bt2_component._FilterComponentClassConst):
  59             cc_ptr = component_class._ptr
  60             add_fn = native_bt.bt2_graph_add_filter_component
  61             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
  62         elif isinstance(component_class, bt2_component._SinkComponentClassConst):
  63             cc_ptr = component_class._ptr
  64             add_fn = native_bt.bt2_graph_add_sink_component
  65             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
  66         elif issubclass(component_class, bt2_component._UserSourceComponent):
  67             cc_ptr = component_class._bt_cc_ptr
  68             add_fn = native_bt.bt2_graph_add_source_component
  69             cc_type = native_bt.COMPONENT_CLASS_TYPE_SOURCE
  70         elif issubclass(component_class, bt2_component._UserSinkComponent):
  71             cc_ptr = component_class._bt_cc_ptr
  72             add_fn = native_bt.bt2_graph_add_sink_component
  73             cc_type = native_bt.COMPONENT_CLASS_TYPE_SINK
  74         elif issubclass(component_class, bt2_component._UserFilterComponent):
  75             cc_ptr = component_class._bt_cc_ptr
  76             add_fn = native_bt.bt2_graph_add_filter_component
  77             cc_type = native_bt.COMPONENT_CLASS_TYPE_FILTER
  78         else:
  79             raise TypeError(
  80                 "'{}' is not a component class".format(
  81                     component_class.__class__.__name__
  82                 )
  83             )
  84
  85         utils._check_str(name)
  86         utils._check_log_level(logging_level)
  87         base_cc_ptr = component_class._bt_component_class_ptr()
  88
  89         if obj is not None and not native_bt.bt2_is_python_component_class(base_cc_ptr):
  90             raise ValueError('cannot pass a Python object to a non-Python component')
  91
  92         if params is not None and not isinstance(params, (dict, bt2.MapValue)):
  93             raise TypeError("'params' parameter is not a 'dict' or a 'bt2.MapValue'.")
  94
  95         params = bt2.create_value(params)
  96
  97         params_ptr = params._ptr if params is not None else None
  98
  99         status, comp_ptr = add_fn(
 100             self._ptr, cc_ptr, name, params_ptr, obj, logging_level
 101         )
 102         utils._handle_func_status(status, 'cannot add component to graph')
 103         assert comp_ptr
 104         return bt2_component._create_component_from_const_ptr_and_get_ref(
 105             comp_ptr, cc_type
 106         )
 107
 108     def connect_ports(self, upstream_port, downstream_port):
 109         utils._check_type(upstream_port, bt2_port._OutputPortConst)
 110         utils._check_type(downstream_port, bt2_port._InputPortConst)
 111         status, conn_ptr = native_bt.graph_connect_ports(
 112             self._ptr, upstream_port._ptr, downstream_port._ptr
 113         )
 114         utils._handle_func_status(status, 'cannot connect component ports within graph')
 115         assert conn_ptr
 116         return bt2_connection._ConnectionConst._create_from_ptr_and_get_ref(conn_ptr)
 117
 118     def add_port_added_listener(self, listener):
 119         if not callable(listener):
 120             raise TypeError("'listener' parameter is not callable")
 121
 122         fn = native_bt.bt2_graph_add_port_added_listener
 123         listener_from_native = functools.partial(
 124             _graph_port_added_listener_from_native, listener
 125         )
 126
 127         listener_ids = fn(self._ptr, listener_from_native)
 128         if listener_ids is None:
 129             raise bt2._Error('cannot add listener to graph object')
 130
 131         # keep the partial's reference
 132         self._listener_partials.append(listener_from_native)
 133
 134     def run_once(self):
 135         status = native_bt.graph_run_once(self._ptr)
 136         utils._handle_func_status(status, 'graph object could not run once')
 137
 138     def run(self):
 139         status = native_bt.graph_run(self._ptr)
 140         utils._handle_func_status(status, 'graph object stopped running')
 141
 142     def add_interrupter(self, interrupter):
 143         utils._check_type(interrupter, bt2_interrupter.Interrupter)
 144         native_bt.graph_add_interrupter(self._ptr, interrupter._ptr)
 145
 146     @property
 147     def default_interrupter(self):
 148         ptr = native_bt.graph_borrow_default_interrupter(self._ptr)
 149         return bt2_interrupter.Interrupter._create_from_ptr_and_get_ref(ptr)