FramebufferSurface.h revision db89edc94bd2a78226b407f9f7261e202e7fa325 
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, const sp<IGraphicBufferConsumer>& consumer);
41
42    virtual status_t prepareFrame(CompositionType compositionType);
43    virtual status_t compositionComplete();
44    virtual status_t advanceFrame();
45    virtual void onFrameCommitted();
46
47    // Implementation of DisplaySurface::dump(). Note that ConsumerBase also
48    // has a non-virtual dump() with the same signature.
49    virtual void dump(String8& result) const;
50
51private:
52    virtual ~FramebufferSurface() { }; // this class cannot be overloaded
53
54    virtual void onFrameAvailable();
55    virtual void freeBufferLocked(int slotIndex);
56
57    virtual void dumpLocked(String8& result, const char* prefix) const;
58
59    // nextBuffer waits for and then latches the next buffer from the
60    // BufferQueue and releases the previously latched buffer to the
61    // BufferQueue.  The new buffer is returned in the 'buffer' argument.
62    status_t nextBuffer(sp<GraphicBuffer>& outBuffer, sp<Fence>& outFence);
63
64    // mDisplayType must match one of the HWC display types
65    int mDisplayType;
66
67    // mCurrentBufferIndex is the slot index of the current buffer or
68    // INVALID_BUFFER_SLOT to indicate that either there is no current buffer
69    // or the buffer is not associated with a slot.
70    int mCurrentBufferSlot;
71
72    // mCurrentBuffer is the current buffer or NULL to indicate that there is
73    // no current buffer.
74    sp<GraphicBuffer> mCurrentBuffer;
75
76    // Hardware composer, owned by SurfaceFlinger.
77    HWComposer& mHwc;
78};
79
80// ---------------------------------------------------------------------------
81}; // namespace android
82// ---------------------------------------------------------------------------
83
84#endif // ANDROID_SF_FRAMEBUFFER_SURFACE_H
85
86