research.m1stereo.tv/gitweb/ - melted/blob - src/framework/mlt_filter.h

   1 /*
   2  * mlt_filter.h -- abstraction for all filter services
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  */
  20
  21 #ifndef _MLT_FILTER_H_
  22 #define _MLT_FILTER_H_
  23
  24 #include "mlt_service.h"
  25
  26 /** \brief Filter abstract service class
  27  *
  28  * A filter is a service that may modify the output of a single producer.
  29  *
  30  * \extends mlt_service_s
  31  * \properties \em track the index of the track of a multitrack on which the filter is applied
  32  */
  33
  34 struct mlt_filter_s
  35 {
  36         /** We're implementing service here */
  37         struct mlt_service_s parent;
  38
  39         /** public virtual */
  40         void ( *close )( mlt_filter );
  41
  42         /** protected filter method */
  43         mlt_frame ( *process )( mlt_filter, mlt_frame );
  44
  45         /** Protected */
  46         void *child;
  47 };
  48
  49 #define MLT_FILTER_SERVICE( filter )            ( &( filter )->parent )
  50 #define MLT_FILTER_PROPERTIES( filter )         MLT_SERVICE_PROPERTIES( MLT_FILTER_SERVICE( filter ) )
  51
  52 extern int mlt_filter_init( mlt_filter self, void *child );
  53 extern mlt_filter mlt_filter_new( );
  54 extern mlt_service mlt_filter_service( mlt_filter self );
  55 extern mlt_properties mlt_filter_properties( mlt_filter self );
  56 extern mlt_frame mlt_filter_process( mlt_filter self, mlt_frame that );
  57 extern int mlt_filter_connect( mlt_filter self, mlt_service producer, int index );
  58 extern void mlt_filter_set_in_and_out( mlt_filter self, mlt_position in, mlt_position out );
  59 extern int mlt_filter_get_track( mlt_filter self );
  60 extern mlt_position mlt_filter_get_in( mlt_filter self );
  61 extern mlt_position mlt_filter_get_out( mlt_filter self );
  62 extern void mlt_filter_close( mlt_filter );
  63
  64 #endif