]> git.sesse.net Git - mlt/blob - src/modules/sdl/consumer_sdl_preview.c
Merge pull request #10 from mcfrisk/coverity_review_fixes_v2
[mlt] / src / modules / sdl / consumer_sdl_preview.c
1 /*
2  * consumer_sdl_preview.c -- A Simple DirectMedia Layer consumer
3  * Copyright (C) 2004-2005, 2010 Ushodaya Enterprises Limited
4  * Author: Charles Yates
5  *
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.
10  *
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.
15  *
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
19  */
20
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>
26 #include <stdlib.h>
27 #include <string.h>
28 #include <pthread.h>
29 #include <SDL.h>
30 #include <SDL_syswm.h>
31 #include <sys/time.h>
32
33 extern pthread_mutex_t mlt_sdl_mutex;
34
35 typedef struct consumer_sdl_s *consumer_sdl;
36
37 struct consumer_sdl_s
38 {
39         struct mlt_consumer_s parent;
40         mlt_consumer active;
41         int ignore_change;
42         mlt_consumer play;
43         mlt_consumer still;
44         pthread_t thread;
45         int joined;
46         int running;
47         int sdl_flags;
48         double last_speed;
49         mlt_position last_position;
50
51         pthread_cond_t refresh_cond;
52         pthread_mutex_t refresh_mutex;
53         int refresh_count;
54 };
55
56 /** Forward references to static functions.
57 */
58
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 );
67
68 mlt_consumer consumer_sdl_preview_init( mlt_profile profile, mlt_service_type type, const char *id, char *arg )
69 {
70         consumer_sdl this = calloc( 1, sizeof( struct consumer_sdl_s ) );
71         if ( this != NULL && mlt_consumer_init( &this->parent, this, profile ) == 0 )
72         {
73                 // Get the parent consumer object
74                 mlt_consumer parent = &this->parent;
75
76                 // Get the properties
77                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
78
79                 // Get the width and height
80                 int width = mlt_properties_get_int( properties, "width" );
81                 int height = mlt_properties_get_int( properties, "height" );
82
83                 // Process actual param
84                 if ( arg == NULL || sscanf( arg, "%dx%d", &width, &height ) == 2 )
85                 {
86                         mlt_properties_set_int( properties, "width", width );
87                         mlt_properties_set_int( properties, "height", height );
88                 }
89
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, "rescale", "nearest" );
94                 mlt_properties_set( properties, "deinterlace_method", "onefield" );
95                 mlt_properties_set_int( properties, "prefill", 1 );
96                 parent->close = consumer_close;
97                 parent->start = consumer_start;
98                 parent->stop = consumer_stop;
99                 parent->is_stopped = consumer_is_stopped;
100                 this->joined = 1;
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 );
109                 return parent;
110         }
111         free( this );
112         return NULL;
113 }
114
115 void consumer_frame_show_cb( mlt_consumer sdl, mlt_consumer parent, mlt_frame frame )
116 {
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 );
121 }
122
123 static void consumer_sdl_event_cb( mlt_consumer sdl, mlt_consumer parent, SDL_Event *event )
124 {
125         mlt_events_fire( MLT_CONSUMER_PROPERTIES( parent ), "consumer-sdl-event", event, NULL );
126 }
127
128 static void consumer_refresh_cb( mlt_consumer sdl, mlt_consumer parent, char *name )
129 {
130         if ( !strcmp( name, "refresh" ) )
131         {
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 );
137         }
138 }
139
140 static int consumer_start( mlt_consumer parent )
141 {
142         consumer_sdl this = parent->child;
143
144         if ( !this->running )
145         {
146                 // properties
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 );
150
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" );
157
158                 consumer_stop( parent );
159
160                 this->running = 1;
161                 this->joined = 0;
162                 this->last_speed = 1;
163
164                 if ( output_display != NULL )
165                         setenv( "DISPLAY", output_display, 1 );
166
167                 if ( window_id != NULL )
168                         setenv( "SDL_WINDOWID", window_id, 1 );
169
170                 if ( video_driver != NULL )
171                         setenv( "SDL_VIDEODRIVER", video_driver, 1 );
172
173                 if ( audio_driver != NULL )
174                         setenv( "SDL_AUDIODRIVER", audio_driver, 1 );
175
176                 if ( audio_device != NULL )
177                         setenv( "AUDIODEV", audio_device, 1 );
178
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 );
182                 if ( ret < 0 )
183                 {
184                         fprintf( stderr, "Failed to initialize SDL: %s\n", SDL_GetError() );
185                         return -1;
186                 }
187
188                 SDL_EnableKeyRepeat( SDL_DEFAULT_REPEAT_DELAY, SDL_DEFAULT_REPEAT_INTERVAL );
189                 SDL_EnableUNICODE( 1 );
190
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 );
196
197                 mlt_properties_set_int( play, "progressive", progressive );
198                 mlt_properties_set_int( still, "progressive", progressive );
199
200                 mlt_properties_pass_list( play, properties,
201                         "deinterlace_method,resize,rescale,width,height,aspect_ratio,display_ratio,preview_off,preview_format,window_background"
202                         ",volume,real_time,buffer,prefill,audio_off,frequency,drop_max" );
203                 mlt_properties_pass_list( still, properties,
204                         "deinterlace_method,resize,rescale,width,height,aspect_ratio,display_ratio,preview_off,preview_format,window_background" );
205
206                 mlt_properties_pass( play, properties, "play." );
207                 mlt_properties_pass( still, properties, "still." );
208
209                 mlt_properties_set_data( play, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
210                 mlt_properties_set_data( still, "app_lock", mlt_properties_get_data( properties, "app_lock", NULL ), 0, NULL, NULL );
211                 mlt_properties_set_data( play, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
212                 mlt_properties_set_data( still, "app_unlock", mlt_properties_get_data( properties, "app_unlock", NULL ), 0, NULL, NULL );
213
214                 mlt_properties_set_int( play, "put_mode", 1 );
215                 mlt_properties_set_int( still, "put_mode", 1 );
216                 mlt_properties_set_int( play, "terminate_on_pause", 1 );
217
218                 // Start the still producer just to initialise the gui
219                 mlt_consumer_start( this->still );
220                 this->active = this->still;
221
222                 // Inform child consumers that we control the sdl
223                 mlt_properties_set_int( play, "sdl_started", 1 );
224                 mlt_properties_set_int( still, "sdl_started", 1 );
225
226                 pthread_create( &this->thread, NULL, consumer_thread, this );
227         }
228
229         return 0;
230 }
231
232 static int consumer_stop( mlt_consumer parent )
233 {
234         // Get the actual object
235         consumer_sdl this = parent->child;
236
237         if ( this->joined == 0 )
238         {
239                 mlt_properties properties = MLT_CONSUMER_PROPERTIES( parent );
240                 int app_locked = mlt_properties_get_int( properties, "app_locked" );
241                 void ( *lock )( void ) = mlt_properties_get_data( properties, "app_lock", NULL );
242                 void ( *unlock )( void ) = mlt_properties_get_data( properties, "app_unlock", NULL );
243
244                 if ( app_locked && unlock ) unlock( );
245
246                 // Kill the thread and clean up
247                 this->running = 0;
248
249                 pthread_mutex_lock( &this->refresh_mutex );
250                 pthread_cond_broadcast( &this->refresh_cond );
251                 pthread_mutex_unlock( &this->refresh_mutex );
252 #ifndef WIN32
253                 if ( this->thread )
254 #endif
255                         pthread_join( this->thread, NULL );
256                 this->joined = 1;
257
258                 if ( app_locked && lock ) lock( );
259                 
260                 pthread_mutex_lock( &mlt_sdl_mutex );
261                 SDL_Quit( );
262                 pthread_mutex_unlock( &mlt_sdl_mutex );
263         }
264
265         return 0;
266 }
267
268 static int consumer_is_stopped( mlt_consumer parent )
269 {
270         consumer_sdl this = parent->child;
271         return !this->running;
272 }
273
274 static void *consumer_thread( void *arg )
275 {
276         // Identify the arg
277         consumer_sdl this = arg;
278
279         // Get the consumer
280         mlt_consumer consumer = &this->parent;
281
282         // Get the properties
283         mlt_properties properties = MLT_CONSUMER_PROPERTIES( consumer );
284
285         // internal intialization
286         int first = 1;
287         mlt_frame frame = NULL;
288         int last_position = -1;
289         int eos = 0;
290         int eos_threshold = 20;
291         if ( this->play )
292                 eos_threshold = eos_threshold + mlt_properties_get_int( MLT_CONSUMER_PROPERTIES( this->play ), "buffer" );
293
294         // Determine if the application is dealing with the preview
295         int preview_off = mlt_properties_get_int( properties, "preview_off" );
296
297         pthread_mutex_lock( &this->refresh_mutex );
298         this->refresh_count = 0;
299         pthread_mutex_unlock( &this->refresh_mutex );
300
301         // Loop until told not to
302         while( this->running )
303         {
304                 // Get a frame from the attached producer
305                 frame = mlt_consumer_get_frame( consumer );
306
307                 // Ensure that we have a frame
308                 if ( this->running && frame != NULL )
309                 {
310                         // Get the speed of the frame
311                         double speed = mlt_properties_get_double( MLT_FRAME_PROPERTIES( frame ), "_speed" );
312
313                         // Lock during the operation
314                         mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
315
316                         // Get refresh request for the current frame
317                         int refresh = mlt_properties_get_int( properties, "refresh" );
318
319                         // Decrement refresh and clear changed
320                         mlt_events_block( properties, properties );
321                         mlt_properties_set_int( properties, "refresh", 0 );
322                         mlt_events_unblock( properties, properties );
323
324                         // Unlock after the operation
325                         mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
326
327                         // Set the changed property on this frame for the benefit of still
328                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", refresh );
329
330                         // Make sure the recipient knows that this frame isn't really rendered
331                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "rendered", 0 );
332
333                         // Optimisation to reduce latency
334                         if ( speed == 1.0 )
335                         {
336                                 if ( last_position != -1 && last_position + 1 != mlt_frame_get_position( frame ) )
337                                         mlt_consumer_purge( this->play );
338                                 last_position = mlt_frame_get_position( frame );
339                         }
340                         else
341                         {
342                                 //mlt_consumer_purge( this->play );
343                                 last_position = -1;
344                         }
345
346                         // If we aren't playing normally, then use the still
347                         if ( speed != 1 )
348                         {
349                                 mlt_producer producer = MLT_PRODUCER( mlt_service_get_producer( MLT_CONSUMER_SERVICE( consumer ) ) );
350                                 mlt_position duration = producer? mlt_producer_get_playtime( producer ) : -1;
351                                 int pause = 0;
352
353 #ifndef SKIP_WAIT_EOS
354                                 if ( this->active == this->play )
355                                 {
356                                         // Do not interrupt the play consumer near the end
357                                         if ( duration - this->last_position > eos_threshold )
358                                         {
359                                                 // Get a new frame at the sought position
360                                                 mlt_frame_close( frame );
361                                                 if ( producer )
362                                                         mlt_producer_seek( producer, this->last_position );
363                                                 frame = mlt_consumer_get_frame( consumer );
364                                                 pause = 1;
365                                         }
366                                         else
367                                         {
368                                                 // Send frame with speed 0 to stop it
369                                                 if ( frame && !mlt_consumer_is_stopped( this->play ) )
370                                                 {
371                                                         mlt_consumer_put_frame( this->play, frame );
372                                                         frame = NULL;
373                                                         eos = 1;
374                                                 }
375
376                                                 // Check for end of stream
377                                                 if ( mlt_consumer_is_stopped( this->play ) )
378                                                 {
379                                                         // Stream has ended
380                                                         mlt_log_verbose( MLT_CONSUMER_SERVICE( consumer ), "END OF STREAM\n" );
381                                                         pause = 1;
382                                                         eos = 0; // reset eos indicator
383                                                 }
384                                                 else
385                                                 {
386                                                         // Prevent a tight busy loop
387                                                         struct timespec tm = { 0, 100000L }; // 100 usec
388                                                         nanosleep( &tm, NULL );
389                                                 }
390                                         }
391                                 }
392 #else
393                                 pause = this->active == this->play;
394 #endif
395                                 if ( pause )
396                                 {
397                                         // Start the still consumer
398                                         mlt_consumer_stop( this->play );
399                                         this->last_speed = speed;
400                                         this->active = this->still;
401                                         this->ignore_change = 0;
402                                         mlt_consumer_start( this->still );
403                                 }
404                                 // Send the frame to the active child
405                                 if ( frame && !eos )
406                                 {
407                                         mlt_properties_set_int( MLT_FRAME_PROPERTIES( frame ), "refresh", 1 );
408                                         mlt_consumer_put_frame( this->active, frame );
409                                 }
410                                 if ( pause && speed == 0.0 )
411                                 {
412                                         mlt_events_fire( properties, "consumer-sdl-paused", NULL );
413                                 }
414                         }
415                         // Allow a little grace time before switching consumers on speed changes
416                         else if ( this->ignore_change -- > 0 && this->active != NULL && !mlt_consumer_is_stopped( this->active ) )
417                         {
418                                 mlt_consumer_put_frame( this->active, frame );
419                         }
420                         // Otherwise use the normal player
421                         else
422                         {
423                                 if ( !mlt_consumer_is_stopped( this->still ) )
424                                         mlt_consumer_stop( this->still );
425                                 if ( mlt_consumer_is_stopped( this->play ) )
426                                 {
427                                         this->last_speed = speed;
428                                         this->active = this->play;
429                                         this->ignore_change = 0;
430                                         mlt_consumer_start( this->play );
431                                 }
432                                 mlt_consumer_put_frame( this->play, frame );
433                         }
434
435                         // Copy the rectangle info from the active consumer
436                         if ( this->running && preview_off == 0 )
437                         {
438                                 mlt_properties active = MLT_CONSUMER_PROPERTIES( this->active );
439                                 mlt_service_lock( MLT_CONSUMER_SERVICE( consumer ) );
440                                 mlt_properties_set_int( properties, "rect_x", mlt_properties_get_int( active, "rect_x" ) );
441                                 mlt_properties_set_int( properties, "rect_y", mlt_properties_get_int( active, "rect_y" ) );
442                                 mlt_properties_set_int( properties, "rect_w", mlt_properties_get_int( active, "rect_w" ) );
443                                 mlt_properties_set_int( properties, "rect_h", mlt_properties_get_int( active, "rect_h" ) );
444                                 mlt_service_unlock( MLT_CONSUMER_SERVICE( consumer ) );
445                         }
446
447                         if ( this->active == this->still )
448                         {
449                                 pthread_mutex_lock( &this->refresh_mutex );
450                                 if ( this->running && speed == 0 && this->refresh_count <= 0 )
451                                 {
452                                         mlt_events_fire( properties, "consumer-sdl-paused", NULL );
453                                         pthread_cond_wait( &this->refresh_cond, &this->refresh_mutex );
454                                 }
455                                 this->refresh_count --;
456                                 pthread_mutex_unlock( &this->refresh_mutex );
457                         }
458
459                         // We are definitely not waiting on the first frame any more
460                         first = 0;
461                 }
462                 else
463                 {
464                         if ( frame ) mlt_frame_close( frame );
465                         mlt_consumer_put_frame( this->active, NULL );
466                         this->running = 0;
467                 }
468         }
469
470         if ( this->play ) mlt_consumer_stop( this->play );
471         if ( this->still ) mlt_consumer_stop( this->still );
472
473         return NULL;
474 }
475
476 /** Callback to allow override of the close method.
477 */
478
479 static void consumer_close( mlt_consumer parent )
480 {
481         // Get the actual object
482         consumer_sdl this = parent->child;
483
484         // Stop the consumer
485         mlt_consumer_stop( parent );
486
487         // Close the child consumers
488         mlt_consumer_close( this->play );
489         mlt_consumer_close( this->still );
490
491         // Now clean up the rest
492         mlt_consumer_close( parent );
493
494         // Finally clean up this
495         free( this );
496 }