call.h 9.03 KB
Newer Older
yanmorin's avatar
   
yanmorin committed
1
/*
2
 *  Copyright (C) 2004, 2005, 2006, 2009, 2008, 2009, 2010 Savoir-Faire Linux Inc.
Emmanuel Milou's avatar
Emmanuel Milou committed
3
 *  Author: Emmanuel Milou <emmanuel.milou@savoirfairelinux.com>
jpbl's avatar
jpbl committed
4
 *  Author: Yan Morin <yan.morin@savoirfairelinux.com>
yanmorin's avatar
   
yanmorin committed
5
6
 *  Author : Laurielle Lea <laurielle.lea@savoirfairelinux.com>
 *
jpbl's avatar
jpbl committed
7
8
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
9
 *  the Free Software Foundation; either version 3 of the License, or
jpbl's avatar
jpbl committed
10
 *  (at your option) any later version.
yanmorin's avatar
   
yanmorin committed
11
 *
jpbl's avatar
jpbl committed
12
13
14
15
 *  This program 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 General Public License for more details.
yanmorin's avatar
   
yanmorin committed
16
 *
jpbl's avatar
jpbl committed
17
18
19
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *   Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20
21
22
23
24
25
26
27
28
29
30
 *
 *  Additional permission under GNU GPL version 3 section 7:
 *
 *  If you modify this program, or any covered work, by linking or
 *  combining it with the OpenSSL project's OpenSSL library (or a
 *  modified version of that library), containing parts covered by the
 *  terms of the OpenSSL or SSLeay licenses, Savoir-Faire Linux Inc.
 *  grants you additional permission to convey the resulting work.
 *  Corresponding Source for a non-source form of such a combination
 *  shall include the source code for the parts of OpenSSL used as well
 *  as that of the covered work.
jpbl's avatar
jpbl committed
31
 */
yanmorin's avatar
   
yanmorin committed
32
33
#ifndef CALL_H
#define CALL_H
jpbl's avatar
jpbl committed
34

yanmorin's avatar
   
yanmorin committed
35
#include <cc++/thread.h> // for mutex
36
#include <sstream>
37

38
39
// #include "plug-in/audiorecorder/audiorecord.h"
#include "audio/recordable.h"
yanmorin's avatar
   
yanmorin committed
40

41
42
43
44
#define SIP_SCHEME       "sip:"
#define SIPS_SCHEME      "sips:"

#define CallConfigNULL   NULL
Emmanuel Milou's avatar
Emmanuel Milou committed
45

46
47
48
49
50
/* 
 * @file call.h 
 * @brief A call is the base class for protocol-based calls
 */

yanmorin's avatar
   
yanmorin committed
51
52
typedef std::string CallID;

53
class Call: public Recordable{
Emmanuel Milou's avatar
Emmanuel Milou committed
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
    public:

        /**
         * This determines if the call is a direct IP-to-IP call or a classic call, made with an existing account
         */
        enum CallConfiguration {Classic, IPtoIP};

        /**
         * This determines if the call originated from the local user (Outgoing)
         * or from some remote peer (Incoming).
         */
        enum CallType {Incoming, Outgoing};

        /**
         * Tell where we're at with the call. The call gets Connected when we know
         * from the other end what happened with out call. A call can be 'Connected'
         * even if the call state is Busy, Refused, or Error.
         *
         * Audio should be transmitted when ConnectionState = Connected AND
         * CallState = Active.
         */
        enum ConnectionState {Disconnected, Trying, Progressing, Ringing, Connected};

        /**
         * The Call State.
         */
80
        enum CallState {Inactive, Active, Hold, Busy, Conferencing, Refused, Error};
Emmanuel Milou's avatar
Emmanuel Milou committed
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

        /**
         * Constructor of a call
         * @param id Unique identifier of the call
         * @param type set definitely this call as incoming/outgoing
         */
        Call(const CallID& id, Call::CallType type);
        virtual ~Call();

        /** 
         * Return a reference on the call id
         * @return call id
         */
        CallID& getCallId() {return _id; }

Alexandre Savard's avatar
Alexandre Savard committed
96
97
98
99
100
101
102
103
	/** 
         * Return a reference on the conference id
         * @return call id
         */
        CallID& getConfId() {return _confID; }

	void setConfId(CallID id) {_confID = id; }

Emmanuel Milou's avatar
Emmanuel Milou committed
104
105
106
107
108
        inline CallType getCallType (void)
        {
            return _type;
        }

Emmanuel Milou's avatar
Emmanuel Milou committed
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
        /** 
         * Set the peer number (destination on outgoing)
         * not protected by mutex (when created)
         * @param number peer number
         */
        void setPeerNumber(const std::string& number) {  _peerNumber = number; }

        /** 
         * Get the peer number (destination on outgoing)
         * not protected by mutex (when created)
         * @return std::string The peer number
         */
        const std::string& getPeerNumber() {  return _peerNumber; }

        /** 
         * Set the peer name (caller in ingoing)
         * not protected by mutex (when created)
         * @param name The peer name
         */
        void setPeerName(const std::string& name) {  _peerName = name; }

