sdp_message.h

Go to the documentation of this file.

/*
  The oSIP library implements the Session Initiation Protocol (SIP -rfc3261-)
  Copyright (C) 2001-2015 Aymeric MOIZARD amoizard@antisip.com
  
  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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/


#ifndef _SDP_H_
#define _SDP_H_

#ifdef ENABLE_MPATROL
#include <mpatrol.h>
#endif

#include <osipparser2/osip_list.h>


#ifdef __cplusplus
extern "C" {
#endif

  typedef struct sdp_bandwidth sdp_bandwidth_t;

  struct sdp_bandwidth {
    char *b_bwtype;                             
    char *b_bandwidth;                          
  };

  int sdp_bandwidth_init (sdp_bandwidth_t ** elem);
  void sdp_bandwidth_free (sdp_bandwidth_t * elem);

  typedef struct sdp_time_descr sdp_time_descr_t;

  struct sdp_time_descr {
    char *t_start_time;                            
    char *t_stop_time;                             
    osip_list_t r_repeats;                
  };

  int sdp_time_descr_init (sdp_time_descr_t ** elem);
  void sdp_time_descr_free (sdp_time_descr_t * elem);

  typedef struct sdp_key sdp_key_t;

  struct sdp_key {
    char *k_keytype;            
    char *k_keydata;            
  };

  int sdp_key_init (sdp_key_t ** elem);
  void sdp_key_free (sdp_key_t * elem);

  typedef struct sdp_attribute sdp_attribute_t;

  struct sdp_attribute {
    char *a_att_field;                          
    char *a_att_value;                          
  };

  int sdp_attribute_init (sdp_attribute_t ** elem);
  void sdp_attribute_free (sdp_attribute_t * elem);


  typedef struct sdp_connection sdp_connection_t;

  struct sdp_connection {
    char *c_nettype;                             
    char *c_addrtype;                            
    char *c_addr;                                
    char *c_addr_multicast_ttl;
    char *c_addr_multicast_int;
  };

  int sdp_connection_init (sdp_connection_t ** elem);
  void sdp_connection_free (sdp_connection_t * elem);

  typedef struct sdp_media sdp_media_t;

  struct sdp_media {
    char *m_media;                              
    char *m_port;                               
    char *m_number_of_port;             
    char *m_proto;                              
    osip_list_t m_payloads;            
    char *i_info;                               
    osip_list_t c_connections;
    osip_list_t b_bandwidths;
    osip_list_t a_attributes;
    sdp_key_t *k_key;                           
  };

  int sdp_media_init (sdp_media_t ** elem);
  void sdp_media_free (sdp_media_t * elem);

  typedef struct sdp_message sdp_message_t;

  struct sdp_message {
    char *v_version;                            
    char *o_username;                           
    char *o_sess_id;                            
    char *o_sess_version;               
    char *o_nettype;                            
    char *o_addrtype;                           
    char *o_addr;                               
    char *s_name;                               
    char *i_info;                               
    char *u_uri;                                
    osip_list_t e_emails;              
    osip_list_t p_phones;              
    sdp_connection_t *c_connection;
    osip_list_t b_bandwidths;
    osip_list_t t_descrs;              
    char *z_adjustments;                
    sdp_key_t *k_key;                           
    osip_list_t a_attributes;
    osip_list_t m_medias;              
  };



  int sdp_message_init (sdp_message_t ** sdp);
  int sdp_message_parse (sdp_message_t * sdp, const char *buf);
  int sdp_message_to_str (sdp_message_t * sdp, char **dest);
  void sdp_message_free (sdp_message_t * sdp);
  int sdp_message_clone (sdp_message_t * sdp, sdp_message_t ** dest);

  int sdp_message_v_version_set (sdp_message_t * sdp, char *value);
  char *sdp_message_v_version_get (sdp_message_t * sdp);
  int sdp_message_o_origin_set (sdp_message_t * sdp, char *username, char *sess_id, char *sess_version, char *nettype, char *addrtype, char *addr);
  char *sdp_message_o_username_get (sdp_message_t * sdp);
  char *sdp_message_o_sess_id_get (sdp_message_t * sdp);
  char *sdp_message_o_sess_version_get (sdp_message_t * sdp);
  char *sdp_message_o_nettype_get (sdp_message_t * sdp);
  char *sdp_message_o_addrtype_get (sdp_message_t * sdp);
  char *sdp_message_o_addr_get (sdp_message_t * sdp);
  int sdp_message_s_name_set (sdp_message_t * sdp, char *value);
  char *sdp_message_s_name_get (sdp_message_t * sdp);
  int sdp_message_i_info_set (sdp_message_t * sdp, int pos_media, char *value);
  char *sdp_message_i_info_get (sdp_message_t * sdp, int pos_media);
  int sdp_message_u_uri_set (sdp_message_t * sdp, char *value);
  char *sdp_message_u_uri_get (sdp_message_t * sdp);
  int sdp_message_e_email_add (sdp_message_t * sdp, char *value);
#define sdp_e_email_get sdp_message_e_email_get

  char *sdp_message_e_email_get (sdp_message_t * sdp, int pos);
  int sdp_message_p_phone_add (sdp_message_t * sdp, char *value);
  char *sdp_message_p_phone_get (sdp_message_t * sdp, int pos);
  int sdp_message_c_connection_add (sdp_message_t * sdp, int pos_media, char *nettype, char *addrtype, char *addr, char *addr_multicast_ttl, char *addr_multicast_int);
#ifndef DOXYGEN
/* this method should be internal only... */
  sdp_connection_t *sdp_message_connection_get (sdp_message_t * sdp, int pos_media, int pos);
