Merge ../mlt
[melted] / src / framework / mlt_tractor.c
index 3bcf020..40c7821 100644 (file)
@@ -1,43 +1,51 @@
-/*
- * mlt_tractor.c -- tractor service class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_tractor.c
+ * \brief tractor service class
+ * \see mlt_tractor_s
  *
- * 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.
+ * Copyright (C) 2003-2009 Ushodaya Enterprises Limited
+ * \author Charles Yates <charles.yates@pandora.be>
  *
- * This program is distributed in the hope that it will be useful,
+ * 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 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_tractor.h"
 #include "mlt_frame.h"
 #include "mlt_multitrack.h"
 #include "mlt_field.h"
+#include "mlt_log.h"
 
 #include <stdio.h>
 #include <stdlib.h>
 #include <string.h>
 #include <ctype.h>
 
-/** Forward references to static methods.
+/* Forward references to static methods.
 */
 
-static int producer_get_frame( mlt_producer this, mlt_frame_ptr frame, int track );
+static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int track );
 static void mlt_tractor_listener( mlt_multitrack tracks, mlt_tractor this );
 
-/** Constructor for the tractor.
-*/
+/** Construct a tractor without a field or multitrack.
+ *
+ * Sets the resource property to "<tractor>", the mlt_type to "mlt_producer",
+ * and mlt_service to "tractor".
+ *
+ * \public \memberof mlt_tractor_s
+ * \return the new tractor
+ */
 
 mlt_tractor mlt_tractor_init( )
 {
@@ -69,6 +77,15 @@ mlt_tractor mlt_tractor_init( )
        return this;
 }
 
