mediastream.h 27.6 KB
Newer Older
aymeric's avatar
aymeric committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/*
mediastreamer2 library - modular sound and video processing and streaming
Copyright (C) 2006  Simon MORLAT (simon.morlat@linphone.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 MEDIASTREAM_H
#define MEDIASTREAM_H

24 25 26
#include <ortp/ortp.h>
#include <ortp/event.h>
#include <ortp/zrtp.h>
jehan's avatar
jehan committed
27 28
/* defined in srtp.h*/
typedef struct srtp_ctx_t *MSSrtpCtx;
29

Simon Morlat's avatar
Simon Morlat committed
30 31 32 33 34
#include <mediastreamer2/msfilter.h>
#include <mediastreamer2/msticker.h>
#include <mediastreamer2/mssndcard.h>
#include <mediastreamer2/mswebcam.h>
#include <mediastreamer2/msvideo.h>
35 36
#include <mediastreamer2/bitratecontrol.h>
#include <mediastreamer2/qualityindicator.h>
37
#include <mediastreamer2/ice.h>
aymeric's avatar
aymeric committed
38

39

40 41 42
#define PAYLOAD_TYPE_FLAG_CAN_RECV	PAYLOAD_TYPE_USER_FLAG_1
#define PAYLOAD_TYPE_FLAG_CAN_SEND	PAYLOAD_TYPE_USER_FLAG_2

43 44 45 46 47

