bitratecontrol.h 7.39 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_ratecontrol
#define ms2_ratecontrol

#include "mediastreamer2/msfilter.h"
25
#include <ortp/ortp.h>
26 27 28 29 30 31 32 33 34 35 36 37

#ifdef __cplusplus
extern "C" {
#endif


/**
 * Audio Bitrate controller object
**/

typedef struct _MSAudioBitrateController MSAudioBitrateController;

38
enum _MSRateControlActionType{
39 40 41
	MSRateControlActionDoNothing,
	MSRateControlActionDecreaseBitrate,
	MSRateControlActionDecreasePacketRate,
42
	MSRateControlActionIncreaseQuality,
43
};
44 45 46
typedef enum _MSRateControlActionType MSRateControlActionType;
const char *ms_rate_control_action_type_name(MSRateControlActionType t);

47 48 49 50 51
enum _MSQosAnalyzerNetworkState{
	MSQosAnalyzerNetworkFine,
	MSQosAnalyzerNetworkUnstable,
	MSQosAnalyzerNetworkCongested,
	MSQosAnalyzerNetworkLossy,
52
};
53 54
typedef enum _MSQosAnalyzerNetworkState MSQosAnalyzerNetworkState;
const char *ms_qos_analyzer_network_state_name(MSQosAnalyzerNetworkState state);
55

56
typedef struct _MSRateControlAction{
57
	MSRateControlActionType type;
58 59 60 61 62 63 64
	int value;
}MSRateControlAction;

typedef struct _MSBitrateDriver MSBitrateDriver;
typedef struct _MSBitrateDriverDesc MSBitrateDriverDesc;

struct _MSBitrateDriverDesc{
65
	int (*execute_action)(MSBitrateDriver *obj, const MSRateControlAction *action);
66 67 68 69
	void (*uninit)(MSBitrateDriver *obj);
};

/*
70
 * The MSBitrateDriver has the responsibility to execute rate control actions.
71 72 73 74
 * This is an abstract interface.
**/
struct _MSBitrateDriver{
	MSBitrateDriverDesc *desc;
75
	int refcnt;
76 77
};

78 79 80 81
int ms_bitrate_driver_execute_action(MSBitrateDriver *obj, const MSRateControlAction *action);
MSBitrateDriver * ms_bitrate_driver_ref(MSBitrateDriver *obj);
void ms_bitrate_driver_unref(MSBitrateDriver *obj);

82 83
MSBitrateDriver *ms_audio_bitrate_driver_new(RtpSession *session, MSFilter *encoder);
MSBitrateDriver *ms_av_bitrate_driver_new(RtpSession *asession, MSFilter *aenc, RtpSession *vsession, MSFilter *venc);
84
MSBitrateDriver *ms_bandwidth_bitrate_driver_new(RtpSession *asession, MSFilter *aenc, RtpSession *vsession, MSFilter *venc);
85

86 87
typedef struct _MSQosAnalyzer MSQosAnalyzer;
typedef struct _MSQosAnalyzerDesc MSQosAnalyzerDesc;
88

89 90 91 92 93 94
struct _MSQosAnalyzerDesc{
	bool_t (*process_rtcp)(MSQosAnalyzer *obj, mblk_t *rtcp);
	void (*suggest_action)(MSQosAnalyzer *obj, MSRateControlAction *action);
	bool_t (*has_improved)(MSQosAnalyzer *obj);
	void (*update)(MSQosAnalyzer *);
	void (*uninit)(MSQosAnalyzer *);
95 96 97
};

/**
98
 * A MSQosAnalyzer is responsible to analyze RTCP feedback and suggest actions on bitrate or packet rate accordingly.
99 100
 * This is an abstract interface.
**/
101 102
struct _MSQosAnalyzer{
	MSQosAnalyzerDesc *desc;
103
	char *label;
104
	void (*on_action_suggested)(void*, int, const char**);
105
	void *on_action_suggested_user_pointer;
106
	int refcnt;
107 108 109 110
	enum {
		Simple,
		Stateful,
	} type;
111 112
};

113 114
MSQosAnalyzer * ms_qos_analyzer_ref(MSQosAnalyzer *obj);
void ms_qos_analyzer_unref(MSQosAnalyzer *obj);
115
void ms_qos_analyser_set_label(MSQosAnalyzer *obj, const char *label);
116 117 118 119
void ms_qos_analyzer_suggest_action(MSQosAnalyzer *obj, MSRateControlAction *action);
bool_t ms_qos_analyzer_has_improved(MSQosAnalyzer *obj);
bool_t ms_qos_analyzer_process_rtcp(MSQosAnalyzer *obj, mblk_t *rtcp);
void ms_qos_analyzer_update(MSQosAnalyzer *obj);
120
void ms_qos_analyzer_set_on_action_suggested(MSQosAnalyzer *obj, void (*on_action_suggested)(void*,int,const char**),void* u);
121

122
/**
123
 * The simple qos analyzer is an implementation of MSQosAnalyzer that performs analysis for single stream.
124
**/
125
MSQosAnalyzer * ms_simple_qos_analyzer_new(RtpSession *session);
126

127
MSQosAnalyzer * ms_stateful_qos_analyzer_new(RtpSession *session);
128
/**
129
 * The audio/video qos analyzer is an implementation of MSQosAnalyzer that performs analysis of two audio and video streams.
130
**/
131
/*MSQosAnalyzer * ms_av_qos_analyzer_new(RtpSession *asession, RtpSession *vsession);*/
132

133 134
/**
 * The MSBitrateController the overall behavior and state machine of the adaptive rate control system.
135
 * It requires a MSQosAnalyzer to obtain analyse of the quality of service, and a MSBitrateDriver
136 137 138 139 140 141
 * to run the actions on media streams, like decreasing or increasing bitrate.
**/
typedef struct _MSBitrateController MSBitrateController;

/**
 * Instanciates MSBitrateController
142
 * @param qosanalyzer a Qos analyzer object
143
 * @param driver a bitrate driver object.
144
 * The newly created bitrate controller owns references to the analyzer and the driver.
145
**/
146
MSBitrateController *ms_bitrate_controller_new(MSQosAnalyzer *qosanalyzer, MSBitrateDriver *driver);
147

148 149 150 151 152 153 154 155 156
/**
 * Asks the bitrate controller to process a newly received RTCP packet.
 * @param MSBitrateController the bitrate controller object.
 * @param rtcp an RTCP packet received for the media session(s) being managed by the controller.
 * If the RTCP packet contains useful feedback regarding quality of the media streams received by the far end,
 * then the bitrate controller may take decision and execute actions on the local media streams to adapt the
 * output bitrate.
**/
void ms_bitrate_controller_process_rtcp(MSBitrateController *obj, mblk_t *rtcp);
157

158 159
void ms_bitrate_controller_update(MSBitrateController *obj);

160
/**
161
 * Return the QoS analyzer associated to the bitrate controller
162
**/
163
MSQosAnalyzer * ms_bitrate_controller_get_qos_analyzer(MSBitrateController *obj);
164

165 166
/**
 * Destroys the bitrate controller
167
 *
168
 * If no other entity holds references to the underlyings MSQosAnalyzer and MSBitrateDriver object,
169 170 171
 * then they will be destroyed too.
**/
void ms_bitrate_controller_destroy(MSBitrateController *obj);
172

173 174 175 176 177 178 179 180
/**
 * Convenience function to create a bitrate controller managing a single audio stream.
 * @param session the RtpSession object for the media stream
 * @param encoder the MSFilter object responsible for encoding the audio data.
 * @param flags unused.
 * This function actually calls internally:
 * <br>
 * \code
181
 * ms_bitrate_controller_new(ms_simple_qos_analyzer_new(session),ms_audio_bitrate_driver_new(encoder));
182 183 184
 * \endcode
**/
MSBitrateController *ms_audio_bitrate_controller_new(RtpSession *session, MSFilter *encoder, unsigned int flags);
185

186 187 188 189 190 191 192 193 194
/**
 * Convenience fonction to create a bitrate controller managing a video and an audio stream.
 * @param vsession the video RtpSession
 * @param venc the video encoder
 * @param asession the audio RtpSession
 * @param aenc the audio encoder
 * This function actually calls internally:
 * <br>
 * \code
195
 * ms_bitrate_controller_new(ms_av_qos_analyzer_new(asession,vsession),ms_av_bitrate_driver_new(aenc,venc));
196 197 198
 * \endcode
**/
MSBitrateController *ms_av_bitrate_controller_new(RtpSession *asession, MSFilter *aenc, RtpSession *vsession, MSFilter *venc);
199

200
MSBitrateController *ms_bandwidth_bitrate_controller_new(RtpSession *asession, MSFilter *aenc, RtpSession *vsession, MSFilter *venc);
201 202 203 204 205 206 207
#ifdef __cplusplus
}
#endif

#endif