qualityindicator.h 3.28 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
/*
mediastreamer2 library - modular sound and video processing and streaming

 * Copyright (C) 2011  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.
*/

#ifndef ms2_qualityindicator_h
#define ms2_qualityindicator_h

#include "mediastreamer2/mscommon.h"
25
#include <ortp/ortp.h>
26 27 28 29 30 31 32

typedef struct _MSQualityIndicator MSQualityIndicator;

#ifdef __cplusplus
extern "C"{
#endif

33 34 35 36 37 38
/**
 * Creates a quality indicator object.
 * @param session the RtpSession being monitored.
**/ 
MS2_PUBLIC MSQualityIndicator *ms_quality_indicator_new(RtpSession *session);

39 40 41 42 43
/**
 * Set a label, just used for logging.
**/
MS2_PUBLIC void ms_quality_indicator_set_label(MSQualityIndicator *obj, const char *label);

44 45 46 47 48 49 50 51 52 53 54 55 56 57
/**
 * Updates quality indicator based on a received RTCP packet.
**/
MS2_PUBLIC void ms_quality_indicator_update_from_feedback(MSQualityIndicator *qi, mblk_t *rtcp);

/**
 * Updates quality indicator based on the local statistics directly computed by the RtpSession used when creating the indicator.
 * This function must be called typically every second.
**/
MS2_PUBLIC void ms_quality_indicator_update_local(MSQualityIndicator *qi);

/**
 * Return the real time rating of the session. Its value is between 0 (worse) and 5.0 (best).
**/
58
MS2_PUBLIC float ms_quality_indicator_get_rating(const MSQualityIndicator *qi);
59 60 61 62

/**
 * Returns the average rating of the session, that is the rating for all the duration of the session.
**/
63
MS2_PUBLIC float ms_quality_indicator_get_average_rating(const MSQualityIndicator *qi);
64

65 66 67
/**
 * Return the real time rating of the listening quality of the session. Its value is between 0.0 (worse) and 5.0 (best).
**/
68
MS2_PUBLIC float ms_quality_indicator_get_lq_rating(const MSQualityIndicator *qi);
69 70 71 72

/**
 * Returns the average rating of the listening quality of the session, that is the rating of the listening quality for all the duration of the session.
**/
73
MS2_PUBLIC float ms_quality_indicator_get_average_lq_rating(const MSQualityIndicator *qi);
74

75 76
/**
 * Returns the local loss rate, as computed internally by ms_quality_indicator_update_local().
77
 * The value is expressed as a percentage.
78 79 80 81 82
 * This method is for advanced usage.
**/
MS2_PUBLIC float ms_quality_indicator_get_local_loss_rate(const MSQualityIndicator *qi);

/**
83 84
 * Returns the local late rate, as computed internally by ms_quality_indicator_update_local().
 * The value is expressed as a percentage.
85 86 87 88 89 90 91 92
 * This method is for advanced usage.
**/
MS2_PUBLIC float ms_quality_indicator_get_local_late_rate(const MSQualityIndicator *qi);

/**
 * Destroys the quality indicator object.
**/
MS2_PUBLIC void ms_quality_indicator_destroy(MSQualityIndicator *qi);
93 94 95 96 97 98 99 100 101 102



#ifdef __cplusplus
}
#endif


#endif