#ifdef __cplusplus
extern "C" {
#endif

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
/**
 * @addtogroup ring_api
 * @{
**/

struct _RingStream
{
	MSTicker *ticker;
	MSFilter *source;
	MSFilter *gendtmf;
	MSFilter *write_resampler;
	MSFilter *sndwrite;
};

typedef struct _RingStream RingStream;

MS2_PUBLIC RingStream *ring_start (const char * file, int interval, MSSndCard *sndcard);
MS2_PUBLIC RingStream *ring_start_with_cb(const char * file, int interval, MSSndCard *sndcard, MSFilterNotifyFunc func, void * user_data);
MS2_PUBLIC void ring_stop (RingStream * stream);

/**
 * @}
**/
jehan's avatar
jehan committed
71 72 73
/*
 * Crypto suite used configure encrypted stream*/
typedef enum _MSCryptoSuite{
74 75
	MS_CRYPTO_SUITE_INVALID=0,
	MS_AES_128_SHA1_80,
jehan's avatar
jehan committed
76 77 78 79 80 81
	MS_AES_128_SHA1_32,
	MS_AES_128_NO_AUTH,
	MS_NO_CIPHER_SHA1_80,
	MS_AES_256_SHA1_80,
	MS_AES_256_SHA1_32
} MSCryptoSuite;
82

83 84 85 86 87 88 89 90
typedef struct _MSCryptoSuiteNameParams{
	const char *name;
	const char *params;
}MSCryptoSuiteNameParams;

MS2_PUBLIC MSCryptoSuite ms_crypto_suite_build_from_name_params(const MSCryptoSuiteNameParams *nameparams);
MS2_PUBLIC int ms_crypto_suite_to_name_params(MSCryptoSuite cs, MSCryptoSuiteNameParams *nameparams);

91 92 93
/**
 * The MediaStream is an object describing a stream (one of AudioStream or VideoStream).
**/
jehan's avatar
jehan committed
94 95 96 97 98
typedef struct _MediaStream MediaStream;

/*
 * internal cb to process rtcp stream
 * */
99
typedef void (*media_stream_process_rtcp_callback_t)(MediaStream *stream, mblk_t *m);
jehan's avatar
jehan committed
100

101 102
struct _MSMediaStreamSessions{
	RtpSession *rtp_session;
jehan's avatar
jehan committed
103
	MSSrtpCtx srtp_session;
104 105
	OrtpZrtpContext *zrtp_context;
	MSTicker *ticker;
jehan's avatar
jehan committed
106
	bool_t is_secured;
107 108 109
};

typedef struct _MSMediaStreamSessions MSMediaStreamSessions;
jehan's avatar
jehan committed
110

111 112 113 114 115 116 117 118
MS2_PUBLIC void ms_media_stream_sessions_uninit(MSMediaStreamSessions *sessions);

typedef enum _MSStreamState{
	MSStreamInitialized,
	MSStreamPreparing,
	MSStreamStarted
}MSStreamState;

Simon Morlat's avatar
Simon Morlat committed
119 120 121
#define AudioStreamType MSAudio
#define VideoStreamType MSVideo

122 123 124
/**
 * Base struct for both AudioStream and VideoStream structure.
**/
125
struct _MediaStream {
Simon Morlat's avatar
Simon Morlat committed
126
	MSFormatType type;
127 128
	MSStreamState state;
	MSMediaStreamSessions sessions;
129 130 131 132 133 134 135
	OrtpEvQueue *evq;
	MSFilter *rtprecv;
	MSFilter *rtpsend;
	MSFilter *encoder;
	MSFilter *decoder;
	MSFilter *voidsink;
	MSBitrateController *rc;
136
	MSQualityIndicator *qi;
137
	IceCheckList *ice_check_list;
138 139
	time_t start_time;
	time_t last_iterate_time;
140 141
	uint64_t last_packet_count;
	time_t last_packet_time;
142
	bool_t use_rc;
143
	bool_t owns_sessions;
144
	bool_t pad;
jehan's avatar
jehan committed
145
	/**
146
	 * defines encoder target network bit rate, uses #media_stream_set_target_network_bitrate() setter.
jehan's avatar
jehan committed
147 148
	 * */
	int target_bitrate;
149
	media_stream_process_rtcp_callback_t process_rtcp;
150 151
};

jehan's avatar
jehan committed
152 153 154 155 156

/**
 * @addtogroup audio_stream_api
 * @{
**/
157

158 159
MS2_PUBLIC bool_t media_stream_srtp_supported(void);

160 161 162 163 164 165 166 167 168 169
MS2_PUBLIC void media_stream_set_rtcp_information(MediaStream *stream, const char *cname, const char *tool);

MS2_PUBLIC void media_stream_get_local_rtp_stats(MediaStream *stream, rtp_stats_t *stats);

MS2_PUBLIC int media_stream_set_dscp(MediaStream *stream, int dscp);

MS2_PUBLIC void media_stream_enable_adaptive_bitrate_control(MediaStream *stream, bool_t enabled);

MS2_PUBLIC void media_stream_enable_adaptive_jittcomp(MediaStream *stream, bool_t enabled);

170 171 172
/*
 * deprecated, use media_stream_set_srtp_recv_key and media_stream_set_srtp_send_key.
**/
jehan's avatar
jehan committed
173 174 175
MS2_PUBLIC bool_t media_stream_enable_srtp(MediaStream* stream, MSCryptoSuite suite, const char* snd_key, const char* rcv_key);

MS2_PUBLIC int media_stream_set_srtp_recv_key(MediaStream *stream, MSCryptoSuite suite, const char* key);
176

jehan's avatar
jehan committed
177 178
MS2_PUBLIC int media_stream_set_srtp_send_key(MediaStream *stream, MSCryptoSuite suite, const char* key);
/**
179
 * @param[in] stream MediaStream object
jehan's avatar
jehan committed
180 181
 * @return true if stream is encrypted
 * */
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197
MS2_PUBLIC bool_t media_stream_secured(const MediaStream *stream);
#define media_stream_is_secured media_stream_secured

/**
 * Tells whether AVPF is enabled or not.
 * @param[in] stream #MediaStream object.
 * @return True if AVPF is enabled, false otherwise.
 */
MS2_PUBLIC bool_t media_stream_avpf_enabled(const MediaStream *stream);

/**
 * Gets the AVPF Regular RTCP report interval.
 * @param[in] stream #MediaStream object.
 * @return The AVPF Regular RTCP report interval in seconds.
 */
MS2_PUBLIC uint8_t media_stream_get_avpf_rr_interval(const MediaStream *stream);
198 199


200
MS2_PUBLIC const MSQualityIndicator *media_stream_get_quality_indicator(MediaStream *stream);
jehan's avatar
jehan committed
201 202 203
/* *
 * returns a realtime indicator of the stream quality between 0 and 5
 * */
204
MS2_PUBLIC float media_stream_get_quality_rating(MediaStream *stream);
205

206 207
MS2_PUBLIC float media_stream_get_average_quality_rating(MediaStream *stream);

208 209 210 211
MS2_PUBLIC float media_stream_get_lq_quality_rating(MediaStream *stream);

MS2_PUBLIC float media_stream_get_average_lq_quality_rating(MediaStream *stream);

212
/**
jehan's avatar
jehan committed
213 214 215 216 217 218 219 220 221 222 223 224
 * <br>For multirate codecs like OPUS, encoder output target bitrate must be set.
 * <br>Encoder will compute output codec bitrate from this value.
 * <br> default value is the value corresponding the rtp PayloadType
 * @param stream stream to apply parameter on
 * @param target_bitrate in bit per seconds
 * @return 0 if succeed
 * */
MS2_PUBLIC int media_stream_set_target_network_bitrate(MediaStream *stream,int target_bitrate);

/**
 * get the stream target bitrate.
 * @param stream stream to apply parameter on
225
 * @return target_bitrate in bit per seconds
jehan's avatar
jehan committed
226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
 * */
MS2_PUBLIC int media_stream_get_target_network_bitrate(const MediaStream *stream);

/**
 * get current stream  upload bitrate. Value is updated every seconds
 * @param stream
 * @return bitrate in bit per seconds
 * */
MS2_PUBLIC float media_stream_get_up_bw(const MediaStream *stream);

/**
 * get current stream download bitrate. Value is updated every seconds
 * @param stream
 * @return bitrate in bit per seconds
 * */
MS2_PUBLIC float media_stream_get_down_bw(const MediaStream *stream);

243 244 245 246 247 248
/**
 * Returns the sessions that were used in the media stream (RTP, SRTP, ZRTP...) so that they can be re-used.
 * As a result of calling this function, the media stream no longer owns the sessions and thus will not free them.
**/
MS2_PUBLIC void media_stream_reclaim_sessions(MediaStream *stream, MSMediaStreamSessions *sessions);

jehan's avatar
jehan committed
249 250 251

void media_stream_iterate(MediaStream * stream);

252 253 254 255 256
/**
 * Returns TRUE if stream was still actively receiving packets (RTP or RTCP) in the last period specified in timeout_seconds.
**/
MS2_PUBLIC bool_t media_stream_alive(MediaStream *stream, int timeout_seconds);

jehan's avatar
jehan committed
257 258 259 260
/**
 * @returns curret streams tate
 * */
MS2_PUBLIC MSStreamState media_stream_get_state(const MediaStream *stream);
261

262 263 264
typedef enum EchoLimiterType{
	ELInactive,
	ELControlMic,
265
	ELControlFull
266 267
} EchoLimiterType;

aymeric's avatar
aymeric committed
268 269
struct _AudioStream
{
270
	MediaStream ms;
aymeric's avatar
aymeric committed
271 272 273
	MSFilter *soundread;
	MSFilter *soundwrite;
	MSFilter *dtmfgen;
274
	MSFilter *dtmfgen_rtp;
Yann Diorcet's avatar
Yann Diorcet committed
275
	MSFilter *plc;
aymeric's avatar
aymeric committed
276
	MSFilter *ec;/*echo canceler*/
277
	MSFilter *volsend,*volrecv; /*MSVolumes*/
278 279 280
	MSFilter *local_mixer;
	MSFilter *local_player;
	MSFilter *local_player_resampler;
281 282
	MSFilter *read_resampler;
	MSFilter *write_resampler;
smorlat's avatar
smorlat committed
283
	MSFilter *equalizer;
284
	MSFilter *dummy;
285 286 287 288
	MSFilter *send_tee;
	MSFilter *recv_tee;
	MSFilter *recorder_mixer;
	MSFilter *recorder;
Simon Morlat's avatar
Simon Morlat committed
289 290 291 292 293 294
	struct {
		MSFilter *resampler;
		MSFilter *encoder;
		MSFilter *recorder;
		MSFilter *video_input;
	}av_recorder;
295
	char *recorder_file;
296
	EchoLimiterType el_type; /*use echo limiter: two MSVolume, measured input level controlling local output level*/
297
	uint32_t features;
smorlat's avatar
smorlat committed
298
	bool_t play_dtmfs;
smorlat's avatar
smorlat committed
299
	bool_t use_gc;
300
	bool_t use_agc;
smorlat's avatar
smorlat committed
301
	bool_t eq_active;
302
	bool_t use_ng;/*noise gate*/
303
	bool_t is_ec_delay_set;
aymeric's avatar
aymeric committed
304 305
};

306 307 308
/**
 * The AudioStream holds all resources to create and run typical VoIP audiostream.
**/
aymeric's avatar
aymeric committed
309 310 311 312
typedef struct _AudioStream AudioStream;


/* start a thread that does sampling->encoding->rtp_sending|rtp_receiving->decoding->playing */
Simon Morlat's avatar
Simon Morlat committed
313
MS2_PUBLIC AudioStream *audio_stream_start (RtpProfile * prof, int locport, const char *remip,
aymeric's avatar
aymeric committed
314 315
				 int remport, int payload_type, int jitt_comp, bool_t echo_cancel);

Simon Morlat's avatar
Simon Morlat committed
316
MS2_PUBLIC AudioStream *audio_stream_start_with_sndcards(RtpProfile * prof, int locport, const char *remip4, int remport, int payload_type, int jitt_comp, MSSndCard *playcard, MSSndCard *captcard, bool_t echocancel);
aymeric's avatar
aymeric committed
317

318

Simon Morlat's avatar
Simon Morlat committed
319
MS2_PUBLIC int audio_stream_start_with_files (AudioStream * stream, RtpProfile * prof,
aymeric's avatar
aymeric committed
320 321 322 323
					    const char *remip, int remport, int rem_rtcp_port,
					    int pt, int jitt_comp,
					    const char * infile,  const char * outfile);

324 325
/**
 * Starts an audio stream from/to local wav files or soundcards.
326
 *
327 328
 * This method starts the processing of the audio stream, that is playing from wav file or soundcard, voice processing, encoding,
 * sending through RTP, receiving from RTP, decoding, voice processing and wav file recording or soundcard playback.
329 330
 *
 *
331
 * @param stream an AudioStream previously created with audio_stream_new().
332
 * @param profile a RtpProfile containing all PayloadType possible during the audio session.
333 334 335
 * @param rem_rtp_ip remote IP address where to send the encoded audio.
 * @param rem_rtp_port remote IP port where to send the encoded audio.
 * @param rem_rtcp_ip remote IP address for RTCP.
336
 * @param rem_rtcp_port remote port for RTCP.
337
 * @param payload payload type index to use for the sending stream. This index must point to a valid PayloadType in the RtpProfile.
338 339 340 341 342
 * @param jitt_comp Nominal jitter buffer size in milliseconds.
 * @param infile path to wav file to play out (can be NULL)
 * @param outfile path to wav file to record into (can be NULL)
 * @param playcard The soundcard to be used for playback (can be NULL)
 * @param captcard The soundcard to be used for catpure. (can be NULL)
343
 * @param use_ec whether echo cancellation is to be performed.
344 345
 * @returns 0 if sucessful, -1 otherwise.
**/
346 347
MS2_PUBLIC int audio_stream_start_full(AudioStream *stream, RtpProfile *profile, const char *rem_rtp_ip,int rem_rtp_port,
	const char *rem_rtcp_ip, int rem_rtcp_port, int payload,int jitt_comp, const char *infile, const char *outfile,
348 349
	MSSndCard *playcard, MSSndCard *captcard, bool_t use_ec);

350

Simon Morlat's avatar
Simon Morlat committed
351 352
MS2_PUBLIC void audio_stream_play(AudioStream *st, const char *name);
MS2_PUBLIC void audio_stream_record(AudioStream *st, const char *name);
aymeric's avatar
aymeric committed
353

354
static inline void audio_stream_set_rtcp_information(AudioStream *st, const char *cname, const char *tool) {
355 356
	media_stream_set_rtcp_information(&st->ms, cname, tool);
}
aymeric's avatar
aymeric committed
357

Simon Morlat's avatar
Simon Morlat committed
358
MS2_PUBLIC void audio_stream_play_received_dtmfs(AudioStream *st, bool_t yesno);
smorlat's avatar
smorlat committed
359

360 361
/**
 * Creates an AudioStream object listening on a RTP port.
362 363
 * @param loc_rtp_port the local UDP port to listen for RTP packets.
 * @param loc_rtcp_port the local UDP port to listen for RTCP packets
364 365 366
 * @param ipv6 TRUE if ipv6 must be used.
 * @returns a new AudioStream.
**/
367
MS2_PUBLIC AudioStream *audio_stream_new(int loc_rtp_port, int loc_rtcp_port, bool_t ipv6);
368

369 370
/**Creates an AudioStream object from initialized MSMediaStreamSessions.
 * @param sessions the MSMediaStreamSessions
371 372 373 374
 * @returns a new AudioStream
**/
MS2_PUBLIC AudioStream *audio_stream_new_with_sessions(const MSMediaStreamSessions *sessions);

375 376 377 378 379 380 381 382
#define AUDIO_STREAM_FEATURE_PLC 		(1 << 0)
#define AUDIO_STREAM_FEATURE_EC 		(1 << 1)
#define AUDIO_STREAM_FEATURE_EQUALIZER		(1 << 2)
#define AUDIO_STREAM_FEATURE_VOL_SND 		(1 << 3)
#define AUDIO_STREAM_FEATURE_VOL_RCV 		(1 << 4)
#define AUDIO_STREAM_FEATURE_DTMF		(1 << 5)
#define AUDIO_STREAM_FEATURE_DTMF_ECHO		(1 << 6)
#define AUDIO_STREAM_FEATURE_MIXED_RECORDING	(1 << 7)
383
#define AUDIO_STREAM_FEATURE_LOCAL_PLAYING	(1 << 8)
384

Yann Diorcet's avatar
Yann Diorcet committed
385 386 387 388 389 390 391
#define AUDIO_STREAM_FEATURE_ALL	(\
					AUDIO_STREAM_FEATURE_PLC | \
					AUDIO_STREAM_FEATURE_EC | \
					AUDIO_STREAM_FEATURE_EQUALIZER | \
					AUDIO_STREAM_FEATURE_VOL_SND | \
					AUDIO_STREAM_FEATURE_VOL_RCV | \
					AUDIO_STREAM_FEATURE_DTMF | \
392
					AUDIO_STREAM_FEATURE_DTMF_ECHO |\
393 394
					AUDIO_STREAM_FEATURE_MIXED_RECORDING |\
					AUDIO_STREAM_FEATURE_LOCAL_PLAYING \
Yann Diorcet's avatar
Yann Diorcet committed
395 396
					)

