All the functions imported from HLS video library now take xf::cv::Mat (in sync with Vitis vision library) to represent image data instead of hls::Mat. The main difference between these two is that the hls::Mat uses hls::stream to store the data whereas xf::cv::Mat uses a pointer. Therefore, hls:: Mat cannot be exactly replaced with xf::cv::Mat for migrating.
Below table summarizes the differences between member functions of hls::Mat to xf::cv::Mat.
| Member Function | hls::Mat (HLS Video lib) | xf::cv::Mat (Vitis vision lib) |
|---|---|---|
| channels() | Returns the number of channels | Returns the number of channels |
| type() | Returns the enum value of pixel type | Returns the enum value of pixel type |
| depth() | Returns the enum value of pixel type | Returns the depth of pixel including channels |
| read() | Readout a value and return it as a scalar from stream | Readout a value from a given location and return it as a packed (for multi-pixel/clock) value. |
| operator >> | Similar to read() | Not available in Vitis vision |
| operator << | Similar to write() | Not available in Vitis vision |
| Write() | Write a scalar value into the stream | Writes a packed (for multi-pixel/clock) value into the given location. |
Infrastructure files available in HLS Video Library hls_video_core.hpp, hls_video_mem.hpp, hls_video_types.hpp are moved to xf_video_core.hpp, xf_video_mem.hpp, xf_video_types.hpp in Vitis vision Library and hls_video_imgbase.hpp is deprecated. Code inside these files unchanged except that these are now under xf::cv::namespace.