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

   1 /*
   2  * mlt_service.h -- interface for all service classes
   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 self 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_SERVICE_H_
  22 #define _MLT_SERVICE_H_
  23
  24 #include "mlt_properties.h"
  25
  26 /** The interface definition for all services.
  27 */
  28
  29 struct mlt_service_s
  30 {
  31         // We're extending properties here
  32         struct mlt_properties_s parent;
  33
  34         // Protected virtual
  35         int ( *get_frame )( mlt_service self, mlt_frame_ptr frame, int index );
  36         mlt_destructor close;
  37         void *close_object;
  38
  39         // Private data
  40         void *local;
  41         void *child;
  42 };
  43
  44 /** The public API.
  45 */
  46
  47 extern int mlt_service_init( mlt_service self, void *child );
  48 extern void mlt_service_lock( mlt_service self );
  49 extern void mlt_service_unlock( mlt_service self );
  50 extern mlt_service_type mlt_service_identify( mlt_service self );
  51 extern int mlt_service_connect_producer( mlt_service self, mlt_service producer, int index );
  52 extern int mlt_service_get_frame( mlt_service self, mlt_frame_ptr frame, int index );
  53 extern mlt_properties mlt_service_properties( mlt_service self );
  54 extern mlt_service mlt_service_consumer( mlt_service self );
  55 extern mlt_service mlt_service_producer( mlt_service self );
  56 extern int mlt_service_attach( mlt_service self, mlt_filter filter );
  57 extern int mlt_service_detach( mlt_service self, mlt_filter filter );
  58 extern void mlt_service_apply_filters( mlt_service self, mlt_frame frame, int index );
  59 extern mlt_filter mlt_service_filter( mlt_service self, int index );
  60
  61 extern void mlt_service_close( mlt_service self );
  62
  63 // I'm not sure about self one - leaving it out of docs for now (only used in consumer_westley)
  64 extern mlt_service mlt_service_get_producer( mlt_service self );
  65
  66 #endif
  67