-/*
- * mlt_filter.h -- abstraction for all filter services
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_filter.h
+ * \brief abstraction for all filter services
+ * \see mlt_filter_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
*/
#ifndef _MLT_FILTER_H_
#include "mlt_service.h"
-/** The interface definition for all filters.
-*/
+/** \brief Filter abstract service class
+ *
+ * A filter is a service that may modify the output of a single producer.
+ *
+ * \extends mlt_service_s
+ * \properties \em track the index of the track of a multitrack on which the filter is applied
+ * \properties \em service a reference to the service to which this filter is attached.
+ * \properties \em disable Set this to disable the filter while keeping it in the object model.
+ * Currently this is not cleared when the filter is detached.
+ */
struct mlt_filter_s
{
- // We're implementing service here
+ /** We're implementing service here */
struct mlt_service_s parent;
- // public virtual
+ /** public virtual */
void ( *close )( mlt_filter );
- // protected filter method
+ /** protected filter method */
mlt_frame ( *process )( mlt_filter, mlt_frame );
- // track and in/out points
- mlt_service producer;
-
- // Protected
+ /** Protected */
void *child;
};
-/** Public final methods
-*/
-
-extern int mlt_filter_init( mlt_filter this, void *child );
-extern mlt_service mlt_filter_service( mlt_filter this );
-extern mlt_properties mlt_filter_properties( mlt_filter this );
-extern mlt_frame mlt_filter_process( mlt_filter this, mlt_frame that );
-extern int mlt_filter_connect( mlt_filter this, mlt_service producer, int index );
-extern void mlt_filter_set_in_and_out( mlt_filter this, mlt_position in, mlt_position out );
-extern int mlt_filter_get_track( mlt_filter this );
-extern mlt_position mlt_filter_get_in( mlt_filter this );
-extern mlt_position mlt_filter_get_out( mlt_filter this );
+#define MLT_FILTER_SERVICE( filter ) ( &( filter )->parent )
+#define MLT_FILTER_PROPERTIES( filter ) MLT_SERVICE_PROPERTIES( MLT_FILTER_SERVICE( filter ) )
+
+extern int mlt_filter_init( mlt_filter self, void *child );
+extern mlt_filter mlt_filter_new( );
+extern mlt_service mlt_filter_service( mlt_filter self );
+extern mlt_properties mlt_filter_properties( mlt_filter self );
+extern mlt_frame mlt_filter_process( mlt_filter self, mlt_frame that );
+extern int mlt_filter_connect( mlt_filter self, mlt_service producer, int index );
+extern void mlt_filter_set_in_and_out( mlt_filter self, mlt_position in, mlt_position out );
+extern int mlt_filter_get_track( mlt_filter self );
+extern mlt_position mlt_filter_get_in( mlt_filter self );
+extern mlt_position mlt_filter_get_out( mlt_filter self );
+extern mlt_position mlt_filter_get_length( mlt_filter self );
+extern mlt_position mlt_filter_get_length2( mlt_filter self, mlt_frame frame );
+extern mlt_position mlt_filter_get_position( mlt_filter self, mlt_frame frame );
+extern double mlt_filter_get_progress( mlt_filter self, mlt_frame frame );
extern void mlt_filter_close( mlt_filter );
#endif