1 /* GStreamer
2  * Copyright (C) <2007> Wim Taymans <wim.taymans@gmail.com>
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public
15  * License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19 
20 #ifndef __GST_PLAY_SINK_H__
21 #define __GST_PLAY_SINK_H__
22 
23 #include <gst/gst.h>
24 
25 #include "gstplay-enum.h"
26 
27 G_BEGIN_DECLS
28 
29 #define GST_TYPE_PLAY_SINK \
30   (gst_play_sink_get_type())
31 #define GST_PLAY_SINK(obj) \
32   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_PLAY_SINK, GstPlaySink))
33 #define GST_PLAY_SINK_CLASS(klass) \
34   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_PLAY_SINK, GstPlaySinkClass))
35 #define GST_IS_PLAY_SINK(obj) \
36   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_PLAY_SINK))
37 #define GST_IS_PLAY_SINK_CLASS(klass) \
38   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_PLAY_SINK))
39 #define GST_PLAY_SINK_CAST(obj) \
40   ((GstPlaySink*)(obj))
41 
42 /**
43  * GstPlaySinkType:
44  * @GST_PLAY_SINK_TYPE_AUDIO: an audio pad
45  * @GST_PLAY_SINK_TYPE_AUDIO_RAW: a raw audio pad. Deprecated.
46  * @GST_PLAY_SINK_TYPE_VIDEO: a video pad
47  * @GST_PLAY_SINK_TYPE_VIDEO_RAW: a raw video pad. Deprecated.
48  * @GST_PLAY_SINK_TYPE_TEXT: a text pad
49  * @GST_PLAY_SINK_TYPE_LAST: the last type
50  * @GST_PLAY_SINK_TYPE_FLUSHING: a flushing pad, used when shutting down
51  *
52  * Types of pads that can be requested from the sinks.
53  */
54 typedef enum {
55   GST_PLAY_SINK_TYPE_AUDIO     = 0,
56   GST_PLAY_SINK_TYPE_AUDIO_RAW = 1,
57   GST_PLAY_SINK_TYPE_VIDEO     = 2,
58   GST_PLAY_SINK_TYPE_VIDEO_RAW = 3,
59   GST_PLAY_SINK_TYPE_TEXT      = 4,
60   GST_PLAY_SINK_TYPE_LAST      = 5,
61 
62   /* this is a dummy pad */
63   GST_PLAY_SINK_TYPE_FLUSHING  = 6
64 } GstPlaySinkType;
65 
66 typedef struct _GstPlaySink GstPlaySink;
67 typedef struct _GstPlaySinkClass GstPlaySinkClass;
68 
69 GType gst_play_sink_get_type (void);
70 
71 GstPad *         gst_play_sink_request_pad    (GstPlaySink *playsink, GstPlaySinkType type);
72 void             gst_play_sink_release_pad    (GstPlaySink *playsink, GstPad *pad);
73 void             gst_play_sink_refresh_pad    (GstPlaySink *playsink, GstPad *pad, GstPlaySinkType type);
74 
75 void             gst_play_sink_set_filter     (GstPlaySink * playsink, GstPlaySinkType type, GstElement * filter);
76 GstElement *     gst_play_sink_get_filter     (GstPlaySink * playsink, GstPlaySinkType type);
77 
78 void             gst_play_sink_set_sink       (GstPlaySink * playsink, GstPlaySinkType type, GstElement * sink);
79 GstElement *     gst_play_sink_get_sink       (GstPlaySink * playsink, GstPlaySinkType type);
80 
81 void             gst_play_sink_set_vis_plugin (GstPlaySink * playsink, GstElement * vis);
82 GstElement *     gst_play_sink_get_vis_plugin (GstPlaySink * playsink);
83 
84 void             gst_play_sink_set_volume     (GstPlaySink *playsink, gdouble volume);
85 gdouble          gst_play_sink_get_volume     (GstPlaySink *playsink);
86 
87 void             gst_play_sink_set_mute       (GstPlaySink *playsink, gboolean mute);
88 gboolean         gst_play_sink_get_mute       (GstPlaySink *playsink);
89 
90 gboolean         gst_play_sink_set_flags      (GstPlaySink * playsink, GstPlayFlags flags);
91 GstPlayFlags     gst_play_sink_get_flags      (GstPlaySink * playsink);
92 
93 void             gst_play_sink_set_font_desc  (GstPlaySink *playsink, const gchar * desc);
94 gchar *          gst_play_sink_get_font_desc  (GstPlaySink *playsink);
95 void             gst_play_sink_set_subtitle_encoding  (GstPlaySink *playsink, const gchar * encoding);
96 gchar *          gst_play_sink_get_subtitle_encoding  (GstPlaySink *playsink);
97 
98 void             gst_play_sink_set_av_offset  (GstPlaySink *playsink, gint64 av_offset);
99 gint64           gst_play_sink_get_av_offset  (GstPlaySink *playsink);
100 
101 void             gst_play_sink_set_text_offset  (GstPlaySink *playsink, gint64 text_offset);
102 gint64           gst_play_sink_get_text_offset  (GstPlaySink *playsink);
103 
104 GstSample *      gst_play_sink_get_last_sample (GstPlaySink * playsink);
105 GstSample *      gst_play_sink_convert_sample  (GstPlaySink * playsink, GstCaps * caps);
106 
107 gboolean         gst_play_sink_reconfigure    (GstPlaySink * playsink);
108 
109 gboolean         gst_play_sink_plugin_init    (GstPlugin * plugin);
110 
111 G_END_DECLS
112 
113 #endif /* __GST_PLAY_SINK_H__ */
114