xref: /aosp_15_r20/external/tensorflow/tensorflow/lite/delegates/external/external_delegate.h (revision b6fb3261f9314811a0f4371741dbb8839866f948)
1 /* Copyright 2020 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 
16 #ifndef TENSORFLOW_LITE_DELEGATES_EXTERNAL_EXTERNAL_DELEGATE_H_
17 #define TENSORFLOW_LITE_DELEGATES_EXTERNAL_EXTERNAL_DELEGATE_H_
18 
19 #include "tensorflow/lite/c/common.h"
20 
21 #ifdef __cplusplus
22 extern "C" {
23 #endif  // __cplusplus
24 
25 // TfLiteExternalDelegateOptions is a structure of key/value options to create
26 // an external delegate.
27 #define kExternalDelegateMaxOptions 256
28 typedef struct TfLiteExternalDelegateOptions {
29   const char* lib_path;
30   int count;
31   const char* keys[kExternalDelegateMaxOptions];
32   const char* values[kExternalDelegateMaxOptions];
33   TfLiteStatus (*insert)(struct TfLiteExternalDelegateOptions* options,
34                          const char* key, const char* value);
35 } TfLiteExternalDelegateOptions;
36 
37 // Insert key/value to the options.
38 TfLiteStatus TfLiteExternalDelegateOptionsInsert(
39     TfLiteExternalDelegateOptions* options, const char* key, const char* value);
40 
41 // Populates TfLiteExternalDelegateOptions with the given shared library path.
42 TfLiteExternalDelegateOptions TfLiteExternalDelegateOptionsDefault(
43     const char* lib_path);
44 
45 // Creates a new delegate instance that need to be destroyed with
46 // `TfLiteExternalDelegateDelete` when delegate is no longer used by TFLite.
47 TfLiteDelegate* TfLiteExternalDelegateCreate(
48     const TfLiteExternalDelegateOptions* options);
49 
50 // Destroys a delegate created with `TfLiteExternalDelegateCreate` call.
51 void TfLiteExternalDelegateDelete(TfLiteDelegate* delegate);
52 
53 #ifdef __cplusplus
54 }
55 #endif  // __cplusplus
56 
57 #endif  // TENSORFLOW_LITE_DELEGATES_EXTERNAL_EXTERNAL_DELEGATE_H_
58