summaryrefslogtreecommitdiff
path: root/gst-libs/gst/player/gstplayer.h
blob: e13499a111af0bb7d8ee955d1485cc378fdb6442 (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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
/* GStreamer
 *
 * Copyright (C) 2014-2015 Sebastian Dröge <sebastian@centricular.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_PLAYER_H__
#define __GST_PLAYER_H__

#include <gst/gst.h>
#include <gst/video/video.h>
#include <gst/player/gstplayer-types.h>
#include <gst/player/gstplayer-signal-dispatcher.h>
#include <gst/player/gstplayer-video-renderer.h>
#include <gst/player/gstplayer-media-info.h>

G_BEGIN_DECLS

GST_EXPORT
GType        gst_player_state_get_type                (void);
#define      GST_TYPE_PLAYER_STATE                    (gst_player_state_get_type ())

/**
 * GstPlayerState:
 * @GST_PLAYER_STATE_STOPPED: the player is stopped.
 * @GST_PLAYER_STATE_BUFFERING: the player is buffering.
 * @GST_PLAYER_STATE_PAUSED: the player is paused.
 * @GST_PLAYER_STATE_PLAYING: the player is currently playing a
 * stream.
 */
typedef enum
{
  GST_PLAYER_STATE_STOPPED,
  GST_PLAYER_STATE_BUFFERING,
  GST_PLAYER_STATE_PAUSED,
  GST_PLAYER_STATE_PLAYING
} GstPlayerState;

GST_EXPORT
const gchar *gst_player_state_get_name                (GstPlayerState state);

GST_EXPORT
GQuark       gst_player_error_quark                   (void);

GST_EXPORT
GType        gst_player_error_get_type                (void);
#define      GST_PLAYER_ERROR                         (gst_player_error_quark ())
#define      GST_TYPE_PLAYER_ERROR                    (gst_player_error_get_type ())

/**
 * GstPlayerError:
 * @GST_PLAYER_ERROR_FAILED: generic error.
 */
typedef enum {
  GST_PLAYER_ERROR_FAILED = 0
} GstPlayerError;

GST_EXPORT
const gchar *gst_player_error_get_name                (GstPlayerError error);

GST_EXPORT
GType gst_player_color_balance_type_get_type          (void);
#define GST_TYPE_PLAYER_COLOR_BALANCE_TYPE            (gst_player_color_balance_type_get_type ())

/**
 * GstPlayerColorBalanceType:
 * @GST_PLAYER_COLOR_BALANCE_BRIGHTNESS: brightness or black level.
 * @GST_PLAYER_COLOR_BALANCE_CONTRAST: contrast or luma gain.
 * @GST_PLAYER_COLOR_BALANCE_SATURATION: color saturation or chroma
 * gain.
 * @GST_PLAYER_COLOR_BALANCE_HUE: hue or color balance.
 */
typedef enum
{
  GST_PLAYER_COLOR_BALANCE_BRIGHTNESS,
  GST_PLAYER_COLOR_BALANCE_CONTRAST,
  GST_PLAYER_COLOR_BALANCE_SATURATION,
  GST_PLAYER_COLOR_BALANCE_HUE,
} GstPlayerColorBalanceType;

GST_EXPORT
const gchar *gst_player_color_balance_type_get_name   (GstPlayerColorBalanceType type);

#define GST_TYPE_PLAYER             (gst_player_get_type ())
#define GST_IS_PLAYER(obj)          (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLAYER))
#define GST_IS_PLAYER_CLASS(klass)  (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLAYER))
#define GST_PLAYER_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_PLAYER, GstPlayerClass))
#define GST_PLAYER(obj)             (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLAYER, GstPlayer))
#define GST_PLAYER_CLASS(klass)     (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLAYER, GstPlayerClass))
#define GST_PLAYER_CAST(obj)        ((GstPlayer*)(obj))


GST_EXPORT
GType        gst_player_get_type                      (void);

GST_EXPORT
GstPlayer *  gst_player_new                           (GstPlayerVideoRenderer * video_renderer, GstPlayerSignalDispatcher * signal_dispatcher);

GST_EXPORT
void         gst_player_play                          (GstPlayer    * player);

GST_EXPORT
void         gst_player_pause                         (GstPlayer    * player);

GST_EXPORT
void         gst_player_stop                          (GstPlayer    * player);

GST_EXPORT
void         gst_player_seek                          (GstPlayer    * player,
                                                       GstClockTime   position);

GST_EXPORT
void         gst_player_set_rate                      (GstPlayer    * player,
                                                       gdouble        rate);

GST_EXPORT
gdouble      gst_player_get_rate                      (GstPlayer    * player);

GST_EXPORT
gchar *      gst_player_get_uri                       (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_uri                       (GstPlayer    * player,
                                                       const gchar  * uri);

GST_EXPORT
gchar *      gst_player_get_subtitle_uri              (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_subtitle_uri              (GstPlayer    * player,
                                                       const gchar *uri);

GST_EXPORT
GstClockTime gst_player_get_position                  (GstPlayer    * player);

GST_EXPORT
GstClockTime gst_player_get_duration                  (GstPlayer    * player);

GST_EXPORT
gdouble      gst_player_get_volume                    (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_volume                    (GstPlayer    * player,
                                                       gdouble        val);

GST_EXPORT
gboolean     gst_player_get_mute                      (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_mute                      (GstPlayer    * player,
                                                       gboolean       val);

GST_EXPORT
GstElement * gst_player_get_pipeline                  (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_video_track_enabled       (GstPlayer    * player,
                                                       gboolean enabled);

GST_EXPORT
void         gst_player_set_audio_track_enabled       (GstPlayer    * player,
                                                       gboolean enabled);

GST_EXPORT
void         gst_player_set_subtitle_track_enabled    (GstPlayer    * player,
                                                       gboolean enabled);

GST_EXPORT
gboolean     gst_player_set_audio_track               (GstPlayer    *player,
                                                       gint stream_index);

GST_EXPORT
gboolean     gst_player_set_video_track               (GstPlayer    *player,
                                                       gint stream_index);

GST_EXPORT
gboolean     gst_player_set_subtitle_track            (GstPlayer    *player,
                                                       gint stream_index);

GST_EXPORT
GstPlayerMediaInfo *    gst_player_get_media_info     (GstPlayer * player);

GST_EXPORT
GstPlayerAudioInfo *    gst_player_get_current_audio_track (GstPlayer * player);

GST_EXPORT
GstPlayerVideoInfo *    gst_player_get_current_video_track (GstPlayer * player);

GST_EXPORT
GstPlayerSubtitleInfo * gst_player_get_current_subtitle_track (GstPlayer * player);

GST_EXPORT
gboolean     gst_player_set_visualization             (GstPlayer    * player,
                                                       const gchar *name);

GST_EXPORT
void         gst_player_set_visualization_enabled     (GstPlayer    * player,
                                                       gboolean enabled);

GST_EXPORT
gchar *      gst_player_get_current_visualization     (GstPlayer    * player);

GST_EXPORT
gboolean     gst_player_has_color_balance             (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_color_balance             (GstPlayer    * player,
                                                       GstPlayerColorBalanceType type,
                                                       gdouble value);

GST_EXPORT
gdouble      gst_player_get_color_balance             (GstPlayer    * player,
                                                       GstPlayerColorBalanceType type);


GST_EXPORT
GstVideoMultiviewFramePacking gst_player_get_multiview_mode (GstPlayer    * player);

GST_EXPORT
void                     gst_player_set_multiview_mode (GstPlayer    * player,
                                                        GstVideoMultiviewFramePacking mode);

GST_EXPORT
GstVideoMultiviewFlags  gst_player_get_multiview_flags  (GstPlayer  * player);

GST_EXPORT
void                    gst_player_set_multiview_flags  (GstPlayer  * player,
                                                         GstVideoMultiviewFlags flags);

GST_EXPORT
gint64       gst_player_get_audio_video_offset        (GstPlayer    * player);

GST_EXPORT
void         gst_player_set_audio_video_offset        (GstPlayer    * player,
                                                       gint64 offset);

GST_EXPORT
gboolean       gst_player_set_config                  (GstPlayer * player,
                                                       GstStructure * config);

GST_EXPORT
GstStructure * gst_player_get_config                  (GstPlayer * player);

/* helpers for configuring the config structure */

GST_EXPORT
void           gst_player_config_set_user_agent       (GstStructure * config,
                                                       const gchar * agent);

GST_EXPORT
gchar *        gst_player_config_get_user_agent       (const GstStructure * config);

GST_EXPORT
void           gst_player_config_set_position_update_interval  (GstStructure * config,
                                                                guint          interval);

GST_EXPORT
guint          gst_player_config_get_position_update_interval  (const GstStructure * config);

GST_EXPORT
void           gst_player_config_set_seek_accurate (GstStructure * config, gboolean accurate);

GST_EXPORT
gboolean       gst_player_config_get_seek_accurate (const GstStructure * config);

typedef enum
{
  GST_PLAYER_THUMBNAIL_RAW_NATIVE = 0,
  GST_PLAYER_THUMBNAIL_RAW_xRGB,
  GST_PLAYER_THUMBNAIL_RAW_BGRx,
  GST_PLAYER_THUMBNAIL_JPG,
  GST_PLAYER_THUMBNAIL_PNG
} GstPlayerSnapshotFormat;

GST_EXPORT
GstSample * gst_player_get_video_snapshot (GstPlayer * player,
    GstPlayerSnapshotFormat format, const GstStructure * config);

G_END_DECLS

#endif /* __GST_PLAYER_H__ */