Explicitly bind fragment shader outputs in order.
[movit] / resource_pool.h
1 #ifndef _MOVIT_RESOURCE_POOL_H
2 #define _MOVIT_RESOURCE_POOL_H 1
3
4 // A ResourcePool governs resources that are shared between multiple EffectChains;
5 // in particular, resources that might be expensive to acquire or hold. Thus,
6 // if you have many EffectChains, hooking them up to the same ResourcePool is
7 // probably a good idea.
8 //
9 // However, hooking an EffectChain to a ResourcePool extends the OpenGL context
10 // demands (see effect_chain.h) to that of the ResourcePool; all chains must then
11 // only be used in OpenGL contexts sharing resources with each other. This is
12 // the reason why there isn't just one global ResourcePool singleton (although
13 // most practical users will just want one).
14 //
15 // Thread-safety: All functions except the constructor and destructor can be
16 // safely called from multiple threads at the same time, provided they have
17 // separate (but sharing) OpenGL contexts.
18 //
19 // Memory management (only relevant if you use multiple contexts): Some objects,
20 // like FBOs, are not shareable across contexts, and can only be deleted from
21 // the context they were created in. Thus, you will need to tell the
22 // ResourcePool explicitly if you delete a context, or they will leak (and the
23 // ResourcePool destructor will assert-fail). See clean_context().
24
25 #include <epoxy/gl.h>
26 #include <pthread.h>
27 #include <stddef.h>
28 #include <list>
29 #include <map>
30 #include <string>
31 #include <utility>
32 #include <vector>
33
34 namespace movit {
35
36 class ResourcePool {
37 public:
38         // program_freelist_max_length is how many compiled programs that are unused to keep
39         // around after they are no longer in use (in case another EffectChain
40         // wants that exact program later). Shaders are expensive to compile and do not
41         // need a lot of resources to keep around, so this should be a reasonable number.
42         //
43         // texture_freelist_max_bytes is how many bytes of unused textures to keep around
44         // after they are no longer in use (in case a new texture of the same dimensions
45         // and format is needed). Note that the size estimate is very coarse; it does not
46         // take into account padding, metadata, and most importantly mipmapping.
47         // This means you should be prepared for actual memory usage of the freelist being
48         // twice this estimate or more.
49         ResourcePool(size_t program_freelist_max_length = 100,
50                      size_t texture_freelist_max_bytes = 100 << 20,  // 100 MB.
51                      size_t fbo_freelist_max_length = 100);  // Per context.
52         ~ResourcePool();
53
54         // All remaining functions are intended for calls from EffectChain only.
55
56         // Compile the given vertex+fragment shader pair, or fetch an already
57         // compiled program from the cache if possible. Keeps ownership of the
58         // program; you must call release_glsl_program() instead of deleting it
59         // when you no longer want it.
60         //
61         // If <fragment_shader_outputs> contains more than one value, the given
62         // outputs will be bound to fragment shader output colors in the order
63         // they appear in the vector. Otherwise, output order is undefined and
64         // determined by the OpenGL driver.
65         GLuint compile_glsl_program(const std::string& vertex_shader,
66                                     const std::string& fragment_shader,
67                                     const std::vector<std::string>& frag_shader_outputs);
68         void release_glsl_program(GLuint glsl_program_num);
69
70         // Allocate a 2D texture of the given internal format and dimensions,
71         // or fetch a previous used if possible. Unbinds GL_TEXTURE_2D afterwards.
72         // Keeps ownership of the texture; you must call release_2d_texture() instead
73         // of deleting it when you no longer want it.
74         GLuint create_2d_texture(GLint internal_format, GLsizei width, GLsizei height);
75         void release_2d_texture(GLuint texture_num);
76
77         // Allocate an FBO with the the given texture(s) bound as framebuffer attachment(s),
78         // or fetch a previous used if possible. Unbinds GL_FRAMEBUFFER afterwards.
79         // Keeps ownership of the FBO; you must call release_fbo() of deleting
80         // it when you no longer want it.
81         //
82         // NOTE: In principle, the FBO doesn't have a resolution or pixel format;
83         // you can bind almost whatever texture you want to it. However, changing
84         // textures can have an adverse effect on performance due to validation,
85         // in particular on NVidia cards. Also, keep in mind that FBOs are not
86         // shareable across contexts, so you must have the context that's supposed
87         // to own the FBO current when you create or release it.
88         GLuint create_fbo(GLuint texture0_num,
89                           GLuint texture1_num = 0,
90                           GLuint texture2_num = 0,
91                           GLuint texture3_num = 0);
92         void release_fbo(GLuint fbo_num);
93
94         // Informs the ResourcePool that the current context is going away soon,
95         // and that any resources held for it in the freelist should be deleted.
96         //
97         // You do not need to do this for the last context; the regular destructor
98         // will take care of that. This means that if you only ever use one
99         // thread/context, you never need to call this function.
100         void clean_context();
101
102 private:
103         // Delete the given program and both its shaders.
104         void delete_program(GLuint program_num);
105
106         // Deletes all FBOs for the given context that belong to deleted textures.
107         void cleanup_unlinked_fbos(void *context);
108
109         // Remove FBOs off the end of the freelist for <context>, until it
110         // is no more than <max_length> elements long.
111         void shrink_fbo_freelist(void *context, size_t max_length);
112
113         // Protects all the other elements in the class.
114         pthread_mutex_t lock;
115
116         size_t program_freelist_max_length, texture_freelist_max_bytes, fbo_freelist_max_length;
117                 
118         // A mapping from vertex/fragment shader source strings to compiled program number.
119         std::map<std::pair<std::string, std::string>, GLuint> programs;
120
121         // A mapping from compiled program number to number of current users.
122         // Once this reaches zero, the program is taken out of this map and instead
123         // put on the freelist (after which it may be deleted).
124         std::map<GLuint, int> program_refcount;
125
126         // A mapping from program number to vertex and fragment shaders.
127         std::map<GLuint, std::pair<GLuint, GLuint> > program_shaders;
128
129         // A list of programs that are no longer in use, most recently freed first.
130         // Once this reaches <program_freelist_max_length>, the last element
131         // will be deleted.
132         std::list<GLuint> program_freelist;
133
134         struct Texture2D {
135                 GLint internal_format;
136                 GLsizei width, height;
137         };
138
139         // A mapping from texture number to format details. This is filled if the
140         // texture is given out to a client or on the freelist, but not if it is
141         // deleted from the freelist.
142         std::map<GLuint, Texture2D> texture_formats;
143
144         // A list of all textures that are release but not freed (most recently freed
145         // first), and an estimate of their current memory usage. Once
146         // <texture_freelist_bytes> goes above <texture_freelist_max_bytes>,
147         // elements are deleted off the end of the list until we are under the limit
148         // again.
149         std::list<GLuint> texture_freelist;
150         size_t texture_freelist_bytes;
151
152         static const unsigned num_fbo_attachments = 4;
153         struct FBO {
154                 GLuint fbo_num;
155                 // GL_INVALID_INDEX means associated to a texture that has since been deleted.
156                 // 0 means the output isn't bound.
157                 GLuint texture_num[num_fbo_attachments];
158         };
159
160         // For each context, a mapping from FBO number to format details. This is
161         // filled if the FBO is given out to a client or on the freelist, but
162         // not if it is deleted from the freelist.
163         std::map<std::pair<void *, GLuint>, FBO> fbo_formats;
164         typedef std::map<std::pair<void *, GLuint>, FBO>::iterator FBOFormatIterator;
165
166         // For each context, a list of all FBOs that are released but not freed
167         // (most recently freed first). Once this reaches <fbo_freelist_max_length>,
168         // the last element will be deleted.
169         //
170         // We store iterators directly into <fbo_format> for efficiency.
171         std::map<void *, std::list<FBOFormatIterator> > fbo_freelist;
172
173         // See the caveats at the constructor.
174         static size_t estimate_texture_size(const Texture2D &texture_format);
175 };
176
177 }  // namespace movit
178
179 #endif  // !defined(_MOVIT_RESOURCE_POOL_H)