Tractor enhancements
[melted] / src / framework / mlt_playlist.c
index e79e43c..0e017ce 100644 (file)
@@ -25,6 +25,7 @@
 
 #include <stdio.h>
 #include <stdlib.h>
+#include <string.h>
 
 /** Virtual playlist entry.
 */
@@ -32,8 +33,9 @@
 typedef struct
 {
        mlt_producer producer;
-       mlt_timecode in;
-       mlt_timecode playtime;
+       mlt_position frame_in;
+       mlt_position frame_out;
+       mlt_position frame_count;
 }
 playlist_entry;
 
@@ -71,8 +73,28 @@ mlt_playlist mlt_playlist_init( )
                // Override the producer get_frame
                producer->get_frame = producer_get_frame;
 
+               // Define the destructor
+               producer->close = ( mlt_destructor )mlt_playlist_close;
+               producer->close_object = this;
+
                // Initialise blank
                mlt_producer_init( &this->blank, NULL );
+               mlt_properties_set( mlt_producer_properties( &this->blank ), "mlt_service", "blank" );
+               mlt_properties_set( mlt_producer_properties( &this->blank ), "resource", "blank" );
+
+               // Indicate that this producer is a playlist
+               mlt_properties_set_data( mlt_playlist_properties( this ), "playlist", this, 0, NULL, NULL );
+
+               // Specify the eof condition
+               mlt_properties_set( mlt_playlist_properties( this ), "eof", "pause" );
+               mlt_properties_set( mlt_playlist_properties( this ), "resource", "<playlist>" );
+               mlt_properties_set( mlt_playlist_properties( this ), "mlt_type", "mlt_producer" );
+               mlt_properties_set_position( mlt_playlist_properties( this ), "in", 0 );
+               mlt_properties_set_position( mlt_playlist_properties( this ), "out", 0 );
+               mlt_properties_set_position( mlt_playlist_properties( this ), "length", 0 );
+
+               this->size = 10;
+               this->list = malloc( this->size * sizeof( playlist_entry * ) );
        }
        
        return this;
@@ -83,7 +105,7 @@ mlt_playlist mlt_playlist_init( )
 
 mlt_producer mlt_playlist_producer( mlt_playlist this )
 {
-       return &this->parent;
+       return this != NULL ? &this->parent : NULL;
 }
 
 /** Get the service associated to this playlist.
@@ -102,106 +124,557 @@ mlt_properties mlt_playlist_properties( mlt_playlist this )
        return mlt_producer_properties( &this->parent );
 }
 
-/** Append to the virtual playlist.
+/** Refresh the playlist after a clip has been changed.
 */
 
