quality_reporting.c 30.3 KB
Newer Older
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
/*
linphone
Copyright (C) 2014 - Belledonne Communications, Grenoble, France

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.
*/

#ifdef HAVE_CONFIG_H
#include "../config.h"
#endif

#include "linphonecore.h"
#include "private.h"
#include "sal/sal.h"
27 28
#include "ortp/rtpsession.h"

29 30
#include <math.h>

31 32
/***************************************************************************
 *  				TODO / REMINDER LIST
33
 ***************************************************************************
34
	- move qos data at report's end? <-- unit test recup publish body
35
 ***************************************************************************
36 37 38
 *  				END OF TODO / REMINDER LIST
 ****************************************************************************/

39
#define STR_REASSIGN(dest, src) {\
40 41 42 43
	if (dest != NULL) \
		ms_free(dest); \
	dest = src; \
}
44

45 46
/*since printf family functions are LOCALE dependent, float separator may differ
depending on the user's locale (LC_NUMERIC environment var).*/
47
static char * float_to_one_decimal_string(float f) {
48 49 50 51
	float rounded_f = floorf(f * 10 + .5f) / 10;

	int floor_part = (int) rounded_f;
	int one_decimal_part = floorf (10 * (rounded_f - floor_part) + .5f);
52

53
	return ms_strdup_printf("%d.%d", floor_part, one_decimal_part);
54 55
}

56 57 58 59
static void append_to_buffer_valist(char **buff, size_t *buff_size, size_t *offset, const char *fmt, va_list args) {
	belle_sip_error_code ret;
	size_t prevoffset = *offset;

60
	#ifndef WIN32
61 62
		va_list cap;/*copy of our argument list: a va_list cannot be re-used (SIGSEGV on linux 64 bits)*/
		va_copy(cap,args);
63
		ret = belle_sip_snprintf_valist(*buff, *buff_size, offset, fmt, cap);
64
		va_end(cap);
65
	#else
66
		ret = belle_sip_snprintf_valist(*buff, *buff_size, offset, fmt, args);
67
	#endif
68

69
	/*if we are out of memory, we add some size to buffer*/
70
	if (ret == BELLE_SIP_BUFFER_OVERFLOW) {
71
		/*some compilers complain that size_t cannot be formatted as unsigned long, hence forcing cast*/
72
		ms_warning("QualityReporting: Buffer was too small to contain the whole report - increasing its size from %lu to %lu",
73
			(unsigned long)*buff_size, (unsigned long)*buff_size + 2048);
74 75 76 77
		*buff_size += 2048;
		*buff = (char *) ms_realloc(*buff, *buff_size);

		*offset = prevoffset;
78
		/*recall itself since we did not write all things into the buffer but
79
		only a part of it*/
80 81 82 83 84 85 86 87 88 89 90
		append_to_buffer_valist(buff, buff_size, offset, fmt, args);
	}
}

static void append_to_buffer(char **buff, size_t *buff_size, size_t *offset, const char *fmt, ...) {
	va_list args;
	va_start(args, fmt);
	append_to_buffer_valist(buff, buff_size, offset, fmt, args);
	va_end(args);
}

91
static void reset_avg_metrics(reporting_session_report_t * report){
92
	int i;
93
	reporting_content_metrics_t * metrics[2] = {&report->local_metrics, &report->remote_metrics};
94 95

	for (i = 0; i < 2; i++) {
96
		metrics[i]->rtcp_sr_count = 0;
97 98 99 100 101 102
		metrics[i]->rtcp_xr_count = 0;
		metrics[i]->jitter_buffer.nominal = 0;
		metrics[i]->jitter_buffer.max = 0;

		metrics[i]->delay.round_trip_delay = 0;
	}
103
	report->last_report_date = ms_time(NULL);
104
}
105

106 107 108 109
#define APPEND_IF_NOT_NULL_STR(buffer, size, offset, fmt, arg) if (arg != NULL) append_to_buffer(buffer, size, offset, fmt, arg)
#define APPEND_IF_NUM_IN_RANGE(buffer, size, offset, fmt, arg, inf, sup) if (inf <= arg && arg <= sup) append_to_buffer(buffer, size, offset, fmt, arg)
#define APPEND_IF(buffer, size, offset, fmt, arg, cond) if (cond) append_to_buffer(buffer, size, offset, fmt, arg)
#define IF_NUM_IN_RANGE(num, inf, sup, statement) if (inf <= num && num <= sup) statement
110

111 112 113 114 115 116
#define METRICS_PACKET_LOSS 1 << 0
#define METRICS_QUALITY_ESTIMATES 1 << 1
#define METRICS_SESSION_DESCRIPTION 1 << 2
#define METRICS_JITTER_BUFFER 1 << 3
#define METRICS_DELAY 1 << 4
#define METRICS_SIGNAL 1 << 5
117 118
#define METRICS_ADAPTIVE_ALGORITHM 1 << 6

