FramebufferSurface.h revision da27af9832a0170f1fc40ef3f21371c4d30d21b3 
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;
33class HWComposer;
34
35// ---------------------------------------------------------------------------
36
37class FramebufferSurface : public ConsumerBase {
38public:
39    FramebufferSurface(HWComposer& hwc);
40
41    bool isUpdateOnDemand() const { return false; }
42    status_t setUpdateRectangle(const Rect& updateRect);
43    status_t compositionComplete();
44
45    virtual void dump(String8& result);
46
47    // setReleaseFenceFd stores a fence file descriptor that will signal when the
48    // current buffer is no longer being read. This fence will be returned to
49    // the producer when the current buffer is released by updateTexImage().
50    // Multiple fences can be set for a given buffer; they will be merged into
51    // a single union fence. The SurfaceTexture will close the file descriptor
52    // when finished with it.
53    status_t setReleaseFenceFd(int fenceFd);
54
55private:
56    virtual ~FramebufferSurface() { }; // this class cannot be overloaded
57
58    virtual void onFrameAvailable();
59    virtual void freeBufferLocked(int slotIndex);
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    // mCurrentBufferIndex is the slot index of the current buffer or
67    // INVALID_BUFFER_SLOT to indicate that either there is no current buffer
68    // or the buffer is not associated with a slot.
69    int mCurrentBufferSlot;
70
71    // mCurrentBuffer is the current buffer or NULL to indicate that there is
72    // no current buffer.
73    sp<GraphicBuffer> mCurrentBuffer;
74
75    // Hardware composer, owned by SurfaceFlinger.
76    HWComposer& mHwc;
77};
78
79// ---------------------------------------------------------------------------
80}; // namespace android
81// ---------------------------------------------------------------------------
82
83#endif // ANDROID_SF_FRAMEBUFFER_SURFACE_H
84
85