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
  45     def _library_filename(self):
  46         '''
  47         Determine the library filename depending on the platform.
  48         '''
  49
  50         if platform.uname()[0] == 'Linux':
  51             return 'libirmp.so'
  52         # TODO Add support for more platforms.
  53         return 'irmp.dll'
  54
  55     def __init__(self):
  56         '''
  57         Create a library instance.
  58         '''
  59
  60         # Load the library. Lookup routines, declare their prototypes.
  61         filename = self._library_filename()
  62         self._lib = ctypes.cdll.LoadLibrary(filename)
  63
  64         self._lib.irmp_get_sample_rate.restype = ctypes.c_uint32
  65         self._lib.irmp_get_sample_rate.argtypes = []
  66
  67         self._lib.irmp_reset_state.restype = None
  68         self._lib.irmp_reset_state.argtypes = []
  69
  70         self._lib.irmp_add_one_sample.restype = ctypes.c_int
  71         self._lib.irmp_add_one_sample.argtypes = [ ctypes.c_int, ]
  72
  73         if False:
  74             self._lib.irmp_detect_buffer.restype = self.ResultData
  75             self._lib.irmp_detect_buffer.argtypes = [ ctypes.POINTER(ctypes.c_uint8), ctypes.c_size_t, ]
  76
  77         self._lib.irmp_get_result_data.restype = ctypes.c_int
  78         self._lib.irmp_get_result_data.argtypes = [ ctypes.POINTER(self.ResultData), ]
  79
  80         self._lib.irmp_get_protocol_name.restype = ctypes.c_char_p
  81         self._lib.irmp_get_protocol_name.argtypes = [ ctypes.c_uint32, ]
  82
  83         # Create a result buffer that's local to the library instance.
  84         self._data = self.ResultData()
  85
  86     def get_sample_rate(self):
  87         return self._lib.irmp_get_sample_rate()
  88
  89     def reset_state(self):
  90         self._lib.irmp_reset_state()
  91
  92     def add_one_sample(self, level):
  93         if not self._lib.irmp_add_one_sample(int(level)):
  94             return False
  95         self._lib.irmp_get_result_data(ctypes.byref(self._data))
  96         return True
  97
  98     def get_result_data(self):
  99         data = {
 100             'proto_nr': self._data.protocol,
 101             'proto_name': self._data.protocol_name.decode('UTF-8', 'ignore'),
 102             'address': self._data.address,
 103             'command': self._data.command,
 104             'repeat': bool(self._data.flags & self.FLAG_REPETITION),
 105             'start': self._data.start_sample,
 106             'end': self._data.end_sample,
 107         }
 108         return data