119 120 121
static uint8_t are_metrics_filled(const reporting_content_metrics_t rm) {
	uint8_t ret = 0;

122 123
	IF_NUM_IN_RANGE(rm.packet_loss.network_packet_loss_rate, 0, 255, ret|=METRICS_PACKET_LOSS);
	IF_NUM_IN_RANGE(rm.packet_loss.jitter_buffer_discard_rate, 0, 255, ret|=METRICS_PACKET_LOSS);
124

125
	/*since these are same values than local ones, do not check them*/
126 127 128 129 130 131 132 133 134 135 136
	/*if (rm.session_description.payload_type != -1) ret|=METRICS_SESSION_DESCRIPTION;*/
	/*if (rm.session_description.payload_desc != NULL) ret|=METRICS_SESSION_DESCRIPTION;*/
	/*if (rm.session_description.sample_rate != -1) ret|=METRICS_SESSION_DESCRIPTION;*/
	/*if (rm.session_description.fmtp != NULL) ret|=METRICS_SESSION_DESCRIPTION;*/
	if (rm.session_description.frame_duration != -1) ret|=METRICS_SESSION_DESCRIPTION;
	if (rm.session_description.packet_loss_concealment != -1) ret|=METRICS_SESSION_DESCRIPTION;

	IF_NUM_IN_RANGE(rm.jitter_buffer.adaptive, 0, 3, ret|=METRICS_JITTER_BUFFER);
	IF_NUM_IN_RANGE(rm.jitter_buffer.abs_max, 0, 65535, ret|=METRICS_JITTER_BUFFER);

	IF_NUM_IN_RANGE(rm.delay.end_system_delay, 0, 65535, ret|=METRICS_DELAY);
137
	/*IF_NUM_IN_RANGE(rm.delay.symm_one_way_delay, 0, 65535, ret|=METRICS_DELAY);*/
138 139 140 141 142 143 144 145 146 147 148 149
	IF_NUM_IN_RANGE(rm.delay.interarrival_jitter, 0, 65535, ret|=METRICS_DELAY);
	IF_NUM_IN_RANGE(rm.delay.mean_abs_jitter, 0, 65535, ret|=METRICS_DELAY);

	if (rm.signal.level != 127) ret|=METRICS_SIGNAL;
	if (rm.signal.noise_level != 127) ret|=METRICS_SIGNAL;

	if (rm.rtcp_xr_count>0){
		IF_NUM_IN_RANGE(rm.jitter_buffer.nominal/rm.rtcp_xr_count, 0, 65535, ret|=METRICS_JITTER_BUFFER);
		IF_NUM_IN_RANGE(rm.jitter_buffer.max/rm.rtcp_xr_count, 0, 65535, ret|=METRICS_JITTER_BUFFER);
		IF_NUM_IN_RANGE(rm.quality_estimates.moslq/rm.rtcp_xr_count, 1, 5, ret|=METRICS_QUALITY_ESTIMATES);
		IF_NUM_IN_RANGE(rm.quality_estimates.moscq/rm.rtcp_xr_count, 1, 5, ret|=METRICS_QUALITY_ESTIMATES);
	}
150 151 152
	if (rm.rtcp_sr_count+rm.rtcp_xr_count>0){
		IF_NUM_IN_RANGE(rm.delay.round_trip_delay/(rm.rtcp_sr_count+rm.rtcp_xr_count), 0, 65535, ret|=METRICS_DELAY);
	}
153 154

	return ret;
155
}
156

157 158 159 160 161 162 163 164 165 166 167
static bool_t quality_reporting_enabled(const LinphoneCall * call) {
	return (call->dest_proxy != NULL && linphone_proxy_config_quality_reporting_enabled(call->dest_proxy));
}

static bool_t media_report_enabled(LinphoneCall * call, int stats_type){
	if (! quality_reporting_enabled(call))
		return FALSE;

	if (stats_type == LINPHONE_CALL_STATS_VIDEO && !linphone_call_params_video_enabled(linphone_call_get_current_params(call)))
		return FALSE;

168
	return (call->log->reporting.reports[stats_type] != NULL);
169 170
}

