quality_reporting.c 32.1 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
#define STR_REASSIGN(dest, src) {\
32 33 34 35
	if (dest != NULL) \
		ms_free(dest); \
	dest = src; \
}
36

37 38
/*since printf family functions are LOCALE dependent, float separator may differ
depending on the user's locale (LC_NUMERIC environment var).*/
39
static char * float_to_one_decimal_string(float f) {
40 41 42 43
	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);
44

45
	return ms_strdup_printf("%d.%d", floor_part, one_decimal_part);
46 47
}

48 49 50 51
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;

52
	#ifndef WIN32
53 54
		va_list cap;/*copy of our argument list: a va_list cannot be re-used (SIGSEGV on linux 64 bits)*/
		va_copy(cap,args);
55
		ret = belle_sip_snprintf_valist(*buff, *buff_size, offset, fmt, cap);
56
		va_end(cap);
57
	#else
58
		ret = belle_sip_snprintf_valist(*buff, *buff_size, offset, fmt, args);
59
	#endif
60

61
	/*if we are out of memory, we add some size to buffer*/
62
	if (ret == BELLE_SIP_BUFFER_OVERFLOW) {
63
		/*some compilers complain that size_t cannot be formatted as unsigned long, hence forcing cast*/
64
		ms_warning("QualityReporting: Buffer was too small to contain the whole report - increasing its size from %lu to %lu",
65
			(unsigned long)*buff_size, (unsigned long)*buff_size + 2048);
66 67 68 69
		*buff_size += 2048;
		*buff = (char *) ms_realloc(*buff, *buff_size);

		*offset = prevoffset;
70
		/*recall itself since we did not write all things into the buffer but
71
		only a part of it*/
72 73 74 75 76 77 78 79 80 81 82
		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);
}

83
static void reset_avg_metrics(reporting_session_report_t * report){
84
	int i;
85
	reporting_content_metrics_t * metrics[2] = {&report->local_metrics, &report->remote_metrics};
86 87

	for (i = 0; i < 2; i++) {
88
		metrics[i]->rtcp_sr_count = 0;
89 90 91 92
		metrics[i]->rtcp_xr_count = 0;
		metrics[i]->jitter_buffer.nominal = 0;
		metrics[i]->jitter_buffer.max = 0;

93 94 95
		metrics[i]->quality_estimates.moslq = 0;
		metrics[i]->quality_estimates.moscq = 0;

96 97
		metrics[i]->delay.round_trip_delay = 0;
	}
98
	report->last_report_date = ms_time(NULL);
99
}
100

101 102 103 104
#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
105

106 107 108 109 110 111
#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
112 113
#define METRICS_ADAPTIVE_ALGORITHM 1 << 6

114 115 116
static uint8_t are_metrics_filled(const reporting_content_metrics_t rm) {
	uint8_t ret = 0;

117 118
	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);
119

120 121 122 123
	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;
124 125 126 127 128 129 130 131 132 133 134

	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);
	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;

135 136 137
	IF_NUM_IN_RANGE(rm.quality_estimates.moslq, 1, 5, ret|=METRICS_QUALITY_ESTIMATES);
	IF_NUM_IN_RANGE(rm.quality_estimates.moscq, 1, 5, ret|=METRICS_QUALITY_ESTIMATES);

138 139 140 141
	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);
	}
142 143 144
	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);
	}
145 146

	return ret;
147
}
148

149 150 151 152 153 154 155 156 157 158 159
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;

160
	return (call->log->reporting.reports[stats_type] != NULL);
161 162
}

163
static void append_metrics_to_buffer(char ** buffer, size_t * size, size_t * offset, const reporting_content_metrics_t rm) {
164 165 166 167
	char * timestamps_start_str = NULL;
	char * timestamps_stop_str = NULL;
	char * network_packet_loss_rate_str = NULL;
	char * jitter_buffer_discard_rate_str = NULL;
168
	/*char * gap_loss_density_str = NULL;*/
169 170
	char * moslq_str = NULL;
	char * moscq_str = NULL;
171
	uint8_t available_metrics = are_metrics_filled(rm);
172

173
	if (rm.timestamps.start > 0)
174
		timestamps_start_str = linphone_timestamp_to_rfc3339_string(rm.timestamps.start);
175
	if (rm.timestamps.stop > 0)
176 177 178 179 180 181
		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);

