]> sigrok.org Git - libsigrokdecode.git/blobdiff - instance.c
srd_inst_decode(): Improve comments and log messages.
[libsigrokdecode.git] / instance.c
index d0e9d0ac5f663626da3a7545b59f74beb450b666..b4f9cfd67638dbc54ac214641e64b31976bb4d1d 100644 (file)
@@ -18,9 +18,9 @@
  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 
+#include <config.h>
 #include "libsigrokdecode-internal.h" /* First, so we avoid a _POSIX_C_SOURCE warning. */
 #include "libsigrokdecode.h"
-#include "config.h"
 #include <glib.h>
 #include <inttypes.h>
 #include <stdlib.h>
@@ -30,8 +30,8 @@
 
 extern SRD_PRIV GSList *sessions;
 
-/* type_logic.c */
-extern SRD_PRIV PyTypeObject srd_logic_type;
+/* module_sigrokdecode.c */
+extern SRD_PRIV PyObject *srd_logic_type;
 
 /** @endcond */
 
@@ -163,7 +163,7 @@ SRD_API int srd_inst_option_set(struct srd_decoder_inst *di,
 err_out:
        Py_XDECREF(py_optval);
        if (PyErr_Occurred()) {
-               srd_exception_catch("Stray exception in srd_inst_option_set().");
+               srd_exception_catch("Stray exception in srd_inst_option_set()");
                ret = SRD_ERR_PYTHON;
        }
 
@@ -187,16 +187,13 @@ static gint compare_channel_id(const struct srd_channel *pdch,
  * @param new_channels A GHashTable of channels to set. Key is channel name,
  *                     value is the channel number. Samples passed to this
  *                     instance will be arranged in this order.
- * @param unit_size Number of bytes per sample in the data stream to be passed
- *                  to the decoder. The highest channel index specified in the
- *                  channel map must lie within a sample unit.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
- * @since 0.3.0
+ * @since 0.4.0
  */
 SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
-               GHashTable *new_channels, int unit_size)
+               GHashTable *new_channels)
 {
        GVariant *channel_val;
        GList *l;
@@ -205,9 +202,8 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
        int *new_channelmap, new_channelnum, num_required_channels, i;
        char *channel_id;
 
-       srd_dbg("Setting channels for instance %s with list of %d channels, "
-               "unitsize %d.", di->inst_id, g_hash_table_size(new_channels),
-               unit_size);
+       srd_dbg("Setting channels for instance %s with list of %d channels.",
+               di->inst_id, g_hash_table_size(new_channels));
 
        if (g_hash_table_size(new_channels) == 0)
                /* No channels provided. */
@@ -220,12 +216,7 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                return SRD_ERR_ARG;
        }
 
-       new_channelmap = NULL;
-
-       if (!(new_channelmap = g_try_malloc(sizeof(int) * di->dec_num_channels))) {
-               srd_err("Failed to g_malloc() new channel map.");
-               return SRD_ERR_MALLOC;
-       }
+       new_channelmap = g_malloc(sizeof(int) * di->dec_num_channels);
 
        /*
         * For now, map all indexes to channel -1 (can be overridden later).
@@ -245,12 +236,6 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                        return SRD_ERR_ARG;
                }
                new_channelnum = g_variant_get_int32(channel_val);
-               if (new_channelnum >= 8 * unit_size) {
-                       srd_err("Channel index %d not within data unit (%d bit).",
-                               new_channelnum, 8 * unit_size);
-                       g_free(new_channelmap);
-                       return SRD_ERR_ARG;
-               }
                if (!(sl = g_slist_find_custom(di->decoder->channels, channel_id,
                                (GCompareFunc)compare_channel_id))) {
                        /* Fall back on optional channels. */
@@ -267,7 +252,6 @@ SRD_API int srd_inst_channel_set_all(struct srd_decoder_inst *di,
                srd_dbg("Setting channel mapping: %s (index %d) = channel %d.",
                        pdch->id, pdch->order, new_channelnum);
        }
-       di->data_unitsize = unit_size;
 
        srd_dbg("Final channel map:");
        num_required_channels = g_slist_length(di->decoder->channels);
@@ -325,10 +309,7 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
                return NULL;
        }
 
-       if (!(di = g_try_malloc0(sizeof(struct srd_decoder_inst)))) {
-               srd_err("Failed to g_malloc() instance.");
-               return NULL;
-       }
+       di = g_malloc0(sizeof(struct srd_decoder_inst));
 
        di->decoder = dec;
        di->sess = sess;
