summaryrefslogtreecommitdiff
path: root/include/gst/play/gstplay-media-info.h
blob: 6796a380acff9ceaf4bbd1c49d92887ce0a76106 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
/* GStreamer
 *
 * Copyright (C) 2015 Brijesh Singh <brijesh.ksingh@gmail.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __GST_PLAY_MEDIA_INFO_H__
#define __GST_PLAY_MEDIA_INFO_H__

#include <gst/gst.h>
#include <gst/play/play-prelude.h>

G_BEGIN_DECLS

/**
 * GST_TYPE_PLAY_STREAM_INFO:
 * Since: 1.20
 */
#define GST_TYPE_PLAY_STREAM_INFO \
  (gst_play_stream_info_get_type ())
#define GST_PLAY_STREAM_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_STREAM_INFO,GstPlayStreamInfo))
#define GST_PLAY_STREAM_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_STREAM_INFO,GstPlayStreamInfo))
#define GST_IS_PLAY_STREAM_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_STREAM_INFO))
#define GST_IS_PLAY_STREAM_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_STREAM_INFO))

/**
 * GstPlayStreamInfo:
 *
 * Base structure for information concerning a media stream. Depending on
 * the stream type, one can find more media-specific information in
 * #GstPlayVideoInfo, #GstPlayAudioInfo, #GstPlaySubtitleInfo.
 * Since: 1.20
 */
typedef struct _GstPlayStreamInfo GstPlayStreamInfo;
typedef struct _GstPlayStreamInfoClass GstPlayStreamInfoClass;

GST_PLAY_API
GType         gst_play_stream_info_get_type (void);

GST_PLAY_API
gint          gst_play_stream_info_get_index (const GstPlayStreamInfo *info);

GST_PLAY_API
const gchar*  gst_play_stream_info_get_stream_type (const GstPlayStreamInfo *info);

GST_PLAY_API
GstTagList*   gst_play_stream_info_get_tags  (const GstPlayStreamInfo *info);

GST_PLAY_API
GstCaps*      gst_play_stream_info_get_caps  (const GstPlayStreamInfo *info);

GST_PLAY_API
const gchar*  gst_play_stream_info_get_codec (const GstPlayStreamInfo *info);

/**
 * GST_TYPE_PLAY_VIDEO_INFO:
 * Since: 1.20
 */
#define GST_TYPE_PLAY_VIDEO_INFO \
  (gst_play_video_info_get_type ())
#define GST_PLAY_VIDEO_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_VIDEO_INFO, GstPlayVideoInfo))
#define GST_PLAY_VIDEO_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((obj),GST_TYPE_PLAY_VIDEO_INFO, GstPlayVideoInfoClass))
#define GST_IS_PLAY_VIDEO_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_VIDEO_INFO))
#define GST_IS_PLAY_VIDEO_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((obj),GST_TYPE_PLAY_VIDEO_INFO))

/**
 * GstPlayVideoInfo:
 *
 * #GstPlayStreamInfo specific to video streams.
 * Since: 1.20
 */
typedef struct _GstPlayVideoInfo GstPlayVideoInfo;
typedef struct _GstPlayVideoInfoClass GstPlayVideoInfoClass;

GST_PLAY_API
GType         gst_play_video_info_get_type (void);

GST_PLAY_API
gint          gst_play_video_info_get_bitrate     (const GstPlayVideoInfo * info);

GST_PLAY_API
gint          gst_play_video_info_get_max_bitrate (const GstPlayVideoInfo * info);

GST_PLAY_API
gint          gst_play_video_info_get_width       (const GstPlayVideoInfo * info);

GST_PLAY_API
gint          gst_play_video_info_get_height      (const GstPlayVideoInfo * info);

GST_PLAY_API
void          gst_play_video_info_get_framerate   (const GstPlayVideoInfo * info,
                                                     gint * fps_n,
                                                     gint * fps_d);

GST_PLAY_API
void          gst_play_video_info_get_pixel_aspect_ratio (const GstPlayVideoInfo * info,
                                                            guint * par_n,
                                                            guint * par_d);

/**
 * GST_TYPE_PLAY_AUDIO_INFO:
 * Since: 1.20
 */
#define GST_TYPE_PLAY_AUDIO_INFO \
  (gst_play_audio_info_get_type ())
#define GST_PLAY_AUDIO_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_AUDIO_INFO, GstPlayAudioInfo))
#define GST_PLAY_AUDIO_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_AUDIO_INFO, GstPlayAudioInfoClass))
#define GST_IS_PLAY_AUDIO_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_AUDIO_INFO))
#define GST_IS_PLAY_AUDIO_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_AUDIO_INFO))

/**
 * GstPlayAudioInfo:
 *
 * #GstPlayStreamInfo specific to audio streams.
 * Since: 1.20
 */
typedef struct _GstPlayAudioInfo GstPlayAudioInfo;
typedef struct _GstPlayAudioInfoClass GstPlayAudioInfoClass;

