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