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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
|
/*
* Copyright (C) 2003-2014 The Music Player Daemon Project
* http://www.musicpd.org
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (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
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU 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.
*/
#ifndef MPD_PIPE_H
#define MPD_PIPE_H
#include "thread/Mutex.hxx"
#include "Compiler.h"
#ifndef NDEBUG
#include "AudioFormat.hxx"
#endif
#include <assert.h>
struct MusicChunk;
class MusicBuffer;
/**
* A queue of #MusicChunk objects. One party appends chunks at the
* tail, and the other consumes them from the head.
*/
class MusicPipe {
/** the first chunk */
MusicChunk *head;
/** a pointer to the tail of the chunk */
MusicChunk **tail_r;
/** the current number of chunks */
unsigned size;
/** a mutex which protects #head and #tail_r */
mutable Mutex mutex;
#ifndef NDEBUG
AudioFormat audio_format;
#endif
public:
/**
* Creates a new #MusicPipe object. It is empty.
*/
MusicPipe()
:head(nullptr), tail_r(&head), size(0) {
#ifndef NDEBUG
audio_format.Clear();
#endif
}
/**
* Frees the object. It must be empty now.
*/
~MusicPipe() {
assert(head == nullptr);
assert(tail_r == &head);
}
#ifndef NDEBUG
/**
* Checks if the audio format if the chunk is equal to the specified
* audio_format.
*/
gcc_pure
bool CheckFormat(AudioFormat other) const {
return !audio_format.IsDefined() ||
audio_format == other;
}
/**
* Checks if the specified chunk is enqueued in the music pipe.
*/
gcc_pure
bool Contains(const MusicChunk *chunk) const;
#endif
/**
* Returns the first #MusicChunk from the pipe. Returns
* nullptr if the pipe is empty.
*/
gcc_pure
const MusicChunk *Peek() const {
return head;
}
/**
* Removes the first chunk from the head, and returns it.
*/
MusicChunk *Shift();
/**
* Clears the whole pipe and returns the chunks to the buffer.
*
* @param buffer the buffer object to return the chunks to
*/
void Clear(MusicBuffer &buffer);
/**
* Pushes a chunk to the tail of the pipe.
*/
void Push(MusicChunk *chunk);
/**
* Returns the number of chunks currently in this pipe.
*/
gcc_pure
unsigned GetSize() const {
return size;
}
gcc_pure
bool IsEmpty() const {
return GetSize() == 0;
}
};
#endif
|