397

Yann Diorcet's avatar
Yann Diorcet committed
398 399
MS2_PUBLIC uint32_t audio_stream_get_features(AudioStream *st);
MS2_PUBLIC void audio_stream_set_features(AudioStream *st, uint32_t features);
400

401 402 403
MS2_PUBLIC void audio_stream_prepare_sound(AudioStream *st, MSSndCard *playcard, MSSndCard *captcard);
MS2_PUBLIC void audio_stream_unprepare_sound(AudioStream *st);
MS2_PUBLIC bool_t audio_stream_started(AudioStream *stream);
404 405
/**
 * Starts an audio stream from local soundcards.
406
 *
407 408
 * This method starts the processing of the audio stream, that is capture from soundcard, voice processing, encoding,
 * sending through RTP, receiving from RTP, decoding, voice processing and soundcard playback.
409
 *
410 411 412 413 414 415 416 417 418 419 420
 * @param stream an AudioStream previously created with audio_stream_new().
 * @param prof a RtpProfile containing all PayloadType possible during the audio session.
 * @param remip remote IP address where to send the encoded audio.
 * @param remport remote IP port where to send the encoded audio
 * @param rem_rtcp_port remote port for RTCP.
 * @param payload_type payload type index to use for the sending stream. This index must point to a valid PayloadType in the RtpProfile.
 * @param jitt_comp Nominal jitter buffer size in milliseconds.
 * @param playcard The soundcard to be used for playback
 * @param captcard The soundcard to be used for catpure.
 * @param echo_cancel whether echo cancellation is to be performed.
**/
Simon Morlat's avatar
Simon Morlat committed
421 422
MS2_PUBLIC int audio_stream_start_now(AudioStream * stream, RtpProfile * prof,  const char *remip, int remport, int rem_rtcp_port, int payload_type, int jitt_comp,MSSndCard *playcard, MSSndCard *captcard, bool_t echo_cancel);
MS2_PUBLIC void audio_stream_set_relay_session_id(AudioStream *stream, const char *relay_session_id);
aymeric's avatar
aymeric committed
423
/*returns true if we are still receiving some data from remote end in the last timeout seconds*/
Simon Morlat's avatar
Simon Morlat committed
424
MS2_PUBLIC bool_t audio_stream_alive(AudioStream * stream, int timeout);
aymeric's avatar
aymeric committed
425

