e57621598f
Bug: 20105644
Change-Id: I21526b5397ea51a15500c44a99daa9d75fc4ea67
(cherry picked from commit e478305181)
244 lines
11 KiB
C++
244 lines
11 KiB
C++
/*
|
|
* Copyright (C) 2010 The Android Open Source Project
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
#ifndef ANDROID_GUI_CONSUMERBASE_H
|
|
#define ANDROID_GUI_CONSUMERBASE_H
|
|
|
|
#include <gui/BufferQueue.h>
|
|
|
|
#include <ui/GraphicBuffer.h>
|
|
|
|
#include <utils/String8.h>
|
|
#include <utils/Vector.h>
|
|
#include <utils/threads.h>
|
|
#include <gui/IConsumerListener.h>
|
|
|
|
namespace android {
|
|
// ----------------------------------------------------------------------------
|
|
|
|
class String8;
|
|
|
|
// ConsumerBase is a base class for BufferQueue consumer end-points. It
|
|
// handles common tasks like management of the connection to the BufferQueue
|
|
// and the buffer pool.
|
|
class ConsumerBase : public virtual RefBase,
|
|
protected ConsumerListener {
|
|
public:
|
|
struct FrameAvailableListener : public virtual RefBase {
|
|
// See IConsumerListener::onFrame{Available,Replaced}
|
|
virtual void onFrameAvailable(const BufferItem& item) = 0;
|
|
virtual void onFrameReplaced(const BufferItem& /* item */) {}
|
|
};
|
|
|
|
virtual ~ConsumerBase();
|
|
|
|
// abandon frees all the buffers and puts the ConsumerBase into the
|
|
// 'abandoned' state. Once put in this state the ConsumerBase can never
|
|
// leave it. When in the 'abandoned' state, all methods of the
|
|
// IGraphicBufferProducer interface will fail with the NO_INIT error.
|
|
//
|
|
// Note that while calling this method causes all the buffers to be freed
|
|
// from the perspective of the the ConsumerBase, if there are additional
|
|
// references on the buffers (e.g. if a buffer is referenced by a client
|
|
// or by OpenGL ES as a texture) then those buffer will remain allocated.
|
|
void abandon();
|
|
|
|
// Returns true if the ConsumerBase is in the 'abandoned' state
|
|
bool isAbandoned();
|
|
|
|
// set the name of the ConsumerBase that will be used to identify it in
|
|
// log messages.
|
|
void setName(const String8& name);
|
|
|
|
// dump writes the current state to a string. Child classes should add
|
|
// their state to the dump by overriding the dumpLocked method, which is
|
|
// called by these methods after locking the mutex.
|
|
void dump(String8& result) const;
|
|
void dump(String8& result, const char* prefix) const;
|
|
|
|
// setFrameAvailableListener sets the listener object that will be notified
|
|
// when a new frame becomes available.
|
|
void setFrameAvailableListener(const wp<FrameAvailableListener>& listener);
|
|
|
|
// See IGraphicBufferConsumer::detachBuffer
|
|
status_t detachBuffer(int slot);
|
|
|
|
private:
|
|
ConsumerBase(const ConsumerBase&);
|
|
void operator=(const ConsumerBase&);
|
|
|
|
protected:
|
|
// ConsumerBase constructs a new ConsumerBase object to consume image
|
|
// buffers from the given IGraphicBufferConsumer.
|
|
// The controlledByApp flag indicates that this consumer is under the application's
|
|
// control.
|
|
ConsumerBase(const sp<IGraphicBufferConsumer>& consumer, bool controlledByApp = false);
|
|
|
|
// onLastStrongRef gets called by RefBase just before the dtor of the most
|
|
// derived class. It is used to clean up the buffers so that ConsumerBase
|
|
// can coordinate the clean-up by calling into virtual methods implemented
|
|
// by the derived classes. This would not be possible from the
|
|
// ConsuemrBase dtor because by the time that gets called the derived
|
|
// classes have already been destructed.
|
|
//
|
|
// This methods should not need to be overridden by derived classes, but
|
|
// if they are overridden the ConsumerBase implementation must be called
|
|
// from the derived class.
|
|
virtual void onLastStrongRef(const void* id);
|
|
|
|
// Implementation of the IConsumerListener interface. These
|
|
// calls are used to notify the ConsumerBase of asynchronous events in the
|
|
// BufferQueue. The onFrameAvailable, onFrameReplaced, and
|
|
// onBuffersReleased methods should not need to be overridden by derived
|
|
// classes, but if they are overridden the ConsumerBase implementation must
|
|
// be called from the derived class. The ConsumerBase version of
|
|
// onSidebandStreamChanged does nothing and can be overriden by derived
|
|
// classes if they want the notification.
|
|
virtual void onFrameAvailable(const BufferItem& item) override;
|
|
virtual void onFrameReplaced(const BufferItem& item) override;
|
|
virtual void onBuffersReleased() override;
|
|
virtual void onSidebandStreamChanged() override;
|
|
|
|
// freeBufferLocked frees up the given buffer slot. If the slot has been
|
|
// initialized this will release the reference to the GraphicBuffer in that
|
|
// slot. Otherwise it has no effect.
|
|
//
|
|
// Derived classes should override this method to clean up any state they
|
|
// keep per slot. If it is overridden, the derived class's implementation
|
|
// must call ConsumerBase::freeBufferLocked.
|
|
//
|
|
// This method must be called with mMutex locked.
|
|
virtual void freeBufferLocked(int slotIndex);
|
|
|
|
// abandonLocked puts the BufferQueue into the abandoned state, causing
|
|
// all future operations on it to fail. This method rather than the public
|
|
// abandon method should be overridden by child classes to add abandon-
|
|
// time behavior.
|
|
//
|
|
// Derived classes should override this method to clean up any object
|
|
// state they keep (as opposed to per-slot state). If it is overridden,
|
|
// the derived class's implementation must call ConsumerBase::abandonLocked.
|
|
//
|
|
// This method must be called with mMutex locked.
|
|
virtual void abandonLocked();
|
|
|
|
// dumpLocked dumps the current state of the ConsumerBase object to the
|
|
// result string. Each line is prefixed with the string pointed to by the
|
|
// prefix argument. The buffer argument points to a buffer that may be
|
|
// used for intermediate formatting data, and the size of that buffer is
|
|
// indicated by the size argument.
|
|
//
|
|
// Derived classes should override this method to dump their internal
|
|
// state. If this method is overridden the derived class's implementation
|
|
// should call ConsumerBase::dumpLocked.
|
|
//
|
|
// This method must be called with mMutex locked.
|
|
virtual void dumpLocked(String8& result, const char* prefix) const;
|
|
|
|
// acquireBufferLocked fetches the next buffer from the BufferQueue and
|
|
// updates the buffer slot for the buffer returned.
|
|
//
|
|
// Derived classes should override this method to perform any
|
|
// initialization that must take place the first time a buffer is assigned
|
|
// to a slot. If it is overridden the derived class's implementation must
|
|
// call ConsumerBase::acquireBufferLocked.
|
|
virtual status_t acquireBufferLocked(BufferItem *item, nsecs_t presentWhen,
|
|
uint64_t maxFrameNumber = 0);
|
|
|
|
// releaseBufferLocked relinquishes control over a buffer, returning that
|
|
// control to the BufferQueue.
|
|
//
|
|
// Derived classes should override this method to perform any cleanup that
|
|
// must take place when a buffer is released back to the BufferQueue. If
|
|
// it is overridden the derived class's implementation must call
|
|
// ConsumerBase::releaseBufferLocked.e
|
|
virtual status_t releaseBufferLocked(int slot,
|
|
const sp<GraphicBuffer> graphicBuffer,
|
|
EGLDisplay display, EGLSyncKHR eglFence);
|
|
|
|
// returns true iff the slot still has the graphicBuffer in it.
|
|
bool stillTracking(int slot, const sp<GraphicBuffer> graphicBuffer);
|
|
|
|
// addReleaseFence* adds the sync points associated with a fence to the set
|
|
// of sync points that must be reached before the buffer in the given slot
|
|
// may be used after the slot has been released. This should be called by
|
|
// derived classes each time some asynchronous work is kicked off that
|
|
// references the buffer.
|
|
status_t addReleaseFence(int slot,
|
|
const sp<GraphicBuffer> graphicBuffer, const sp<Fence>& fence);
|
|
status_t addReleaseFenceLocked(int slot,
|
|
const sp<GraphicBuffer> graphicBuffer, const sp<Fence>& fence);
|
|
|
|
// Slot contains the information and object references that
|
|
// ConsumerBase maintains about a BufferQueue buffer slot.
|
|
struct Slot {
|
|
// mGraphicBuffer is the Gralloc buffer store in the slot or NULL if
|
|
// no Gralloc buffer is in the slot.
|
|
sp<GraphicBuffer> mGraphicBuffer;
|
|
|
|
// mFence is a fence which will signal when the buffer associated with
|
|
// this buffer slot is no longer being used by the consumer and can be
|
|
// overwritten. The buffer can be dequeued before the fence signals;
|
|
// the producer is responsible for delaying writes until it signals.
|
|
sp<Fence> mFence;
|
|
|
|
// the frame number of the last acquired frame for this slot
|
|
uint64_t mFrameNumber;
|
|
};
|
|
|
|
// mSlots stores the buffers that have been allocated by the BufferQueue
|
|
// for each buffer slot. It is initialized to null pointers, and gets
|
|
// filled in with the result of BufferQueue::acquire when the
|
|
// client dequeues a buffer from a
|
|
// slot that has not yet been used. The buffer allocated to a slot will also
|
|
// be replaced if the requested buffer usage or geometry differs from that
|
|
// of the buffer allocated to a slot.
|
|
Slot mSlots[BufferQueue::NUM_BUFFER_SLOTS];
|
|
|
|
// mAbandoned indicates that the BufferQueue will no longer be used to
|
|
// consume images buffers pushed to it using the IGraphicBufferProducer
|
|
// interface. It is initialized to false, and set to true in the abandon
|
|
// method. A BufferQueue that has been abandoned will return the NO_INIT
|
|
// error from all IConsumerBase methods capable of returning an error.
|
|
bool mAbandoned;
|
|
|
|
// mName is a string used to identify the ConsumerBase in log messages.
|
|
// It can be set by the setName method.
|
|
String8 mName;
|
|
|
|
// mFrameAvailableListener is the listener object that will be called when a
|
|
// new frame becomes available. If it is not NULL it will be called from
|
|
// queueBuffer.
|
|
wp<FrameAvailableListener> mFrameAvailableListener;
|
|
|
|
// The ConsumerBase has-a BufferQueue and is responsible for creating this object
|
|
// if none is supplied
|
|
sp<IGraphicBufferConsumer> mConsumer;
|
|
|
|
// mMutex is the mutex used to prevent concurrent access to the member
|
|
// variables of ConsumerBase objects. It must be locked whenever the
|
|
// member variables are accessed or when any of the *Locked methods are
|
|
// called.
|
|
//
|
|
// This mutex is intended to be locked by derived classes.
|
|
mutable Mutex mMutex;
|
|
};
|
|
|
|
// ----------------------------------------------------------------------------
|
|
}; // namespace android
|
|
|
|
#endif // ANDROID_GUI_CONSUMERBASE_H
|