buffer.h

/*******************************************************************************
 * Copyright (c) 2009-2014, MAV'RIC Development Team
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without 
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice, 
 * this list of conditions and the following disclaimer.
 * 
 * 2. Redistributions in binary form must reproduce the above copyright notice, 
 * this list of conditions and the following disclaimer in the documentation 
 * and/or other materials provided with the distribution.
 * 
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE 
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 * POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

/*******************************************************************************
 * \file buffer.h
 * 
 * \author MAV'RIC Team
 * \author Felix Schill
 *   
 * \brief Buffer
 *
 ******************************************************************************/


#ifndef BUFFER_H_
#define BUFFER_H_

#ifdef __cplusplus
extern "C" 
{
#endif

#include <stdint.h>
#include "streams.h"

#define BUFFER_SIZE 256
#define BUFFER_MASK (BUFFER_SIZE-1)


typedef struct 
{
    uint8_t Buffer[BUFFER_SIZE];        
    uint8_t buffer_head;                
    uint8_t buffer_tail;                
    uint8_t full;                       
} buffer_t;


void buffer_init(buffer_t * buffer);


uint8_t buffer_put_lossy(buffer_t * buffer, uint8_t byte);


uint8_t buffer_put(buffer_t * buffer, uint8_t byte);


uint8_t buffer_get(buffer_t * buffer);


void buffer_clear(buffer_t * buffer);


uint32_t buffer_bytes_available(buffer_t * buffer);


uint8_t buffer_full(buffer_t * buffer);


int8_t buffer_empty(buffer_t * buffer);


void buffer_make_buffered_stream(buffer_t *buffer, byte_stream_t *stream);


void buffer_make_buffered_stream_lossy(buffer_t *buffer, byte_stream_t *stream);


#ifdef __cplusplus
}
#endif

#endif /* BUFFER_H_ */