libsigrokdecode: Move decoder metadata into Decoder object.

diff --git a/decode.c b/decode.c
index fb35517e8a526d16e4662bba9b952bf9bd37d806..9899985ca52d523586ce974fad151ea1a01b7c5c 100644 (file)
--- a/decode.c
+++ b/decode.c
@@ -56,6 +56,8 @@ emb_put(PyObject *self, PyObject *args)
 {
        PyObject *arg;
        
 {
        PyObject *arg;
        

+       (void)self;
+

        if (!PyArg_ParseTuple(args, "O:put", &arg))
                return NULL;
 
        if (!PyArg_ParseTuple(args, "O:put", &arg))
                return NULL;
 


@@ -168,7 +170,7 @@ static int h_str(PyObject *py_res, PyObject *py_mod,
        char *str;
        int ret;
 
        char *str;
        int ret;
 

-       py_str = PyMapping_GetItemString(py_res, (char *)key);
+       py_str = PyObject_GetAttrString(py_res, (char *)key); /* NEWREF */

        if (!py_str || !PyString_Check(py_str)) {
                ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
                goto err_h_decref_mod;
        if (!py_str || !PyString_Check(py_str)) {
                ret = SRD_ERR_PYTHON; /* TODO: More specific error? */
                goto err_h_decref_mod;


@@ -215,9 +217,10 @@ static int srd_load_decoder(const char *name,
                              struct srd_decoder **dec)
 {
        struct srd_decoder *d;
                              struct srd_decoder **dec)
 {
        struct srd_decoder *d;

-       PyObject *py_mod, *py_func, *py_res, *py_instance = NULL, *py_args, *py_value/* , *py_tuple */;
+       PyObject *py_mod, *py_res;
+       PyObject *py_args, *py_value, *py_instance;

        int r;
        int r;

-       fprintf(stdout, "\n%s\n", name);
+       fprintf(stdout, "%s: %s\n", __func__, name);

 
        /* "Import" the Python module. */
        if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */
 
        /* "Import" the Python module. */
        if (!(py_mod = PyImport_ImportModule(name))) { /* NEWREF */


@@ -225,22 +228,21 @@ static int srd_load_decoder(const char *name,
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 

-       /* Get the 'register' dictionary as Python object. */
-       py_res = PyObject_GetAttrString(py_mod, "register"); /* NEWREF */
-       if (!py_res || PyCallable_Check(py_res)) {
+       /* Get the 'Decoder' class as Python object. */
+       py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
+       if (!py_res) {

                if (PyErr_Occurred())
                        PyErr_Print(); /* Returns void. */
                Py_XDECREF(py_mod);
                if (PyErr_Occurred())
                        PyErr_Print(); /* Returns void. */
                Py_XDECREF(py_mod);

-               fprintf(stderr, "register dictionary was not found or is declared a function.\n");
+               fprintf(stderr, "Decoder class not found in PD module %s\n", name);

                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 
                return SRD_ERR_PYTHON; /* TODO: More specific error? */
        }
 

-

        if (!(d = malloc(sizeof(struct srd_decoder))))
                return SRD_ERR_MALLOC;
 
        if (!(d = malloc(sizeof(struct srd_decoder))))
                return SRD_ERR_MALLOC;
 

-       if ((r = h_str(py_res, py_mod, "id", &(d->id))) < 0)
-               return r;
+       /* We'll just use the name of the module for the id */
+       d->id = strdup(name);

 
        if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
                return r;
 
        if ((r = h_str(py_res, py_mod, "name", &(d->name))) < 0)
                return r;


@@ -266,61 +268,35 @@ static int srd_load_decoder(const char *name,
                return r;
 
        d->py_mod = py_mod;
                return r;
 
        d->py_mod = py_mod;

+       d->py_decobj = py_res;

 
 

-       Py_XDECREF(py_res);
-       
-       
-       /* Get the 'Decoder' class as Python object. */
-       py_res = PyObject_GetAttrString(py_mod, "Decoder"); /* NEWREF */
-       if (!py_res) {
+       /* Create a Python tuple of size 1. */
+       if (!(py_args = PyTuple_New(0))) { /* NEWREF */

                if (PyErr_Occurred())
                        PyErr_Print(); /* Returns void. */
                if (PyErr_Occurred())
                        PyErr_Print(); /* Returns void. */

-               //Py_XDECREF(py_mod);
-               fprintf(stderr, "Decoder class not found in PD module %s\n", name);
-               //return SRD_ERR_PYTHON; /* TODO: More specific error? */
-               
-               
-               /* Get the 'decode' function name as Python callable object. */
-               py_func = PyObject_GetAttrString(py_mod, "decode"); /* NEWREF */
-               if (!py_func || !PyCallable_Check(py_func)) {
-                       if (PyErr_Occurred())
-                               PyErr_Print(); /* Returns void. */
-                       Py_XDECREF(py_mod);
-                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
-               }
-       } else {
-               PyObject_Print(py_res, stdout, Py_PRINT_RAW);
-               fprintf(stdout, "\n");

                
                

-               /* Create a Python tuple of size 1. */
-               if (!(py_args = PyTuple_New(0))) { /* NEWREF */
-                       if (PyErr_Occurred())
-                               PyErr_Print(); /* Returns void. */
-                       
-                       Py_XDECREF(py_res);
-                       Py_XDECREF(py_mod);
-                       
-                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
-               }
+               Py_XDECREF(py_res);
+               Py_XDECREF(py_mod);

                
                

-               py_value = Py_BuildValue("{sssisd}", 
-                                         "driver", "demo",
-                                         "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
-                                         "starttime", 129318231823.0 //TODO: Fill with something reasonable.
-                                         );
-               /* Create an instance of the Decoder class */
-               py_instance = PyObject_Call(py_res, py_args, py_value);
-               if (!py_instance) {
-                       if (PyErr_Occurred())
-                               PyErr_Print(); /* Returns void. */
-                       Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
-                       Py_XDECREF(py_res);
-                       Py_XDECREF(py_mod);
-                       fprintf(stderr, "Unable to create instance of Decoder class in PD module %s\n", name);
-                       return SRD_ERR_PYTHON; /* TODO: More specific error? */
-               } 
+               return SRD_ERR_PYTHON; /* TODO: More specific error? */

        }
        }

-
+       
+       py_value = Py_BuildValue("{sssisd}", 
+                                 "driver", "demo",
+                                 "unitsize", _unitsize, //FIXME: Pass in a unitsize that matches the selected LA
+                                 "starttime", 129318231823.0 //TODO: Fill with something reasonable.
+                                 );
+       /* Create an instance of the Decoder class */
+       py_instance = PyObject_Call(py_res, py_args, py_value);
+       if (!py_instance) {
+               if (PyErr_Occurred())
+                       PyErr_Print(); /* Returns void. */
+               Py_XDECREF(py_value); /* TODO: Ref. stolen upon error? */
+               Py_XDECREF(py_res);
+               Py_XDECREF(py_mod);
+               fprintf(stderr, "Unable to create instance of Decoder class in PD module %s\n", name);
+               return SRD_ERR_PYTHON; /* TODO: More specific error? */
+       } 

        d->py_instance = py_instance;
 
        /* TODO: Handle func, inputformats, outputformats. */
        d->py_instance = py_instance;
 
        /* TODO: Handle func, inputformats, outputformats. */

diff --git a/decoders/spi.py b/decoders/spi.py
index 4c6619688f3bc07fe2285279a5520315a942008d..997119cad8e9e55573706cc199938a7455b7777e 100644 (file)
--- a/decoders/spi.py
+++ b/decoders/spi.py
@@ -1,107 +1,114 @@
+##
+## This file is part of the sigrok project.
+##
+## Copyright (C) 2011 Gareth McMullin <gareth@blacksphere.co.nz>
+##
+## 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, write to the Free Software
+## Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
+##

 class Sample():
 class Sample():

-       def __init__(self, data):
-               self.data = data
-       def probe(self, probe):
-               s = ord(self.data[probe / 8]) & (1 << (probe % 8))
-               return True if s else False
+    def __init__(self, data):
+        self.data = data
+    def probe(self, probe):
+        s = ord(self.data[probe / 8]) & (1 << (probe % 8))
+        return True if s else False

 
 def sampleiter(data, unitsize):
 
 def sampleiter(data, unitsize):

-       for i in range(0, len(data), unitsize):
-               yield(Sample(data[i:i+unitsize]))
+    for i in range(0, len(data), unitsize):
+        yield(Sample(data[i:i+unitsize]))

 
 class Decoder():
 
 class Decoder():

-       # Probe names with a set of defaults
-       probes = {'sdata':0, 'sck':1}
-
-       def __init__(self, unitsize, **kwargs):
-               # Metadata comes in here, we don't care for now
-               #print kwargs
-               self.unitsize = unitsize
-
-               self.probes = Decoder.probes
-               self.oldsck = True
-               self.rxcount = 0
-               self.rxdata = 0
-               self.bytesreceived = 0
-
-       def summary(self):
-               return "SPI: %d bytes received" % self.bytesreceived
-
-       def decode(self, data):
-               # We should accept a list of samples and iterate...
-               for sample in sampleiter(data["data"], self.unitsize):
-
-                       sck = sample.probe(self.probes["sck"])
-                       # Sample SDATA on rising SCK
-                       if sck == self.oldsck:
-                               continue
-                       self.oldsck = sck
-                       if not sck: 
-                               continue        
-
-                       # If this is first bit, save timestamp
-                       if self.rxcount == 0:
-                               self.time = data["time"]
-                       # Receive bit into our shift register
-                       sdata = sample.probe(self.probes["sdata"])
-                       if sdata:
-                               self.rxdata |= 1 << (7 - self.rxcount)
-                       self.rxcount += 1
-                       # Continue to receive if not a byte yet
-                       if self.rxcount != 8:
-                               continue
-                       # Received a byte, pass up to sigrok
-                       outdata = {"time":self.time,
-                               "duration":data["time"] + data["duration"] - self.time,
-                               "data":self.rxdata,
-                               "display":("%02X" % self.rxdata),
-                               "type":"spi",
-                       }
-                       print outdata
-                       sigrok.put(outdata)
-                       # Reset decoder state
-                       self.rxdata = 0
-                       self.rxcount = 0
-                       # Keep stats for summary
-                       self.bytesreceived += 1
-                       
-
-register = {
-       'id': 'spi',
-       'name': 'SPI Decoder',
-       'longname': '...',
-       'desc': 'Decodes SPI frames',
-       'longdesc': '...',
-       'author': 'Gareth McMullin',
-       'email': 'gareth@blacksphere.co.nz',
-       'license': 'gplv2+',
-       'in': ['logic'],
-       'out': ['spi'],
-       'probes': [
-               # All probes.
-       ],
-       'options': {
-               # No options so far.
-       },
-       # 'start': start,
-       # 'report': report,
-}
-
+    name = 'SPI Decoder'
+    desc = '...desc...'
+    longname = '...longname...'
+    longdesc = '...longdesc...'
+    author = 'Gareth McMullin'
+    email = 'gareth@blacksphere.co.nz'
+    license = 'gplv2+'
+    inputs = ['logic']
+    outputs = ['spi']
+    # Probe names with a set of defaults
+    probes = {'sdata':0, 'sck':1}
+    options = {}
+
+    def __init__(self, unitsize, **kwargs):
+        # Metadata comes in here, we don't care for now
+        #print kwargs
+        self.unitsize = unitsize
+
+        self.probes = Decoder.probes
+        self.oldsck = True
+        self.rxcount = 0
+        self.rxdata = 0
+        self.bytesreceived = 0
+
+    def report(self):
+        return "SPI: %d bytes received" % self.bytesreceived
+
+    def decode(self, data):
+        # We should accept a list of samples and iterate...
+        for sample in sampleiter(data["data"], self.unitsize):
+
+            sck = sample.probe(self.probes["sck"])
+            # Sample SDATA on rising SCK
+            if sck == self.oldsck:
+                continue
+            self.oldsck = sck
+            if not sck: 
+                continue    
+
+            # If this is first bit, save timestamp
+            if self.rxcount == 0:
+                self.time = data["time"]
+            # Receive bit into our shift register
+            sdata = sample.probe(self.probes["sdata"])
+            if sdata:
+                self.rxdata |= 1 << (7 - self.rxcount)
+            self.rxcount += 1
+            # Continue to receive if not a byte yet
+            if self.rxcount != 8:
+                continue
+            # Received a byte, pass up to sigrok
+            outdata = {"time":self.time,
+                "duration":data["time"] + data["duration"] - self.time,
+                "data":self.rxdata,
+                "display":("%02X" % self.rxdata),
+                "type":"spi",
+            }
+            print outdata
+            sigrok.put(outdata)
+            # Reset decoder state
+            self.rxdata = 0
+            self.rxcount = 0
+            # Keep stats for summary
+            self.bytesreceived += 1
+            

 if __name__ == "__main__":
 if __name__ == "__main__":

-       data = open("spi_dump.bin").read()
+    data = open("spi_dump.bin").read()

 
 

-       # dummy class to keep Decoder happy for test
-       class Sigrok():
-               def put(self, data):
-                       print "\t", data
-       sigrok = Sigrok()
+    # dummy class to keep Decoder happy for test
+    class Sigrok():
+        def put(self, data):
+            print "\t", data
+    sigrok = Sigrok()

 
 

-       dec = Decoder(driver='ols', unitsize=1, starttime=0)
-       dec.decode({"time":0, "duration":len(data), "data":data, "type":"logic"})
+    dec = Decoder(driver='ols', unitsize=1, starttime=0)
+    dec.decode({"time":0, "duration":len(data), "data":data, "type":"logic"})

 
 

-       print dec.summary()
+    print dec.summary()

 else:
 else:

-       import sigrok
+    import sigrok

 
 #Tested with:
 #  sigrok-cli -d 0:samplerate=1000000:rle=on --time=1s -p 1,2 -a spidec
 
 #Tested with:
 #  sigrok-cli -d 0:samplerate=1000000:rle=on --time=1s -p 1,2 -a spidec

diff --git a/sigrokdecode.h b/sigrokdecode.h
index fde9208a5f27120f848a22b947f2b90aa095d95f..9f7925282fd7a92f4e3e0dc80a8b8735ca4ef2d4 100644 (file)
--- a/sigrokdecode.h
+++ b/sigrokdecode.h
@@ -91,7 +91,8 @@ struct srd_decoder {
        /** TODO */
        PyObject *py_mod;
 
        /** TODO */
        PyObject *py_mod;
 

-       /** Python function that performs the decoding */
+       /** Python object that performs the decoding */
+       PyObject *py_decobj;

        PyObject *py_instance;
 };
 
        PyObject *py_instance;
 };