-static int mlt_playlist_virtual_append( mlt_playlist this, mlt_producer producer, mlt_timecode in, mlt_timecode out )
+static int mlt_playlist_virtual_refresh( mlt_playlist this )
 {
+       int i = 0;
+
        // Get the fps of the first producer
        double fps = mlt_properties_get_double( mlt_playlist_properties( this ), "first_fps" );
+       mlt_position frame_count = 0;
 
-       // If fps is 0
-       if ( fps == 0 )
-       {
-               // Inherit it from the producer
-               fps = mlt_producer_get_fps( producer );
-       }
-       else if ( fps != mlt_properties_get_double( mlt_producer_properties( producer ), "fps" ) )
+       for ( i = 0; i < this->count; i ++ )
        {
-               // Generate a warning for now - the following attempt to fix may fail
-               fprintf( stderr, "Warning: fps mismatch on playlist producer %d\n", this->count );
+               // Get the producer
+               mlt_producer producer = this->list[ i ]->producer;
 
-               // It should be safe to impose fps on an image producer, but not necessarily safe for video
-               mlt_properties_set_double( mlt_producer_properties( producer ), "fps", fps );
+               // If fps is 0
+               if ( fps == 0 )
+               {
+                       // Inherit it from the producer
+                       fps = mlt_producer_get_fps( producer );
+               }
+               else if ( fps != mlt_properties_get_double( mlt_producer_properties( producer ), "fps" ) )
+               {
+                       // Generate a warning for now - the following attempt to fix may fail
+                       fprintf( stderr, "Warning: fps mismatch on playlist producer %d\n", this->count );
+
+                       // It should be safe to impose fps on an image producer, but not necessarily safe for video
+                       mlt_properties_set_double( mlt_producer_properties( producer ), "fps", fps );
+               }
+
+               // Update the frame_count for this clip
+               frame_count += this->list[ i ]->frame_count;
        }
 
+       // Refresh all properties
+       mlt_properties_set_double( mlt_playlist_properties( this ), "first_fps", fps );
+       mlt_properties_set_double( mlt_playlist_properties( this ), "fps", fps == 0 ? 25 : fps );
+       mlt_properties_set_position( mlt_playlist_properties( this ), "length", frame_count );
+       mlt_properties_set_position( mlt_playlist_properties( this ), "out", frame_count - 1 );
+
+       return 0;
+}
+
+/** Append to the virtual playlist.
+*/
+
+static int mlt_playlist_virtual_append( mlt_playlist this, mlt_producer producer, mlt_position in, mlt_position out )
+{
        // Check that we have room
        if ( this->count >= this->size )
        {
                int i;
                this->list = realloc( this->list, ( this->size + 10 ) * sizeof( playlist_entry * ) );
-               for ( i = this->size; i < this->size + 10; i ++ )
-                       this->list[ i ] = NULL;
+               for ( i = this->size; i < this->size + 10; i ++ ) this->list[ i ] = NULL;
                this->size += 10;
        }
 
        this->list[ this->count ] = calloc( sizeof( playlist_entry ), 1 );
        this->list[ this->count ]->producer = producer;
-       this->list[ this->count ]->in = in;
-       this->list[ this->count ]->playtime = out - in;
+       this->list[ this->count ]->frame_in = in;
+       this->list[ this->count ]->frame_out = out;
+       this->list[ this->count ]->frame_count = out - in + 1;
+
+       mlt_properties_set( mlt_producer_properties( producer ), "eof", "pause" );
+
+       mlt_producer_set_speed( producer, 0 );
 
        this->count ++;
 
-       mlt_properties_set_double( mlt_playlist_properties( this ), "first_fps", fps );
-       mlt_properties_set_double( mlt_playlist_properties( this ), "fps", fps );
+       mlt_properties_inc_ref( mlt_producer_properties( producer ) );
 
-       return 0;
+       return mlt_playlist_virtual_refresh( this );
 }
 
 /** Seek in the virtual playlist.
 */
 
