52c8fcf09c616505bcc03707c37e2b8ff396aa8e
[tidl/tidl-api.git] / tinn_api / inc / configuration.h
1 /******************************************************************************
2  * Copyright (c) 2017 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 #pragma once
31 //! @file configuration.h
33 #include <string>
34 #include <iostream>
36 namespace tinn {
38 /*! @class Configuration
39     @brief Specifies the configuration required for a network
40 */
41 class Configuration
42 {
43   public:
45     //! Number of frames of input data (can be 0 if data is not read from file)
46     int     numFrames;
48     //! Height of the input frame
49     int     inHeight;
51     //! Width of the input frame
52     int     inWidth;
54     //! Number of channels in the input frame (e.g. 3 for BGR)
55     int     inNumChannels;
56     int     noZeroCoeffsPercentage;
58     //! Size of the TI DL per Execution Object heap
59     size_t EXTMEM_HEAP_SIZE;
61     //! Size of the heap used for paramter data
62     size_t PARAM_HEAP_SIZE;
64     //! @brief Location of the input file
65     //! Can be empty if input data is provided by frameworks such as OpenCV.
66     std::string inData;
68     //! Location of the output file
69     //! Can be empty if output data is consumed by frameworks such as OpenCV.
70     std::string outData;
72     //! Path to the TIDL network binary file
73     std::string netBinFile;
75     //! Path to the TIDL parameter binary file
76     std::string paramsBinFile;
78     //! Default constructor.
79     Configuration(): numFrames(0), inHeight(0), inWidth(0),
80                      inNumChannels(0),
81                      noZeroCoeffsPercentage(100),
82                      EXTMEM_HEAP_SIZE(64 << 20),  // 64MB for inceptionNetv1
83                      PARAM_HEAP_SIZE(9 << 20)     // 9MB for mobileNet1
84     {}
86     //! Validate the fields in the configuration object
87     bool Validate() const;
89     //! Print the configuration
90     void Print(std::ostream& os = std::cout) const;
92     //! Read a configuration from the specified file and validate
93     bool ReadFromFile(const std::string& file_name);
94 };
96 }