2 * consumer_sdl_preview.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2004-2005, 2010 Ushodaya Enterprises Limited
4 * Author: Charles Yates
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library 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 GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #include <framework/mlt_consumer.h>
22 #include <framework/mlt_frame.h>
23 #include <framework/mlt_factory.h>
24 #include <framework/mlt_producer.h>
25 #include <framework/mlt_log.h>
30 #include <SDL_syswm.h>
33 extern pthread_mutex_t mlt_sdl_mutex;
35 typedef struct consumer_sdl_s *consumer_sdl;
39 struct mlt_consumer_s parent;
49 mlt_position last_position;
51 pthread_cond_t refresh_cond;
52 pthread_mutex_t refresh_mutex;
56 /** Forward references to static functions.
59 static int consumer_start( mlt_consumer parent );
60 static int consumer_stop( mlt_consumer parent );
61 static int consumer_is_stopped( mlt_consumer parent );
62 static void consumer_close( mlt_consumer parent );
63 static void *consumer_thread( void * );
64 static void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer this, mlt_frame frame );
65 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer this, SDL_Event *event );
66 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer this, char *name );
68 mlt_consumer consumer_sdl_preview_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
70 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
71 if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
73 // Get the parent consumer object
74 mlt_consumer parent = &this->parent;
77 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
79 // Get the width and height
80 int width = mlt_properties_get_int( properties, "width" );
81 int height = mlt_properties_get_int( properties, "height" );
83 // Process actual param
84 if ( arg == NULL || sscanf( arg, "%dx%d", &width, &height ) == 2 )
86 mlt_properties_set_int( properties, "width", width );
87 mlt_properties_set_int( properties, "height", height );
90 // Create child consumers
91 this->play = mlt_factory_consumer( profile, "sdl", arg );
92 this->still = mlt_factory_consumer( profile, "sdl_still", arg );
93 mlt_properties_set( properties, "real_time", "0" );
94 mlt_properties_set( properties, "rescale", "nearest" );
95 mlt_properties_set( properties, "deinterlace_method", "onefield" );
96 parent->close = consumer_close;
97 parent->start = consumer_start;
98 parent->stop = consumer_stop;
99 parent->is_stopped = consumer_is_stopped;
101 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
102 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
103 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
104 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
105 pthread_cond_init( &this->refresh_cond, NULL );
106 pthread_mutex_init( &this->refresh_mutex, NULL );
107 mlt_events_listen( MLT_CONSUMER_PROPERTIES( parent ), this, "property-changed", ( mlt_listener )consumer_refresh_cb );
108 mlt_events_register( properties, "consumer-sdl-paused", NULL );
115 void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer parent, mlt_frame frame )
117 consumer_sdl this = parent->child;
118 this->last_speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
119 this->last_position = mlt_frame_get_position( frame );
120 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-frame-show", frame, NULL );
123 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer parent, SDL_Event *event )
125 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-sdl-event", event, NULL );
128 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
130 if ( !strcmp( name, "refresh" ) )
132 consumer_sdl this = parent->child;
133 pthread_mutex_lock( &this->refresh_mutex );
134 this->refresh_count = this->refresh_count <= 0 ? 1 : this->refresh_count + 1;
135 pthread_cond_broadcast( &this->refresh_cond );
136 pthread_mutex_unlock( &this->refresh_mutex );
140 static int consumer_start( mlt_consumer parent )
142 consumer_sdl this = parent->child;
144 if ( !this->running )
147 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
148 mlt_properties play = MLT_CONSUMER_PROPERTIES( this->play );
149 mlt_properties still = MLT_CONSUMER_PROPERTIES( this->still );
151 char *window_id = mlt_properties_get( properties, "window_id" );
152 char *audio_driver = mlt_properties_get( properties, "audio_driver" );
153 char *video_driver = mlt_properties_get( properties, "video_driver" );
154 char *audio_device = mlt_properties_get( properties, "audio_device" );
155 char *output_display = mlt_properties_get( properties, "output_display" );
156 int progressive = mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" );
158 consumer_stop( parent );
162 this->last_speed = 1;
164 if ( output_display != NULL )
165 setenv( "DISPLAY", output_display, 1 );
167 if ( window_id != NULL )
168 setenv( "SDL_WINDOWID", window_id, 1 );
170 if ( video_driver != NULL )
171 setenv( "SDL_VIDEODRIVER", video_driver, 1 );
173 if ( audio_driver != NULL )
174 setenv( "SDL_AUDIODRIVER", audio_driver, 1 );
176 if ( audio_device != NULL )
177 setenv( "AUDIODEV", audio_device, 1 );
179 pthread_mutex_lock( &mlt_sdl_mutex );
180 int ret = SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE );
181 pthread_mutex_unlock( &mlt_sdl_mutex );
184 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
188 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
189 SDL_EnableUNICODE( 1 );
191 // Pass properties down
192 mlt_properties_set_data( play, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
193 mlt_properties_set_data( still, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
194 mlt_properties_set_data( play, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
195 mlt_properties_set_data( still, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
197 mlt_properties_set_int( play, "progressive", progressive );
198 mlt_properties_set_int( still, "progressive", progressive );
200 mlt_properties_pass_list( play, properties,
201 "deinterlace_method,resize,rescale,width,height,aspect_ratio,display_ratio,volume,real_time,buffer,prefill" );
202 mlt_properties_pass_list( still, properties,
203 "deinterlace_method,resize,rescale,width,height,aspect_ratio,display_ratio" );
204 mlt_properties_pass_list( play, properties, "preview_off,preview_format,window_background" );
205 mlt_properties_pass_list( still, properties, "preview_off,preview_format,window_background" );
207 mlt_properties_pass( play, properties, "play." );
208 mlt_properties_pass( still, properties, "still." );
210 mlt_properties_set_data( play, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
211 mlt_properties_set_data( still, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
212 mlt_properties_set_data( play, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
213 mlt_properties_set_data( still, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
215 mlt_properties_set_int( play, "put_mode", 1 );
216 mlt_properties_set_int( still, "put_mode", 1 );
217 mlt_properties_set_int( play, "terminate_on_pause", 1 );
219 // Start the still producer just to initialise the gui
220 mlt_consumer_start( this->still );
221 this->active = this->still;
223 // Inform child consumers that we control the sdl
224 mlt_properties_set_int( play, "sdl_started", 1 );
225 mlt_properties_set_int( still, "sdl_started", 1 );
227 pthread_create( &this->thread, NULL, consumer_thread, this );
233 static int consumer_stop( mlt_consumer parent )
235 // Get the actual object
236 consumer_sdl this = parent->child;
238 if ( this->joined == 0 )
240 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
241 int app_locked = mlt_properties_get_int( properties, "app_locked" );
242 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
243 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
245 if ( app_locked && unlock ) unlock( );
247 // Kill the thread and clean up
250 pthread_mutex_lock( &this->refresh_mutex );
251 pthread_cond_broadcast( &this->refresh_cond );
252 pthread_mutex_unlock( &this->refresh_mutex );
256 pthread_join( this->thread, NULL );
259 if ( app_locked && lock ) lock( );
261 pthread_mutex_lock( &mlt_sdl_mutex );
263 pthread_mutex_unlock( &mlt_sdl_mutex );
269 static int consumer_is_stopped( mlt_consumer parent )
271 consumer_sdl this = parent->child;
272 return !this->running;
275 static void *consumer_thread( void *arg )
278 consumer_sdl this = arg;
281 mlt_consumer consumer = &this->parent;
283 // Get the properties
284 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
286 // internal intialization
288 mlt_frame frame = NULL;
289 int last_position = -1;
291 int eos_threshold = 20 + mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "buffer" );
293 // Determine if the application is dealing with the preview
294 int preview_off = mlt_properties_get_int( properties, "preview_off" );
296 this->refresh_count = 0;
298 // Loop until told not to
299 while( this->running )
301 // Get a frame from the attached producer
302 frame = mlt_consumer_get_frame( consumer );
304 // Ensure that we have a frame
305 if ( this->running && frame != NULL )
307 // Get the speed of the frame
308 double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
310 // Lock during the operation
311 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
313 // Get refresh request for the current frame
314 int refresh = mlt_properties_get_int( properties, "refresh" );
316 // Decrement refresh and clear changed
317 mlt_events_block( properties, properties );
318 mlt_properties_set_int( properties, "refresh", 0 );
319 mlt_events_unblock( properties, properties );
321 // Unlock after the operation
322 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
324 // Set the changed property on this frame for the benefit of still
325 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", refresh );
327 // Make sure the recipient knows that this frame isn't really rendered
328 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 0 );
330 // Optimisation to reduce latency
333 if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
334 mlt_consumer_purge( this->play );
335 last_position = mlt_frame_get_position( frame );
339 //mlt_consumer_purge( this->play );
343 // If we aren't playing normally, then use the still
346 mlt_producer producer = MLT_PRODUCER( mlt_service_get_producer( MLT_CONSUMER_SERVICE( consumer ) ) );
347 mlt_position duration = mlt_producer_get_playtime( producer );
350 #ifndef SKIP_WAIT_EOS
351 if ( this->active == this->play )
353 // Do not interrupt the play consumer near the end
354 if ( duration - this->last_position > eos_threshold )
356 // Get a new frame at the sought position
357 mlt_frame_close( frame );
359 mlt_producer_seek( producer, this->last_position );
360 frame = mlt_consumer_get_frame( consumer );
365 // Send frame with speed 0 to stop it
366 if ( frame && !mlt_consumer_is_stopped( this->play ) )
368 mlt_consumer_put_frame( this->play, frame );
373 // Check for end of stream
374 if ( mlt_consumer_is_stopped( this->play ) )
377 mlt_log_verbose( MLT_CONSUMER_SERVICE( consumer ), "END OF STREAM\n" );
379 eos = 0; // reset eos indicator
383 // Prevent a tight busy loop
384 struct timespec tm = { 0, 100000L }; // 100 usec
385 nanosleep( &tm, NULL );
390 pause = this->active == this->play;
394 // Start the still consumer
395 mlt_consumer_stop( this->play );
396 this->last_speed = speed;
397 this->active = this->still;
398 this->ignore_change = 0;
399 mlt_consumer_start( this->still );
401 // Send the frame to the active child
404 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", 1 );
405 mlt_consumer_put_frame( this->active, frame );
407 if ( pause && speed == 0.0 )
409 mlt_events_fire( properties, "consumer-sdl-paused", NULL );
412 // Allow a little grace time before switching consumers on speed changes
413 else if ( this->ignore_change -- > 0 && this->active != NULL && !mlt_consumer_is_stopped( this->active ) )
415 mlt_consumer_put_frame( this->active, frame );
417 // Otherwise use the normal player
420 if ( !mlt_consumer_is_stopped( this->still ) )
421 mlt_consumer_stop( this->still );
422 if ( mlt_consumer_is_stopped( this->play ) )
424 this->last_speed = speed;
425 this->active = this->play;
426 this->ignore_change = 0;
427 mlt_consumer_start( this->play );
429 mlt_consumer_put_frame( this->play, frame );
432 // Copy the rectangle info from the active consumer
433 if ( this->running && preview_off == 0 )
435 mlt_properties active = MLT_CONSUMER_PROPERTIES( this->active );
436 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
437 mlt_properties_set_int( properties, "rect_x", mlt_properties_get_int( active, "rect_x" ) );
438 mlt_properties_set_int( properties, "rect_y", mlt_properties_get_int( active, "rect_y" ) );
439 mlt_properties_set_int( properties, "rect_w", mlt_properties_get_int( active, "rect_w" ) );
440 mlt_properties_set_int( properties, "rect_h", mlt_properties_get_int( active, "rect_h" ) );
441 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
444 if ( this->active == this->still )
446 pthread_mutex_lock( &this->refresh_mutex );
447 if ( this->running && speed == 0 && this->refresh_count <= 0 )
449 mlt_events_fire( properties, "consumer-sdl-paused", NULL );
450 pthread_cond_wait( &this->refresh_cond, &this->refresh_mutex );
452 this->refresh_count --;
453 pthread_mutex_unlock( &this->refresh_mutex );
456 // We are definitely not waiting on the first frame any more
461 if ( frame ) mlt_frame_close( frame );
462 mlt_consumer_put_frame( this->active, NULL );
467 if ( this->play ) mlt_consumer_stop( this->play );
468 if ( this->still ) mlt_consumer_stop( this->still );
473 /** Callback to allow override of the close method.
476 static void consumer_close( mlt_consumer parent )
478 // Get the actual object
479 consumer_sdl this = parent->child;
482 mlt_consumer_stop( parent );
484 // Close the child consumers
485 mlt_consumer_close( this->play );
486 mlt_consumer_close( this->still );
488 // Now clean up the rest
489 mlt_consumer_close( parent );
491 // Finally clean up this