vlc_picture_pool.h 4.44 KB
Newer Older
1 2 3
/*****************************************************************************
 * vlc_picture_pool.h: picture pool definitions
 *****************************************************************************
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
4
 * Copyright (C) 2009 VLC authors and VideoLAN
5 6 7 8
 * $Id$
 *
 * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ org>
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
9 10 11
 * This program 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
12 13 14 15
 * (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
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
16 17
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Lesser General Public License for more details.
18
 *
Jean-Baptiste Kempf's avatar
LGPL  
Jean-Baptiste Kempf committed
19 20 21
 * You should have received a copy of the GNU Lesser 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.
22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
 *****************************************************************************/

#ifndef VLC_PICTURE_POOL_H
#define VLC_PICTURE_POOL_H 1

/**
 * \file
 * This file defines picture pool structures and functions in vlc
 */

#include <vlc_picture.h>

/**
 * Picture pool handle
 *
 * XXX it is not thread safe, all pool manipulations and picture_Release
 * must be properly locked if needed.
 */
typedef struct picture_pool_t picture_pool_t;

/**
43 44 45
 * Picture pool configuration
 */
typedef struct {
46 47
    unsigned  picture_count;
    picture_t *const *picture;
48 49 50 51 52 53 54

    int       (*lock)(picture_t *);
    void      (*unlock)(picture_t *);
} picture_pool_configuration_t;

/**
 * It creates a picture_pool_t wrapping the given configuration.
55
 *
Rémi Denis-Courmont's avatar
Typos  
Rémi Denis-Courmont committed
56
 * It avoids useless picture creations/destructions.
57 58 59
 * 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.
60 61 62 63 64
 * 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.
 */
65
VLC_API picture_pool_t * picture_pool_NewExtended( const picture_pool_configuration_t * ) VLC_USED;
66 67 68 69 70

/**
 * It creates a picture_pool_t wrapping the given arrays of picture.
 *
 * It is provided as convenience.
71
 */
72 73
VLC_API picture_pool_t * picture_pool_New(unsigned count,
                                          picture_t *const *tab) VLC_USED;
74 75 76 77 78 79

/**
 * It creates a picture_pool_t creating images using the given format.
 *
 * Provided for convenience.
 */
80 81
VLC_API picture_pool_t * picture_pool_NewFromFormat(const video_format_t *,
                                                    unsigned count) VLC_USED;
82 83 84 85 86 87 88

/**
 * It destroys a pool created by picture_pool_New.
 *
 * All pictures must already be released to the pool. The pool will then
 * released them.
 */
89
VLC_API void picture_pool_Delete( picture_pool_t * );
90 91 92 93 94 95

/**
 * It retreives a picture_t from a pool.
 *
 * The picture must be release by using picture_Release.
 */
96
VLC_API picture_t * picture_pool_Get( picture_pool_t * ) VLC_USED;
97

98 99 100 101 102 103
/**
 * Forcefully return all pictures in the pool to free/unallocated state.
 *
 * @warning This can only be called when it is known that all pending
 * references to the picture pool are stale, e.g. a decoder failed to
 * release pictures properly when it terminated.
104 105
 /
 * @return the number of picture references that were freed
106
 */
107
unsigned picture_pool_Reset( picture_pool_t * );
108

109 110 111 112 113 114 115 116 117
/**
 * It forces the next picture_pool_Get to return a picture even if no
 * pictures are free.
 *
 * It does it by releasing itself the oldest used picture if none is
 * available.
 * XXX it should be used with great care, the only reason you may need
 * it is to workaround a bug.
 */
118
void picture_pool_NonEmpty( picture_pool_t * );
119

120 121 122 123 124 125 126 127
/**
 * 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.
 */
128 129
VLC_API picture_pool_t * picture_pool_Reserve(picture_pool_t *, unsigned count)
VLC_USED;
130

131 132 133
/**
 * It returns the size of the given pool.
 */
134
VLC_API int picture_pool_GetSize(picture_pool_t *);
135

136

137 138
#endif /* VLC_PICTURE_POOL_H */