mlt_tractor.[ch], mlt_multitrack.[ch]: improve doxygen documentation for the tractor...
[melted] / src / framework / mlt_deque.h
1 /**
2 * \file mlt_deque.h
3 * \brief double ended queue
4 *
5 * Copyright (C) 2003-2008 Ushodaya Enterprises Limited
6 * \author Charles Yates <charles.yates@pandora.be>
7 *
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Lesser General Public
10 * License as published by the Free Software Foundation; either
11 * version 2.1 of the License, or (at your option) any later version.
12 *
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Lesser General Public License for more details.
17 *
18 * You should have received a copy of the GNU Lesser General Public
19 * License along with this library; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 */
22
23 #ifndef _MLT_DEQUE_H_
24 #define _MLT_DEQUE_H_
25
26 #include "mlt_types.h"
27
28 extern mlt_deque mlt_deque_init( );
29 extern int mlt_deque_count( mlt_deque self );
30 extern int mlt_deque_push_back( mlt_deque self, void *item );
31 extern void *mlt_deque_pop_back( mlt_deque self );
32 extern int mlt_deque_push_front( mlt_deque self, void *item );
33 extern void *mlt_deque_pop_front( mlt_deque self );
34 extern void *mlt_deque_peek_back( mlt_deque self );
35 extern void *mlt_deque_peek_front( mlt_deque self );
36
37 extern int mlt_deque_push_back_int( mlt_deque self, int item );
38 extern int mlt_deque_pop_back_int( mlt_deque self );
39 extern int mlt_deque_push_front_int( mlt_deque self, int item );
40 extern int mlt_deque_pop_front_int( mlt_deque self );
41 extern int mlt_deque_peek_back_int( mlt_deque self );
42 extern int mlt_deque_peek_front_int( mlt_deque self );
43
44 extern int mlt_deque_push_back_double( mlt_deque self, double item );
45 extern double mlt_deque_pop_back_double( mlt_deque self );
46 extern int mlt_deque_push_front_double( mlt_deque self, double item );
47 extern double mlt_deque_pop_front_double( mlt_deque self );
48 extern double mlt_deque_peek_back_double( mlt_deque self );
49 extern double mlt_deque_peek_front_double( mlt_deque self );
50
51 extern void mlt_deque_close( mlt_deque self );
52
53 #endif