git.sesse.net Git - mlt/blob - src/framework/mlt_consumer.h

   1 /*
   2  * mlt_consumer.h -- abstraction for all consumer services
   3  * Copyright (C) 2003-2004 Ushodaya Enterprises Limited
   4  * Author: Charles Yates <charles.yates@pandora.be>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program 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
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software Foundation,
  18  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef _MLT_CONSUMER_H_
  22 #define _MLT_CONSUMER_H_
  23
  24 #include "mlt_service.h"
  25
  26 /** The interface definition for all consumers.
  27 */
  28
  29 struct mlt_consumer_s
  30 {
  31         // We're implementing service here
  32         struct mlt_service_s parent;
  33
  34         // public virtual
  35         void ( *close )( mlt_consumer );
  36
  37         // Private data
  38         void *private;
  39         void *child;
  40 };
  41
  42 /** Public final methods
  43 */
  44
  45 extern int mlt_consumer_init( mlt_consumer this, void *child );
  46 extern mlt_service mlt_consumer_service( mlt_consumer this );
  47 extern int mlt_consumer_connect( mlt_consumer this, mlt_service producer );
  48 extern void mlt_consumer_close( mlt_consumer );
  49
  50 #endif