cc/test/test_web_graphics_context_3d.h

   1 // Copyright 2013 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 CC_TEST_TEST_WEB_GRAPHICS_CONTEXT_3D_H_
   6 #define CC_TEST_TEST_WEB_GRAPHICS_CONTEXT_3D_H_
   7
   8 #include <vector>
   9
  10 #include "base/callback.h"
  11 #include "base/compiler_specific.h"
  12 #include "base/containers/hash_tables.h"
  13 #include "base/containers/scoped_ptr_hash_map.h"
  14 #include "base/memory/ref_counted.h"
  15 #include "base/memory/scoped_ptr.h"
  16 #include "base/memory/weak_ptr.h"
  17 #include "base/stl_util.h"
  18 #include "base/synchronization/lock.h"
  19 #include "cc/output/context_provider.h"
  20 #include "cc/test/ordered_texture_map.h"
  21 #include "cc/test/test_texture.h"
  22 #include "third_party/khronos/GLES2/gl2.h"
  23 #include "ui/gfx/rect.h"
  24
  25 namespace cc {
  26 class TestContextSupport;
  27
  28 class TestWebGraphicsContext3D {
  29  public:
  30   static scoped_ptr<TestWebGraphicsContext3D> Create();
  31
  32   virtual ~TestWebGraphicsContext3D();
  33
  34   void set_context_lost_callback(const base::Closure& callback) {
  35     context_lost_callback_ = callback;
  36   }
  37
  38   virtual void reshapeWithScaleFactor(int width,
  39                                       int height,
  40                                       float scale_factor);
  41
  42   virtual bool isContextLost();
  43
  44   virtual void discardFramebufferEXT(GLenum target,
  45                                      GLsizei num_attachments,
  46                                      const GLenum* attachments) {}
  47
  48   virtual void activeTexture(GLenum texture) {}
  49   virtual void attachShader(GLuint program, GLuint shader);
  50   virtual void bindFramebuffer(GLenum target, GLuint framebuffer);
  51   virtual void bindRenderbuffer(GLenum target, GLuint renderbuffer);
  52   virtual void bindTexture(GLenum target, GLuint texture_id);
  53
  54   virtual void texParameteri(GLenum target, GLenum pname, GLint param);
  55   virtual void getTexParameteriv(GLenum target, GLenum pname, GLint* value);
  56   virtual void asyncTexImage2DCHROMIUM(GLenum target,
  57                                        GLint level,
  58                                        GLenum internalformat,
  59                                        GLsizei width,
  60                                        GLsizei height,
  61                                        GLint border,
  62                                        GLenum format,
  63                                        GLenum type,
  64                                        const void* pixels) {}
  65   virtual void asyncTexSubImage2DCHROMIUM(GLenum target,
  66                                           GLint level,
  67                                           GLint xoffset,
  68                                           GLint yoffset,
  69                                           GLsizei width,
  70                                           GLsizei height,
  71                                           GLenum format,
  72                                           GLenum type,
  73                                           const void* pixels) {}
  74   virtual void waitAsyncTexImage2DCHROMIUM(GLenum target) {}
  75   virtual void releaseTexImage2DCHROMIUM(GLenum target, GLint image_id) {}
  76
  77   virtual GLenum checkFramebufferStatus(GLenum target);
  78
  79   virtual void clear(GLbitfield mask) {}
  80   virtual void clearColor(GLclampf red,
  81                           GLclampf green,
  82                           GLclampf blue,
  83                           GLclampf alpha) {}
  84   virtual void clearStencil(GLint s) {}
  85   virtual void compressedTexImage2D(GLenum target,
  86                                     GLint level,
  87                                     GLenum internal_format,
  88                                     GLsizei width,
  89                                     GLsizei height,
  90                                     GLint border,
  91                                     GLsizei image_size,
  92                                     const void* data) {}
  93   virtual GLint getUniformLocation(GLuint program, const GLchar* name);
  94   virtual GLsizeiptr getVertexAttribOffset(GLuint index, GLenum pname);
  95
  96   virtual GLboolean isBuffer(GLuint buffer);
  97   virtual GLboolean isEnabled(GLenum cap);
  98   virtual GLboolean isFramebuffer(GLuint framebuffer);
  99   virtual GLboolean isProgram(GLuint program);
 100   virtual GLboolean isRenderbuffer(GLuint renderbuffer);
 101   virtual GLboolean isShader(GLuint shader);
 102   virtual GLboolean isTexture(GLuint texture);
 103
 104   virtual void useProgram(GLuint program);
 105
 106   virtual void viewport(GLint x, GLint y, GLsizei width, GLsizei height) {}
 107
 108   virtual void genBuffers(GLsizei count, GLuint* ids);
 109   virtual void genFramebuffers(GLsizei count, GLuint* ids);
 110   virtual void genRenderbuffers(GLsizei count, GLuint* ids);
 111   virtual void genTextures(GLsizei count, GLuint* ids);
 112
 113   virtual void deleteBuffers(GLsizei count, GLuint* ids);
 114   virtual void deleteFramebuffers(GLsizei count, GLuint* ids);
 115   virtual void deleteRenderbuffers(GLsizei count, GLuint* ids);
 116   virtual void deleteTextures(GLsizei count, GLuint* ids);
 117
 118   virtual GLuint createBuffer();
 119   virtual GLuint createFramebuffer();
 120   virtual GLuint createRenderbuffer();
 121   virtual GLuint createTexture();
 122
 123   virtual void deleteBuffer(GLuint id);
 124   virtual void deleteFramebuffer(GLuint id);
 125   virtual void deleteRenderbuffer(GLuint id);
 126   virtual void deleteTexture(GLuint id);
 127
 128   virtual GLuint createProgram();
 129   virtual GLuint createShader(GLenum);
 130   virtual GLuint createExternalTexture();
 131
 132   virtual void deleteProgram(GLuint id);
 133   virtual void deleteShader(GLuint id);
 134
 135   virtual void texStorage2DEXT(GLenum target,
 136                                GLint levels,
 137                                GLuint internalformat,
 138                                GLint width,
 139                                GLint height) {}
 140
 141   virtual GLuint createQueryEXT();
 142   virtual void deleteQueryEXT(GLuint query) {}
 143   virtual void beginQueryEXT(GLenum target, GLuint query) {}
 144   virtual void endQueryEXT(GLenum target);
 145   virtual void getQueryObjectuivEXT(GLuint query, GLenum pname, GLuint* params);
 146
 147   virtual void scissor(GLint x, GLint y, GLsizei width, GLsizei height) {}
 148
 149   virtual void texImage2D(GLenum target,
 150                           GLint level,
 151                           GLenum internalformat,
 152                           GLsizei width,
 153                           GLsizei height,
 154                           GLint border,
 155                           GLenum format,
 156                           GLenum type,
 157                           const void* pixels) {}
 158
 159   virtual void texSubImage2D(GLenum target,
 160                              GLint level,
 161                              GLint xoffset,
 162                              GLint yoffset,
 163                              GLsizei width,
 164                              GLsizei height,
 165                              GLenum format,
 166                              GLenum type,
 167                              const void* pixels) {}
 168
 169   virtual void genMailboxCHROMIUM(GLbyte* mailbox);
 170   virtual void produceTextureCHROMIUM(GLenum target,
 171                                       const GLbyte* mailbox) { }
 172   virtual void consumeTextureCHROMIUM(GLenum target,
 173                                       const GLbyte* mailbox) { }
 174
 175   virtual void loseContextCHROMIUM(GLenum current, GLenum other);
 176
 177   virtual void bindTexImage2DCHROMIUM(GLenum target, GLint image_id) {}
 178
 179   virtual void drawArrays(GLenum mode, GLint first, GLsizei count) {}
 180   virtual void drawElements(GLenum mode,
 181                             GLsizei count,
 182                             GLenum type,
 183                             GLintptr offset) {}
 184   virtual void disable(GLenum cap) {}
 185   virtual void enable(GLenum cap) {}
 186   virtual void finish();
 187   virtual void flush();
 188   virtual void shallowFlushCHROMIUM() {}
 189
 190   virtual void getAttachedShaders(GLuint program,
 191                                   GLsizei max_count,
 192                                   GLsizei* count,
 193                                   GLuint* shaders) {}
 194   virtual GLint getAttribLocation(GLuint program, const GLchar* name);
 195   virtual void getBooleanv(GLenum pname, GLboolean* value) {}
 196   virtual void getBufferParameteriv(GLenum target, GLenum pname, GLint* value) {
 197   }
 198   virtual GLenum getError();
 199   virtual void getFloatv(GLenum pname, GLfloat* value) {}
 200   virtual void getFramebufferAttachmentParameteriv(GLenum target,
 201                                                    GLenum attachment,
 202                                                    GLenum pname,
 203                                                    GLint* value) {}
 204
 205   virtual void getIntegerv(GLenum pname, GLint* value);
 206
 207   virtual void getProgramiv(GLuint program, GLenum pname, GLint* value);
 208
 209   virtual void getRenderbufferParameteriv(GLenum target,
 210                                           GLenum pname,
 211                                           GLint* value) {}
 212
 213   virtual void getShaderiv(GLuint shader, GLenum pname, GLint* value);
 214
 215   virtual void getShaderPrecisionFormat(GLenum shadertype,
 216                                         GLenum precisiontype,
 217                                         GLint* range,
 218                                         GLint* precision);
 219
 220   virtual void getTexParameterfv(GLenum target, GLenum pname, GLfloat* value) {}
 221   virtual void getUniformfv(GLuint program, GLint location, GLfloat* value) {}
 222   virtual void getUniformiv(GLuint program, GLint location, GLint* value) {}
 223   virtual void getVertexAttribfv(GLuint index, GLenum pname, GLfloat* value) {}
 224   virtual void getVertexAttribiv(GLuint index, GLenum pname, GLint* value) {}
 225
 226   virtual void bindBuffer(GLenum target, GLuint buffer);
 227   virtual void bufferData(GLenum target,
 228                           GLsizeiptr size,
 229                           const void* data,
 230                           GLenum usage);
 231   virtual void* mapBufferCHROMIUM(GLenum target,
 232                                   GLenum access);
 233   virtual GLboolean unmapBufferCHROMIUM(GLenum target);
 234
 235   virtual GLuint createImageCHROMIUM(GLsizei width,
 236                                      GLsizei height,
 237                                      GLenum internalformat);
 238   virtual void destroyImageCHROMIUM(GLuint image_id);
 239   virtual void getImageParameterivCHROMIUM(GLuint image_id,
 240                                            GLenum pname,
 241                                            GLint* params);
 242   virtual void* mapImageCHROMIUM(GLuint image_id, GLenum access);
 243   virtual void unmapImageCHROMIUM(GLuint image_id);
 244   virtual void texImageIOSurface2DCHROMIUM(GLenum target,
 245                                            GLsizei width,
 246                                            GLsizei height,
 247                                            GLuint io_surface_id,
 248                                            GLuint plane) {}
 249
 250   virtual unsigned insertSyncPoint();
 251   virtual void waitSyncPoint(unsigned sync_point);
 252
 253   unsigned last_waited_sync_point() const { return last_waited_sync_point_; }
 254
 255   const ContextProvider::Capabilities& test_capabilities() const {
 256     return test_capabilities_;
 257   }
 258
 259   void set_context_lost(bool context_lost) { context_lost_ = context_lost; }
 260   void set_times_bind_texture_succeeds(int times) {
 261     times_bind_texture_succeeds_ = times;
 262   }
 263   void set_times_end_query_succeeds(int times) {
 264     times_end_query_succeeds_ = times;
 265   }
 266
 267   // When set, mapImageCHROMIUM and mapBufferCHROMIUM will return NULL after
 268   // this many times.
 269   void set_times_map_image_chromium_succeeds(int times) {
 270     times_map_image_chromium_succeeds_ = times;
 271   }
 272   void set_times_map_buffer_chromium_succeeds(int times) {
 273     times_map_buffer_chromium_succeeds_ = times;
 274   }
 275
 276   size_t NumTextures() const;
 277   GLuint TextureAt(int i) const;
 278
 279   size_t NumUsedTextures() const { return used_textures_.size(); }
 280   bool UsedTexture(int texture) const {
 281     return ContainsKey(used_textures_, texture);
 282   }
 283   void ResetUsedTextures() { used_textures_.clear(); }
 284
 285   void set_have_extension_io_surface(bool have) {
 286     test_capabilities_.gpu.iosurface = have;
 287     test_capabilities_.gpu.texture_rectangle = have;
 288   }
 289   void set_have_extension_egl_image(bool have) {
 290     test_capabilities_.gpu.egl_image_external = have;
 291   }
 292   void set_have_post_sub_buffer(bool have) {
 293     test_capabilities_.gpu.post_sub_buffer = have;
 294   }
 295   void set_have_discard_framebuffer(bool have) {
 296     test_capabilities_.gpu.discard_framebuffer = have;
 297   }
 298   void set_support_compressed_texture_etc1(bool support) {
 299     test_capabilities_.gpu.texture_format_etc1 = support;
 300   }
 301   void set_support_texture_storage(bool support) {
 302     test_capabilities_.gpu.texture_storage = support;
 303   }
 304
 305   // When this context is lost, all contexts in its share group are also lost.
 306   void add_share_group_context(TestWebGraphicsContext3D* context3d) {
 307     shared_contexts_.push_back(context3d);
 308   }
 309
 310   void set_max_texture_size(int size) { max_texture_size_ = size; }
 311
 312   static const GLuint kExternalTextureId;
 313   virtual GLuint NextTextureId();
 314   virtual void RetireTextureId(GLuint id);
 315
 316   virtual GLuint NextBufferId();
 317   virtual void RetireBufferId(GLuint id);
 318
 319   virtual GLuint NextImageId();
 320   virtual void RetireImageId(GLuint id);
 321
 322   size_t GetTransferBufferMemoryUsedBytes() const;
 323   void SetMaxTransferBufferUsageBytes(size_t max_transfer_buffer_usage_bytes);
 324   size_t GetPeakTransferBufferMemoryUsedBytes() const {
 325     return peak_transfer_buffer_memory_used_bytes_;
 326   }
 327
 328   void set_test_support(TestContextSupport* test_support) {
 329     test_support_ = test_support;
 330   }
 331
 332   int width() const { return width_; }
 333   int height() const { return height_; }
 334   bool reshape_called() const { return reshape_called_; }
 335   void clear_reshape_called() { reshape_called_ = false; }
 336   float scale_factor() const { return scale_factor_; }
 337
 338   enum UpdateType {
 339     NoUpdate = 0,
 340     PrepareTexture,
 341     PostSubBuffer
 342   };
 343
 344   gfx::Rect update_rect() const { return update_rect_; }
 345
 346   UpdateType last_update_type() { return last_update_type_; }
 347
 348  protected:
 349   struct TextureTargets {
 350     TextureTargets();
 351     ~TextureTargets();
 352
 353     void BindTexture(GLenum target, GLuint id);
 354     void UnbindTexture(GLuint id);
 355
 356     GLuint BoundTexture(GLenum target);
 357
 358    private:
 359     typedef base::hash_map<GLenum, GLuint> TargetTextureMap;
 360     TargetTextureMap bound_textures_;
 361   };
 362
 363   struct Buffer {
 364     Buffer();
 365     ~Buffer();
 366
 367     GLenum target;
 368     scoped_ptr<uint8[]> pixels;
 369     size_t size;
 370
 371    private:
 372     DISALLOW_COPY_AND_ASSIGN(Buffer);
 373   };
 374
 375   struct Image {
 376     Image();
 377     ~Image();
 378
 379     scoped_ptr<uint8[]> pixels;
 380
 381    private:
 382     DISALLOW_COPY_AND_ASSIGN(Image);
 383   };
 384
 385   struct Namespace : public base::RefCountedThreadSafe<Namespace> {
 386     Namespace();
 387
 388     // Protects all fields.
 389     base::Lock lock;
 390     unsigned next_buffer_id;
 391     unsigned next_image_id;
 392     unsigned next_texture_id;
 393     base::ScopedPtrHashMap<unsigned, Buffer> buffers;
 394     base::ScopedPtrHashMap<unsigned, Image> images;
 395     OrderedTextureMap textures;
 396
 397    private:
 398     friend class base::RefCountedThreadSafe<Namespace>;
 399     ~Namespace();
 400     DISALLOW_COPY_AND_ASSIGN(Namespace);
 401   };
 402
 403   TestWebGraphicsContext3D();
 404
 405   void CreateNamespace();
 406   GLuint BoundTextureId(GLenum target);
 407   scoped_refptr<TestTexture> BoundTexture(GLenum target);
 408   void CheckTextureIsBound(GLenum target);
 409
 410   unsigned context_id_;
 411   ContextProvider::Capabilities test_capabilities_;
 412   int times_bind_texture_succeeds_;
 413   int times_end_query_succeeds_;
 414   bool context_lost_;
 415   int times_map_image_chromium_succeeds_;
 416   int times_map_buffer_chromium_succeeds_;
 417   base::Closure context_lost_callback_;
 418   base::hash_set<unsigned> used_textures_;
 419   unsigned next_program_id_;
 420   base::hash_set<unsigned> program_set_;
 421   unsigned next_shader_id_;
 422   base::hash_set<unsigned> shader_set_;
 423   std::vector<TestWebGraphicsContext3D*> shared_contexts_;
 424   int max_texture_size_;
 425   bool reshape_called_;
 426   int width_;
 427   int height_;
 428   float scale_factor_;
 429   TestContextSupport* test_support_;
 430   gfx::Rect update_rect_;
 431   UpdateType last_update_type_;
 432   unsigned next_insert_sync_point_;
 433   unsigned last_waited_sync_point_;
 434
 435   unsigned bound_buffer_;
 436   TextureTargets texture_targets_;
 437
 438   size_t peak_transfer_buffer_memory_used_bytes_;
 439
 440   scoped_refptr<Namespace> namespace_;
 441   static Namespace* shared_namespace_;
 442
 443   base::WeakPtrFactory<TestWebGraphicsContext3D> weak_ptr_factory_;
 444 };
 445
 446 }  // namespace cc
 447
 448 #endif  // CC_TEST_TEST_WEB_GRAPHICS_CONTEXT_3D_H_