171
static void append_metrics_to_buffer(char ** buffer, size_t * size, size_t * offset, const reporting_content_metrics_t rm) {
172 173 174 175
	char * timestamps_start_str = NULL;
	char * timestamps_stop_str = NULL;
	char * network_packet_loss_rate_str = NULL;
	char * jitter_buffer_discard_rate_str = NULL;
176
	/*char * gap_loss_density_str = NULL;*/
177 178
	char * moslq_str = NULL;
	char * moscq_str = NULL;
179
	uint8_t available_metrics = are_metrics_filled(rm);
180

181
	if (rm.timestamps.start > 0)
182
		timestamps_start_str = linphone_timestamp_to_rfc3339_string(rm.timestamps.start);
183
	if (rm.timestamps.stop > 0)
184 185 186 187 188 189
		timestamps_stop_str = linphone_timestamp_to_rfc3339_string(rm.timestamps.stop);

	append_to_buffer(buffer, size, offset, "Timestamps:");
		APPEND_IF_NOT_NULL_STR(buffer, size, offset, " START=%s", timestamps_start_str);
		APPEND_IF_NOT_NULL_STR(buffer, size, offset, " STOP=%s", timestamps_stop_str);

190 191 192 193 194 195 196 197 198 199 200 201 202
	if ((available_metrics & METRICS_SESSION_DESCRIPTION) != 0){
		append_to_buffer(buffer, size, offset, "\r\nSessionDesc:");
			APPEND_IF(buffer, size, offset, " PT=%d", rm.session_description.payload_type, rm.session_description.payload_type != -1);
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " PD=%s", rm.session_description.payload_desc);
			APPEND_IF(buffer, size, offset, " SR=%d", rm.session_description.sample_rate, rm.session_description.sample_rate != -1);
			APPEND_IF(buffer, size, offset, " FD=%d", rm.session_description.frame_duration, rm.session_description.frame_duration != -1);
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " FMTP=\"%s\"", rm.session_description.fmtp);
			APPEND_IF(buffer, size, offset, " PLC=%d", rm.session_description.packet_loss_concealment, rm.session_description.packet_loss_concealment != -1);
	}

	if ((available_metrics & METRICS_JITTER_BUFFER) != 0){
		append_to_buffer(buffer, size, offset, "\r\nJitterBuffer:");
			APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " JBA=%d", rm.jitter_buffer.adaptive, 0, 3);
203 204 205 206
			if (rm.rtcp_xr_count){
				APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " JBN=%d", rm.jitter_buffer.nominal/rm.rtcp_xr_count, 0, 65535);
				APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " JBM=%d", rm.jitter_buffer.max/rm.rtcp_xr_count, 0, 65535);
			}
207 208 209
			APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " JBX=%d",  rm.jitter_buffer.abs_max, 0, 65535);

		append_to_buffer(buffer, size, offset, "\r\nPacketLoss:");
210 211 212
			IF_NUM_IN_RANGE(rm.packet_loss.network_packet_loss_rate, 0, 255, network_packet_loss_rate_str = float_to_one_decimal_string(rm.packet_loss.network_packet_loss_rate / 256));
			IF_NUM_IN_RANGE(rm.packet_loss.jitter_buffer_discard_rate, 0, 255, jitter_buffer_discard_rate_str = float_to_one_decimal_string(rm.packet_loss.jitter_buffer_discard_rate / 256));

213 214 215 216 217
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " NLR=%s", network_packet_loss_rate_str);
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " JDR=%s", jitter_buffer_discard_rate_str);
	}

		/*append_to_buffer(buffer, size, offset, "\r\nBurstGapLoss:");*/
218
			/*IF_NUM_IN_RANGE(rm.burst_gap_loss.gap_loss_density, 0, 10, gap_loss_density_str = float_to_one_decimal_string(rm.burst_gap_loss.gap_loss_density));*/
219 220 221 222 223 224 225 226
		/*	append_to_buffer(buffer, size, offset, " BLD=%d", rm.burst_gap_loss.burst_loss_density);*/
		/*	append_to_buffer(buffer, size, offset, " BD=%d", rm.burst_gap_loss.burst_duration);*/
		/*	APPEND_IF_NOT_NULL_STR(buffer, size, offset, " GLD=%s", gap_loss_density_str);*/
		/*	append_to_buffer(buffer, size, offset, " GD=%d", rm.burst_gap_loss.gap_duration);*/
		/*	append_to_buffer(buffer, size, offset, " GMIN=%d", rm.burst_gap_loss.min_gap_threshold);*/

	if ((available_metrics & METRICS_DELAY) != 0){
		append_to_buffer(buffer, size, offset, "\r\nDelay:");
227 228
			if (rm.rtcp_xr_count+rm.rtcp_sr_count){
				APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " RTD=%d", rm.delay.round_trip_delay/(rm.rtcp_xr_count+rm.rtcp_sr_count), 0, 65535);
229
			}
230 231 232 233 234 235 236 237 238 239 240
			APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " ESD=%d", rm.delay.end_system_delay, 0, 65535);
			APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " IAJ=%d", rm.delay.interarrival_jitter, 0, 65535);
			APPEND_IF_NUM_IN_RANGE(buffer, size, offset, " MAJ=%d", rm.delay.mean_abs_jitter, 0, 65535);
	}

	if ((available_metrics & METRICS_SIGNAL) != 0){
		append_to_buffer(buffer, size, offset, "\r\nSignal:");
			APPEND_IF(buffer, size, offset, " SL=%d", rm.signal.level, rm.signal.level != 127);
			APPEND_IF(buffer, size, offset, " NL=%d", rm.signal.noise_level, rm.signal.noise_level != 127);
	}

241
	/*if quality estimates metrics are available, rtcp_xr_count should be always not null*/
