src/call_interface.h

   1 /*
   2  *  call_interface.h
   3  *
   4  *  Copyright(C) 2007,2008 Ixonos Plc
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2, or (at your option)
   9  *  any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Boston, MA 02111.
  19  */
  20
  21 /*
  22  * Written by
  23  *   Jukka Honkela
  24  *   Yi Zheng
  25  *   Matti Katila
  26  *   Vesa Pikki
  27  *   Heikki Paajanen
  28  */
  29
  30
  31 #ifndef CALL_INTERFACE
  32 #define CALL_INTERFACE
  33
  34
  35 /**
  36  * @brief voice call interface provice voice call service such as dial accept or
  37  * hangup a call
  38  */
  39 typedef struct CallInterface CallInterface;
  40
  41 struct CallInterface
  42 {
  43
  44     gpointer priv;
  45
  46     gpointer vendor_priv;
  47
  48     /***************************Method calls***********************************/
  49
  50
  51
  52     /**
  53      * @brief makes a call
  54      * @param call call interface pointer
  55      * @param ipc_data data for ipc
  56      * @param number the phone number to call
  57      */
  58     void (*initiate) (CallInterface *call,
  59                       gpointer ipc_data,
  60                       const char* number,
  61                       const char* type);
  62
  63     /**
  64      * @brief Activates a call (either incoming or held)
  65      * @param call call interface pointer
  66      * @param ipc_data data for ipc
  67      * @param id call's id
  68      */
  69     void (*activate) (CallInterface *call,
  70                       gpointer ipc_data,
  71                       gint id);
  72
  73
  74     /**
  75      * @brief Adds specified call to conference
  76      * @param call call interface pointer
  77      * @param ipc_data data for ipc
  78      * @param id call's id
  79      */
  80     void (*activate_conference) (CallInterface *call,
  81                                  gpointer ipc_data,
  82                                  gint id);
  83
  84     /**
  85      * @brief Hangup a call. Hangup the current call or cancel the call
  86      * request
  87      * @param call call interface pointer
  88      * @param ipc_data data for ipc
  89      * @param message TODO what's this?
  90      * @param id index of the call to hang up
  91      */
  92     void (*release) (CallInterface *call,
  93                      gpointer ipc_data,
  94                      const gchar *message,
  95                      const gint id);
  96
  97     /**
  98      * @brief Place active call to hold.
  99      *
 100      * @param call call interface pointer
 101      * @param ipc_data data for ipc
 102      */
 103     void (*hold_active) (CallInterface *call,
 104                          gpointer ipc_data);
 105
 106     /**
 107      * @brief Join calls.
 108      *
 109      * @param call call interface pointer
 110      * @param ipc_data data for ipc
 111      */
 112     void (*join) (CallInterface *call,
 113                   gpointer ipc_data);
 114
 115     /**
 116      * @brief Transfer calls.
 117      *
 118      * @param call call interface pointer
 119      * @param ipc_data data for ipc
 120      */
 121     void (*transfer) (CallInterface *call,
 122                       gpointer ipc_data,
 123                       const gchar *number);
 124
 125     /**
 126      * @brief Hangup all calls.
 127      * @param call call interface pointer
 128      * @param ipc_data data for ipc
 129      * @param message TODO what's this?
 130      */
 131     void (*release_all) (CallInterface *call,
 132                          gpointer ipc_data,
 133                          const gchar *message);
 134
 135     /**
 136      * @brief Releases all held calls.
 137      * @param call call interface pointer
 138      * @param ipc_data data for ipc
 139      * @param message TODO what's this?
 140      */
 141     void (*release_held) (CallInterface *call,
 142                           gpointer ipc_data,
 143                           const gchar *message);
 144
 145
 146     /**
 147     * @brief Lists current calls (held and active)
 148     * @param call call interface pointer
 149     * @param ipc_data data for ipc
 150     */
 151     void (*list_calls) (CallInterface *call,
 152                         gpointer ipc_data);
 153
 154     /**
 155     * @brief Set Dtmf of modem
 156     * @param call call interface poniter
 157     * @param ipc_data data for ipc
 158     * @param str Dtmf string
 159     */
 160     void (*send_dtmf) (CallInterface *call,
 161                        gpointer ipc_data);
 162
 163     /**
 164      * @brief Get emergency number
 165      * @param call call interface poniter
 166      * @param ipc_data data for ipc
 167      */
 168     void (*emergency) (CallInterface *call,
 169                        gpointer ipc_data);
 170
 171
 172
 173 };
 174
 175 typedef struct _CallIPCInterface CallIPCInterface;
 176
 177 struct _CallIPCInterface
 178 {
 179
 180     gpointer priv;
 181
 182     /**************************Replies to method calls*************************/
 183
 184     /**
 185      * @brief sends a reply to ipc that phone call has been made
 186      * @param call_ipc call IPC interface pointer
 187      * @param ipc_data data for ipc
 188      * @param id newly initiated phone call's id
 189      */
 190     void (*initiate_reply) (CallIPCInterface *call_ipc,
 191                             gpointer ipc_data,
 192                             const gint id);
 193
 194
 195     /**
 196      * @brief sends a reply to ipc that phone call has been activated
 197      * @param call_ipc call IPC interface pointer
 198      * @param ipc_data data for ipc
 199      */
 200     void (*activate_reply) (CallIPCInterface *call_ipc,
 201                             gpointer ipc_data);
 202
 203     /**
 204      * @brief sends a reply to ipc that phone call has been added to
 205      * conference
 206      * @param call_ipc call IPC interface pointer
 207      * @param ipc_data data for ipc
 208      */
 209     void (*activate_conference_reply) (CallIPCInterface *call_ipc,
 210                                        gpointer ipc_data);
 211
 212     /**
 213      * @brief sends a reply to ipc that active and held calls have been joined and released
 214      * @param call_ipc call IPC interface pointer
 215      * @param ipc_data data for ipc
 216      */
 217     void (*join_reply) (CallIPCInterface *call_ipc,
 218                         gpointer ipc_data);
 219
 220     /**
 221      * @brief sends a reply to ipc that a phone call has been released (hung up)
 222      * @param call_ipc call IPC interface pointer
 223      * @param ipc_data data for ipc
 224      */
 225     void (*release_reply) (CallIPCInterface *call_ipc,
 226                            gpointer ipc_data);
 227
 228     /**
 229      * @brief sends a reply to ipc that dtmf has been sent
 230      * @param call_ipc call IPC interface pointer
 231      * @param ipc_data data for ipc
 232      * @param mode
 233      */
 234     void (*send_dtmf_reply) (CallIPCInterface *call_ipc,
 235                              gpointer ipc_data,
 236                              const char *mode);
 237
 238     /**
 239      * @brief sends a reply to ipc with the emergency number
 240      * @param call_ipc call IPC interface pointer
 241      * @param ipc_data data for ipc
 242      * @param number emergency number
 243      */
 244     void (*emergency_reply) (CallIPCInterface *call_ipc,
 245                              gpointer ipc_data,
 246                              const char* number);
 247
 248     /**
 249      * @brief send a reply to set DTMF duration function
 250      * @param call_ipc call IPC interface pointer
 251      * @param ipc_data data for ipc
 252      */
 253     void (*set_dtmf_duration_reply) (CallIPCInterface *call_ipc,
 254                                      gpointer ipc_data);
 255
 256     /**
 257      * @brief send a reply to get DTMF duration function
 258      * @param call_ipc call IPC interface pointer
 259      * @param ipc_data data for ipc
 260      * @param duration dtmf duration
 261      */
 262     void (*get_dtmf_duration_reply) (CallIPCInterface *call_ipc,
 263                                      gpointer ipc_data,
 264                                      const gint duration);
 265
 266     /**
 267      * @brief send a reply to release all function
 268      * @param call_ipc call IPC interface pointer
 269      * @param ipc_data data for ipc
 270      */
 271     void (*release_all_reply) (CallIPCInterface *call_ipc,
 272                                gpointer ipc_data);
 273
 274
 275     /**
 276      * @brief send a reply to release held function
 277      * @param call_ipc call IPC interface pointer
 278      * @param ipc_data data for ipc
 279      */
 280     void (*release_held_reply) (CallIPCInterface *call_ipc,
 281                                 gpointer ipc_data);
 282
 283     /**
 284     * @brief send a reply to list calls function
 285     * @param call_ipc call IPC interface pointer
 286     * @param ipc_data data for ipc
 287     * @param calls active calls
 288     */
 289     void (*list_calls_reply) (CallIPCInterface *call_ipc,
 290                               gpointer ipc_data,
 291                               GArray *calls);
 292
 293     /**
 294      * @brief sends a reply to get send identification function
 295      * @param call_ipc call IPC interface pointer
 296      * @param ipc_data data for ipc
 297      * @param mode ??
 298      */
 299     void (*get_send_identification_reply) (CallIPCInterface *call_ipc,
 300                                            gpointer ipc_data,
 301                                            gboolean mode);
 302
 303     /**
 304      * @brief sends a reply to set send identification function
 305      * @param call_ipc call IPC interface pointer
 306      * @param ipc_data data for ipc
 307      */
 308     void (*set_send_identification_reply) (CallIPCInterface *call_ipc,
 309                                            gpointer ipc_data);
 310     /*********************Error replies to method calls************************/
 311
 312     /**
 313      * @brief sends an error reply to ipc
 314      * @param call_ipc pointer to call IPC interface struct
 315      * @param ipc_data ipc data
 316      * @param error pointer to GError describing error
 317      */
 318     void (*initiate_error) (CallIPCInterface *call_ipc,
 319                             gpointer ipc_data,
 320                             GError *error);
 321
 322
 323
 324     /**
 325      * @brief sends an error reply to ipc
 326      * @param call_ipc pointer to call IPC interface struct
 327      * @param ipc_data ipc data
 328      * @param error pointer to GError describing error
 329      */
 330     void (*activate_error) (CallIPCInterface *call_ipc,
 331                             gpointer ipc_data,
 332                             GError *error);
 333
 334     /**
 335      * @brief sends an error reply to ipc
 336      * @param call_ipc pointer to call IPC interface struct
 337      * @param ipc_data ipc data
 338      * @param error pointer to GError describing error
 339      */
 340     void (*activate_conference_error) (CallIPCInterface *call_ipc,
 341                                        gpointer ipc_data,
 342                                        GError *error);
 343
 344     /**
 345      * @brief sends an error reply to ipc
 346      * @param call_ipc pointer to call IPC interface struct
 347      * @param ipc_data ipc data
 348      * @param error pointer to GError describing error
 349      */
 350     void (*release_error) (CallIPCInterface *call_ipc,
 351                            gpointer ipc_data,
 352                            GError *error);
 353
 354     /**
 355      * @brief sends an error reply to ipc
 356      * @param call_ipc pointer to call IPC interface struct
 357      * @param ipc_data ipc data
 358      * @param error pointer to GError describing error
 359      */
 360     void (*join_error) (CallIPCInterface *call_ipc,
 361                         gpointer ipc_data,
 362                         GError *error);
 363
 364     /**
 365      * @brief sends an error reply to ipc
 366      * @param call_ipc pointer to call IPC interface struct
 367      * @param ipc_data ipc data
 368      * @param error pointer to GError describing error
 369      */
 370     void (*release_all_error) (CallIPCInterface *call_ipc,
 371                                gpointer ipc_data,
 372                                GError *error);
 373
 374     /**
 375      * @brief sends an error reply to ipc
 376      * @param call_ipc pointer to call IPC interface struct
 377      * @param ipc_data ipc data
 378      * @param error pointer to GError describing error
 379      */
 380     void (*release_held_error) (CallIPCInterface *call_ipc,
 381                                 gpointer ipc_data,
 382                                 GError *error);
 383
 384     /**
 385      * @brief sends an error reply to ipc
 386      * @param call_ipc pointer to call IPC interface struct
 387      * @param ipc_data ipc data
 388      * @param error pointer to GError describing error
 389      */
 390     void (*send_dtmf_error) (CallIPCInterface *call_ipc,
 391                              gpointer ipc_data,
 392                              GError *error);
 393
 394     /**
 395      * @brief sends an error reply to ipc
 396      * @param call_ipc pointer to call IPC interface struct
 397      * @param ipc_data ipc data
 398      * @param error pointer to GError describing error
 399      */
 400     void (*emergency_error) (CallIPCInterface *call_ipc,
 401                              gpointer ipc_data,
 402                              GError *error);
 403
 404
 405     /**
 406      * @brief sends an error reply to ipc
 407      * @param call_ipc pointer to call IPC interface struct
 408      * @param ipc_data ipc data
 409      * @param error pointer to GError describing error
 410      */
 411     void (*set_dtmf_duration_error) (CallIPCInterface *call_ipc,
 412                                      gpointer ipc_data,
 413                                      GError *error);
 414
 415     /**
 416      * @brief sends an error reply to ipc
 417      * @param call_ipc pointer to call IPC interface struct
 418      * @param ipc_data ipc data
 419      * @param error pointer to GError describing error
 420      */
 421     void (*get_dtmf_duration_error) (CallIPCInterface *call_ipc,
 422                                      gpointer ipc_data,
 423                                      GError *error);
 424
 425     /**
 426      * @brief sends an error reply to ipc
 427      * @param call_ipc call IPC interface pointer
 428      * @param ipc_data data for ipc
 429      * @param error pointer to GError describing error
 430      */
 431     void (*list_calls_error) (CallIPCInterface *call_ipc,
 432                               gpointer ipc_data,
 433                               GError *error);
 434
 435     /**
 436      * @brief sends an error reply to ipc
 437      * @param call_ipc call IPC interface pointer
 438      * @param ipc_data data for ipc
 439      * @param error pointer to GError describing error
 440      */
 441     void (*set_send_identification_error) (CallIPCInterface *call_ipc,
 442                                            gpointer ipc_data,
 443                                            GError *error);
 444
 445     /**
 446      * @brief sends an error reply to ipc
 447      * @param call_ipc call IPC interface pointer
 448      * @param ipc_data data for ipc
 449      * @param error pointer to GError describing error
 450      */
 451     void (*get_send_identification_error) (CallIPCInterface *call_ipc,
 452                                            gpointer ipc_data,
 453                                            GError *error);
 454
 455     /********************************Signals***********************************/
 456
 457
 458
 459     /**
 460      * @brief call progress signal is emited to provide additional information
 461      * on call's progress
 462      */
 463     void (*call_status) (CallIPCInterface *call_ipc,
 464                          const gint id,
 465                          const gchar *status,
 466                          GHashTable *properties
 467                         );
 468
 469
 470 };
 471
 472 #endif