/usr/include/pjmedia/stream.h is in libpjproject-dev 2.1.0.0.ast20130823-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 | /* $Id: stream.h 3841 2011-10-24 09:28:13Z ming $ */
/*
* Copyright (C) 2008-2011 Teluu Inc. (http://www.teluu.com)
* Copyright (C) 2003-2008 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_STREAM_H__
#define __PJMEDIA_STREAM_H__
/**
* @file stream.h
* @brief Media Stream.
*/
#include <pjmedia/codec.h>
#include <pjmedia/endpoint.h>
#include <pjmedia/jbuf.h>
#include <pjmedia/port.h>
#include <pjmedia/rtcp.h>
#include <pjmedia/transport.h>
#include <pjmedia/vid_codec.h>
#include <pj/sock.h>
PJ_BEGIN_DECL
/**
* @defgroup PJMED_STRM Streams
* @ingroup PJMEDIA_PORT
* @brief Communicating with remote peer via the network
* @{
*
* A media stream is a bidirectional multimedia communication between two
* endpoints. It corresponds to a media description (m= line) in SDP
* session descriptor.
*
* A media stream consists of two unidirectional channels:
* - encoding channel, which transmits unidirectional media to remote, and
* - decoding channel, which receives unidirectional media from remote.
*
* A media stream exports media port interface (see @ref PJMEDIA_PORT)
* and application normally uses this interface to interconnect the stream
* to other PJMEDIA components.
*
* A media stream internally manages the following objects:
* - an instance of media codec (see @ref PJMEDIA_CODEC),
* - an @ref PJMED_JBUF,
* - two instances of RTP sessions (#pjmedia_rtp_session, one for each
* direction),
* - one instance of RTCP session (#pjmedia_rtcp_session),
* - and a reference to media transport to send and receive packets
* to/from the network (see @ref PJMEDIA_TRANSPORT).
*
* Streams are created by calling #pjmedia_stream_create(), specifying
* #pjmedia_stream_info structure in the parameter. Application can construct
* the #pjmedia_stream_info structure manually, or use
* #pjmedia_stream_info_from_sdp() or #pjmedia_session_info_from_sdp()
* functions to construct the #pjmedia_stream_info from local and remote
* SDP session descriptors.
*
* Application can also use @ref PJMEDIA_SESSION to indirectly create the
* streams.
*/
/**
* Opaque declaration for media channel.
* Media channel is unidirectional flow of media from sender to
* receiver.
*/
typedef struct pjmedia_channel pjmedia_channel;
/**
* This structure describes media stream information. Each media stream
* corresponds to one "m=" line in SDP session descriptor, and it has
* its own RTP/RTCP socket pair.
*/
typedef struct pjmedia_stream_info
{
pjmedia_type type; /**< Media type (audio, video) */
pjmedia_tp_proto proto; /**< Transport protocol (RTP/AVP, etc.) */
pjmedia_dir dir; /**< Media direction. */
pj_sockaddr rem_addr; /**< Remote RTP address */
pj_sockaddr rem_rtcp; /**< Optional remote RTCP address. If
sin_family is zero, the RTP address
will be calculated from RTP. */
#if defined(PJMEDIA_HAS_RTCP_XR) && (PJMEDIA_HAS_RTCP_XR != 0)
pj_bool_t rtcp_xr_enabled;
/**< Specify whether RTCP XR is enabled.*/
pj_uint32_t rtcp_xr_interval; /**< RTCP XR interval. */
pj_sockaddr rtcp_xr_dest;/**<Additional remote RTCP XR address.
This is useful for third-party (e.g:
network monitor) to monitor the
stream. If sin_family is zero,
this will be ignored. */
#endif
pjmedia_codec_info fmt; /**< Incoming codec format info. */
pjmedia_codec_param *param; /**< Optional codec param. */
unsigned tx_pt; /**< Outgoing codec paylaod type. */
unsigned rx_pt; /**< Incoming codec paylaod type. */
unsigned tx_maxptime;/**< Outgoing codec max ptime. */
int tx_event_pt;/**< Outgoing pt for telephone-events. */
int rx_event_pt;/**< Incoming pt for telephone-events. */
pj_uint32_t ssrc; /**< RTP SSRC. */
pj_uint32_t rtp_ts; /**< Initial RTP timestamp. */
pj_uint16_t rtp_seq; /**< Initial RTP sequence number. */
pj_uint8_t rtp_seq_ts_set;
/**< Bitmask flags if initial RTP sequence
and/or timestamp for sender are set.
bit 0/LSB : sequence flag
bit 1 : timestamp flag */
int jb_init; /**< Jitter buffer init delay in msec.
(-1 for default). */
int jb_min_pre; /**< Jitter buffer minimum prefetch
delay in msec (-1 for default). */
int jb_max_pre; /**< Jitter buffer maximum prefetch
delay in msec (-1 for default). */
int jb_max; /**< Jitter buffer max delay in msec. */
#if defined(PJMEDIA_STREAM_ENABLE_KA) && PJMEDIA_STREAM_ENABLE_KA!=0
pj_bool_t use_ka; /**< Stream keep-alive and NAT hole punch
(see #PJMEDIA_STREAM_ENABLE_KA)
is enabled? */
#endif
pj_bool_t rtcp_sdes_bye_disabled;
/**< Disable automatic sending of RTCP
SDES and BYE. */
} pjmedia_stream_info;
/**
* This function will initialize the stream info based on information
* in both SDP session descriptors for the specified stream index.
* The remaining information will be taken from default codec parameters.
* If socket info array is specified, the socket will be copied to the
* session info as well.
*
* @param si Stream info structure to be initialized.
* @param pool Pool to allocate memory.
* @param endpt PJMEDIA endpoint instance.
* @param local Local SDP session descriptor.
* @param remote Remote SDP session descriptor.
* @param stream_idx Media stream index in the session descriptor.
*
* @return PJ_SUCCESS if stream info is successfully initialized.
*/
PJ_DECL(pj_status_t)
pjmedia_stream_info_from_sdp( pjmedia_stream_info *si,
pj_pool_t *pool,
pjmedia_endpt *endpt,
const pjmedia_sdp_session *local,
const pjmedia_sdp_session *remote,
unsigned stream_idx);
/**
* Create a media stream based on the specified parameter. After the stream
* has been created, application normally would want to get the media port
* interface of the streams, by calling pjmedia_stream_get_port(). The
* media port interface exports put_frame() and get_frame() function, used
* to transmit and receive media frames from the stream.
*
* Without application calling put_frame() and get_frame(), there will be
* no media frames transmitted or received by the stream.
*
* @param endpt Media endpoint.
* @param pool Pool to allocate memory for the stream. A large
* number of memory may be needed because jitter
* buffer needs to preallocate some storage.
* @param info Stream information.
* @param tp Stream transport instance used to transmit
* and receive RTP/RTCP packets to/from the underlying
* transport.
* @param user_data Arbitrary user data (for future callback feature).
* @param p_stream Pointer to receive the media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_create(pjmedia_endpt *endpt,
pj_pool_t *pool,
const pjmedia_stream_info *info,
pjmedia_transport *tp,
void *user_data,
pjmedia_stream **p_stream);
/**
* Destroy the media stream.
*
* @param stream The media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_destroy(pjmedia_stream *stream);
/**
* Get the last frame type retreived from the jitter buffer.
*
* @param stream The media stream.
*
* @return Jitter buffer frame type.
*/
PJ_DEF(char) pjmedia_stream_get_last_jb_frame_type(pjmedia_stream *stream);
/**
* Get the media port interface of the stream. The media port interface
* declares put_frame() and get_frame() function, which is the only
* way for application to transmit and receive media frames from the
* stream.
*
* @param stream The media stream.
* @param p_port Pointer to receive the port interface.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_port(pjmedia_stream *stream,
pjmedia_port **p_port );
/**
* Get the media transport object associated with this stream.
*
* @param st The media stream.
*
* @return The transport object being used by the stream.
*/
PJ_DECL(pjmedia_transport*) pjmedia_stream_get_transport(pjmedia_stream *st);
/**
* Start the media stream. This will start the appropriate channels
* in the media stream, depending on the media direction that was set
* when the stream was created.
*
* @param stream The media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_start(pjmedia_stream *stream);
/**
* Get the stream info.
*
* @param stream The media stream.
* @param info Stream info.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_info( const pjmedia_stream *stream,
pjmedia_stream_info *info);
/**
* Get the stream statistics. See also
* #pjmedia_stream_get_stat_jbuf()
*
* @param stream The media stream.
* @param stat Media stream statistics.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_stat( const pjmedia_stream *stream,
pjmedia_rtcp_stat *stat);
/**
* Reset the stream statistics.
*
* @param stream The media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_reset_stat(pjmedia_stream *stream);
#if defined(PJMEDIA_HAS_RTCP_XR) && (PJMEDIA_HAS_RTCP_XR != 0)
/**
* Get the stream extended report statistics (RTCP XR).
*
* @param stream The media stream.
* @param stat Media stream extended report statistics.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_stat_xr( const pjmedia_stream *stream,
pjmedia_rtcp_xr_stat *stat);
#endif
/**
* Get current jitter buffer state. See also
* #pjmedia_stream_get_stat()
*
* @param stream The media stream.
* @param state Jitter buffer state.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_stat_jbuf(const pjmedia_stream *stream,
pjmedia_jb_state *state);
/**
* Pause the individual channel in the stream.
*
* @param stream The media channel.
* @param dir Which direction to pause.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_pause( pjmedia_stream *stream,
pjmedia_dir dir);
/**
* Resume the individual channel in the stream.
*
* @param stream The media channel.
* @param dir Which direction to resume.
*
* @return PJ_SUCCESS on success;
*/
PJ_DECL(pj_status_t) pjmedia_stream_resume(pjmedia_stream *stream,
pjmedia_dir dir);
/**
* Transmit DTMF to this stream. The DTMF will be transmitted uisng
* RTP telephone-events as described in RFC 2833. This operation is
* only valid for audio stream.
*
* @param stream The media stream.
* @param ascii_digit String containing digits to be sent to remote.
* Currently the maximum number of digits are 32.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t) pjmedia_stream_dial_dtmf(pjmedia_stream *stream,
const pj_str_t *ascii_digit);
/**
* Check if the stream has incoming DTMF digits in the incoming DTMF
* queue. Incoming DTMF digits received via RFC 2833 mechanism are
* saved in the incoming digits queue.
*
* @param stream The media stream.
*
* @return Non-zero (PJ_TRUE) if the stream has received DTMF
* digits in the .
*/
PJ_DECL(pj_bool_t) pjmedia_stream_check_dtmf(pjmedia_stream *stream);
/**
* Retrieve the incoming DTMF digits from the stream, and remove the digits
* from stream's DTMF buffer. Note that the digits buffer will not be NULL
* terminated.
*
* @param stream The media stream.
* @param ascii_digits Buffer to receive the digits. The length of this
* buffer is indicated in the "size" argument.
* @param size On input, contains the maximum digits to be copied
* to the buffer.
* On output, it contains the actual digits that has
* been copied to the buffer.
*
* @return Non-zero (PJ_TRUE) if the stream has received DTMF
* digits in the .
*/
PJ_DECL(pj_status_t) pjmedia_stream_get_dtmf( pjmedia_stream *stream,
char *ascii_digits,
unsigned *size);
/**
* Set callback to be called upon receiving DTMF digits. If callback is
* registered, the stream will not buffer incoming DTMF but rather call
* the callback as soon as DTMF digit is received completely.
*
* @param stream The media stream.
* @param cb Callback to be called upon receiving DTMF digits.
* The DTMF digits will be given to the callback as
* ASCII digits.
* @param user_data User data to be returned back when the callback
* is called.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_stream_set_dtmf_callback(pjmedia_stream *stream,
void (*cb)(pjmedia_stream*,
void *user_data,
int digit),
void *user_data);
/**
* Send RTCP SDES for the media stream.
*
* @param stream The media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_stream_send_rtcp_sdes( pjmedia_stream *stream );
/**
* Send RTCP BYE for the media stream.
*
* @param stream The media stream.
*
* @return PJ_SUCCESS on success.
*/
PJ_DECL(pj_status_t)
pjmedia_stream_send_rtcp_bye( pjmedia_stream *stream );
/**
* @}
*/
PJ_END_DECL
#endif /* __PJMEDIA_STREAM_H__ */
|