242
	if ((available_metrics & METRICS_QUALITY_ESTIMATES) != 0){
243 244
		IF_NUM_IN_RANGE(rm.quality_estimates.moslq/rm.rtcp_xr_count, 1, 5, moslq_str = float_to_one_decimal_string(rm.quality_estimates.moslq/rm.rtcp_xr_count));
		IF_NUM_IN_RANGE(rm.quality_estimates.moscq/rm.rtcp_xr_count, 1, 5, moscq_str = float_to_one_decimal_string(rm.quality_estimates.moscq/rm.rtcp_xr_count));
245

246 247 248 249 250
		append_to_buffer(buffer, size, offset, "\r\nQualityEst:");
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " MOSLQ=%s", moslq_str);
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " MOSCQ=%s", moscq_str);
	}

251 252
	append_to_buffer(buffer, size, offset, "\r\n");

253 254 255 256
	ms_free(timestamps_start_str);
	ms_free(timestamps_stop_str);
	ms_free(network_packet_loss_rate_str);
	ms_free(jitter_buffer_discard_rate_str);
257
	/*ms_free(gap_loss_density_str);*/
258 259
	ms_free(moslq_str);
	ms_free(moscq_str);
260 261
}

262
static int send_report(LinphoneCall* call, reporting_session_report_t * report, const char * report_event) {
263
	LinphoneContent content = {0};
264
	LinphoneAddress *addr;
265
	int expires = -1;
266 267 268
	size_t offset = 0;
	size_t size = 2048;
	char * buffer;
269
	int ret = 0;
270

271 272 273
	/*if we are on a low bandwidth network, do not send reports to not overload it*/
	if (linphone_call_params_low_bandwidth_enabled(linphone_call_get_current_params(call))){
		ms_warning("QualityReporting[%p]: Avoid sending reports on low bandwidth network", call);
274 275
		ret = 1;
		goto end;
276 277
	}

278 279
	/*if the call was hung up too early, we might have invalid IPs information
	in that case, we abort the report since it's not useful data*/
280 281
	if (report->info.local_addr.ip == NULL || strlen(report->info.local_addr.ip) == 0
		|| report->info.remote_addr.ip == NULL || strlen(report->info.remote_addr.ip) == 0) {
282
		ms_warning("QualityReporting[%p]: Trying to submit a %s too early (call duration: %d sec) but %s IP could "
283
			"not be retrieved so dropping this report"
284
			, call
285
			, report_event
286 287
			, linphone_call_get_duration(call)
			, (report->info.local_addr.ip == NULL || strlen(report->info.local_addr.ip) == 0) ? "local" : "remote");
288 289
		ret = 2;
		goto end;
290 291
	}

292
	addr = linphone_address_new(linphone_proxy_config_get_quality_reporting_collector(call->dest_proxy));
293
	if (addr == NULL) {
294
		ms_warning("QualityReporting[%p]: Asked to submit reporting statistics but no collector address found"
295
			, call);
296 297
		ret = 3;
		goto end;
298 299
	}

300
	buffer = (char *) ms_malloc(size);
301 302 303
	content.type = ms_strdup("application");
	content.subtype = ms_strdup("vq-rtcpxr");

304
	append_to_buffer(&buffer, &size, &offset, "%s\r\n", report_event);
305 306 307 308 309 310 311 312 313 314 315
	append_to_buffer(&buffer, &size, &offset, "CallID: %s\r\n", report->info.call_id);
	append_to_buffer(&buffer, &size, &offset, "LocalID: %s\r\n", report->info.local_id);
	append_to_buffer(&buffer, &size, &offset, "RemoteID: %s\r\n", report->info.remote_id);
	append_to_buffer(&buffer, &size, &offset, "OrigID: %s\r\n", report->info.orig_id);

	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "LocalGroup: %s\r\n", report->info.local_group);
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "RemoteGroup: %s\r\n", report->info.remote_group);
	append_to_buffer(&buffer, &size, &offset, "LocalAddr: IP=%s PORT=%d SSRC=%d\r\n", report->info.local_addr.ip, report->info.local_addr.port, report->info.local_addr.ssrc);
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "LocalMAC: %s\r\n", report->info.local_mac_addr);
	append_to_buffer(&buffer, &size, &offset, "RemoteAddr: IP=%s PORT=%d SSRC=%d\r\n", report->info.remote_addr.ip, report->info.remote_addr.port, report->info.remote_addr.ssrc);
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "RemoteMAC: %s\r\n", report->info.remote_mac_addr);
316

317 318
	append_to_buffer(&buffer, &size, &offset, "LocalMetrics:\r\n");
	append_metrics_to_buffer(&buffer, &size, &offset, report->local_metrics);
319

320
	if (are_metrics_filled(report->remote_metrics)!=0) {
321 322 323
		append_to_buffer(&buffer, &size, &offset, "RemoteMetrics:\r\n");
		append_metrics_to_buffer(&buffer, &size, &offset, report->remote_metrics);
	}
