1 /* GStreamer valve element 2 * 3 * Copyright 2007 Collabora Ltd, 4 * Copyright 2007 Nokia Corporation 5 * @author: Olivier Crete <olivier.crete@collabora.co.uk> 6 * 7 * This library is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU Library General Public 9 * License as published by the Free Software Foundation; either 10 * version 2 of the License, or (at your option) any later version. 11 * 12 * This library is distributed in the hope that it will be useful, 13 * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 * Library General Public License for more details. 16 * 17 * You should have received a copy of the GNU Library General Public 18 * License along with this library; if not, write to the 19 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, 20 * Boston, MA 02110-1301, USA. 21 * 22 */ 23 24 #ifndef __GST_VALVE_H__ 25 #define __GST_VALVE_H__ 26 27 #include <gst/gst.h> 28 29 G_BEGIN_DECLS 30 /* #define's don't like whitespacey bits */ 31 #define GST_TYPE_VALVE \ 32 (gst_valve_get_type()) 33 #define GST_VALVE(obj) \ 34 (G_TYPE_CHECK_INSTANCE_CAST((obj), \ 35 GST_TYPE_VALVE,GstValve)) 36 #define GST_VALVE_CLASS(klass) \ 37 (G_TYPE_CHECK_CLASS_CAST((klass), \ 38 GST_TYPE_VALVE,GstValveClass)) 39 #define GST_IS_VALVE(obj) \ 40 (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_VALVE)) 41 #define GST_IS_VALVE_CLASS(obj) \ 42 (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_VALVE)) 43 44 typedef struct _GstValve GstValve; 45 typedef struct _GstValveClass GstValveClass; 46 47 /** 48 * GstValveDropMode: 49 * @GST_VALVE_DROP_MODE_DROP_ALL: Drop all buffers, buffer lists and events. 50 * @GST_VALVE_DROP_MODE_FORWARD_STICKY_EVENTS: Drop all buffers, buffer lists 51 * and non-sticky events but forward sticky events. 52 * @GST_VALVE_DROP_MODE_TRANSFORM_TO_GAP: Drop all buffers, buffer lists and 53 * non-sticky events but forward sticky events and forward GAP events for each 54 * dropped buffer. 55 * 56 * Since: 1.20 57 */ 58 typedef enum { 59 GST_VALVE_DROP_MODE_DROP_ALL, 60 GST_VALVE_DROP_MODE_FORWARD_STICKY_EVENTS, 61 GST_VALVE_DROP_MODE_TRANSFORM_TO_GAP, 62 } GstValveDropMode; 63 64 /** 65 * GstValve: 66 * 67 * The private valve structure 68 */ 69 struct _GstValve 70 { 71 /*< private >*/ 72 GstElement parent; 73 74 /* atomic boolean */ 75 gint drop; 76 77 GstValveDropMode drop_mode; 78 79 /* Protected by the stream lock */ 80 gboolean discont; 81 gboolean need_repush_sticky; 82 83 GstPad *srcpad; 84 GstPad *sinkpad; 85 }; 86 87 struct _GstValveClass 88 { 89 GstElementClass parent_class; 90 }; 91 92 G_GNUC_INTERNAL GType gst_valve_get_type (void); 93 94 G_END_DECLS 95 96 #endif /* __GST_VALVE_H__ */ 97