oRTP  0.25.0
include/ortp/payloadtype.h
Go to the documentation of this file.
00001 /*
00002   The oRTP library is an RTP (Realtime Transport Protocol - rfc3550) stack.
00003   Copyright (C) 2001  Simon MORLAT simon.morlat@linphone.org
00004 
00005   This library is free software; you can redistribute it and/or
00006   modify it under the terms of the GNU Lesser General Public
00007   License as published by the Free Software Foundation; either
00008   version 2.1 of the License, or (at your option) any later version.
00009 
00010   This library is distributed in the hope that it will be useful,
00011   but WITHOUT ANY WARRANTY; without even the implied warranty of
00012   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013   Lesser General Public License for more details.
00014 
00015   You should have received a copy of the GNU Lesser General Public
00016   License along with this library; if not, write to the Free Software
00017   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00018 */
00019 
00026 #ifndef PAYLOADTYPE_H
00027 #define PAYLOADTYPE_H
00028 #include <ortp/port.h>
00029 
00030 #ifdef __cplusplus
00031 extern "C"{
00032 #endif
00033 
00034 /* flags for PayloadType::flags */
00035 
00036 #define PAYLOAD_TYPE_ALLOCATED (1)
00037 /*payload type represents a VBR codec*/
00038 #define PAYLOAD_TYPE_IS_VBR (1<<1)
00039 #define PAYLOAD_TYPE_RTCP_FEEDBACK_ENABLED (1<<2)
00040 /* private flags for future use by ortp */
00041 #define PAYLOAD_TYPE_PRIV1 (1<<3)
00042 /* user flags, can be used by the application on top of oRTP */
00043 #define PAYLOAD_TYPE_USER_FLAG_0 (1<<4)
00044 #define PAYLOAD_TYPE_USER_FLAG_1 (1<<5)
00045 #define PAYLOAD_TYPE_USER_FLAG_2 (1<<6)
00046 #define PAYLOAD_TYPE_USER_FLAG_3 (1<<7)
00047 #define PAYLOAD_TYPE_USER_FLAG_4 (1<<8)
00048 /* ask for more if you need*/
00049 
00050 #define PAYLOAD_AUDIO_CONTINUOUS 0
00051 #define PAYLOAD_AUDIO_PACKETIZED 1
00052 #define PAYLOAD_VIDEO 2
00053 #define PAYLOAD_TEXT 3
00054 #define PAYLOAD_OTHER 4  /* ?? */
00055 
00056 #define PAYLOAD_TYPE_AVPF_NONE 0
00057 #define PAYLOAD_TYPE_AVPF_FIR (1 << 0)
00058 #define PAYLOAD_TYPE_AVPF_PLI (1 << 1)
00059 #define PAYLOAD_TYPE_AVPF_SLI (1 << 2)
00060 #define PAYLOAD_TYPE_AVPF_RPSI (1 << 3)
00061 
00062 struct _PayloadTypeAvpfParams {
00063         unsigned char features; 
00064         bool_t rpsi_compatibility; /*< Linphone uses positive feeback for RPSI. However first versions handling
00065                 AVPF wrongly declared RPSI as negative feedback, so this is kept for compatibility
00066                 with these versions but will probably be removed at some point in time. */
00067         uint16_t trr_interval; 
00068 };
00069 
00070 struct _PayloadType
00071 {
00072         int type; 
00073         int clock_rate; 
00074         char bits_per_sample;   /* in case of continuous audio data */
00075         char *zero_pattern;
00076         int pattern_length;
00077         /* other useful information for the application*/
00078         int normal_bitrate;     /*in bit/s */
00079         char *mime_type; 
00080         int channels; 
00081         char *recv_fmtp; /* various format parameters for the incoming stream */
00082         char *send_fmtp; /* various format parameters for the outgoing stream */
00083         struct _PayloadTypeAvpfParams avpf; /* AVPF parameters */
00084         int flags;
00085         void *user_data;
00086 };
00087 
00088 #ifndef PayloadType_defined
00089 #define PayloadType_defined
00090 typedef struct _PayloadType PayloadType;
00091 typedef struct _PayloadTypeAvpfParams PayloadTypeAvpfParams;
00092 #endif
00093 
00094 #define payload_type_set_flag(pt,flag) (pt)->flags|=((int)flag)
00095 #define payload_type_unset_flag(pt,flag) (pt)->flags&=(~(int)flag)
00096 #define payload_type_get_flags(pt)      (pt)->flags
00097 
00098 
00099 ORTP_PUBLIC PayloadType *payload_type_new(void);
00100 ORTP_PUBLIC PayloadType *payload_type_clone(const PayloadType *payload);
00101 ORTP_PUBLIC char *payload_type_get_rtpmap(PayloadType *pt);
00102 ORTP_PUBLIC void payload_type_destroy(PayloadType *pt);
00103 ORTP_PUBLIC void payload_type_set_recv_fmtp(PayloadType *pt, const char *fmtp);
00104 ORTP_PUBLIC void payload_type_set_send_fmtp(PayloadType *pt, const char *fmtp);
00105 ORTP_PUBLIC void payload_type_append_recv_fmtp(PayloadType *pt, const char *fmtp);
00106 ORTP_PUBLIC void payload_type_append_send_fmtp(PayloadType *pt, const char *fmtp);
00107 #define payload_type_get_avpf_params(pt)        ((pt)->avpf)
00108 ORTP_PUBLIC void payload_type_set_avpf_params(PayloadType *pt, PayloadTypeAvpfParams params);
00109 
00110 #define payload_type_get_bitrate(pt)    ((pt)->normal_bitrate)
00111 #define payload_type_get_rate(pt)               ((pt)->clock_rate)
00112 #define payload_type_get_mime(pt)               ((pt)->mime_type)
00113 
00114 ORTP_PUBLIC bool_t fmtp_get_value(const char *fmtp, const char *param_name, char *result, size_t result_len);
00115 
00116 #define payload_type_set_user_data(pt,p)        (pt)->user_data=(p)
00117 #define payload_type_get_user_data(pt)          ((pt)->user_data)
00118 
00119 
00120 /* some payload types */
00121 /* audio */
00122 ORTP_VAR_PUBLIC PayloadType payload_type_pcmu8000;
00123 ORTP_VAR_PUBLIC PayloadType payload_type_pcma8000;
00124 ORTP_VAR_PUBLIC PayloadType payload_type_pcm8000;
00125 ORTP_VAR_PUBLIC PayloadType payload_type_l16_mono;
00126 ORTP_VAR_PUBLIC PayloadType payload_type_l16_stereo;
00127 ORTP_VAR_PUBLIC PayloadType payload_type_lpc1016;
00128 ORTP_VAR_PUBLIC PayloadType payload_type_g729;
00129 ORTP_VAR_PUBLIC PayloadType payload_type_g7231;
00130 ORTP_VAR_PUBLIC PayloadType payload_type_g7221;
00131 ORTP_VAR_PUBLIC PayloadType payload_type_cn;
00132 ORTP_VAR_PUBLIC PayloadType payload_type_g726_40;
00133 ORTP_VAR_PUBLIC PayloadType payload_type_g726_32;
00134 ORTP_VAR_PUBLIC PayloadType payload_type_g726_24;
00135 ORTP_VAR_PUBLIC PayloadType payload_type_g726_16;
00136 ORTP_VAR_PUBLIC PayloadType payload_type_aal2_g726_40;
00137 ORTP_VAR_PUBLIC PayloadType payload_type_aal2_g726_32;
00138 ORTP_VAR_PUBLIC PayloadType payload_type_aal2_g726_24;
00139 ORTP_VAR_PUBLIC PayloadType payload_type_aal2_g726_16;
00140 ORTP_VAR_PUBLIC PayloadType payload_type_gsm;
00141 ORTP_VAR_PUBLIC PayloadType payload_type_lpc;
00142 ORTP_VAR_PUBLIC PayloadType payload_type_lpc1015;
00143 ORTP_VAR_PUBLIC PayloadType payload_type_speex_nb;
00144 ORTP_VAR_PUBLIC PayloadType payload_type_speex_wb;
00145 ORTP_VAR_PUBLIC PayloadType payload_type_speex_uwb;
00146 ORTP_VAR_PUBLIC PayloadType payload_type_ilbc;
00147 ORTP_VAR_PUBLIC PayloadType payload_type_amr;
00148 ORTP_VAR_PUBLIC PayloadType payload_type_amrwb;
00149 ORTP_VAR_PUBLIC PayloadType payload_type_truespeech;
00150 ORTP_VAR_PUBLIC PayloadType payload_type_evrc0;
00151 ORTP_VAR_PUBLIC PayloadType payload_type_evrcb0;
00152 ORTP_VAR_PUBLIC PayloadType payload_type_silk_nb;
00153 ORTP_VAR_PUBLIC PayloadType payload_type_silk_mb;
00154 ORTP_VAR_PUBLIC PayloadType payload_type_silk_wb;
00155 ORTP_VAR_PUBLIC PayloadType payload_type_silk_swb;
00156 ORTP_VAR_PUBLIC PayloadType payload_type_aaceld_16k;
00157 ORTP_VAR_PUBLIC PayloadType payload_type_aaceld_22k;
00158 ORTP_VAR_PUBLIC PayloadType payload_type_aaceld_32k;
00159 ORTP_VAR_PUBLIC PayloadType payload_type_aaceld_44k;
00160 ORTP_VAR_PUBLIC PayloadType payload_type_aaceld_48k;
00161 ORTP_VAR_PUBLIC PayloadType payload_type_opus;
00162 ORTP_VAR_PUBLIC PayloadType payload_type_isac;
00163 ORTP_VAR_PUBLIC PayloadType payload_type_gsm_efr;
00164 ORTP_VAR_PUBLIC PayloadType payload_type_codec2;
00165 
00166 /* video */
00167 ORTP_VAR_PUBLIC PayloadType payload_type_mpv;
00168 ORTP_VAR_PUBLIC PayloadType payload_type_h261;
00169 ORTP_VAR_PUBLIC PayloadType payload_type_h263;
00170 ORTP_VAR_PUBLIC PayloadType payload_type_h263_1998;
00171 ORTP_VAR_PUBLIC PayloadType payload_type_h263_2000;
00172 ORTP_VAR_PUBLIC PayloadType payload_type_mp4v;
00173 ORTP_VAR_PUBLIC PayloadType payload_type_theora;
00174 ORTP_VAR_PUBLIC PayloadType payload_type_h264;
00175 ORTP_VAR_PUBLIC PayloadType payload_type_x_snow;
00176 ORTP_VAR_PUBLIC PayloadType payload_type_jpeg;
00177 ORTP_VAR_PUBLIC PayloadType payload_type_vp8;
00178 
00179 ORTP_VAR_PUBLIC PayloadType payload_type_g722;
00180 
00181 /* text */
00182 ORTP_VAR_PUBLIC PayloadType payload_type_t140;
00183 ORTP_VAR_PUBLIC PayloadType payload_type_t140_red;
00184 
00185 /* non standard file transfer over UDP */
00186 ORTP_VAR_PUBLIC PayloadType payload_type_x_udpftp;
00187 
00188 /* telephone-event */
00189 ORTP_VAR_PUBLIC PayloadType payload_type_telephone_event;
00190 
00191 #ifdef __cplusplus
00192 }
00193 #endif
00194 
00195 #endif