decoders/ir_irmp/irmp_library.py

   1 ##
   2 ## This file is part of the libsigrokdecode project.
   3 ##
   4 ## Copyright (C) 2019 Rene Staffen
   5 ##
   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.
  10 ##
  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.
  15 ##
  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/>.
  18 ##
  19
  20 '''
  21 Python binding for the IRMP library.
  22 '''
  23
  24 import ctypes
  25 import platform
  26
  27 class IrmpLibrary:
  28     '''
  29     Library instance for an infrared protocol detector.
  30     '''
  31
  32     class ResultData(ctypes.Structure):
  33         _fields_ = [
  34             ( 'protocol', ctypes.c_uint32, ),
  35             ( 'protocol_name', ctypes.c_char_p, ),
  36             ( 'address', ctypes.c_uint32, ),
  37             ( 'command', ctypes.c_uint32, ),
  38             ( 'flags', ctypes.c_uint32, ),
  39             ( 'start_sample', ctypes.c_uint32, ),
  40             ( 'end_sample', ctypes.c_uint32, ),
  41         ]
  42
  43     FLAG_REPETITION = 1 << 0
  44     FLAG_RELEASE = 1 << 1
  45
  46     def _library_filename(self):
  47         '''
  48         Determine the library filename depending on the platform.
  49         '''
  50
  51         if platform.uname()[0] == 'Linux':
  52             return 'libirmp.so'
  53         if platform.uname()[0] == 'Darwin':
  54             return 'libirmp.dylib'
  55         return 'irmp.dll'
  56
  57     def __init__(self):
  58         '''
  59         Create a library instance.
  60         '''
  61
  62         # Load the library. Lookup routines, declare their prototypes.
  63         filename = self._library_filename()
  64         self._lib = ctypes.cdll.LoadLibrary(filename)
  65
  66         self._lib.irmp_get_sample_rate.restype = ctypes.c_uint32
  67         self._lib.irmp_get_sample_rate.argtypes = []
  68
  69         self._lib.irmp_reset_state.restype = None
  70         self._lib.irmp_reset_state.argtypes = []
  71
  72         self._lib.irmp_add_one_sample.restype = ctypes.c_int
  73         self._lib.irmp_add_one_sample.argtypes = [ ctypes.c_int, ]
  74
  75         if False:
  76             self._lib.irmp_detect_buffer.restype = self.ResultData
  77             self._lib.irmp_detect_buffer.argtypes = [ ctypes.POINTER(ctypes.c_uint8), ctypes.c_size_t, ]
  78
  79         self._lib.irmp_get_result_data.restype = ctypes.c_int
  80         self._lib.irmp_get_result_data.argtypes = [ ctypes.POINTER(self.ResultData), ]
  81
  82         self._lib.irmp_get_protocol_name.restype = ctypes.c_char_p
  83         self._lib.irmp_get_protocol_name.argtypes = [ ctypes.c_uint32, ]
  84
  85         # Create a result buffer that's local to the library instance.
  86         self._data = self.ResultData()
  87
  88     def get_sample_rate(self):
  89         return self._lib.irmp_get_sample_rate()
  90
  91     def reset_state(self):
  92         self._lib.irmp_reset_state()
  93
  94     def add_one_sample(self, level):
  95         if not self._lib.irmp_add_one_sample(int(level)):
  96             return False
  97         self._lib.irmp_get_result_data(ctypes.byref(self._data))
  98         return True
  99
 100     def get_result_data(self):
 101         data = {
 102             'proto_nr': self._data.protocol,
 103             'proto_name': self._data.protocol_name.decode('UTF-8', 'ignore'),
 104             'address': self._data.address,
 105             'command': self._data.command,
 106             'repeat': bool(self._data.flags & self.FLAG_REPETITION),
 107             'release': bool(self._data.flags & self.FLAG_RELEASE),
 108             'start': self._data.start_sample,
 109             'end': self._data.end_sample,
 110         }
 111         return data