FramebufferSurface.h revision 74d211ae26a0257c6075a823812e40b55aa1e653 
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 void onFrameCommitted();
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) const;
59
60    // nextBuffer waits for and then latches the next buffer from the
61    // BufferQueue and releases the previously latched buffer to the
62    // BufferQueue.  The new buffer is returned in the 'buffer' argument.
63    status_t nextBuffer(sp<GraphicBuffer>& outBuffer, sp<Fence>& outFence);
64
65    // mDisplayType must match one of the HWC display types
66    int mDisplayType;
67
68    // mCurrentBufferIndex is the slot index of the current buffer or
69    // INVALID_BUFFER_SLOT to indicate that either there is no current buffer
70    // or the buffer is not associated with a slot.
71    int mCurrentBufferSlot;
72
73    // mCurrentBuffer is the current buffer or NULL to indicate that there is
74    // no current buffer.
75    sp<GraphicBuffer> mCurrentBuffer;
76
77    // Hardware composer, owned by SurfaceFlinger.
78    HWComposer& mHwc;
79};
80
81// ---------------------------------------------------------------------------
82}; // namespace android
83// ---------------------------------------------------------------------------
84
85#endif // ANDROID_SF_FRAMEBUFFER_SURFACE_H
86
87