deps/libretro-common/include/queues/fifo_queue.h

   1 /* Copyright  (C) 2010-2020 The RetroArch team
   2  *
   3  * ---------------------------------------------------------------------------------------
   4  * The following license statement only applies to this file (fifo_queue.h).
   5  * ---------------------------------------------------------------------------------------
   6  *
   7  * Permission is hereby granted, free of charge,
   8  * to any person obtaining a copy of this software and associated documentation files (the "Software"),
   9  * to deal in the Software without restriction, including without limitation the rights to
  10  * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  11  * and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
  16  * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  19  * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  21  */
  22
  23 #ifndef __LIBRETRO_SDK_FIFO_BUFFER_H
  24 #define __LIBRETRO_SDK_FIFO_BUFFER_H
  25
  26 #include <stdint.h>
  27 #include <stddef.h>
  28 #include <stdlib.h>
  29
  30 #include <retro_common_api.h>
  31 #include <retro_inline.h>
  32 #include <boolean.h>
  33
  34 RETRO_BEGIN_DECLS
  35
  36 #define FIFO_READ_AVAIL(buffer) (((buffer)->end + (((buffer)->end < (buffer)->first) ? (buffer)->size : 0)) - (buffer)->first)
  37
  38 #define FIFO_WRITE_AVAIL(buffer) (((buffer)->size - 1) - (((buffer)->end + (((buffer)->end < (buffer)->first) ? (buffer)->size : 0)) - (buffer)->first))
  39
  40 #define FIFO_READ_AVAIL_NONPTR(buffer) (((buffer).end + (((buffer).end < (buffer).first) ? (buffer).size : 0)) - (buffer).first)
  41
  42 #define FIFO_WRITE_AVAIL_NONPTR(buffer) (((buffer).size - 1) - (((buffer).end + (((buffer).end < (buffer).first) ? (buffer).size : 0)) - (buffer).first))
  43
  44 struct fifo_buffer
  45 {
  46    uint8_t *buffer;
  47    size_t size;
  48    size_t first;
  49    size_t end;
  50 };
  51
  52 typedef struct fifo_buffer fifo_buffer_t;
  53
  54 fifo_buffer_t *fifo_new(size_t size);
  55
  56 bool fifo_initialize(fifo_buffer_t *buf, size_t size);
  57
  58 static INLINE void fifo_clear(fifo_buffer_t *buffer)
  59 {
  60    buffer->first = 0;
  61    buffer->end   = 0;
  62 }
  63
  64 void fifo_write(fifo_buffer_t *buffer, const void *in_buf, size_t size);
  65
  66 void fifo_read(fifo_buffer_t *buffer, void *in_buf, size_t size);
  67
  68 void fifo_free(fifo_buffer_t *buffer);
  69
  70 bool fifo_deinitialize(fifo_buffer_t *buffer);
  71
  72
  73 RETRO_END_DECLS
  74
  75 #endif