2 ## This file is part of the libsigrokdecode project.
4 ## Copyright (C) 2019 Rene Staffen
6 ## This program is free software; you can redistribute it and/or modify
7 ## it under the terms of the GNU General Public License as published by
8 ## the Free Software Foundation; either version 2 of the License, or
9 ## (at your option) any later version.
11 ## This program is distributed in the hope that it will be useful,
12 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
13 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ## GNU General Public License for more details.
16 ## You should have received a copy of the GNU General Public License
17 ## along with this program; if not, see <http://www.gnu.org/licenses/>.
21 Python binding for the IRMP library.
29 Library instance for an infrared protocol detector.
32 __usable_instance = None
34 class ResultData(ctypes.Structure):
36 ( 'protocol', ctypes.c_uint32, ),
37 ( 'protocol_name', ctypes.c_char_p, ),
38 ( 'address', ctypes.c_uint32, ),
39 ( 'command', ctypes.c_uint32, ),
40 ( 'flags', ctypes.c_uint32, ),
41 ( 'start_sample', ctypes.c_uint32, ),
42 ( 'end_sample', ctypes.c_uint32, ),
45 FLAG_REPETITION = 1 << 0
48 def _library_filename(self):
50 Determine the library filename depending on the platform.
53 if platform.uname()[0] == 'Linux':
55 if platform.uname()[0] == 'Darwin':
56 return 'libirmp.dylib'
59 def _library_setup_api(self):
61 Lookup the C library's API routines. Declare their prototypes.
67 self._lib.irmp_get_sample_rate.restype = ctypes.c_uint32
68 self._lib.irmp_get_sample_rate.argtypes = []
70 self._lib.irmp_reset_state.restype = None
71 self._lib.irmp_reset_state.argtypes = []
73 self._lib.irmp_add_one_sample.restype = ctypes.c_int
74 self._lib.irmp_add_one_sample.argtypes = [ ctypes.c_int, ]
77 self._lib.irmp_detect_buffer.restype = self.ResultData
78 self._lib.irmp_detect_buffer.argtypes = [ ctypes.POINTER(ctypes.c_uint8), ctypes.c_size_t, ]
80 self._lib.irmp_get_result_data.restype = ctypes.c_int
81 self._lib.irmp_get_result_data.argtypes = [ ctypes.POINTER(self.ResultData), ]
83 self._lib.irmp_get_protocol_name.restype = ctypes.c_char_p
84 self._lib.irmp_get_protocol_name.argtypes = [ ctypes.c_uint32, ]
86 # Create a result buffer that's local to the library instance.
87 self._data = self.ResultData()
93 Create a library instance.
96 # Only create a working instance for the first invocation.
97 # Degrade all other instances, make them fail "late" during
98 # execution, so that users will see the errors.
101 if IrmpLibrary.__usable_instance is None:
102 filename = self._library_filename()
103 self._lib = ctypes.cdll.LoadLibrary(filename)
104 self._library_setup_api()
105 IrmpLibrary.__usable_instance = self
107 def get_sample_rate(self):
110 return self._lib.irmp_get_sample_rate()
112 def reset_state(self):
115 self._lib.irmp_reset_state()
117 def add_one_sample(self, level):
119 raise Exception("IRMP library limited to a single instance.")
120 if not self._lib.irmp_add_one_sample(int(level)):
122 self._lib.irmp_get_result_data(ctypes.byref(self._data))
125 def get_result_data(self):
129 'proto_nr': self._data.protocol,
130 'proto_name': self._data.protocol_name.decode('UTF-8', 'ignore'),
131 'address': self._data.address,
132 'command': self._data.command,
133 'repeat': bool(self._data.flags & self.FLAG_REPETITION),
134 'release': bool(self._data.flags & self.FLAG_RELEASE),
135 'start': self._data.start_sample,
136 'end': self._data.end_sample,