summaryrefslogtreecommitdiff
path: root/pjmedia/include/pjmedia/types.h
blob: ac3af4e8701ddbf78de2211f1ccc1a4f39750829 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
/* $Id$ */
/* 
 * Copyright (C) 2003-2006 Benny Prijono <benny@prijono.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA 
 */
#ifndef __PJMEDIA_TYPES_H__
#define __PJMEDIA_TYPES_H__

#include <pjmedia/config.h>
#include <pj/sock.h>

/** 
 * Top most media type. 
 */
enum pjmedia_type
{
    /** No type. */
    PJMEDIA_TYPE_NONE = 0,

    /** The media is audio */
    PJMEDIA_TYPE_AUDIO = 1,

    /** The media is video. */
    PJMEDIA_TYPE_VIDEO = 2,

    /** Unknown media type, in this case the name will be specified in 
     *  encoding_name.
     */
    PJMEDIA_TYPE_UNKNOWN = 3,

};


/** 
 * Media direction. 
 */
enum pjmedia_dir
{
    /** None */
    PJMEDIA_DIR_NONE = 0,

    /** Encoding (outgoing to network) stream */
    PJMEDIA_DIR_ENCODING = 1,

    /** Decoding (incoming from network) stream. */
    PJMEDIA_DIR_DECODING = 2,

    /** Incoming and outgoing stream. */
    PJMEDIA_DIR_ENCODING_DECODING = 3,

};


/**
 * Top level media type.
 */
typedef enum pjmedia_type pjmedia_type;

/**
 * Media direction.
 */
typedef enum pjmedia_dir pjmedia_dir;

/**
 * Codec info.
 */
typedef struct pjmedia_codec_info pjmedia_codec_info;

/**
 * Codec initialization parameter.
 */
typedef struct pjmedia_codec_param pjmedia_codec_param;

/** 
 * Types of media frames. 
 */
typedef enum pjmedia_frame_type pjmedia_frame_type;

/** 
 * This structure describes a media frame. 
 */
typedef struct pjmedia_frame pjmedia_frame;

/**
 * Codec instance.
 */
typedef struct pjmedia_codec pjmedia_codec;

/**
 * Codec factory.
 */
typedef struct pjmedia_codec_factory pjmedia_codec_factory;

/**
 * Codec operation.
 */
typedef struct pjmedia_codec_op pjmedia_codec_op;

/**
 * Codec factory operation.
 */
typedef struct pjmedia_codec_factory_op pjmedia_codec_factory_op;

/**
 * Codec manager.
 */
typedef struct pjmedia_codec_mgr pjmedia_codec_mgr;

/** 
 * Opague declaration of media endpoint. 
 */
typedef struct pjmedia_endpt pjmedia_endpt;


/** 
 * Media socket info. 
 */
typedef struct pjmedia_sock_info
{

    pj_sock_t	    rtp_sock;	    /**< Socket for RTP.		    */
    pj_sockaddr_in  rtp_addr_name;  /**< Local RTP address to be advertised.*/
    pj_sock_t	    rtcp_sock;	    /**< Socket for RTCP.		    */
    pj_sockaddr_in  rtcp_addr_name; /**< Local RTCP addr to be advertised.  */

} pjmedia_sock_info;


/**
 * Typedef for media stream information.
 */
typedef struct pjmedia_stream_info pjmedia_stream_info;

/**
 * Typedef for media stream statistic.
 */
typedef struct pjmedia_stream_stat pjmedia_stream_stat;

/**
 * Typedef for media stream.
 */
typedef struct pjmedia_stream pjmedia_stream;

/**
 * Individual channel statistic.
 */
typedef struct pjmedia_channel_stat pjmedia_channel_stat;

/** 
 * Opaque declaration of media session. 
 */
typedef struct pjmedia_session pjmedia_session;

/**
 * Media session info.
 */
typedef struct pjmedia_session_info pjmedia_session_info;

/**
 * Forward declaration for SDP attribute (sdp.h)
 */
typedef struct pjmedia_sdp_attr pjmedia_sdp_attr;

/**
 * Forward declaration for SDP rtpmap attribute (sdp.h)
 */
typedef struct pjmedia_sdp_rtpmap pjmedia_sdp_rtpmap;

/**
 * Forward declaration for SDP fmtp attribute (sdp.h)
 */
typedef struct pjmedia_sdp_fmtp pjmedia_sdp_fmtp;

/**
 * Forward declaration for SDP connection info (sdp.h)
 */
typedef struct pjmedia_sdp_conn pjmedia_sdp_conn;

/**
 * Forward declaration for SDP media line (sdp.h)
 */
typedef struct pjmedia_sdp_media pjmedia_sdp_media;

/**
 * Forward declaration for SDP session (sdp.h)
 */
typedef struct pjmedia_sdp_session pjmedia_sdp_session;

/**
 * Forward declaration for SDP negotiator state (sdp_neg.h).
 */
typedef enum pjmedia_sdp_neg_state pjmedia_sdp_neg_state;

/**
 * Forward declaration for SDP negotiator (sdp_neg.h).
 */
typedef struct pjmedia_sdp_neg pjmedia_sdp_neg;

/**
 * Types of frame returned from jitter buffer (jbuf.h).
 */
typedef enum pjmedia_jb_frame_type pjmedia_jb_frame_type;

/**
 * Opaque declaration for jitter buffer.
 */
typedef struct pjmedia_jbuf pjmedia_jbuf;

#endif	/* __PJMEDIA_TYPES_H__ */