src/framework/*: improve the doxygen documentation (work in progress). This also...

[mlt] / src / framework / mlt_filter.h

diff --git a/src/framework/mlt_filter.h b/src/framework/mlt_filter.h
index 99212a9219561ea157a710c610e5c63f2a1ab118..c67c9abcc745ffad1c0c415b019507e0b7827ac0 100644 (file)
--- a/src/framework/mlt_filter.h
+++ b/src/framework/mlt_filter.h
@@ -3,19 +3,19 @@
  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
  * Author: Charles Yates <charles.yates@pandora.be>
  *
- * 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.
+ * 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 program is distributed in the hope that it will be useful,
+ * 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 +23,42 @@
 
 #include "mlt_service.h"
 
-/** The interface definition for all filters.
-*/
+/** \brief Filter abstract service class
+ *
+ * \extends mlt_service_s
+ */
 
 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;
-       int track;
-       mlt_timecode in;
-       mlt_timecode out;
-
-       // 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 int mlt_filter_connect( mlt_filter this, mlt_service producer, int index );
-extern void mlt_filter_set_in_and_out( mlt_filter this, mlt_timecode in, mlt_timecode out );
-extern int mlt_filter_get_track( mlt_filter this );
-extern mlt_timecode mlt_filter_get_in( mlt_filter this );
-extern mlt_timecode 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 void mlt_filter_close( mlt_filter );
 
 #endif