426 427 428 429
/**
 * Executes background low priority tasks related to audio processing (RTP statistics analysis).
 * It should be called periodically, for example with an interval of 100 ms or so.
 */
430 431
MS2_PUBLIC void audio_stream_iterate(AudioStream *stream);

jehan's avatar
jehan committed
432 433 434
/**
 * enable echo-limiter dispositve: one MSVolume in input branch controls a MSVolume in the output branch
 * */
Simon Morlat's avatar
Simon Morlat committed
435
MS2_PUBLIC void audio_stream_enable_echo_limiter(AudioStream *stream, EchoLimiterType type);
436

jehan's avatar
jehan committed
437 438 439
/**
 * enable gain control, to be done before start()
 * */
Simon Morlat's avatar
Simon Morlat committed
440
MS2_PUBLIC void audio_stream_enable_gain_control(AudioStream *stream, bool_t val);
smorlat's avatar
smorlat committed
441

jehan's avatar
jehan committed
442 443 444
/**
 * enable automatic gain control, to be done before start()
 * */
Simon Morlat's avatar
Simon Morlat committed
445
MS2_PUBLIC void audio_stream_enable_automatic_gain_control(AudioStream *stream, bool_t val);
446

jehan's avatar
jehan committed
447 448 449
/**
 * to be done before start
 *  */
