Fix a tiny leak (that would cause an assertion failure on exit).
[movit] / 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
10 #include "glew.h"
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         for (list<GLuint>::const_iterator freelist_it = fbo_freelist.begin();
56              freelist_it != fbo_freelist.end();
57              ++freelist_it) {
58                 GLuint free_fbo_num = *freelist_it;
59                 assert(fbo_formats.count(free_fbo_num) != 0);
60                 fbo_formats.erase(free_fbo_num);
61                 glDeleteFramebuffers(1, &free_fbo_num);
62                 check_error();
63         }
64         assert(fbo_formats.empty());
65 }
66
67 void ResourcePool::delete_program(GLuint glsl_program_num)
68 {
69         bool found_program = false;
70         for (map<pair<string, string>, GLuint>::iterator program_it = programs.begin();
71              program_it != programs.end();
72              ++program_it) {
73                 if (program_it->second == glsl_program_num) {
74                         programs.erase(program_it);
75                         found_program = true;
76                         break;
77                 }
78         }
79         assert(found_program);
80         glDeleteProgram(glsl_program_num);
81
82         map<GLuint, pair<GLuint, GLuint> >::iterator shader_it =
83                 program_shaders.find(glsl_program_num);
84         assert(shader_it != program_shaders.end());
85
86         glDeleteShader(shader_it->second.first);
87         glDeleteShader(shader_it->second.second);
88         program_shaders.erase(shader_it);
89 }
90
91 GLuint ResourcePool::compile_glsl_program(const string& vertex_shader, const string& fragment_shader)
92 {
93         GLuint glsl_program_num;
94         pthread_mutex_lock(&lock);
95         const pair<string, string> key(vertex_shader, fragment_shader);
96         if (programs.count(key)) {
97                 // Already in the cache. Increment the refcount, or take it off the freelist
98                 // if it's zero.
99                 glsl_program_num = programs[key];
100                 map<GLuint, int>::iterator refcount_it = program_refcount.find(glsl_program_num);
101                 if (refcount_it != program_refcount.end()) {
102                         ++refcount_it->second;
103                 } else {
104                         list<GLuint>::iterator freelist_it =
105                                 find(program_freelist.begin(), program_freelist.end(), glsl_program_num);
106                         assert(freelist_it != program_freelist.end());
107                         program_freelist.erase(freelist_it);
108                         program_refcount.insert(make_pair(glsl_program_num, 1));
109                 }
110         } else {
111                 // Not in the cache. Compile the shaders.
112                 glsl_program_num = glCreateProgram();
113                 GLuint vs_obj = compile_shader(vertex_shader, GL_VERTEX_SHADER);
114                 GLuint fs_obj = compile_shader(fragment_shader, GL_FRAGMENT_SHADER);
115                 glAttachShader(glsl_program_num, vs_obj);
116                 check_error();
117                 glAttachShader(glsl_program_num, fs_obj);
118                 check_error();
119                 glLinkProgram(glsl_program_num);
120                 check_error();
121
122                 GLint success;
123                 glGetProgramiv(glsl_program_num, GL_LINK_STATUS, &success);
124                 if (success == GL_FALSE) {
125                         GLchar error_log[1024] = {0};
126                         glGetProgramInfoLog(glsl_program_num, 1024, NULL, error_log);
127                         fprintf(stderr, "Error linking program: %s\n", error_log);
128                         exit(1);
129                 }
130
131                 if (movit_debug_level == MOVIT_DEBUG_ON) {
132                         // Output shader to a temporary file, for easier debugging.
133                         static int compiled_shader_num = 0;
134                         char filename[256];
135                         sprintf(filename, "chain-%03d.frag", compiled_shader_num++);
136                         FILE *fp = fopen(filename, "w");
137                         if (fp == NULL) {
138                                 perror(filename);
139                                 exit(1);
140                         }
141                         fprintf(fp, "%s\n", fragment_shader.c_str());
142                         fclose(fp);
143                 }
144
145                 programs.insert(make_pair(key, glsl_program_num));
146                 program_refcount.insert(make_pair(glsl_program_num, 1));
147                 program_shaders.insert(make_pair(glsl_program_num, make_pair(vs_obj, fs_obj)));
148         }
149         pthread_mutex_unlock(&lock);
150         return glsl_program_num;
151 }
152
153 void ResourcePool::release_glsl_program(GLuint glsl_program_num)
154 {
155         pthread_mutex_lock(&lock);
156         map<GLuint, int>::iterator refcount_it = program_refcount.find(glsl_program_num);
157         assert(refcount_it != program_refcount.end());
158
159         if (--refcount_it->second == 0) {
160                 program_refcount.erase(refcount_it);
161                 assert(find(program_freelist.begin(), program_freelist.end(), glsl_program_num)
162                         == program_freelist.end());
163                 program_freelist.push_front(glsl_program_num);
164                 if (program_freelist.size() > program_freelist_max_length) {
165                         delete_program(program_freelist.back());
166                         program_freelist.pop_back();
167                 }
168         }
169
170         pthread_mutex_unlock(&lock);
171 }
172
173 GLuint ResourcePool::create_2d_texture(GLint internal_format, GLsizei width, GLsizei height)
174 {
175         pthread_mutex_lock(&lock);
176         // See if there's a texture on the freelist we can use.
177         for (list<GLuint>::iterator freelist_it = texture_freelist.begin();
178              freelist_it != texture_freelist.end();
179              ++freelist_it) {
180                 GLuint texture_num = *freelist_it;
181                 map<GLuint, Texture2D>::const_iterator format_it = texture_formats.find(texture_num);
182                 assert(format_it != texture_formats.end());
183                 if (format_it->second.internal_format == internal_format &&
184                     format_it->second.width == width &&
185                     format_it->second.height == height) {
186                         texture_freelist_bytes -= estimate_texture_size(format_it->second);
187                         texture_freelist.erase(freelist_it);
188                         pthread_mutex_unlock(&lock);
189                         return texture_num;
190                 }
191         }
192
193         // Find any reasonable format given the internal format; OpenGL validates it
194         // even though we give NULL as pointer.
195         GLenum format;
196         switch (internal_format) {
197         case GL_RGBA32F_ARB:
198         case GL_RGBA16F_ARB:
199         case GL_RGBA8:
200         case GL_SRGB8_ALPHA8:
201                 format = GL_RGBA;
202                 break;
203         case GL_RG32F:
204         case GL_RG16F:
205                 format = GL_RG;
206                 break;
207         case GL_R8:
208                 format = GL_RED;
209                 break;
210         default:
211                 // TODO: Add more here as needed.
212                 assert(false);
213         }
214
215         GLuint texture_num;
216         glGenTextures(1, &texture_num);
217         check_error();
218         glBindTexture(GL_TEXTURE_2D, texture_num);
219         check_error();
220         glTexImage2D(GL_TEXTURE_2D, 0, internal_format, width, height, 0, format, GL_UNSIGNED_BYTE, NULL);
221         check_error();
222         glBindTexture(GL_TEXTURE_2D, 0);
223         check_error();
224
225         Texture2D texture_format;
226         texture_format.internal_format = internal_format;
227         texture_format.width = width;
228         texture_format.height = height;
229         assert(texture_formats.count(texture_num) == 0);
230         texture_formats.insert(make_pair(texture_num, texture_format));
231
232         pthread_mutex_unlock(&lock);
233         return texture_num;
234 }
235
236 void ResourcePool::release_2d_texture(GLuint texture_num)
237 {
238         pthread_mutex_lock(&lock);
239         texture_freelist.push_front(texture_num);
240         assert(texture_formats.count(texture_num) != 0);
241         texture_freelist_bytes += estimate_texture_size(texture_formats[texture_num]);
242
243         while (texture_freelist_bytes > texture_freelist_max_bytes) {
244                 GLuint free_texture_num = texture_freelist.front();
245                 texture_freelist.pop_front();
246                 assert(texture_formats.count(free_texture_num) != 0);
247                 texture_freelist_bytes -= estimate_texture_size(texture_formats[free_texture_num]);
248                 texture_formats.erase(free_texture_num);
249                 glDeleteTextures(1, &free_texture_num);
250                 check_error();
251
252                 // Delete any FBO related to this texture.
253                 for (list<GLuint>::iterator fbo_freelist_it = fbo_freelist.begin();
254                      fbo_freelist_it != fbo_freelist.end(); ) {
255                         GLuint fbo_num = *fbo_freelist_it;
256                         map<GLuint, FBO>::const_iterator format_it = fbo_formats.find(fbo_num);
257                         assert(format_it != fbo_formats.end());
258                         if (format_it->second.texture_num == free_texture_num) {
259                                 fbo_formats.erase(fbo_num);
260                                 glDeleteFramebuffers(1, &fbo_num);
261                                 fbo_freelist.erase(fbo_freelist_it++);
262                         } else {
263                                 ++fbo_freelist_it;
264                         }
265                 }
266         }
267         pthread_mutex_unlock(&lock);
268 }
269
270 GLuint ResourcePool::create_fbo(void *context, GLuint texture_num)
271 {
272         pthread_mutex_lock(&lock);
273         // See if there's an FBO on the freelist we can use.
274         for (list<GLuint>::iterator freelist_it = fbo_freelist.begin();
275              freelist_it != fbo_freelist.end();
276              ++freelist_it) {
277                 GLuint fbo_num = *freelist_it;
278                 map<GLuint, FBO>::const_iterator format_it = fbo_formats.find(fbo_num);
279                 assert(format_it != fbo_formats.end());
280                 if (format_it->second.context == context &&
281                     format_it->second.texture_num == texture_num) {
282                         fbo_freelist.erase(freelist_it);
283                         pthread_mutex_unlock(&lock);
284                         return fbo_num;
285                 }
286         }
287
288         // Create a new one.
289         GLuint fbo_num;
290         glGenFramebuffers(1, &fbo_num);
291         check_error();
292         glBindFramebuffer(GL_FRAMEBUFFER, fbo_num);
293         check_error();
294         glFramebufferTexture2D(
295                 GL_FRAMEBUFFER,
296                 GL_COLOR_ATTACHMENT0,
297                 GL_TEXTURE_2D,
298                 texture_num,
299                 0);
300         check_error();
301         GLenum status = glCheckFramebufferStatusEXT(GL_FRAMEBUFFER_EXT);
302         assert(status == GL_FRAMEBUFFER_COMPLETE);
303         glBindFramebuffer(GL_FRAMEBUFFER, 0);
304         check_error();
305
306         FBO fbo_format;
307         fbo_format.context = context;
308         fbo_format.texture_num = texture_num;
309         assert(fbo_formats.count(fbo_num) == 0);
310         fbo_formats.insert(make_pair(fbo_num, fbo_format));
311
312         pthread_mutex_unlock(&lock);
313         return fbo_num;
314 }
315
316 void ResourcePool::release_fbo(GLuint fbo_num)
317 {
318         pthread_mutex_lock(&lock);
319         fbo_freelist.push_front(fbo_num);
320         assert(fbo_formats.count(fbo_num) != 0);
321
322         while (fbo_freelist.size() > fbo_freelist_max_length) {
323                 GLuint free_fbo_num = fbo_freelist.front();
324                 fbo_freelist.pop_front();
325                 assert(fbo_formats.count(free_fbo_num) != 0);
326                 fbo_formats.erase(free_fbo_num);
327                 glDeleteFramebuffers(1, &free_fbo_num);
328                 check_error();
329         }
330         pthread_mutex_unlock(&lock);
331 }
332
333 size_t ResourcePool::estimate_texture_size(const Texture2D &texture_format)
334 {
335         size_t bytes_per_pixel;
336
337         switch (texture_format.internal_format) {
338         case GL_RGBA32F_ARB:
339                 bytes_per_pixel = 16;
340                 break;
341         case GL_RGBA16F_ARB:
342                 bytes_per_pixel = 8;
343                 break;
344         case GL_RGBA8:
345         case GL_SRGB8_ALPHA8:
346                 bytes_per_pixel = 4;
347                 break;
348         case GL_RG32F:
349                 bytes_per_pixel = 8;
350                 break;
351         case GL_RG16F:
352                 bytes_per_pixel = 4;
353                 break;
354         case GL_R8:
355                 bytes_per_pixel = 1;
356                 break;
357         default:
358                 // TODO: Add more here as needed.
359                 assert(false);
360         }
361
362         return texture_format.width * texture_format.height * bytes_per_pixel;
363 }
364
365 }  // namespace movit