2 * Copyright (C) 2015 Centricular Ltd
3 * @author: Edward Hervey <edward@centricular.com>
4 * @author: Jan Schmidt <jan@centricular.com>
6 * gststreams.h : Header for GstStream subsystem
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
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 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
25 #ifndef __GST_STREAMS_H__
26 #define __GST_STREAMS_H__
28 #include <gst/gstobject.h>
29 #include <gst/gstevent.h>
33 #define GST_TYPE_STREAM (gst_stream_get_type ())
34 #define GST_IS_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_STREAM))
35 #define GST_IS_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_STREAM))
36 #define GST_STREAM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_STREAM, GstStreamClass))
37 #define GST_STREAM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_STREAM, GstStream))
38 #define GST_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_STREAM, GstStreamClass))
39 #define GST_STREAM_CAST(obj) ((GstStream*)(obj))
43 * @GST_STREAM_TYPE_UNKNOWN: The stream is of unknown (unclassified) type.
44 * @GST_STREAM_TYPE_AUDIO: The stream is of audio data
45 * @GST_STREAM_TYPE_VIDEO: The stream carries video data
46 * @GST_STREAM_TYPE_CONTAINER: The stream is a muxed container type
47 * @GST_STREAM_TYPE_TEXT: The stream contains subtitle / subpicture data.
49 * #GstStreamType describes a high level classification set for
50 * flows of data in #GstStream objects.
52 * Note that this is a flag, and therefore users should not assume it
53 * will be a single value. Do not use the equality operator for checking
54 * whether a stream is of a certain type.
57 GST_STREAM_TYPE_UNKNOWN = 1 << 0,
58 GST_STREAM_TYPE_AUDIO = 1 << 1,
59 GST_STREAM_TYPE_VIDEO = 1 << 2,
60 GST_STREAM_TYPE_CONTAINER = 1 << 3,
61 GST_STREAM_TYPE_TEXT = 1 << 4
65 typedef struct _GstStream GstStream;
66 typedef struct _GstStreamClass GstStreamClass;
67 typedef struct _GstStreamPrivate GstStreamPrivate;
71 * @stream_id: The Stream Identifier for this #GstStream
73 * A high-level object representing a single stream. It might be backed, or
74 * not, by an actual flow of data in a pipeline (#GstPad).
76 * A #GstStream does not care about data changes (such as decoding, encoding,
77 * parsing,...) as long as the underlying data flow corresponds to the same
78 * high-level flow (ex: a certain audio track).
80 * A #GstStream contains all the information pertinent to a stream, such as
81 * stream-id, tags, caps, type, ...
83 * Elements can subclass a #GstStream for internal usage (to contain information
84 * pertinent to streams of data).
90 const gchar *stream_id;
93 GstStreamPrivate *priv;
95 gpointer _gst_reserved[GST_PADDING];
100 * @parent_class: the parent class structure
102 * GstStream class structure
104 struct _GstStreamClass {
105 GstObjectClass parent_class;
108 gpointer _gst_reserved[GST_PADDING];
111 GType gst_stream_get_type (void);
113 GstStream *gst_stream_new (const gchar *stream_id,
116 GstStreamFlags flags);
118 const gchar *gst_stream_get_stream_id (GstStream *stream);
120 void gst_stream_set_stream_flags (GstStream *stream, GstStreamFlags flags);
121 GstStreamFlags gst_stream_get_stream_flags (GstStream *stream);
123 void gst_stream_set_stream_type (GstStream *stream, GstStreamType stream_type);
124 GstStreamType gst_stream_get_stream_type (GstStream *stream);
126 void gst_stream_set_tags (GstStream *stream, GstTagList *tags);
127 GstTagList *gst_stream_get_tags (GstStream *stream);
129 void gst_stream_set_caps (GstStream *stream, GstCaps *caps);
130 GstCaps *gst_stream_get_caps (GstStream *stream);
132 const gchar *gst_stream_type_get_name (GstStreamType stype);
135 #endif /* __GST_STREAMS_H__ */