324 325
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "DialogID: %s\r\n", report->dialog_id);

326 327 328 329 330 331 332 333 334 335 336
	if (report->qos_analyzer.timestamp!=NULL){
		append_to_buffer(&buffer, &size, &offset, "AdaptiveAlg:");
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " NAME=%s", report->qos_analyzer.name);
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " TS=%s", report->qos_analyzer.timestamp);
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " IN_LEG=%s", report->qos_analyzer.input_leg);
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " IN=%s", report->qos_analyzer.input);
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " OUT_LEG=%s", report->qos_analyzer.output_leg);
			APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, " OUT=%s", report->qos_analyzer.output);
		append_to_buffer(&buffer, &size, &offset, "\r\n");
	}

337
	content.data = buffer;
338
	content.size = strlen(buffer);
339

340
	if (! linphone_core_publish(call->core, addr, "vq-rtcpxr", expires, &content)){
341
		ret=4;
342 343
	} else {
		reset_avg_metrics(report);
344 345 346 347 348
		STR_REASSIGN(report->qos_analyzer.timestamp, NULL);
		STR_REASSIGN(report->qos_analyzer.input_leg, NULL);
		STR_REASSIGN(report->qos_analyzer.input, NULL);
		STR_REASSIGN(report->qos_analyzer.output_leg, NULL);
		STR_REASSIGN(report->qos_analyzer.output, NULL);
349
	}
350

351
	linphone_address_destroy(addr);
352 353

	linphone_content_uninit(&content);
354 355 356 357 358 359 360 361 362

	end:
	ms_message("QualityReporting[%p]: Send '%s' for '%s' stream with status %d",
		call,
		report_event,
		report->info.local_group,
		ret
	);

363
	return ret;
364 365
}

366 367 368
static const SalStreamDescription * get_media_stream_for_desc(const SalMediaDescription * smd, SalStreamType sal_stream_type) {
	int count;
	if (smd != NULL) {
369
		for (count = 0; count < smd->nb_streams; ++count) {
370 371
			if (smd->streams[count].type == sal_stream_type) {
				return &smd->streams[count];
372 373
			}
		}
374
	}
375 376
	return NULL;
}
377

378
static void update_ip(LinphoneCall * call, int stats_type) {
379
	SalStreamType sal_stream_type = (stats_type == LINPHONE_CALL_STATS_AUDIO) ? SalAudio : SalVideo;
380 381
	const SalStreamDescription * local_desc = get_media_stream_for_desc(call->localdesc, sal_stream_type);
	const SalStreamDescription * remote_desc = get_media_stream_for_desc(sal_call_get_remote_media_description(call->op), sal_stream_type);
382

383 384 385 386
	if (local_desc != NULL) {
		/*since this function might be called for video stream AFTER it has been uninitialized, local description might
		be invalid. In any other case, IP/port should be always filled and valid*/
		if (local_desc->rtp_addr != NULL && strlen(local_desc->rtp_addr) > 0) {
387 388
			call->log->reporting.reports[stats_type]->info.local_addr.port = local_desc->rtp_port;
			STR_REASSIGN(call->log->reporting.reports[stats_type]->info.local_addr.ip, ms_strdup(local_desc->rtp_addr));
389
		}
390
	}
391

392 393 394
	if (remote_desc != NULL) {
		/*port is always stored in stream description struct*/
		call->log->reporting.reports[stats_type]->info.remote_addr.port = remote_desc->rtp_port;
395

396 397 398 399 400
		/*for IP it can be not set if we are using a direct route*/
		if (remote_desc->rtp_addr != NULL && strlen(remote_desc->rtp_addr) > 0) {
			STR_REASSIGN(call->log->reporting.reports[stats_type]->info.remote_addr.ip, ms_strdup(remote_desc->rtp_addr));
		} else {
			STR_REASSIGN(call->log->reporting.reports[stats_type]->info.remote_addr.ip, ms_strdup(sal_call_get_remote_media_description(call->op)->addr));
401
		}
402
	}
403 404
}

405
static void qos_analyzer_on_action_suggested(void *user_data, int datac, const char** data){
406
	reporting_session_report_t *report = (reporting_session_report_t*) user_data;
407
	char * appendbuf;
408

409 410
	appendbuf=ms_strdup_printf("%s%d;", report->qos_analyzer.timestamp?report->qos_analyzer.timestamp:"", ms_time(0));
	STR_REASSIGN(report->qos_analyzer.timestamp,appendbuf);
411

412 413 414
	STR_REASSIGN(report->qos_analyzer.input_leg, ms_strdup(data[0]));
	appendbuf=ms_strdup_printf("%s%s;", report->qos_analyzer.input?report->qos_analyzer.input:"", data[1]);
	STR_REASSIGN(report->qos_analyzer.input,appendbuf);
415

416 417 418
	STR_REASSIGN(report->qos_analyzer.output_leg, ms_strdup(data[2]));
	appendbuf=ms_strdup_printf("%s%s;", report->qos_analyzer.output?report->qos_analyzer.output:"", data[3]);
	STR_REASSIGN(report->qos_analyzer.output, appendbuf);
419 420
}

