Merge pull request #5 from ErickOF/feature-filter_module

Adding LT model + PV model documentation

Author: ErickOF

modules/Makefile

@@ -20,26 +20,19 @@ LIBDIR=-L. -L$(SYSTEMC)/lib-linux64
 SOURCES := $(wildcard $(SRCDIR)/*.cpp)
 INCLUDES := $(wildcard $(INCDIR)/*.hpp)
 OBJECTS := $(SOURCES:$(SRCDIR)/%.cpp=$(OBJDIR)/%.o)
-FV_OBJECTS := $(SOURCES:$(SRCDIR)/%.cpp=$(OBJDIR)/%.i)
 
-$(BINDIR)/$(TARGET): $(OBJECTS)
+$(BINDIR)/$(TARGET): clean $(OBJECTS)
 		@$(LD) $(OBJECTS) $(LFLAGS) $(LIBS) $(LIBDIR) -o $@
-		@echo "Linked $@ completed!"
 
 $(OBJECTS): $(OBJDIR)/%.o : $(SRCDIR)/%.cpp
 		@$(CC) $(CFLAGS) $(INCDIR) -c $< -o $@
-		@echo "Compilation $< in $@"
-
-fv_run: $(FV_OBJECTS)
-		cbmc $(FV_OBJECTS) --function sc_main
-
-$(FV_OBJECTS): $(OBJDIR)/%.i : $(SRCDIR)/%.cpp
-		@$(CC) $(CFLAGS) $(INCDIR) -c $< -o $@
-		@echo "FV compilation $< in $@"
 
 .PHONY: clean
 clean:
-		@rm -f $(OBJECTS)
-		@echo "Clean done."
+		@rm -rf obj
+		@rm -f $(TARGET)
+		@mkdir -p obj
+
+compile: $(BINDIR)/$(TARGET)
 
-all: $(BINDIR)/$(TARGET)
+all: compile run

modules/filter/Makefile

@@ -10,33 +10,52 @@ INCLUDES += INCLUDES_STB
 
 # Defining preprocessor directive for debug
 ifdef IPS_DEBUG_EN
-	CFLAGS += -DIPS_DEBUG_EN
-	LFLAGS += -DIPS_DEBUG_EN
+		CFLAGS += -DIPS_DEBUG_EN
+		LFLAGS += -DIPS_DEBUG_EN
 endif # IPS_DEBUG_EN
 
 # Defining preprocessor directive for dumping enable
 ifdef IPS_DUMP_EN
-	CFLAGS += -DIPS_DUMP_EN
-	LFLAGS += -DIPS_DUMP_EN
+		CFLAGS += -DIPS_DUMP_EN
+		LFLAGS += -DIPS_DUMP_EN
 endif # IPS_DUMP_EN
 
-# Defining preprocessor directive for test mode one window random
-ifdef TEST_MODE_ONE_WINDOW_RANDOM
-	CFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_RANDOM
-	LFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_RANDOM
-endif # TEST_MODE_ONE_WINDOW_RANDOM
 
 # Defining preprocessor directive for test mode one wildcard normal
 ifdef TEST_MODE_ONE_WINDOW_NORMAL
-	CFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_NORMAL
-	LFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_NORMAL
+		CFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_NORMAL
+		LFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_NORMAL
 endif # TEST_MODE_ONE_WINDOW_NORMAL
 
+# Defining preprocessor directive for test mode one window random
+ifdef TEST_MODE_ONE_WINDOW_RANDOM
+		CFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_RANDOM
+		LFLAGS += -DTEST_MODE_ONE_WINDOW -DTEST_MODE_ONE_WINDOW_RANDOM
+endif # TEST_MODE_ONE_WINDOW_RANDOM
+
+# Defining preprocessor directive for model - by default PV model
+ifdef IPS_FILTER_LT_EN
+		CFLAGS += -DIPS_FILTER_LT_EN
+		LFLAGS += -DIPS_FILTER_LT_EN
+else # IPS_FILTER_AT_EN
+ifdef IPS_FILTER_AT_EN
+		CFLAGS += -DIPS_FILTER_AT_EN
+		LFLAGS += -DIPS_FILTER_AT_EN
+else # IPS_FILTER_CA_EN
+ifdef IPS_FILTER_CA_EN
+		CFLAGS += -DIPS_FILTER_CA_EN
+		LFLAGS += -DIPS_FILTER_CA_EN
+else # IPS_FILTER_PV_EN
+		CFLAGS += -DIPS_FILTER_PV_EN
+		LFLAGS += -DIPS_FILTER_PV_EN
+endif # IPS_FILTER_CA_EN
+endif # IPS_FILTER_AT_EN
+endif # IPS_FILTER_LT_EN
 
 # Run the compiled file
 run:
-	@./test
+		@./test
 
 # Show waveform
 waveform:
-	@gtkwave ips_filter.vcd
+		@gtkwave ips_filter.vcd

modules/filter/include/ips_filter_lt_model.hpp

@@ -0,0 +1,161 @@
+#ifndef IPS_FILTER_LT_MODEL_HPP
+#define IPS_FILTER_LT_MODEL_HPP
+#ifdef IPS_DEBUG_EN
+#include <iostream>
+#endif // IPS_DEBUG_ENi
+#ifdef IPS_DUMP_EN
+#include <sstream>
+#endif // IPS_DUMP_EN
+#include <systemc.h>
+
+
+/**
+ * @brief Filter module.
+ * It takes care of filtering a image/kernel using a median filter or an
+ * equivalent convolution like:
+ *                 | 1/N^2 ... 1/N^2 |   | img(row - N/2, col - N/2) ... img(row + N/2, col + N/2) |
+ * img(row, col) = |  ...  ...  .... | * |            ...            ...            ...            |
+ *                 | 1/N^2 ... 1/N^2 |   | img(row + N/2, col - N/2) ... img(row + N/2, col + N/2) |
+ *
+ * @tparam IN - data type of the inputs
+ * @tparam OUT - data type of the outputs
+ * @tparam N - size of the kernel
+ */
+template <typename IN = sc_uint<8>, typename OUT = sc_uint<8>, uint8_t N = 3>
+SC_MODULE(Filter)
+{
+protected:
+  //----------------------------Internal Variables----------------------------
+#ifdef IPS_DUMP_EN
+  sc_trace_file* wf;
+#endif // IPS_DUMP_EN
+  OUT* img_window_tmp;
+  OUT* kernel;
+  OUT* result_ptr;
+
+  // Event to trigger the filter execution
+  sc_event event;
+
+  //-----------------------------Internal Methods-----------------------------
+  void exec_filter();
+  void init();
+
+public:
+  /**
+   * @brief Default constructor for Filter
+   */
+  SC_HAS_PROCESS(Filter);
+#ifdef IPS_DUMP_EN
+  /**
+   * @brief Construct a new Filter object
+   * 
+   * @param name - name of the module
+   * @param wf - waveform file pointer
+   */
+  Filter(sc_core::sc_module_name name, sc_core::sc_trace_file* wf)
+    : sc_core::sc_module(name), wf(wf)
+#else
+  /**
+   * @brief Construct a new Filter object
+   * 
+   * @param name - name of the module
+   */
+  Filter(sc_core::sc_module_name name) : sc_core::sc_module(name)
+#endif // IPS_DUMP_EN
+  {
+    // Calling this method by default since it is no time consumer
+    // It is assumed that this kernel is already loaded in the model
+    // Kernel does not change after synthesis
+    SC_METHOD(init);
+    // Thread waiting for the request
+    SC_THREAD(exec_filter);
+  }
+
+  //---------------------------------Methods---------------------------------
+  void filter(IN* img_window, OUT* result);
+};
+
+/**
+ * @brief Execute the image filtering
+ * 
+ */
+template <typename IN, typename OUT, uint8_t N>
+void Filter<IN, OUT, N>::exec_filter()
+{
+  size_t i;
+  size_t j;
+
+  while (true)
+  {
+    // Wait to peform the convolution
+    wait(this->event);
+
+    // Default value for the result depending on the output datatype
+    *(this->result_ptr) = (OUT) 0;
+
+    // Perform the convolution
+    for (i = 0; i < N; ++i)
+      for (j = 0; j < N; ++j)
+        *(this->result_ptr) += this->kernel[i * N + j] * this->img_window_tmp[i * N + j];
+  }
+}
+
+/**
+ * @brief Filtering image
+ * 
+ * @param img_window - image window to filter
+ * @param result - resultant pixel
+ */
+template <typename IN, typename OUT, uint8_t N>
+void Filter<IN, OUT, N>::filter(IN* img_window, OUT* result)
+{
+  size_t i;
+  size_t j;
+
+  // Default value for the result depending on the output datatype
+  this->result_ptr = result;
+
+  // Perform the convolution
+  for (i = 0; i < N; ++i)
+    for (j = 0; j < N; ++j)
+        this->img_window_tmp[i * N + j] = (OUT) img_window[i * N + j];
+
+  this->event.notify(DELAY_TIME, SC_NS);
+}
+
+/**
+ * @brief Initializes a kernel of N x N with default value of 1 / (N^2)
+ * 
+ */
+template <typename IN, typename OUT, uint8_t N>
+void Filter<IN, OUT, N>::init()
+{
+  // Init a kernel of N x N with default value of 1 / (N * N)
+  this->kernel = new OUT[N * N];
+  std::fill_n(this->kernel, N * N, ((OUT) 1) / ((OUT) N * N));
+  // Init image window of N x N with default value of 1 / (N * N)
+  this->img_window_tmp = new OUT[N * N];
+#ifdef IPS_DEBUG_EN
+  // Print the initialized kernel
+  SC_REPORT_INFO(this->name(), "init result");
+  size_t i, j;
+
+  for (i = 0; i < N; ++i)
+  {
+    for (j = 0; j < N; ++j)
+    {
+      std::cout << "[" << this->kernel[i * N + j] << "]";
+
+#ifdef IPS_DUMP_EN
+      // Adding the signals to the waveform
+      std::ostringstream var_name;
+      var_name << "kernel_" << i << "_" << j;
+      sc_trace(this->wf, this->kernel[i * N + j], var_name.str());
+#endif // IPS_DUMP_EN
+    }
+
+    std::cout << std::endl;
+  }
+#endif // IPS_DEBUG_EN
+}
+#endif // IPS_FILTER_LT_MODEL_HPP

modules/filter/include/ips_filter_pv_model.hpp

@@ -1,15 +1,26 @@
-#ifndef IPS_FILTER_FILTER_HPP
-#define IPS_FILTER_FILTER_HPP
+#ifndef IPS_FILTER_PV_MODEL_HPP
+#define IPS_FILTER_PV_MODEL_HPP
 #ifdef IPS_DEBUG_EN
 #include <iostream>
 #endif // IPS_DEBUG_ENi
 #ifdef IPS_DUMP_EN
 #include <sstream>
 #endif // IPS_DUMP_EN
 #include <systemc.h>
-#include <vector>
 
 
+/**
+ * @brief Filter module.
+ * It takes care of filtering a image/kernel using a median filter or an
+ * equivalent convolution like:
+ *                 | 1/N^2 ... 1/N^2 |   | img(row - N/2, col - N/2) ... img(row + N/2, col + N/2) |
+ * img(row, col) = |  ...  ...  .... | * |            ...            ...            ...            |
+ *                 | 1/N^2 ... 1/N^2 |   | img(row + N/2, col - N/2) ... img(row + N/2, col + N/2) |
+ *
+ * @tparam IN - data type of the inputs
+ * @tparam OUT - data type of the outputs
+ * @tparam N - size of the kernel
+ */
 template <typename IN = sc_uint<8>, typename OUT = sc_uint<8>, uint8_t N = 3>
 SC_MODULE(Filter)
 {
@@ -23,11 +34,21 @@ SC_MODULE(Filter)
    * @brief Default constructor for Filter
    */
   SC_CTOR(Filter);
-  //template <typename IN, typename OUT, uint8_t N>
 #ifdef IPS_DUMP_EN
+  /**
+   * @brief Construct a new Filter object
+   * 
+   * @param name - name of the module
+   * @param wf - waveform file pointer
+   */
   Filter(sc_core::sc_module_name name, sc_core::sc_trace_file* wf)
     : sc_core::sc_module(name), wf(wf)
 #else
+  /**
+   * @brief Construct a new Filter object
+   * 
+   * @param name - name of the module
+   */
   Filter(sc_core::sc_module_name name) : sc_core::sc_module(name)
 #endif // IPS_DUMP_EN
   {
@@ -39,26 +60,39 @@ SC_MODULE(Filter)
   void init_kernel();
 };
 
+/**
+ * @brief Filtering image
+ * 
+ * @param img_window - image window to filter
+ * @param result - resultant pixel
+ */
 template <typename IN, typename OUT, uint8_t N>
 void Filter<IN, OUT, N>::filter(IN* img_window, OUT& result)
 {
   size_t i;
   size_t j;
 
+  // Default value for the result depending on the output datatype
   result = (OUT) 0;
 
+  // Perform the convolution
   for (i = 0; i < N; ++i)
     for (j = 0; j < N; ++j)
       result += this->kernel[i * N + j] * ((OUT) img_window[i * N + j]);
 }
 
+/**
+ * @brief Initializes a kernel of N x N with default value of 1 / (N^2)
+ * 
+ */
 template <typename IN, typename OUT, uint8_t N>
 void Filter<IN, OUT, N>::init_kernel()
 {
   // Init a kernel of N x N with default value of 1 / (N * N)
   this->kernel = new OUT[N * N];
   std::fill_n(this->kernel, N * N, ((OUT) 1) / ((OUT) N * N));
 #ifdef IPS_DEBUG_EN
+  // Print the initialized kernel
   SC_REPORT_INFO(this->name(), "init_kernel result");
   size_t i, j;
 
@@ -69,6 +103,7 @@ void Filter<IN, OUT, N>::init_kernel()
       std::cout << "[" << this->kernel[i * N + j] << "]";
 
 #ifdef IPS_DUMP_EN
+      // Adding the signals to the waveform
       std::ostringstream var_name;
       var_name << "kernel_" << i << "_" << j;
       sc_trace(this->wf, this->kernel[i * N + j], var_name.str());
@@ -79,4 +114,4 @@ void Filter<IN, OUT, N>::init_kernel()
   }
 #endif // IPS_DEBUG_EN
 }
-#endif // IPS_FILTER_FILTER_HPP
+#endif // IPS_FILTER_PV_MODEL_HPP