182 183 184 185 186 187 188 189 190 191 192 193 194
	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);
195 196 197 198
			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);
			}
199 200 201
			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:");
202 203 204
			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));

205 206 207 208 209
			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:");*/
210
			/*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));*/
211 212 213 214 215 216 217 218
		/*	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:");
219 220
			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);
221
			}
222 223 224 225 226 227 228 229 230 231 232
			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);
	}

233
	/*if quality estimates metrics are available, rtcp_xr_count should be always not null*/
234
	if ((available_metrics & METRICS_QUALITY_ESTIMATES) != 0){
235 236
		IF_NUM_IN_RANGE(rm.quality_estimates.moslq, 1, 5, moslq_str = float_to_one_decimal_string(rm.quality_estimates.moslq));
		IF_NUM_IN_RANGE(rm.quality_estimates.moscq, 1, 5, moscq_str = float_to_one_decimal_string(rm.quality_estimates.moscq));
237

238 239 240 241 242
		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);
	}

243 244 245 246 247
	if (rm.user_agent!=NULL){
		append_to_buffer(buffer, size, offset, "\r\nLinphoneExt:");
			APPEND_IF_NOT_NULL_STR(buffer, size, offset, " UA=\"%s\"", rm.user_agent);
	}

248 249
	append_to_buffer(buffer, size, offset, "\r\n");

250 251 252 253
	ms_free(timestamps_start_str);
	ms_free(timestamps_stop_str);
	ms_free(network_packet_loss_rate_str);
	ms_free(jitter_buffer_discard_rate_str);
254
	/*ms_free(gap_loss_density_str);*/
255 256
	ms_free(moslq_str);
	ms_free(moscq_str);
257 258
}

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

268 269 270
	/*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);
271 272
		ret = 1;
		goto end;
273 274
	}

275 276
	/*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*/
277 278
	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) {
279
		ms_warning("QualityReporting[%p]: Trying to submit a %s too early (call duration: %d sec) but %s IP could "
280
			"not be retrieved so dropping this report"
281
			, call
282
			, report_event
283 284
			, linphone_call_get_duration(call)
			, (report->info.local_addr.ip == NULL || strlen(report->info.local_addr.ip) == 0) ? "local" : "remote");
285 286
		ret = 2;
		goto end;
287 288
	}

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

297
	buffer = (char *) ms_malloc(size);
298 299 300
	content.type = ms_strdup("application");
	content.subtype = ms_strdup("vq-rtcpxr");

301
	append_to_buffer(&buffer, &size, &offset, "%s\r\n", report_event);
302
	append_to_buffer(&buffer, &size, &offset, "CallID: %s\r\n", report->info.call_id);
303 304
	append_to_buffer(&buffer, &size, &offset, "LocalID: %s\r\n", report->info.local_addr.id);
	append_to_buffer(&buffer, &size, &offset, "RemoteID: %s\r\n", report->info.remote_addr.id);
305 306
	append_to_buffer(&buffer, &size, &offset, "OrigID: %s\r\n", report->info.orig_id);

307 308
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "LocalGroup: %s\r\n", report->info.local_addr.group);
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "RemoteGroup: %s\r\n", report->info.remote_addr.group);
309
	append_to_buffer(&buffer, &size, &offset, "LocalAddr: IP=%s PORT=%d SSRC=%u\r\n", report->info.local_addr.ip, report->info.local_addr.port, report->info.local_addr.ssrc);
310
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "LocalMAC: %s\r\n", report->info.local_addr.mac);
311
	append_to_buffer(&buffer, &size, &offset, "RemoteAddr: IP=%s PORT=%d SSRC=%u\r\n", report->info.remote_addr.ip, report->info.remote_addr.port, report->info.remote_addr.ssrc);
312
	APPEND_IF_NOT_NULL_STR(&buffer, &size, &offset, "RemoteMAC: %s\r\n", report->info.remote_addr.mac);
313

314 315
	append_to_buffer(&buffer, &size, &offset, "LocalMetrics:\r\n");
	append_metrics_to_buffer(&buffer, &size, &offset, report->local_metrics);
316

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

