Use var_Inherit* instead of var_CreateGet*.

[vlc] / include / vlc_picture_pool.h

diff --git a/include/vlc_picture_pool.h b/include/vlc_picture_pool.h
index 72469c634ebe625f4058d89a874364a575a33bd4..d22dbed8e9a6fc05bc5cd8400ade70e258fea03b 100644 (file)
--- a/include/vlc_picture_pool.h
+++ b/include/vlc_picture_pool.h
@@ -40,21 +40,43 @@
 typedef struct picture_pool_t picture_pool_t;
 
 /**
- * It creates a picture_pool_t wrapping the given arrays of picture.
+ * Picture pool configuration
+ */
+typedef struct {
+    int       picture_count;
+    picture_t **picture;
+
+    int       (*lock)(picture_t *);
+    void      (*unlock)(picture_t *);
+} picture_pool_configuration_t;
+
+/**
+ * It creates a picture_pool_t wrapping the given configuration.
  *
- * It is usefull to avoid useless picture creations/destructions.
+ * It avoids useless picture creations/destructions.
  * The given picture must not have a reference count greater than 1.
  * The pool takes ownership of the picture and MUST not be used directly.
  * When deleted, the pool will release the pictures using picture_Release.
+ * If defined, picture_pool_configuration_t::lock will be called before
+ * a picture is used, and picture_pool_configuration_t::unlock will be called
+ * as soon as a picture is unused. They are allowed to modify picture_t::p and
+ * access picture_t::p_sys.
+ */
+VLC_EXPORT( picture_pool_t *, picture_pool_NewExtended, ( const picture_pool_configuration_t * ) LIBVLC_USED );
+
+/**
+ * It creates a picture_pool_t wrapping the given arrays of picture.
+ *
+ * It is provided as convenience.
  */
-VLC_EXPORT( picture_pool_t *, picture_pool_New, ( int i_picture, picture_t *pp_picture[] ) );
+VLC_EXPORT( picture_pool_t *, picture_pool_New, ( int picture_count, picture_t *picture[] ) LIBVLC_USED );
 
 /**
  * It creates a picture_pool_t creating images using the given format.
  *
  * Provided for convenience.
  */
-VLC_EXPORT( picture_pool_t *, picture_pool_NewFromFormat, ( const video_format_t *, int i_picture ) );
+VLC_EXPORT( picture_pool_t *, picture_pool_NewFromFormat, ( const video_format_t *, int picture_count ) LIBVLC_USED );
 
 /**
  * It destroys a pool created by picture_pool_New.
@@ -69,7 +91,7 @@ VLC_EXPORT( void, picture_pool_Delete, ( picture_pool_t * ) );
  *
  * The picture must be release by using picture_Release.
  */
-VLC_EXPORT( picture_t *, picture_pool_Get, ( picture_pool_t * ) );
+VLC_EXPORT( picture_t *, picture_pool_Get, ( picture_pool_t * ) LIBVLC_USED );
 
 /**
  * It forces the next picture_pool_Get to return a picture even if no
@@ -82,7 +104,23 @@ VLC_EXPORT( picture_t *, picture_pool_Get, ( picture_pool_t * ) );
  * XXX it should be used with great care, the only reason you may need
  * it is to workaround a bug.
  */
-VLC_EXPORT( void, picture_pool_NonEmpty, ( picture_pool_t *, bool b_reset ) );
+VLC_EXPORT( void, picture_pool_NonEmpty, ( picture_pool_t *, bool reset ) );
+
+/**
+ * It reserves picture_count pictures from the given pool and returns
+ * a new pool with thoses pictures.
+ *
+ * The master pool must be full.
+ * The returned pool must be deleted before the master pool.
+ * When deleted, all pictures return to the master pool.
+ */
+VLC_EXPORT( picture_pool_t *, picture_pool_Reserve, (picture_pool_t *, int picture_count) LIBVLC_USED );
+
+/**
+ * It returns the size of the given pool.
+ */
+VLC_EXPORT( int, picture_pool_GetSize, (picture_pool_t *) );
+
 
 #endif /* VLC_PICTURE_POOL_H */