        /** 
         * Get the peer name (caller in ingoing)
         * not protected by mutex (when created)
         * @return std::string The peer name
         */
        const std::string& getPeerName() {  return _peerName; }

137
138
139
140
141
142
143
144
145
146
147
148
149
150
	/** 
         * Set the display name (caller in ingoing)
         * not protected by mutex (when created)
         * @return std::string The peer display name
         */
        void setDisplayName(const std::string& name) {  _displayName = name; }

	/** 
         * Get the peer display name (caller in ingoing)
         * not protected by mutex (when created)
         * @return std::string The peer name
         */
        const std::string& getDisplayName() {  return _displayName; }

Emmanuel Milou's avatar
Emmanuel Milou committed
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
        /**
         * Tell if the call is incoming
         * @return true if yes
         *	      false otherwise
         */
        bool isIncoming() { return (_type == Incoming) ? true : false; }

        /** 
         * Set the connection state of the call (protected by mutex)
         * @param state The connection state
         */
        void setConnectionState(ConnectionState state);

        /** 
         * Get the connection state of the call (protected by mutex)
         * @return ConnectionState The connection state
         */
        ConnectionState getConnectionState();

        /**
         * Set the state of the call (protected by mutex)
         * @param state The call state
         */
        void setState(CallState state);

        /** 
         * Get the call state of the call (protected by mutex)
         * @return CallState  The call state
         */
        CallState getState();
181
        
182
        std::string getStateStr ();
Emmanuel Milou's avatar
Emmanuel Milou committed
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

        void setCallConfiguration (Call::CallConfiguration callConfig) { _callConfig = callConfig; }
        
        Call::CallConfiguration getCallConfiguration (void) { return _callConfig; }
        
        /**
         * Set the audio start boolean (protected by mutex)
         * @param start true if we start the audio
         *		    false otherwise
         */
        void setAudioStart(bool start);

        /**
         * Tell if the audio is started (protected by mutex)
         * @return true if it's already started
         *	      false otherwise
         */
        bool isAudioStarted();

        /** 
         * Set my IP [not protected] 
         * @param ip  The local IP address
         */
        void setLocalIp(const std::string& ip)     { _localIPAddress = ip; }

        /** 
         * Set local audio port, as seen by me [not protected]
         * @param port  The local audio port
         */
        void setLocalAudioPort(unsigned int port)  { _localAudioPort = port;}

        /** 
         * Set the audio port that remote will see.
         * @param port  The external audio port
         */
        void setLocalExternAudioPort(unsigned int port) { _localExternalAudioPort = port; }
219

Emmanuel Milou's avatar
Emmanuel Milou committed
220
        /** 
Emmanuel Milou's avatar
Emmanuel Milou committed
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
         * Return the audio port seen by the remote side. 
         * @return unsigned int The external audio port
         */
        unsigned int getLocalExternAudioPort() { return _localExternalAudioPort; }

        /** 
         * Return my IP [mutex protected] 
         * @return std::string The local IP
         */
        const std::string& getLocalIp();

        /** 
         * Return port used locally (for my machine) [mutex protected] 
         * @return unsigned int  The local audio port
         */
        unsigned int getLocalAudioPort();

238
239
	std::string getRecFileId(){ return getPeerName(); }

240
241
	std::string getFileName() { return _filename; }

Emmanuel Milou's avatar
Emmanuel Milou committed
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
    protected:
        /** Protect every attribute that can be changed by two threads */
        ost::Mutex _callMutex;

        bool _audioStarted;

        // Informations about call socket / audio

        /** My IP address */
        std::string  _localIPAddress;

        /** Local audio port, as seen by me. */
        unsigned int _localAudioPort;

        /** Port assigned to my machine by the NAT, as seen by remote peer (he connects there) */
        unsigned int _localExternalAudioPort;


    private:  

        /** Unique ID of the call */
        CallID _id;

Alexandre Savard's avatar
Alexandre Savard committed
265
266
267
	/** Unique conference ID, used exclusively in case of a conferece */
	CallID _confID;

Emmanuel Milou's avatar
Emmanuel Milou committed
268
269
        /** Type of the call */
        CallType _type;
270

Emmanuel Milou's avatar
Emmanuel Milou committed
271
272
        /** Disconnected/Progressing/Trying/Ringing/Connected */
        ConnectionState _connectionState;
273

Emmanuel Milou's avatar
Emmanuel Milou committed
274
275
276
277
278
279
280
281
282
283
284
285
        /** Inactive/Active/Hold/Busy/Refused/Error */
        CallState _callState;

        /** Direct IP-to-IP or classic call */
        CallConfiguration _callConfig;

        /** Name of the peer */
        std::string _peerName;

        /** Number of the peer */
        std::string _peerNumber;

286
287
288
	/** Display Name */
	std::string _displayName;

289
	/** File name for his call : time YY-MM-DD */
Emmanuel Milou's avatar
Emmanuel Milou committed
290
        std::string _filename;
291
292

	
jpbl's avatar
jpbl committed
293
294
};

yanmorin's avatar
   
yanmorin committed
295
#endif