git.sesse.net Git - movit/blob - resource_pool.cpp

   1 #include <assert.h>
   2 #include <pthread.h>
   3 #include <stdio.h>
   4 #include <stdlib.h>
   5 #include <algorithm>
   6 #include <map>
   7 #include <string>
   8 #include <utility>
   9 #include <epoxy/gl.h>
  10
  11 #include "init.h"
  12 #include "resource_pool.h"
  13 #include "util.h"
  14
  15 using namespace std;
  16
  17 namespace movit {
  18
  19 ResourcePool::ResourcePool(size_t program_freelist_max_length,
  20                            size_t texture_freelist_max_bytes,
  21                            size_t fbo_freelist_max_length)
  22         : program_freelist_max_length(program_freelist_max_length),
  23           texture_freelist_max_bytes(texture_freelist_max_bytes),
  24           fbo_freelist_max_length(fbo_freelist_max_length),
  25           texture_freelist_bytes(0)
  26 {
  27         pthread_mutex_init(&lock, NULL);
  28 }
  29
  30 ResourcePool::~ResourcePool()
  31 {
  32         assert(program_refcount.empty());
  33
  34         for (list<GLuint>::const_iterator freelist_it = program_freelist.begin();
  35              freelist_it != program_freelist.end();
  36              ++freelist_it) {
  37                 delete_program(*freelist_it);
  38         }
  39         assert(programs.empty());
  40         assert(program_shaders.empty());
  41
  42         for (list<GLuint>::const_iterator freelist_it = texture_freelist.begin();
  43              freelist_it != texture_freelist.end();
  44              ++freelist_it) {
  45                 GLuint free_texture_num = *freelist_it;
  46                 assert(texture_formats.count(free_texture_num) != 0);
  47                 texture_freelist_bytes -= estimate_texture_size(texture_formats[free_texture_num]);
  48                 texture_formats.erase(free_texture_num);
  49                 glDeleteTextures(1, &free_texture_num);
  50                 check_error();
  51         }
  52         assert(texture_formats.empty());
  53         assert(texture_freelist_bytes == 0);
  54
  55         void *context = get_gl_context_identifier();
  56         cleanup_unlinked_fbos(context);
  57
  58         for (map<void *, std::list<GLuint> >::iterator context_it = fbo_freelist.begin();
  59              context_it != fbo_freelist.end();
  60              ++context_it) {
  61                 if (context_it->first != context) {
  62                         // If this does not hold, the client should have called clean_context() earlier.
  63                         assert(context_it->second.empty());
  64                         continue;
  65                 }
  66                 for (list<GLuint>::const_iterator freelist_it = context_it->second.begin();
  67                      freelist_it != context_it->second.end();
  68                      ++freelist_it) {
  69                         pair<void *, GLuint> key(context, *freelist_it);
  70                         GLuint free_fbo_num = *freelist_it;
  71                         assert(fbo_formats.count(key) != 0);
  72                         fbo_formats.erase(key);
  73                         glDeleteFramebuffers(1, &free_fbo_num);
  74                         check_error();
  75                 }
  76         }
  77
  78         assert(fbo_formats.empty());
  79 }
  80
  81 void ResourcePool::delete_program(GLuint glsl_program_num)
  82 {
  83         bool found_program = false;
  84         for (map<pair<string, string>, GLuint>::iterator program_it = programs.begin();
  85              program_it != programs.end();
  86              ++program_it) {
  87                 if (program_it->second == glsl_program_num) {
  88                         programs.erase(program_it);
  89                         found_program = true;
  90                         break;
  91                 }
  92         }
  93         assert(found_program);
  94         glDeleteProgram(glsl_program_num);
  95
  96         map<GLuint, pair<GLuint, GLuint> >::iterator shader_it =
  97                 program_shaders.find(glsl_program_num);
  98         assert(shader_it != program_shaders.end());
  99
 100         glDeleteShader(shader_it->second.first);
 101         glDeleteShader(shader_it->second.second);
 102         program_shaders.erase(shader_it);
 103 }
 104
 105 GLuint ResourcePool::compile_glsl_program(const string& vertex_shader, const string& fragment_shader)
 106 {
 107         GLuint glsl_program_num;
 108         pthread_mutex_lock(&lock);
 109         const pair<string, string> key(vertex_shader, fragment_shader);
 110         if (programs.count(key)) {
 111                 // Already in the cache. Increment the refcount, or take it off the freelist
 112                 // if it's zero.
 113                 glsl_program_num = programs[key];
 114                 map<GLuint, int>::iterator refcount_it = program_refcount.find(glsl_program_num);
 115                 if (refcount_it != program_refcount.end()) {
 116                         ++refcount_it->second;
 117                 } else {
 118                         list<GLuint>::iterator freelist_it =
 119                                 find(program_freelist.begin(), program_freelist.end(), glsl_program_num);
 120                         assert(freelist_it != program_freelist.end());
 121                         program_freelist.erase(freelist_it);
 122                         program_refcount.insert(make_pair(glsl_program_num, 1));
 123                 }
 124         } else {
 125                 // Not in the cache. Compile the shaders.
 126                 glsl_program_num = glCreateProgram();
 127                 check_error();
 128                 GLuint vs_obj = compile_shader(vertex_shader, GL_VERTEX_SHADER);
 129                 check_error();
 130                 GLuint fs_obj = compile_shader(fragment_shader, GL_FRAGMENT_SHADER);
 131                 check_error();
 132                 glAttachShader(glsl_program_num, vs_obj);
 133                 check_error();
 134                 glAttachShader(glsl_program_num, fs_obj);
 135                 check_error();
 136                 glLinkProgram(glsl_program_num);
 137                 check_error();
 138
 139                 GLint success;
 140                 glGetProgramiv(glsl_program_num, GL_LINK_STATUS, &success);
 141                 if (success == GL_FALSE) {
 142                         GLchar error_log[1024] = {0};
 143                         glGetProgramInfoLog(glsl_program_num, 1024, NULL, error_log);
 144                         fprintf(stderr, "Error linking program: %s\n", error_log);
 145                         exit(1);
 146                 }
 147
 148                 if (movit_debug_level == MOVIT_DEBUG_ON) {
 149                         // Output shader to a temporary file, for easier debugging.
 150                         static int compiled_shader_num = 0;
 151                         char filename[256];
 152                         sprintf(filename, "chain-%03d.frag", compiled_shader_num++);
 153                         FILE *fp = fopen(filename, "w");
 154                         if (fp == NULL) {
 155                                 perror(filename);
 156                                 exit(1);
 157                         }
 158                         fprintf(fp, "%s\n", fragment_shader.c_str());
 159                         fclose(fp);
 160                 }
 161
 162                 programs.insert(make_pair(key, glsl_program_num));
 163                 program_refcount.insert(make_pair(glsl_program_num, 1));
 164                 program_shaders.insert(make_pair(glsl_program_num, make_pair(vs_obj, fs_obj)));
 165         }
 166         pthread_mutex_unlock(&lock);
 167         return glsl_program_num;
 168 }
 169
 170 void ResourcePool::release_glsl_program(GLuint glsl_program_num)
 171 {
 172         pthread_mutex_lock(&lock);
 173         map<GLuint, int>::iterator refcount_it = program_refcount.find(glsl_program_num);
 174         assert(refcount_it != program_refcount.end());
 175
 176         if (--refcount_it->second == 0) {
 177                 program_refcount.erase(refcount_it);
 178                 assert(find(program_freelist.begin(), program_freelist.end(), glsl_program_num)
 179                         == program_freelist.end());
 180                 program_freelist.push_front(glsl_program_num);
 181                 if (program_freelist.size() > program_freelist_max_length) {
 182                         delete_program(program_freelist.back());
 183                         program_freelist.pop_back();
 184                 }
 185         }
 186
 187         pthread_mutex_unlock(&lock);
 188 }
 189
 190 GLuint ResourcePool::create_2d_texture(GLint internal_format, GLsizei width, GLsizei height)
 191 {
 192         assert(width > 0);
 193         assert(height > 0);
 194
 195         pthread_mutex_lock(&lock);
 196         // See if there's a texture on the freelist we can use.
 197         for (list<GLuint>::iterator freelist_it = texture_freelist.begin();
 198              freelist_it != texture_freelist.end();
 199              ++freelist_it) {
 200                 GLuint texture_num = *freelist_it;
 201                 map<GLuint, Texture2D>::const_iterator format_it = texture_formats.find(texture_num);
 202                 assert(format_it != texture_formats.end());
 203                 if (format_it->second.internal_format == internal_format &&
 204                     format_it->second.width == width &&
 205                     format_it->second.height == height) {
 206                         texture_freelist_bytes -= estimate_texture_size(format_it->second);
 207                         texture_freelist.erase(freelist_it);
 208                         pthread_mutex_unlock(&lock);
 209                         return texture_num;
 210                 }
 211         }
 212
 213         // Find any reasonable format given the internal format; OpenGL validates it
 214         // even though we give NULL as pointer.
 215         GLenum format;
 216         switch (internal_format) {
 217         case GL_RGBA32F_ARB:
 218         case GL_RGBA16F_ARB:
 219         case GL_RGBA8:
 220         case GL_SRGB8_ALPHA8:
 221                 format = GL_RGBA;
 222                 break;
 223         case GL_RGB32F:
 224         case GL_RGB16F:
 225         case GL_RGB8:
 226         case GL_SRGB8:
 227                 format = GL_RGB;
 228                 break;
 229         case GL_RG32F:
 230         case GL_RG16F:
 231         case GL_RG8:
 232                 format = GL_RG;
 233                 break;
 234         case GL_R32F:
 235         case GL_R16F:
 236         case GL_R8:
 237                 format = GL_RED;
 238                 break;
 239         default:
 240                 // TODO: Add more here as needed.
 241                 assert(false);
 242         }
 243
 244         // Same with type; GLES is stricter than desktop OpenGL here.
 245         GLenum type;
 246         switch (internal_format) {
 247         case GL_RGBA32F_ARB:
 248         case GL_RGBA16F_ARB:
 249         case GL_RGB32F:
 250         case GL_RGB16F:
 251         case GL_RG32F:
 252         case GL_RG16F:
 253         case GL_R32F:
 254         case GL_R16F:
 255                 type = GL_FLOAT;
 256                 break;
 257         case GL_SRGB8_ALPHA8:
 258         case GL_SRGB8:
 259         case GL_RGBA8:
 260         case GL_RGB8:
 261         case GL_RG8:
 262         case GL_R8:
 263                 type = GL_UNSIGNED_BYTE;
 264                 break;
 265         default:
 266                 // TODO: Add more here as needed.
 267                 assert(false);
 268         }
 269
 270
 271         GLuint texture_num;
 272         glGenTextures(1, &texture_num);
 273         check_error();
 274         glBindTexture(GL_TEXTURE_2D, texture_num);
 275         check_error();
 276         glTexImage2D(GL_TEXTURE_2D, 0, internal_format, width, height, 0, format, type, NULL);
 277         check_error();
 278         glBindTexture(GL_TEXTURE_2D, 0);
 279         check_error();
 280
 281         Texture2D texture_format;
 282         texture_format.internal_format = internal_format;
 283         texture_format.width = width;
 284         texture_format.height = height;
 285         assert(texture_formats.count(texture_num) == 0);
 286         texture_formats.insert(make_pair(texture_num, texture_format));
 287
 288         pthread_mutex_unlock(&lock);
 289         return texture_num;
 290 }
 291
 292 void ResourcePool::release_2d_texture(GLuint texture_num)
 293 {
 294         pthread_mutex_lock(&lock);
 295         texture_freelist.push_front(texture_num);
 296         assert(texture_formats.count(texture_num) != 0);
 297         texture_freelist_bytes += estimate_texture_size(texture_formats[texture_num]);
 298
 299         while (texture_freelist_bytes > texture_freelist_max_bytes) {
 300                 GLuint free_texture_num = texture_freelist.back();
 301                 texture_freelist.pop_back();
 302                 assert(texture_formats.count(free_texture_num) != 0);
 303                 texture_freelist_bytes -= estimate_texture_size(texture_formats[free_texture_num]);
 304                 texture_formats.erase(free_texture_num);
 305                 glDeleteTextures(1, &free_texture_num);
 306                 check_error();
 307
 308                 // Unlink any lingering FBO related to this texture. We might
 309                 // not be in the right context, so don't delete it right away;
 310                 // the cleanup in release_fbo() (which calls cleanup_unlinked_fbos())
 311                 // will take care of actually doing that later.
 312                 for (map<pair<void *, GLuint>, FBO>::iterator format_it = fbo_formats.begin();
 313                      format_it != fbo_formats.end();
 314                      ++format_it) {
 315                         for (unsigned i = 0; i < num_fbo_attachments; ++i) {
 316                                 if (format_it->second.texture_num[i] == free_texture_num) {
 317                                         format_it->second.texture_num[i] = GL_INVALID_INDEX;
 318                                 }
 319                         }
 320                 }
 321         }
 322         pthread_mutex_unlock(&lock);
 323 }
 324
 325 GLuint ResourcePool::create_fbo(GLuint texture0_num, GLuint texture1_num, GLuint texture2_num, GLuint texture3_num)
 326 {
 327         void *context = get_gl_context_identifier();
 328
 329         // Make sure we are filled from the bottom.
 330         assert(texture0_num != 0);
 331         if (texture1_num == 0) {
 332                 assert(texture2_num == 0);
 333         }
 334         if (texture2_num == 0) {
 335                 assert(texture3_num == 0);
 336         }
 337
 338         pthread_mutex_lock(&lock);
 339         if (fbo_freelist.count(context) != 0) {
 340                 // See if there's an FBO on the freelist we can use.
 341                 for (list<GLuint>::iterator freelist_it = fbo_freelist[context].begin();
 342                      freelist_it != fbo_freelist[context].end();
 343                      ++freelist_it) {
 344                         GLuint fbo_num = *freelist_it;
 345                         map<pair<void *, GLuint>, FBO>::const_iterator format_it =
 346                                 fbo_formats.find(make_pair(context, fbo_num));
 347                         assert(format_it != fbo_formats.end());
 348                         if (format_it->second.texture_num[0] == texture0_num &&
 349                             format_it->second.texture_num[1] == texture1_num &&
 350                             format_it->second.texture_num[2] == texture2_num &&
 351                             format_it->second.texture_num[3] == texture3_num) {
 352                                 fbo_freelist[context].erase(freelist_it);
 353                                 pthread_mutex_unlock(&lock);
 354                                 return fbo_num;
 355                         }
 356                 }
 357         }
 358
 359         // Create a new one.
 360         FBO fbo_format;
 361         fbo_format.texture_num[0] = texture0_num;
 362         fbo_format.texture_num[1] = texture1_num;
 363         fbo_format.texture_num[2] = texture2_num;
 364         fbo_format.texture_num[3] = texture3_num;
 365
 366         GLuint fbo_num;
 367         glGenFramebuffers(1, &fbo_num);
 368         check_error();
 369         glBindFramebuffer(GL_FRAMEBUFFER, fbo_num);
 370         check_error();
 371
 372         GLenum bufs[num_fbo_attachments];
 373         unsigned num_active_attachments = 0;
 374         for (unsigned i = 0; i < num_fbo_attachments; ++i, ++num_active_attachments) {
 375                 if (fbo_format.texture_num[i] == 0) {
 376                         break;
 377                 }
 378                 glFramebufferTexture2D(
 379                         GL_FRAMEBUFFER,
 380                         GL_COLOR_ATTACHMENT0 + i,
 381                         GL_TEXTURE_2D,
 382                         fbo_format.texture_num[i],
 383                         0);
 384                 check_error();
 385                 bufs[i] = GL_COLOR_ATTACHMENT0 + i;
 386         }
 387
 388         glDrawBuffers(num_active_attachments, bufs);
 389         check_error();
 390
 391         GLenum status = glCheckFramebufferStatusEXT(GL_FRAMEBUFFER_EXT);
 392         assert(status == GL_FRAMEBUFFER_COMPLETE);
 393         glBindFramebuffer(GL_FRAMEBUFFER, 0);
 394         check_error();
 395
 396         pair<void *, GLuint> key(context, fbo_num);
 397         assert(fbo_formats.count(key) == 0);
 398         fbo_formats.insert(make_pair(key, fbo_format));
 399
 400         pthread_mutex_unlock(&lock);
 401         return fbo_num;
 402 }
 403
 404 void ResourcePool::release_fbo(GLuint fbo_num)
 405 {
 406         void *context = get_gl_context_identifier();
 407
 408         pthread_mutex_lock(&lock);
 409         fbo_freelist[context].push_front(fbo_num);
 410         assert(fbo_formats.count(make_pair(context, fbo_num)) != 0);
 411
 412         // Now that we're in this context, free up any FBOs that are connected
 413         // to deleted textures (in release_2d_texture).
 414         cleanup_unlinked_fbos(context);
 415
 416         shrink_fbo_freelist(context, fbo_freelist_max_length);
 417         pthread_mutex_unlock(&lock);
 418 }
 419
 420 void ResourcePool::clean_context()
 421 {
 422         void *context = get_gl_context_identifier();
 423
 424         // Currently, we only need to worry about FBOs, as they are the only
 425         // non-shareable resource we hold.
 426         shrink_fbo_freelist(context, 0);
 427         fbo_freelist.erase(context);
 428 }
 429
 430 void ResourcePool::cleanup_unlinked_fbos(void *context)
 431 {
 432         for (list<GLuint>::iterator freelist_it = fbo_freelist[context].begin();
 433              freelist_it != fbo_freelist[context].end(); ) {
 434                 GLuint fbo_num = *freelist_it;
 435                 pair<void *, GLuint> key(context, fbo_num);
 436                 assert(fbo_formats.count(key) != 0);
 437
 438                 bool all_unlinked = true;
 439                 for (unsigned i = 0; i < num_fbo_attachments; ++i) {
 440                         if (fbo_formats[key].texture_num[i] != 0 &&
 441                             fbo_formats[key].texture_num[i] != GL_INVALID_INDEX) {
 442                                 all_unlinked = false;
 443                                 break;
 444                         }
 445                 }
 446                 if (all_unlinked) {
 447                         fbo_formats.erase(key);
 448                         glDeleteFramebuffers(1, &fbo_num);
 449                         check_error();
 450                         fbo_freelist[context].erase(freelist_it++);
 451                 } else {
 452                         freelist_it++;
 453                 }
 454         }
 455 }
 456
 457 void ResourcePool::shrink_fbo_freelist(void *context, size_t max_length)
 458 {
 459         while (fbo_freelist[context].size() > max_length) {
 460                 GLuint free_fbo_num = fbo_freelist[context].back();
 461                 pair<void *, GLuint> key(context, free_fbo_num);
 462                 fbo_freelist[context].pop_back();
 463                 assert(fbo_formats.count(key) != 0);
 464                 fbo_formats.erase(key);
 465                 glDeleteFramebuffers(1, &free_fbo_num);
 466                 check_error();
 467         }
 468 }
 469
 470 size_t ResourcePool::estimate_texture_size(const Texture2D &texture_format)
 471 {
 472         size_t bytes_per_pixel;
 473
 474         switch (texture_format.internal_format) {
 475         case GL_RGBA32F_ARB:
 476                 bytes_per_pixel = 16;
 477                 break;
 478         case GL_RGBA16F_ARB:
 479                 bytes_per_pixel = 8;
 480                 break;
 481         case GL_RGB32F_ARB:
 482                 bytes_per_pixel = 12;
 483                 break;
 484         case GL_RGB16F_ARB:
 485                 bytes_per_pixel = 6;
 486                 break;
 487         case GL_RGBA8:
 488         case GL_SRGB8_ALPHA8:
 489                 bytes_per_pixel = 4;
 490                 break;
 491         case GL_RGB8:
 492         case GL_SRGB8:
 493                 bytes_per_pixel = 3;
 494                 break;
 495         case GL_RG32F:
 496                 bytes_per_pixel = 8;
 497                 break;
 498         case GL_RG16F:
 499                 bytes_per_pixel = 4;
 500                 break;
 501         case GL_R32F:
 502                 bytes_per_pixel = 4;
 503                 break;
 504         case GL_R16F:
 505                 bytes_per_pixel = 2;
 506                 break;
 507         case GL_RG8:
 508                 bytes_per_pixel = 2;
 509                 break;
 510         case GL_R8:
 511                 bytes_per_pixel = 1;
 512                 break;
 513         default:
 514                 // TODO: Add more here as needed.
 515                 assert(false);
 516         }
 517
 518         return texture_format.width * texture_format.height * bytes_per_pixel;
 519 }
 520
 521 }  // namespace movit