2 * filter_glsl_manager.cpp
3 * Copyright (C) 2011-2012 Christophe Thommeret <hftom@free.fr>
4 * Copyright (C) 2013 Dan Dennedy <dan@dennedy.org>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 #include "filter_glsl_manager.h"
24 #include <movit/init.h>
25 #include <movit/util.h>
26 #include <movit/effect_chain.h>
27 #include <movit/resource_pool.h>
28 #include "mlt_movit_input.h"
29 #include "mlt_flip_effect.h"
30 #include <mlt++/MltEvent.h>
31 #include <mlt++/MltProducer.h>
34 #include <framework/mlt_factory.h>
37 #if defined(__DARWIN__)
38 #include <OpenGL/OpenGL.h>
45 void dec_ref_and_delete(GlslManager *p)
47 if (p->dec_ref() == 0) {
52 GlslManager::GlslManager()
53 : Mlt::Filter( mlt_filter_new() )
54 , resource_pool(new ResourcePool())
60 mlt_filter filter = get_filter();
62 // Set the mlt_filter child in case we choose to override virtual functions.
64 add_ref(mlt_global_properties());
66 mlt_events_register( get_properties(), "init glsl", NULL );
67 mlt_events_register( get_properties(), "close glsl", NULL );
68 initEvent = listen("init glsl", this, (mlt_listener) GlslManager::onInit);
69 closeEvent = listen("close glsl", this, (mlt_listener) GlslManager::onClose);
73 GlslManager::~GlslManager()
75 mlt_log_debug(get_service(), "%s\n", __FUNCTION__);
77 // XXX If there is still a frame holding a reference to a texture after this
78 // destructor is called, then it will crash in release_texture().
79 // while (texture_list.peek_back())
80 // delete (glsl_texture) texture_list.pop_back();
83 if (prev_sync != NULL) {
84 glDeleteSync( prev_sync );
86 while (syncs_to_delete.count() > 0) {
87 GLsync sync = (GLsync) syncs_to_delete.pop_front();
93 void GlslManager::add_ref(mlt_properties properties)
96 mlt_properties_set_data(properties, "glslManager", this, 0,
97 (mlt_destructor) dec_ref_and_delete, NULL);
100 GlslManager* GlslManager::get_instance()
102 return (GlslManager*) mlt_properties_get_data(mlt_global_properties(), "glslManager", 0);
105 glsl_fbo GlslManager::get_fbo(int width, int height)
107 #if defined(__DARWIN__)
108 CGLContextObj context = CGLGetCurrentContext();
110 HGLRC context = wglGetCurrentContext();
112 GLXContext context = glXGetCurrentContext();
116 for (int i = 0; i < fbo_list.count(); ++i) {
117 glsl_fbo fbo = (glsl_fbo) fbo_list.peek(i);
118 if (!fbo->used && (fbo->width == width) && (fbo->height == height) && (fbo->context == context)) {
127 glGenFramebuffers(1, &fb);
131 glsl_fbo fbo = new glsl_fbo_s;
133 glDeleteFramebuffers(1, &fb);
138 fbo->height = height;
140 fbo->context = context;
142 fbo_list.push_back(fbo);
147 void GlslManager::release_fbo(glsl_fbo fbo)
152 glsl_texture GlslManager::get_texture(int width, int height, GLint internal_format)
155 for (int i = 0; i < texture_list.count(); ++i) {
156 glsl_texture tex = (glsl_texture) texture_list.peek(i);
157 if (!tex->used && (tex->width == width) && (tex->height == height) && (tex->internal_format == internal_format)) {
158 glBindTexture(GL_TEXTURE_2D, tex->texture);
159 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
160 glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
161 glBindTexture( GL_TEXTURE_2D, 0);
168 // Recycle a glsl_texture with deleted glTexture.
169 glsl_texture gtex = 0;
170 for (int i = 0; i < texture_list.count(); ++i) {
171 glsl_texture tex = (glsl_texture) texture_list.peek(i);
172 if (!tex->used && !tex->width && !tex->height) {
180 glGenTextures(1, &tex);
182 glDeleteTextures(1, &tex);
187 gtex = new glsl_texture_s;
192 glBindTexture( GL_TEXTURE_2D, tex );
193 glTexImage2D( GL_TEXTURE_2D, 0, internal_format, width, height, 0, GL_RGBA, GL_UNSIGNED_BYTE, NULL );
194 glTexParameterf( GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_EDGE );
195 glTexParameterf( GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_EDGE );
196 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST );
197 glTexParameteri( GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST );
198 glBindTexture( GL_TEXTURE_2D, 0 );
202 gtex->height = height;
203 gtex->internal_format = internal_format;
206 texture_list.push_back(gtex);
211 void GlslManager::release_texture(glsl_texture texture)
216 void GlslManager::delete_sync(GLsync sync)
218 // We do not know which thread we are called from, and we can only
219 // delete this if we are in one with a valid OpenGL context.
220 // Thus, store it for later deletion in render_frame_texture().
221 GlslManager* g = GlslManager::get_instance();
223 g->syncs_to_delete.push_back(sync);
227 glsl_pbo GlslManager::get_pbo(int size)
232 glGenBuffers(1, &pb);
238 pbo = new glsl_pbo_s;
240 glDeleteBuffers(1, &pb);
247 if (size > pbo->size) {
248 glBindBuffer(GL_PIXEL_UNPACK_BUFFER_ARB, pbo->pbo);
249 glBufferData(GL_PIXEL_UNPACK_BUFFER_ARB, size, NULL, GL_STREAM_DRAW);
250 glBindBuffer(GL_PIXEL_UNPACK_BUFFER_ARB, 0);
257 void GlslManager::cleanupContext()
260 while (fbo_list.peek_back()) {
261 glsl_fbo fbo = (glsl_fbo) fbo_list.pop_back();
262 glDeleteFramebuffers(1, &fbo->fbo);
265 for (int i = 0; i < texture_list.count(); ++i) {
266 glsl_texture texture = (glsl_texture) texture_list.peek(i);
267 glDeleteTextures(1, &texture->texture);
273 glDeleteBuffers(1, &pbo->pbo);
280 void GlslManager::onInit( mlt_properties owner, GlslManager* filter )
282 mlt_log_debug( filter->get_service(), "%s\n", __FUNCTION__ );
284 std::string path = std::string(mlt_environment("MLT_APPDIR")).append("\\share\\movit");
285 #elif defined(__DARWIN__) && defined(RELOCATABLE)
286 std::string path = std::string(mlt_environment("MLT_APPDIR")).append("/share/movit");
288 std::string path = std::string(getenv("MLT_MOVIT_PATH") ? getenv("MLT_MOVIT_PATH") : SHADERDIR);
290 ::init_movit( path, mlt_log_get_level() == MLT_LOG_DEBUG? MOVIT_DEBUG_ON : MOVIT_DEBUG_OFF );
291 filter->set( "glsl_supported", movit_initialized );
294 void GlslManager::onClose( mlt_properties owner, GlslManager *filter )
296 filter->cleanupContext();
299 void GlslManager::onServiceChanged( mlt_properties owner, mlt_service aservice )
301 Mlt::Service service( aservice );
303 service.set( "movit chain", NULL, 0 );
307 void GlslManager::onPropertyChanged( mlt_properties owner, mlt_service service, const char* property )
309 if ( property && std::string( property ) == "disable" )
310 onServiceChanged( owner, service );
315 mlt_filter filter_glsl_manager_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
317 GlslManager* g = GlslManager::get_instance();
321 g = new GlslManager();
322 return g->get_filter();
327 static void deleteChain( GlslChain* chain )
329 // The Input* is owned by the EffectChain, but the MltInput* is not.
330 // Thus, we have to delete it here.
331 for (std::map<mlt_producer, MltInput*>::iterator input_it = chain->inputs.begin();
332 input_it != chain->inputs.end();
334 delete input_it->second;
336 delete chain->effect_chain;
340 void* GlslManager::get_frame_specific_data( mlt_service service, mlt_frame frame, const char *key, int *length )
342 const char *unique_id = mlt_properties_get( MLT_SERVICE_PROPERTIES(service), "_unique_id" );
344 snprintf( buf, sizeof(buf), "%s_%s", key, unique_id );
345 return mlt_properties_get_data( MLT_FRAME_PROPERTIES(frame), buf, length );
348 int GlslManager::set_frame_specific_data( mlt_service service, mlt_frame frame, const char *key, void *value, int length, mlt_destructor destroy, mlt_serialiser serialise )
350 const char *unique_id = mlt_properties_get( MLT_SERVICE_PROPERTIES(service), "_unique_id" );
352 snprintf( buf, sizeof(buf), "%s_%s", key, unique_id );
353 return mlt_properties_set_data( MLT_FRAME_PROPERTIES(frame), buf, value, length, destroy, serialise );
356 void GlslManager::set_chain( mlt_service service, GlslChain* chain )
358 mlt_properties_set_data( MLT_SERVICE_PROPERTIES(service), "_movit chain", chain, 0, (mlt_destructor) deleteChain, NULL );
361 GlslChain* GlslManager::get_chain( mlt_service service )
363 return (GlslChain*) mlt_properties_get_data( MLT_SERVICE_PROPERTIES(service), "_movit chain", NULL );
366 Effect* GlslManager::get_effect( mlt_service service, mlt_frame frame )
368 return (Effect*) get_frame_specific_data( service, frame, "_movit effect", NULL );
371 Effect* GlslManager::set_effect( mlt_service service, mlt_frame frame, Effect* effect )
373 set_frame_specific_data( service, frame, "_movit effect", effect, 0, NULL, NULL );
377 MltInput* GlslManager::get_input( mlt_producer producer, mlt_frame frame )
379 return (MltInput*) get_frame_specific_data( MLT_PRODUCER_SERVICE(producer), frame, "_movit input", NULL );
382 MltInput* GlslManager::set_input( mlt_producer producer, mlt_frame frame, MltInput* input )
384 set_frame_specific_data( MLT_PRODUCER_SERVICE(producer), frame, "_movit input", input, 0, NULL, NULL );
388 uint8_t* GlslManager::get_input_pixel_pointer( mlt_producer producer, mlt_frame frame )
390 return (uint8_t*) get_frame_specific_data( MLT_PRODUCER_SERVICE(producer), frame, "_movit input pp", NULL );
393 uint8_t* GlslManager::set_input_pixel_pointer( mlt_producer producer, mlt_frame frame, uint8_t* image )
395 set_frame_specific_data( MLT_PRODUCER_SERVICE(producer), frame, "_movit input pp", image, 0, NULL, NULL );
399 mlt_service GlslManager::get_effect_input( mlt_service service, mlt_frame frame )
401 return (mlt_service) get_frame_specific_data( service, frame, "_movit effect input", NULL );
404 void GlslManager::set_effect_input( mlt_service service, mlt_frame frame, mlt_service input_service )
406 set_frame_specific_data( service, frame, "_movit effect input", input_service, 0, NULL, NULL );
409 void GlslManager::get_effect_secondary_input( mlt_service service, mlt_frame frame, mlt_service *input_service, mlt_frame *input_frame)
411 *input_service = (mlt_service) get_frame_specific_data( service, frame, "_movit effect secondary input", NULL );
412 *input_frame = (mlt_frame) get_frame_specific_data( service, frame, "_movit effect secondary input frame", NULL );
415 void GlslManager::set_effect_secondary_input( mlt_service service, mlt_frame frame, mlt_service input_service, mlt_frame input_frame )
417 set_frame_specific_data( service, frame, "_movit effect secondary input", input_service, 0, NULL, NULL );
418 set_frame_specific_data( service, frame, "_movit effect secondary input frame", input_frame, 0, NULL, NULL );
421 int GlslManager::render_frame_texture(EffectChain *chain, mlt_frame frame, int width, int height, uint8_t **image)
423 glsl_fbo fbo = get_fbo( width, height );
425 glsl_texture texture = get_texture( width, height, GL_RGBA8 );
431 glBindFramebuffer( GL_FRAMEBUFFER, fbo->fbo );
433 glFramebufferTexture2D( GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, texture->texture, 0 );
435 glBindFramebuffer( GL_FRAMEBUFFER, 0 );
439 while (syncs_to_delete.count() > 0) {
440 GLsync sync = (GLsync) syncs_to_delete.pop_front();
441 glDeleteSync( sync );
445 // Make sure we never have more than one frame pending at any time.
446 // This ensures we do not swamp the GPU with so much work
447 // that we cannot actually display the frames we generate.
448 if (prev_sync != NULL) {
450 glClientWaitSync( prev_sync, 0, GL_TIMEOUT_IGNORED );
451 glDeleteSync( prev_sync );
453 chain->render_to_fbo( fbo->fbo, width, height );
454 prev_sync = glFenceSync( GL_SYNC_GPU_COMMANDS_COMPLETE, 0 );
455 GLsync sync = glFenceSync( GL_SYNC_GPU_COMMANDS_COMPLETE, 0 );
458 glBindFramebuffer( GL_FRAMEBUFFER, 0 );
462 *image = (uint8_t*) &texture->texture;
463 mlt_frame_set_image( frame, *image, 0, NULL );
464 mlt_properties_set_data( MLT_FRAME_PROPERTIES(frame), "movit.convert.texture", texture, 0,
465 (mlt_destructor) GlslManager::release_texture, NULL );
466 mlt_properties_set_data( MLT_FRAME_PROPERTIES(frame), "movit.convert.fence", sync, 0,
467 (mlt_destructor) GlslManager::delete_sync, NULL );
472 int GlslManager::render_frame_rgba(EffectChain *chain, mlt_frame frame, int width, int height, uint8_t **image)
474 glsl_fbo fbo = get_fbo( width, height );
476 glsl_texture texture = get_texture( width, height, GL_RGBA8 );
482 // Use a PBO to hold the data we read back with glReadPixels().
483 // (Intel/DRI goes into a slow path if we don't read to PBO.)
484 int img_size = width * height * 4;
485 glsl_pbo pbo = get_pbo( img_size );
488 release_texture(texture);
494 glBindFramebuffer( GL_FRAMEBUFFER, fbo->fbo );
496 glFramebufferTexture2D( GL_FRAMEBUFFER, GL_COLOR_ATTACHMENT0, GL_TEXTURE_2D, texture->texture, 0 );
498 glBindFramebuffer( GL_FRAMEBUFFER, 0 );
501 chain->render_to_fbo( fbo->fbo, width, height );
504 glBindFramebuffer( GL_FRAMEBUFFER, fbo->fbo );
506 glBindBuffer( GL_PIXEL_PACK_BUFFER_ARB, pbo->pbo );
508 glBufferData( GL_PIXEL_PACK_BUFFER_ARB, img_size, NULL, GL_STREAM_READ );
510 glReadPixels( 0, 0, width, height, GL_BGRA, GL_UNSIGNED_BYTE, BUFFER_OFFSET(0) );
514 uint8_t* buf = (uint8_t*) glMapBuffer( GL_PIXEL_PACK_BUFFER_ARB, GL_READ_ONLY );
516 *image = (uint8_t*) mlt_pool_alloc( img_size );
517 mlt_frame_set_image( frame, *image, img_size, mlt_pool_release );
518 memcpy( *image, buf, img_size );
520 // Convert BGRA to RGBA
521 register uint8_t *p = *image;
522 register int n = width * height + 1;
529 // Release PBO and FBO
530 glUnmapBuffer( GL_PIXEL_PACK_BUFFER_ARB );
532 glBindBuffer( GL_PIXEL_PACK_BUFFER_ARB, 0 );
534 glBindFramebuffer( GL_FRAMEBUFFER, 0 );
536 glBindTexture( GL_TEXTURE_2D, 0 );
538 mlt_properties_set_data( MLT_FRAME_PROPERTIES(frame), "movit.convert.texture", texture, 0,
539 (mlt_destructor) GlslManager::release_texture, NULL);
545 void GlslManager::lock_service( mlt_frame frame )
547 Mlt::Producer producer( mlt_producer_cut_parent( mlt_frame_get_original_producer( frame ) ) );
551 void GlslManager::unlock_service( mlt_frame frame )
553 Mlt::Producer producer( mlt_producer_cut_parent( mlt_frame_get_original_producer( frame ) ) );