421
void linphone_reporting_update_ip(LinphoneCall * call) {
422
	update_ip(call, LINPHONE_CALL_STATS_AUDIO);
423
	update_ip(call, LINPHONE_CALL_STATS_VIDEO);
424
}
425

426
void linphone_reporting_update_media_info(LinphoneCall * call, int stats_type) {
427 428 429
	MediaStream * stream = NULL;
	const PayloadType * local_payload = NULL;
	const PayloadType * remote_payload = NULL;
430
	const LinphoneCallParams * current_params = linphone_call_get_current_params(call);
431
	reporting_session_report_t * report = call->log->reporting.reports[stats_type];
432

433
	if (!media_report_enabled(call, stats_type))
434 435
		return;

436

437
	STR_REASSIGN(report->info.call_id, ms_strdup(call->log->call_id));
438 439 440 441 442 443 444 445 446 447
	STR_REASSIGN(report->info.local_group, ms_strdup_printf("linphone-%s-%s-%s",
		(stats_type == LINPHONE_CALL_STATS_AUDIO ? "audio" : "video"),
		linphone_core_get_user_agent_name(),
		report->info.call_id)
	);
	STR_REASSIGN(report->info.remote_group, ms_strdup_printf("linphone-%s-%s-%s",
		(stats_type == LINPHONE_CALL_STATS_AUDIO ? "audio" : "video"),
		linphone_call_get_remote_user_agent(call),
		report->info.call_id)
	);
448

449
	if (call->dir == LinphoneCallIncoming) {
450 451 452
		STR_REASSIGN(report->info.remote_id, linphone_address_as_string(call->log->from));
		STR_REASSIGN(report->info.local_id, linphone_address_as_string(call->log->to));
		STR_REASSIGN(report->info.orig_id, ms_strdup(report->info.remote_id));
453
	} else {
454 455 456
		STR_REASSIGN(report->info.remote_id, linphone_address_as_string(call->log->to));
		STR_REASSIGN(report->info.local_id, linphone_address_as_string(call->log->from));
		STR_REASSIGN(report->info.orig_id, ms_strdup(report->info.local_id));
457
	}
458

459
	STR_REASSIGN(report->dialog_id, sal_op_get_dialog_id(call->op));
460

461 462
	report->local_metrics.timestamps.start = call->log->start_date_time;
	report->local_metrics.timestamps.stop = call->log->start_date_time + linphone_call_get_duration(call);
463

464
	/*we use same timestamps for remote too*/
465 466
	report->remote_metrics.timestamps.start = call->log->start_date_time;
	report->remote_metrics.timestamps.stop = call->log->start_date_time + linphone_call_get_duration(call);
467

468
	/*yet we use the same payload config for local and remote, since this is the largest use case*/
469 470
	if (stats_type == LINPHONE_CALL_STATS_AUDIO && call->audiostream != NULL) {
		stream = &call->audiostream->ms;
471 472
		local_payload = linphone_call_params_get_used_audio_codec(current_params);
		remote_payload = local_payload;
473 474
	} else if (stats_type == LINPHONE_CALL_STATS_VIDEO && call->videostream != NULL) {
		stream = &call->videostream->ms;
475 476
		local_payload = linphone_call_params_get_used_video_codec(current_params);
		remote_payload = local_payload;
477
	}
478

479 480
	if (stream != NULL) {
		RtpSession * session = stream->sessions.rtp_session;
481

482 483 484
		report->info.local_addr.ssrc = rtp_session_get_send_ssrc(session);
		report->info.remote_addr.ssrc = rtp_session_get_recv_ssrc(session);
	}
485

486 487
	if (local_payload != NULL) {
		report->local_metrics.session_description.payload_type = local_payload->type;
488
		STR_REASSIGN(report->local_metrics.session_description.payload_desc, ms_strdup(local_payload->mime_type));
489
		report->local_metrics.session_description.sample_rate = local_payload->clock_rate;
490
		STR_REASSIGN(report->local_metrics.session_description.fmtp, ms_strdup(local_payload->recv_fmtp));
491
	}
492

493 494
	if (remote_payload != NULL) {
		report->remote_metrics.session_description.payload_type = remote_payload->type;
495
		STR_REASSIGN(report->remote_metrics.session_description.payload_desc, ms_strdup(remote_payload->mime_type));
496
		report->remote_metrics.session_description.sample_rate = remote_payload->clock_rate;
497
		STR_REASSIGN(report->remote_metrics.session_description.fmtp, ms_strdup(remote_payload->recv_fmtp));
498
	}
499 500
}

501 502 503 504 505
/* generate random float in interval ] 0.9 t ; 1.1 t [*/
static float reporting_rand(float t){
	return t * (.2f * (rand() / (RAND_MAX * 1.0f)) + 0.9f);
}

