/
extra_rwops.h
89 lines (72 loc) · 2.99 KB
/
extra_rwops.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
/*
* SDL_sound -- An abstract sound format decoding API.
* Copyright (C) 2001 Ryan C. Gordon.
*
* This library 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 (at your option) any later version.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Some extra RWops that are needed or are just handy to have.
*
* Please see the file COPYING in the source's root directory.
*
* This file written by Ryan C. Gordon. (icculus@icculus.org)
*/
#ifndef _INCLUDE_EXTRA_RWOPS_H_
#define _INCLUDE_EXTRA_RWOPS_H_
#include "SDL.h"
#ifdef __cplusplus
extern "C" {
#endif
/*
* The Reference Counter RWops...
*
* This wraps another RWops with a reference counter. When you create a
* reference counter RWops, it sets a counter to one. Everytime you call
* RWops_RWRefCounter_new(), that's RWops's counter increments by one.
* Everytime you call that RWops's close() method, the counter decrements
* by one. If the counter hits zero, the original RWops's close() method
* is called, and the reference counting wrapper deletes itself. The read,
* write, and seek methods just pass through to the original.
*
* This is handy if you have two libraries (in the original case, SDL_sound
* and SMPEG), who both want an SDL_RWops, and both want to close it when
* they are finished. This resolves that contention. The user creates a
* RWops, passes it to SDL_sound, which wraps it in a reference counter and
* increments the number of references, and passes the wrapped RWops to
* SMPEG. SMPEG "closes" this wrapped RWops when the MP3 has finished
* playing, and SDL_sound then closes it, too. This second closing removes
* the last reference, and the RWops is smoothly destructed.
*/
/* Return a SDL_RWops that is a reference counting wrapper of (rw). */
SDL_RWops *RWops_RWRefCounter_new(SDL_RWops *rw);
/* Increment a reference counting RWops's refcount by one. */
void RWops_RWRefCounter_addRef(SDL_RWops *rw);
/*
* RWops pooling. This is to reduce malloc() pressure for audio that is
* placed into Sound_Samples over and over again.
*/
/* Call this first. */
int RWops_pooled_init(void);
/* Call this last. */
int RWops_pooled_deinit(void);
/* Get a new RWops, allocating if needed. */
SDL_RWops *RWops_pooled_alloc(void);
/* Return a RWops to the pool for reuse. */
void RWops_pooled_free(SDL_RWops *rw);
#ifdef __cplusplus
}
#endif
#endif /* !defined _INCLUDE_EXTRA_RWOPS_H_ */
/* end of extra_rwops.h ... */