source/core/program.cpp

   1 #include <algorithm>
   2 #include <cstring>
   3 #include <set>
   4 #include <msp/core/hash.h>
   5 #include <msp/core/maputils.h>
   6 #include <msp/gl/extensions/arb_fragment_shader.h>
   7 #include <msp/gl/extensions/arb_geometry_shader4.h>
   8 #include <msp/gl/extensions/arb_shader_objects.h>
   9 #include <msp/gl/extensions/arb_uniform_buffer_object.h>
  10 #include <msp/gl/extensions/arb_vertex_shader.h>
  11 #include <msp/gl/extensions/ext_gpu_shader4.h>
  12 #include <msp/gl/extensions/nv_non_square_matrices.h>
  13 #include <msp/io/print.h>
  14 #include <msp/strings/format.h>
  15 #include "buffer.h"
  16 #include "error.h"
  17 #include "misc.h"
  18 #include "module.h"
  19 #include "program.h"
  20 #include "resources.h"
  21 #include "shader.h"
  22 #include "glsl/compiler.h"
  23
  24 using namespace std;
  25
  26 namespace Msp {
  27 namespace GL {
  28
  29 Program::Program()
  30 {
  31         init();
  32 }
  33
  34 Program::Program(const std::string &source)
  35 {
  36         init();
  37
  38         GlslModule mod;
  39         mod.set_source(source);
  40         add_stages(mod);
  41
  42         link();
  43         module = 0;
  44 }
  45
  46 Program::Program(const string &vert, const string &frag)
  47 {
  48         init();
  49
  50 #pragma GCC diagnostic push
  51 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
  52         attach_shader_owned(new VertexShader(vert));
  53         attach_shader_owned(new FragmentShader(frag));
  54 #pragma GCC diagnostic pop
  55         link();
  56 }
  57
  58 Program::Program(const Module &mod, const map<string, int> &spec_values)
  59 {
  60         init();
  61         add_stages(mod, spec_values);
  62         link();
  63 }
  64
  65 void Program::init()
  66 {
  67         static Require _req(ARB_shader_objects);
  68
  69         id = glCreateProgram();
  70         module = 0;
  71         linked = false;
  72 }
  73
  74 Program::~Program()
  75 {
  76         for(vector<unsigned>::iterator i=stage_ids.begin(); i!=stage_ids.end(); ++i)
  77                 glDeleteShader(*i);
  78         glDeleteProgram(id);
  79 }
  80
  81 void Program::add_stages(const Module &mod, const map<string, int> &spec_values)
  82 {
  83         if(!stage_ids.empty())
  84                 throw invalid_operation("Program::add_stages");
  85
  86         switch(mod.get_format())
  87         {
  88         case Module::GLSL: return add_glsl_stages(static_cast<const GlslModule &>(mod), spec_values);
  89         default: throw invalid_argument("Program::add_stages");
  90         }
  91 }
  92
  93 unsigned Program::add_stage(GLenum type)
  94 {
  95         switch(type)
  96         {
  97         case GL_VERTEX_SHADER: { static Require _req(ARB_vertex_shader); } break;
  98         case GL_GEOMETRY_SHADER: { static Require _req(ARB_geometry_shader4); } break;
  99         case GL_FRAGMENT_SHADER: { static Require _req(ARB_fragment_shader); } break;
 100         default: throw invalid_argument("Program::add_stage");
 101         }
 102
 103         unsigned stage_id = glCreateShader(type);
 104         stage_ids.push_back(stage_id);
 105         glAttachShader(id, stage_id);
 106
 107         return stage_id;
 108 }
 109
 110 void Program::add_glsl_stages(const GlslModule &mod, const map<string, int> &spec_values)
 111 {
 112         module = &mod;
 113
 114         SL::Compiler compiler;
 115         compiler.set_source(mod.get_prepared_source(), "<module>");
 116         compiler.specialize(spec_values);
 117         compiler.compile(SL::Compiler::PROGRAM);
 118 #ifdef DEBUG
 119         string diagnostics = compiler.get_diagnostics();
 120         if(!diagnostics.empty())
 121                 IO::print("Program diagnostics:\n%s\n", diagnostics);
 122 #endif
 123
 124         vector<SL::Stage::Type> stages = compiler.get_stages();
 125         for(vector<SL::Stage::Type>::const_iterator i=stages.begin(); i!=stages.end(); ++i)
 126         {
 127                 unsigned stage_id = 0;
 128                 switch(*i)
 129                 {
 130                 case SL::Stage::VERTEX: stage_id = add_stage(GL_VERTEX_SHADER); break;
 131                 case SL::Stage::GEOMETRY: stage_id = add_stage(GL_GEOMETRY_SHADER); break;
 132                 case SL::Stage::FRAGMENT: stage_id = add_stage(GL_FRAGMENT_SHADER); break;
 133                 default: throw invalid_operation("Program::add_glsl_stages");
 134                 }
 135
 136                 string stage_src = compiler.get_stage_glsl(*i);
 137                 const char *src_ptr = stage_src.data();
 138                 int src_len = stage_src.size();
 139                 glShaderSource(stage_id, 1, &src_ptr, &src_len);
 140
 141                 if(*i==SL::Stage::VERTEX)
 142                 {
 143                         const map<string, unsigned> &attribs = compiler.get_vertex_attributes();
 144                         for(map<string, unsigned>::const_iterator j=attribs.begin(); j!=attribs.end(); ++j)
 145                                 glBindAttribLocation(id, j->second, j->first.c_str());
 146                 }
 147
 148                 if(*i==SL::Stage::FRAGMENT && EXT_gpu_shader4)
 149                 {
 150                         const map<string, unsigned> &frag_outs = compiler.get_fragment_outputs();
 151                         for(map<string, unsigned>::const_iterator j=frag_outs.begin(); j!=frag_outs.end(); ++j)
 152                                 glBindFragDataLocation(id, j->second, j->first.c_str());
 153                 }
 154
 155                 compile_glsl_stage(stage_id);
 156         }
 157 }
 158
 159 void Program::compile_glsl_stage(unsigned stage_id)
 160 {
 161         glCompileShader(stage_id);
 162         bool compiled = get_shader_i(stage_id, GL_COMPILE_STATUS);
 163
 164         GLsizei info_log_len = get_shader_i(stage_id, GL_INFO_LOG_LENGTH);
 165         string info_log(info_log_len+1, 0);
 166         glGetShaderInfoLog(stage_id, info_log_len+1, &info_log_len, &info_log[0]);
 167         info_log.erase(info_log_len);
 168         if(module && module->get_format()==Module::GLSL)
 169                 info_log = static_cast<const GlslModule *>(module)->get_source_map().translate_errors(info_log);
 170
 171         if(!compiled)
 172                 throw compile_error(info_log);
 173 #ifdef DEBUG
 174         if(!info_log.empty())
 175                 IO::print("Shader compile info log:\n%s", info_log);
 176 #endif
 177 }
 178
 179 #pragma GCC diagnostic push
 180 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 181 void Program::attach_shader(Shader &shader)
 182 {
 183         unsigned shader_id = shader.steal_id();
 184         if(!shader_id)
 185                 throw invalid_argument("Program::attach_shader");
 186         stage_ids.push_back(shader_id);
 187         compile_glsl_stage(shader_id);
 188 }
 189
 190 void Program::attach_shader_owned(Shader *shader)
 191 {
 192         attach_shader(*shader);
 193         delete shader;
 194 }
 195
 196 void Program::detach_shader(Shader &)
 197 {
 198 }
 199
 200 const vector<Shader *> &Program::get_attached_shaders() const
 201 {
 202         static vector<Shader *> dummy;
 203         return dummy;
 204 }
 205
 206 void Program::bind_attribute(unsigned index, const string &name)
 207 {
 208         static Require _req(ARB_vertex_shader);
 209         glBindAttribLocation(id, index, name.c_str());
 210 }
 211
 212 void Program::bind_attribute(VertexAttribute attr, const string &name)
 213 {
 214         bind_attribute(get_attribute_semantic(attr), name);
 215 }
 216
 217 void Program::bind_fragment_data(unsigned index, const string &name)
 218 {
 219         static Require _req(EXT_gpu_shader4);
 220         glBindFragDataLocation(id, index, name.c_str());
 221 }
 222 #pragma GCC diagnostic pop
 223
 224 void Program::link()
 225 {
 226         if(stage_ids.empty())
 227                 throw invalid_operation("Program::link");
 228
 229         uniforms.clear();
 230
 231         glLinkProgram(id);
 232         linked = get_program_i(id, GL_LINK_STATUS);
 233
 234         GLsizei info_log_len = get_program_i(id, GL_INFO_LOG_LENGTH);
 235         string info_log(info_log_len+1, 0);
 236         glGetProgramInfoLog(id, info_log_len+1, &info_log_len, &info_log[0]);
 237         info_log.erase(info_log_len);
 238         if(module && module->get_format()==Module::GLSL)
 239                 info_log = static_cast<const GlslModule *>(module)->get_source_map().translate_errors(info_log);
 240
 241         if(!linked)
 242                 throw compile_error(info_log);
 243 #ifdef DEBUG
 244         if(!info_log.empty())
 245                 IO::print("Program link info log:\n%s", info_log);
 246 #endif
 247
 248         query_uniforms();
 249         query_attributes();
 250
 251         for(UniformMap::const_iterator i=uniforms.begin(); i!=uniforms.end(); ++i)
 252                 require_type(i->second.type);
 253         for(AttributeMap::const_iterator i=attributes.begin(); i!=attributes.end(); ++i)
 254                 require_type(i->second.type);
 255 }
 256
 257 void Program::query_uniforms()
 258 {
 259         unsigned count = get_program_i(id, GL_ACTIVE_UNIFORMS);
 260         vector<UniformInfo *> uniforms_by_index(count);
 261         for(unsigned i=0; i<count; ++i)
 262         {
 263                 char name[128];
 264                 int len = 0;
 265                 int size;
 266                 GLenum type;
 267                 glGetActiveUniform(id, i, sizeof(name), &len, &size, &type, name);
 268                 if(len && strncmp(name, "gl_", 3))
 269                 {
 270                         /* Some implementations report the first element of a uniform array,
 271                         others report just the name of the array itself. */
 272                         if(len>3 && !strcmp(name+len-3, "[0]"))
 273                                 name[len-3] = 0;
 274
 275                         UniformInfo &info = uniforms[name];
 276                         info.block = 0;
 277                         info.name = name;
 278                         info.array_size = size;
 279                         info.array_stride = 0;
 280                         info.matrix_stride = 0;
 281                         info.type = from_gl_type(type);
 282                         uniforms_by_index[i] = &info;
 283                 }
 284         }
 285
 286         if(ARB_uniform_buffer_object)
 287                 query_uniform_blocks(uniforms_by_index);
 288
 289         UniformBlockInfo &default_block = uniform_blocks[string()];
 290         default_block.data_size = 0;
 291         default_block.bind_point = -1;
 292
 293         for(UniformMap::iterator i=uniforms.begin(); i!=uniforms.end(); ++i)
 294                 if(!i->second.block)
 295                 {
 296                         i->second.location = glGetUniformLocation(id, i->second.name.c_str());
 297                         i->second.block = &default_block;
 298                         default_block.uniforms.push_back(&i->second);
 299                 }
 300
 301         default_block.layout_hash = compute_layout_hash(default_block.uniforms);
 302
 303         string layout_descriptor;
 304         for(UniformBlockMap::const_iterator i=uniform_blocks.begin(); i!=uniform_blocks.end(); ++i)
 305                 layout_descriptor += format("%d:%x\n", i->second.bind_point, i->second.layout_hash);
 306         uniform_layout_hash = hash32(layout_descriptor);
 307 }
 308
 309 void Program::query_uniform_blocks(const vector<UniformInfo *> &uniforms_by_index)
 310 {
 311         uniform_blocks.clear();
 312
 313         std::set<unsigned> used_bind_points;
 314         unsigned count = get_program_i(id, GL_ACTIVE_UNIFORM_BLOCKS);
 315         for(unsigned i=0; i<count; ++i)
 316         {
 317                 char name[128];
 318                 int len;
 319                 glGetActiveUniformBlockName(id, i, sizeof(name), &len, name);
 320                 UniformBlockInfo &info = uniform_blocks[name];
 321                 info.name = name;
 322
 323                 int value;
 324                 glGetActiveUniformBlockiv(id, i, GL_UNIFORM_BLOCK_DATA_SIZE, &value);
 325                 info.data_size = value;
 326
 327                 glGetActiveUniformBlockiv(id, i, GL_UNIFORM_BLOCK_ACTIVE_UNIFORMS, &value);
 328                 vector<int> indices(value);
 329                 glGetActiveUniformBlockiv(id, i, GL_UNIFORM_BLOCK_ACTIVE_UNIFORM_INDICES, &indices[0]);
 330                 for(vector<int>::iterator j=indices.begin(); j!=indices.end(); ++j)
 331                 {
 332                         if(!uniforms_by_index[*j])
 333                                 throw logic_error("Program::link");
 334                         info.uniforms.push_back(uniforms_by_index[*j]);
 335                         uniforms_by_index[*j]->block = &info;
 336                 }
 337
 338                 vector<unsigned> indices2(indices.begin(), indices.end());
 339                 vector<int> values(indices.size());
 340                 glGetActiveUniformsiv(id, indices.size(), &indices2[0], GL_UNIFORM_OFFSET, &values[0]);
 341                 for(unsigned j=0; j<indices.size(); ++j)
 342                         uniforms_by_index[indices[j]]->location = values[j];
 343
 344                 indices2.clear();
 345                 for(vector<int>::iterator j=indices.begin(); j!=indices.end(); ++j)
 346                         if(uniforms_by_index[*j]->array_size>1)
 347                                 indices2.push_back(*j);
 348                 if(!indices2.empty())
 349                 {
 350                         glGetActiveUniformsiv(id, indices2.size(), &indices2[0], GL_UNIFORM_ARRAY_STRIDE, &values[0]);
 351                         for(unsigned j=0; j<indices2.size(); ++j)
 352                                 uniforms_by_index[indices2[j]]->array_stride = values[j];
 353                 }
 354
 355                 indices2.clear();
 356                 for(vector<int>::iterator j=indices.begin(); j!=indices.end(); ++j)
 357                 {
 358                         DataType t = uniforms_by_index[*j]->type;
 359                         if(is_matrix(t))
 360                                 indices2.push_back(*j);
 361                 }
 362                 if(!indices2.empty())
 363                 {
 364                         glGetActiveUniformsiv(id, indices2.size(), &indices2[0], GL_UNIFORM_MATRIX_STRIDE, &values[0]);
 365                         for(unsigned j=0; j<indices2.size(); ++j)
 366                                 uniforms_by_index[indices2[j]]->matrix_stride = values[j];
 367                 }
 368
 369                 sort(info.uniforms.begin(), info.uniforms.end(), uniform_location_compare);
 370                 info.layout_hash = compute_layout_hash(info.uniforms);
 371                 unsigned n_bindings = BufferRange::get_n_uniform_buffer_bindings();
 372                 info.bind_point = info.layout_hash%n_bindings;
 373                 while(used_bind_points.count(info.bind_point))
 374                         info.bind_point = (info.bind_point+1)%n_bindings;
 375                 glUniformBlockBinding(id, i, info.bind_point);
 376                 used_bind_points.insert(info.bind_point);
 377         }
 378 }
 379
 380 void Program::query_attributes()
 381 {
 382         unsigned count = get_program_i(id, GL_ACTIVE_ATTRIBUTES);
 383         for(unsigned i=0; i<count; ++i)
 384         {
 385                 char name[128];
 386                 int len = 0;
 387                 int size;
 388                 GLenum type;
 389                 glGetActiveAttrib(id, i, sizeof(name), &len, &size, &type, name);
 390                 if(len && strncmp(name, "gl_", 3))
 391                 {
 392                         if(len>3 && !strcmp(name+len-3, "[0]"))
 393                                 name[len-3] = 0;
 394
 395                         AttributeInfo &info = attributes[name];
 396                         info.name = name;
 397                         info.location = glGetAttribLocation(id, name);
 398                         info.array_size = size;
 399                         info.type = from_gl_type(type);
 400                 }
 401         }
 402 }
 403
 404 Program::LayoutHash Program::compute_layout_hash(const vector<const UniformInfo *> &uniforms)
 405 {
 406         string layout_descriptor;
 407         for(vector<const UniformInfo *>::const_iterator i = uniforms.begin(); i!=uniforms.end(); ++i)
 408                 layout_descriptor += format("%d:%s:%x:%d\n", (*i)->location, (*i)->name, (*i)->type, (*i)->array_size);
 409         return hash32(layout_descriptor);
 410 }
 411
 412 bool Program::uniform_location_compare(const UniformInfo *uni1, const UniformInfo *uni2)
 413 {
 414         return uni1->location<uni2->location;
 415 }
 416
 417 string Program::get_info_log() const
 418 {
 419         GLsizei len = get_program_i(id, GL_INFO_LOG_LENGTH);
 420         string log(len+1, 0);
 421         glGetProgramInfoLog(id, len+1, &len, &log[0]);
 422         log.erase(len);
 423         return log;
 424 }
 425
 426 const Program::UniformBlockInfo &Program::get_uniform_block_info(const string &name) const
 427 {
 428         return get_item(uniform_blocks, name);
 429 }
 430
 431 const Program::UniformInfo &Program::get_uniform_info(const string &name) const
 432 {
 433         return get_item(uniforms, name);
 434 }
 435
 436 int Program::get_uniform_location(const string &n) const
 437 {
 438         if(n[n.size()-1]==']')
 439                 throw invalid_argument("Program::get_uniform_location");
 440
 441         UniformMap::const_iterator i = uniforms.find(n);
 442         if(i==uniforms.end())
 443                 return -1;
 444
 445         return i->second.block->bind_point<0 ? i->second.location : -1;
 446 }
 447
 448 const Program::AttributeInfo &Program::get_attribute_info(const string &name) const
 449 {
 450         return get_item(attributes, name);
 451 }
 452
 453 int Program::get_attribute_location(const string &n) const
 454 {
 455         if(n[n.size()-1]==']')
 456                 throw invalid_argument("Program::get_attribute_location");
 457
 458         AttributeMap::const_iterator i = attributes.find(n);
 459         return i!=attributes.end() ? i->second.location : -1;
 460 }
 461
 462 void Program::bind() const
 463 {
 464         if(!linked)
 465                 throw invalid_operation("Program::bind");
 466
 467         if(!set_current(this))
 468                 return;
 469
 470         glUseProgram(id);
 471 }
 472
 473 void Program::unbind()
 474 {
 475         if(!set_current(0))
 476                 return;
 477
 478         glUseProgram(0);
 479 }
 480
 481
 482 Program::Loader::Loader(Program &p, Collection &c):
 483         DataFile::CollectionObjectLoader<Program>(p, &c)
 484 {
 485         add("module",          &Loader::module);
 486
 487         // Deprecated
 488         add("attribute",       &Loader::attribute);
 489         add("fragment_shader", &Loader::fragment_shader);
 490         add("geometry_shader", &Loader::geometry_shader);
 491         add("vertex_shader",   &Loader::vertex_shader);
 492 }
 493
 494 void Program::Loader::finish()
 495 {
 496         obj.link();
 497 }
 498
 499 void Program::Loader::module(const string &n)
 500 {
 501         map<string, int> spec_values;
 502         SpecializationLoader ldr(spec_values);
 503         load_sub_with(ldr);
 504         obj.add_stages(get_collection().get<Module>(n), spec_values);
 505 }
 506
 507 #pragma GCC diagnostic push
 508 #pragma GCC diagnostic ignored "-Wdeprecated-declarations"
 509 void Program::Loader::attribute(unsigned i, const string &n)
 510 {
 511         obj.bind_attribute(i, n);
 512 }
 513
 514 void Program::Loader::fragment_shader(const string &src)
 515 {
 516         obj.attach_shader_owned(new FragmentShader(src));
 517 }
 518
 519 void Program::Loader::geometry_shader(const string &src)
 520 {
 521         obj.attach_shader_owned(new GeometryShader(src));
 522 }
 523
 524 void Program::Loader::vertex_shader(const string &src)
 525 {
 526         obj.attach_shader_owned(new VertexShader(src));
 527 }
 528 #pragma GCC diagnostic pop
 529
 530
 531 DataFile::Loader::ActionMap Program::SpecializationLoader::shared_actions;
 532
 533 Program::SpecializationLoader::SpecializationLoader(map<string, int> &sv):
 534         spec_values(sv)
 535 {
 536         set_actions(shared_actions);
 537 }
 538
 539 void Program::SpecializationLoader::init_actions()
 540 {
 541         add("specialize", &SpecializationLoader::specialize_bool);
 542         add("specialize", &SpecializationLoader::specialize_int);
 543 }
 544
 545 void Program::SpecializationLoader::specialize_bool(const string &name, bool value)
 546 {
 547         spec_values[name] = value;
 548 }
 549
 550 void Program::SpecializationLoader::specialize_int(const string &name, int value)
 551 {
 552         spec_values[name] = value;
 553 }
 554
 555 } // namespace GL
 556 } // namespace Msp