e052548a420572e6f48605697216c5ff07ade76a
[tidl/tidl-api.git] / tidl_api / inc / imgutil.h
1 /******************************************************************************
2  * Copyright (c) 2018 Texas Instruments Incorporated - http://www.ti.com/
3  *  All rights reserved.
4  *
5  *  Redistribution and use in source and binary forms, with or without
6  *  modification, are permitted provided that the following conditions are met:
7  *      * Redistributions of source code must retain the above copyright
8  *        notice, this list of conditions and the following disclaimer.
9  *      * Redistributions in binary form must reproduce the above copyright
10  *        notice, this list of conditions and the following disclaimer in the
11  *        documentation and/or other materials provided with the distribution.
12  *      * Neither the name of Texas Instruments Incorporated nor the
13  *        names of its contributors may be used to endorse or promote products
14  *        derived from this software without specific prior written permission.
15  *
16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26  *  THE POSSIBILITY OF SUCH DAMAGE.
27  *****************************************************************************/
29 //! @file imgutil.h
31 #pragma once
32 #include "opencv2/core.hpp"
33 #include "opencv2/imgproc.hpp"
34 using namespace cv;
36 namespace tidl {
37 namespace imgutil {
39 //! PreProcImage - preprocess image data into the value ranges that
40 //! the DL network expects
41 //! @param image        Input image data (OpenCV data structure)
42 //! @param ptr          Output buffer that TI DL takes as input
43 //! @param roi          Number of Region-Of-Interests
44 //! @param n            Number of channels
45 //! @param width        Input image width
46 //! @param height       Input image height
47 //! @param pitch        Output buffer (ptr) pitch for each line
48 //! @param chOffset     Output buffer (ptr) offset for each channel
49 //! @param frameCount   Number of frames in input image data
50 //! @param preProcType  Preprocessing type, specified in network config
51 bool PreProcImage(Mat& image, char *ptr, int16_t roi, int16_t n,
52                   int16_t width, int16_t height, int16_t pitch,
53                   int32_t chOffset, int32_t frameCount, int32_t preProcType);
55 } // namesapce tidl::imgutil
56 } // namespace tidl