DisplaySurface.h revision 9e56aa0fdb5f7121b9b975c6c16db103ea4d2fe9 
1/*
2 * Copyright 2013 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_DISPLAY_SURFACE_H
18#define ANDROID_SF_DISPLAY_SURFACE_H
19
20#include <utils/Errors.h>
21#include <utils/RefBase.h>
22#include <utils/StrongPointer.h>
23
24// ---------------------------------------------------------------------------
25namespace android {
26// ---------------------------------------------------------------------------
27
28class IGraphicBufferProducer;
29class String8;
30
31class DisplaySurface : public virtual RefBase {
32public:
33    // beginFrame is called at the beginning of the composition loop, before
34    // the configuration is known. The DisplaySurface should do anything it
35    // needs to do to enable HWComposer to decide how to compose the frame.
36    // We pass in mustRecompose so we can keep VirtualDisplaySurface's state
37    // machine happy without actually queueing a buffer if nothing has changed.
38    virtual status_t beginFrame(bool mustRecompose) = 0;
39
40    // prepareFrame is called after the composition configuration is known but
41    // before composition takes place. The DisplaySurface can use the
42    // composition type to decide how to manage the flow of buffers between
43    // GLES and HWC for this frame.
44    enum CompositionType {
45        COMPOSITION_UNKNOWN = 0,
46        COMPOSITION_GLES    = 1,
47        COMPOSITION_HWC     = 2,
48        COMPOSITION_MIXED   = COMPOSITION_GLES | COMPOSITION_HWC
49    };
50    virtual status_t prepareFrame(CompositionType compositionType) = 0;
51
52#ifndef USE_HWC2
53    // Should be called when composition rendering is complete for a frame (but
54    // eglSwapBuffers hasn't necessarily been called). Required by certain
55    // older drivers for synchronization.
56    // TODO: Remove this when we drop support for HWC 1.0.
57    virtual status_t compositionComplete() = 0;
58#endif
59
60    // Inform the surface that GLES composition is complete for this frame, and
61    // the surface should make sure that HWComposer has the correct buffer for
62    // this frame. Some implementations may only push a new buffer to
63    // HWComposer if GLES composition took place, others need to push a new
64    // buffer on every frame.
65    //
66    // advanceFrame must be followed by a call to  onFrameCommitted before
67    // advanceFrame may be called again.
68    virtual status_t advanceFrame() = 0;
69
70    // onFrameCommitted is called after the frame has been committed to the
71    // hardware composer. The surface collects the release fence for this
72    // frame's buffer.
73    virtual void onFrameCommitted() = 0;
74
75    virtual void dumpAsString(String8& result) const = 0;
76
77    virtual void resizeBuffers(const uint32_t w, const uint32_t h) = 0;
78
79#ifdef USE_HWC2
80    virtual const sp<Fence>& getClientTargetAcquireFence() const = 0;
81#endif
82
83protected:
84    DisplaySurface() {}
85    virtual ~DisplaySurface() {}
86};
87
88// ---------------------------------------------------------------------------
89} // namespace android
90// ---------------------------------------------------------------------------
91
92#endif // ANDROID_SF_DISPLAY_SURFACE_H
93
94