1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
##
## This file is part of the libsigrokdecode project.
##
## Copyright (C) 2019 Rene Staffen
## Copyright (C) 2020-2021 Gerhard Sittig <gerhard.sittig@gmx.net>
##
## This program is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 2 of the License, or
## (at your option) any later version.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program; if not, see <http://www.gnu.org/licenses/>.
##
'''
Python binding for the IRMP library.
'''
import ctypes
import platform
class IrmpLibrary:
'''
Library instance for an infrared protocol detector.
'''
__usable_instance = None
class ResultData(ctypes.Structure):
_fields_ = [
( 'protocol', ctypes.c_uint32, ),
( 'protocol_name', ctypes.c_char_p, ),
( 'address', ctypes.c_uint32, ),
( 'command', ctypes.c_uint32, ),
( 'flags', ctypes.c_uint32, ),
( 'start_sample', ctypes.c_uint32, ),
( 'end_sample', ctypes.c_uint32, ),
]
FLAG_REPETITION = 1 << 0
FLAG_RELEASE = 1 << 1
def _library_filename(self):
'''
Determine the library filename depending on the platform.
'''
if platform.uname()[0] == 'Linux':
return 'libirmp.so'
if platform.uname()[0] == 'Darwin':
return 'libirmp.dylib'
return 'irmp.dll'
def _library_setup_api(self):
'''
Lookup the C library's API routines. Declare their prototypes.
'''
self._lib.irmp_get_sample_rate.restype = ctypes.c_uint32
self._lib.irmp_get_sample_rate.argtypes = []
self._lib.irmp_instance_alloc.restype = ctypes.c_void_p
self._lib.irmp_instance_alloc.argtypes = []
self._lib.irmp_instance_free.restype = None
self._lib.irmp_instance_free.argtypes = [ ctypes.c_void_p, ]
self._lib.irmp_instance_id.restype = ctypes.c_size_t
self._lib.irmp_instance_id.argtypes = [ ctypes.c_void_p, ]
self._lib.irmp_instance_lock.restype = ctypes.c_int
self._lib.irmp_instance_lock.argtypes = [ ctypes.c_void_p, ctypes.c_int, ]
self._lib.irmp_instance_unlock.restype = None
self._lib.irmp_instance_unlock.argtypes = [ ctypes.c_void_p, ]
self._lib.irmp_reset_state.restype = None
self._lib.irmp_reset_state.argtypes = []
self._lib.irmp_add_one_sample.restype = ctypes.c_int
self._lib.irmp_add_one_sample.argtypes = [ ctypes.c_int, ]
if False:
self._lib.irmp_detect_buffer.restype = self.ResultData
self._lib.irmp_detect_buffer.argtypes = [ ctypes.POINTER(ctypes.c_uint8), ctypes.c_size_t, ]
self._lib.irmp_get_result_data.restype = ctypes.c_int
self._lib.irmp_get_result_data.argtypes = [ ctypes.POINTER(self.ResultData), ]
self._lib.irmp_get_protocol_name.restype = ctypes.c_char_p
self._lib.irmp_get_protocol_name.argtypes = [ ctypes.c_uint32, ]
# Create a result buffer that's local to the library instance.
self._data = self.ResultData()
self._inst = None
return True
def __init__(self):
'''
Create a library instance.
'''
filename = self._library_filename()
self._lib = ctypes.cdll.LoadLibrary(filename)
self._library_setup_api()
def __del__(self):
'''
Release a disposed library instance.
'''
if self._inst:
self._lib.irmp_instance_free(self._inst)
self._inst = None
def __enter__(self):
'''
Enter a context (lock management).
'''
if self._inst is None:
self._inst = self._lib.irmp_instance_alloc()
self._lib.irmp_instance_lock(self._inst, 1)
return self
def __exit__(self, extype, exvalue, trace):
'''
Leave a context (lock management).
'''
self._lib.irmp_instance_unlock(self._inst)
return False
def client_id(self):
return self._lib.irmp_instance_id(self._inst)
def get_sample_rate(self):
return self._lib.irmp_get_sample_rate()
def reset_state(self):
self._lib.irmp_reset_state()
def add_one_sample(self, level):
if not self._lib.irmp_add_one_sample(int(level)):
return False
self._lib.irmp_get_result_data(ctypes.byref(self._data))
return True
def get_result_data(self):
if not self._data:
return None
return {
'proto_nr': self._data.protocol,
'proto_name': self._data.protocol_name.decode('UTF-8', 'ignore'),
'address': self._data.address,
'command': self._data.command,
'repeat': bool(self._data.flags & self.FLAG_REPETITION),
'release': bool(self._data.flags & self.FLAG_RELEASE),
'start': self._data.start_sample,
'end': self._data.end_sample,
}
|
