diff options
Diffstat (limited to 'src/audacious/input-api.h')
| -rw-r--r-- | src/audacious/input-api.h | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/src/audacious/input-api.h b/src/audacious/input-api.h new file mode 100644 index 0000000..7c49b0e --- /dev/null +++ b/src/audacious/input-api.h @@ -0,0 +1,60 @@ +/* + * input-api.h + * Copyright 2013 John Lindgren + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are met: + * + * 1. Redistributions of source code must retain the above copyright notice, + * this list of conditions, and the following disclaimer. + * + * 2. Redistributions in binary form must reproduce the above copyright notice, + * this list of conditions, and the following disclaimer in the documentation + * provided with the distribution. + * + * This software is provided "as is" and without any warranty, express or + * implied. In no event shall the authors be liable for any damages arising from + * the use of this software. + */ + +/* Do not include this file directly; use input.h instead. */ + +/* These functions are to be used only from the play() function of an input plugin. */ + +/* Prepares the output system for playback in the specified format. Returns + * TRUE on success, FALSE if the selected format is not supported. */ +AUD_FUNC3 (bool_t, input_open_audio, int, format, int, rate, int, channels) + +/* Informs the output system of replay gain values for the current song so + * that volume levels can be adjusted accordingly, if the user so desires. + * This may be called at any time during playback should the values change. */ +AUD_VFUNC1 (input_set_gain, const ReplayGainInfo *, info) + +/* Passes audio data to the output system for playback. The data must be in + * the format passed to open_audio, and the length (in bytes) must be an + * integral number of frames. This function blocks until all the data has + * been written (though it may not yet be heard by the user). */ +AUD_VFUNC2 (input_write_audio, void *, data, int, length) + +/* Returns the time counter. Note that this represents the amount of audio + * data passed to the output system, not the amount actually heard by the + * user. */ +AUD_FUNC0 (int, input_written_time) + +/* Returns a reference to the current tuple for the stream. */ +AUD_FUNC0 (Tuple *, input_get_tuple) + +/* Updates the tuple for the stream. The caller gives up ownership of one + * reference to the tuple. */ +AUD_VFUNC1 (input_set_tuple, Tuple *, tuple) + +/* Updates the displayed bitrate, in bits per second. */ +AUD_VFUNC1 (input_set_bitrate, int, bitrate) + +/* Checks whether playback is to be stopped. The play() function should poll + * check_stop() periodically and return as soon as check_stop() returns TRUE. */ +AUD_FUNC0 (bool_t, input_check_stop) + +/* Checks whether a seek has been requested. If so, discards any buffered audio + * and returns the position to seek to, in milliseconds. Otherwise, returns -1. */ +AUD_FUNC0 (int, input_check_seek) |