Simon Morlat's avatar
Simon Morlat committed
450
MS2_PUBLIC void audio_stream_set_echo_canceller_params(AudioStream *st, int tail_len_ms, int delay_ms, int framesize);
451

jehan's avatar
jehan committed
452 453 454
/**
 * enable adaptive rate control
 * */
455
static inline void audio_stream_enable_adaptive_bitrate_control(AudioStream *stream, bool_t enabled) {
456 457
	media_stream_enable_adaptive_bitrate_control(&stream->ms, enabled);
}
458

jehan's avatar
jehan committed
459 460 461
/**
 *  Enable adaptive jitter compensation
 *  */
462
static inline void audio_stream_enable_adaptive_jittcomp(AudioStream *stream, bool_t enabled) {
463 464
	media_stream_enable_adaptive_jittcomp(&stream->ms, enabled);
}
465

Simon Morlat's avatar
Simon Morlat committed
466
MS2_PUBLIC void audio_stream_set_mic_gain(AudioStream *stream, float gain);
smorlat's avatar
smorlat committed
467

jehan's avatar
jehan committed
468 469 470
/**
 *  enable/disable rtp stream
 *  */
Simon Morlat's avatar
Simon Morlat committed
471
MS2_PUBLIC void audio_stream_mute_rtp(AudioStream *stream, bool_t val);
Simon Morlat's avatar
Simon Morlat committed
472

jehan's avatar
jehan committed
473 474 475
/**
 * enable noise gate, must be done before start()
 * */
Simon Morlat's avatar
Simon Morlat committed
476
MS2_PUBLIC void audio_stream_enable_noise_gate(AudioStream *stream, bool_t val);
477

jehan's avatar
jehan committed
478 479 480
/**
 * enable parametric equalizer in the stream that goes to the speaker
 * */
Simon Morlat's avatar
Simon Morlat committed
481
MS2_PUBLIC void audio_stream_enable_equalizer(AudioStream *stream, bool_t enabled);
smorlat's avatar
smorlat committed
482

Simon Morlat's avatar
Simon Morlat committed
483
MS2_PUBLIC void audio_stream_equalizer_set_gain(AudioStream *stream, int frequency, float gain, int freq_width);
smorlat's avatar
smorlat committed
484

jehan's avatar
jehan committed
485 486 487
/**
 *  stop the audio streaming thread and free everything
 *  */
Simon Morlat's avatar
Simon Morlat committed
488
MS2_PUBLIC void audio_stream_stop (AudioStream * stream);
aymeric's avatar
aymeric committed
489

jehan's avatar
jehan committed
490 491 492
/**
 *  send a dtmf
 *  */
Simon Morlat's avatar
Simon Morlat committed
493
MS2_PUBLIC int audio_stream_send_dtmf (AudioStream * stream, char dtmf);
aymeric's avatar
aymeric committed
494

495 496
MS2_PUBLIC MSFilter *audio_stream_get_local_player(AudioStream *stream);

497 498 499 500 501 502
MS2_PUBLIC int audio_stream_mixed_record_open(AudioStream *st, const char*filename);

