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
/*
* Copyright 2003-2018 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 SHARED_PIPE_CONSUMER_HXX
#define SHARED_PIPE_CONSUMER_HXX
#include "util/Compiler.h"
#include <assert.h>
struct MusicChunk;
class MusicPipe;
/**
* A utility class which helps with consuming data from a #MusicPipe.
*
* This class is intentionally not thread-safe. Since it is designed
* to be called from two distinct threads (PlayerThread=feeder and
* OutputThread=consumer), all methods must be called with a mutex
* locked to serialize access. Usually, this is #AudioOutput::mutex.
*/
class SharedPipeConsumer {
/**
* The music pipe which provides music chunks to be played.
*/
const MusicPipe *pipe = nullptr;
/**
* The #MusicChunk which is currently being played. All
* chunks before this one may be returned to the #MusicBuffer,
* because they are not going to be used by this output
* anymore.
*/
const MusicChunk *chunk;
/**
* Has the output finished playing #chunk?
*/
bool consumed;
public:
void Init(const MusicPipe &_pipe) {
pipe = &_pipe;
chunk = nullptr;
}
const MusicPipe &GetPipe() {
assert(pipe != nullptr);
return *pipe;
}
bool IsInitial() {
return chunk == nullptr;
}
void Cancel() {
chunk = nullptr;
}
const MusicChunk *Get() noexcept;
void Consume(gcc_unused const MusicChunk &_chunk) {
assert(chunk != nullptr);
assert(chunk == &_chunk);
consumed = true;
}
gcc_pure
bool IsConsumed(const MusicChunk &_chunk) const noexcept;
void ClearTail(gcc_unused const MusicChunk &_chunk) noexcept {
assert(chunk == &_chunk);
assert(consumed);
chunk = nullptr;
}
};
#endif