323 324
	if (report->qos_analyzer.timestamp!=NULL){
		append_to_buffer(&buffer, &size, &offset, "AdaptiveAlg:");
325 326 327 328 329 330
			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);
331 332 333
		append_to_buffer(&buffer, &size, &offset, "\r\n");
	}

334
	content.data = buffer;
335
	content.size = strlen(buffer);
336

337 338 339 340 341 342 343
	if (call->log->reporting.on_report_sent != NULL){
		call->log->reporting.on_report_sent(
			call,
			(report==call->log->reporting.reports[0])?LINPHONE_CALL_STATS_AUDIO:LINPHONE_CALL_STATS_VIDEO,
			&content);
	}

344
	if (! linphone_core_publish(call->core, addr, "vq-rtcpxr", expires, &content)){
345
		ret=4;
346 347
	} else {
		reset_avg_metrics(report);
348 349 350 351 352
		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);
353
	}
354

355
	linphone_address_destroy(addr);
356 357

	linphone_content_uninit(&content);
358 359

	end:
360
	ms_message("QualityReporting[%p]: Send '%s' with status %d",
361 362 363 364 365
		call,
		report_event,
		ret
	);

366
	return ret;
367 368
}

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

381
static void update_ip(LinphoneCall * call, int stats_type) {
382
	SalStreamType sal_stream_type = (stats_type == LINPHONE_CALL_STATS_AUDIO) ? SalAudio : SalVideo;
383 384
	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);
385

386 387 388 389
	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) {
390 391
			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));
392
		}
393
	}
394

395 396 397
	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;
398

