research.m1stereo.tv/gitweb/ - melted/blob - src/framework/mlt_consumer.h

   1 /**
   2  * \file mlt_consumer.h
   3  * \brief abstraction for all consumer services
   4  *
   5  * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
   6  * \author Charles Yates <charles.yates@pandora.be>
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Lesser General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2.1 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Lesser General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU Lesser General Public
  19  * License along with this library; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #ifndef _MLT_CONSUMER_H_
  24 #define _MLT_CONSUMER_H_
  25
  26 #include "mlt_service.h"
  27 #include "mlt_events.h"
  28 #include <pthread.h>
  29
  30 /** \brief Consumer abstract service class
  31  *
  32  * \extends mlt_service_s
  33  */
  34
  35 struct mlt_consumer_s
  36 {
  37         /* We're implementing service here */
  38         struct mlt_service_s parent;
  39
  40         /* public virtual */
  41         int ( *start )( mlt_consumer );
  42         int ( *stop )( mlt_consumer );
  43         int ( *is_stopped )( mlt_consumer );
  44         void ( *close )( mlt_consumer );
  45
  46         /* Private data */
  47         void *local;
  48         void *child;
  49
  50         int real_time;
  51         int ahead;
  52         mlt_image_format format;
  53         mlt_deque queue;
  54         pthread_t ahead_thread;
  55         pthread_mutex_t mutex;
  56         pthread_cond_t cond;
  57         pthread_mutex_t put_mutex;
  58         pthread_cond_t put_cond;
  59         mlt_frame put;
  60         int put_active;
  61         mlt_event event_listener;
  62 };
  63
  64 #define MLT_CONSUMER_SERVICE( consumer )        ( &( consumer )->parent )
  65 #define MLT_CONSUMER_PROPERTIES( consumer )     MLT_SERVICE_PROPERTIES( MLT_CONSUMER_SERVICE( consumer ) )
  66
  67 extern int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile );
  68 extern mlt_consumer mlt_consumer_new( mlt_profile profile );
  69 extern mlt_service mlt_consumer_service( mlt_consumer self );
  70 extern mlt_properties mlt_consumer_properties( mlt_consumer self );
  71 extern int mlt_consumer_connect( mlt_consumer self, mlt_service producer );
  72 extern int mlt_consumer_start( mlt_consumer self );
  73 extern void mlt_consumer_purge( mlt_consumer self );
  74 extern int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame );
  75 extern mlt_frame mlt_consumer_get_frame( mlt_consumer self );
  76 extern mlt_frame mlt_consumer_rt_frame( mlt_consumer self );
  77 extern int mlt_consumer_stop( mlt_consumer self );
  78 extern int mlt_consumer_is_stopped( mlt_consumer self );
  79 extern void mlt_consumer_stopped( mlt_consumer self );
  80 extern void mlt_consumer_close( mlt_consumer );
  81
  82 #endif