-static mlt_producer mlt_playlist_virtual_seek( mlt_playlist this )
+static mlt_service mlt_playlist_virtual_seek( mlt_playlist this )
+{
+       // Default producer to blank
+       mlt_producer producer = NULL;
+
+       // Map playlist position to real producer in virtual playlist
+       mlt_position position = mlt_producer_frame( &this->parent );
+
+       mlt_position original = position;
+
+       // Total number of frames
+       int64_t total = 0;
+
+       // Get the properties
+       mlt_properties properties = mlt_playlist_properties( this );
+
+       // Get the eof handling
+       char *eof = mlt_properties_get( properties, "eof" );
+
+       // Index for the main loop
+       int i = 0;
+
+       // Loop for each producer until found
+       for ( i = 0; i < this->count; i ++ )
+       {
+               // Increment the total
+               total += this->list[ i ]->frame_count;
+
+               // Check if the position indicates that we have found the clip
+               if ( position < this->list[ i ]->frame_count )
+               {
+                       // Found it, now break
+                       producer = this->list[ i ]->producer;
+                       break;
+               }
+               else
+               {
+                       // Decrement position by length of this entry
+                       position -= this->list[ i ]->frame_count;
+               }
+       }
+
+       // Seek in real producer to relative position
+       if ( producer != NULL )
+       {
+               position += this->list[ i ]->frame_in;
+               mlt_producer_seek( producer, position );
+       }
+       else if ( !strcmp( eof, "pause" ) && total > 0 )
+       {
+               playlist_entry *entry = this->list[ this->count - 1 ];
+               mlt_producer this_producer = mlt_playlist_producer( this );
+               mlt_producer_seek( this_producer, original - 1 );
+               producer = entry->producer;
+               mlt_producer_seek( producer, entry->frame_out );
+               mlt_producer_set_speed( this_producer, 0 );
+               mlt_producer_set_speed( producer, 0 );
+       }
+       else if ( !strcmp( eof, "loop" ) && total > 0 )
+       {
+               playlist_entry *entry = this->list[ 0 ];
+               mlt_producer this_producer = mlt_playlist_producer( this );
+               mlt_producer_seek( this_producer, 0 );
+               producer = entry->producer;
+               mlt_producer_seek( producer, entry->frame_in );
+       }
+       else
+       {
+               producer = &this->blank;
+       }
+
+       return mlt_producer_service( producer );
+}
+
+/** Invoked when a producer indicates that it has prematurely reached its end.
+*/
+
+static mlt_producer mlt_playlist_virtual_set_out( mlt_playlist this )
 {
        // Default producer to blank
        mlt_producer producer = &this->blank;
 
        // Map playlist position to real producer in virtual playlist
-       mlt_timecode position = mlt_producer_position( &this->parent );
+       mlt_position position = mlt_producer_frame( &this->parent );
 
        // Loop through the virtual playlist
        int i = 0;
 
        for ( i = 0; i < this->count; i ++ )
        {
-               if ( position < this->list[ i ]->playtime )
+               if ( position < this->list[ i ]->frame_count )
                {
                        // Found it, now break
                        producer = this->list[ i ]->producer;
-                       position += this->list[ i ]->in;
                        break;
                }
                else
                {
                        // Decrement position by length of this entry
-                       position -= this->list[ i ]->playtime;
+                       position -= this->list[ i ]->frame_count;
                }
        }
 
        // Seek in real producer to relative position
-       mlt_producer_seek( producer, position );
+       if ( i < this->count )
+       {
+               // Update the frame_count for the changed clip (hmmm)
+               this->list[ i ]->frame_out = position;
+               this->list[ i ]->frame_count = this->list[ i ]->frame_out - this->list[ i ]->frame_in + 1;
+
+               // Refresh the playlist
+               mlt_playlist_virtual_refresh( this );
+       }
 
        return producer;
 }
 
