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
|
/*
* Farstream - Farstream Session
*
* Copyright 2007 Collabora Ltd.
* @author: Philippe Kalaf <philippe.kalaf@collabora.co.uk>
* Copyright 2007 Nokia Corp.
*
* fs-session.h - A Farstream Session gobject (base implementation)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef __FS_SESSION_H__
#define __FS_SESSION_H__
#include <glib.h>
#include <glib-object.h>
#include <farstream/fs-stream.h>
#include <farstream/fs-participant.h>
#include <farstream/fs-codec.h>
G_BEGIN_DECLS
/* TYPE MACROS */
#define FS_TYPE_SESSION \
(fs_session_get_type ())
#define FS_SESSION(obj) \
(G_TYPE_CHECK_INSTANCE_CAST((obj), FS_TYPE_SESSION, FsSession))
#define FS_SESSION_CLASS(klass) \
(G_TYPE_CHECK_CLASS_CAST((klass), FS_TYPE_SESSION, FsSessionClass))
#define FS_IS_SESSION(obj) \
(G_TYPE_CHECK_INSTANCE_TYPE((obj), FS_TYPE_SESSION))
#define FS_IS_SESSION_CLASS(klass) \
(G_TYPE_CHECK_CLASS_TYPE((klass), FS_TYPE_SESSION))
#define FS_SESSION_GET_CLASS(obj) \
(G_TYPE_INSTANCE_GET_CLASS ((obj), FS_TYPE_SESSION, FsSessionClass))
#define FS_SESSION_CAST(obj) ((FsSession *) (obj))
typedef struct _FsSession FsSession;
typedef struct _FsSessionClass FsSessionClass;
typedef struct _FsSessionPrivate FsSessionPrivate;
/**
* FsDTMFEvent:
*
* An enum that represents the different DTMF event that can be sent to a
* #FsSession. The values corresponds those those defined in RFC 4733
* The rest of the possibles values are in the IANA registry at:
* http://www.iana.org/assignments/audio-telephone-event-registry
*
*/
typedef enum _FsDTMFEvent
{
/*< protected >*/
FS_DTMF_EVENT_0 = 0,
FS_DTMF_EVENT_1 = 1,
FS_DTMF_EVENT_2 = 2,
FS_DTMF_EVENT_3 = 3,
FS_DTMF_EVENT_4 = 4,
FS_DTMF_EVENT_5 = 5,
FS_DTMF_EVENT_6 = 6,
FS_DTMF_EVENT_7 = 7,
FS_DTMF_EVENT_8 = 8,
FS_DTMF_EVENT_9 = 9,
FS_DTMF_EVENT_STAR = 10,
FS_DTMF_EVENT_POUND = 11,
FS_DTMF_EVENT_A = 12,
FS_DTMF_EVENT_B = 13,
FS_DTMF_EVENT_C = 14,
FS_DTMF_EVENT_D = 15
} FsDTMFEvent;
/**
* FsDTMFMethod:
* @FS_DTMF_METHOD_RTP_RFC4733: Send as a special payload type defined by RFC 4733
* (which obsoletes RFC 2833)
* @FS_DTMF_METHOD_SOUND: Send as tones as in-band audio sound
*
* An enum that represents the different ways a DTMF event can be sent
*
*/
typedef enum _FsDTMFMethod
{
FS_DTMF_METHOD_RTP_RFC4733 = 1,
FS_DTMF_METHOD_SOUND = 2
} FsDTMFMethod;
/**
* FsSessionClass:
* @parent_class: Our parent
* @new_stream: Create a new #FsStream
* @start_telephony_event: Starts a telephony event
* @stop_telephony_event: Stops a telephony event
* @set_send_codec: Forces sending with a specific codec
* @set_codec_preferences: Specifies the codec preferences
* @list_transmitters: Returns a list of the available transmitters
* @get_stream_transmitter_type: Returns the GType of the stream transmitter
* @codecs_need_resend: Returns the list of codecs that need resending
* @set_allowed_caps: Set the possible allowed src and sink caps
* @set_encryption_parameters: Set encryption parameters
*
* You must override at least new_stream in a subclass.
*/
struct _FsSessionClass
{
GObjectClass parent_class;
/*virtual functions */
FsStream *(* new_stream) (FsSession *session,
FsParticipant *participant,
FsStreamDirection direction,
GError **error);
gboolean (* start_telephony_event) (FsSession *session, guint8 event,
guint8 volume);
gboolean (* stop_telephony_event) (FsSession *session);
gboolean (* set_send_codec) (FsSession *session, FsCodec *send_codec,
GError **error);
gboolean (* set_codec_preferences) (FsSession *session,
GList *codec_preferences,
GError **error);
gchar** (* list_transmitters) (FsSession *session);
GType (* get_stream_transmitter_type) (FsSession *session,
const gchar *transmitter);
GList* (* codecs_need_resend) (FsSession *session, GList *old_codecs,
GList *new_codecs);
gboolean (* set_allowed_caps) (FsSession *session, GstCaps *sink_caps,
GstCaps *src_caps, GError **error);
gboolean (* set_encryption_parameters) (FsSession *session,
GstStructure *parameters, GError **error);
/*< private >*/
gpointer _padding[6];
};
/**
* FsSession:
*
* All members are private, access them using methods and properties
*/
struct _FsSession
{
GObject parent;
/*< private >*/
FsSessionPrivate *priv;
gpointer _padding[8];
};
GType fs_session_get_type (void);
FsStream *fs_session_new_stream (FsSession *session,
FsParticipant *participant,
FsStreamDirection direction,
GError **error);
gboolean fs_session_start_telephony_event (FsSession *session, guint8 event,
guint8 volume);
gboolean fs_session_stop_telephony_event (FsSession *session);
gboolean fs_session_set_send_codec (FsSession *session, FsCodec *send_codec,
GError **error);
gboolean fs_session_set_codec_preferences (FsSession *session,
GList *codec_preferences,
GError **error);
gchar **fs_session_list_transmitters (FsSession *session);
void fs_session_emit_error (FsSession *session,
gint error_no,
const gchar *error_msg);
GType fs_session_get_stream_transmitter_type (FsSession *session,
const gchar *transmitter);
GList* fs_session_codecs_need_resend (FsSession *session,
GList *old_codecs, GList *new_codecs);
gboolean fs_session_set_allowed_caps (FsSession *session, GstCaps *sink_caps,
GstCaps *src_caps, GError **error);
gboolean fs_session_set_encryption_parameters (FsSession *session,
GstStructure *parameters, GError **error);
void fs_session_destroy (FsSession *session);
gboolean fs_session_parse_send_codec_changed (FsSession *session,
GstMessage *message,
FsCodec **codec,
GList **secondary_codecs);
gboolean fs_session_parse_codecs_changed (FsSession *session,
GstMessage *message);
gboolean fs_session_parse_telephony_event_started (FsSession *session,
GstMessage *message,
FsDTMFMethod *method,
FsDTMFEvent *event,
guint8 *volume);
gboolean fs_session_parse_telephony_event_stopped (FsSession *session,
GstMessage *message,
FsDTMFMethod *method);
G_END_DECLS
#endif /* __FS_SESSION_H__ */
|
