gtk/voip_calls.h

   1 /* voip_calls.h
   2  * VoIP calls summary addition for ethereal
   3  *
   4  * $Id$
   5  *
   6  * Copyright 2004, Ericsson , Spain
   7  * By Francisco Alcoba <francisco.alcoba@ericsson.com>
   8  *
   9  * based on h323_calls.h
  10  * Copyright 2004, Iskratel, Ltd, Kranj
  11  * By Miha Jemec <m.jemec@iskratel.si>
  12  *
  13  * H323, RTP and Graph Support
  14  * By Alejandro Vaquero, alejandro.vaquero@verso.com
  15  * Copyright 2005, Verso Technologies Inc.
  16  *
  17  * Ethereal - Network traffic analyzer
  18  * By Gerald Combs <gerald@ethereal.com>
  19  * Copyright 1998 Gerald Combs
  20  *
  21  * This program is free software; you can redistribute it and/or
  22  * modify it under the terms of the GNU General Public License
  23  * as published by the Free Software Foundation; either version 2
  24  * of the License, or (at your option) any later version.
  25  *
  26  * This program is distributed in the hope that it will be useful,
  27  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  28  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  29  * GNU General Public License for more details.
  30  *
  31  * You should have received a copy of the GNU General Public License
  32  * along with this program; if not, write to the Free Software
  33  * Foundation,  Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  34  */
  35
  36 #ifndef VOIP_CALLS_H_INCLUDED
  37 #define VOIP_CALLS_H_INCLUDED
  38
  39 #include <glib.h>
  40 #include <stdio.h>
  41 #include <epan/address.h>
  42
  43 /****************************************************************************/
  44 /* defines voip call state */
  45 typedef enum _voip_call_state {
  46         VOIP_CALL_SETUP,
  47         VOIP_IN_CALL,
  48         VOIP_CANCELLED,
  49         VOIP_COMPLETED,
  50         VOIP_REJECTED,
  51                 VOIP_UNKNOWN
  52 } voip_call_state;
  53
  54 extern char *voip_call_state_name[6];
  55
  56 typedef enum _voip_call_active_state {
  57                 VOIP_ACTIVE,
  58                 VOIP_INACTIVE
  59 } voip_call_active_state;
  60
  61 typedef enum _voip_protocol {
  62                 VOIP_SIP,
  63                 VOIP_ISUP,
  64                 VOIP_H323
  65 } voip_protocol;
  66
  67 extern char *voip_protocol_name[3];
  68
  69 /* defines specific SIP data */
  70
  71 typedef enum _sip_call_state {
  72         SIP_INVITE_SENT,
  73         SIP_200_REC,
  74         SIP_CANCEL_SENT
  75 } sip_call_state;
  76
  77 typedef struct _sip_calls_info {
  78         gchar *call_identifier;
  79         guint32 invite_cseq;
  80         sip_call_state sip_state;
  81 } sip_calls_info_t;
  82
  83 /* defines specific ISUP data */
  84
  85 typedef struct _isup_calls_info {
  86         guint16                 cic;
  87         guint32                 opc, dpc;
  88         guint8                  ni;
  89 } isup_calls_info_t;
  90
  91 typedef struct _h245_address {
  92         guint32 h245_address;
  93         guint16 h245_port;
  94 } h245_address_t;
  95
  96 /* defines specific H323 data */
  97 typedef struct _h323_calls_info {
  98         guint8 *guid;   /* Call ID to identify a H225 */
  99         GList*  h245_list;   /* list of H245 Address and ports for tunneling off calls*/
 100         guint32 h225SetupAddr; /* we use the SETUP H225 IP to determine if packets are forward or reverse */
 101         gboolean is_h245;
 102         gboolean is_faststart_Setup;    /* if faststart field is included in Setup*/
 103         gboolean is_faststart_Proc;             /* if faststart field is included in Proce, Alerting, Progress or Connect*/
 104         gboolean is_h245Tunneling;
 105         gint32 q931_crv;
 106         gint32 q931_crv2;
 107 } h323_calls_info_t;
 108
 109 /* defines a voip call */
 110 typedef struct _voip_calls_info {
 111         voip_call_state call_state;
 112         voip_call_active_state call_active_state;
 113         gchar *from_identity;
 114         gchar *to_identity;
 115         gpointer prot_info;
 116         guint32 initial_speaker;
 117         guint32 npackets;
 118         guint32 first_frame_num; /* frame number of first frame */
 119         guint32 last_frame_num;
 120         voip_protocol protocol;
 121         guint16 call_num;
 122         gint32 start_sec, start_usec, stop_sec, stop_usec;
 123         gboolean selected;
 124
 125 } voip_calls_info_t;
 126
 127 /* structure that holds the information about all detected calls */
 128 /* struct holding all information of the tap */
 129
 130 typedef struct _voip_calls_tapinfo {
 131         int     ncalls;       /* number of calls in the list */
 132         GList*  strinfo_list;   /* list with all calls */
 133         int     npackets;       /* total number of packets of all calls */
 134         voip_calls_info_t* filter_calls_fwd;  /* used as filter in some tap modes */
 135         guint32 launch_count;   /* number of times the tap has been run */
 136         int start_packets;
 137         int completed_calls;
 138         int rejected_calls;
 139         graph_analysis_info_t* graph_analysis;
 140         /*
 141          * Now add dummy variables, one for each tap listener.
 142          * Their address will be used to distinguish between them.
 143          */
 144         int sip_dummy;
 145         int sdp_dummy;
 146         int h225_dummy;
 147         int h245dg_dummy;
 148         int mtp3_dummy;
 149         int isup_dummy;
 150         int q931_dummy;
 151 } voip_calls_tapinfo_t;
 152
 153
 154 /* defines a RTP stream */
 155 typedef struct _voip_rtp_stream_info {
 156         address src_addr;
 157         guint16 src_port;
 158         address dest_addr;
 159         guint16 dest_port;
 160         guint32 ssrc;
 161         guint8  pt;
 162         guint32 npackets;
 163
 164         guint32 first_frame_num; /* frame number of first frame */
 165         guint32 setup_frame_number; /* frame number of setup message */
 166         /* start of recording (GMT) of this stream */
 167         guint32 start_rel_sec;         /* start stream rel seconds */
 168         guint32 start_rel_usec;        /* start stream rel microseconds */
 169         guint32 stop_rel_sec;         /* stop stream rel seconds */
 170         guint32 stop_rel_usec;        /* stop stream rel microseconds */
 171 } voip_rtp_stream_info_t;
 172
 173 /* structure that holds the information about all RTP streams associated with the calls */
 174 /* struct holding all information of the RTP tap */
 175 typedef struct _voip_rtp_tapinfo {
 176         int     nstreams;       /* number of rtp streams */
 177         GList*  list;                   /* list with the rtp streams */
 178         int rtp_dummy;
 179 } voip_rtp_tapinfo_t;
 180
 181 /****************************************************************************/
 182 /* INTERFACE */
 183
 184 /*
 185 * Registers the voip_calls tap listeners (if not already done).
 186 * From that point on, the calls list will be updated with every redissection.
 187 * This function is also the entry point for the initialization routine of the tap system.
 188 * So whenever voip_calls.c is added to the list of ETHEREAL_TAP_SRCs, the tap will be registered on startup.
 189 * If not, it will be registered on demand by the voip_calls functions that need it.
 190 */
 191 void sip_calls_init_tap(void);
 192 void isup_calls_init_tap(void);
 193 void mtp3_calls_init_tap(void);
 194 void h225_calls_init_tap(void);
 195 void h245dg_calls_init_tap(void);
 196 void q931_calls_init_tap(void);
 197 void sdp_calls_init_tap(void);
 198 void rtp_init_tap(void);
 199
 200
 201 /*
 202 * Removes the voip_calls tap listener (if not already done)
 203 * From that point on, the voip calls list won't be updated any more.
 204 */
 205 void remove_tap_listener_sip_calls(void);
 206 void remove_tap_listener_isup_calls(void);
 207 void remove_tap_listener_mtp3_calls(void);
 208 void remove_tap_listener_h225_calls(void);
 209 void remove_tap_listener_h245dg_calls(void);
 210 void remove_tap_listener_q931_calls(void);
 211 void remove_tap_listener_sdp_calls(void);
 212 void remove_tap_listener_rtp(void);
 213
 214 /*
 215 * Retrieves a constant reference to the unique info structure of the voip_calls tap listener.
 216 * The user should not modify the data pointed to.
 217 */
 218 const voip_calls_tapinfo_t* voip_calls_get_info(void);
 219
 220 /*
 221 * Cleans up memory of voip calls tap.
 222 */
 223 void voip_calls_reset(voip_calls_tapinfo_t *tapinfo);
 224 void isup_calls_reset(voip_calls_tapinfo_t *tapinfo);
 225 void mtp3_calls_reset(voip_calls_tapinfo_t *tapinfo);
 226 void q931_calls_reset(voip_calls_tapinfo_t *tapinfo);
 227
 228 void graph_analysis_data_init(void);
 229
 230 #endif /*VOIP_CALLS_H_INCLUDED*/