+/** Construct a tractor as well as a field and multitrack.
+ *
+ * Sets the resource property to "<tractor>", the mlt_type to "mlt_producer",
+ * and mlt_service to "tractor".
+ *
+ * \public \memberof mlt_tractor_s
+ * \return the new tractor
+ */
+
 mlt_tractor mlt_tractor_new( )
 {
        mlt_tractor this = calloc( sizeof( struct mlt_tractor_s ), 1 );
@@ -106,7 +123,12 @@ mlt_tractor mlt_tractor_new( )
 }
 
 /** Get the service object associated to the tractor.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \return the parent service object
+ * \see MLT_TRACTOR_SERVICE
+ */
 
 mlt_service mlt_tractor_service( mlt_tractor this )
 {
@@ -114,7 +136,12 @@ mlt_service mlt_tractor_service( mlt_tractor this )
 }
 
 /** Get the producer object associated to the tractor.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \return the parent producer object
+ * \see MLT_TRACTOR_PRODUCER
+ */
 
 mlt_producer mlt_tractor_producer( mlt_tractor this )
 {
@@ -122,7 +149,12 @@ mlt_producer mlt_tractor_producer( mlt_tractor this )
 }
 
 /** Get the properties object associated to the tractor.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \return the tractor's property list
+ * \see MLT_TRACTOR_PROPERTIES
+ */
 
 mlt_properties mlt_tractor_properties( mlt_tractor this )
 {
@@ -130,7 +162,11 @@ mlt_properties mlt_tractor_properties( mlt_tractor this )
 }
 
 /** Get the field this tractor is harvesting.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \return a field or NULL if there is no field for this tractor
+ */
 
 mlt_field mlt_tractor_field( mlt_tractor this )
 {
@@ -138,7 +174,11 @@ mlt_field mlt_tractor_field( mlt_tractor this )
 }
 
 /** Get the multitrack this tractor is pulling.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \return a multitrack or NULL if there is none
+ */
 
 mlt_multitrack mlt_tractor_multitrack( mlt_tractor this )
 {
@@ -146,7 +186,10 @@ mlt_multitrack mlt_tractor_multitrack( mlt_tractor this )
 }
 
 /** Ensure the tractors in/out points match the multitrack.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ */
 
 void mlt_tractor_refresh( mlt_tractor this )
 {
@@ -169,7 +212,12 @@ static void mlt_tractor_listener( mlt_multitrack tracks, mlt_tractor this )
 }
 
 /** Connect the tractor.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \param producer a producer
+ * \return true on error
+ */
 
 int mlt_tractor_connect( mlt_tractor this, mlt_service producer )
 {
@@ -183,7 +231,13 @@ int mlt_tractor_connect( mlt_tractor this, mlt_service producer )
 }
 
 /** Set the producer for a specific track.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \param producer a producer
+ * \param index the 0-based track index
+ * \return true on error
+ */
 
 int mlt_tractor_set_track( mlt_tractor this, mlt_producer producer, int index )
 {
@@ -191,7 +245,12 @@ int mlt_tractor_set_track( mlt_tractor this, mlt_producer producer, int index )
 }
 
 /** Get the producer for a specific track.
-*/
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ * \param index the 0-based track index
+ * \return the producer for track \p index
+ */
 
 mlt_producer mlt_tractor_get_track( mlt_tractor this, int index )
 {
@@ -204,19 +263,19 @@ static int producer_get_image( mlt_frame this, uint8_t **buffer, mlt_image_forma
        mlt_properties properties = MLT_FRAME_PROPERTIES( this );
        mlt_frame frame = mlt_frame_pop_service( this );
        mlt_properties frame_properties = MLT_FRAME_PROPERTIES( frame );
-       mlt_properties_set_int( frame_properties, "width", mlt_properties_get_int( properties, "width" ) );
-       mlt_properties_set_int( frame_properties, "height", mlt_properties_get_int( properties, "height" ) );
        mlt_properties_set( frame_properties, "rescale.interp", mlt_properties_get( properties, "rescale.interp" ) );
+       mlt_properties_set_int( frame_properties, "resize_alpha", mlt_properties_get_int( properties, "resize_alpha" ) );
        mlt_properties_set_int( frame_properties, "distort", mlt_properties_get_int( properties, "distort" ) );
        mlt_properties_set_double( frame_properties, "consumer_aspect_ratio", mlt_properties_get_double( properties, "consumer_aspect_ratio" ) );
-       mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_double( properties, "consumer_deinterlace" ) );
+       mlt_properties_set_int( frame_properties, "consumer_deinterlace", mlt_properties_get_int( properties, "consumer_deinterlace" ) );
        mlt_properties_set( frame_properties, "deinterlace_method", mlt_properties_get( properties, "deinterlace_method" ) );
-       mlt_properties_set_int( frame_properties, "normalised_width", mlt_properties_get_double( properties, "normalised_width" ) );
-       mlt_properties_set_int( frame_properties, "normalised_height", mlt_properties_get_double( properties, "normalised_height" ) );
+       mlt_properties_set_int( frame_properties, "normalised_width", mlt_properties_get_int( properties, "normalised_width" ) );
+       mlt_properties_set_int( frame_properties, "normalised_height", mlt_properties_get_int( properties, "normalised_height" ) );
        mlt_frame_get_image( frame, buffer, format, width, height, writable );
        mlt_properties_set_data( properties, "image", *buffer, *width * *height * 2, NULL, NULL );
        mlt_properties_set_int( properties, "width", *width );
        mlt_properties_set_int( properties, "height", *height );
+       mlt_properties_set_int( properties, "format", *format );
        mlt_properties_set_double( properties, "aspect_ratio", mlt_frame_get_aspect_ratio( frame ) );
        mlt_properties_set_int( properties, "progressive", mlt_properties_get_int( frame_properties, "progressive" ) );
        mlt_properties_set_int( properties, "distort", mlt_properties_get_int( frame_properties, "distort" ) );
@@ -253,9 +312,13 @@ static void destroy_data_queue( void *arg )
 }
 
 /** Get the next frame.
-
-       TODO: This function needs to be redesigned...
-*/
+ *
+ * \private \memberof mlt_tractor_s
+ * \param parent the producer interface to the tractor
+ * \param[out] frame a frame by reference
+ * \param track the 0-based track index
+ * \return true on error
+ */
 
 static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int track )
 {
@@ -268,6 +331,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                int done = 0;
                mlt_frame temp = NULL;
                int count = 0;
+               int image_count = 0;
 
                // Get the properties of the parent producer
                mlt_properties properties = MLT_PRODUCER_PROPERTIES( parent );
@@ -284,7 +348,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                // Determine whether this tractor feeds to the consumer or stops here
                int global_feed = mlt_properties_get_int( properties, "global_feed" );
 
-               // If we don't have one, we're in trouble... 
+               // If we don't have one, we're in trouble...
                if ( multitrack != NULL )
                {
                        // Used to garbage collect all frames
@@ -299,6 +363,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                        // We'll store audio and video frames to use here
                        mlt_frame audio = NULL;
                        mlt_frame video = NULL;
+                       mlt_frame first_video = NULL;
 
                        // Temporary properties
                        mlt_properties temp_properties = NULL;
@@ -309,7 +374,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                        mlt_producer_set_speed( target, mlt_producer_get_speed( parent ) );
 
                        // We will create one frame and attach everything to it
-                       *frame = mlt_frame_init( );
+                       *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( parent ) );
 
                        // Get the properties of the frame
                        frame_properties = MLT_FRAME_PROPERTIES( *frame );
@@ -327,50 +392,10 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                                done = mlt_properties_get_int( temp_properties, "last_track" );
 
                                // Handle fx only tracks
-                               if ( mlt_properties_get_int( temp_properties, "meta.fx_cut" ) )
+                               if ( mlt_properties_get_int( temp_properties, "fx_cut" ) )
                                {
-                                       mlt_properties copy = video == NULL ? frame_properties : MLT_FRAME_PROPERTIES( video );
-                                       int i = 0;
-
-                                       for ( i = 0; i < mlt_properties_count( temp_properties ); i ++ )
-                                       {
-                                               char *name = mlt_properties_get_name( temp_properties, i );
-                                               char *value = mlt_properties_get_value( temp_properties, i );
-                                               // For animated filters
-                                               if ( isdigit( name[ 0 ] ) && value != NULL )
-                                                       mlt_properties_set( copy, name, value );
-                                       }
-
-                                       if ( video )
-                                       {
-                                               // Take all but the first placeholding producer and dump on to the image stack
-                                               void *p = mlt_deque_pop_front( MLT_FRAME_IMAGE_STACK( temp ) );
-                                               while ( ( p = mlt_deque_pop_front( MLT_FRAME_IMAGE_STACK( temp ) ) ) != NULL )
-                                                       mlt_deque_push_back( MLT_FRAME_IMAGE_STACK( video ), p );
-                                       }
-                                       else
-                                       {
-                                               mlt_frame_push_service( *frame, temp );
-                                               mlt_frame_push_service( *frame, producer_get_image );
-                                               mlt_properties_set_int( frame_properties, "meta.fx_cut", 1 );
-                                       }
-
-                                       if ( audio )
-                                       {
-                                               // Take all but the first placeholding producer and dump on to the audio stack
-                                               void *p = !mlt_frame_is_test_audio( temp ) ? mlt_deque_pop_front( MLT_FRAME_AUDIO_STACK( temp ) ) : NULL;
-                                               while ( ( p = mlt_deque_pop_front( MLT_FRAME_AUDIO_STACK( temp ) ) ) != NULL )
-                                                       mlt_deque_push_back( MLT_FRAME_AUDIO_STACK( audio ), p );
-                                       }
-                                       else
-                                       {
-                                               mlt_frame_push_audio( *frame, temp );
-                                               mlt_frame_push_audio( *frame, producer_get_audio );
-                                               mlt_properties_set_int( frame_properties, "meta.fx_cut", 1 );
-                                       }
-
-                                       // Ensure everything is hidden
-                                       mlt_properties_set_int( temp_properties, "hide", 3 );
+                                       int hide = ( video == NULL ? 1 : 0 ) | ( audio == NULL ? 2 : 0 );
+                                       mlt_properties_set_int( temp_properties, "hide", hide );
                                }
 
                                // We store all frames with a destructor on the output frame
@@ -426,9 +451,18 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                                                mlt_deque_push_front( MLT_FRAME_IMAGE_STACK( temp ), video );
                                        }
                                        video = temp;
