Cleanup license declarations and remove dv1394d references.
[melted] / src / framework / mlt_service.c
index f432aae..aedc6ef 100644 (file)
@@ -3,27 +3,29 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Charles Yates <charles.yates@pandora.be>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
- * (at your option) any later version.
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
  *
- * This program is distributed in the hope that it will be useful,
+ * This library is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  */
 
 #include "config.h"
 #include "mlt_service.h"
+#include "mlt_filter.h"
 #include "mlt_frame.h"
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
+#include <pthread.h>
 
 /** IMPORTANT NOTES
 
@@ -44,43 +46,104 @@ typedef struct
        int count;
        mlt_service *in;
        mlt_service out;
+       int filter_count;
+       int filter_size;
+       mlt_filter *filters;
+       pthread_mutex_t mutex;
 }
 mlt_service_base;
 
-/** Friends?
+/** Private methods
 */
 
 static void mlt_service_disconnect( mlt_service this );
 static void mlt_service_connect( mlt_service this, mlt_service that );
 static int service_get_frame( mlt_service this, mlt_frame_ptr frame, int index );
+static void mlt_service_property_changed( mlt_listener, mlt_properties owner, mlt_service this, void **args );
 
 /** Constructor
 */
 
 int mlt_service_init( mlt_service this, void *child )
 {
+       int error = 0;
+
        // Initialise everything to NULL
        memset( this, 0, sizeof( struct mlt_service_s ) );
 
        // Assign the child
        this->child = child;
 
-       // Generate private space
-       this->private = calloc( sizeof( mlt_service_base ), 1 );
+       // Generate local space
+       this->local = calloc( sizeof( mlt_service_base ), 1 );
 
        // Associate the methods
        this->get_frame = service_get_frame;
        
        // Initialise the properties
-       return mlt_properties_init( &this->parent, this );
+       error = mlt_properties_init( &this->parent, this );
+       if ( error == 0 )
+       {
+               this->parent.close = ( mlt_destructor )mlt_service_close;
+               this->parent.close_object = this;
+
+               mlt_events_init( &this->parent );
+               mlt_events_register( &this->parent, "service-changed", NULL );
+               mlt_events_register( &this->parent, "property-changed", ( mlt_transmitter )mlt_service_property_changed );
+               pthread_mutex_init( &( ( mlt_service_base * )this->local )->mutex, NULL );
+       }
+
+       return error;
 }
 
-/** Return the properties object.
-*/
+static void mlt_service_property_changed( mlt_listener listener, mlt_properties owner, mlt_service this, void **args )
+{
+       if ( listener != NULL )
+               listener( owner, this, ( char * )args[ 0 ] );
+}
+
+void mlt_service_lock( mlt_service this )
+{
+       if ( this != NULL )
+               pthread_mutex_lock( &( ( mlt_service_base * )this->local )->mutex );
+}
+
+void mlt_service_unlock( mlt_service this )
+{
+       if ( this != NULL )
+               pthread_mutex_unlock( &( ( mlt_service_base * )this->local )->mutex );
+}
 