MS2_PUBLIC int audio_stream_mixed_record_start(AudioStream *st);

MS2_PUBLIC int audio_stream_mixed_record_stop(AudioStream *st);

Simon Morlat's avatar
Simon Morlat committed
503
MS2_PUBLIC void audio_stream_set_default_card(int cardindex);
aymeric's avatar
aymeric committed
504

Simon Morlat's avatar
Simon Morlat committed
505
/* retrieve RTP statistics*/
506
static inline void audio_stream_get_local_rtp_stats(AudioStream *stream, rtp_stats_t *stats) {
507 508
	media_stream_get_local_rtp_stats(&stream->ms, stats);
}
Simon Morlat's avatar
Simon Morlat committed
509

510
/* returns a realtime indicator of the stream quality between 0 and 5 */
511 512
MS2_PUBLIC float audio_stream_get_quality_rating(AudioStream *stream);

513 514
/* returns the quality rating as an average since the start of the streaming session.*/
MS2_PUBLIC float audio_stream_get_average_quality_rating(AudioStream *stream);
aymeric's avatar
aymeric committed
515

516 517 518 519 520 521
/* returns a realtime indicator of the listening quality of the stream between 0 and 5 */
MS2_PUBLIC float audio_stream_get_lq_quality_rating(AudioStream *stream);

/* returns the listening quality rating as an average since the start of the streaming session.*/
MS2_PUBLIC float audio_stream_get_average_lq_quality_rating(AudioStream *stream);

522 523
/* enable ZRTP on the audio stream */
MS2_PUBLIC void audio_stream_enable_zrtp(AudioStream *stream, OrtpZrtpParams *params);
jehan's avatar
jehan committed
524 525 526 527
/**
 * return TRUE if zrtp is enabled, it does not mean that stream is encrypted, but only that zrtp is configured to know encryption status, uses #
 * */
bool_t  audio_stream_zrtp_enabled(const AudioStream *stream);
528

529
/* enable SRTP on the audio stream */
jehan's avatar
jehan committed
530
static inline bool_t audio_stream_enable_srtp(AudioStream* stream, MSCryptoSuite suite, const char* snd_key, const char* rcv_key) {
531 532
	return media_stream_enable_srtp(&stream->ms, suite, snd_key, rcv_key);
}
533

534
static inline int audio_stream_set_dscp(AudioStream *stream, int dscp) {
535 536
	return media_stream_set_dscp(&stream->ms, dscp);
}
Simon Morlat's avatar
Simon Morlat committed
537

Simon Morlat's avatar
Simon Morlat committed
538

539 540 541 542 543 544 545 546 547
/**
 * @}
**/


/**
 * @addtogroup video_stream_api
 * @{
**/
aymeric's avatar
aymeric committed
548

549
typedef void (*VideoStreamRenderCallback)(void *user_pointer, const MSPicture *local_view, const MSPicture *remote_view);
550 551 552
typedef void (*VideoStreamEventCallback)(void *user_pointer, const MSFilter *f, const unsigned int event_id, const void *args);


553 554 555 556 557 558
typedef enum _VideoStreamDir{
	VideoStreamSendRecv,
	VideoStreamSendOnly,
	VideoStreamRecvOnly
}VideoStreamDir;

aymeric's avatar
aymeric committed
559 560
struct _VideoStream
{
561
	MediaStream ms;
aymeric's avatar
aymeric committed
562 563
	MSFilter *source;
	MSFilter *pixconv;
564
	MSFilter *sizeconv;
aymeric's avatar
aymeric committed
565 566
	MSFilter *tee;
	MSFilter *output;
567 568
	MSFilter *tee2;
	MSFilter *jpegwriter;
569
	MSFilter *output2;
Simon Morlat's avatar
Simon Morlat committed
570 571
	MSFilter *tee3;
	MSFilter *itcsink;
572
	MSVideoSize sent_vsize;
smorlat's avatar
smorlat committed
573
	int corner; /*for selfview*/
574 575
	VideoStreamRenderCallback rendercb;
	void *render_pointer;
576 577
	VideoStreamEventCallback eventcb;
	void *event_pointer;
578
	char *display_name;
579 580
	unsigned long window_id;
	unsigned long preview_window_id;
581
	VideoStreamDir dir;
582
	MSWebCam *cam;
583
	int device_orientation; /* warning: meaning of this variable depends on the platform (Android, iOS, ...) */
Simon Morlat's avatar
Simon Morlat committed
584
	uint64_t last_reported_decoding_error_time;
585
	bool_t use_preview_window;
586
	bool_t freeze_on_error;
587
	bool_t display_filter_auto_rotate_enabled;
588 589
	bool_t source_performs_encoding;
	bool_t output_performs_decoding;
Simon Morlat's avatar
Simon Morlat committed
590
	
aymeric's avatar
aymeric committed
591 592 593
};

typedef struct _VideoStream VideoStream;
594

595

