1
0
mirror of https://github.com/mpv-player/mpv synced 2024-12-20 22:02:59 +00:00
mpv/misc/ring.h
wm4 8a9b64329c Relicense some non-MPlayer source files to LGPL 2.1 or later
This covers source files which were added in mplayer2 and mpv times
only, and where all code is covered by LGPL relicensing agreements.

There are probably more files to which this applies, but I'm being
conservative here.

A file named ao_sdl.c exists in MPlayer too, but the mpv one is a
complete rewrite, and was added some time after the original ao_sdl.c
was removed. The same applies to vo_sdl.c, for which the SDL2 API is
radically different in addition (MPlayer supports SDL 1.2 only).

common.c contains only code written by me. But common.h is a strange
case: although it originally was named mp_common.h and exists in MPlayer
too, by now it contains only definitions written by uau and me. The
exceptions are the CONTROL_ defines - thus not changing the license of
common.h yet.

codec_tags.c contained once large tables generated from MPlayer's
codecs.conf, but all of these tables were removed.

From demux_playlist.c I'm removing a code fragment from someone who was
not asked; this probably could be done later (see commit 15dccc37).

misc.c is a bit complicated to reason about (it was split off mplayer.c
and thus contains random functions out of this file), but actually all
functions have been added post-MPlayer. Except get_relative_time(),
which was written by uau, but looks similar to 3 different versions of
something similar in each of the Unix/win32/OSX timer source files. I'm
not sure what that means in regards to copyright, so I've just moved it
into another still-GPL source file for now.

screenshot.c once had some minor parts of MPlayer's vf_screenshot.c, but
they're all gone.
2016-01-19 18:36:06 +01:00

109 lines
2.9 KiB
C

/*
* This file is part of mpv.
* Copyright (c) 2012 wm4
* Copyright (c) 2013 Stefano Pigozzi <stefano.pigozzi@gmail.com>
*
* mpv is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* mpv 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 Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with mpv. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef MPV_MP_RING_H
#define MPV_MP_RING_H
/**
* A simple non-blocking SPSC (single producer, single consumer) ringbuffer
* implementation. Thread safety is accomplished through atomic operations.
*/
struct mp_ring;
/**
* Instantiate a new ringbuffer
*
* talloc_ctx: talloc context of the newly created object
* size: total size in bytes
* return: the newly created ringbuffer
*/
struct mp_ring *mp_ring_new(void *talloc_ctx, int size);
/**
* Read data from the ringbuffer
*
* buffer: target ringbuffer instance
* dest: destination buffer for the read data. If NULL read data is discarded.
* len: maximum number of bytes to read
* return: number of bytes read
*/
int mp_ring_read(struct mp_ring *buffer, unsigned char *dest, int len);
/**
* Write data to the ringbuffer
*
* buffer: target ringbuffer instance
* src: source buffer for the write data
* len: maximum number of bytes to write
* return: number of bytes written
*/
int mp_ring_write(struct mp_ring *buffer, unsigned char *src, int len);
/**
* Drain data from the ringbuffer
*
* buffer: target ringbuffer instance
* len: maximum number of bytes to drain
* return: number of bytes drained
*/
int mp_ring_drain(struct mp_ring *buffer, int len);
/**
* Reset the ringbuffer discarding any content
*
* buffer: target ringbuffer instance
*/
void mp_ring_reset(struct mp_ring *buffer);
/**
* Get the available size for writing
*
* buffer: target ringbuffer instance
* return: number of bytes that can be written
*/
int mp_ring_available(struct mp_ring *buffer);
/**
* Get the total size
*
* buffer: target ringbuffer instance
* return: total ringbuffer size in bytes
*/
int mp_ring_size(struct mp_ring *buffer);
/**
* Get the available size for reading
*
* buffer: target ringbuffer instance
* return: number of bytes ready for reading
*/
int mp_ring_buffered(struct mp_ring *buffer);
/**
* Get a string representation of the ringbuffer
*
* buffer: target ringbuffer instance
* talloc_ctx: talloc context of the newly created string
* return: string representing the ringbuffer
*/
char *mp_ring_repr(struct mp_ring *buffer, void *talloc_ctx);
#endif