9039271de28b4a85f5a552cb94b90da9bc0c48ca
[tidl/tidl-api.git] / examples / imagenet / main.cpp
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  *****************************************************************************/
28 #include <signal.h>
29 #include <iostream>
30 #include <iomanip>
31 #include <fstream>
32 #include <cassert>
33 #include <string>
34 #include <functional>
35 #include <algorithm>
36 #include <time.h>
37 #include <unistd.h>
39 #include <queue>
40 #include <vector>
41 #include <chrono>
43 #include "executor.h"
44 #include "execution_object.h"
45 #include "execution_object_pipeline.h"
46 #include "configuration.h"
47 #include "imagenet_classes.h"
48 #include "imgutil.h"
49 #include "../common/video_utils.h"
51 #include "opencv2/core.hpp"
52 #include "opencv2/imgproc.hpp"
53 #include "opencv2/highgui.hpp"
54 #include "opencv2/videoio.hpp"
56 using namespace std;
57 using namespace tidl;
58 using namespace tidl::imgutil;
59 using namespace cv;
61 #define NUM_VIDEO_FRAMES  300
62 #define DEFAULT_CONFIG    "j11_v2"
63 #define NUM_DEFAULT_INPUTS  1
64 const char *default_inputs[NUM_DEFAULT_INPUTS] =
65 {
66     "../test/testvecs/input/objects/cat-pet-animal-domestic-104827.jpeg"
67 };
69 Executor* CreateExecutor(DeviceType dt, uint32_t num, const Configuration& c);
70 bool RunConfiguration(cmdline_opts_t& opts);
71 bool ReadFrame(ExecutionObjectPipeline& eop,
72                uint32_t frame_idx, const Configuration& c,
73                const cmdline_opts_t& opts, VideoCapture &cap);
74 bool WriteFrameOutput(const ExecutionObjectPipeline &eop);
75 void DisplayHelp();
78 int main(int argc, char *argv[])
79 {
80     // Catch ctrl-c to ensure a clean exit
81     signal(SIGABRT, exit);
82     signal(SIGTERM, exit);
84     // If there are no devices capable of offloading TIDL on the SoC, exit
85     uint32_t num_eves = Executor::GetNumDevices(DeviceType::EVE);
86     uint32_t num_dsps = Executor::GetNumDevices(DeviceType::DSP);
87     if (num_eves == 0 && num_dsps == 0)
88     {
89         cout << "TI DL not supported on this SoC." << endl;
90         return EXIT_SUCCESS;
91     }
93     // Process arguments
94     cmdline_opts_t opts;
95     opts.config = DEFAULT_CONFIG;
96     if (num_eves != 0) { opts.num_eves = 1;  opts.num_dsps = 0; }
97     else               { opts.num_eves = 0;  opts.num_dsps = 1; }
98     if (! ProcessArgs(argc, argv, opts))
99     {
100         DisplayHelp();
101         exit(EXIT_SUCCESS);
102     }
103     assert(opts.num_dsps != 0 || opts.num_eves != 0);
104     if (opts.num_frames == 0)
105         opts.num_frames = (opts.is_camera_input || opts.is_video_input) ?
106                           NUM_VIDEO_FRAMES : 1;
107     if (opts.input_file.empty())
108         cout << "Input: " << default_inputs[0] << endl;
109     else
110         cout << "Input: " << opts.input_file << endl;
112     // Run network
113     bool status = RunConfiguration(opts);
114     if (!status)
115     {
116         cout << "imagenet FAILED" << endl;
117         return EXIT_FAILURE;
118     }
120     cout << "imagenet PASSED" << endl;
121     return EXIT_SUCCESS;
124 bool RunConfiguration(cmdline_opts_t& opts)
126     // Read the TI DL configuration file
127     Configuration c;
128     string config_file = "../test/testvecs/config/infer/tidl_config_"
129                               + opts.config + ".txt";
130     bool status = c.ReadFromFile(config_file);
131     if (!status)
132     {
133         cerr << "Error in configuration file: " << config_file << endl;
134         return false;
135     }
136     c.enableApiTrace = opts.verbose;
138     // setup camera/video input/output
139     VideoCapture cap;
140     if (! SetVideoInputOutput(cap, opts, "ImageNet"))  return false;
142     try
143     {
144         // Create Executors with the approriate core type, number of cores
145         // and configuration specified
146         Executor* e_eve = CreateExecutor(DeviceType::EVE, opts.num_eves, c);
147         Executor* e_dsp = CreateExecutor(DeviceType::DSP, opts.num_dsps, c);
149         // Get ExecutionObjects from Executors
150         vector<ExecutionObject*> eos;
151         for (uint32_t i = 0; i < opts.num_eves; i++) eos.push_back((*e_eve)[i]);
152         for (uint32_t i = 0; i < opts.num_dsps; i++) eos.push_back((*e_dsp)[i]);
153         uint32_t num_eos = eos.size();
155         // Use duplicate EOPs to do double buffering on frame input/output
156         //    because each EOP has its own set of input/output buffers,
157         //    so that host ReadFrame() can be overlapped with device processing
158         // Use one EO as an example, with different buffer_factor,
159         //    we have different execution behavior:
160         // If buffer_factor is set to 1 -> single buffering
161         //    we create one EOP: eop0 (eo0)
162         //    pipeline execution of multiple frames over time is as follows:
163         //    --------------------- time ------------------->
164         //    eop0: [RF][eo0.....][WF]
165         //    eop0:                   [RF][eo0.....][WF]
166         //    eop0:                                     [RF][eo0.....][WF]
167         // If buffer_factor is set to 2 -> double buffering
168         //    we create two EOPs: eop0 (eo0), eop1(eo0)
169         //    pipeline execution of multiple frames over time is as follows:
170         //    --------------------- time ------------------->
171         //    eop0: [RF][eo0.....][WF]
172         //    eop1:     [RF]      [eo0.....][WF]
173         //    eop0:                   [RF]  [eo0.....][WF]
174         //    eop1:                             [RF]  [eo0.....][WF]
175         vector<ExecutionObjectPipeline *> eops;
176         uint32_t buffer_factor = 2;  // set to 1 for single buffering
177         for (uint32_t j = 0; j < buffer_factor; j++)
178             for (uint32_t i = 0; i < num_eos; i++)
179                 eops.push_back(new ExecutionObjectPipeline({eos[i]}));
180         uint32_t num_eops = eops.size();
182         // Allocate input and output buffers for each EOP
183         AllocateMemory(eops);
185         chrono::time_point<chrono::steady_clock> tloop0, tloop1;
186         tloop0 = chrono::steady_clock::now();
188         // Process frames with available eops in a pipelined manner
189         // additional num_eos iterations to flush the pipeline (epilogue)
190         for (uint32_t frame_idx = 0;
191              frame_idx < opts.num_frames + num_eops; frame_idx++)
192         {
193             ExecutionObjectPipeline* eop = eops[frame_idx % num_eops];
195             // Wait for previous frame on the same eop to finish processing
196             if (eop->ProcessFrameWait())
197             {
198                 ReportTime(eop);
199                 WriteFrameOutput(*eop);
200             }
202             // Read a frame and start processing it with current eop
203             if (ReadFrame(*eop, frame_idx, c, opts, cap))
204                 eop->ProcessFrameStartAsync();
205         }
207         tloop1 = chrono::steady_clock::now();
208         chrono::duration<float> elapsed = tloop1 - tloop0;
209         cout << "Loop total time (including read/write/opencv/print/etc): "
210                   << setw(6) << setprecision(4)
211                   << (elapsed.count() * 1000) << "ms" << endl;
213         FreeMemory(eops);
214         for (auto eop : eops)  delete eop;
215         delete e_eve;
216         delete e_dsp;
217     }
218     catch (tidl::Exception &e)
219     {
220         cerr << e.what() << endl;
221         status = false;
222     }
224     return status;
227 // Create an Executor with the specified type and number of EOs
228 Executor* CreateExecutor(DeviceType dt, uint32_t num, const Configuration& c)
230     if (num == 0) return nullptr;
232     DeviceIds ids;
233     for (uint32_t i = 0; i < num; i++)
234         ids.insert(static_cast<DeviceId>(i));
236     return new Executor(dt, ids, c);
239 bool ReadFrame(ExecutionObjectPipeline &eop,
240                uint32_t frame_idx, const Configuration& c,
241                const cmdline_opts_t& opts, VideoCapture &cap)
243     if (frame_idx >= opts.num_frames)
244         return false;
246     eop.SetFrameIndex(frame_idx);
248     char*  frame_buffer = eop.GetInputBufferPtr();
249     assert (frame_buffer != nullptr);
251     Mat image;
252     if (! opts.is_camera_input && ! opts.is_video_input)
253     {
254         if (opts.input_file.empty())
255             image = cv::imread(default_inputs[frame_idx % NUM_DEFAULT_INPUTS],
256                                CV_LOAD_IMAGE_COLOR);
257         else
258             image = cv::imread(opts.input_file, CV_LOAD_IMAGE_COLOR);
259         if (image.empty())
260         {
261             cerr << "Unable to read input image" << endl;
262             return false;
263         }
264     }
265     else
266     {
267         Mat v_image;
268         if (! cap.grab())  return false;
269         if (! cap.retrieve(v_image)) return false;
270         int orig_width  = v_image.cols;
271         int orig_height = v_image.rows;
272         // Crop camera/video input to center 256x256 input
273         if (orig_width > 256 && orig_height > 256)
274         {
275             image = Mat(v_image, Rect((orig_width-256)/2, (orig_height-256)/2,
276                                        256, 256));
277         }
278         else
279             image = v_image;
280         cv::imshow("ImageNet", image);
281         waitKey(2);
282     }
284     // TI DL image preprocessing, into frame_buffer
285     return PreProcImage(image, frame_buffer, 1, 3, c.inWidth, c.inHeight,
286                         c.inWidth, c.inWidth * c.inHeight, 1, c.preProcType);
289 // Display top 5 classified imagenet classes with probabilities
290 bool WriteFrameOutput(const ExecutionObjectPipeline &eop)
292     const int k = 5;
293     unsigned char *out = (unsigned char *) eop.GetOutputBufferPtr();
294     int out_size = eop.GetOutputBufferSizeInBytes();
296     // sort and get k largest values and corresponding indices
297     typedef pair<unsigned char, int> val_index;
298     auto constexpr cmp = [](val_index &left, val_index &right)
299                          { return left.first > right.first; };
300     priority_queue<val_index, vector<val_index>, decltype(cmp)> queue(cmp);
301     // initialize priority queue with smallest value on top
302     for (int i = 0; i < k; i++)
303         queue.push(val_index(out[i], i));
305     // for rest output, if larger than current min, pop min, push new val
306     for (int i = k; i < out_size; i++)
307     {
308         if (out[i] > queue.top().first)
309         {
310           queue.pop();
311           queue.push(val_index(out[i], i));
312         }
313     }
315     // output top k values in reverse order: largest val first
316     vector<val_index> sorted;
317     while (! queue.empty())
318     {
319       sorted.push_back(queue.top());
320       queue.pop();
321     }
323     for (int i = k - 1; i >= 0; i--)
324         cout << k-i << ": " << imagenet_classes[sorted[i].second] << endl;
326     return true;
329 void DisplayHelp()
331     cout <<
332     "Usage: imagenet\n"
333     "  Will run imagenet network to predict top 5 object"
334     " classes for the input.\n  Use -c to run a"
335     "  different imagenet network. Default is j11_v2.\n"
336     "Optional arguments:\n"
337     " -c <config>          Valid configs: j11_bn, j11_prelu, j11_v2\n"
338     " -d <number>          Number of dsp cores to use\n"
339     " -e <number>          Number of eve cores to use\n"
340     " -i <image>           Path to the image file as input\n"
341     " -i camera<number>    Use camera as input\n"
342     "                      video input port: /dev/video<number>\n"
343     " -i <name>.{mp4,mov,avi}  Use video file as input\n"
344     " -f <number>          Number of frames to process\n"
345     " -v                   Verbose output during execution\n"
346     " -h                   Help\n";