+                                       if ( first_video == NULL )
+                                               first_video = temp;
+
+                                       // Ensure that all frames know the aspect ratio of the background
+                                       mlt_properties_set_double( temp_properties, "output_ratio",
+                                                                                          mlt_properties_get_double( MLT_FRAME_PROPERTIES( first_video ), "aspect_ratio" ) );
+
+                                       mlt_properties_set_int( MLT_FRAME_PROPERTIES( temp ), "image_count", ++ image_count );
+                                       image_count = 1;
                                }
                        }
-       
+
                        // Now stack callbacks
                        if ( audio != NULL )
                        {
@@ -438,7 +472,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
 
                        if ( video != NULL )
                        {
-                               mlt_properties video_properties = MLT_FRAME_PROPERTIES( video );
+                               mlt_properties video_properties = MLT_FRAME_PROPERTIES( first_video );
                                mlt_frame_push_service( *frame, video );
                                mlt_frame_push_service( *frame, producer_get_image );
                                if ( global_feed )
@@ -450,6 +484,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                                mlt_properties_set_int( frame_properties, "real_height", mlt_properties_get_int( video_properties, "real_height" ) );
                                mlt_properties_set_int( frame_properties, "progressive", mlt_properties_get_int( video_properties, "progressive" ) );
                                mlt_properties_set_double( frame_properties, "aspect_ratio", mlt_properties_get_double( video_properties, "aspect_ratio" ) );
+                               mlt_properties_set_int( frame_properties, "image_count", image_count );
                        }
                        else
                        {
@@ -469,7 +504,7 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
                }
                else
                {
-                       fprintf( stderr, "tractor without a multitrack!!\n" );
+                       mlt_log( MLT_PRODUCER_SERVICE( parent ), MLT_LOG_ERROR, "tractor without a multitrack!!\n" );
                        mlt_service_get_frame( this->producer, frame, track );
                }
 
@@ -482,13 +517,16 @@ static int producer_get_frame( mlt_producer parent, mlt_frame_ptr frame, int tra
        else
        {
                // Generate a test card
-               *frame = mlt_frame_init( );
+               *frame = mlt_frame_init( MLT_PRODUCER_SERVICE( parent ) );
                return 0;
        }
 }
 
-/** Close the tractor.
-*/
+/** Close the tractor and free its resources.
+ *
+ * \public \memberof mlt_tractor_s
+ * \param this a tractor
+ */
 
 void mlt_tractor_close( mlt_tractor this )
 {