+/** Obtain the current clips index.
+*/
+
+int mlt_playlist_current_clip( mlt_playlist this )
+{
+       // Map playlist position to real producer in virtual playlist
+       mlt_position position = mlt_producer_frame( &this->parent );
+
+       // Loop through the virtual playlist
+       int i = 0;
+
+       for ( i = 0; i < this->count; i ++ )
+       {
+               if ( position < this->list[ i ]->frame_count )
+               {
+                       // Found it, now break
+                       break;
+               }
+               else
+               {
+                       // Decrement position by length of this entry
+                       position -= this->list[ i ]->frame_count;
+               }
+       }
+
+       return i;
+}
+
+/** Obtain the current clips producer.
+*/
+
+mlt_producer mlt_playlist_current( mlt_playlist this )
+{
+       int i = mlt_playlist_current_clip( this );
+       if ( i < this->count )
+               return this->list[ i ]->producer;
+       else
+               return &this->blank;
+}
+
+/** Get the position which corresponds to the start of the next clip.
+*/
+
+mlt_position mlt_playlist_clip( mlt_playlist this, mlt_whence whence, int index )
+{
+       mlt_position position = 0;
+       int absolute_clip = index;
+       int i = 0;
+
+       // Determine the absolute clip
+       switch ( whence )
+       {
+               case mlt_whence_relative_start:
+                       absolute_clip = index;
+                       break;
+
+               case mlt_whence_relative_current:
+                       absolute_clip = mlt_playlist_current_clip( this ) + index;
+                       break;
+
+               case mlt_whence_relative_end:
+                       absolute_clip = this->count - index;
+                       break;
+       }
+
+       // Check that we're in a valid range
+       if ( absolute_clip < 0 )
+               absolute_clip = 0;
+       else if ( absolute_clip > this->count )
+               absolute_clip = this->count;
+
+       // Now determine the position
+       for ( i = 0; i < absolute_clip; i ++ )
+               position += this->list[ i ]->frame_count;
+
+       return position;
+}
+
+/** Get all the info about the clip specified.
+*/
+
+int mlt_playlist_get_clip_info( mlt_playlist this, mlt_playlist_clip_info *info, int index )
+{
+       int error = index < 0 || index >= this->count;
+       memset( info, 0, sizeof( mlt_playlist_clip_info ) );
+       if ( !error )
+       {
+               mlt_producer producer = this->list[ index ]->producer;
+               mlt_properties properties = mlt_producer_properties( producer );
+               info->clip = index;
+               info->producer = producer;
+               info->start = mlt_playlist_clip( this, mlt_whence_relative_start, index );
+               info->resource = mlt_properties_get( properties, "resource" );
+               info->frame_in = this->list[ index ]->frame_in;
+               info->frame_out = this->list[ index ]->frame_out;
+               info->frame_count = this->list[ index ]->frame_count;
+               info->length = mlt_producer_get_length( producer );
+               info->fps = mlt_producer_get_fps( producer );
+       }
+
+       // Determine the consuming filter service
+       if ( info->producer != NULL )
+       {
+               info->service = mlt_producer_service( info->producer );
+               while ( mlt_service_consumer( info->service ) != NULL )
+                       info->service = mlt_service_consumer( info->service );
+       }
+
+       return error;
+}
+
+/** Get number of clips in the playlist.
+*/
+
+int mlt_playlist_count( mlt_playlist this )
+{
+       return this->count;
+}
+
+/** Clear the playlist.
+*/
+
+int mlt_playlist_clear( mlt_playlist this )
+{
+       int i;
+       for ( i = 0; i < this->count; i ++ )
+               mlt_producer_close( this->list[ i ]->producer );
+       this->count = 0;
+       mlt_properties_set_double( mlt_playlist_properties( this ), "first_fps", 0 );
+       return mlt_playlist_virtual_refresh( this );
+}
+
 /** Append a producer to the playlist.
 */
 
 int mlt_playlist_append( mlt_playlist this, mlt_producer producer )
 {
        // Append to virtual list
-       return mlt_playlist_virtual_append( this, producer, 0, mlt_producer_get_playtime( producer ) );
+       return mlt_playlist_virtual_append( this, producer, 0, mlt_producer_get_playtime( producer ) - 1 );
+}
+
+/** Append a producer to the playlist with in/out points.
+*/
+
+int mlt_playlist_append_io( mlt_playlist this, mlt_producer producer, mlt_position in, mlt_position out )
+{
+       // Append to virtual list
+       if ( in != -1 && out != -1 )
+               return mlt_playlist_virtual_append( this, producer, in, out );
+       else
+               return mlt_playlist_append( this, producer );
 }
 
 /** Append a blank to the playlist of a given length.
 */
 
-int mlt_playlist_blank( mlt_playlist this, mlt_timecode length )
+int mlt_playlist_blank( mlt_playlist this, mlt_position length )
 {
        // Append to the virtual list
        return mlt_playlist_virtual_append( this, &this->blank, 0, length );
 }
 