GST_PLAY_API
GType         gst_play_audio_info_get_type (void);

GST_PLAY_API
gint          gst_play_audio_info_get_channels    (const GstPlayAudioInfo* info);

GST_PLAY_API
gint          gst_play_audio_info_get_sample_rate (const GstPlayAudioInfo* info);

GST_PLAY_API
gint          gst_play_audio_info_get_bitrate     (const GstPlayAudioInfo* info);

GST_PLAY_API
gint          gst_play_audio_info_get_max_bitrate (const GstPlayAudioInfo* info);

GST_PLAY_API
const gchar*  gst_play_audio_info_get_language    (const GstPlayAudioInfo* info);

/**
 * GST_TYPE_PLAY_SUBTITLE_INFO:
 * Since: 1.20
 */
#define GST_TYPE_PLAY_SUBTITLE_INFO \
  (gst_play_subtitle_info_get_type ())
#define GST_PLAY_SUBTITLE_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_SUBTITLE_INFO, GstPlaySubtitleInfo))
#define GST_PLAY_SUBTITLE_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_SUBTITLE_INFO,GstPlaySubtitleInfoClass))
#define GST_IS_PLAY_SUBTITLE_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_SUBTITLE_INFO))
#define GST_IS_PLAY_SUBTITLE_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_SUBTITLE_INFO))

/**
 * GstPlaySubtitleInfo:
 *
 * #GstPlayStreamInfo specific to subtitle streams.
 * Since: 1.20
 */
typedef struct _GstPlaySubtitleInfo GstPlaySubtitleInfo;
typedef struct _GstPlaySubtitleInfoClass GstPlaySubtitleInfoClass;

GST_PLAY_API
GType         gst_play_subtitle_info_get_type (void);

GST_PLAY_API
const gchar * gst_play_subtitle_info_get_language (const GstPlaySubtitleInfo* info);

/**
 * GST_TYPE_PLAY_MEDIA_INFO:
 * Since: 1.20
 */
#define GST_TYPE_PLAY_MEDIA_INFO \
  (gst_play_media_info_get_type())
#define GST_PLAY_MEDIA_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_PLAY_MEDIA_INFO,GstPlayMediaInfo))
#define GST_PLAY_MEDIA_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_PLAY_MEDIA_INFO,GstPlayMediaInfoClass))
#define GST_IS_PLAY_MEDIA_INFO(obj) \
  (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_PLAY_MEDIA_INFO))
#define GST_IS_PLAY_MEDIA_INFO_CLASS(klass) \
  (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_PLAY_MEDIA_INFO))

/**
 * GstPlayMediaInfo:
 *
 * Structure containing the media information of a URI.
 * Since: 1.20
 */
typedef struct _GstPlayMediaInfo GstPlayMediaInfo;
typedef struct _GstPlayMediaInfoClass GstPlayMediaInfoClass;

GST_PLAY_API
GType         gst_play_media_info_get_type (void);

GST_PLAY_API
const gchar * gst_play_media_info_get_uri (const GstPlayMediaInfo *info);

GST_PLAY_API
gboolean      gst_play_media_info_is_seekable (const GstPlayMediaInfo *info);

GST_PLAY_API
gboolean      gst_play_media_info_is_live (const GstPlayMediaInfo *info);

GST_PLAY_API
GstClockTime  gst_play_media_info_get_duration (const GstPlayMediaInfo *info);

GST_PLAY_API
GList*        gst_play_media_info_get_stream_list (const GstPlayMediaInfo *info);

GST_PLAY_API
guint         gst_play_media_info_get_number_of_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
GList*        gst_play_media_info_get_video_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
guint         gst_play_media_info_get_number_of_video_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
GList*        gst_play_media_info_get_audio_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
guint         gst_play_media_info_get_number_of_audio_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
GList*        gst_play_media_info_get_subtitle_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
guint         gst_play_media_info_get_number_of_subtitle_streams (const GstPlayMediaInfo *info);

GST_PLAY_API
GstTagList*   gst_play_media_info_get_tags (const GstPlayMediaInfo *info);

GST_PLAY_API
const gchar*  gst_play_media_info_get_title (const GstPlayMediaInfo *info);

GST_PLAY_API
const gchar*  gst_play_media_info_get_container_format (const GstPlayMediaInfo *info);

GST_PLAY_API
GstSample*    gst_play_media_info_get_image_sample (const GstPlayMediaInfo *info);

GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_video_streams)
GList*        gst_play_get_video_streams    (const GstPlayMediaInfo *info);

GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_audio_streams)
GList*        gst_play_get_audio_streams    (const GstPlayMediaInfo *info);

GST_PLAY_DEPRECATED_FOR(gst_play_media_info_get_subtitle_streams)
GList*        gst_play_get_subtitle_streams (const GstPlayMediaInfo *info);

G_END_DECLS

#endif /* __GST_PLAY_MEDIA_INFO_H */