596
MS2_PUBLIC VideoStream *video_stream_new(int loc_rtp_port, int loc_rtcp_port, bool_t use_ipv6);
597
MS2_PUBLIC VideoStream *video_stream_new_with_sessions(const MSMediaStreamSessions *sessions);
Simon Morlat's avatar
Simon Morlat committed
598
MS2_PUBLIC void video_stream_set_direction(VideoStream *vs, VideoStreamDir dir);
599
static inline void video_stream_enable_adaptive_bitrate_control(VideoStream *stream, bool_t enabled) {
600 601
	media_stream_enable_adaptive_bitrate_control(&stream->ms, enabled);
}
602
static inline void video_stream_enable_adaptive_jittcomp(VideoStream *stream, bool_t enabled) {
603 604
	media_stream_enable_adaptive_jittcomp(&stream->ms, enabled);
}
Simon Morlat's avatar
Simon Morlat committed
605 606 607
MS2_PUBLIC void video_stream_set_render_callback(VideoStream *s, VideoStreamRenderCallback cb, void *user_pointer);
MS2_PUBLIC void video_stream_set_event_callback(VideoStream *s, VideoStreamEventCallback cb, void *user_pointer);
MS2_PUBLIC void video_stream_set_display_filter_name(VideoStream *s, const char *fname);
608
MS2_PUBLIC int video_stream_start(VideoStream * stream, RtpProfile *profile, const char *rem_rtp_ip, int rem_rtp_port, const char *rem_rtcp_ip, int rem_rtcp_port,
aymeric's avatar
aymeric committed
609
		int payload, int jitt_comp, MSWebCam *device);
610 611
MS2_PUBLIC void video_stream_prepare_video(VideoStream *stream);
MS2_PUBLIC void video_stream_unprepare_video(VideoStream *stream);
612 613


Simon Morlat's avatar
Simon Morlat committed
614
MS2_PUBLIC void video_stream_set_relay_session_id(VideoStream *stream, const char *relay_session_id);
615
static inline void video_stream_set_rtcp_information(VideoStream *st, const char *cname, const char *tool) {
616 617
	media_stream_set_rtcp_information(&st->ms, cname, tool);
}
Simon Morlat's avatar
Simon Morlat committed
618
MS2_PUBLIC void video_stream_change_camera(VideoStream *stream, MSWebCam *cam);
619 620
/* Calling video_stream_set_sent_video_size() or changing the bitrate value in the used PayloadType during a stream is running does nothing.
The following function allows to take into account new parameters by redrawing the sending graph*/
Simon Morlat's avatar
Simon Morlat committed
621
MS2_PUBLIC void video_stream_update_video_params(VideoStream *stream);
aymeric's avatar
aymeric committed
622
/*function to call periodically to handle various events */
Simon Morlat's avatar
Simon Morlat committed
623
MS2_PUBLIC void video_stream_iterate(VideoStream *stream);
624 625 626 627 628 629 630 631 632 633 634

/**
 * Ask the video stream to send a Full-Intra Request.
 * @param[in] stream The videostream object.
 */
MS2_PUBLIC void video_stream_send_fir(VideoStream *stream);

/**
 * Ask the video stream to generate a Video Fast Update (generally after receiving a Full-Intra Request.
 * @param[in] stream The videostream object.
 */
Simon Morlat's avatar
Simon Morlat committed
635
MS2_PUBLIC void video_stream_send_vfu(VideoStream *stream);
636

Simon Morlat's avatar
Simon Morlat committed
637 638
MS2_PUBLIC void video_stream_stop(VideoStream * stream);
MS2_PUBLIC void video_stream_set_sent_video_size(VideoStream *stream, MSVideoSize vsize);
639 640 641 642 643 644

/**
 * Gets the size of the video that is sent.
 * @param[in] stream The videostream for which to get the sent video size.
 * @return The sent video size or MS_VIDEO_SIZE_UNKNOWN if not available.
 */
645
MS2_PUBLIC MSVideoSize video_stream_get_sent_video_size(const VideoStream *stream);
646 647 648 649 650 651

/**
 * Gets the size of the video that is received.
 * @param[in] stream The videostream for which to get the received video size.
 * @return The received video size or MS_VIDEO_SIZE_UNKNOWN if not available.
 */
652
MS2_PUBLIC MSVideoSize video_stream_get_received_video_size(const VideoStream *stream);
653

654 655 656 657 658
/**
 * Returns the name of the video display filter on the current platform.
**/
const char *video_stream_get_default_video_renderer(void);

Simon Morlat's avatar
Simon Morlat committed
659 660 661 662 663 664
MS2_PUBLIC void video_stream_enable_self_view(VideoStream *stream, bool_t val);
MS2_PUBLIC unsigned long video_stream_get_native_window_id(VideoStream *stream);
MS2_PUBLIC void video_stream_set_native_window_id(VideoStream *stream, unsigned long id);
MS2_PUBLIC void video_stream_set_native_preview_window_id(VideoStream *stream, unsigned long id);
MS2_PUBLIC unsigned long video_stream_get_native_preview_window_id(VideoStream *stream);
MS2_PUBLIC void video_stream_use_preview_video_window(VideoStream *stream, bool_t yesno);
665
MS2_PUBLIC void video_stream_set_device_rotation(VideoStream *stream, int orientation);
666
MS2_PUBLIC void video_stream_show_video(VideoStream *stream, bool_t show);
667
MS2_PUBLIC void video_stream_set_freeze_on_error(VideoStream *stream, bool_t yesno);
668

