X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_filter.c;h=9a04352ef49dabd9a1000b896b40b7d5f792f60a;hb=f4963a6aa07644399b273b5d2b1f9299c9047414;hp=6723d2f1c0dcc7dc67a3179edd28a22c4b3be993;hpb=bf3264b9e340ba5c11cbf59835a8af3db94e0cc2;p=melted diff --git a/src/framework/mlt_filter.c b/src/framework/mlt_filter.c index 6723d2f..9a04352 100644 --- a/src/framework/mlt_filter.c +++ b/src/framework/mlt_filter.c @@ -1,7 +1,10 @@ -/* - * mlt_filter.c -- abstraction for all filter services - * Copyright (C) 2003-2004 Ushodaya Enterprises Limited - * Author: Charles Yates +/** + * \file mlt_filter.c + * \brief abstraction for all filter services + * \see mlt_filter_s + * + * Copyright (C) 2003-2009 Ushodaya Enterprises Limited + * \author Charles Yates * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public @@ -18,8 +21,6 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */ -#include "config.h" - #include "mlt_filter.h" #include "mlt_frame.h" @@ -29,8 +30,13 @@ static int filter_get_frame( mlt_service this, mlt_frame_ptr frame, int index ); -/** Constructor method. -*/ +/** Initialize a new filter. + * + * \public \memberof mlt_filter_s + * \param this a filter + * \param child the object of a subclass + * \return true if there was an error + */ int mlt_filter_init( mlt_filter this, void *child ) { @@ -58,8 +64,11 @@ int mlt_filter_init( mlt_filter this, void *child ) return 1; } -/** Create a new filter. -*/ +/** Create a new filter and initialize it. + * + * \public \memberof mlt_filter_s + * \return a new filter + */ mlt_filter mlt_filter_new( ) { @@ -69,16 +78,26 @@ mlt_filter mlt_filter_new( ) return this; } -/** Get the service associated to this filter -*/ +/** Get the service class interface. + * + * \public \memberof mlt_filter_s + * \param this a filter + * \return the service parent class + * \see MLT_FILTER_SERVICE + */ mlt_service mlt_filter_service( mlt_filter this ) { return this != NULL ? &this->parent : NULL; } -/** Get the properties associated to this filter. -*/ +/** Get the filter properties. + * + * \public \memberof mlt_filter_s + * \param this a filter + * \return the properties list for the filter + * \see MLT_FILTER_PROPERTIES + */ mlt_properties mlt_filter_properties( mlt_filter this ) { @@ -86,13 +105,18 @@ mlt_properties mlt_filter_properties( mlt_filter this ) } /** Connect this filter to a producers track. Note that a filter only operates - on a single track, and by default it operates on the entirety of that track. -*/ + * on a single track, and by default it operates on the entirety of that track. + * + * \public \memberof mlt_filter_s + * \param this a filter + * \param producer the producer to which to connect this filter + * \param index which of potentially multiple producers to this service (0 based) + */ int mlt_filter_connect( mlt_filter this, mlt_service producer, int index ) { int ret = mlt_service_connect_producer( &this->parent, producer, index ); - + // If the connection was successful, grab the producer, track and reset in/out if ( ret == 0 ) { @@ -101,12 +125,18 @@ int mlt_filter_connect( mlt_filter this, mlt_service producer, int index ) mlt_properties_set_position( properties, "out", 0 ); mlt_properties_set_int( properties, "track", index ); } - + return ret; } -/** Tune the in/out points. -*/ +/** Set the starting and ending time. + * + * \public \memberof mlt_filter_s + * \param this a filter + * \param in the time relative to the producer at which start applying the filter + * \param out the time relative to the producer at which to stop applying the filter + */ + void mlt_filter_set_in_and_out( mlt_filter this, mlt_position in, mlt_position out ) { @@ -116,7 +146,12 @@ void mlt_filter_set_in_and_out( mlt_filter this, mlt_position in, mlt_position o } /** Return the track that this filter is operating on. -*/ + * + * \public \memberof mlt_filter_s + * \param this a filter + * \return true on error + */ + int mlt_filter_get_track( mlt_filter this ) { @@ -125,7 +160,12 @@ int mlt_filter_get_track( mlt_filter this ) } /** Get the in point. -*/ + * + * \public \memberof mlt_filter_s + * \param this a filter + * \return the start time for the filter relative to the producer + */ + mlt_position mlt_filter_get_in( mlt_filter this ) { @@ -134,7 +174,12 @@ mlt_position mlt_filter_get_in( mlt_filter this ) } /** Get the out point. -*/ + * + * \public \memberof mlt_filter_s + * \param this a filter + * \return the ending time for the filter relative to the producer + */ + mlt_position mlt_filter_get_out( mlt_filter this ) { @@ -143,7 +188,13 @@ mlt_position mlt_filter_get_out( mlt_filter this ) } /** Process the frame. -*/ + * + * \public \memberof mlt_filter_s + * \param this a filter + * \param frame a frame + * \return a frame + */ + mlt_frame mlt_filter_process( mlt_filter this, mlt_frame frame ) { @@ -155,7 +206,14 @@ mlt_frame mlt_filter_process( mlt_filter this, mlt_frame frame ) } /** Get a frame from this filter. -*/ + * + * \private \memberof mlt_filter_s + * \param service a service + * \param[out] frame a frame by reference + * \param index as determined by the producer + * \return true on error + */ + static int filter_get_frame( mlt_service service, mlt_frame_ptr frame, int index ) { @@ -165,7 +223,7 @@ static int filter_get_frame( mlt_service service, mlt_frame_ptr frame, int index int track = mlt_filter_get_track( this ); int in = mlt_filter_get_in( this ); int out = mlt_filter_get_out( this ); - + // Get the producer this is connected to mlt_service producer = mlt_service_producer( &this->parent ); @@ -182,7 +240,7 @@ static int filter_get_frame( mlt_service service, mlt_frame_ptr frame, int index } else { - *frame = mlt_frame_init( ); + *frame = mlt_frame_init( service ); return 0; } } @@ -192,8 +250,12 @@ static int filter_get_frame( mlt_service service, mlt_frame_ptr frame, int index } } -/** Close the filter. -*/ +/** Close and destroy the filter. + * + * \public \memberof mlt_filter_s + * \param this a filter + */ + void mlt_filter_close( mlt_filter this ) {