1/* GStreamer
2 * Copyright (C) 2015 Centricular Ltd
3 * @author: Edward Hervey <[email protected]>
4 * @author: Jan Schmidt <[email protected]>
5 *
6 * gststreams.h : Header for GstStream subsystem
7 *
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.
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 * Library General Public License for more details.
17 *
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.
22 */
23
24
25#ifndef __GST_STREAMS_H__
26#define __GST_STREAMS_H__
27
28#include <gst/gstobject.h>
29
30G_BEGIN_DECLS
31
32#define GST_TYPE_STREAM (gst_stream_get_type ())
33#define GST_IS_STREAM(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_STREAM))
34#define GST_IS_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_STREAM))
35#define GST_STREAM_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_STREAM, GstStreamClass))
36#define GST_STREAM(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_STREAM, GstStream))
37#define GST_STREAM_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_STREAM, GstStreamClass))
38#define GST_STREAM_CAST(obj) ((GstStream*)(obj))
39
40/**
41 * GstStreamType:
42 * @GST_STREAM_TYPE_UNKNOWN: The stream is of unknown (unclassified) type.
43 * @GST_STREAM_TYPE_AUDIO: The stream is of audio data
44 * @GST_STREAM_TYPE_VIDEO: The stream carries video data
45 * @GST_STREAM_TYPE_CONTAINER: The stream is a muxed container type
46 * @GST_STREAM_TYPE_TEXT: The stream contains subtitle / subpicture data.
47 *
48 * #GstStreamType describes a high level classification set for
49 * flows of data in #GstStream objects.
50 *
51 * Note that this is a flag, and therefore users should not assume it
52 * will be a single value. Do not use the equality operator for checking
53 * whether a stream is of a certain type.
54 *
55 * Since: 1.10
56 */
57typedef enum {
58 GST_STREAM_TYPE_UNKNOWN = 1 << 0,
59 GST_STREAM_TYPE_AUDIO = 1 << 1,
60 GST_STREAM_TYPE_VIDEO = 1 << 2,
61 GST_STREAM_TYPE_CONTAINER = 1 << 3,
62 GST_STREAM_TYPE_TEXT = 1 << 4
63} GstStreamType;
64
65
66typedef struct _GstStream GstStream;
67typedef struct _GstStreamClass GstStreamClass;
68typedef struct _GstStreamPrivate GstStreamPrivate;
69
70/**
71 * GstStream:
72 * @stream_id: The Stream Identifier for this #GstStream
73 *
74 * A high-level object representing a single stream. It might be backed, or
75 * not, by an actual flow of data in a pipeline (#GstPad).
76 *
77 * A #GstStream does not care about data changes (such as decoding, encoding,
78 * parsing,...) as long as the underlying data flow corresponds to the same
79 * high-level flow (ex: a certain audio track).
80 *
81 * A #GstStream contains all the information pertinent to a stream, such as
82 * stream-id, tags, caps, type, ...
83 *
84 * Elements can subclass a #GstStream for internal usage (to contain information
85 * pertinent to streams of data).
86 *
87 * Since: 1.10
88 */
89struct _GstStream {
90 /*< private >*/
91 GstObject object;
92
93 /*< public >*/
94 const gchar *stream_id;
95
96 /*< private >*/
97 GstStreamPrivate *priv;
98
99 gpointer _gst_reserved[GST_PADDING];
100};
101
102/**
103 * GstStreamClass:
104 * @parent_class: the parent class structure
105 *
106 * GstStream class structure
107 */
108struct _GstStreamClass {
109 GstObjectClass parent_class;
110
111 /*< private >*/
112 gpointer _gst_reserved[GST_PADDING];
113};
114
115GST_API
116GType gst_stream_get_type (void);
117
118#include <gst/gstevent.h>
119
120GST_API
121GstStream *gst_stream_new (const gchar *stream_id,
122 GstCaps *caps,
123 GstStreamType type,
124 GstStreamFlags flags);
125GST_API
126const gchar * gst_stream_get_stream_id (GstStream *stream);
127
128GST_API
129void gst_stream_set_stream_flags (GstStream *stream, GstStreamFlags flags);
130
131GST_API
132GstStreamFlags gst_stream_get_stream_flags (GstStream *stream);
133
134GST_API
135void gst_stream_set_stream_type (GstStream *stream, GstStreamType stream_type);
136
137GST_API
138GstStreamType gst_stream_get_stream_type (GstStream *stream);
139
140GST_API
141void gst_stream_set_tags (GstStream *stream, GstTagList *tags);
142
143GST_API
144GstTagList * gst_stream_get_tags (GstStream *stream);
145
146GST_API
147void gst_stream_set_caps (GstStream *stream, GstCaps *caps);
148
149GST_API
150GstCaps * gst_stream_get_caps (GstStream *stream);
151
152GST_API
153const gchar * gst_stream_type_get_name (GstStreamType stype);
154
155#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
156G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstStream, gst_object_unref)
157#endif
158
159G_END_DECLS
160
161#endif /* __GST_STREAMS_H__ */
162