-mlt_properties mlt_service_properties( mlt_service this )
+mlt_service_type mlt_service_identify( mlt_service this )
 {
-       return &this->parent;
+       mlt_service_type type = invalid_type;
+       if ( this != NULL )
+       {
+               mlt_properties properties = MLT_SERVICE_PROPERTIES( this );
+               char *mlt_type = mlt_properties_get( properties, "mlt_type" );
+               char *resource = mlt_properties_get( properties, "resource" );
+               if ( mlt_type == NULL )
+                       type = unknown_type;
+               else if ( resource == NULL || !strcmp( resource, "<producer>" ) )
+                       type = producer_type;
+               else if ( !strcmp( resource, "<playlist>" ) )
+                       type = playlist_type;
+               else if ( !strcmp( resource, "<tractor>" ) )
+                       type = tractor_type;
+               else if ( !strcmp( resource, "<multitrack>" ) )
+                       type = multitrack_type;
+               else if ( !strcmp( mlt_type, "producer" ) )
+                       type = producer_type;
+               else if ( !strcmp( mlt_type, "filter" ) )
+                       type = filter_type;
+               else if ( !strcmp( mlt_type, "transition" ) )
+                       type = transition_type;
+               else if ( !strcmp( mlt_type, "consumer" ) )
+                       type = consumer_type;
+               else
+                       type = unknown_type;
+       }
+       return type;
 }
 
 /** Connect a producer service.
@@ -95,15 +158,12 @@ int mlt_service_connect_producer( mlt_service this, mlt_service producer, int in
        int i = 0;
 
        // Get the service base
-       mlt_service_base *base = this->private;
+       mlt_service_base *base = this->local;
 
-       // Does this service accept input?
-       if ( mlt_service_accepts_input( this ) == 0 )
-               return 1;
-
-       // Does the producer service accept output connections?
-       if ( mlt_service_accepts_output( producer ) == 0 )
-               return 2;
+       // Special case 'track' index - only works for last filter(s) in a particular chain
+       // but allows a filter to apply to the output frame regardless of which track it comes from
+       if ( index == -1 )
+               index = 0;
 
        // Check if the producer is already registered with this service
        for ( i = 0; i < base->count; i ++ )
@@ -126,6 +186,17 @@ int mlt_service_connect_producer( mlt_service this, mlt_service producer, int in
        // If we have space, assign the input
        if ( base->in != NULL && index >= 0 && index < base->size )
        {
+               // Get the current service
+               mlt_service current = base->in[ index ];
+
+               // Increment the reference count on this producer
+               if ( producer != NULL )
+               {
+                       mlt_service_lock( producer );
+                       mlt_properties_inc_ref( MLT_SERVICE_PROPERTIES( producer ) );
+                       mlt_service_unlock( producer );
+               }
+
                // Now we disconnect the producer service from its consumer
                mlt_service_disconnect( producer );
                
@@ -139,6 +210,9 @@ int mlt_service_connect_producer( mlt_service this, mlt_service producer, int in
                // Now we connect the producer to its connected consumer
                mlt_service_connect( producer, this );
 
+               // Close the current service
+               mlt_service_close( current );
+
                // Inform caller that all went well
                return 0;
        }
@@ -151,27 +225,56 @@ int mlt_service_connect_producer( mlt_service this, mlt_service producer, int in
 /** Disconnect this service from its consumer.
 */
 
-void mlt_service_disconnect( mlt_service this )
+static void mlt_service_disconnect( mlt_service this )
+{
+       if ( this != NULL )
+       {
+               // Get the service base
+               mlt_service_base *base = this->local;
+
+               // Disconnect
+               base->out = NULL;
+       }
+}
+
+/** Obtain the consumer this service is connected to.
+*/
+
+mlt_service mlt_service_consumer( mlt_service this )
 {
        // Get the service base
-       mlt_service_base *base = this->private;
+       mlt_service_base *base = this->local;
 
-       // There's a bit more required here...
-       base->out = NULL;
+       // Return the connected consumer
+       return base->out;
 }
 
-/** Associate this service to the its consumer.
+/** Obtain the producer this service is connected to.
 */
 
-void mlt_service_connect( mlt_service this, mlt_service that )
+mlt_service mlt_service_producer( mlt_service this )
 {
        // Get the service base
-       mlt_service_base *base = this->private;
+       mlt_service_base *base = this->local;
 
-       // There's a bit more required here...
-       base->out = that;
+       // Return the connected producer
+       return base->count > 0 ? base->in[ base->count - 1 ] : NULL;
 }
 
+/** Associate this service to the consumer.
+*/
+
+static void mlt_service_connect( mlt_service this, mlt_service that )
+{
+       if ( this != NULL )
+       {
+               // Get the service base
+               mlt_service_base *base = this->local;
+
+               // There's a bit more required here...
+               base->out = that;
+       }
+}
 
 /** Get the first connected producer service.
 */
@@ -181,103 +284,209 @@ mlt_service mlt_service_get_producer( mlt_service this )
        mlt_service producer = NULL;
 
        // Get the service base
-       mlt_service_base *base = this->private;
+       mlt_service_base *base = this->local;
 
        if ( base->in != NULL )
                producer = base->in[ 0 ];
        
        return producer;
 }
 
-/** Get the service state.
+/** Default implementation of get_frame.
 */
 
-mlt_service_state mlt_service_get_state( mlt_service this )
+static int service_get_frame( mlt_service this, mlt_frame_ptr frame, int index )
 {
-       mlt_service_state state = mlt_state_unknown;
-       if ( mlt_service_has_input( this ) )
-               state |= mlt_state_providing;
-       if ( mlt_service_has_output( this ) )
-               state |= mlt_state_connected;
-       if ( state != ( mlt_state_providing | mlt_state_connected ) )
-               state |= mlt_state_dormant;
-       return state;
+       mlt_service_base *base = this->local;
+       if ( index < base->count )
+       {
+               mlt_service producer = base->in[ index ];
+               if ( producer != NULL )
+                       return mlt_service_get_frame( producer, frame, index );
+       }
+       *frame = mlt_frame_init( );
+       return 0;
 }
 
-/** Get the maximum number of inputs accepted.
-       Returns: -1 for many, 0 for none or n for fixed.
+/** Return the properties object.
 */
 
