2 * consumer_sdl_preview.c -- A Simple DirectMedia Layer consumer
3 * Copyright (C) 2004-2005 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>
29 #include <SDL/SDL_syswm.h>
32 extern pthread_mutex_t mlt_sdl_mutex;
34 typedef struct consumer_sdl_s *consumer_sdl;
38 struct mlt_consumer_s parent;
48 mlt_position last_position;
50 pthread_cond_t refresh_cond;
51 pthread_mutex_t refresh_mutex;
55 /** Forward references to static functions.
58 static int consumer_start( mlt_consumer parent );
59 static int consumer_stop( mlt_consumer parent );
60 static int consumer_is_stopped( mlt_consumer parent );
61 static void consumer_close( mlt_consumer parent );
62 static void *consumer_thread( void * );
63 static void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer this, mlt_frame frame );
64 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer this, SDL_Event *event );
65 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer this, char *name );
67 mlt_consumer consumer_sdl_preview_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
69 consumer_sdl this = calloc( sizeof( struct consumer_sdl_s ), 1 );
70 if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
72 // Get the parent consumer object
73 mlt_consumer parent = &this->parent;
76 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
78 // Get the width and height
79 int width = mlt_properties_get_int( properties, "width" );
80 int height = mlt_properties_get_int( properties, "height" );
82 // Process actual param
83 if ( arg == NULL || sscanf( arg, "%dx%d", &width, &height ) == 2 )
85 mlt_properties_set_int( properties, "width", width );
86 mlt_properties_set_int( properties, "height", height );
89 // Create child consumers
90 this->play = mlt_factory_consumer( profile, "sdl", arg );
91 this->still = mlt_factory_consumer( profile, "sdl_still", arg );
92 mlt_properties_set( properties, "real_time", "0" );
93 mlt_properties_set( properties, "rescale", "nearest" );
94 mlt_properties_set( properties, "deinterlace_method", "onefield" );
95 parent->close = consumer_close;
96 parent->start = consumer_start;
97 parent->stop = consumer_stop;
98 parent->is_stopped = consumer_is_stopped;
100 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
101 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-frame-show", ( mlt_listener )consumer_frame_show_cb );
102 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->play ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
103 mlt_events_listen( MLT_CONSUMER_PROPERTIES( this->still ), this, "consumer-sdl-event", ( mlt_listener )consumer_sdl_event_cb );
104 pthread_cond_init( &this->refresh_cond, NULL );
105 pthread_mutex_init( &this->refresh_mutex, NULL );
106 mlt_events_listen( MLT_CONSUMER_PROPERTIES( parent ), this, "property-changed", ( mlt_listener )consumer_refresh_cb );
113 void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer parent, mlt_frame frame )
115 consumer_sdl this = parent->child;
116 this->last_speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
117 this->last_position = mlt_frame_get_position( frame );
118 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-frame-show", frame, NULL );
121 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer parent, SDL_Event *event )
123 mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-sdl-event", event, NULL );
126 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
128 if ( !strcmp( name, "refresh" ) )
130 consumer_sdl this = parent->child;
131 pthread_mutex_lock( &this->refresh_mutex );
132 this->refresh_count = this->refresh_count <= 0 ? 1 : this->refresh_count ++;
133 pthread_cond_broadcast( &this->refresh_cond );
134 pthread_mutex_unlock( &this->refresh_mutex );
138 static int consumer_start( mlt_consumer parent )
140 consumer_sdl this = parent->child;
142 if ( !this->running )
145 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
146 mlt_properties play = MLT_CONSUMER_PROPERTIES( this->play );
147 mlt_properties still = MLT_CONSUMER_PROPERTIES( this->still );
149 char *window_id = mlt_properties_get( properties, "window_id" );
150 char *audio_driver = mlt_properties_get( properties, "audio_driver" );
151 char *video_driver = mlt_properties_get( properties, "video_driver" );
152 char *audio_device = mlt_properties_get( properties, "audio_device" );
153 char *output_display = mlt_properties_get( properties, "output_display" );
154 int progressive = mlt_properties_get_int( properties, "progressive" ) | mlt_properties_get_int( properties, "deinterlace" );
156 consumer_stop( parent );
160 this->last_speed = 1;
162 if ( output_display != NULL )
163 setenv( "DISPLAY", output_display, 1 );
165 if ( window_id != NULL )
166 setenv( "SDL_WINDOWID", window_id, 1 );
168 if ( video_driver != NULL )
169 setenv( "SDL_VIDEODRIVER", video_driver, 1 );
171 if ( audio_driver != NULL )
172 setenv( "SDL_AUDIODRIVER", audio_driver, 1 );
174 if ( audio_device != NULL )
175 setenv( "AUDIODEV", audio_device, 1 );
177 if ( SDL_Init( SDL_INIT_VIDEO | SDL_INIT_NOPARACHUTE ) < 0 )
179 fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
183 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
184 SDL_EnableUNICODE( 1 );
186 // Pass properties down
187 mlt_properties_set_data( play, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
188 mlt_properties_set_data( still, "transport_producer", mlt_properties_get_data( properties, "transport_producer", NULL ), 0, NULL, NULL );
189 mlt_properties_set_data( play, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
190 mlt_properties_set_data( still, "transport_callback", mlt_properties_get_data( properties, "transport_callback", NULL ), 0, NULL, NULL );
192 mlt_properties_set_int( play, "progressive", progressive );
193 mlt_properties_set_int( still, "progressive", progressive );
195 mlt_properties_pass_list( play, properties, "resize,rescale,width,height,aspect_ratio,display_ratio,volume" );
196 mlt_properties_pass_list( still, properties, "resize,rescale,width,height,aspect_ratio,display_ratio" );
197 mlt_properties_pass_list( play, properties, "deinterlace_method" );
198 mlt_properties_pass_list( still, properties, "deinterlace_method" );
199 mlt_properties_pass_list( play, properties, "preview_off,preview_format,window_background" );
200 mlt_properties_pass_list( still, properties, "preview_off,preview_format,window_background" );
202 mlt_properties_pass( play, properties, "play." );
203 mlt_properties_pass( still, properties, "still." );
205 mlt_properties_set_data( play, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
206 mlt_properties_set_data( still, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
207 mlt_properties_set_data( play, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
208 mlt_properties_set_data( still, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
210 mlt_properties_set_int( play, "put_mode", 1 );
211 mlt_properties_set_int( still, "put_mode", 1 );
212 mlt_properties_set_int( play, "terminate_on_pause", 1 );
214 // Start the still producer just to initialise the gui
215 mlt_consumer_start( this->still );
216 this->active = this->still;
218 // Inform child consumers that we control the sdl
219 mlt_properties_set_int( play, "sdl_started", 1 );
220 mlt_properties_set_int( still, "sdl_started", 1 );
222 pthread_create( &this->thread, NULL, consumer_thread, this );
228 static int consumer_stop( mlt_consumer parent )
230 // Get the actual object
231 consumer_sdl this = parent->child;
233 if ( this->joined == 0 )
235 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
236 int app_locked = mlt_properties_get_int( properties, "app_locked" );
237 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
238 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
240 if ( app_locked && unlock ) unlock( );
242 // Kill the thread and clean up
245 pthread_mutex_lock( &this->refresh_mutex );
246 pthread_cond_broadcast( &this->refresh_cond );
247 pthread_mutex_unlock( &this->refresh_mutex );
249 pthread_join( this->thread, NULL );
252 if ( app_locked && lock ) lock( );
254 pthread_mutex_lock( &mlt_sdl_mutex );
256 pthread_mutex_unlock( &mlt_sdl_mutex );
262 static int consumer_is_stopped( mlt_consumer parent )
264 consumer_sdl this = parent->child;
265 return !this->running;
268 static void *consumer_thread( void *arg )
271 consumer_sdl this = arg;
273 // Get the consumer and producer
274 mlt_consumer consumer = &this->parent;
275 mlt_producer producer = MLT_PRODUCER( mlt_service_get_producer( MLT_CONSUMER_SERVICE( consumer ) ) );
277 // Get the properties
278 mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
280 // internal intialization
282 mlt_frame frame = NULL;
283 int last_position = -1;
284 int eof_threshold = 10 + mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "buffer" );
285 int prefill = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "prefill" );
286 int buffer = mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "buffer" );
288 // Determine if the application is dealing with the preview
289 int preview_off = mlt_properties_get_int( properties, "preview_off" );
291 this->refresh_count = 0;
293 // Loop until told not to
294 while( this->running )
296 // Get a frame from the attached producer
297 frame = mlt_consumer_get_frame( consumer );
299 // Ensure that we have a frame
300 if ( this->running && frame != NULL )
302 // Get the speed of the frame
303 double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
305 // Lock during the operation
306 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
308 // Get refresh request for the current frame
309 int refresh = mlt_properties_get_int( properties, "refresh" );
311 // Decrement refresh and clear changed
312 mlt_events_block( properties, properties );
313 mlt_properties_set_int( properties, "refresh", 0 );
314 mlt_events_unblock( properties, properties );
316 // Unlock after the operation
317 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
319 // Set the changed property on this frame for the benefit of still
320 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", refresh );
322 // Make sure the recipient knows that this frame isn't really rendered
323 mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 0 );
325 // Optimisation to reduce latency
328 if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
329 mlt_consumer_purge( this->play );
330 last_position = mlt_frame_get_position( frame );
334 //mlt_consumer_purge( this->play );
338 // If we aren't playing normally, then use the still
341 mlt_position duration = mlt_producer_get_playtime( producer );
343 // Do not interrupt the normal consumer near the end
344 if ( !mlt_consumer_is_stopped( this->play ) && ( duration - this->last_position ) > eof_threshold )
345 mlt_consumer_stop( this->play );
347 // Switch to the still consumer
348 if ( mlt_consumer_is_stopped( this->still ) )
350 // If near the end, wait for the normal consumer to play out its buffers
351 assert( this->active == this->play );
352 if ( ! mlt_consumer_is_stopped( this->play ) && speed == 0.0 )
354 // This frame with speed=0 will tell normal consumer to terminate
355 mlt_consumer_put_frame( this->play, frame );
357 if ( ( duration - this->last_position ) > ( prefill > 0 ? prefill : buffer ) )
359 while ( ! mlt_consumer_is_stopped( this->play ) )
361 struct timespec tm = { 0, 10000000L }; // 10 ms
362 nanosleep( &tm, NULL );
365 mlt_consumer_stop( this->play );
367 // We want to be positioned at the end
368 if ( duration - this->last_position < 10 )
369 this->last_position = duration - 1;
373 // We will need a new frame at the correct position
374 mlt_frame_close( frame );
377 // Get a new frame at the sought position
379 mlt_producer_seek( producer, this->last_position );
380 frame = mlt_consumer_get_frame( consumer );
382 // Start the still consumer
383 this->last_speed = speed;
384 this->active = this->still;
385 this->ignore_change = 0;
386 mlt_consumer_start( this->still );
388 // Use the still consumer
390 mlt_consumer_put_frame( this->still, frame );
392 // Allow a little grace time before switching consumers on speed changes
393 else if ( this->ignore_change -- > 0 && this->active != NULL && !mlt_consumer_is_stopped( this->active ) )
395 mlt_consumer_put_frame( this->active, frame );
397 // Otherwise use the normal player
400 if ( !mlt_consumer_is_stopped( this->still ) )
401 mlt_consumer_stop( this->still );
402 if ( mlt_consumer_is_stopped( this->play ) )
404 this->last_speed = speed;
405 this->active = this->play;
406 this->ignore_change = 0;
407 mlt_consumer_start( this->play );
409 mlt_consumer_put_frame( this->play, frame );
412 // Copy the rectangle info from the active consumer
413 if ( this->running && preview_off == 0 )
415 mlt_properties active = MLT_CONSUMER_PROPERTIES( this->active );
416 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
417 mlt_properties_set_int( properties, "rect_x", mlt_properties_get_int( active, "rect_x" ) );
418 mlt_properties_set_int( properties, "rect_y", mlt_properties_get_int( active, "rect_y" ) );
419 mlt_properties_set_int( properties, "rect_w", mlt_properties_get_int( active, "rect_w" ) );
420 mlt_properties_set_int( properties, "rect_h", mlt_properties_get_int( active, "rect_h" ) );
421 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
424 if ( this->active == this->still )
426 pthread_mutex_lock( &this->refresh_mutex );
427 if ( this->running && speed == 0 && this->refresh_count <= 0 )
428 pthread_cond_wait( &this->refresh_cond, &this->refresh_mutex );
429 this->refresh_count --;
430 pthread_mutex_unlock( &this->refresh_mutex );
433 // We are definitely not waiting on the first frame any more
438 if ( frame ) mlt_frame_close( frame );
439 mlt_consumer_put_frame( this->active, NULL );
444 if ( this->play ) mlt_consumer_stop( this->play );
445 if ( this->still ) mlt_consumer_stop( this->still );
450 /** Callback to allow override of the close method.
453 static void consumer_close( mlt_consumer parent )
455 // Get the actual object
456 consumer_sdl this = parent->child;
459 mlt_consumer_stop( parent );
461 // Close the child consumers
462 mlt_consumer_close( this->play );
463 mlt_consumer_close( this->still );
465 // Now clean up the rest
466 mlt_consumer_close( parent );
468 // Finally clean up this