mirror of
https://code.videolan.org/videolan/vlc
synced 2024-09-16 16:02:54 +02:00
90 lines
2.8 KiB
C
90 lines
2.8 KiB
C
/*****************************************************************************
|
|
* vlc_picture_fifo.h: picture fifo definitions
|
|
*****************************************************************************
|
|
* Copyright (C) 2009 the VideoLAN team
|
|
* $Id$
|
|
*
|
|
* Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
|
*****************************************************************************/
|
|
|
|
#ifndef VLC_PICTURE_FIFO_H
|
|
#define VLC_PICTURE_FIFO_H 1
|
|
|
|
/**
|
|
* \file
|
|
* This file defines picture fifo structures and functions in vlc
|
|
*/
|
|
|
|
#include <vlc_picture.h>
|
|
|
|
/**
|
|
* Picture fifo handle
|
|
*
|
|
* It is thread safe (push/pop).
|
|
*/
|
|
typedef struct picture_fifo_t picture_fifo_t;
|
|
|
|
/**
|
|
* It creates an empty picture_fifo_t.
|
|
*/
|
|
VLC_EXPORT( picture_fifo_t *, picture_fifo_New, ( void ) LIBVLC_USED );
|
|
|
|
/**
|
|
* It destroys a fifo created by picture_fifo_New.
|
|
*
|
|
* All pictures inside the fifo will be released by picture_Release.
|
|
*/
|
|
VLC_EXPORT( void, picture_fifo_Delete, ( picture_fifo_t * ) );
|
|
|
|
/**
|
|
* It retreives a picture_t from the fifo.
|
|
*
|
|
* If the fifo is empty, it return NULL without waiting.
|
|
*/
|
|
VLC_EXPORT( picture_t *, picture_fifo_Pop, ( picture_fifo_t * ) LIBVLC_USED );
|
|
|
|
/**
|
|
* It returns the first picture_t pointer from the fifo but does not
|
|
* remove it. The picture returned has been hold for you so you
|
|
* must call picture_Release on it.
|
|
*
|
|
* If the fifo is empty, it return NULL without waiting.
|
|
*/
|
|
VLC_EXPORT( picture_t *, picture_fifo_Peek, ( picture_fifo_t * ) LIBVLC_USED );
|
|
|
|
/**
|
|
* It saves a picture_t into the fifo.
|
|
*/
|
|
VLC_EXPORT( void, picture_fifo_Push, ( picture_fifo_t *, picture_t * ) );
|
|
|
|
/**
|
|
* It release all picture inside the fifo that have a lower or equal date
|
|
* if flush_before or higher or equal to if not flush_before than the given one.
|
|
*
|
|
* All pictures inside the fifo will be released by picture_Release.
|
|
*/
|
|
VLC_EXPORT( void, picture_fifo_Flush, ( picture_fifo_t *, mtime_t date, bool flush_before ) );
|
|
|
|
/**
|
|
* It applies a delta on all the picture timestamp.
|
|
*/
|
|
VLC_EXPORT( void, picture_fifo_OffsetDate, ( picture_fifo_t *, mtime_t delta ) );
|
|
|
|
|
|
#endif /* VLC_PICTURE_FIFO_H */
|
|
|