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