FramebufferSurface.h revision 1a4d883dcc1725892bfb5c28dec255a233186524 
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#define NUM_FRAME_BUFFERS  2
26
27// ---------------------------------------------------------------------------
28namespace android {
29// ---------------------------------------------------------------------------
30
31class Rect;
32class String8;
33
34// ---------------------------------------------------------------------------
35
36class FramebufferSurface : public ConsumerBase {
37public:
38
39    static sp<FramebufferSurface> create();
40
41    // TODO: this should be coming from HWC
42    float getRefreshRate() const;
43
44    bool isUpdateOnDemand() const { return false; }
45    status_t setUpdateRectangle(const Rect& updateRect);
46    status_t compositionComplete();
47
48    virtual void dump(String8& result);
49
50    // nextBuffer waits for and then latches the next buffer from the
51    // BufferQueue and releases the previously latched buffer to the
52    // BufferQueue.  The new buffer is returned in the 'buffer' argument.
53    status_t nextBuffer(sp<GraphicBuffer>* buffer);
54
55private:
56    FramebufferSurface();
57    virtual ~FramebufferSurface(); // this class cannot be overloaded
58
59    virtual void onFrameAvailable();
60    virtual void freeBufferLocked(int slotIndex);
61
62    framebuffer_device_t* fbDev;
63
64    // mCurrentBufferIndex is the slot index of the current buffer or
65    // INVALID_BUFFER_SLOT to indicate that either there is no current buffer
66    // or the buffer is not associated with a slot.
67    int mCurrentBufferSlot;
68
69    // mCurrentBuffer is the current buffer or NULL to indicate that there is
70    // no current buffer.
71    sp<GraphicBuffer> mCurrentBuffer;
72};
73
74// ---------------------------------------------------------------------------
75}; // namespace android
76// ---------------------------------------------------------------------------
77
78#endif // ANDROID_SF_FRAMEBUFFER_SURFACE_H
79
80