DNNRT.h

Go to the documentation of this file.

/*
 *  DNNRT.h - Spresense Arduino DNN runtime library 
 *  Copyright 2018 Sony Semiconductor Solutions Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef Dnnrt_h
#define Dnnrt_h
 
#ifdef SUBCORE
#error "DNNRT library is NOT supported by SubCore."
#endif
 
#include <Arduino.h>
 
#include <dnnrt/runtime.h>
 
class DNNVariable; // forward reference
class File;
 
class DNNRT {
 
public:
  DNNRT() {};
  ~DNNRT() {};
 
  int begin(File &nnbfile, unsigned char cpu_num = 1);
 
  int end();
 
  int inputVariable(DNNVariable &var, unsigned int index);
 
  DNNVariable& outputVariable(unsigned int index);
 
  int forward();
 
  int numOfInput();
 
  int inputSize(unsigned int index);
 
  int inputDimension(unsigned int index);
 
  int inputShapeSize(unsigned int index, unsigned int shapeindex);
 
  int numOfOutput();
 
  int outputSize(unsigned int index);
 
  int outputDimension(unsigned int index);
 
  int outputShapeSize(unsigned int index, unsigned int shapeindex);
 
private:
  dnn_runtime_t *_rt;            // DNN runtime context
  nn_network_t  *_network;       // Network data from .nnb file
 
  void         **_input;         // Input data array
  int            _nr_inputs;     // Number of input data
  DNNVariable   *_output;        // Output data array
  int            _nr_outputs;    // Number of output data
};
 
class DNNVariable {
  friend class DNNRT;
 
public:
  DNNVariable(unsigned int size);
  ~DNNVariable();
 
  unsigned int size() {
    return _size;
  }
 
  const float& operator[](unsigned int index) const {
    return _data[index];
  }
 
  float *data() {
    return _data;
  }
 
  int maxIndex();
 
private:
  DNNVariable();
  float *_data;
  unsigned int _size;
  bool _allocated;
};
 
#endif