oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

decoder/Thread: document locking rules

Browse Source
This commit is contained in:
Max Kellermann 2015-12-31 12:24:57 +01:00
parent b62f5e079e
commit 55e113c7a7
1 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/decoder/DecoderThread.cxx
View File

@ -120,6 +120,11 @@ decoder_input_stream_open(DecoderControl &dc, Path path)
return is; return is;
} }
/**
* Decode a stream with the given decoder plugin.
*
* Caller holds DecoderControl::mutex.
*/
static bool static bool
decoder_stream_decode(const DecoderPlugin &plugin, decoder_stream_decode(const DecoderPlugin &plugin,
Decoder &decoder, Decoder &decoder,
@ -155,6 +160,11 @@ decoder_stream_decode(const DecoderPlugin &plugin,
return decoder.dc.state != DecoderState::START; return decoder.dc.state != DecoderState::START;
} }
/**
* Decode a file with the given decoder plugin.
*
* Caller holds DecoderControl::mutex.
*/
static bool static bool
decoder_file_decode(const DecoderPlugin &plugin, decoder_file_decode(const DecoderPlugin &plugin,
Decoder &decoder, Path path) Decoder &decoder, Path path)
@ -258,6 +268,8 @@ decoder_run_stream_fallback(Decoder &decoder, InputStream &is)
/** /**
* Try decoding a stream. * Try decoding a stream.
*
* Caller holds DecoderControl::mutex.
*/ */
static bool static bool
decoder_run_stream(Decoder &decoder, const char *uri) decoder_run_stream(Decoder &decoder, const char *uri)
@ -302,6 +314,12 @@ decoder_load_replay_gain(Decoder &decoder, Path path_fs)
decoder_replay_gain(decoder, &info); decoder_replay_gain(decoder, &info);
} }
/**
* Decode a file with the given decoder plugin.
*
* DecoderControl::mutex must not be locked by the caller. It will be
* left locked upon returning true.
*/
static bool static bool
TryDecoderFile(Decoder &decoder, Path path_fs, const char *suffix, TryDecoderFile(Decoder &decoder, Path path_fs, const char *suffix,
const DecoderPlugin &plugin) const DecoderPlugin &plugin)
@ -344,6 +362,8 @@ TryDecoderFile(Decoder &decoder, Path path_fs, const char *suffix,
/** /**
* Try decoding a file. * Try decoding a file.
*
* Caller holds DecoderControl::mutex.
*/ */
static bool static bool
decoder_run_file(Decoder &decoder, const char *uri_utf8, Path path_fs) decoder_run_file(Decoder &decoder, const char *uri_utf8, Path path_fs)
@ -369,6 +389,11 @@ decoder_run_file(Decoder &decoder, const char *uri_utf8, Path path_fs)
return false; return false;
} }
/**
* Decode a song addressed by a #DetachedSong.
*
* Caller holds DecoderControl::mutex.
*/
static void static void
decoder_run_song(DecoderControl &dc, decoder_run_song(DecoderControl &dc,
const DetachedSong &song, const char *uri, Path path_fs) const DetachedSong &song, const char *uri, Path path_fs)
@ -419,6 +444,10 @@ decoder_run_song(DecoderControl &dc,
dc.client_cond.signal(); dc.client_cond.signal();
} }
/**
*
* Caller holds DecoderControl::mutex.
*/
static void static void
decoder_run(DecoderControl &dc) decoder_run(DecoderControl &dc)
{ {