-int mlt_service_accepts_input( mlt_service this )
+mlt_properties mlt_service_properties( mlt_service self )
 {
-       if ( this->accepts_input == NULL )
-               return -1;
-       else
-               return this->accepts_input( this );
+       return self != NULL ? &self->parent : NULL;
 }
 
-/** Get the maximum number of outputs accepted.
+/** Recursively apply attached filters
 */
 
-int mlt_service_accepts_output( mlt_service this )
+void mlt_service_apply_filters( mlt_service this, mlt_frame frame, int index )
 {
-       if ( this->accepts_output == NULL )
-               return 1;
-       else
-               return this->accepts_output( this );
+       int i;
+       mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
+       mlt_properties service_properties = MLT_SERVICE_PROPERTIES( this );
+       mlt_service_base *base = this->local;
+       mlt_position position = mlt_frame_get_position( frame );
+       mlt_position this_in = mlt_properties_get_position( service_properties, "in" );
+       mlt_position this_out = mlt_properties_get_position( service_properties, "out" );
+
+       if ( index == 0 || mlt_properties_get_int( service_properties, "_filter_private" ) == 0 )
+       {
+               // Process the frame with the attached filters
+               for ( i = 0; i < base->filter_count; i ++ )
+               {
+                       if ( base->filters[ i ] != NULL )
+                       {
+                               mlt_position in = mlt_filter_get_in( base->filters[ i ] );
+                               mlt_position out = mlt_filter_get_out( base->filters[ i ] );
+                               int disable = mlt_properties_get_int( MLT_FILTER_PROPERTIES( base->filters[ i ] ), "disable" );
+                               if ( !disable && ( ( in == 0 && out == 0 ) || ( position >= in && ( position <= out || out == 0 ) ) ) )
+                               {
+                                       mlt_properties_set_position( frame_properties, "in", in == 0 ? this_in : in );
+                                       mlt_properties_set_position( frame_properties, "out", out == 0 ? this_out : out );
+                                       mlt_filter_process( base->filters[ i ], frame );
+                                       mlt_service_apply_filters( MLT_FILTER_SERVICE( base->filters[ i ] ), frame, index + 1 );
+                               }
+                       }
+               }
+       }
 }
 
-/** Determines if this service has input
+/** Obtain a frame.
 */
 
-int mlt_service_has_input( mlt_service this )
+int mlt_service_get_frame( mlt_service this, mlt_frame_ptr frame, int index )
 {
-       if ( this->has_input == NULL )
-               return 1;
-       else
-               return this->has_input( this );
-}
+       int result = 0;
 
-/** Determine if this service has output
-*/
+       // Lock the service
+       mlt_service_lock( this );
+
+       // Ensure that the frame is NULL
+       *frame = NULL;
+
+       // Only process if we have a valid service
+       if ( this != NULL && this->get_frame != NULL )
+       {
+               mlt_properties properties = MLT_SERVICE_PROPERTIES( this );
+               mlt_position in = mlt_properties_get_position( properties, "in" );
+               mlt_position out = mlt_properties_get_position( properties, "out" );
+
+               result = this->get_frame( this, frame, index );
+
+               if ( result == 0 )
+               {
+                       mlt_properties_inc_ref( properties );
+                       properties = MLT_FRAME_PROPERTIES( *frame );
+                       if ( in >=0 && out > 0 )
+                       {
+                               mlt_properties_set_position( properties, "in", in );
+                               mlt_properties_set_position( properties, "out", out );
+                       }
+                       mlt_service_apply_filters( this, *frame, 1 );
+                       mlt_deque_push_back( MLT_FRAME_SERVICE_STACK( *frame ), this );
+               }
+       }
+
+       // Make sure we return a frame
+       if ( *frame == NULL )
+               *frame = mlt_frame_init( );
+
+       // Unlock the service
+       mlt_service_unlock( this );
+
+       return result;
+}
 
-int mlt_service_has_output( mlt_service this )
+static void mlt_service_filter_changed( mlt_service owner, mlt_service this )
 {
-       mlt_service_base *base = this->private;
-       if ( this->has_output == NULL )
-               return base->out != NULL;
-       else
-               return this->has_output( this );
+       mlt_events_fire( MLT_SERVICE_PROPERTIES( this ), "service-changed", NULL );
 }
 
-/** Check if the service is active.
+/** Attach a filter.
 */
 
