The large GULP->PJSIP renaming effort.
[asterisk/asterisk.git] / include / asterisk / res_pjsip_session.h
1 /*
2  * Asterisk -- An open source telephony toolkit.
3  *
4  * Copyright (C) 2013, Digium, Inc.
5  *
6  * Mark Michelson <mmichelson@digium.com>
7  *
8  * See http://www.asterisk.org for more information about
9  * the Asterisk project. Please do not directly contact
10  * any of the maintainers of this project for assistance;
11  * the project provides a web site, mailing lists and IRC
12  * channels for your use.
13  *
14  * This program is free software, distributed under the terms of
15  * the GNU General Public License Version 2. See the LICENSE file
16  * at the top of the source tree.
17  */
18
19 #ifndef _RES_SIP_SESSION_H
20 #define _RES_SIP_SESSION_H
21
22 /* Needed for pj_timer_entry definition */
23 #include "pjlib.h"
24 #include "asterisk/linkedlists.h"
25 /* Needed for AST_MAX_EXTENSION constant */
26 #include "asterisk/channel.h"
27 /* Needed for ast_sockaddr struct */
28 #include "asterisk/netsock.h"
29 /* Needed for ast_sdp_srtp struct */
30 #include "asterisk/sdp_srtp.h"
31
32 /* Forward declarations */
33 struct ast_sip_endpoint;
34 struct ast_sip_transport;
35 struct pjsip_inv_session;
36 struct ast_channel;
37 struct ast_datastore;
38 struct ast_datastore_info;
39 struct ao2_container;
40 struct pjsip_tx_data;
41 struct pjsip_rx_data;
42 struct ast_party_id;
43 struct pjmedia_sdp_media;
44 struct pjmedia_sdp_session;
45 struct ast_dsp;
46 struct ast_udptl;
47
48 /*! \brief T.38 states for a session */
49 enum ast_sip_session_t38state {
50         T38_DISABLED = 0,   /*!< Not enabled */
51         T38_LOCAL_REINVITE, /*!< Offered from local - REINVITE */
52         T38_PEER_REINVITE,  /*!< Offered from peer - REINVITE */
53         T38_ENABLED,        /*!< Negotiated (enabled) */
54         T38_REJECTED,       /*!< Refused */
55 };
56
57 struct ast_sip_session_sdp_handler;
58
59 /*!
60  * \brief A structure containing SIP session media information
61  */
62 struct ast_sip_session_media {
63         union {
64                 /*! \brief RTP instance itself */
65                 struct ast_rtp_instance *rtp;
66                 /*! \brief UDPTL instance itself */
67                 struct ast_udptl *udptl;
68         };
69         /*! \brief Direct media address */
70         struct ast_sockaddr direct_media_addr;
71         /*! \brief SDP handler that setup the RTP */
72         struct ast_sip_session_sdp_handler *handler;
73         /*! \brief Holds SRTP information */
74         struct ast_sdp_srtp *srtp;
75         /*! \brief Stream is on hold */
76         unsigned int held:1;
77         /*! \brief Stream type this session media handles */
78         char stream_type[1];
79 };
80
81 /*!
82  * \brief Opaque structure representing a request that could not be sent
83  * due to an outstanding INVITE transaction
84  */
85 struct ast_sip_session_delayed_request;
86
87 /*!
88  * \brief A structure describing a SIP session
89  *
90  * For the sake of brevity, a "SIP session" in Asterisk is referring to
91  * a dialog initiated by an INVITE. While "session" is typically interpreted
92  * to refer to the negotiated media within a SIP dialog, we have opted
93  * to use the term "SIP session" to refer to the INVITE dialog itself.
94  */
95 struct ast_sip_session {
96         /* Dialplan extension where incoming call is destined */
97         char exten[AST_MAX_EXTENSION];
98         /* The endpoint with which Asterisk is communicating */
99         struct ast_sip_endpoint *endpoint;
100         /* The PJSIP details of the session, which includes the dialog */
101         struct pjsip_inv_session *inv_session;
102         /* The Asterisk channel associated with the session */
103         struct ast_channel *channel;
104         /* Registered session supplements */
105         AST_LIST_HEAD(, ast_sip_session_supplement) supplements;
106         /* Datastores added to the session by supplements to the session */
107         struct ao2_container *datastores;
108         /* Media streams */
109         struct ao2_container *media;
110         /* Serializer for tasks relating to this SIP session */
111         struct ast_taskprocessor *serializer;
112         /* Requests that could not be sent due to current inv_session state */
113         AST_LIST_HEAD_NOLOCK(, ast_sip_session_delayed_request) delayed_requests;
114         /* When we need to reschedule a reinvite, we use this structure to do it */
115         pj_timer_entry rescheduled_reinvite;
116         /* Format capabilities pertaining to direct media */
117         struct ast_format_cap *direct_media_cap;
118         /* When we need to forcefully end the session */
119         pj_timer_entry scheduled_termination;
120         /* Identity of endpoint this session deals with */
121         struct ast_party_id id;
122         /* Requested capabilities */
123         struct ast_format_cap *req_caps;
124         /* Codecs overriden by dialplan on an outgoing request */
125         struct ast_codec_pref override_prefs;
126         /* Optional DSP, used only for inband DTMF detection if configured */
127         struct ast_dsp *dsp;
128         /* Whether the termination of the session should be deferred */
129         unsigned int defer_terminate:1;
130         /* Deferred incoming re-invite */
131         pjsip_rx_data *deferred_reinvite;
132         /* Current T.38 state */
133         enum ast_sip_session_t38state t38state;
134 };
135
136 typedef int (*ast_sip_session_request_creation_cb)(struct ast_sip_session *session, pjsip_tx_data *tdata);
137 typedef int (*ast_sip_session_response_cb)(struct ast_sip_session *session, pjsip_rx_data *rdata);
138 typedef int (*ast_sip_session_sdp_creation_cb)(struct ast_sip_session *session, pjmedia_sdp_session *sdp);
139
140 enum ast_sip_session_supplement_priority {
141         /*! Top priority. Supplements with this priority are those that need to run before any others */
142         AST_SIP_SESSION_SUPPLEMENT_PRIORITY_FIRST = 0,
143         /*! Channel creation priority.
144          * chan_gulp creates a channel at this priority. If your supplement depends on being run before
145          * or after channel creation, then set your priority to be lower or higher than this value.
146          */
147         AST_SIP_SESSION_SUPPLEMENT_PRIORITY_CHANNEL = 1000000,
148         /*! Lowest priority. Supplements with this priority should be run after all other supplements */
149         AST_SIP_SESSION_SUPPLEMENT_PRIORITY_LAST = INT_MAX,
150 };
151
152 /*!
153  * \brief A supplement to SIP message processing
154  *
155  * These can be registered by any module in order to add
156  * processing to incoming and outgoing SIP requests and responses
157  */
158 struct ast_sip_session_supplement {
159     /*! Method on which to call the callbacks. If NULL, call on all methods */
160     const char *method;
161         /*! Priority for this supplement. Lower numbers are visited before higher numbers */
162         enum ast_sip_session_supplement_priority priority;
163     /*!
164          * \brief Notification that the session has begun
165          * This method will always be called from a SIP servant thread.
166          */
167     void (*session_begin)(struct ast_sip_session *session);
168     /*! 
169          * \brief Notification that the session has ended
170          *
171          * This method may or may not be called from a SIP servant thread. Do
172          * not make assumptions about being able to call PJSIP methods from within
173          * this method.
174          */
175     void (*session_end)(struct ast_sip_session *session);
176         /*!
177          * \brief Notification that the session is being destroyed
178          */
179         void (*session_destroy)(struct ast_sip_session *session);
180     /*!
181      * \brief Called on incoming SIP request
182      * This method can indicate a failure in processing in its return. If there
183      * is a failure, it is required that this method sends a response to the request.
184          * This method is always called from a SIP servant thread.
185          *
186          * \note
187          * The following PJSIP methods will not work properly:
188          * pjsip_rdata_get_dlg()
189          * pjsip_rdata_get_tsx()
190          * The reason is that the rdata passed into this function is a cloned rdata structure,
191          * and its module data is not copied during the cloning operation.
192          * If you need to get the dialog, you can get it via session->inv_session->dlg.
193      */
194     int (*incoming_request)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
195     /*! 
196          * \brief Called on an incoming SIP response
197          * This method is always called from a SIP servant thread.
198          *
199          * \note
200          * The following PJSIP methods will not work properly:
201          * pjsip_rdata_get_dlg()
202          * pjsip_rdata_get_tsx()
203          * The reason is that the rdata passed into this function is a cloned rdata structure,
204          * and its module data is not copied during the cloning operation.
205          * If you need to get the dialog, you can get it via session->inv_session->dlg.
206          */
207     void (*incoming_response)(struct ast_sip_session *session, struct pjsip_rx_data *rdata);
208     /*!
209          * \brief Called on an outgoing SIP request
210          * This method is always called from a SIP servant thread.
211          */
212     void (*outgoing_request)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
213     /*! 
214          * \brief Called on an outgoing SIP response
215          * This method is always called from a SIP servant thread.
216          */
217     void (*outgoing_response)(struct ast_sip_session *session, struct pjsip_tx_data *tdata);
218         /*! Next item in the list */
219         AST_LIST_ENTRY(ast_sip_session_supplement) next;
220 };
221
222 /*!
223  * \brief A handler for SDPs in SIP sessions
224  *
225  * An SDP handler is registered by a module that is interested in being the
226  * responsible party for specific types of SDP streams.
227  */
228 struct ast_sip_session_sdp_handler {
229         /*! An identifier for this handler */
230         const char *id;
231         /*!
232          * \brief Determine whether a stream requires that the re-invite be deferred.
233          * If a stream can not be immediately negotiated the re-invite can be deferred and
234          * resumed at a later time. It is up to the handler which caused deferral to occur
235          * to resume it.
236          * \param session The session for which the media is being re-invited
237          * \param session_media The media being reinvited
238          * \param sdp The entire SDP.
239          * \retval 0 The stream was unhandled or does not need the re-invite to be deferred.
240          * \retval 1 Re-invite should be deferred and will be resumed later. No further operations will take place.
241          * \note This is optional, if not implemented the stream is assumed to not be deferred.
242          */
243         int (*defer_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
244         /*!
245          * \brief Set session details based on a stream in an incoming SDP offer or answer
246          * \param session The session for which the media is being negotiated
247          * \param session_media The media to be setup for this session
248          * \param sdp The entire SDP. Useful for getting "global" information, such as connections or attributes
249          * \param stream The stream on which to operate
250          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
251          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
252          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
253          */
254         int (*negotiate_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, const struct pjmedia_sdp_media *stream);
255         /*!
256          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
257          * \param session The session for which media is being added
258          * \param session_media The media to be setup for this session
259          * \param stream The stream on which to operate
260          * \retval 0 The stream was not handled by this handler. If there are other registered handlers for this stream type, they will be called.
261          * \retval <0 There was an error encountered. No further operation will take place and the current negotiation will be abandoned.
262          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
263          */
264         int (*handle_incoming_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *sdp, struct pjmedia_sdp_media *stream);
265         /*!
266          * \brief Create an SDP media stream and add it to the outgoing SDP offer or answer
267          * \param session The session for which media is being added
268          * \param session_media The media to be setup for this session
269          * \param sdp The entire SDP as currently built
270          * \retval 0 This handler has no stream to add. If there are other registered handlers for this stream type, they will be called.
271          * \retval <0 There was an error encountered. No further operation will take place and the current SDP negotiation will be abandoned.
272          * \retval >0 The handler has a stream to be added to the SDP. No further handler of this stream type will be called.
273          */
274         int (*create_outgoing_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, struct pjmedia_sdp_session *sdp);
275         /*!
276          * \brief Update media stream with external address if applicable
277          * \param tdata The outgoing message itself
278          * \param stream The stream on which to operate
279          * \param transport The transport the SDP is going out on
280          */
281         void (*change_outgoing_sdp_stream_media_address)(struct pjsip_tx_data *tdata, struct pjmedia_sdp_media *stream, struct ast_sip_transport *transport);
282         /*!
283          * \brief Apply a negotiated SDP media stream
284          * \param session The session for which media is being applied
285          * \param session_media The media to be setup for this session
286          * \param local The entire local negotiated SDP
287          * \param local_stream The local stream which to apply
288          * \param remote The entire remote negotiated SDP
289          * \param remote_stream The remote stream which to apply
290          * \retval 0 The stream was not applied by this handler. If there are other registered handlers for this stream type, they will be called.
291          * \retval <0 There was an error encountered. No further operation will take place and the current application will be abandoned.
292          * \retval >0 The stream was handled by this handler. No further handler of this stream type will be called.
293          */
294         int (*apply_negotiated_sdp_stream)(struct ast_sip_session *session, struct ast_sip_session_media *session_media, const struct pjmedia_sdp_session *local, const struct pjmedia_sdp_media *local_stream,
295                 const struct pjmedia_sdp_session *remote, const struct pjmedia_sdp_media *remote_stream);
296         /*!
297          * \brief Destroy a session_media created by this handler
298          * \param session The session for which media is being destroyed
299          * \param session_media The media to destroy
300          */
301         void (*stream_destroy)(struct ast_sip_session_media *session_media);
302         /*! Next item in the list. */
303         AST_LIST_ENTRY(ast_sip_session_sdp_handler) next;
304 };
305
306 /*!
307  * \brief A structure which contains a channel implementation and session
308  */
309 struct ast_sip_channel_pvt {
310         /*! \brief Pointer to channel specific implementation information, must be ao2 object */
311         void *pvt;
312         /*! \brief Pointer to session */
313         struct ast_sip_session *session;
314 };
315
316 /*!
317  * \brief Allocate a new SIP channel pvt structure
318  *
319  * \param pvt Pointer to channel specific implementation
320  * \param session Pointer to SIP session
321  *
322  * \retval non-NULL success
323  * \retval NULL failure
324  */
325 struct ast_sip_channel_pvt *ast_sip_channel_pvt_alloc(void *pvt, struct ast_sip_session *session);
326
327 /*!
328  * \brief Allocate a new SIP session
329  *
330  * This will take care of allocating the datastores container on the session as well
331  * as placing all registered supplements onto the session.
332  *
333  * The endpoint that is passed in will have its reference count increased by one since
334  * the session will be keeping a reference to the endpoint. The session will relinquish
335  * this reference when the session is destroyed.
336  *
337  * \param endpoint The endpoint that this session communicates with
338  * \param inv_session The PJSIP INVITE session data
339  */
340 struct ast_sip_session *ast_sip_session_alloc(struct ast_sip_endpoint *endpoint, pjsip_inv_session *inv);
341
342 /*!
343  * \brief Create a new outgoing SIP session
344  *
345  * The endpoint that is passed in will have its reference count increased by one since
346  * the session will be keeping a reference to the endpoint. The session will relinquish
347  * this reference when the session is destroyed.
348  *
349  * \param endpoint The endpoint that this session uses for settings
350  * \param location Optional name of the location to call, be it named location or explicit URI
351  * \param request_user Optional request user to place in the request URI if permitted
352  * \param req_caps The requested capabilities
353  */
354 struct ast_sip_session *ast_sip_session_create_outgoing(struct ast_sip_endpoint *endpoint, const char *location, const char *request_user, struct ast_format_cap *req_caps);
355
356 /*!
357  * \brief Defer local termination of a session until remote side terminates, or an amount of time passes
358  *
359  * \param session The session to defer termination on
360  */
361 void ast_sip_session_defer_termination(struct ast_sip_session *session);
362
363 /*!
364  * \brief Register an SDP handler
365  *
366  * An SDP handler is responsible for parsing incoming SDP streams and ensuring that
367  * Asterisk can cope with the contents. Similarly, the SDP handler will be
368  * responsible for constructing outgoing SDP streams.
369  *
370  * Multiple handlers for the same stream type may be registered. They will be
371  * visited in the order they were registered. Handlers will be visited for each
372  * stream type until one claims to have handled the stream.
373  *
374  * \param handler The SDP handler to register
375  * \param stream_type The type of media stream for which to call the handler
376  * \retval 0 Success
377  * \retval -1 Failure
378  */
379 int ast_sip_session_register_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
380
381 /*!
382  * \brief Unregister an SDP handler
383  *
384  * \param handler The SDP handler to unregister
385  * \param stream_type Stream type for which the SDP handler was registered
386  */
387 void ast_sip_session_unregister_sdp_handler(struct ast_sip_session_sdp_handler *handler, const char *stream_type);
388
389 /*!
390  * \brief Register a supplement to SIP session processing
391  *
392  * This allows for someone to insert themselves in the processing of SIP
393  * requests and responses. This, for example could allow for a module to
394  * set channel data based on headers in an incoming message. Similarly,
395  * a module could reject an incoming request if desired.
396  *
397  * \param supplement The supplement to register
398  * \retval 0 Success
399  * \retval -1 Failure
400  */
401 int ast_sip_session_register_supplement(struct ast_sip_session_supplement *supplement);
402
403 /*!
404  * \brief Unregister a an supplement to SIP session processing
405  *
406  * \param supplement The supplement to unregister
407  */
408 void ast_sip_session_unregister_supplement(struct ast_sip_session_supplement *supplement);
409
410 /*!
411  * \brief Alternative for ast_datastore_alloc()
412  *
413  * There are two major differences between this and ast_datastore_alloc()
414  * 1) This allocates a refcounted object
415  * 2) This will fill in a uid if one is not provided
416  *
417  * DO NOT call ast_datastore_free() on a datastore allocated in this
418  * way since that function will attempt to free the datastore rather
419  * than play nicely with its refcount.
420  *
421  * \param info Callbacks for datastore
422  * \param uid Identifier for datastore
423  * \retval NULL Failed to allocate datastore
424  * \retval non-NULL Newly allocated datastore
425  */
426 struct ast_datastore *ast_sip_session_alloc_datastore(const struct ast_datastore_info *info, const char *uid);
427
428 /*!
429  * \brief Add a datastore to a SIP session
430  *
431  * Note that SIP uses reference counted datastores. The datastore passed into this function
432  * must have been allocated using ao2_alloc() or there will be serious problems.
433  *
434  * \param session The session to add the datastore to
435  * \param datastore The datastore to be added to the session
436  * \retval 0 Success
437  * \retval -1 Failure
438  */
439 int ast_sip_session_add_datastore(struct ast_sip_session *session, struct ast_datastore *datastore);
440
441 /*!
442  * \brief Retrieve a session datastore
443  *
444  * The datastore retrieved will have its reference count incremented. When the caller is done
445  * with the datastore, the reference counted needs to be decremented using ao2_ref().
446  *
447  * \param session The session from which to retrieve the datastore
448  * \param name The name of the datastore to retrieve
449  * \retval NULL Failed to find the specified datastore
450  * \retval non-NULL The specified datastore
451  */
452 struct ast_datastore *ast_sip_session_get_datastore(struct ast_sip_session *session, const char *name);
453
454 /*!
455  * \brief Remove a session datastore from the session
456  *
457  * This operation may cause the datastore's free() callback to be called if the reference
458  * count reaches zero.
459  *
460  * \param session The session to remove the datastore from
461  * \param name The name of the datastore to remove
462  */
463 void ast_sip_session_remove_datastore(struct ast_sip_session *session, const char *name);
464
465 /*!
466  * \brief Send a reinvite or UPDATE on a session
467  *
468  * This method will inspect the session in order to construct an appropriate
469  * session refresh request. As with any outgoing request in res_sip_session,
470  * this will call into registered supplements in case they wish to add anything.
471  *
472  * Note: The on_request_creation callback may or may not be called in the same
473  * thread where this function is called. Request creation may need to be delayed
474  * due to the current INVITE transaction state.
475  * 
476  * \param session The session on which the reinvite will be sent
477  * \param on_request_creation Callback called when request is created
478  * \param on_sdp_creation Callback called when SDP is created
479  * \param on_response Callback called when response for request is received
480  * \param method The method that should be used when constructing the session refresh
481  * \param generate_new_sdp Boolean to indicate if a new SDP should be created
482  * \retval 0 Successfully sent refresh
483  * \retval -1 Failure to send refresh
484  */
485 int ast_sip_session_refresh(struct ast_sip_session *session,
486                 ast_sip_session_request_creation_cb on_request_creation,
487                 ast_sip_session_sdp_creation_cb on_sdp_creation,
488                 ast_sip_session_response_cb on_response,
489                 enum ast_sip_session_refresh_method method,
490                 int generate_new_sdp);
491
492 /*!
493  * \brief Send a SIP response
494  *
495  * This will send the SIP response specified in tdata and
496  * call into any registered supplements' outgoing_response callback.
497  *
498  * \param session The session on which to send the response.
499  * \param tdata The response to send
500  */
501 void ast_sip_session_send_response(struct ast_sip_session *session, pjsip_tx_data *tdata);
502
503 /*!
504  * \brief Send a SIP request
505  *
506  * This will send the SIP request specified in tdata and
507  * call into any registered supplements' outgoing_request callback.
508  *
509  * \param session The session to which to send the request
510  * \param tdata The request to send
511  */
512 void ast_sip_session_send_request(struct ast_sip_session *session, pjsip_tx_data *tdata);
513
514 /*!
515  * \brief Creates an INVITE request.
516  *
517  * \param session Starting session for the INVITE
518  * \param tdata The created request.
519  */
520 int ast_sip_session_create_invite(struct ast_sip_session *session, pjsip_tx_data **tdata);
521
522 /*!
523  * \brief Send a SIP request and get called back when a response is received
524  *
525  * This will send the request out exactly the same as ast_sip_send_request() does.
526  * The difference is that when a response arrives, the specified callback will be
527  * called into
528  *
529  * \param session The session on which to send the request
530  * \param tdata The request to send
531  * \param on_response Callback to be called when a response is received
532  */
533 void ast_sip_session_send_request_with_cb(struct ast_sip_session *session, pjsip_tx_data *tdata,
534                 ast_sip_session_response_cb on_response);
535
536 /*!
537  * \brief Retrieves a session from a dialog
538  *
539  * \param dlg The dialog to retrieve the session from
540  *
541  * \retval non-NULL if session exists
542  * \retval NULL if no session
543  *
544  * \note The reference count of the session is increased when returned
545  *
546  * \note This function *must* be called with the dialog locked
547  */
548 struct ast_sip_session *ast_sip_dialog_get_session(pjsip_dialog *dlg);
549
550 /*!
551  * \brief Resumes processing of a deferred incoming re-invite
552  *
553  * \param session The session which has a pending incoming re-invite
554  *
555  * \note When resuming a re-invite it is given to the pjsip stack as if it
556  *       had just been received from a transport, this means that the deferral
557  *       callback will be called again.
558  */
559 void ast_sip_session_resume_reinvite(struct ast_sip_session *session);
560
561 #endif /* _RES_SIP_SESSION_H */