Home | History | Annotate | Download | only in hwui 
      1 /*
      2  * Copyright (C) 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_HWUI_DEFERRED_DISPLAY_LIST_H
     18 #define ANDROID_HWUI_DEFERRED_DISPLAY_LIST_H
     19 
     20 #include <utils/Errors.h>
     21 #include <utils/LinearAllocator.h>
     22 #include <utils/Vector.h>
     23 #include <utils/TinyHashMap.h>
     24 
     25 #include "Matrix.h"
     26 #include "OpenGLRenderer.h"
     27 #include "Rect.h"
     28 
     29 class SkBitmap;
     30 
     31 namespace android {
     32 namespace uirenderer {
     33 
     34 class ClipOp;
     35 class DrawOp;
     36 class SaveOp;
     37 class SaveLayerOp;
     38 class StateOp;
     39 
     40 class DeferredDisplayState;
     41 class OpenGLRenderer;
     42 
     43 class Batch;
     44 class DrawBatch;
     45 class MergingDrawBatch;
     46 
     47 typedef const void* mergeid_t;
     48 
     49 class DeferredDisplayState {
     50 public:
     51     /** static void* operator new(size_t size); PURPOSELY OMITTED **/
     52     static void* operator new(size_t size, LinearAllocator& allocator) {
     53         return allocator.alloc(size);
     54     }
     55 
     56     // global op bounds, mapped by mMatrix to be in screen space coordinates, clipped
     57     Rect mBounds;
     58 
     59     // the below are set and used by the OpenGLRenderer at record and deferred playback
     60     bool mClipValid;
     61     Rect mClip;
     62     int mClipSideFlags; // specifies which sides of the bounds are clipped, unclipped if cleared
     63     bool mClipped;
     64     mat4 mMatrix;
     65     DrawModifiers mDrawModifiers;
     66     float mAlpha;
     67 };
     68 
     69 class OpStatePair {
     70 public:
     71     OpStatePair()
     72             : op(NULL), state(NULL) {}
     73     OpStatePair(DrawOp* newOp, const DeferredDisplayState* newState)
     74             : op(newOp), state(newState) {}
     75     OpStatePair(const OpStatePair& other)
     76             : op(other.op), state(other.state) {}
     77     DrawOp* op;
     78     const DeferredDisplayState* state;
     79 };
     80 
     81 class DeferredDisplayList {
     82 public:
     83     DeferredDisplayList(const Rect& bounds, bool avoidOverdraw = true) :
     84             mBounds(bounds), mAvoidOverdraw(avoidOverdraw) {
     85         clear();
     86     }
     87     ~DeferredDisplayList() { clear(); }
     88     void reset(const Rect& bounds) { mBounds.set(bounds); }
     89 
     90     enum OpBatchId {
     91         kOpBatch_None = 0, // Don't batch
     92         kOpBatch_Bitmap,
     93         kOpBatch_Patch,
     94         kOpBatch_AlphaVertices,
     95         kOpBatch_Vertices,
     96         kOpBatch_AlphaMaskTexture,
     97         kOpBatch_Text,
     98         kOpBatch_ColorText,
     99 
    100         kOpBatch_Count, // Add other batch ids before this
    101     };
    102 
    103     bool isEmpty() { return mBatches.isEmpty(); }
    104 
    105     /**
    106      * Plays back all of the draw ops recorded into batches to the renderer.
    107      * Adjusts the state of the renderer as necessary, and restores it when complete
    108      */
    109     status_t flush(OpenGLRenderer& renderer, Rect& dirty);
    110 
    111     void addClip(OpenGLRenderer& renderer, ClipOp* op);
    112     void addSaveLayer(OpenGLRenderer& renderer, SaveLayerOp* op, int newSaveCount);
    113     void addSave(OpenGLRenderer& renderer, SaveOp* op, int newSaveCount);
    114     void addRestoreToCount(OpenGLRenderer& renderer, StateOp* op, int newSaveCount);
    115 
    116     /**
    117      * Add a draw op into the DeferredDisplayList, reordering as needed (for performance) if
    118      * disallowReorder is false, respecting draw order when overlaps occur.
    119      */
    120     void addDrawOp(OpenGLRenderer& renderer, DrawOp* op);
    121 
    122 private:
    123     DeferredDisplayState* createState() {
    124         return new (mAllocator) DeferredDisplayState();
    125     }
    126 
    127     void tryRecycleState(DeferredDisplayState* state) {
    128         mAllocator.rewindIfLastAlloc(state, sizeof(DeferredDisplayState));
    129     }
    130 
    131     /**
    132      * Resets the batching back-pointers, creating a barrier in the operation stream so that no ops
    133      * added in the future will be inserted into a batch that already exist.
    134      */
    135     void resetBatchingState();
    136 
    137     void clear();
    138 
    139     void storeStateOpBarrier(OpenGLRenderer& renderer, StateOp* op);
    140     void storeRestoreToCountBarrier(OpenGLRenderer& renderer, StateOp* op, int newSaveCount);
    141 
    142     bool recordingComplexClip() const { return mComplexClipStackStart >= 0; }
    143 
    144     int getStateOpDeferFlags() const;
    145     int getDrawOpDeferFlags() const;
    146 
    147     void discardDrawingBatches(const unsigned int maxIndex);
    148 
    149     // layer space bounds of rendering
    150     Rect mBounds;
    151     const bool mAvoidOverdraw;
    152 
    153     /**
    154      * At defer time, stores the *defer time* savecount of save/saveLayer ops that were deferred, so
    155      * that when an associated restoreToCount is deferred, it can be recorded as a
    156      * RestoreToCountBatch
    157      */
    158     Vector<int> mSaveStack;
    159     int mComplexClipStackStart;
    160 
    161     Vector<Batch*> mBatches;
    162 
    163     // Maps batch ids to the most recent *non-merging* batch of that id
    164     Batch* mBatchLookup[kOpBatch_Count];
    165 
    166     // Points to the index after the most recent barrier
    167     int mEarliestBatchIndex;
    168 
    169     // Points to the first index that may contain a pure drawing batch
    170     int mEarliestUnclearedIndex;
    171 
    172     /**
    173      * Maps the mergeid_t returned by an op's getMergeId() to the most recently seen
    174      * MergingDrawBatch of that id. These ids are unique per draw type and guaranteed to not
    175      * collide, which avoids the need to resolve mergeid collisions.
    176      */
    177     TinyHashMap<mergeid_t, DrawBatch*> mMergingBatches[kOpBatch_Count];
    178 
    179     LinearAllocator mAllocator;
    180 };
    181 
    182 /**
    183  * Struct containing information that instructs the defer
    184  */
    185 struct DeferInfo {
    186 public:
    187     DeferInfo() :
    188             batchId(DeferredDisplayList::kOpBatch_None),
    189             mergeId((mergeid_t) -1),
    190             mergeable(false),
    191             opaqueOverBounds(false) {
    192     };
    193 
    194     int batchId;
    195     mergeid_t mergeId;
    196     bool mergeable;
    197     bool opaqueOverBounds; // opaque over bounds in DeferredDisplayState - can skip ops below
    198 };
    199 
    200 }; // namespace uirenderer
    201 }; // namespace android
    202 
    203 #endif // ANDROID_HWUI_DEFERRED_DISPLAY_LIST_H
    204