toxcore/toxav/bwcontroller.h

/* SPDX-License-Identifier: GPL-3.0-or-later
 * Copyright © 2016-2018 The TokTok team.
 * Copyright © 2013-2015 Tox project.
 */
#ifndef C_TOXCORE_TOXAV_BWCONTROLLER_H
#define C_TOXCORE_TOXAV_BWCONTROLLER_H

#include "../toxcore/Messenger.h"
#include "../toxcore/tox.h"

typedef struct BWController BWController;

typedef void m_cb(BWController *bwc, uint32_t friend_number, float loss, void *user_data);

BWController *bwc_new(Messenger *m, Tox *tox, uint32_t friendnumber, m_cb *mcb, void *mcb_user_data,
                      Mono_Time *bwc_mono_time);

void bwc_kill(BWController *bwc);

void bwc_add_lost(BWController *bwc, uint32_t bytes_lost);
void bwc_add_recv(BWController *bwc, uint32_t recv_bytes);

#endif /* C_TOXCORE_TOXAV_BWCONTROLLER_H */
Use spdx license identifier instead of GPL blurb. 2020-03-12 09:10:33 +08:00			`/* SPDX-License-Identifier: GPL-3.0-or-later`
Update copyright to 2018. 2018-08-26 07:36:42 +08:00			`* Copyright © 2016-2018 The TokTok team.`
Update license headers and remove redundant file name comment. "All rights reserved" was incorrect. The project was licensed under GPL3, which means a lot of rights are licensed to everybody in the world, i.e. not reserved to the "Tox Project". 2017-01-14 23:46:31 +08:00			`* Copyright © 2013-2015 Tox project.`
New Adaptive BR algorithm, cleanups and fixes 2015-10-11 05:54:23 +08:00			`*/`
Standardise header guards. Using the full path including the repo name. 2018-09-10 03:54:05 +08:00			`#ifndef C_TOXCORE_TOXAV_BWCONTROLLER_H`
			`#define C_TOXCORE_TOXAV_BWCONTROLLER_H`
Group #include directives in 3-4 groups. 1. Current module (if C file). 2. Headers from current library. 3. Headers from other library (e.g. toxcore includes in toxav). 4. System headers. 2016-09-11 22:47:51 +08:00
New Adaptive BR algorithm, cleanups and fixes 2015-10-11 05:54:23 +08:00			`#include "../toxcore/Messenger.h"`
Use public API for sending in BWC. 2020-04-08 04:34:50 +08:00			`#include "../toxcore/tox.h"`

Make struct typedefs have the same name as their struct 2022-01-05 00:36:28 +08:00			`typedef struct BWController BWController;`
New Adaptive BR algorithm, cleanups and fixes 2015-10-11 05:54:23 +08:00
cleanup: Ensure handler params are named after callback params. 2024-01-18 06:35:00 +08:00			`typedef void m_cb(BWController bwc, uint32_t friend_number, float loss, void user_data);`
Fix style in bwcontroller module. * Comments in macros must be `//` style. * No inner structs. * Named callback types. * `++i` instead of `i++`. * No assignments as expressions. 2018-08-13 00:09:06 +08:00
Use public API for sending in BWC. 2020-04-08 04:34:50 +08:00			`BWController bwc_new(Messenger m, Tox tox, uint32_t friendnumber, m_cb mcb, void *mcb_user_data,`
Stop using Messenger's mono_time in bandwidth controller. We're actually still using it, but we got a private pointer now, preparing us for having a private mono_time in toxav. 2020-04-05 18:35:02 +08:00			`Mono_Time *bwc_mono_time);`
Improve video key frame sending. This change does not include the addition of VP9. We do that in a separate pull request. Changes: * fix the video bug (video frames larger than 65KBytes) by sending full frame length in alternate header field * improve video frame reconstruction logic with slots * configure video encoder and decoder to be multihtreaded * set error resilience flags on video codec * change encoder and decoder softdeadline 2018-01-20 05:59:42 +08:00
fix BWController misspelling 2015-11-11 17:33:03 +08:00			`void bwc_kill(BWController *bwc);`
New Adaptive BR algorithm, cleanups and fixes 2015-10-11 05:54:23 +08:00
Synchronise parameter names in headers with those in the implementation. 2018-07-20 05:54:30 +08:00			`void bwc_add_lost(BWController *bwc, uint32_t bytes_lost);`
			`void bwc_add_recv(BWController *bwc, uint32_t recv_bytes);`
New Adaptive BR algorithm, cleanups and fixes 2015-10-11 05:54:23 +08:00
cleanup: Add comment after every `#endif`. This makes far-away endifs clearer, so we're applying the rule to all endifs to be consistent. 2024-01-23 21:11:05 +08:00			`#endif /* C_TOXCORE_TOXAV_BWCONTROLLER_H */`