@@ -346,31 +327,21 @@ SRD_API struct srd_decoder_inst *srd_inst_new(struct srd_session *sess,
        di->dec_num_channels = g_slist_length(di->decoder->channels) +
                        g_slist_length(di->decoder->opt_channels);
        if (di->dec_num_channels) {
-               if (!(di->dec_channelmap =
-                               g_try_malloc(sizeof(int) * di->dec_num_channels))) {
-                       srd_err("Failed to g_malloc() channel map.");
-                       g_free(di);
-                       return NULL;
-               }
+               di->dec_channelmap =
+                               g_malloc(sizeof(int) * di->dec_num_channels);
                for (i = 0; i < di->dec_num_channels; i++)
                        di->dec_channelmap[i] = i;
-               di->data_unitsize = (di->dec_num_channels + 7) / 8;
                /*
                 * Will be used to prepare a sample at every iteration
                 * of the instance's decode() method.
                 */
-               if (!(di->channel_samples = g_try_malloc(di->dec_num_channels))) {
-                       srd_err("Failed to g_malloc() sample buffer.");
-                       g_free(di->dec_channelmap);
-                       g_free(di);
-                       return NULL;
-               }
+               di->channel_samples = g_malloc(di->dec_num_channels);
        }
 
        /* Create a new instance of this decoder class. */
        if (!(di->py_inst = PyObject_CallObject(dec->py_dec, NULL))) {
                if (PyErr_Occurred())
-                       srd_exception_catch("failed to create %s instance: ",
+                       srd_exception_catch("Failed to create %s instance",
                                        decoder_id);
                g_free(di->dec_channelmap);
                g_free(di);
@@ -534,7 +505,7 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
                        di->inst_id);
 
        if (!(py_res = PyObject_CallMethod(di->py_inst, "start", NULL))) {
-               srd_exception_catch("Protocol decoder instance %s",
+               srd_exception_catch("Protocol decoder instance %s",
                                di->inst_id);
                return SRD_ERR_PYTHON;
        }
@@ -551,7 +522,7 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
 }
 
 /**
- * Run the specified decoder function.
+ * Decode a chunk of samples.
  *
  * @param di The decoder instance to call. Must not be NULL.
  * @param start_samplenum The starting sample number for the buffer's sample
@@ -560,24 +531,19 @@ SRD_PRIV int srd_inst_start(struct srd_decoder_inst *di)
  *                       set, relative to the start of capture.
  * @param inbuf The buffer to decode. Must not be NULL.
  * @param inbuflen Length of the buffer. Must be > 0.
+ * @param unitsize The number of bytes per sample. Must be > 0.
  *
  * @return SRD_OK upon success, a (negative) error code otherwise.
  *
  * @private
- *
- * @since 0.1.0
  */
 SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
                uint64_t start_samplenum, uint64_t end_samplenum,
-               const uint8_t *inbuf, uint64_t inbuflen)
+               const uint8_t *inbuf, uint64_t inbuflen, uint64_t unitsize)
 {
        PyObject *py_res;
        srd_logic *logic;
 
-       srd_dbg("Calling decode() on instance %s with %" PRIu64 " bytes "
-               "starting at sample %" PRIu64 ".", di->inst_id, inbuflen,
-               start_samplenum);
-
        /* Return an error upon unusable input. */
        if (!di) {
                srd_dbg("empty decoder instance");
@@ -592,11 +558,19 @@ SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
                return SRD_ERR_ARG;
        }
 
+       ((struct srd_decoder_inst *)di)->data_unitsize = unitsize;
+
+       srd_dbg("Decoding: start sample %" PRIu64 ", end sample %"
+               PRIu64 " (%" PRIu64 " samples, %" PRIu64 " bytes, unitsize = "
+               "%d), instance %s.", start_samplenum, end_samplenum,
+               end_samplenum - start_samplenum, inbuflen, di->data_unitsize,
+               di->inst_id);
+
        /*
         * Create new srd_logic object. Each iteration around the PD's loop
         * will fill one sample into this object.
         */
-       logic = PyObject_New(srd_logic, &srd_logic_type);
+       logic = PyObject_New(srd_logic, (PyTypeObject *)srd_logic_type);
        Py_INCREF(logic);
        logic->di = (struct srd_decoder_inst *)di;
        logic->start_samplenum = start_samplenum;
@@ -609,7 +583,7 @@ SRD_PRIV int srd_inst_decode(const struct srd_decoder_inst *di,
        Py_IncRef(di->py_inst);
        if (!(py_res = PyObject_CallMethod(di->py_inst, "decode",
                        "KKO", start_samplenum, end_samplenum, logic))) {
-               srd_exception_catch("Protocol decoder instance %s",
+               srd_exception_catch("Protocol decoder instance %s",
                                di->inst_id);
                return SRD_ERR_PYTHON;
        }