gpu/command_buffer/service/framebuffer_manager.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef GPU_COMMAND_BUFFER_SERVICE_FRAMEBUFFER_MANAGER_H_
   6 #define GPU_COMMAND_BUFFER_SERVICE_FRAMEBUFFER_MANAGER_H_
   7
   8 #include <vector>
   9
  10 #include "base/basictypes.h"
  11 #include "base/containers/hash_tables.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "gpu/command_buffer/service/context_group.h"
  15 #include "gpu/command_buffer/service/gl_utils.h"
  16 #include "gpu/gpu_export.h"
  17
  18 namespace gpu {
  19 namespace gles2 {
  20
  21 class FramebufferManager;
  22 class Renderbuffer;
  23 class RenderbufferManager;
  24 class Texture;
  25 class TextureRef;
  26 class TextureManager;
  27
  28 // Info about a particular Framebuffer.
  29 class GPU_EXPORT Framebuffer : public base::RefCounted<Framebuffer> {
  30  public:
  31   class Attachment : public base::RefCounted<Attachment> {
  32    public:
  33     virtual GLsizei width() const = 0;
  34     virtual GLsizei height() const = 0;
  35     virtual GLenum internal_format() const = 0;
  36     virtual GLenum texture_type() const = 0;
  37     virtual GLsizei samples() const = 0;
  38     virtual GLuint object_name() const = 0;
  39     virtual bool cleared() const = 0;
  40     virtual void SetCleared(
  41         RenderbufferManager* renderbuffer_manager,
  42         TextureManager* texture_manager,
  43         bool cleared) = 0;
  44     virtual bool IsTexture(TextureRef* texture) const = 0;
  45     virtual bool IsRenderbuffer(
  46         Renderbuffer* renderbuffer) const = 0;
  47     virtual bool CanRenderTo() const = 0;
  48     virtual void DetachFromFramebuffer(Framebuffer* framebuffer) const = 0;
  49     virtual bool ValidForAttachmentType(
  50         GLenum attachment_type, uint32 max_color_attachments) = 0;
  51     virtual size_t GetSignatureSize(TextureManager* texture_manager) const = 0;
  52     virtual void AddToSignature(
  53         TextureManager* texture_manager, std::string* signature) const = 0;
  54     virtual void OnWillRenderTo() const = 0;
  55     virtual void OnDidRenderTo() const = 0;
  56     virtual bool FormsFeedbackLoop(TextureRef* texture, GLint level) const = 0;
  57
  58    protected:
  59     friend class base::RefCounted<Attachment>;
  60     virtual ~Attachment() {}
  61   };
  62
  63   Framebuffer(FramebufferManager* manager, GLuint service_id);
  64
  65   GLuint service_id() const {
  66     return service_id_;
  67   }
  68
  69   bool HasUnclearedAttachment(GLenum attachment) const;
  70   bool HasUnclearedColorAttachments() const;
  71
  72   void MarkAttachmentAsCleared(
  73     RenderbufferManager* renderbuffer_manager,
  74     TextureManager* texture_manager,
  75     GLenum attachment,
  76     bool cleared);
  77
  78   // Unbinds all attachments from this framebuffer for workaround
  79   // 'unbind_attachments_on_bound_render_fbo_delete'.  The Framebuffer must be
  80   // bound when calling this.
  81   void DoUnbindGLAttachmentsForWorkaround(GLenum target);
  82
  83   // Attaches a renderbuffer to a particlar attachment.
  84   // Pass null to detach.
  85   void AttachRenderbuffer(
  86       GLenum attachment, Renderbuffer* renderbuffer);
  87
  88   // Attaches a texture to a particlar attachment. Pass null to detach.
  89   void AttachTexture(
  90       GLenum attachment, TextureRef* texture_ref, GLenum target,
  91       GLint level, GLsizei samples);
  92
  93   // Unbinds the given renderbuffer if it is bound.
  94   void UnbindRenderbuffer(
  95       GLenum target, Renderbuffer* renderbuffer);
  96
  97   // Unbinds the given texture if it is bound.
  98   void UnbindTexture(
  99       GLenum target, TextureRef* texture_ref);
 100
 101   const Attachment* GetAttachment(GLenum attachment) const;
 102
 103   bool IsDeleted() const {
 104     return deleted_;
 105   }
 106
 107   void MarkAsValid() {
 108     has_been_bound_ = true;
 109   }
 110
 111   bool IsValid() const {
 112     return has_been_bound_ && !IsDeleted();
 113   }
 114
 115   bool HasDepthAttachment() const;
 116   bool HasStencilAttachment() const;
 117   GLenum GetColorAttachmentFormat() const;
 118   // If the color attachment is a texture, returns its type; otherwise,
 119   // returns 0.
 120   GLenum GetColorAttachmentTextureType() const;
 121
 122   // Verify all the rules in OpenGL ES 2.0.25 4.4.5 are followed.
 123   // Returns GL_FRAMEBUFFER_COMPLETE if there are no reasons we know we can't
 124   // use this combination of attachments. Otherwise returns the value
 125   // that glCheckFramebufferStatus should return for this set of attachments.
 126   // Note that receiving GL_FRAMEBUFFER_COMPLETE from this function does
 127   // not mean the real OpenGL will consider it framebuffer complete. It just
 128   // means it passed our tests.
 129   GLenum IsPossiblyComplete() const;
 130
 131   // Implements optimized glGetFramebufferStatus.
 132   GLenum GetStatus(TextureManager* texture_manager, GLenum target) const;
 133
 134   // Check all attachments are cleared
 135   bool IsCleared() const;
 136
 137   GLenum GetDrawBuffer(GLenum draw_buffer) const;
 138
 139   void SetDrawBuffers(GLsizei n, const GLenum* bufs);
 140
 141   // If a color buffer is attached to GL_COLOR_ATTACHMENTi, enable that
 142   // draw buffer for glClear().
 143   void PrepareDrawBuffersForClear() const;
 144
 145   // Restore draw buffers states that have been changed in
 146   // PrepareDrawBuffersForClear().
 147   void RestoreDrawBuffersAfterClear() const;
 148
 149   // Return true if any draw buffers has an alpha channel.
 150   bool HasAlphaMRT() const;
 151
 152   static void ClearFramebufferCompleteComboMap();
 153
 154   static bool AllowFramebufferComboCompleteMapForTesting() {
 155     return allow_framebuffer_combo_complete_map_;
 156   }
 157
 158   void OnTextureRefDetached(TextureRef* texture);
 159   void OnWillRenderTo() const;
 160   void OnDidRenderTo() const;
 161
 162  private:
 163   friend class FramebufferManager;
 164   friend class base::RefCounted<Framebuffer>;
 165
 166   ~Framebuffer();
 167
 168   void MarkAsDeleted();
 169
 170   void MarkAttachmentsAsCleared(
 171     RenderbufferManager* renderbuffer_manager,
 172     TextureManager* texture_manager,
 173     bool cleared);
 174
 175   void MarkAsComplete(unsigned state_id) {
 176     framebuffer_complete_state_count_id_ = state_id;
 177   }
 178
 179   unsigned framebuffer_complete_state_count_id() const {
 180     return framebuffer_complete_state_count_id_;
 181   }
 182
 183   // Helper function for PrepareDrawBuffersForClear() and
 184   // RestoreDrawBuffersAfterClear().
 185   void ChangeDrawBuffersHelper(bool recover) const;
 186
 187   // The managers that owns this.
 188   FramebufferManager* manager_;
 189
 190   bool deleted_;
 191
 192   // Service side framebuffer id.
 193   GLuint service_id_;
 194
 195   // Whether this framebuffer has ever been bound.
 196   bool has_been_bound_;
 197
 198   // state count when this framebuffer was last checked for completeness.
 199   unsigned framebuffer_complete_state_count_id_;
 200
 201   // A map of attachments.
 202   typedef base::hash_map<GLenum, scoped_refptr<Attachment> > AttachmentMap;
 203   AttachmentMap attachments_;
 204
 205   // A map of successful frame buffer combos. If it's in the map
 206   // it should be FRAMEBUFFER_COMPLETE.
 207   typedef base::hash_map<std::string, bool> FramebufferComboCompleteMap;
 208   static FramebufferComboCompleteMap* framebuffer_combo_complete_map_;
 209   static bool allow_framebuffer_combo_complete_map_;
 210
 211   scoped_ptr<GLenum[]> draw_buffers_;
 212
 213   DISALLOW_COPY_AND_ASSIGN(Framebuffer);
 214 };
 215
 216 struct DecoderFramebufferState {
 217   DecoderFramebufferState();
 218   ~DecoderFramebufferState();
 219
 220   // State saved for clearing so we can clear render buffers and then
 221   // restore to these values.
 222   bool clear_state_dirty;
 223
 224   // The currently bound framebuffers
 225   scoped_refptr<Framebuffer> bound_read_framebuffer;
 226   scoped_refptr<Framebuffer> bound_draw_framebuffer;
 227 };
 228
 229 // This class keeps track of the frambebuffers and their attached renderbuffers
 230 // so we can correctly clear them.
 231 class GPU_EXPORT FramebufferManager {
 232  public:
 233   class GPU_EXPORT TextureDetachObserver {
 234    public:
 235     TextureDetachObserver();
 236     virtual ~TextureDetachObserver();
 237
 238     virtual void OnTextureRefDetachedFromFramebuffer(TextureRef* texture) = 0;
 239
 240    private:
 241     DISALLOW_COPY_AND_ASSIGN(TextureDetachObserver);
 242   };
 243
 244   FramebufferManager(uint32 max_draw_buffers, uint32 max_color_attachments,
 245                      ContextGroup::ContextType context_type);
 246   ~FramebufferManager();
 247
 248   // Must call before destruction.
 249   void Destroy(bool have_context);
 250
 251   // Creates a Framebuffer for the given framebuffer.
 252   void CreateFramebuffer(GLuint client_id, GLuint service_id);
 253
 254   // Gets the framebuffer info for the given framebuffer.
 255   Framebuffer* GetFramebuffer(GLuint client_id);
 256
 257   // Removes a framebuffer info for the given framebuffer.
 258   void RemoveFramebuffer(GLuint client_id);
 259
 260   // Gets a client id for a given service id.
 261   bool GetClientId(GLuint service_id, GLuint* client_id) const;
 262
 263   void MarkAttachmentsAsCleared(
 264     Framebuffer* framebuffer,
 265     RenderbufferManager* renderbuffer_manager,
 266     TextureManager* texture_manager);
 267
 268   void MarkAsComplete(Framebuffer* framebuffer);
 269
 270   bool IsComplete(Framebuffer* framebuffer);
 271
 272   void IncFramebufferStateChangeCount() {
 273     // make sure this is never 0.
 274     framebuffer_state_change_count_ =
 275         (framebuffer_state_change_count_ + 1) | 0x80000000U;
 276   }
 277
 278   void AddObserver(TextureDetachObserver* observer) {
 279     texture_detach_observers_.push_back(observer);
 280   }
 281
 282   void RemoveObserver(TextureDetachObserver* observer) {
 283     texture_detach_observers_.erase(
 284         std::remove(texture_detach_observers_.begin(),
 285                     texture_detach_observers_.end(),
 286                     observer),
 287         texture_detach_observers_.end());
 288   }
 289
 290   ContextGroup::ContextType context_type() const {
 291     return context_type_;
 292   }
 293
 294  private:
 295   friend class Framebuffer;
 296
 297   void StartTracking(Framebuffer* framebuffer);
 298   void StopTracking(Framebuffer* framebuffer);
 299
 300   void OnTextureRefDetached(TextureRef* texture);
 301
 302   // Info for each framebuffer in the system.
 303   typedef base::hash_map<GLuint, scoped_refptr<Framebuffer> >
 304       FramebufferMap;
 305   FramebufferMap framebuffers_;
 306
 307   // Incremented anytime anything changes that might effect framebuffer
 308   // state.
 309   unsigned framebuffer_state_change_count_;
 310
 311   // Counts the number of Framebuffer allocated with 'this' as its manager.
 312   // Allows to check no Framebuffer will outlive this.
 313   unsigned int framebuffer_count_;
 314
 315   bool have_context_;
 316
 317   uint32 max_draw_buffers_;
 318   uint32 max_color_attachments_;
 319
 320   ContextGroup::ContextType context_type_;
 321
 322   typedef std::vector<TextureDetachObserver*> TextureDetachObserverVector;
 323   TextureDetachObserverVector texture_detach_observers_;
 324
 325   DISALLOW_COPY_AND_ASSIGN(FramebufferManager);
 326 };
 327
 328 }  // namespace gles2
 329 }  // namespace gpu
 330
 331 #endif  // GPU_COMMAND_BUFFER_SERVICE_FRAMEBUFFER_MANAGER_H_