Added example to illustrate pipelining across EOs
[tidl/tidl-api.git] / examples / common / utils.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  *****************************************************************************/
28 #pragma once
30 #include <string>
31 #include <iostream>
32 #include <fstream>
33 #include "executor.h"
34 #include "execution_object.h"
35 #include "execution_object_pipeline.h"
36 #include "configuration.h"
38 using tidl::Executor;
39 using tidl::ExecutionObject;
40 using tidl::ExecutionObjectPipeline;
41 using tidl::Configuration;
43 bool ReadFrame(ExecutionObject*     eo,
44                int                  frame_idx,
45                const Configuration& configuration,
46                std::istream&        input_file);
48 bool ReadFrame(ExecutionObjectPipeline* eop,
49                int                      frame_idx,
50                const Configuration&     configuration,
51                std::istream&            input_file);
53 bool WriteFrame(const ExecutionObject* eo, std::ostream& output_file);
55 void ReportTime(const ExecutionObject* eo);
56 void ReportTime(const ExecutionObjectPipeline* eop);
58 bool CheckFrame(const ExecutionObject* eo, const char *ref_output);
59 bool CheckFrame(const ExecutionObjectPipeline *eop, const char *ref_output);
61 const char* ReadReferenceOutput(const std::string& name);