FramebufferSurface.h revision 99c7dbb24994df2f3e175f7b25dd2c9dd92a72f0 
1/*
2 * Copyright (C) 2007 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_SF_FRAMEBUFFER_SURFACE_H
18#define ANDROID_SF_FRAMEBUFFER_SURFACE_H
19
20#include <stdint.h>
21#include <sys/types.h>
22
23#include <gui/ConsumerBase.h>
24
25#include "DisplaySurface.h"
26
27// ---------------------------------------------------------------------------
28namespace android {
29// ---------------------------------------------------------------------------
30
31class Rect;
32class String8;
33class HWComposer;
34
35// ---------------------------------------------------------------------------
36
37class FramebufferSurface : public ConsumerBase,
38                           public DisplaySurface {
39public:
40    FramebufferSurface(HWComposer& hwc, int disp);
41
42    virtual sp<IGraphicBufferProducer> getIGraphicBufferProducer() const;
43
44    virtual status_t compositionComplete();
45    virtual status_t advanceFrame();
46    virtual status_t setReleaseFenceFd(int fenceFd);
47
48    // Implementation of DisplaySurface::dump(). Note that ConsumerBase also
49    // has a non-virtual dump() with the same signature.
50    virtual void dump(String8& result) const;
51
52private:
53    virtual ~FramebufferSurface() { }; // this class cannot be overloaded
54
55    virtual void onFrameAvailable();
56    virtual void freeBufferLocked(int slotIndex);
57
58    virtual void dumpLocked(String8& result, const char* prefix,
59            char* buffer, size_t SIZE) const;
60
61    // nextBuffer waits for and then latches the next buffer from the
62    // BufferQueue and releases the previously latched buffer to the
63    // BufferQueue.  The new buffer is returned in the 'buffer' argument.
64    status_t nextBuffer(sp<GraphicBuffer>& outBuffer, sp<Fence>& outFence);
65
66    // mDisplayType must match one of the HWC display types
67    int mDisplayType;
68
69    // mCurrentBufferIndex is the slot index of the current buffer or
70    // INVALID_BUFFER_SLOT to indicate that either there is no current buffer
71    // or the buffer is not associated with a slot.
72    int mCurrentBufferSlot;
73
74    // mCurrentBuffer is the current buffer or NULL to indicate that there is
75    // no current buffer.
76    sp<GraphicBuffer> mCurrentBuffer;
77
78    // Hardware composer, owned by SurfaceFlinger.
79    HWComposer& mHwc;
80};
81
82// ---------------------------------------------------------------------------
83}; // namespace android
84// ---------------------------------------------------------------------------
85
86#endif // ANDROID_SF_FRAMEBUFFER_SURFACE_H
87
88