-int mlt_service_is_active( mlt_service this )
+int mlt_service_attach( mlt_service this, mlt_filter filter )
 {
-       return !( mlt_service_get_state( this ) & mlt_state_dormant );
+       int error = this == NULL || filter == NULL;
+       if ( error == 0 )
+       {
+               int i = 0;
+               mlt_properties properties = MLT_SERVICE_PROPERTIES( this );
+               mlt_service_base *base = this->local;
+
+               for ( i = 0; error == 0 && i < base->filter_count; i ++ )
+                       if ( base->filters[ i ] == filter )
+                               error = 1;
+
+               if ( error == 0 )
+               {
+                       if ( base->filter_count == base->filter_size )
+                       {
+                               base->filter_size += 10;
+                               base->filters = realloc( base->filters, base->filter_size * sizeof( mlt_filter ) );
+                       }
+
+                       if ( base->filters != NULL )
+                       {
+                               mlt_properties props = MLT_FILTER_PROPERTIES( filter );
+                               mlt_properties_inc_ref( MLT_FILTER_PROPERTIES( filter ) );
+                               base->filters[ base->filter_count ++ ] = filter;
+                               mlt_events_fire( properties, "service-changed", NULL );
+                               mlt_events_listen( props, this, "service-changed", ( mlt_listener )mlt_service_filter_changed );
+                               mlt_events_listen( props, this, "property-changed", ( mlt_listener )mlt_service_filter_changed );
+                       }
+                       else
+                       {
+                               error = 2;
+                       }
+               }
+       }
+       return error;
 }
 
-/** Obtain a frame to pass on.
+/** Detach a filter.
 */
 
-static int service_get_frame( mlt_service this, mlt_frame_ptr frame, int index )
+int mlt_service_detach( mlt_service this, mlt_filter filter )
 {
-       mlt_service_base *base = this->private;
-       if ( index < base->count )
+       int error = this == NULL || filter == NULL;
+       if ( error == 0 )
        {
-               mlt_service producer = base->in[ index ];
-               if ( producer != NULL )
-                       return mlt_service_get_frame( producer, frame, index );
+               int i = 0;
+               mlt_service_base *base = this->local;
+               mlt_properties properties = MLT_SERVICE_PROPERTIES( this );
+
+               for ( i = 0; i < base->filter_count; i ++ )
+                       if ( base->filters[ i ] == filter )
+                               break;
+
+               if ( i < base->filter_count )
+               {
+                       base->filters[ i ] = NULL;
+                       for ( i ++ ; i < base->filter_count; i ++ )
+                               base->filters[ i - 1 ] = base->filters[ i ];
+                       base->filter_count --;
+                       mlt_events_disconnect( MLT_FILTER_PROPERTIES( filter ), this );
+                       mlt_filter_close( filter );
+                       mlt_events_fire( properties, "service-changed", NULL );
+               }
        }
-       *frame = mlt_frame_init( );
-       return 0;
+       return error;
 }
 
-int mlt_service_get_frame( mlt_service this, mlt_frame_ptr frame, int index )
+/** Retrieve a filter.
+*/
+
+mlt_filter mlt_service_filter( mlt_service this, int index )
 {
-       return this->get_frame( this, frame, index );
+       mlt_filter filter = NULL;
+       if ( this != NULL )
+       {
+               mlt_service_base *base = this->local;
+               if ( index >= 0 && index < base->filter_count )
+                       filter = base->filters[ index ];
+       }
+       return filter;
 }
 
 /** Close the service.
@@ -285,9 +494,36 @@ int mlt_service_get_frame( mlt_service this, mlt_frame_ptr frame, int index )
 
 void mlt_service_close( mlt_service this )
 {
-       mlt_service_base *base = this->private;
-       free( base->in );
-       free( base );
-       mlt_properties_close( &this->parent );
+       mlt_service_lock( this );
+       if ( this != NULL && mlt_properties_dec_ref( MLT_SERVICE_PROPERTIES( this ) ) <= 0 )
+       {
+               mlt_service_unlock( this );
+               if ( this->close != NULL )
+               {
+                       this->close( this->close_object );
+               }
+               else
+               {
+                       mlt_service_base *base = this->local;
+                       int i = 0;
+                       int count = base->filter_count;
+                       mlt_events_block( MLT_SERVICE_PROPERTIES( this ), this );
+                       while( count -- )
+                               mlt_service_detach( this, base->filters[ 0 ] );
+                       free( base->filters );
+                       for ( i = 0; i < base->count; i ++ )
+                               if ( base->in[ i ] != NULL )
+                                       mlt_service_close( base->in[ i ] );
+                       this->parent.close = NULL;
+                       free( base->in );
+                       pthread_mutex_destroy( &base->mutex );
+                       free( base );
+                       mlt_properties_close( &this->parent );
+               }
+       }
+       else
+       {
+               mlt_service_unlock( this );
+       }
 }