home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2010 November / maximum-cd-2010-11.iso / DiscContents / vlc-1.1.2-win32.exe / sdk / include / vlc / plugins / vlc_picture_fifo.h < prev    next >
Encoding:
C/C++ Source or Header  |  2010-07-30  |  2.8 KB  |  90 lines
  1. /*****************************************************************************
  2.  * vlc_picture_fifo.h: picture fifo definitions
  3.  *****************************************************************************
  4.  * Copyright (C) 2009 the VideoLAN team
  5.  * $Id: 440886e6543c640f721d4b2344de164785960b01 $
  6.  *
  7.  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
  8.  *
  9.  * This program is free software; you can redistribute it and/or modify
  10.  * it under the terms of the GNU General Public License as published by
  11.  * the Free Software Foundation; either version 2 of the License, or
  12.  * (at your option) any later version.
  13.  *
  14.  * This program is distributed in the hope that it will be useful,
  15.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17.  * GNU General Public License for more details.
  18.  *
  19.  * You should have received a copy of the GNU General Public License
  20.  * along with this program; if not, write to the Free Software
  21.  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  22.  *****************************************************************************/
  23.  
  24. #ifndef VLC_PICTURE_FIFO_H
  25. #define VLC_PICTURE_FIFO_H 1
  26.  
  27. /**
  28.  * \file
  29.  * This file defines picture fifo structures and functions in vlc
  30.  */
  31.  
  32. #include <vlc_picture.h>
  33.  
  34. /**
  35.  * Picture fifo handle
  36.  *
  37.  * It is thread safe (push/pop).
  38.  */
  39. typedef struct picture_fifo_t picture_fifo_t;
  40.  
  41. /**
  42.  * It creates an empty picture_fifo_t.
  43.  */
  44. VLC_EXPORT( picture_fifo_t *, picture_fifo_New, ( void ) LIBVLC_USED );
  45.  
  46. /**
  47.  * It destroys a fifo created by picture_fifo_New.
  48.  *
  49.  * All pictures inside the fifo will be released by picture_Release.
  50.  */
  51. VLC_EXPORT( void, picture_fifo_Delete, ( picture_fifo_t * ) );
  52.  
  53. /**
  54.  * It retreives a picture_t from the fifo.
  55.  *
  56.  * If the fifo is empty, it return NULL without waiting.
  57.  */
  58. VLC_EXPORT( picture_t *, picture_fifo_Pop, ( picture_fifo_t * ) LIBVLC_USED );
  59.  
  60. /**
  61.  * It returns the first picture_t pointer from the fifo but does not
  62.  * remove it. The picture returned has been hold for you so you
  63.  * must call picture_Release on it.
  64.  *
  65.  * If the fifo is empty, it return NULL without waiting.
  66.  */
  67. VLC_EXPORT( picture_t *, picture_fifo_Peek, ( picture_fifo_t * ) LIBVLC_USED );
  68.  
  69. /**
  70.  * It saves a picture_t into the fifo.
  71.  */
  72. VLC_EXPORT( void, picture_fifo_Push, ( picture_fifo_t *, picture_t * ) );
  73.  
  74. /**
  75.  * It release all picture inside the fifo that have a lower or equal date
  76.  * if flush_before or higher or equal to if not flush_before than the given one.
  77.  *
  78.  * All pictures inside the fifo will be released by picture_Release.
  79.  */
  80. VLC_EXPORT( void, picture_fifo_Flush, ( picture_fifo_t *, mtime_t date, bool flush_before ) );
  81.  
  82. /**
  83.  * It applies a delta on all the picture timestamp.
  84.  */
  85. VLC_EXPORT( void, picture_fifo_OffsetDate, ( picture_fifo_t *, mtime_t delta ) );
  86.  
  87.  
  88. #endif /* VLC_PICTURE_FIFO_H */
  89.  
  90.