gpu/command_buffer/service/shader_translator.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_SHADER_TRANSLATOR_H_
   6 #define GPU_COMMAND_BUFFER_SERVICE_SHADER_TRANSLATOR_H_
   7
   8 #include <string>
   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 "base/observer_list.h"
  15 #include "gpu/gpu_export.h"
  16 #include "third_party/angle/include/GLSLANG/ShaderLang.h"
  17
  18 namespace gfx {
  19 struct GLVersionInfo;
  20 }
  21
  22 namespace gpu {
  23 namespace gles2 {
  24
  25 // Mapping between variable name and info.
  26 typedef base::hash_map<std::string, sh::Attribute> AttributeMap;
  27 typedef base::hash_map<std::string, sh::Uniform> UniformMap;
  28 typedef base::hash_map<std::string, sh::Varying> VaryingMap;
  29 // Mapping between hashed name and original name.
  30 typedef base::hash_map<std::string, std::string> NameMap;
  31
  32 // Translates a GLSL ES 2.0 shader to desktop GLSL shader, or just
  33 // validates GLSL ES 2.0 shaders on a true GLSL ES implementation.
  34 class ShaderTranslatorInterface
  35     : public base::RefCounted<ShaderTranslatorInterface> {
  36  public:
  37   ShaderTranslatorInterface() {}
  38
  39   // Initializes the translator.
  40   // Must be called once before using the translator object.
  41   virtual bool Init(sh::GLenum shader_type,
  42                     ShShaderSpec shader_spec,
  43                     const ShBuiltInResources* resources,
  44                     ShShaderOutput shader_output_language,
  45                     ShCompileOptions driver_bug_workarounds) = 0;
  46
  47   // Translates the given shader source.
  48   // Returns true if translation is successful, false otherwise.
  49   // Always fill |info_log| if it's non-null.
  50   // Upon success, fill |translated_shader|, |attrib_map|, |uniform_map|,
  51   // |varying_map|, and |name_map| if they are non-null.
  52   virtual bool Translate(const std::string& shader_source,
  53                          std::string* info_log,
  54                          std::string* translated_shader,
  55                          int* shader_version,
  56                          AttributeMap* attrib_map,
  57                          UniformMap* uniform_map,
  58                          VaryingMap* varying_map,
  59                          NameMap* name_map) const = 0;
  60
  61   // Return a string that is unique for a specfic set of options that would
  62   // possibly affect compilation.
  63   virtual std::string GetStringForOptionsThatWouldAffectCompilation() const = 0;
  64
  65  protected:
  66   virtual ~ShaderTranslatorInterface() {}
  67
  68  private:
  69   friend class base::RefCounted<ShaderTranslatorInterface>;
  70   DISALLOW_COPY_AND_ASSIGN(ShaderTranslatorInterface);
  71 };
  72
  73 // Implementation of ShaderTranslatorInterface
  74 class GPU_EXPORT ShaderTranslator
  75     : NON_EXPORTED_BASE(public ShaderTranslatorInterface) {
  76  public:
  77   class DestructionObserver {
  78    public:
  79     DestructionObserver();
  80     virtual ~DestructionObserver();
  81
  82     virtual void OnDestruct(ShaderTranslator* translator) = 0;
  83
  84    private:
  85     DISALLOW_COPY_AND_ASSIGN(DestructionObserver);
  86   };
  87
  88   ShaderTranslator();
  89
  90   // Return shader output lanaguage type based on the context version.
  91   static ShShaderOutput GetShaderOutputLanguageForContext(
  92       const gfx::GLVersionInfo& context_version);
  93
  94   // Overridden from ShaderTranslatorInterface.
  95   bool Init(sh::GLenum shader_type,
  96             ShShaderSpec shader_spec,
  97             const ShBuiltInResources* resources,
  98             ShShaderOutput shader_output_language,
  99             ShCompileOptions driver_bug_workarounds) override;
 100
 101   // Overridden from ShaderTranslatorInterface.
 102   bool Translate(const std::string& shader_source,
 103                  std::string* info_log,
 104                  std::string* translated_source,
 105                  int* shader_version,
 106                  AttributeMap* attrib_map,
 107                  UniformMap* uniform_map,
 108                  VaryingMap* varying_map,
 109                  NameMap* name_map) const override;
 110
 111   std::string GetStringForOptionsThatWouldAffectCompilation() const override;
 112
 113   void AddDestructionObserver(DestructionObserver* observer);
 114   void RemoveDestructionObserver(DestructionObserver* observer);
 115
 116  private:
 117   ~ShaderTranslator() override;
 118
 119   int GetCompileOptions() const;
 120
 121   ShHandle compiler_;
 122   ShCompileOptions driver_bug_workarounds_;
 123   base::ObserverList<DestructionObserver> destruction_observers_;
 124 };
 125
 126 }  // namespace gles2
 127 }  // namespace gpu
 128
 129 #endif  // GPU_COMMAND_BUFFER_SERVICE_SHADER_TRANSLATOR_H_
 130