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 import collections
.abc
30 def find_plugins(path
, recurse
=True):
31 utils
._check
_str
(path
)
32 utils
._check
_bool
(recurse
)
35 if os
.path
.isfile(path
):
36 plugin_set_ptr
= native_bt
.plugin_find_all_from_file(path
)
37 elif os
.path
.isdir(path
):
38 plugin_set_ptr
= native_bt
.plugin_find_all_from_dir(path
, int(recurse
))
40 if plugin_set_ptr
is None:
43 return _PluginSet
._create
_from
_ptr
(plugin_set_ptr
)
46 def find_plugin(name
):
47 utils
._check
_str
(name
)
48 ptr
= native_bt
.plugin_find(name
)
53 return _Plugin
._create
_from
_ptr
(ptr
)
56 class _PluginSet(object._SharedObject
, collections
.abc
.Sequence
):
57 _put_ref
= staticmethod(native_bt
.plugin_set_put_ref
)
58 _get_ref
= staticmethod(native_bt
.plugin_set_get_ref
)
61 count
= native_bt
.plugin_set_get_plugin_count(self
._ptr
)
65 def __getitem__(self
, index
):
66 utils
._check
_uint
64(index
)
68 if index
>= len(self
):
71 plugin_ptr
= native_bt
.plugin_set_borrow_plugin_by_index_const(self
._ptr
, index
)
72 assert plugin_ptr
is not None
73 return _Plugin
._create
_from
_ptr
_and
_get
_ref
(plugin_ptr
)
77 def __init__(self
, major
, minor
, patch
, extra
):
102 if self
._extra
is not None:
105 return '{}.{}.{}{}'.format(self
._major
, self
._minor
, self
._patch
, extra
)
108 class _PluginComponentClassesIterator(collections
.abc
.Iterator
):
109 def __init__(self
, plugin_comp_cls
):
110 self
._plugin
_comp
_cls
= plugin_comp_cls
114 plugin_ptr
= self
._plugin
_comp
_cls
._plugin
._ptr
115 total
= self
._plugin
_comp
_cls
._component
_class
_count
(plugin_ptr
)
117 if self
._at
== total
:
120 comp_cls_ptr
= self
._plugin
_comp
_cls
._borrow
_component
_class
_by
_index
(plugin_ptr
, self
._at
)
121 assert comp_cls_ptr
is not None
124 comp_cls_type
= self
._plugin
_comp
_cls
._comp
_cls
_type
125 comp_cls_pycls
= bt2
.component
._COMP
_CLS
_TYPE
_TO
_GENERIC
_COMP
_CLS
_PYCLS
[comp_cls_type
]
126 comp_cls_ptr
= comp_cls_pycls
._as
_component
_class
_ptr
(comp_cls_ptr
)
127 name
= native_bt
.component_class_get_name(comp_cls_ptr
)
128 assert name
is not None
132 class _PluginComponentClasses(collections
.abc
.Mapping
):
133 def __init__(self
, plugin
):
134 self
._plugin
= plugin
136 def __getitem__(self
, key
):
137 utils
._check
_str
(key
)
138 cc_ptr
= self
._borrow
_component
_class
_by
_name
(self
._plugin
._ptr
, key
)
143 return bt2
.component
._create
_component
_class
_from
_ptr
_and
_get
_ref
(cc_ptr
, self
._comp
_cls
_type
)
146 return self
._component
_class
_count
(self
._plugin
._ptr
)
149 return _PluginComponentClassesIterator(self
)
152 class _PluginSourceComponentClasses(_PluginComponentClasses
):
153 _component_class_count
= staticmethod(native_bt
.plugin_get_source_component_class_count
)
154 _borrow_component_class_by_name
= staticmethod(native_bt
.plugin_borrow_source_component_class_by_name_const
)
155 _borrow_component_class_by_index
= staticmethod(native_bt
.plugin_borrow_source_component_class_by_index_const
)
156 _comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SOURCE
159 class _PluginFilterComponentClasses(_PluginComponentClasses
):
160 _component_class_count
= staticmethod(native_bt
.plugin_get_filter_component_class_count
)
161 _borrow_component_class_by_name
= staticmethod(native_bt
.plugin_borrow_filter_component_class_by_name_const
)
162 _borrow_component_class_by_index
= staticmethod(native_bt
.plugin_borrow_filter_component_class_by_index_const
)
163 _comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_FILTER
166 class _PluginSinkComponentClasses(_PluginComponentClasses
):
167 _component_class_count
= staticmethod(native_bt
.plugin_get_sink_component_class_count
)
168 _borrow_component_class_by_name
= staticmethod(native_bt
.plugin_borrow_sink_component_class_by_name_const
)
169 _borrow_component_class_by_index
= staticmethod(native_bt
.plugin_borrow_sink_component_class_by_index_const
)
170 _comp_cls_type
= native_bt
.COMPONENT_CLASS_TYPE_SINK
173 class _Plugin(object._SharedObject
):
174 _put_ref
= staticmethod(native_bt
.plugin_put_ref
)
175 _get_ref
= staticmethod(native_bt
.plugin_get_ref
)
179 name
= native_bt
.plugin_get_name(self
._ptr
)
180 assert(name
is not None)
185 return native_bt
.plugin_get_author(self
._ptr
)
189 return native_bt
.plugin_get_license(self
._ptr
)
192 def description(self
):
193 return native_bt
.plugin_get_description(self
._ptr
)
197 return native_bt
.plugin_get_path(self
._ptr
)
201 status
, major
, minor
, patch
, extra
= native_bt
.plugin_get_version_wrapper(self
._ptr
)
203 if status
== native_bt
.PROPERTY_AVAILABILITY_NOT_AVAILABLE
:
206 return _PluginVersion(major
, minor
, patch
, extra
)
209 def source_component_classes(self
):
210 return _PluginSourceComponentClasses(self
)
213 def filter_component_classes(self
):
214 return _PluginFilterComponentClasses(self
)
217 def sink_component_classes(self
):
218 return _PluginSinkComponentClasses(self
)