]> git.sesse.net Git - mlt/blob - src/framework/mlt_playlist.c
Cloning optimisations and introduction of the service parser
[mlt] / src / framework / mlt_playlist.c
1 /*
2  * mlt_playlist.c -- playlist service class
3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
4  * Author: Charles Yates <charles.yates@pandora.be>
5  *
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.
10  *
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.
15  *
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.
19  */
20
21 #include "config.h"
22
23 #include "mlt_playlist.h"
24 #include "mlt_tractor.h"
25 #include "mlt_multitrack.h"
26 #include "mlt_field.h"
27 #include "mlt_frame.h"
28 #include "mlt_transition.h"
29
30 #include <stdio.h>
31 #include <stdlib.h>
32 #include <string.h>
33
34 /** Virtual playlist entry.
35 */
36
37 typedef struct playlist_entry_s
38 {
39         mlt_producer producer;
40         mlt_position frame_in;
41         mlt_position frame_out;
42         mlt_position frame_count;
43         int repeat;
44         mlt_position producer_length;
45         mlt_event event;
46         int preservation_hack;
47 }
48 playlist_entry;
49
50 /** Private definition.
51 */
52
53 struct mlt_playlist_s
54 {
55         struct mlt_producer_s parent;
56         struct mlt_producer_s blank;
57
58         int size;
59         int count;
60         playlist_entry **list;
61 };
62
63 /** Forward declarations
64 */
65
66 static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index );
67 static int mlt_playlist_unmix( mlt_playlist this, int clip );
68 static int mlt_playlist_resize_mix( mlt_playlist this, int clip, int in, int out );
69
70 /** Constructor.
71 */
72
73 mlt_playlist mlt_playlist_init( )
74 {
75         mlt_playlist this = calloc( sizeof( struct mlt_playlist_s ), 1 );
76         if ( this != NULL )
77         {
78                 mlt_producer producer = &this->parent;
79
80                 // Construct the producer
81                 mlt_producer_init( producer, this );
82
83                 // Override the producer get_frame
84                 producer->get_frame = producer_get_frame;
85
86                 // Define the destructor
87                 producer->close = ( mlt_destructor )mlt_playlist_close;
88                 producer->close_object = this;
89
90                 // Initialise blank
91                 mlt_producer_init( &this->blank, NULL );
92                 mlt_properties_set( mlt_producer_properties( &this->blank ), "mlt_service", "blank" );
93                 mlt_properties_set( mlt_producer_properties( &this->blank ), "resource", "blank" );
94
95                 // Indicate that this producer is a playlist
96                 mlt_properties_set_data( mlt_playlist_properties( this ), "playlist", this, 0, NULL, NULL );
97
98                 // Specify the eof condition
99                 mlt_properties_set( mlt_playlist_properties( this ), "eof", "pause" );
100                 mlt_properties_set( mlt_playlist_properties( this ), "resource", "<playlist>" );
101                 mlt_properties_set( mlt_playlist_properties( this ), "mlt_type", "mlt_producer" );
102                 mlt_properties_set_position( mlt_playlist_properties( this ), "in", 0 );
103                 mlt_properties_set_position( mlt_playlist_properties( this ), "out", 0 );
104                 mlt_properties_set_position( mlt_playlist_properties( this ), "length", 0 );
105
106                 this->size = 10;
107                 this->list = malloc( this->size * sizeof( playlist_entry * ) );
108         }
109         
110         return this;
111 }
112
113 /** Get the producer associated to this playlist.
114 */
115
116 mlt_producer mlt_playlist_producer( mlt_playlist this )
117 {
118         return this != NULL ? &this->parent : NULL;
119 }
120
121 /** Get the service associated to this playlist.
122 */
123
124 mlt_service mlt_playlist_service( mlt_playlist this )
125 {
126         return mlt_producer_service( &this->parent );
127 }
128
129 /** Get the propertues associated to this playlist.
130 */
131
132 mlt_properties mlt_playlist_properties( mlt_playlist this )
133 {
134         return mlt_producer_properties( &this->parent );
135 }
136
137 /** Refresh the playlist after a clip has been changed.
138 */
139
140 static int mlt_playlist_virtual_refresh( mlt_playlist this )
141 {
142         // Obtain the properties
143         mlt_properties properties = mlt_playlist_properties( this );
144
145         // Get the fps of the first producer
146         double fps = mlt_properties_get_double( properties, "first_fps" );
147         int i = 0;
148         mlt_position frame_count = 0;
149
150         for ( i = 0; i < this->count; i ++ )
151         {
152                 // Get the producer
153                 mlt_producer producer = this->list[ i ]->producer;
154                 int current_length = mlt_producer_get_out( producer ) - mlt_producer_get_in( producer ) + 1;
155
156                 // If fps is 0
157                 if ( fps == 0 )
158                 {
159                         // Inherit it from the producer
160                         fps = mlt_producer_get_fps( producer );
161                 }
162                 else if ( fps != mlt_properties_get_double( mlt_producer_properties( producer ), "fps" ) )
163                 {
164                         // Generate a warning for now - the following attempt to fix may fail
165                         fprintf( stderr, "Warning: fps mismatch on playlist producer %d\n", this->count );
166
167                         // It should be safe to impose fps on an image producer, but not necessarily safe for video
168                         mlt_properties_set_double( mlt_producer_properties( producer ), "fps", fps );
169                 }
170
171                 // Check if the length of the producer has changed
172                 if ( this->list[ i ]->producer != &this->blank &&
173                          ( this->list[ i ]->frame_in != mlt_producer_get_in( producer ) ||
174                            this->list[ i ]->frame_out != mlt_producer_get_out( producer ) ) )
175                 {
176                         // This clip should be removed...
177                         if ( current_length < 1 )
178                         {
179                                 this->list[ i ]->frame_in = 0;
180                                 this->list[ i ]->frame_out = -1;
181                                 this->list[ i ]->frame_count = 0;
182                         }
183                         else 
184                         {
185                                 this->list[ i ]->frame_in = mlt_producer_get_in( producer );
186                                 this->list[ i ]->frame_out = mlt_producer_get_out( producer );
187                                 this->list[ i ]->frame_count = current_length;
188                         }
189
190                         // Update the producer_length
191                         this->list[ i ]->producer_length = current_length;
192                 }
193
194                 // Calculate the frame_count
195                 this->list[ i ]->frame_count = ( this->list[ i ]->frame_out - this->list[ i ]->frame_in + 1 ) * this->list[ i ]->repeat;
196
197                 // Update the frame_count for this clip
198                 frame_count += this->list[ i ]->frame_count;
199         }
200
201         // Refresh all properties
202         mlt_properties_set_double( properties, "first_fps", fps );
203         mlt_properties_set_double( properties, "fps", fps == 0 ? 25 : fps );
204         mlt_events_block( properties, properties );
205         mlt_properties_set_position( properties, "length", frame_count );
206         mlt_events_unblock( properties, properties );
207         mlt_properties_set_position( properties, "out", frame_count - 1 );
208
209         return 0;
210 }
211
212 /** Listener for producers on the playlist.
213 */
214
215 static void mlt_playlist_listener( mlt_producer producer, mlt_playlist this )
216 {
217         mlt_playlist_virtual_refresh( this );
218 }
219
220 /** Append to the virtual playlist.
221 */
222
223 static int mlt_playlist_virtual_append( mlt_playlist this, mlt_producer source, mlt_position in, mlt_position out )
224 {
225         char *resource = source != NULL ? mlt_properties_get( mlt_producer_properties( source ), "resource" ) : NULL;
226         mlt_producer producer = NULL;
227         mlt_properties properties = NULL;
228         mlt_properties parent = NULL;
229
230         // If we have a cut, then use the in/out points from the cut
231         if ( resource == NULL || !strcmp( resource, "blank" ) )
232         {
233                 producer = &this->blank;
234                 properties = mlt_producer_properties( producer );
235                 mlt_properties_inc_ref( properties );
236         }
237         else if ( mlt_producer_is_cut( source ) )
238         {
239                 producer = source;
240                 if ( in == -1 )
241                         in = mlt_producer_get_in( producer );
242                 if ( out == -1 || out > mlt_producer_get_out( producer ) )
243                         out = mlt_producer_get_out( producer );
244                 properties = mlt_producer_properties( producer );
245                 mlt_properties_inc_ref( properties );
246         }
247         else
248         {
249                 producer = mlt_producer_cut( source, in, out );
250                 if ( in == -1 || in < mlt_producer_get_in( producer ) )
251                         in = mlt_producer_get_in( producer );
252                 if ( out == -1 || out > mlt_producer_get_out( producer ) )
253                         out = mlt_producer_get_out( producer );
254                 properties = mlt_producer_properties( producer );
255         }
256
257         // Fetch the cuts parent properties
258         parent = mlt_producer_properties( mlt_producer_cut_parent( producer ) );
259
260         // Check that we have room
261         if ( this->count >= this->size )
262         {
263                 int i;
264                 this->list = realloc( this->list, ( this->size + 10 ) * sizeof( playlist_entry * ) );
265                 for ( i = this->size; i < this->size + 10; i ++ ) this->list[ i ] = NULL;
266                 this->size += 10;
267         }
268
269         // Create the entry
270         this->list[ this->count ] = calloc( sizeof( playlist_entry ), 1 );
271         if ( this->list[ this->count ] != NULL )
272         {
273                 this->list[ this->count ]->producer = producer;
274                 this->list[ this->count ]->frame_in = in;
275                 this->list[ this->count ]->frame_out = out;
276                 this->list[ this->count ]->frame_count = out - in + 1;
277                 this->list[ this->count ]->repeat = 1;
278                 this->list[ this->count ]->producer_length = mlt_producer_get_out( producer ) - mlt_producer_get_in( producer ) + 1;
279                 this->list[ this->count ]->event = mlt_events_listen( parent, this, "producer-changed", ( mlt_listener )mlt_playlist_listener );
280                 mlt_event_inc_ref( this->list[ this->count ]->event );
281                 mlt_properties_set( properties, "eof", "pause" );
282                 mlt_producer_set_speed( producer, 0 );
283                 this->count ++;
284         }
285
286         return mlt_playlist_virtual_refresh( this );
287 }
288
289 /** Seek in the virtual playlist.
290 */
291
292 static mlt_service mlt_playlist_virtual_seek( mlt_playlist this )
293 {
294         // Default producer to blank
295         mlt_producer producer = NULL;
296
297         // Map playlist position to real producer in virtual playlist
298         mlt_position position = mlt_producer_frame( &this->parent );
299
300         mlt_position original = position;
301
302         // Total number of frames
303         int64_t total = 0;
304
305         // Get the properties
306         mlt_properties properties = mlt_playlist_properties( this );
307
308         // Get the eof handling
309         char *eof = mlt_properties_get( properties, "eof" );
310
311         // Index for the main loop
312         int i = 0;
313
314         // Loop for each producer until found
315         for ( i = 0; i < this->count; i ++ )
316         {
317                 // Increment the total
318                 total += this->list[ i ]->frame_count;
319
320                 // Check if the position indicates that we have found the clip
321                 // Note that 0 length clips get skipped automatically
322                 if ( position < this->list[ i ]->frame_count )
323                 {
324                         // Found it, now break
325                         producer = this->list[ i ]->producer;
326                         break;
327                 }
328                 else
329                 {
330                         // Decrement position by length of this entry
331                         position -= this->list[ i ]->frame_count;
332                 }
333         }
334
335         // Seek in real producer to relative position
336         if ( producer != NULL )
337         {
338                 int count = this->list[ i ]->frame_count / this->list[ i ]->repeat;
339                 mlt_producer_seek( producer, position % count );
340         }
341         else if ( !strcmp( eof, "pause" ) && total > 0 )
342         {
343                 playlist_entry *entry = this->list[ this->count - 1 ];
344                 mlt_producer this_producer = mlt_playlist_producer( this );
345                 mlt_producer_seek( this_producer, original - 1 );
346                 producer = entry->producer;
347                 mlt_producer_seek( producer, entry->frame_out );
348                 mlt_producer_set_speed( this_producer, 0 );
349                 mlt_producer_set_speed( producer, 0 );
350         }
351         else if ( !strcmp( eof, "loop" ) && total > 0 )
352         {
353                 playlist_entry *entry = this->list[ 0 ];
354                 mlt_producer this_producer = mlt_playlist_producer( this );
355                 mlt_producer_seek( this_producer, 0 );
356                 producer = entry->producer;
357                 mlt_producer_seek( producer, 0 );
358         }
359         else
360         {
361                 producer = &this->blank;
362         }
363
364         return mlt_producer_service( producer );
365 }
366
367 /** Invoked when a producer indicates that it has prematurely reached its end.
368 */
369
370 static mlt_producer mlt_playlist_virtual_set_out( mlt_playlist this )
371 {
372         // Default producer to blank
373         mlt_producer producer = &this->blank;
374
375         // Map playlist position to real producer in virtual playlist
376         mlt_position position = mlt_producer_frame( &this->parent );
377
378         // Loop through the virtual playlist
379         int i = 0;
380
381         for ( i = 0; i < this->count; i ++ )
382         {
383                 if ( position < this->list[ i ]->frame_count )
384                 {
385                         // Found it, now break
386                         producer = this->list[ i ]->producer;
387                         break;
388                 }
389                 else
390                 {
391                         // Decrement position by length of this entry
392                         position -= this->list[ i ]->frame_count;
393                 }
394         }
395
396         // Seek in real producer to relative position
397         if ( i < this->count && this->list[ i ]->frame_out != position )
398         {
399                 // Update the frame_count for the changed clip (hmmm)
400                 this->list[ i ]->frame_out = position;
401                 this->list[ i ]->frame_count = this->list[ i ]->frame_out - this->list[ i ]->frame_in + 1;
402
403                 // Refresh the playlist
404                 mlt_playlist_virtual_refresh( this );
405         }
406
407         return producer;
408 }
409
410 /** Obtain the current clips index.
411 */
412
413 int mlt_playlist_current_clip( mlt_playlist this )
414 {
415         // Map playlist position to real producer in virtual playlist
416         mlt_position position = mlt_producer_frame( &this->parent );
417
418         // Loop through the virtual playlist
419         int i = 0;
420
421         for ( i = 0; i < this->count; i ++ )
422         {
423                 if ( position < this->list[ i ]->frame_count )
424                 {
425                         // Found it, now break
426                         break;
427                 }
428                 else
429                 {
430                         // Decrement position by length of this entry
431                         position -= this->list[ i ]->frame_count;
432                 }
433         }
434
435         return i;
436 }
437
438 /** Obtain the current clips producer.
439 */
440
441 mlt_producer mlt_playlist_current( mlt_playlist this )
442 {
443         int i = mlt_playlist_current_clip( this );
444         if ( i < this->count )
445                 return this->list[ i ]->producer;
446         else
447                 return &this->blank;
448 }
449
450 /** Get the position which corresponds to the start of the next clip.
451 */
452
453 mlt_position mlt_playlist_clip( mlt_playlist this, mlt_whence whence, int index )
454 {
455         mlt_position position = 0;
456         int absolute_clip = index;
457         int i = 0;
458
459         // Determine the absolute clip
460         switch ( whence )
461         {
462                 case mlt_whence_relative_start:
463                         absolute_clip = index;
464                         break;
465
466                 case mlt_whence_relative_current:
467                         absolute_clip = mlt_playlist_current_clip( this ) + index;
468                         break;
469
470                 case mlt_whence_relative_end:
471                         absolute_clip = this->count - index;
472                         break;
473         }
474
475         // Check that we're in a valid range
476         if ( absolute_clip < 0 )
477                 absolute_clip = 0;
478         else if ( absolute_clip > this->count )
479                 absolute_clip = this->count;
480
481         // Now determine the position
482         for ( i = 0; i < absolute_clip; i ++ )
483                 position += this->list[ i ]->frame_count;
484
485         return position;
486 }
487
488 /** Get all the info about the clip specified.
489 */
490
491 int mlt_playlist_get_clip_info( mlt_playlist this, mlt_playlist_clip_info *info, int index )
492 {
493         int error = index < 0 || index >= this->count;
494         memset( info, 0, sizeof( mlt_playlist_clip_info ) );
495         if ( !error )
496         {
497                 mlt_producer producer = mlt_producer_cut_parent( this->list[ index ]->producer );
498                 mlt_properties properties = mlt_producer_properties( producer );
499                 info->clip = index;
500                 info->producer = producer;
501                 info->cut = this->list[ index ]->producer;
502                 info->start = mlt_playlist_clip( this, mlt_whence_relative_start, index );
503                 info->resource = mlt_properties_get( properties, "resource" );
504                 info->frame_in = this->list[ index ]->frame_in;
505                 info->frame_out = this->list[ index ]->frame_out;
506                 info->frame_count = this->list[ index ]->frame_count;
507                 info->repeat = this->list[ index ]->repeat;
508                 info->length = mlt_producer_get_length( producer );
509                 info->fps = mlt_producer_get_fps( producer );
510         }
511
512         return error;
513 }
514
515 /** Get number of clips in the playlist.
516 */
517
518 int mlt_playlist_count( mlt_playlist this )
519 {
520         return this->count;
521 }
522
523 /** Clear the playlist.
524 */
525
526 int mlt_playlist_clear( mlt_playlist this )
527 {
528         int i;
529         for ( i = 0; i < this->count; i ++ )
530         {
531                 mlt_event_close( this->list[ i ]->event );
532                 mlt_producer_close( this->list[ i ]->producer );
533         }
534         this->count = 0;
535         mlt_properties_set_double( mlt_playlist_properties( this ), "first_fps", 0 );
536         return mlt_playlist_virtual_refresh( this );
537 }
538
539 /** Append a producer to the playlist.
540 */
541
542 int mlt_playlist_append( mlt_playlist this, mlt_producer producer )
543 {
544         // Append to virtual list
545         return mlt_playlist_virtual_append( this, producer, 0, mlt_producer_get_playtime( producer ) - 1 );
546 }
547
548 /** Append a producer to the playlist with in/out points.
549 */
550
551 int mlt_playlist_append_io( mlt_playlist this, mlt_producer producer, mlt_position in, mlt_position out )
552 {
553         // Append to virtual list
554         if ( in != -1 && out != -1 )
555                 return mlt_playlist_virtual_append( this, producer, in, out );
556         else
557                 return mlt_playlist_append( this, producer );
558 }
559
560 /** Append a blank to the playlist of a given length.
561 */
562
563 int mlt_playlist_blank( mlt_playlist this, mlt_position length )
564 {
565         // Append to the virtual list
566         return mlt_playlist_virtual_append( this, &this->blank, 0, length );
567 }
568
569 /** Insert a producer into the playlist.
570 */
571
572 int mlt_playlist_insert( mlt_playlist this, mlt_producer producer, int where, mlt_position in, mlt_position out )
573 {
574         // Append to end
575         mlt_events_block( mlt_playlist_properties( this ), this );
576         mlt_playlist_append_io( this, producer, in, out );
577
578         // Move to the position specified
579         mlt_playlist_move( this, this->count - 1, where );
580         mlt_events_unblock( mlt_playlist_properties( this ), this );
581
582         return mlt_playlist_virtual_refresh( this );
583 }
584
585 /** Remove an entry in the playlist.
586 */
587
588 int mlt_playlist_remove( mlt_playlist this, int where )
589 {
590         int error = where < 0 || where >= this->count;
591         if ( error == 0 && mlt_playlist_unmix( this, where ) != 0 )
592         {
593                 // We need to know the current clip and the position within the playlist
594                 int current = mlt_playlist_current_clip( this );
595                 mlt_position position = mlt_producer_position( mlt_playlist_producer( this ) );
596
597                 // We need all the details about the clip we're removing
598                 mlt_playlist_clip_info where_info;
599                 playlist_entry *entry = this->list[ where ];
600                 mlt_properties properties = mlt_producer_properties( entry->producer );
601
602                 // Loop variable
603                 int i = 0;
604
605                 // Get the clip info 
606                 mlt_playlist_get_clip_info( this, &where_info, where );
607
608                 // Make sure the clip to be removed is valid and correct if necessary
609                 if ( where < 0 ) 
610                         where = 0;
611                 if ( where >= this->count )
612                         where = this->count - 1;
613
614                 // Reorganise the list
615                 for ( i = where + 1; i < this->count; i ++ )
616                         this->list[ i - 1 ] = this->list[ i ];
617                 this->count --;
618
619                 if ( entry->preservation_hack == 0 )
620                 {
621                         // Decouple from mix_in/out if necessary
622                         if ( mlt_properties_get_data( properties, "mix_in", NULL ) != NULL )
623                         {
624                                 mlt_properties mix = mlt_properties_get_data( properties, "mix_in", NULL );
625                                 mlt_properties_set_data( mix, "mix_out", NULL, 0, NULL, NULL );
626                         }
627                         if ( mlt_properties_get_data( properties, "mix_out", NULL ) != NULL )
628                         {
629                                 mlt_properties mix = mlt_properties_get_data( properties, "mix_out", NULL );
630                                 mlt_properties_set_data( mix, "mix_in", NULL, 0, NULL, NULL );
631                         }
632         
633                         mlt_producer_clear( entry->producer );
634                 }
635
636                 // Close the producer associated to the clip info
637                 mlt_event_close( entry->event );
638                 mlt_producer_close( entry->producer );
639
640                 // Correct position
641                 if ( where == current )
642                         mlt_producer_seek( mlt_playlist_producer( this ), where_info.start );
643                 else if ( where < current && this->count > 0 )
644                         mlt_producer_seek( mlt_playlist_producer( this ), position - where_info.frame_count );
645                 else if ( this->count == 0 )
646                         mlt_producer_seek( mlt_playlist_producer( this ), 0 );
647
648                 // Free the entry
649                 free( entry );
650
651                 // Refresh the playlist
652                 mlt_playlist_virtual_refresh( this );
653         }
654
655         return error;
656 }
657
658 /** Move an entry in the playlist.
659 */
660
661 int mlt_playlist_move( mlt_playlist this, int src, int dest )
662 {
663         int i;
664
665         /* We need to ensure that the requested indexes are valid and correct it as necessary */
666         if ( src < 0 ) 
667                 src = 0;
668         if ( src >= this->count )
669                 src = this->count - 1;
670
671         if ( dest < 0 ) 
672                 dest = 0;
673         if ( dest >= this->count )
674                 dest = this->count - 1;
675         
676         if ( src != dest && this->count > 1 )
677         {
678                 int current = mlt_playlist_current_clip( this );
679                 mlt_position position = mlt_producer_position( mlt_playlist_producer( this ) );
680                 playlist_entry *src_entry = NULL;
681
682                 // We need all the details about the current clip
683                 mlt_playlist_clip_info current_info;
684
685                 mlt_playlist_get_clip_info( this, &current_info, current );
686                 position -= current_info.start;
687
688                 if ( current == src )
689                         current = dest;
690                 else if ( current > src && current < dest )
691                         current ++;
692                 else if ( current == dest )
693                         current = src;
694
695                 src_entry = this->list[ src ];
696                 if ( src > dest )
697                 {
698                         for ( i = src; i > dest; i -- )
699                                 this->list[ i ] = this->list[ i - 1 ];
700                 }
701                 else
702                 {
703                         for ( i = src; i < dest; i ++ )
704                                 this->list[ i ] = this->list[ i + 1 ];
705                 }
706                 this->list[ dest ] = src_entry;
707
708                 mlt_playlist_get_clip_info( this, &current_info, current );
709                 mlt_producer_seek( mlt_playlist_producer( this ), current_info.start + position );
710                 mlt_playlist_virtual_refresh( this );
711         }
712
713         return 0;
714 }
715
716 /** Repeat the specified clip n times.
717 */
718
719 int mlt_playlist_repeat_clip( mlt_playlist this, int clip, int repeat )
720 {
721         int error = repeat < 1 || clip < 0 || clip >= this->count;
722         if ( error == 0 )
723         {
724                 playlist_entry *entry = this->list[ clip ];
725                 entry->repeat = repeat;
726                 mlt_playlist_virtual_refresh( this );
727         }
728         return error;
729 }
730
731 /** Resize the specified clip.
732 */
733
734 int mlt_playlist_resize_clip( mlt_playlist this, int clip, mlt_position in, mlt_position out )
735 {
736         int error = clip < 0 || clip >= this->count;
737         if ( error == 0 && mlt_playlist_resize_mix( this, clip, in, out ) != 0 )
738         {
739                 playlist_entry *entry = this->list[ clip ];
740                 mlt_producer producer = entry->producer;
741
742                 if ( in <= -1 )
743                         in = 0;
744                 if ( out <= -1 || out >= mlt_producer_get_length( producer ) )
745                         out = mlt_producer_get_length( producer ) - 1;
746
747                 if ( out < in )
748                 {
749                         mlt_position t = in;
750                         in = out;
751                         out = t;
752                 }
753
754                 mlt_producer_set_in_and_out( producer, in, out );
755         }
756         return error;
757 }
758
759 /** Split a clip on the playlist at the given position.
760 */
761
762 int mlt_playlist_split( mlt_playlist this, int clip, mlt_position position )
763 {
764         int error = clip < 0 || clip >= this->count;
765         if ( error == 0 )
766         {
767                 playlist_entry *entry = this->list[ clip ];
768                 if ( position >= 0 && position < entry->frame_count )
769                 {
770                         mlt_producer split = NULL;
771                         int in = entry->frame_in;
772                         int out = entry->frame_out;
773                         mlt_events_block( mlt_playlist_properties( this ), this );
774                         mlt_playlist_resize_clip( this, clip, in, in + position );
775                         split = mlt_producer_cut( entry->producer, in + position + 1, out );
776                         mlt_playlist_insert( this, split, clip + 1, 0, -1 );
777                         mlt_producer_close( split );
778                         mlt_events_unblock( mlt_playlist_properties( this ), this );
779                         mlt_events_fire( mlt_playlist_properties( this ), "producer-changed", NULL );
780                 }
781                 else
782                 {
783                         error = 1;
784                 }
785         }
786         return error;
787 }
788
789 /** Join 1 or more consecutive clips.
790 */
791
792 int mlt_playlist_join( mlt_playlist this, int clip, int count, int merge )
793 {
794         int error = clip < 0 || ( clip ) >= this->count;
795         if ( error == 0 )
796         {
797                 int i = clip;
798                 mlt_playlist new_clip = mlt_playlist_init( );
799                 mlt_events_block( mlt_playlist_properties( this ), this );
800                 if ( clip + count >= this->count )
801                         count = this->count - clip;
802                 for ( i = 0; i <= count; i ++ )
803                 {
804                         playlist_entry *entry = this->list[ clip ];
805                         mlt_playlist_append( new_clip, entry->producer );
806                         mlt_playlist_repeat_clip( new_clip, i, entry->repeat );
807                         entry->preservation_hack = 1;
808                         mlt_playlist_remove( this, clip );
809                 }
810                 mlt_events_unblock( mlt_playlist_properties( this ), this );
811                 mlt_playlist_insert( this, mlt_playlist_producer( new_clip ), clip, 0, -1 );
812                 mlt_playlist_close( new_clip );
813         }
814         return error;
815 }
816
817 /** Mix consecutive clips for a specified length and apply transition if specified.
818 */
819
820 int mlt_playlist_mix( mlt_playlist this, int clip, int length, mlt_transition transition )
821 {
822         int error = ( clip < 0 || clip + 1 >= this->count );
823         if ( error == 0 )
824         {
825                 playlist_entry *clip_a = this->list[ clip ];
826                 playlist_entry *clip_b = this->list[ clip + 1 ];
827                 mlt_producer track_a;
828                 mlt_producer track_b;
829                 mlt_tractor tractor = mlt_tractor_new( );
830                 mlt_events_block( mlt_playlist_properties( this ), this );
831
832                 // TODO: Check length is valid for both clips and resize if necessary.
833
834                 // Create the a and b tracks/cuts
835                 track_a = mlt_producer_cut( clip_a->producer, clip_a->frame_out - length + 1, clip_a->frame_out );
836                 track_b = mlt_producer_cut( clip_b->producer, clip_b->frame_in, clip_b->frame_in + length - 1 );
837
838                 // Set the tracks on the tractor
839                 mlt_tractor_set_track( tractor, track_a, 0 );
840                 mlt_tractor_set_track( tractor, track_b, 1 );
841
842                 // Insert the mix object into the playlist
843                 mlt_playlist_insert( this, mlt_tractor_producer( tractor ), clip + 1, -1, -1 );
844                 mlt_properties_set_data( mlt_tractor_properties( tractor ), "mlt_mix", tractor, 0, NULL, NULL );
845
846                 // Attach the transition
847                 if ( transition != NULL )
848                 {
849                         mlt_field field = mlt_tractor_field( tractor );
850                         mlt_field_plant_transition( field, transition, 0, 1 );
851                         mlt_transition_set_in_and_out( transition, 0, length - 1 );
852                 }
853
854                 // Check if we have anything left on the right hand clip
855                 if ( clip_b->frame_out - clip_b->frame_in > length )
856                 {
857                         mlt_playlist_resize_clip( this, clip + 2, clip_b->frame_in + length, clip_b->frame_out );
858                         mlt_properties_set_data( mlt_producer_properties( clip_b->producer ), "mix_in", tractor, 0, NULL, NULL );
859                         mlt_properties_set_data( mlt_tractor_properties( tractor ), "mix_out", clip_b->producer, 0, NULL, NULL );
860                 }
861                 else
862                 {
863                         mlt_producer_clear( clip_b->producer );
864                         mlt_playlist_remove( this, clip + 2 );
865                 }
866
867                 // Check if we have anything left on the left hand clip
868                 if ( clip_a->frame_out - clip_a->frame_in > length )
869                 {
870                         mlt_playlist_resize_clip( this, clip, clip_a->frame_in, clip_a->frame_out - length );
871                         mlt_properties_set_data( mlt_producer_properties( clip_a->producer ), "mix_out", tractor, 0, NULL, NULL );
872                         mlt_properties_set_data( mlt_tractor_properties( tractor ), "mix_in", clip_a->producer, 0, NULL, NULL );
873                 }
874                 else
875                 {
876                         mlt_producer_clear( clip_a->producer );
877                         mlt_playlist_remove( this, clip );
878                 }
879
880                 mlt_events_unblock( mlt_playlist_properties( this ), this );
881                 mlt_events_fire( mlt_playlist_properties( this ), "producer-changed", NULL );
882                 mlt_producer_close( track_a );
883                 mlt_producer_close( track_b );
884                 mlt_tractor_close( tractor );
885         }
886         return error;
887 }
888
889 /** Add a transition to an existing mix.
890 */
891
892 int mlt_playlist_mix_add( mlt_playlist this, int clip, mlt_transition transition )
893 {
894         mlt_producer producer = mlt_producer_cut_parent( mlt_playlist_get_clip( this, clip ) );
895         mlt_properties properties = producer != NULL ? mlt_producer_properties( producer ) : NULL;
896         mlt_tractor tractor = properties != NULL ? mlt_properties_get_data( properties, "mlt_mix", NULL ) : NULL;
897         int error = transition == NULL || tractor == NULL;
898         if ( error == 0 )
899         {
900                 mlt_field field = mlt_tractor_field( tractor );
901                 mlt_field_plant_transition( field, transition, 0, 1 );
902                 mlt_transition_set_in_and_out( transition, 0, this->list[ clip ]->frame_count - 1 );
903         }
904         return error;
905 }
906
907 /** Return the clip at the position.
908 */
909
910 mlt_producer mlt_playlist_get_clip( mlt_playlist this, int clip )
911 {
912         if ( clip >= 0 && clip < this->count )
913                 return this->list[ clip ]->producer;
914         return NULL;
915 }
916
917 /** Determine if the clip is a mix.
918 */
919
920 int mlt_playlist_clip_is_mix( mlt_playlist this, int clip )
921 {
922         mlt_producer producer = mlt_producer_cut_parent( mlt_playlist_get_clip( this, clip ) );
923         mlt_properties properties = producer != NULL ? mlt_producer_properties( producer ) : NULL;
924         mlt_tractor tractor = properties != NULL ? mlt_properties_get_data( properties, "mlt_mix", NULL ) : NULL;
925         return tractor != NULL;
926 }
927
928 /** Remove a mixed clip - ensure that the cuts included in the mix find their way
929         back correctly on to the playlist.
930 */
931
932 static int mlt_playlist_unmix( mlt_playlist this, int clip )
933 {
934         int error = ( clip < 0 || clip >= this->count ); 
935
936         // Ensure that the clip request is actually a mix
937         if ( error == 0 )
938         {
939                 mlt_producer producer = mlt_producer_cut_parent( this->list[ clip ]->producer );
940                 mlt_properties properties = mlt_producer_properties( producer );
941                 error = mlt_properties_get_data( properties, "mlt_mix", NULL ) == NULL;
942         }
943
944         if ( error == 0 )
945         {
946                 playlist_entry *mix = this->list[ clip ];
947                 mlt_tractor tractor = ( mlt_tractor )mlt_producer_cut_parent( mix->producer );
948                 mlt_properties properties = mlt_tractor_properties( tractor );
949                 mlt_producer clip_a = mlt_properties_get_data( properties, "mix_in", NULL );
950                 mlt_producer clip_b = mlt_properties_get_data( properties, "mix_out", NULL );
951                 int length = mlt_producer_get_playtime( mlt_tractor_producer( tractor ) );
952                 mlt_events_block( mlt_playlist_properties( this ), this );
953
954                 if ( clip_a != NULL )
955                 {
956                         mlt_producer_set_in_and_out( clip_a, mlt_producer_get_in( clip_a ), mlt_producer_get_out( clip_a ) + length );
957                 }
958                 else
959                 {
960                         mlt_producer cut = mlt_tractor_get_track( tractor, 0 );
961                         mlt_playlist_insert( this, cut, clip, -1, -1 );
962                         clip ++;
963                 }
964
965                 if ( clip_b != NULL )
966                 {
967                         mlt_producer_set_in_and_out( clip_b, mlt_producer_get_in( clip_b ) - length, mlt_producer_get_out( clip_b ) );
968                 }
969                 else
970                 {
971                         mlt_producer cut = mlt_tractor_get_track( tractor, 1 );
972                         mlt_playlist_insert( this, cut, clip + 1, -1, -1 );
973                 }
974
975                 mlt_properties_set_data( properties, "mlt_mix", NULL, 0, NULL, NULL );
976                 mlt_playlist_remove( this, clip );
977                 mlt_events_unblock( mlt_playlist_properties( this ), this );
978                 mlt_events_fire( mlt_playlist_properties( this ), "producer-changed", NULL );
979         }
980         return error;
981 }
982
983 static int mlt_playlist_resize_mix( mlt_playlist this, int clip, int in, int out )
984 {
985         int error = ( clip < 0 || clip >= this->count ); 
986
987         // Ensure that the clip request is actually a mix
988         if ( error == 0 )
989         {
990                 mlt_producer producer = mlt_producer_cut_parent( this->list[ clip ]->producer );
991                 mlt_properties properties = mlt_producer_properties( producer );
992                 error = mlt_properties_get_data( properties, "mlt_mix", NULL ) == NULL;
993         }
994
995         if ( error == 0 )
996         {
997                 playlist_entry *mix = this->list[ clip ];
998                 mlt_tractor tractor = ( mlt_tractor )mlt_producer_cut_parent( mix->producer );
999                 mlt_properties properties = mlt_tractor_properties( tractor );
1000                 mlt_producer clip_a = mlt_properties_get_data( properties, "mix_in", NULL );
1001                 mlt_producer clip_b = mlt_properties_get_data( properties, "mix_out", NULL );
1002                 mlt_producer track_a = mlt_tractor_get_track( tractor, 0 );
1003                 mlt_producer track_b = mlt_tractor_get_track( tractor, 1 );
1004                 int length = out - in + 1;
1005                 int length_diff = length - mlt_producer_get_playtime( mlt_tractor_producer( tractor ) );
1006                 mlt_events_block( mlt_playlist_properties( this ), this );
1007
1008                 if ( clip_a != NULL )
1009                         mlt_producer_set_in_and_out( clip_a, mlt_producer_get_in( clip_a ), mlt_producer_get_out( clip_a ) - length_diff );
1010
1011                 if ( clip_b != NULL )
1012                         mlt_producer_set_in_and_out( clip_b, mlt_producer_get_in( clip_b ) + length_diff, mlt_producer_get_out( clip_b ) );
1013
1014                 mlt_producer_set_in_and_out( track_a, mlt_producer_get_in( track_a ) - length_diff, mlt_producer_get_out( track_a ) );
1015                 mlt_producer_set_in_and_out( track_b, mlt_producer_get_in( track_b ), mlt_producer_get_out( track_b ) + length_diff );
1016                 mlt_producer_set_in_and_out( mlt_multitrack_producer( mlt_tractor_multitrack( tractor ) ), in, out );
1017                 mlt_producer_set_in_and_out( mlt_tractor_producer( tractor ), in, out );
1018                 mlt_properties_set_position( mlt_producer_properties( mix->producer ), "length", out - in + 1 );
1019                 mlt_producer_set_in_and_out( mix->producer, in, out );
1020
1021                 mlt_events_unblock( mlt_playlist_properties( this ), this );
1022                 mlt_playlist_virtual_refresh( this );
1023         }
1024         return error;
1025 }
1026
1027 /** Get the current frame.
1028 */
1029
1030 static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int index )
1031 {
1032         // Get this mlt_playlist
1033         mlt_playlist this = producer->child;
1034
1035         // Get the real producer
1036         mlt_service real = mlt_playlist_virtual_seek( this );
1037
1038         // Get the frame
1039         mlt_service_get_frame( real, frame, index );
1040
1041         // Check if we're at the end of the clip
1042         mlt_properties properties = mlt_frame_properties( *frame );
1043         if ( mlt_properties_get_int( properties, "end_of_clip" ) )
1044                 mlt_playlist_virtual_set_out( this );
1045
1046         // Check for notifier and call with appropriate argument
1047         mlt_properties playlist_properties = mlt_producer_properties( producer );
1048         void ( *notifier )( void * ) = mlt_properties_get_data( playlist_properties, "notifier", NULL );
1049         if ( notifier != NULL )
1050         {
1051                 void *argument = mlt_properties_get_data( playlist_properties, "notifier_arg", NULL );
1052                 notifier( argument );
1053         }
1054
1055         // Update position on the frame we're creating
1056         mlt_frame_set_position( *frame, mlt_producer_frame( producer ) );
1057
1058         // Position ourselves on the next frame
1059         mlt_producer_prepare_next( producer );
1060
1061         return 0;
1062 }
1063
1064 /** Close the playlist.
1065 */
1066
1067 void mlt_playlist_close( mlt_playlist this )
1068 {
1069         if ( this != NULL && mlt_properties_dec_ref( mlt_playlist_properties( this ) ) <= 0 )
1070         {
1071                 int i = 0;
1072                 this->parent.close = NULL;
1073                 for ( i = 0; i < this->count; i ++ )
1074                 {
1075                         mlt_event_close( this->list[ i ]->event );
1076                         mlt_producer_close( this->list[ i ]->producer );
1077                         free( this->list[ i ] );
1078                 }
1079                 mlt_producer_close( &this->blank );
1080                 mlt_producer_close( &this->parent );
1081                 free( this->list );
1082                 free( this );
1083         }
1084 }