1 /*
2  * This file is part of gtkD.
3  *
4  * gtkD is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * gtkD is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with gtkD; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 
20 // generated automatically - do not change
21 // find conversion definition on APILookup.txt
22 // implement new conversion functionalities on the wrap.utils pakage
23 
24 
25 module gstreamer.Pipeline;
26 
27 private import glib.ConstructionException;
28 private import glib.Str;
29 private import gobject.ObjectG;
30 private import gstreamer.Bin;
31 private import gstreamer.Bus;
32 private import gstreamer.Clock;
33 private import gstreamer.Element;
34 private import gstreamerc.gstreamer;
35 public  import gstreamerc.gstreamertypes;
36 
37 
38 /**
39  * A #GstPipeline is a special #GstBin used as the toplevel container for
40  * the filter graph. The #GstPipeline will manage the selection and
41  * distribution of a global #GstClock as well as provide a #GstBus to the
42  * application.
43  * 
44  * gst_pipeline_new() is used to create a pipeline. when you are done with
45  * the pipeline, use gst_object_unref() to free its resources including all
46  * added #GstElement objects (if not otherwise referenced).
47  * 
48  * Elements are added and removed from the pipeline using the #GstBin
49  * methods like gst_bin_add() and gst_bin_remove() (see #GstBin).
50  * 
51  * Before changing the state of the #GstPipeline (see #GstElement) a #GstBus
52  * can be retrieved with gst_pipeline_get_bus(). This bus can then be
53  * used to receive #GstMessage from the elements in the pipeline.
54  * 
55  * By default, a #GstPipeline will automatically flush the pending #GstBus
56  * messages when going to the NULL state to ensure that no circular
57  * references exist when no messages are read from the #GstBus. This
58  * behaviour can be changed with gst_pipeline_set_auto_flush_bus().
59  * 
60  * When the #GstPipeline performs the PAUSED to PLAYING state change it will
61  * select a clock for the elements. The clock selection algorithm will by
62  * default select a clock provided by an element that is most upstream
63  * (closest to the source). For live pipelines (ones that return
64  * #GST_STATE_CHANGE_NO_PREROLL from the gst_element_set_state() call) this
65  * will select the clock provided by the live source. For normal pipelines
66  * this will select a clock provided by the sinks (most likely the audio
67  * sink). If no element provides a clock, a default #GstSystemClock is used.
68  * 
69  * The clock selection can be controlled with the gst_pipeline_use_clock()
70  * method, which will enforce a given clock on the pipeline. With
71  * gst_pipeline_auto_clock() the default clock selection algorithm can be
72  * restored.
73  * 
74  * A #GstPipeline maintains a running time for the elements. The running
75  * time is defined as the difference between the current clock time and
76  * the base time. When the pipeline goes to READY or a flushing seek is
77  * performed on it, the running time is reset to 0. When the pipeline is
78  * set from PLAYING to PAUSED, the current clock time is sampled and used to
79  * configure the base time for the elements when the pipeline is set
80  * to PLAYING again. The effect is that the running time (as the difference
81  * between the clock time and the base time) will count how much time was spent
82  * in the PLAYING state. This default behaviour can be changed with the
83  * gst_element_set_start_time() method.
84  */
85 public class Pipeline : Bin
86 {
87 	/** the main Gtk struct */
88 	protected GstPipeline* gstPipeline;
89 
90 	/** Get the main Gtk struct */
91 	public GstPipeline* getPipelineStruct()
92 	{
93 		return gstPipeline;
94 	}
95 
96 	/** the main Gtk struct as a void* */
97 	protected override void* getStruct()
98 	{
99 		return cast(void*)gstPipeline;
100 	}
101 
102 	protected override void setStruct(GObject* obj)
103 	{
104 		gstPipeline = cast(GstPipeline*)obj;
105 		super.setStruct(obj);
106 	}
107 
108 	/**
109 	 * Sets our main struct and passes it to the parent class.
110 	 */
111 	public this (GstPipeline* gstPipeline, bool ownedRef = false)
112 	{
113 		this.gstPipeline = gstPipeline;
114 		super(cast(GstBin*)gstPipeline, ownedRef);
115 	}
116 
117 
118 	/** */
119 	public static GType getType()
120 	{
121 		return gst_pipeline_get_type();
122 	}
123 
124 	/**
125 	 * Create a new pipeline with the given name.
126 	 *
127 	 * Params:
128 	 *     name = name of new pipeline
129 	 *
130 	 * Returns: newly created GstPipeline
131 	 *
132 	 *     MT safe.
133 	 *
134 	 * Throws: ConstructionException GTK+ fails to create the object.
135 	 */
136 	public this(string name)
137 	{
138 		auto p = gst_pipeline_new(Str.toStringz(name));
139 		
140 		if(p is null)
141 		{
142 			throw new ConstructionException("null returned by new");
143 		}
144 		
145 		this(cast(GstPipeline*) p);
146 	}
147 
148 	/**
149 	 * Let @pipeline select a clock automatically. This is the default
150 	 * behaviour.
151 	 *
152 	 * Use this function if you previous forced a fixed clock with
153 	 * gst_pipeline_use_clock() and want to restore the default
154 	 * pipeline clock selection algorithm.
155 	 *
156 	 * MT safe.
157 	 */
158 	public void autoClock()
159 	{
160 		gst_pipeline_auto_clock(gstPipeline);
161 	}
162 
163 	/**
164 	 * Check if @pipeline will automatically flush messages when going to
165 	 * the NULL state.
166 	 *
167 	 * Returns: whether the pipeline will automatically flush its bus when
168 	 *     going from READY to NULL state or not.
169 	 *
170 	 *     MT safe.
171 	 */
172 	public bool getAutoFlushBus()
173 	{
174 		return gst_pipeline_get_auto_flush_bus(gstPipeline) != 0;
175 	}
176 
177 	/**
178 	 * Gets the #GstBus of @pipeline. The bus allows applications to receive
179 	 * #GstMessage packets.
180 	 *
181 	 * Returns: a #GstBus, unref after usage.
182 	 *
183 	 *     MT safe.
184 	 */
185 	public override Bus getBus()
186 	{
187 		auto p = gst_pipeline_get_bus(gstPipeline);
188 		
189 		if(p is null)
190 		{
191 			return null;
192 		}
193 		
194 		return ObjectG.getDObject!(Bus)(cast(GstBus*) p, true);
195 	}
196 
197 	/**
198 	 * Gets the current clock used by @pipeline. Users of object
199 	 * oriented languages should use gst_pipeline_get_pipeline_clock()
200 	 * to avoid confusion with gst_element_get_clock() which has a different behavior.
201 	 *
202 	 * Unlike gst_element_get_clock(), this function will always return a
203 	 * clock, even if the pipeline is not in the PLAYING state.
204 	 *
205 	 * Returns: a #GstClock, unref after usage.
206 	 */
207 	public override Clock getClock()
208 	{
209 		auto p = gst_pipeline_get_clock(gstPipeline);
210 		
211 		if(p is null)
212 		{
213 			return null;
214 		}
215 		
216 		return ObjectG.getDObject!(Clock)(cast(GstClock*) p, true);
217 	}
218 
219 	/**
220 	 * Get the configured delay (see gst_pipeline_set_delay()).
221 	 *
222 	 * Returns: The configured delay.
223 	 *
224 	 *     MT safe.
225 	 */
226 	public GstClockTime getDelay()
227 	{
228 		return gst_pipeline_get_delay(gstPipeline);
229 	}
230 
231 	/**
232 	 * Gets the latency that should be configured on the pipeline. See
233 	 * gst_pipeline_set_latency().
234 	 *
235 	 * Returns: Latency to configure on the pipeline or GST_CLOCK_TIME_NONE
236 	 *
237 	 * Since: 1.6
238 	 */
239 	public GstClockTime getLatency()
240 	{
241 		return gst_pipeline_get_latency(gstPipeline);
242 	}
243 
244 	/**
245 	 * Gets the current clock used by @pipeline.
246 	 *
247 	 * Unlike gst_element_get_clock(), this function will always return a
248 	 * clock, even if the pipeline is not in the PLAYING state.
249 	 *
250 	 * Returns: a #GstClock, unref after usage.
251 	 *
252 	 * Since: 1.6
253 	 */
254 	public Clock getPipelineClock()
255 	{
256 		auto p = gst_pipeline_get_pipeline_clock(gstPipeline);
257 		
258 		if(p is null)
259 		{
260 			return null;
261 		}
262 		
263 		return ObjectG.getDObject!(Clock)(cast(GstClock*) p, true);
264 	}
265 
266 	/**
267 	 * Usually, when a pipeline goes from READY to NULL state, it automatically
268 	 * flushes all pending messages on the bus, which is done for refcounting
269 	 * purposes, to break circular references.
270 	 *
271 	 * This means that applications that update state using (async) bus messages
272 	 * (e.g. do certain things when a pipeline goes from PAUSED to READY) might
273 	 * not get to see messages when the pipeline is shut down, because they might
274 	 * be flushed before they can be dispatched in the main thread. This behaviour
275 	 * can be disabled using this function.
276 	 *
277 	 * It is important that all messages on the bus are handled when the
278 	 * automatic flushing is disabled else memory leaks will be introduced.
279 	 *
280 	 * MT safe.
281 	 *
282 	 * Params:
283 	 *     autoFlush = whether or not to automatically flush the bus when
284 	 *         the pipeline goes from READY to NULL state
285 	 */
286 	public void setAutoFlushBus(bool autoFlush)
287 	{
288 		gst_pipeline_set_auto_flush_bus(gstPipeline, autoFlush);
289 	}
290 
291 	/**
292 	 * Set the clock for @pipeline. The clock will be distributed
293 	 * to all the elements managed by the pipeline.
294 	 *
295 	 * Params:
296 	 *     clock = the clock to set
297 	 *
298 	 * Returns: %TRUE if the clock could be set on the pipeline. %FALSE if
299 	 *     some element did not accept the clock.
300 	 *
301 	 *     MT safe.
302 	 */
303 	public override bool setClock(Clock clock)
304 	{
305 		return gst_pipeline_set_clock(gstPipeline, (clock is null) ? null : clock.getClockStruct()) != 0;
306 	}
307 
308 	/**
309 	 * Set the expected delay needed for all elements to perform the
310 	 * PAUSED to PLAYING state change. @delay will be added to the
311 	 * base time of the elements so that they wait an additional @delay
312 	 * amount of time before starting to process buffers and cannot be
313 	 * #GST_CLOCK_TIME_NONE.
314 	 *
315 	 * This option is used for tuning purposes and should normally not be
316 	 * used.
317 	 *
318 	 * MT safe.
319 	 *
320 	 * Params:
321 	 *     delay = the delay
322 	 */
323 	public void setDelay(GstClockTime delay)
324 	{
325 		gst_pipeline_set_delay(gstPipeline, delay);
326 	}
327 
328 	/**
329 	 * Sets the latency that should be configured on the pipeline. Setting
330 	 * GST_CLOCK_TIME_NONE will restore the default behaviour of using the minimum
331 	 * latency from the LATENCY query. Setting this is usually not required and
332 	 * the pipeline will figure out an appropriate latency automatically.
333 	 *
334 	 * Setting a too low latency, especially lower than the minimum latency from
335 	 * the LATENCY query, will most likely cause the pipeline to fail.
336 	 *
337 	 * Params:
338 	 *     latency = latency to configure
339 	 *
340 	 * Since: 1.6
341 	 */
342 	public void setLatency(GstClockTime latency)
343 	{
344 		gst_pipeline_set_latency(gstPipeline, latency);
345 	}
346 
347 	/**
348 	 * Force @pipeline to use the given @clock. The pipeline will
349 	 * always use the given clock even if new clock providers are added
350 	 * to this pipeline.
351 	 *
352 	 * If @clock is %NULL all clocking will be disabled which will make
353 	 * the pipeline run as fast as possible.
354 	 *
355 	 * MT safe.
356 	 *
357 	 * Params:
358 	 *     clock = the clock to use
359 	 */
360 	public void useClock(Clock clock)
361 	{
362 		gst_pipeline_use_clock(gstPipeline, (clock is null) ? null : clock.getClockStruct());
363 	}
364 }