+/** Insert a producer into the playlist.
+*/
+
+int mlt_playlist_insert( mlt_playlist this, mlt_producer producer, int where, mlt_position in, mlt_position out )
+{
+       // Append to end
+       mlt_playlist_append_io( this, producer, in, out );
+
+       // Move to the position specified
+       return mlt_playlist_move( this, this->count - 1, where );
+}
+
+/** Remove an entry in the playlist.
+*/
+
+int mlt_playlist_remove( mlt_playlist this, int where )
+{
+       if ( this->count > 0 )
+       {
+               // We need to know the current clip and the position within the playlist
+               int current = mlt_playlist_current_clip( this );
+               mlt_position position = mlt_producer_position( mlt_playlist_producer( this ) );
+
+               // We need all the details about the clip we're removing
+               mlt_playlist_clip_info where_info;
+
+               // Loop variable
+               int i = 0;
+
+               // Make sure the clip to be removed is valid and correct if necessary
+               if ( where < 0 ) 
+                       where = 0;
+               if ( where >= this->count )
+                       where = this->count - 1;
+
+               // Get the clip info of the clip to be removed
+               mlt_playlist_get_clip_info( this, &where_info, where );
+
+               // Close the producer associated to the clip info
+               mlt_producer_close( where_info.producer );
+
+               // Reorganise the list
+               for ( i = where + 1; i < this->count; i ++ )
+                       this->list[ i - 1 ] = this->list[ i ];
+               this->count --;
+
+               // Correct position
+               if ( where == current )
+                       mlt_producer_seek( mlt_playlist_producer( this ), where_info.start );
+               else if ( where < current && this->count > 0 )
+                       mlt_producer_seek( mlt_playlist_producer( this ), position - where_info.frame_count );
+               else if ( this->count == 0 )
+                       mlt_producer_seek( mlt_playlist_producer( this ), 0 );
+       }
+
+       return 0;
+}
+
+/** Move an entry in the playlist.
+*/
+
+int mlt_playlist_move( mlt_playlist this, int src, int dest )
+{
+       int i;
+
+       /* We need to ensure that the requested indexes are valid and correct it as necessary */
+       if ( src < 0 ) 
+               src = 0;
+       if ( src >= this->count )
+               src = this->count - 1;
+
+       if ( dest < 0 ) 
+               dest = 0;
+       if ( dest >= this->count )
+               dest = this->count - 1;
+       
+       if ( src != dest && this->count > 1 )
+       {
+               int current = mlt_playlist_current_clip( this );
+               mlt_position position = mlt_producer_position( mlt_playlist_producer( this ) );
+               playlist_entry *src_entry = NULL;
+
+               // We need all the details about the current clip
+               mlt_playlist_clip_info current_info;
+
+               mlt_playlist_get_clip_info( this, &current_info, current );
+               position -= current_info.start;
+
+               if ( current == src )
+                       current = dest;
+               else if ( current > src && current < dest )
+                       current ++;
+               else if ( current == dest )
+                       current = src;
+
+               src_entry = this->list[ src ];
+               if ( src > dest )
+               {
+                       for ( i = src; i > dest; i -- )
+                               this->list[ i ] = this->list[ i - 1 ];
+               }
+               else
+               {
+                       for ( i = src; i < dest; i ++ )
+                               this->list[ i ] = this->list[ i + 1 ];
+               }
+               this->list[ dest ] = src_entry;
+
+               mlt_playlist_get_clip_info( this, &current_info, current );
+               mlt_producer_seek( mlt_playlist_producer( this ), current_info.start + position );
+       }
+
+       return 0;
+}
+
+/** Resize the current clip.
+*/
+
+int mlt_playlist_resize_clip( mlt_playlist this, int clip, mlt_position in, mlt_position out )
+{
+       int error = clip < 0 || clip >= this->count;
+       if ( error == 0 )
+       {
+               playlist_entry *entry = this->list[ clip ];
+               mlt_producer producer = entry->producer;
+
+               if ( in <= -1 )
+                       in = 0;
+               if ( out <= -1 || out >= mlt_producer_get_playtime( producer ) )
+                       out = mlt_producer_get_playtime( producer ) - 1;
+
+               if ( out < in )
+               {
+                       mlt_position t = in;
+                       in = out;
+                       out = t;
+               }
+
+               entry->frame_in = in;
+               entry->frame_out = out;
+               entry->frame_count = out - in + 1;
+               mlt_playlist_virtual_refresh( this );
+       }
+       return error;
+}
+
+/** Split a clip on the playlist at the given position.
+*/
+
+int mlt_playlist_split( mlt_playlist this, int clip, mlt_position position )
+{
+       int error = clip < 0 || clip >= this->count;
+       if ( error == 0 )
+       {
+               playlist_entry *entry = this->list[ clip ];
+               if ( position > 0 && position < entry->frame_count )
+               {
+                       int in = entry->frame_in;
+                       int out = entry->frame_out;
+                       mlt_playlist_resize_clip( this, clip, in, in + position );
+                       mlt_playlist_insert( this, entry->producer, clip + 1, in + position + 1, out );
+               }
+               else
+               {
+                       error = 1;
+               }
+       }
+       return error;
+}
+
+/** Join 1 or more consecutive clips.
+*/
+
+int mlt_playlist_join( mlt_playlist this, int clip, int count, int merge )
+{
+       int error = clip < 0 || ( clip + 1 ) >= this->count;
+       if ( error == 0 )
+       {
+               int i = clip;
+               mlt_playlist new_clip = mlt_playlist_init( );
+               if ( clip + count >= this->count )
+                       count = this->count - clip;
+               for ( i = 0; i <= count; i ++ )
+               {
+                       playlist_entry *entry = this->list[ clip ];
+                       mlt_playlist_append_io( new_clip, entry->producer, entry->frame_in, entry->frame_out );
+                       mlt_playlist_remove( this, clip );
+               }
+               mlt_playlist_insert( this, mlt_playlist_producer( new_clip ), clip, 0, -1 );
+               mlt_playlist_close( new_clip );
+       }
+       return error;
+}
+
 /** Get the current frame.
 */
 
