X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_filter.h;h=66e2e471c007abe850d4485b923203f52c8fd6a0;hb=f4963a6aa07644399b273b5d2b1f9299c9047414;hp=158f28a98865cc552de66433dc01b4c1cf7f0d21;hpb=efe08354d45db7bf5478ffa17c35330a3e0d415c;p=melted

diff --git a/src/framework/mlt_filter.h b/src/framework/mlt_filter.h
index 158f28a..66e2e47 100644
--- a/src/framework/mlt_filter.h
+++ b/src/framework/mlt_filter.h
@@ -1,21 +1,24 @@
-/*
- * 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_
@@ -23,40 +26,42 @@
 
 #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
+ */
 
 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
-*/
+#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 this, void *child );
+extern int mlt_filter_init( mlt_filter self, void *child );
 extern mlt_filter mlt_filter_new( );
-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 );
+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 void mlt_filter_close( mlt_filter );
 
 #endif