• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (C) 2023 Huawei Device Co., Ltd.
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 FOUNDATION_ACE_INTERFACE_INNERKITS_IMAGE_ANALYZER_INTERFACE_H
17 #define FOUNDATION_ACE_INTERFACE_INNERKITS_IMAGE_ANALYZER_INTERFACE_H
18 
19 #include <functional>
20 #include <string>
21 
22 #include "image_analyzer.h"
23 
24 namespace OHOS::Ace {
25 class ImageAnalyzerInterface {
26 public:
27     virtual bool IsImageAnalyzerSupported() = 0;
BuildNodeFunc(void * pixelMap,void * config,ImageAnalyzerInnerConfig * uiConfig,void ** overlayData)28     virtual void BuildNodeFunc(
29         void* pixelMap, void* config, ImageAnalyzerInnerConfig* uiConfig, void** overlayData) {};
BuildNodeFunc(std::string uri,void * pixelMap,int frameTimestamp,void * config,ImageAnalyzerInnerConfig * uiConfig,void ** overlayData)30     virtual void BuildNodeFunc(std::string uri, void* pixelMap, int frameTimestamp, void* config,
31         ImageAnalyzerInnerConfig* uiConfig, void** overlayData) {};
UpdateImage(void ** overlayData,void * pixelMap,void * config,ImageAnalyzerInnerConfig * uiConfig)32     virtual void UpdateImage(
33         void** overlayData, void* pixelMap, void* config, ImageAnalyzerInnerConfig* uiConfig) {};
UpdateImage(void ** overlayData,std::string uri,void * pixelMap,int frameTimestamp,void * config,ImageAnalyzerInnerConfig * uiConfig)34     virtual void UpdateImage(void** overlayData, std::string uri, void* pixelMap, int frameTimestamp,
35         void* config, ImageAnalyzerInnerConfig* uiConfig) {};
UpdateConfig(void ** overlayData,void * config)36     virtual void UpdateConfig(void** overlayData, void* config) {};
37     virtual void UpdateInnerConfig(void** overlayData, ImageAnalyzerInnerConfig* config) = 0;
38     virtual void Release(void** overlayData) = 0;
39     virtual void UpdatePressOverlay(void** overlayData, ImageAnalyzerInnerConfig* config) = 0;
40     virtual void UpdateOverlayStatus(void** overlayData, ImageAnalyzerInnerConfig* config) = 0;
41     virtual void UpdateOverlayActiveStatus(void** overlayData, bool status) = 0;
42     virtual void UpdateAIButtonConfig(void** overlayData, AIButtonConfig* config) = 0;
43     /**
44      * @brief Handling keyboard events related to image analysis.
45      *
46      * When the user triggers a button operation in the image analysis interface (such as floating UI), this function
47      * is called to pass the event to the underlying image analysis module.
48      *
49      * @param[in,out] overlayData Pointer to the context data for image analysis.
50      *                            This data usually includes the currently displayed UI status, bound objects, etc.
51      * @param[in]     keyEvent    A pointer to a key event object, containing the type of key operation and key value.
52      */
UpdateKeyEvent(void ** overlayData,void * keyEvent)53     virtual void UpdateKeyEvent(void** overlayData, void* keyEvent) {};
54 protected:
~ImageAnalyzerInterface()55     virtual ~ImageAnalyzerInterface() {}
56 }; // namespace OHOS::Ace
57 }
58 #endif // FOUNDATION_ACE_INTERFACE_INNERKITS_IMAGE_ANALYZER_INTERFACE_H
59