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 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_SERVICE_H_
  22 #define _MLT_SERVICE_H_
  23
  24 #include "mlt_properties.h"
  25
  26 /** State of a service.
  27
  28     Note that a service may be dormant even though it's fully connected,
  29         providing or consuming.
  30 */
  31
  32 typedef enum
  33 {
  34         mlt_state_unknown   = 0,
  35         mlt_state_dormant   = 1,
  36         mlt_state_connected = 2,
  37         mlt_state_providing = 4,
  38         mlt_state_consuming = 8
  39 }
  40 mlt_service_state;
  41
  42 /** The interface definition for all services.
  43 */
  44
  45 struct mlt_service_s
  46 {
  47         // We're extending properties here
  48         struct mlt_properties_s parent;
  49
  50         // Protected virtual
  51         int ( *accepts_input )( mlt_service this );
  52         int ( *accepts_output )( mlt_service this );
  53         int ( *has_input )( mlt_service this );
  54         int ( *has_output )( mlt_service this );
  55         int ( *get_frame )( mlt_service this, mlt_frame_ptr frame, int index );
  56
  57         // Private data
  58         void *private;
  59         void *child;
  60 };
  61
  62 /** The public API.
  63 */
  64
  65 extern int mlt_service_init( mlt_service this, void *child );
  66 extern mlt_properties mlt_service_properties( mlt_service this );
  67 extern int mlt_service_connect_producer( mlt_service this, mlt_service producer, int index );
  68 extern mlt_service_state mlt_service_get_state( mlt_service this );
  69 extern void mlt_service_close( mlt_service this );
  70
  71 extern int mlt_service_accepts_input( mlt_service this );
  72 extern int mlt_service_accepts_output( mlt_service this );
  73 extern int mlt_service_has_input( mlt_service this );
  74 extern int mlt_service_has_output( mlt_service this );
  75 extern int mlt_service_get_frame( mlt_service this, mlt_frame_ptr frame, int index );
  76 extern int mlt_service_is_active( mlt_service this );
  77
  78 #endif
  79