506
void linphone_reporting_on_rtcp_update(LinphoneCall *call, int stats_type) {
507
	reporting_session_report_t * report = call->log->reporting.reports[stats_type];
508 509
	reporting_content_metrics_t * metrics = NULL;
	LinphoneCallStats stats = call->stats[stats_type];
510
	mblk_t *block = NULL;
511
	int report_interval;
512

513
	if (! media_report_enabled(call,stats_type))
514 515
		return;

516 517
	report_interval = linphone_proxy_config_get_quality_reporting_interval(call->dest_proxy);

518
	if (stats.updated == LINPHONE_CALL_STATS_RECEIVED_RTCP_UPDATE) {
519
		metrics = &report->remote_metrics;
520
		block = stats.received_rtcp;
521
	} else if (stats.updated == LINPHONE_CALL_STATS_SENT_RTCP_UPDATE) {
522
		metrics = &report->local_metrics;
523
		block = stats.sent_rtcp;
524
	}
525

526 527
	do{
		if (rtcp_is_XR(block) && (rtcp_XR_get_block_type(block) == RTCP_XR_VOIP_METRICS)){
528

529
			uint8_t config = rtcp_XR_voip_metrics_get_rx_config(block);
530

531
			metrics->rtcp_xr_count++;
532

533 534
			metrics->quality_estimates.moslq += rtcp_XR_voip_metrics_get_mos_lq(block) / 10.f;
			metrics->quality_estimates.moscq += rtcp_XR_voip_metrics_get_mos_cq(block) / 10.f;
535

536 537 538 539 540 541
			metrics->jitter_buffer.nominal += rtcp_XR_voip_metrics_get_jb_nominal(block);
			metrics->jitter_buffer.max += rtcp_XR_voip_metrics_get_jb_maximum(block);
			metrics->jitter_buffer.abs_max = rtcp_XR_voip_metrics_get_jb_abs_max(block);
			metrics->jitter_buffer.adaptive = (config >> 4) & 0x3;
			metrics->packet_loss.network_packet_loss_rate = rtcp_XR_voip_metrics_get_loss_rate(block);
			metrics->packet_loss.jitter_buffer_discard_rate = rtcp_XR_voip_metrics_get_discard_rate(block);
542

543 544 545
			metrics->session_description.packet_loss_concealment = (config >> 6) & 0x3;

			metrics->delay.round_trip_delay += rtcp_XR_voip_metrics_get_round_trip_delay(block);
546 547 548 549 550 551 552 553
		}else if (rtcp_is_SR(block)){
			MediaStream *ms=(stats_type==0 ? &call->audiostream->ms : &call->videostream->ms);
			float rtt = rtp_session_get_round_trip_propagation(ms->sessions.rtp_session);

			if (rtt > 1e-6){
				metrics->rtcp_sr_count++;
				metrics->delay.round_trip_delay += 1000*rtt;
			}
554
		}
555
	}while(rtcp_next_packet(block));
556

557 558 559
	/* check if we should send an interval report - use a random sending time to
	dispatch reports and avoid sending them too close from each other */
	if (report_interval>0 && ms_time(NULL)-report->last_report_date>reporting_rand(report_interval)){
560 561
		linphone_reporting_update_media_info(call, stats_type);
		send_report(call, report, "VQIntervalReport");
562 563 564
	}
}

565 566
static int publish_report(LinphoneCall *call, const char *event_type){
	int ret = 0;
567 568 569
	int i;
	for (i = 0; i < 2; i++){
		if (media_report_enabled(call, i)){
570
			int sndret;
571
			linphone_reporting_update_media_info(call, i);
572 573 574 575 576 577
			sndret=send_report(call, call->log->reporting.reports[i], event_type);
			if (sndret>0){
				ret += 10+(i+1)*sndret;
			}
		} else{
			ret += i+1;
578
		}
579
	}
580
	return ret;
581
}
582 583 584 585

int linphone_reporting_publish_session_report(LinphoneCall* call, bool_t call_term) {
	char * session_type = call_term?"VQSessionReport: CallTerm":"VQSessionReport";
	return publish_report(call, session_type);
586
}
587

588 589
int linphone_reporting_publish_interval_report(LinphoneCall* call) {
	return publish_report(call, "VQIntervalReport");
590 591
}

