X-Git-Url: http://research.m1stereo.tv/gitweb?a=blobdiff_plain;f=src%2Fframework%2Fmlt_tractor.h;h=73e0715365273ab59a03b39aca42d4836ad4920d;hb=780b62679560f15e2201ae42a28de77346729b7e;hp=b9e606ffc26e2db88f800cc9da38ce6b35602a96;hpb=5f8f3adaf7cc01a161092ea272f50279a7ad971a;p=melted

diff --git a/src/framework/mlt_tractor.h b/src/framework/mlt_tractor.h
index b9e606f..73e0715 100644
--- a/src/framework/mlt_tractor.h
+++ b/src/framework/mlt_tractor.h
@@ -1,21 +1,24 @@
-/*
- * mlt_tractor.h -- tractor service class
- * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
- * Author: Charles Yates <charles.yates@pandora.be>
+/**
+ * \file mlt_tractor.h
+ * \brief tractor service class
+ * \see mlt_tractor_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_TRACTOR_H_
@@ -23,6 +26,30 @@
 
 #include "mlt_producer.h"
 
+/** \brief Tractor class
+ *
+ * The tractor is a convenience class that works with the field class
+ * to manage a multitrack, track filters, and transitions.
+ *
+ * \extends mlt_producer_s
+ * \properties \em multitrack holds a reference to the mulitrack object that a tractor manages
+ * \properties \em field holds a reference to the field object that a tractor manages
+ * \properties \em producer holds a reference to an encapsulated producer
+ * \properties \em global_feed a flag to indicate whether this tractor feeds to the consumer or stops here
+ * \properties \em global_queue is something for the data_feed functionality in the core module
+ * \properties \em data_queue is something for the data_feed functionality in the core module
+ */
+
+struct mlt_tractor_s
+{
+	struct mlt_producer_s parent;
+	mlt_service producer;
+};
+
+#define MLT_TRACTOR_PRODUCER( tractor )		( &( tractor )->parent )
+#define MLT_TRACTOR_SERVICE( tractor )		MLT_PRODUCER_SERVICE( MLT_TRACTOR_PRODUCER( tractor ) )
+#define MLT_TRACTOR_PROPERTIES( tractor )	MLT_SERVICE_PROPERTIES( MLT_TRACTOR_SERVICE( tractor ) )
+
 extern mlt_tractor mlt_tractor_init( );
 extern mlt_tractor mlt_tractor_new( );
 extern mlt_service mlt_tractor_service( mlt_tractor self );