lasp/cpp_src/pybind11/lasp_pyindatahandler.cpp

/* #define DEBUGTRACE_ENABLED */
#include "arma_npy.h"
#include "debugtrace.hpp"
#include "lasp_clip.h"
#include "lasp_daq.h"
#include "lasp_daqdata.h"
#include "lasp_ppm.h"
#include "lasp_rtaps.h"
#include "lasp_rtsignalviewer.h"
#include "lasp_streammgr.h"
#include "lasp_threadedindatahandler.h"
#include <armadillo>
#include <atomic>
#include <chrono>
#include <pybind11/pybind11.h>

using namespace std::literals::chrono_literals;
using std::cerr;
using std::endl;

namespace py = pybind11;

/**
 * @brief Generate a Numpy array from daqdata, does *NOT* create a copy of the
 * data!. Instead, it shares the data from the DaqData container.
 *
 * @tparam T The type of the stored sample
 * @param d The daqdata to convert
 *
 * @return Numpy array
 */
template <typename T, bool copy = false>
py::array_t<T> getPyArrayNoCpy(const DaqData &d) {
  // https://github.com/pybind/pybind11/issues/323
  //
  // When a valid object is passed as 'base', it tells pybind not to take
  // ownership of the data, because 'base' will own it. In fact 'packet' will
  // own it, but - psss! - , we don't tell it to pybind... Alos note that ANY
  // valid object is good for this purpose, so I choose "str"...

  py::str dummyDataOwner;
  /*
   * Signature:
   array_t(ShapeContainer shape,
   StridesContainer strides,
   const T *ptr = nullptr,
   handle base = handle());
   */

  return py::array_t<T>(
      py::array::ShapeContainer({d.nframes, d.nchannels}), // Shape

      py::array::StridesContainer( // Strides
          {sizeof(T),
           sizeof(T) * d.nframes}), // Strides (in bytes) for each index

      reinterpret_cast<T *>(
          const_cast<DaqData &>(d).raw_ptr()), // Pointer to buffer

      dummyDataOwner // As stated above, now Numpy does not take ownership of
                     // the data pointer.
  );
}

template <typename T, bool copy = false>
py::array_t<d> dmat_to_ndarray(const DaqData &d) {
  // https://github.com/pybind/pybind11/issues/323
  //
  // When a valid object is passed as 'base', it tells pybind not to take
  // ownership of the data, because 'base' will own it. In fact 'packet' will
  // own it, but - psss! - , we don't tell it to pybind... Alos note that ANY
  // valid object is good for this purpose, so I choose "str"...

  py::str dummyDataOwner;
  /*
   * Signature:
   array_t(ShapeContainer shape,
   StridesContainer strides,
   const T *ptr = nullptr,
   handle base = handle());
   */

  return py::array_t<T>(
      py::array::ShapeContainer({d.nframes, d.nchannels}), // Shape

      py::array::StridesContainer( // Strides
          {sizeof(T),
           sizeof(T) * d.nframes}), // Strides (in bytes) for each index

      reinterpret_cast<T *>(
          const_cast<DaqData &>(d).raw_ptr()), // Pointer to buffer

      dummyDataOwner // As stated above, now Numpy does not take ownership of
                     // the data pointer.
  );
}

/**
 * @brief Wraps the ThreadedInDataHandler such that it calls a Python callback
 * with a buffer of sample data. Converts DaqData objects to Numpy arrays and
 * calls Python given as argument to the constructor
 */
class PyIndataHandler : public ThreadedInDataHandler<PyIndataHandler> {
  /**
   * @brief The callback functions that is called.
   */
  std::unique_ptr<py::function> cb, reset_callback;
  bool _done{false};

 public:
  /**
   * @brief Initialize PyIndataHandler
   *
   * @param mgr StreamMgr handle
   * @param cb Python callback that is called with Numpy input data from device
   * @param reset_callback Python callback that is called with a Daq pointer.
   * Careful: do not store this handle, as it is only valid as long as reset()
   * is called, when a stream stops, this pointer / handle will dangle.
   */
  PyIndataHandler(SmgrHandle mgr, py::function cb, py::function reset_callback)
      : ThreadedInDataHandler(mgr),
        cb(std::make_unique<py::function>(cb)),
        reset_callback(std::make_unique<py::function>(reset_callback)) {
    DEBUGTRACE_ENTER;
    /// Start should be called externally, as at constructor time no virtual
    /// functions should be called.
    py::gil_scoped_release release;
    startThread();
  }
  ~PyIndataHandler() {
    DEBUGTRACE_ENTER;
    /// Callback cannot be called, which results in a deadlock on the GIL
    /// without this release.
    py::gil_scoped_release release;
    stopThread();
  }
  /**
   * @brief Calls the reset callback in Python.
   *
   * @param daq Daq device, or nullptr in case no input stream is running.
   */
  void reset(const Daq *daq) {
    DEBUGTRACE_ENTER;
    if (_done) return;
    try {
      py::gil_scoped_acquire acquire;
      if (daq) {
        (*reset_callback)(daq);
      } else {
        (*reset_callback)(py::none());
      }
    } catch (py::error_already_set &e) {
      cerr << "*************** Error calling reset callback!\n";
      cerr << e.what() << endl;
      cerr << "*************** \n";
      /// Throwing a runtime error here does not work out one way or another.
      /// Therefore, it is better to dive out and prevent undefined behaviour
      abort();
      /* throw std::runtime_error(e.what()); */
    } catch (std::exception &e) {
      cerr << "Caught unknown exception in reset callback:" << e.what() << endl;
      abort();
    }
  }

