1 /* 2 * Copyright (c) 2021 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 FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H 17 #define FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H 18 19 #include <refbase.h> 20 21 #include "surface_type.h" 22 #include "surface_buffer.h" 23 #include "buffer_queue.h" 24 25 namespace OHOS { 26 class SURFACE_HIDDEN BufferQueueConsumer : public RefBase { 27 public: 28 BufferQueueConsumer(sptr<BufferQueue>& bufferQueue); 29 virtual ~BufferQueueConsumer(); 30 31 GSError AcquireBuffer(sptr<SurfaceBuffer> &buffer, sptr<SyncFence> &fence, 32 int64_t ×tamp, std::vector<Rect> &damages, bool isLppMode = false); 33 GSError AcquireBuffer(IConsumerSurface::AcquireBufferReturnValue &returnValue, int64_t expectPresentTimestamp, 34 bool isUsingAutoTimestamp); 35 GSError AcquireBuffer(IConsumerSurface::AcquireBufferReturnValue &returnValue); 36 GSError ReleaseBuffer(sptr<SurfaceBuffer>& buffer, const sptr<SyncFence>& fence); 37 38 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer); 39 GSError AttachBuffer(sptr<SurfaceBuffer>& buffer, int32_t timeOut); 40 41 GSError DetachBuffer(sptr<SurfaceBuffer>& buffer); 42 GSError RegisterSurfaceDelegator(sptr<IRemoteObject> client, sptr<Surface> cSurface); 43 44 bool QueryIfBufferAvailable(); 45 46 GSError RegisterConsumerListener(sptr<IBufferConsumerListener>& listener); 47 GSError RegisterConsumerListener(IBufferConsumerListenerClazz *listener); 48 GSError RegisterReleaseListener(OnReleaseFunc func); 49 GSError RegisterDeleteBufferListener(OnDeleteBufferFunc func, bool isForUniRedraw = false); 50 GSError UnregisterConsumerListener(); 51 52 GSError SetDefaultWidthAndHeight(int32_t width, int32_t height); 53 GSError SetDefaultUsage(uint64_t usage); 54 void Dump(std::string &result) const; 55 void DumpCurrentFrameLayer() const; 56 GraphicTransformType GetTransform() const; 57 GSError GetScalingMode(uint32_t sequence, ScalingMode &scalingMode) const; 58 GSError QueryMetaDataType(uint32_t sequence, HDRMetaDataType &type) const; 59 GSError GetMetaData(uint32_t sequence, std::vector<GraphicHDRMetaData> &metaData) const; 60 GSError GetMetaDataSet(uint32_t sequence, GraphicHDRMetadataKey &key, std::vector<uint8_t> &metaData) const; 61 GSError GetGlobalAlpha(int32_t &alpha); 62 sptr<SurfaceTunnelHandle> GetTunnelHandle() const; 63 GSError SetPresentTimestamp(uint32_t sequence, const GraphicPresentTimestamp ×tamp); 64 65 bool GetStatus() const; 66 void SetStatus(bool status); 67 GSError OnConsumerDied(); 68 GSError GoBackground(); ConsumerRequestCpuAccess(bool on)69 void ConsumerRequestCpuAccess(bool on) 70 { 71 bufferQueue_->ConsumerRequestCpuAccess(on); 72 } 73 74 GSError AttachBufferToQueue(sptr<SurfaceBuffer> buffer); 75 GSError DetachBufferFromQueue(sptr<SurfaceBuffer> buffer, bool isReserveSlot); 76 void SetBufferHold(bool hold); IsBufferHold()77 inline bool IsBufferHold() 78 { 79 if (bufferQueue_ == nullptr) { 80 return false; 81 } 82 return bufferQueue_->IsBufferHold(); 83 } 84 float GetHdrWhitePointBrightness() const; 85 float GetSdrWhitePointBrightness() const; 86 GSError IsSurfaceBufferInCache(uint32_t seqNum, bool &isInCache); 87 uint32_t GetAvailableBufferCount() const; 88 GSError GetLastFlushedDesiredPresentTimeStamp(int64_t &lastFlushedDesiredPresentTimeStamp) const; 89 GSError GetFrontDesiredPresentTimeStamp(int64_t &desiredPresentTimeStamp, bool &isAutoTimeStamp) const; 90 GSError GetBufferSupportFastCompose(bool &bufferSupportFastCompose) const; 91 GSError GetBufferCacheConfig(const sptr<SurfaceBuffer>& buffer, BufferRequestConfig& config); 92 GSError GetCycleBuffersNumber(uint32_t& cycleBuffersNumber); 93 GSError GetFrameGravity(int32_t &frameGravity); 94 GSError GetFixedRotation(int32_t &fixedRotation); 95 GSError GetLastConsumeTime(int64_t &lastConsumeTime) const; 96 GSError SetMaxQueueSize(uint32_t queueSize); 97 GSError GetMaxQueueSize(uint32_t &queueSize) const; 98 GSError ReleaseBuffer(uint32_t sequence, const sptr<SyncFence> &fence); 99 GSError SetIsActiveGame(bool isActiveGame); 100 GSError SetLppDrawSource(bool isShbSource, bool isRsSource); 101 GSError GetAlphaType(GraphicAlphaType &alphaType); 102 GSError SetIsPriorityAlloc(bool isPriorityAlloc); 103 private: 104 sptr<BufferQueue> bufferQueue_ = nullptr; 105 std::string name_ = "not init"; 106 }; 107 } // namespace OHOS 108 109 #endif // FRAMEWORKS_SURFACE_INCLUDE_BUFFER_QUEUE_CONSUMER_H 110