399 400 401 402 403
		/*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));
404
		}
405
	}
406 407
}

408 409 410 411 412 413 414 415 416
typedef struct on_action_suggested_struct{
	LinphoneCall *call;
	int stats_type;
}on_action_suggested_struct_t;

static void qos_analyzer_on_action_suggested(void *user_data, int datac, const char** datav){
	on_action_suggested_struct_t * oass = (on_action_suggested_struct_t *)user_data;
	LinphoneCall *call = oass->call;
	reporting_session_report_t *report = call->log->reporting.reports[oass->stats_type];
417
	char * appendbuf;
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
	int i;
	int ptime = -1;
	int bitrate[2] = {-1, -1};
	int up_bw[2] = {-1, -1};
	int down_bw[2] = {-1, -1};
	MediaStream *streams[2] = {(MediaStream*) call->audiostream, (MediaStream *) call->videostream};
	for (i=0;i<2;i++){
		if (streams[i]!=NULL){
			if (streams[i]->encoder!=NULL){
				if (ms_filter_has_method(streams[i]->encoder,MS_FILTER_GET_BITRATE)){
					ms_filter_call_method(streams[i]->encoder,MS_FILTER_GET_BITRATE,&bitrate[i]);
					bitrate[i] /= 1000.f;
				}
			}
			up_bw[i] = media_stream_get_up_bw(streams[i])/1000.f;
			down_bw[i] = media_stream_get_down_bw(streams[i])/1000.f;
		}
	}
	if (call->audiostream!=NULL){
		if (call->audiostream->ms.encoder!=NULL){
			if(ms_filter_has_method(call->audiostream->ms.encoder,MS_AUDIO_ENCODER_GET_PTIME)){
				ms_filter_call_method(call->audiostream->ms.encoder,MS_AUDIO_ENCODER_GET_PTIME,&ptime);
			}
		}
	}
443

444 445
	appendbuf=ms_strdup_printf("%s%d;", report->qos_analyzer.timestamp?report->qos_analyzer.timestamp:"", ms_time(0));
	STR_REASSIGN(report->qos_analyzer.timestamp,appendbuf);
446

447 448 449
	STR_REASSIGN(report->qos_analyzer.input_leg, ms_strdup_printf("%s aenc_ptime aenc_br a_dbw a_ubw venc_br v_dbw v_ubw", datav[0]));
	appendbuf=ms_strdup_printf("%s%s %d %d %d %d %d %d %d;", report->qos_analyzer.input?report->qos_analyzer.input:"", datav[1],
		ptime, bitrate[0], down_bw[0], up_bw[0], bitrate[1], down_bw[1], up_bw[1] );
450
	STR_REASSIGN(report->qos_analyzer.input,appendbuf);
451 452
	STR_REASSIGN(report->qos_analyzer.output_leg, ms_strdup(datav[2]));
	appendbuf=ms_strdup_printf("%s%s;", report->qos_analyzer.output?report->qos_analyzer.output:"", datav[3]);
453
	STR_REASSIGN(report->qos_analyzer.output, appendbuf);
454 455
}

456
void linphone_reporting_update_ip(LinphoneCall * call) {
457
	update_ip(call, LINPHONE_CALL_STATS_AUDIO);
458
	update_ip(call, LINPHONE_CALL_STATS_VIDEO);
459
}
460

461
void linphone_reporting_update_media_info(LinphoneCall * call, int stats_type) {
462 463 464
	MediaStream * stream = NULL;
	const PayloadType * local_payload = NULL;
	const PayloadType * remote_payload = NULL;
465
	const LinphoneCallParams * current_params = linphone_call_get_current_params(call);
466
	reporting_session_report_t * report = call->log->reporting.reports[stats_type];
467
	char * dialog_id;
468

469
	if (!media_report_enabled(call, stats_type))
470 471
		return;

472
	dialog_id = sal_op_get_dialog_id(call->op);
473

474
	STR_REASSIGN(report->info.call_id, ms_strdup(call->log->call_id));
475 476 477 478 479 480 481

	STR_REASSIGN(report->local_metrics.user_agent, ms_strdup(linphone_core_get_user_agent(call->core)));
	STR_REASSIGN(report->remote_metrics.user_agent, ms_strdup(linphone_call_get_remote_user_agent(call)));

	// RFC states: "LocalGroupID provides the identification for the purposes
	// of aggregation for the local endpoint.".
	STR_REASSIGN(report->info.local_addr.group, ms_strdup_printf("%s-%s-%s"
482
		, dialog_id
483 484 485
		, "local"
		, report->local_metrics.user_agent
		)
486
	);
487
	STR_REASSIGN(report->info.remote_addr.group, ms_strdup_printf("%s-%s-%s"
488
		, dialog_id
489 490 491
		, "remote"
		, report->remote_metrics.user_agent
		)
492
	);
493

494

495
	if (call->dir == LinphoneCallIncoming) {
496 497 498
		STR_REASSIGN(report->info.remote_addr.id, linphone_address_as_string(call->log->from));
		STR_REASSIGN(report->info.local_addr.id, linphone_address_as_string(call->log->to));
		STR_REASSIGN(report->info.orig_id, ms_strdup(report->info.remote_addr.id));
499
	} else {
500 501 502
		STR_REASSIGN(report->info.remote_addr.id, linphone_address_as_string(call->log->to));
		STR_REASSIGN(report->info.local_addr.id, linphone_address_as_string(call->log->from));
		STR_REASSIGN(report->info.orig_id, ms_strdup(report->info.local_addr.id));
503
	}
504

505

506 507
	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);
508

509
	/*we use same timestamps for remote too*/
510 511
	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);
512

513

514
	/*yet we use the same payload config for local and remote, since this is the largest use case*/
515 516
	if (stats_type == LINPHONE_CALL_STATS_AUDIO && call->audiostream != NULL) {
		stream = &call->audiostream->ms;
517 518
		local_payload = linphone_call_params_get_used_audio_codec(current_params);
		remote_payload = local_payload;
519 520
	} else if (stats_type == LINPHONE_CALL_STATS_VIDEO && call->videostream != NULL) {
		stream = &call->videostream->ms;
521 522
		local_payload = linphone_call_params_get_used_video_codec(current_params);
		remote_payload = local_payload;
523
	}
524

525 526
	if (stream != NULL) {
		RtpSession * session = stream->sessions.rtp_session;
527

528 529
		report->info.local_addr.ssrc = rtp_session_get_send_ssrc(session);
		report->info.remote_addr.ssrc = rtp_session_get_recv_ssrc(session);
530 531

		if (stream->qi != NULL){
532 533 534 535
			report->local_metrics.quality_estimates.moslq = ms_quality_indicator_get_average_lq_rating(stream->qi) >= 0 ?
				MAX(1, ms_quality_indicator_get_average_lq_rating(stream->qi)) : -1;
			report->local_metrics.quality_estimates.moscq = ms_quality_indicator_get_average_rating(stream->qi) >= 0 ?
				MAX(1, ms_quality_indicator_get_average_rating(stream->qi)) : -1;
536
		}
537
	}