  /**
   * @brief Calls the Python callback method / function with a Numpy array of
   * stream data.
   */
  void inCallback(const DaqData &d) {

    /* DEBUGTRACE_ENTER; */

    using DataType = DataTypeDescriptor::DataType;
    if (_done) return;

    try {
      py::gil_scoped_acquire acquire;
      py::object bool_val;
      switch (d.dtype) {
        case (DataType::dtype_int8): {
          bool_val = (*cb)(getPyArrayNoCpy<int8_t>(d));
        } break;
        case (DataType::dtype_int16): {
          bool_val = (*cb)(getPyArrayNoCpy<int16_t>(d));
        } break;
        case (DataType::dtype_int32): {
          bool_val = (*cb)(getPyArrayNoCpy<int32_t>(d));
        } break;
        case (DataType::dtype_fl32): {
          bool_val = (*cb)(getPyArrayNoCpy<float>(d));
        } break;
        case (DataType::dtype_fl64): {
          bool_val = (*cb)(getPyArrayNoCpy<double>(d));
        } break;
        default:
          throw std::runtime_error("BUG");
      }  // End of switch

      bool res = bool_val.cast<bool>();
      if (res == false) {
        DEBUGTRACE_PRINT("Setting callbacks to None")
        _done = true;
        // cb = py::function(py::none());
        // reset_callback = py::function(py::none());
        cb.reset();
        reset_callback.reset();
      }
    } catch (py::error_already_set &e) {
      cerr << "ERROR: Python raised exception from callback function: ";
      cerr << e.what() << endl;
      abort();
    } catch (py::cast_error &e) {
      cerr << e.what() << endl;
      cerr << "ERROR: Python callback does not return boolean value." << endl;
      abort();
    } catch (std::exception &e) {
      cerr << "Caught unknown exception in Python callback:" << e.what()
           << endl;
      abort();
    }
  }
};

void init_datahandler(py::module &m) {

  /// The C++ class is PyIndataHandler, but for Python, it is called
  /// InDataHandler
  py::class_<PyIndataHandler> pyidh(m, "InDataHandler");
  pyidh.def(py::init<SmgrHandle, py::function, py::function>());

  /// Peak Programme Meter
  py::class_<PPMHandler> ppm(m, "PPMHandler");
  ppm.def(py::init<SmgrHandle, const d>());
  ppm.def(py::init<SmgrHandle>());

  ppm.def("getCurrentValue", [](const PPMHandler &ppm) {
    std::tuple<vd, arma::uvec> tp;
    {
      py::gil_scoped_release release;
      tp = ppm.getCurrentValue();
    }

    return py::make_tuple(ColToNpy<d>(std::get<0>(tp)),
                          ColToNpy<arma::uword>(std::get<1>(tp)));
  });

  /// Clip Detector
  py::class_<ClipHandler> clip(m, "ClipHandler");
  clip.def(py::init<SmgrHandle>());

  clip.def("getCurrentValue", [](const ClipHandler &clip) {
    arma::uvec cval;
    {
      py::gil_scoped_release release;
      cval = clip.getCurrentValue();
    }

    return ColToNpy<arma::uword>(cval); // something goes wrong here
  });

  /// Real time Aps
  ///
  py::class_<RtAps> rtaps(m, "RtAps");
  rtaps.def(py::init<SmgrHandle,               // StreamMgr
                     Filter *const,            // FreqWeighting filter
                     const us,                 // Nfft
                     const Window::WindowType, // Window
                     const d,                  // Overlap percentage 0<=o<100

                     const d // Time constant
                     >(),
            py::arg("streammgr"), // StreamMgr
            py::arg("preFilter").none(true),
            /// Below list of arguments *SHOULD* be same as for

            /// AvPowerSpectra constructor!
            py::arg("nfft") = 2048,                           //
            py::arg("windowType") = Window::WindowType::Hann, //
            py::arg("overlap_percentage") = 50.0,             //
            py::arg("time_constant") = -1                     //
  );

  rtaps.def("getCurrentValue", [](RtAps &rt) {
    ccube val;
    {
      py::gil_scoped_release release;
      val = rt.getCurrentValue();
    }
    return CubeToNpy<c>(val);
  });

  /// Real time Signal Viewer
  ///
  py::class_<RtSignalViewer> rtsv(m, "RtSignalViewer");
  rtsv.def(py::init<SmgrHandle, // StreamMgr
                    const d,    // Time history
                    const us,   // Resolution
                    const us    // Channel number
                    >());

  rtsv.def("getCurrentValue", [](RtSignalViewer &rt) {
    dmat val;
    {
      py::gil_scoped_release release;
      val = rt.getCurrentValue();
    }
    return MatToNpy<d>(val);
  });
}