#endif

  char *sdp_message_c_nettype_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_c_addrtype_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_c_addr_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_c_addr_multicast_ttl_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_c_addr_multicast_int_get (sdp_message_t * sdp, int pos_media, int pos);
  int sdp_message_b_bandwidth_add (sdp_message_t * sdp, int pos_media, char *bwtype, char *bandwidth);
  sdp_bandwidth_t *sdp_message_bandwidth_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_b_bwtype_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_b_bandwidth_get (sdp_message_t * sdp, int pos_media, int pos);
  int sdp_message_t_time_descr_add (sdp_message_t * sdp, char *start, char *stop);
  char *sdp_message_t_start_time_get (sdp_message_t * sdp, int pos_td);
  char *sdp_message_t_stop_time_get (sdp_message_t * sdp, int pos_td);
  int sdp_message_r_repeat_add (sdp_message_t * sdp, int pos_time_descr, char *value);
  char *sdp_message_r_repeat_get (sdp_message_t * sdp, int pos_time_descr, int pos_repeat);
  int sdp_message_z_adjustments_set (sdp_message_t * sdp, char *value);
  char *sdp_message_z_adjustments_get (sdp_message_t * sdp);
  int sdp_message_k_key_set (sdp_message_t * sdp, int pos_media, char *keytype, char *keydata);
  char *sdp_message_k_keytype_get (sdp_message_t * sdp, int pos_media);
  char *sdp_message_k_keydata_get (sdp_message_t * sdp, int pos_media);
  int sdp_message_a_attribute_add (sdp_message_t * sdp, int pos_media, char *att_field, char *att_value);
  int sdp_message_a_attribute_del (sdp_message_t * sdp, int pos_media, char *att_field);
  int sdp_message_a_attribute_del_at_index (sdp_message_t * sdp, int pos_media, char *att_field, int pos_attr);
  sdp_attribute_t *sdp_message_attribute_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_a_att_field_get (sdp_message_t * sdp, int pos_media, int pos);
  char *sdp_message_a_att_value_get (sdp_message_t * sdp, int pos_media, int pos);
  int sdp_message_endof_media (sdp_message_t * sdp, int pos);
  int sdp_message_m_media_add (sdp_message_t * sdp, char *media, char *port, char *number_of_port, char *proto);
  char *sdp_message_m_media_get (sdp_message_t * sdp, int pos_media);
  char *sdp_message_m_port_get (sdp_message_t * sdp, int pos_media);
  int sdp_message_m_port_set (sdp_message_t * sdp, int pos_media, char *port);
  char *sdp_message_m_number_of_port_get (sdp_message_t * sdp, int pos_media);
  char *sdp_message_m_proto_get (sdp_message_t * sdp, int pos_media);
  int sdp_message_m_payload_add (sdp_message_t * sdp, int pos_media, char *payload);
  char *sdp_message_m_payload_get (sdp_message_t * sdp, int pos_media, int pos);
  int sdp_message_m_payload_del (sdp_message_t * sdp, int pos_media, int pos);


#ifdef __cplusplus
}
#endif
#endif