From d6764679ed3735714acae44c5cf529a9d047dc8b Mon Sep 17 00:00:00 2001 From: Lars-Dominik Braun Date: Sun, 1 Mar 2009 15:03:08 +0100 Subject: Even more documentation ...and small cleanups. --- src/player.c | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'src/player.c') diff --git a/src/player.c b/src/player.c index 06f3ec3..92038d9 100644 --- a/src/player.c +++ b/src/player.c @@ -75,6 +75,12 @@ inline signed short int applyReplayGain (signed short int value, } } +/* Refill player's buffer with dataSize of data + * @param player structure + * @param new data + * @param data size + * @return 1 on success, 0 when buffer overflow occured + */ inline int BarPlayerBufferFill (struct audioPlayer *player, char *data, size_t dataSize) { /* fill buffer */ @@ -89,6 +95,11 @@ inline int BarPlayerBufferFill (struct audioPlayer *player, char *data, return 1; } +/* move data beginning from read pointer to buffer beginning and + * overwrite data already read from buffer + * @param player structure + * @return nothing at all + */ inline void BarPlayerBufferMove (struct audioPlayer *player) { /* move remaining bytes to buffer beginning */ memmove (player->buffer, player->buffer + player->bufferRead, -- cgit v1.2.3