@@ -211,13 +684,27 @@ static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int i
        mlt_playlist this = producer->child;
 
        // Get the real producer
-       mlt_producer real = mlt_playlist_virtual_seek( this );
+       mlt_service real = mlt_playlist_virtual_seek( this );
 
        // Get the frame
-       mlt_service_get_frame( mlt_producer_service( real ), frame, index );
+       mlt_service_get_frame( real, frame, index );
 
-       // Update timecode on the frame we're creating
-       mlt_frame_set_timecode( *frame, mlt_producer_position( producer ) );
+       // Check if we're at the end of the clip
+       mlt_properties properties = mlt_frame_properties( *frame );
+       if ( mlt_properties_get_int( properties, "end_of_clip" ) )
+               mlt_playlist_virtual_set_out( this );
+
+       // Check for notifier and call with appropriate argument
+       mlt_properties playlist_properties = mlt_producer_properties( producer );
+       void ( *notifier )( void * ) = mlt_properties_get_data( playlist_properties, "notifier", NULL );
+       if ( notifier != NULL )
+       {
+               void *argument = mlt_properties_get_data( playlist_properties, "notifier_arg", NULL );
+               notifier( argument );
+       }
+
+       // Update position on the frame we're creating
+       mlt_frame_set_position( *frame, mlt_producer_frame( producer ) );
 
        // Position ourselves on the next frame
        mlt_producer_prepare_next( producer );
@@ -230,7 +717,18 @@ static int producer_get_frame( mlt_producer producer, mlt_frame_ptr frame, int i
 
 void mlt_playlist_close( mlt_playlist this )
 {
-       mlt_producer_close( &this->parent );
-       mlt_producer_close( &this->blank );
-       free( this );
+       if ( this != NULL && mlt_properties_dec_ref( mlt_playlist_properties( this ) ) <= 0 )
+       {
+               int i = 0;
+               this->parent.close = NULL;
+               mlt_producer_close( &this->parent );
+               mlt_producer_close( &this->blank );
+               for ( i = 0; i < this->count; i ++ )
+               {
+                       mlt_producer_close( this->list[ i ]->producer );
+                       free( this->list[ i ] );
+               }
+               free( this->list );
+               free( this );
+       }
 }