669 670 671 672 673 674 675 676 677 678 679
/**
 * @brief Gets the camera sensor rotation.
 *
 * This is needed on some mobile platforms to get the number of degrees the camera sensor
 * is rotated relative to the screen.
 *
 * @param stream The video stream related to the operation
 * @return The camera sensor rotation in degrees (0 to 360) or -1 if it could not be retrieved
 */
MS2_PUBLIC int video_stream_get_camera_sensor_rotation(VideoStream *stream);

680
/*provided for compatibility, use video_stream_set_direction() instead */
Simon Morlat's avatar
Simon Morlat committed
681 682
MS2_PUBLIC int video_stream_recv_only_start(VideoStream *videostream, RtpProfile *profile, const char *addr, int port, int used_pt, int jitt_comp);
MS2_PUBLIC int video_stream_send_only_start(VideoStream *videostream,
683
				RtpProfile *profile, const char *addr, int port, int rtcp_port,
684
				int used_pt, int  jitt_comp, MSWebCam *device);
Simon Morlat's avatar
Simon Morlat committed
685 686
MS2_PUBLIC void video_stream_recv_only_stop(VideoStream *vs);
MS2_PUBLIC void video_stream_send_only_stop(VideoStream *vs);
aymeric's avatar
aymeric committed
687

688 689
/* enable ZRTP on the video stream using information from the audio stream */
MS2_PUBLIC void video_stream_enable_zrtp(VideoStream *vstream, AudioStream *astream, OrtpZrtpParams *param);
690

691
/* enable SRTP on the video stream */
jehan's avatar
jehan committed
692
static inline bool_t video_stream_enable_strp(VideoStream* stream, MSCryptoSuite suite, const char* snd_key, const char* rcv_key) {
693 694 695
	return media_stream_enable_srtp(&stream->ms, suite, snd_key, rcv_key);
}

696 697
/* if enabled, the display filter will internaly rotate the video, according to the device orientation */
MS2_PUBLIC void video_stream_enable_display_filter_auto_rotate(VideoStream* stream, bool_t enable);
698

699
/* retrieve RTP statistics*/
700
static inline void video_stream_get_local_rtp_stats(VideoStream *stream, rtp_stats_t *stats) {
701 702
	media_stream_get_local_rtp_stats(&stream->ms, stats);
}
703

704
static inline int video_stream_set_dscp(VideoStream *stream, int dscp) {
705 706
	return media_stream_set_dscp(&stream->ms, dscp);
}
Simon Morlat's avatar
Simon Morlat committed
707

708 709 710 711 712 713 714 715 716 717 718 719 720 721
/**
 * Ask the video stream whether a decoding error should be reported (eg. to send a VFU request).
 * @param[in] stream The VideoStream object.
 * @param[in] ms The minimum interval in milliseconds between to decoding error report.
 * @return TRUE if the decoding error should be reported, FALSE otherwise.
 */
MS2_PUBLIC bool_t video_stream_is_decoding_error_to_be_reported(VideoStream *stream, uint32_t ms);

/**
 * Tell the video stream that a decoding error has been reported.
 * @param[in] stream The VideoStream object.
 */
MS2_PUBLIC void video_stream_decoding_error_reported(VideoStream *stream);

Simon Morlat's avatar
Simon Morlat committed
722 723 724 725 726 727 728 729 730 731 732 733 734

/**
 * Link the audio stream with an existing video stream.
 * This is necessary to enable recording of audio & video into a multimedia file.
 */
MS2_PUBLIC void audio_stream_link_video(AudioStream *stream, VideoStream *video);

/**
 * Unlink the audio stream from the video stream.
 * This must be done if the video stream is about to be stopped.
**/
MS2_PUBLIC void audio_stream_unlink_video(AudioStream *stream, VideoStream *video);

735 736 737 738
/**
 * Small API to display a local preview window.
**/

Simon Morlat's avatar
Simon Morlat committed
739 740
typedef VideoStream VideoPreview;

Simon Morlat's avatar
Simon Morlat committed
741
MS2_PUBLIC VideoPreview * video_preview_new();
Simon Morlat's avatar
Simon Morlat committed
742 743 744 745
#define video_preview_set_size(p,s) 							video_stream_set_sent_video_size(p,s)
#define video_preview_set_display_filter_name(p,dt)	video_stream_set_display_filter_name(p,dt)
#define video_preview_set_native_window_id(p,id)		video_stream_set_native_preview_window_id (p,id)
#define video_preview_get_native_window_id(p)			video_stream_get_native_preview_window_id (p)
Simon Morlat's avatar
Simon Morlat committed
746 747
MS2_PUBLIC void video_preview_start(VideoPreview *stream, MSWebCam *device);
MS2_PUBLIC void video_preview_stop(VideoPreview *stream);
aymeric's avatar
aymeric committed
748

749 750 751 752
/**
 * @}
**/

Simon Morlat's avatar
Simon Morlat committed
753
MS2_PUBLIC bool_t ms_is_ipv6(const char *address);
aymeric's avatar
aymeric committed
754

755

aymeric's avatar
aymeric committed
756 757 758 759 760
#ifdef __cplusplus
}
#endif

#endif