git.sesse.net Git - mlt/blob - src/framework/mlt_consumer.h

   1 /**
   2  * \file mlt_consumer.h
   3  * \brief abstraction for all consumer services
   4  * \see mlt_consumer_s
   5  *
   6  * Copyright (C) 2003-2010 Ushodaya Enterprises Limited
   7  * \author Charles Yates <charles.yates@pandora.be>
   8  * \author Dan Dennedy <dan@dennedy.org>
   9  *
  10  * This library is free software; you can redistribute it and/or
  11  * modify it under the terms of the GNU Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 of the License, or (at your option) any later version.
  14  *
  15  * This library is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  18  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  23  */
  24
  25 #ifndef _MLT_CONSUMER_H_
  26 #define _MLT_CONSUMER_H_
  27
  28 #include "mlt_service.h"
  29 #include "mlt_events.h"
  30 #include <pthread.h>
  31
  32 /** \brief Consumer abstract service class
  33  *
  34  * A consumer is a service that pulls audio and video from the connected
  35  * producers, filters, and transitions. Typically a consumer is used to
  36  * output audio and/or video to a device, file, or socket.
  37  *
  38  * \extends mlt_service_s
  39  * \properties \em rescale the scaling algorithm to pass on to all scaling
  40  * filters, defaults to "bilinear"
  41  * \properties \em buffer the number of frames to use in the asynchronous
  42  * render thread, defaults to 25
  43  * \properties \em frequency the audio sample rate to use in Hertz, defaults to 48000
  44  * \properties \em channels the number of audio channels to use, defaults to 2
  45  * \properties \em real_time the asynchronous behavior: 1 (default) for asynchronous
  46  * with frame dropping, -1 for asynchronous without frame dropping, 0 to disable (synchronous)
  47  * \properties \em test_card the name of a resource to use as the test card, defaults to
  48  * environment variable MLT_TEST_CARD. If undefined, the hard-coded default test card is
  49  * white silence. A test card is what appears when nothing is produced.
  50  * \event \em consumer-frame-show Subclass implementations should fire this.
  51  * \event \em consumer-frame-render The abstract class fires this.
  52  * \event \em consumer-stopped
  53  * \properties \em fps video frames per second as floating point (read only)
  54  * \properties \em frame_rate_num the numerator of the video frame rate, overrides \p mlt_profile_s
  55  * \properties \em frame_rate_den the denominator of the video frame rate, overrides \p mlt_profile_s
  56  * \properties \em width the horizontal video resolution, overrides \p mlt_profile_s
  57  * \properties \em height the vertical video resolution, overrides \p mlt_profile_s
  58  * \properties \em progressive a flag that indicates if the video is interlaced
  59  * or progressive, overrides \p mlt_profile_s
  60  * \properties \em aspect_ratio the video sample (pixel) aspect ratio as floating point (read only)
  61  * \properties \em sample_aspect_num the numerator of the sample aspect ratio, overrides \p mlt_profile_s
  62  * \properties \em sample_aspect_den the denominator of the sample aspect ratio, overrides \p mlt_profile_s
  63  * \properties \em display_ratio the video frame aspect ratio as floating point (read only)
  64  * \properties \em display_aspect_num the numerator of the video frame aspect ratio, overrides \p mlt_profile_s
  65  * \properties \em display_aspect_den the denominator of the video frame aspect ratio, overrides \p mlt_profile_s
  66  *
  67  */
  68
  69 struct mlt_consumer_s
  70 {
  71         /** A consumer is a service. */
  72         struct mlt_service_s parent;
  73
  74         /** Start the consumer to pull frames (virtual function).
  75          *
  76          * \param mlt_consumer a consumer
  77          * \return true if there was an error
  78          */
  79         int ( *start )( mlt_consumer );
  80
  81         /** Stop the consumer (virtual function).
  82          *
  83          * \param mlt_consumer a consumer
  84          * \return true if there was an error
  85          */
  86         int ( *stop )( mlt_consumer );
  87
  88         /** Get whether the consumer is running or stopped (virtual function).
  89          *
  90          * \param mlt_consumer a consumer
  91          * \return true if the consumer is stopped
  92          */
  93         int ( *is_stopped )( mlt_consumer );
  94
  95         /** The destructor virtual function
  96          *
  97          * \param mlt_consumer a consumer
  98          */
  99         void ( *close )( mlt_consumer );
 100
 101         void *local; /**< \private instance object */
 102         void *child; /**< \private the object of a subclass */
 103
 104         int real_time;
 105         int ahead;
 106         mlt_image_format format;
 107         mlt_deque queue;
 108         pthread_t ahead_thread;
 109         pthread_mutex_t queue_mutex;
 110         pthread_cond_t queue_cond;
 111         pthread_mutex_t put_mutex;
 112         pthread_cond_t put_cond;
 113         mlt_frame put;
 114         int put_active;
 115         mlt_event event_listener;
 116         mlt_position position;
 117
 118         /* additional fields added for the parallel work queue */
 119         mlt_deque worker_threads;
 120         pthread_mutex_t done_mutex;
 121         pthread_cond_t done_cond;
 122         int consecutive_dropped;
 123         int consecutive_rendered;
 124         int process_head;
 125         int started;
 126 };
 127
 128 #define MLT_CONSUMER_SERVICE( consumer )        ( &( consumer )->parent )
 129 #define MLT_CONSUMER_PROPERTIES( consumer )     MLT_SERVICE_PROPERTIES( MLT_CONSUMER_SERVICE( consumer ) )
 130
 131 extern int mlt_consumer_init( mlt_consumer self, void *child, mlt_profile profile );
 132 extern mlt_consumer mlt_consumer_new( mlt_profile profile );
 133 extern mlt_service mlt_consumer_service( mlt_consumer self );
 134 extern mlt_properties mlt_consumer_properties( mlt_consumer self );
 135 extern int mlt_consumer_connect( mlt_consumer self, mlt_service producer );
 136 extern int mlt_consumer_start( mlt_consumer self );
 137 extern void mlt_consumer_purge( mlt_consumer self );
 138 extern int mlt_consumer_put_frame( mlt_consumer self, mlt_frame frame );
 139 extern mlt_frame mlt_consumer_get_frame( mlt_consumer self );
 140 extern mlt_frame mlt_consumer_rt_frame( mlt_consumer self );
 141 extern int mlt_consumer_stop( mlt_consumer self );
 142 extern int mlt_consumer_is_stopped( mlt_consumer self );
 143 extern void mlt_consumer_stopped( mlt_consumer self );
 144 extern void mlt_consumer_close( mlt_consumer );
 145 extern mlt_position mlt_consumer_position( mlt_consumer );
 146
 147 #endif