538

539 540
	STR_REASSIGN(report->dialog_id, ms_strdup_printf("%s;%u", dialog_id, report->info.local_addr.ssrc));

541 542
	if (local_payload != NULL) {
		report->local_metrics.session_description.payload_type = local_payload->type;
543
		if (local_payload->mime_type!=NULL) STR_REASSIGN(report->local_metrics.session_description.payload_desc, ms_strdup(local_payload->mime_type));
544
		report->local_metrics.session_description.sample_rate = local_payload->clock_rate;
545
		if (local_payload->recv_fmtp!=NULL) STR_REASSIGN(report->local_metrics.session_description.fmtp, ms_strdup(local_payload->recv_fmtp));
546
	}
547

548 549
	if (remote_payload != NULL) {
		report->remote_metrics.session_description.payload_type = remote_payload->type;
550
		STR_REASSIGN(report->remote_metrics.session_description.payload_desc, ms_strdup(remote_payload->mime_type));
551
		report->remote_metrics.session_description.sample_rate = remote_payload->clock_rate;
552
		STR_REASSIGN(report->remote_metrics.session_description.fmtp, ms_strdup(remote_payload->recv_fmtp));
553
	}
554 555

	ms_free(dialog_id);
556 557
}

558 559 560 561 562
/* 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);
}

563
void linphone_reporting_on_rtcp_update(LinphoneCall *call, int stats_type) {
564
	reporting_session_report_t * report = call->log->reporting.reports[stats_type];
565 566
	reporting_content_metrics_t * metrics = NULL;
	LinphoneCallStats stats = call->stats[stats_type];
567
	mblk_t *block = NULL;
568
	int report_interval;
569

570
	if (! media_report_enabled(call,stats_type))
571 572
		return;

573 574
	report_interval = linphone_proxy_config_get_quality_reporting_interval(call->dest_proxy);

575
	if (stats.updated == LINPHONE_CALL_STATS_RECEIVED_RTCP_UPDATE) {
576
		metrics = &report->remote_metrics;
577
		block = stats.received_rtcp;
578
	} else if (stats.updated == LINPHONE_CALL_STATS_SENT_RTCP_UPDATE) {
579
		metrics = &report->local_metrics;
580
		block = stats.sent_rtcp;
581
	}
582 583
	do{
		if (rtcp_is_XR(block) && (rtcp_XR_get_block_type(block) == RTCP_XR_VOIP_METRICS)){
584

585
			uint8_t config = rtcp_XR_voip_metrics_get_rx_config(block);
586

587
			metrics->rtcp_xr_count++;
588

589 590 591 592 593 594 595 596
			// for local mos rating, we'll use the quality indicator directly
			// because rtcp XR might not be enabled
			if (stats.updated == LINPHONE_CALL_STATS_RECEIVED_RTCP_UPDATE){
				metrics->quality_estimates.moslq = (rtcp_XR_voip_metrics_get_mos_lq(block)==127) ?
					127 : rtcp_XR_voip_metrics_get_mos_lq(block) / 10.f;
				metrics->quality_estimates.moscq = (rtcp_XR_voip_metrics_get_mos_cq(block)==127) ?
					127 : rtcp_XR_voip_metrics_get_mos_cq(block) / 10.f;
			}
597

598 599 600 601 602 603
			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);
604

605 606 607
			metrics->session_description.packet_loss_concealment = (config >> 6) & 0x3;

			metrics->delay.round_trip_delay += rtcp_XR_voip_metrics_get_round_trip_delay(block);
608 609 610 611 612 613 614 615
		}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;
			}
616
		}
617
	}while(rtcp_next_packet(block));
618

619 620 621
	/* 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)){
622 623
		linphone_reporting_update_media_info(call, stats_type);
		send_report(call, report, "VQIntervalReport");
624 625 626
	}
}

627 628
static int publish_report(LinphoneCall *call, const char *event_type){
	int ret = 0;
629 630 631
	int i;
	for (i = 0; i < 2; i++){
		if (media_report_enabled(call, i)){
632
			int sndret;
633
			linphone_reporting_update_media_info(call, i);
634 635 636 637 638 639
			sndret=send_report(call, call->log->reporting.reports[i], event_type);
			if (sndret>0){
				ret += 10+(i+1)*sndret;
			}
		} else{
			ret += i+1;
640
		}
641
	}
642
	return ret;
643
}
644 645 646 647

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);
648
}
649

650 651
int linphone_reporting_publish_interval_report(LinphoneCall* call) {
	return publish_report(call, "VQIntervalReport");
652 653
}

654 655 656
void linphone_reporting_call_state_updated(LinphoneCall *call){
	LinphoneCallState state=linphone_call_get_state(call);

657 658 659
	if (! quality_reporting_enabled(call)){
		return;
	}
660 661
	switch (state){
		case LinphoneCallStreamsRunning:{
662
			bool_t video_enabled=media_report_enabled(call, LINPHONE_CALL_STATS_VIDEO);
663 664 665 666
			int i;
			MediaStream *streams[2] = {(MediaStream*) call->audiostream, (MediaStream *) call->videostream};
			MSQosAnalyzer *analyzer;
			for (i=0;i<2;i++){
667

668 669 670 671 672 673 674 675
				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){
676 677 678
					on_action_suggested_struct_t * oass = ms_new0(on_action_suggested_struct_t, 1);
					oass->call = call;
					oass->stats_type = i;
679
					STR_REASSIGN(call->log->reporting.reports[i]->qos_analyzer.name, ms_strdup(ms_qos_analyzer_get_name(analyzer)));
680 681 682

					// /!\ only us use this callback so we can free user_data from here
					ms_free(analyzer->on_action_suggested_user_pointer);
683 684
					ms_qos_analyzer_set_on_action_suggested(analyzer,
						qos_analyzer_on_action_suggested,
685
						oass);
686 687 688
				}
			}
			linphone_reporting_update_ip(call);
689
			if (!video_enabled && call->log->reporting.was_video_running){
690
				send_report(call, call->log->reporting.reports[LINPHONE_CALL_STATS_VIDEO], "VQSessionReport");
691
			}
692
			call->log->reporting.was_video_running=video_enabled;
693 694 695 696
			break;
		}
		case LinphoneCallEnd:{
			if (call->log->status==LinphoneCallSuccess || call->log->status==LinphoneCallAborted){
697
				linphone_reporting_publish_session_report(call, TRUE);
698 699 700 701 702 703 704 705
			}
			break;
		}
		default:{
			break;
		}
	}
}
706

707 708 709 710
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};
711 712 713

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

714 715 716 717
	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;
718
		metrics[i]->session_description.packet_loss_concealment = -1;
719 720 721 722 723 724 725 726 727 728 729 730 731 732

		metrics[i]->packet_loss.network_packet_loss_rate = -1;
		metrics[i]->packet_loss.jitter_buffer_discard_rate = -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;
733
	}
734 735

	reset_avg_metrics(rm);
736
	return rm;
737
}
738 739

void linphone_reporting_destroy(reporting_session_report_t * report) {
740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762
	STR_REASSIGN(report->info.call_id, NULL);
	STR_REASSIGN(report->info.local_addr.id, NULL);
	STR_REASSIGN(report->info.remote_addr.id, NULL);
	STR_REASSIGN(report->info.orig_id, NULL);
	STR_REASSIGN(report->info.local_addr.ip, NULL);
	STR_REASSIGN(report->info.remote_addr.ip, NULL);
	STR_REASSIGN(report->info.local_addr.group, NULL);
	STR_REASSIGN(report->info.remote_addr.group, NULL);
	STR_REASSIGN(report->info.local_addr.mac, NULL);
	STR_REASSIGN(report->info.remote_addr.mac, NULL);
	STR_REASSIGN(report->dialog_id, NULL);
	STR_REASSIGN(report->local_metrics.session_description.fmtp, NULL);
	STR_REASSIGN(report->local_metrics.session_description.payload_desc, NULL);
	STR_REASSIGN(report->local_metrics.user_agent, NULL);
	STR_REASSIGN(report->remote_metrics.session_description.fmtp, NULL);
	STR_REASSIGN(report->remote_metrics.session_description.payload_desc, NULL);
	STR_REASSIGN(report->remote_metrics.user_agent, NULL);
	STR_REASSIGN(report->qos_analyzer.name, NULL);
	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