Added Python 3 bindings for TIDL API
[tidl/tidl-api.git] / tidl_api / src / pybind_eo.cpp
1 /******************************************************************************
2  * Copyright (c) 2018-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 #include "pybind_common.h"
32 PYBIND11_MAKE_OPAQUE(EO);
34 // Class, method names follow PEP8, Style Guide for Python Code (Reference #3)
35 void init_eo(module &m)
36 {
37     class_<EO>(m, "ExecutionObject")
38         .def("get_input_buffer",
39               [](const EO &eo)
40               {
41                  ArgInfo ai(eo.GetInputBufferPtr(),
42                             eo.GetInputBufferSizeInBytes());
43                  return ai;
44               },
45               "Exposes the input buffer in the ExecutionObject as\n"
46               "a Python object using the buffer protocol. This object can\n"
47               "be specified as an argument to the readinto method")
49         .def("get_output_buffer",
50               [](const EO &eo)
51               {
52                  ArgInfo ai(eo.GetOutputBufferPtr(),
53                             eo.GetOutputBufferSizeInBytes());
54                  return ai;
55               },
56               "Exposes the output buffer in the ExecutionObject as\n"
57               "a Python object using the buffer protocol. This object can\n"
58               "be specified as an argument to the write method")
60         .def("set_frame_index", &EO::SetFrameIndex,
61              "Set the frame index of the frame currently processed.\n"
62              "Used for trace/debug messages")
64         .def("get_frame_index", &EO::GetFrameIndex)
66         .def("process_frame_start_async", &EO::ProcessFrameStartAsync,
67              "Start processing a frame. The call is asynchronous and\n"
68              "returns immediately")
70         .def("process_frame_wait", &EO::ProcessFrameWait,
71              "Wait for the executor pipeline to complete processing a frame\n"
72              "returns false if process_frame_wait() was called without a\n"
73              " corresponding call to process_frame_start_async")
75         .def("get_device_name", &EO::GetDeviceName)
77         .def("get_host_process_time_in_ms",
78              &EO::GetHostProcessTimeInMilliSeconds,
79              "Milliseconds taken on the host to process a frame")
81         .def("get_process_time_in_ms",
82              &EO::GetProcessTimeInMilliSeconds,
83              "Milliseconds taken on the device to process a frame")
85         .def("write_layer_outputs_to_file",
86              &EO::WriteLayerOutputsToFile,
87              "Write the output buffer for each layer to a file\n"
88              "<filename_prefix>_<ID>_HxW.bin",
89              arg("filename_prefix")="trace_dump_");
90 }