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 #include <pthread.h>
  26
  27 /** The interface definition for all consumers.
  28 */
  29
  30 struct mlt_consumer_s
  31 {
  32         // We're implementing service here
  33         struct mlt_service_s parent;
  34
  35         // public virtual
  36         int ( *start )( mlt_consumer );
  37         int ( *stop )( mlt_consumer );
  38         int ( *is_stopped )( mlt_consumer );
  39         void ( *close )( mlt_consumer );
  40
  41         // Private data
  42         void *local;
  43         void *child;
  44
  45         int real_time;
  46         int ahead;
  47         mlt_image_format format;
  48         mlt_deque queue;
  49         pthread_t ahead_thread;
  50         pthread_mutex_t mutex;
  51         pthread_cond_t cond;
  52         pthread_mutex_t put_mutex;
  53         pthread_cond_t put_cond;
  54         mlt_frame put;
  55 };
  56
  57 /** Public final methods
  58 */
  59
  60 extern int mlt_consumer_init( mlt_consumer self, void *child );
  61 extern mlt_consumer mlt_consumer_new( );
  62 extern mlt_service mlt_consumer_service( mlt_consumer self );
  63 extern mlt_properties mlt_consumer_properties( mlt_consumer self );
  64 extern int mlt_consumer_connect( mlt_consumer self, mlt_service producer );
  65 extern int mlt_consumer_start( mlt_consumer self );
  66 extern void mlt_consumer_purge( mlt_consumer self );
  67 extern int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame );
  68 extern mlt_frame mlt_consumer_get_frame( mlt_consumer self );
  69 extern mlt_frame mlt_consumer_rt_frame( mlt_consumer self );
  70 extern int mlt_consumer_stop( mlt_consumer self );
  71 extern int mlt_consumer_is_stopped( mlt_consumer self );
  72 extern void mlt_consumer_stopped( mlt_consumer self );
  73 extern void mlt_consumer_close( mlt_consumer );
  74
  75 #endif