592 593 594
void linphone_reporting_call_state_updated(LinphoneCall *call){
	LinphoneCallState state=linphone_call_get_state(call);

595 596 597
	if (! quality_reporting_enabled(call)){
		return;
	}
598 599
	switch (state){
		case LinphoneCallStreamsRunning:{
600
			bool_t video_enabled=media_report_enabled(call, LINPHONE_CALL_STATS_VIDEO);
601 602 603 604 605 606 607 608 609 610 611 612
			int i;
			MediaStream *streams[2] = {(MediaStream*) call->audiostream, (MediaStream *) call->videostream};
			MSQosAnalyzer *analyzer;
			for (i=0;i<2;i++){
				if (streams[i]==NULL||streams[i]->rc==NULL){
					ms_message("QualityReporting[%p] Cannot set on_action_suggested"
					" callback for %s stream because something is null", call, i?"video":"audio");
					continue;
				}

				analyzer=ms_bitrate_controller_get_qos_analyzer(streams[i]->rc);
				if (analyzer){
613
					STR_REASSIGN(call->log->reporting.reports[i]->qos_analyzer.name, ms_strdup(ms_qos_analyzer_get_name(analyzer)));
614 615
					ms_qos_analyzer_set_on_action_suggested(analyzer,
						qos_analyzer_on_action_suggested,
616
						call->log->reporting.reports[i]);
617 618 619
				}
			}
			linphone_reporting_update_ip(call);
620
			if (!video_enabled && call->log->reporting.was_video_running){
621
				send_report(call, call->log->reporting.reports[LINPHONE_CALL_STATS_VIDEO], "VQSessionReport");
622
			}
623
			call->log->reporting.was_video_running=video_enabled;
624 625 626 627
			break;
		}
		case LinphoneCallEnd:{
			if (call->log->status==LinphoneCallSuccess || call->log->status==LinphoneCallAborted){
628
				linphone_reporting_publish_session_report(call, TRUE);
629 630 631 632 633 634 635 636
			}
			break;
		}
		default:{
			break;
		}
	}
}
637

638 639 640 641
reporting_session_report_t * linphone_reporting_new() {
	int i;
	reporting_session_report_t * rm = ms_new0(reporting_session_report_t,1);
	reporting_content_metrics_t * metrics[2] = {&rm->local_metrics, &rm->remote_metrics};
642 643 644

	memset(rm, 0, sizeof(reporting_session_report_t));

645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663
	for (i = 0; i < 2; i++) {
		metrics[i]->session_description.payload_type = -1;
		metrics[i]->session_description.sample_rate = -1;
		metrics[i]->session_description.frame_duration = -1;

		metrics[i]->packet_loss.network_packet_loss_rate = -1;
		metrics[i]->packet_loss.jitter_buffer_discard_rate = -1;

		metrics[i]->session_description.packet_loss_concealment = -1;

		metrics[i]->jitter_buffer.adaptive = -1;
		metrics[i]->jitter_buffer.abs_max = -1;

		metrics[i]->delay.end_system_delay = -1;
		metrics[i]->delay.interarrival_jitter = -1;
		metrics[i]->delay.mean_abs_jitter = -1;

		metrics[i]->signal.level = 127;
		metrics[i]->signal.noise_level = 127;
664
	}
665 666

	reset_avg_metrics(rm);
667
	return rm;
668
}
669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685

void linphone_reporting_destroy(reporting_session_report_t * report) {
	if (report->info.call_id != NULL) ms_free(report->info.call_id);
	if (report->info.local_id != NULL) ms_free(report->info.local_id);
	if (report->info.remote_id != NULL) ms_free(report->info.remote_id);
	if (report->info.orig_id != NULL) ms_free(report->info.orig_id);
	if (report->info.local_addr.ip != NULL) ms_free(report->info.local_addr.ip);
	if (report->info.remote_addr.ip != NULL) ms_free(report->info.remote_addr.ip);
	if (report->info.local_group != NULL) ms_free(report->info.local_group);
	if (report->info.remote_group != NULL) ms_free(report->info.remote_group);
	if (report->info.local_mac_addr != NULL) ms_free(report->info.local_mac_addr);
	if (report->info.remote_mac_addr != NULL) ms_free(report->info.remote_mac_addr);
	if (report->dialog_id != NULL) ms_free(report->dialog_id);
	if (report->local_metrics.session_description.fmtp != NULL) ms_free(report->local_metrics.session_description.fmtp);
	if (report->local_metrics.session_description.payload_desc != NULL) ms_free(report->local_metrics.session_description.payload_desc);
	if (report->remote_metrics.session_description.fmtp != NULL) ms_free(report->remote_metrics.session_description.fmtp);
	if (report->remote_metrics.session_description.payload_desc != NULL) ms_free(report->remote_metrics.session_description.payload_desc);
686 687 688 689 690 691
	if (report->qos_analyzer.name != NULL) ms_free(report->qos_analyzer.name);
	if (report->qos_analyzer.timestamp != NULL) ms_free(report->qos_analyzer.timestamp);
	if (report->qos_analyzer.input_leg != NULL) ms_free(report->qos_analyzer.input_leg);
	if (report->qos_analyzer.input != NULL) ms_free(report->qos_analyzer.input);
	if (report->qos_analyzer.output_leg != NULL) ms_free(report->qos_analyzer.output_leg);
	if (report->qos_analyzer.output != NULL) ms_free(report->qos_analyzer.output);
692 693 694

	ms_free(report);
}
695

696