Updates to vid.stab module.

[mlt] / src / framework / mlt_filter.h

diff --git a/src/framework/mlt_filter.h b/src/framework/mlt_filter.h
index d95a754c534cfc4522d4a25c637958ce38685bd4..187833d46cdedf26547dab016bbf8fb6b9657d0e 100644 (file)
--- 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,27 +26,32 @@
 
 #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 );
 
-       // 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 ) )
 
@@ -57,6 +65,10 @@ extern void mlt_filter_set_in_and_out( mlt_filter self, mlt_position in, mlt_pos
 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