src/output_all.h File Reference

#include <stdbool.h>
#include <stddef.h>

Go to the source code of this file.

Functions

void audio_output_all_init (void)
 Global initialization: load audio outputs from the configuration file and initialize them.
void audio_output_all_finish (void)
 Global finalization: free memory occupied by audio outputs.
unsigned int audio_output_count (void)
 Returns the total number of audio output devices, including those who are disabled right now.
struct audio_outputaudio_output_get (unsigned i)
 Returns the "i"th audio output device.
struct audio_outputaudio_output_find (const char *name)
 Returns the audio output device with the specified name.
bool audio_output_all_open (const struct audio_format *audio_format, struct music_buffer *buffer)
 Opens all audio outputs which are not disabled.
void audio_output_all_close (void)
 Closes all audio outputs.
bool audio_output_all_play (struct music_chunk *chunk)
 Enqueue a music_chunk object for playing, i.e.
unsigned audio_output_all_check (void)
 Checks if the output devices have drained their music pipe, and returns the consumed music chunks to the music_buffer.
bool audio_output_all_wait (unsigned threshold)
 Checks if the size of the music_pipe is below the threshold.
void audio_output_all_pause (void)
 Puts all audio outputs into pause mode.
void audio_output_all_cancel (void)
 Try to cancel data which may still be in the device's buffers.


Function Documentation

void audio_output_all_cancel ( void   ) 

Try to cancel data which may still be in the device's buffers.

unsigned audio_output_all_check ( void   ) 

Checks if the output devices have drained their music pipe, and returns the consumed music chunks to the music_buffer.

Returns:
the number of chunks to play left in the music_pipe

void audio_output_all_close ( void   ) 

Closes all audio outputs.

void audio_output_all_finish ( void   ) 

Global finalization: free memory occupied by audio outputs.

All

void audio_output_all_init ( void   ) 

Global initialization: load audio outputs from the configuration file and initialize them.

bool audio_output_all_open ( const struct audio_format audio_format,
struct music_buffer *  buffer 
)

Opens all audio outputs which are not disabled.

Parameters:
audio_format the preferred audio format, or NULL to reuse the previous format
buffer the music_buffer where consumed music_chunk objects should be returned
Returns:
true on success, false on failure

void audio_output_all_pause ( void   ) 

Puts all audio outputs into pause mode.

Most implementations will simply close it then.

bool audio_output_all_play ( struct music_chunk chunk  ) 

Enqueue a music_chunk object for playing, i.e.

pushes it to a music_pipe.

Parameters:
chunk the music_chunk object to be played
Returns:
true on success, false if no audio output was able to play (all closed then)

bool audio_output_all_wait ( unsigned  threshold  ) 

Checks if the size of the music_pipe is below the threshold.

If not, it attempts to synchronize with all output threads, and waits until another music_chunk is finished.

Parameters:
threshold the maximum number of chunks in the pipe
Returns:
true if there are less than threshold chunks in the pipe

unsigned int audio_output_count ( void   ) 

Returns the total number of audio output devices, including those who are disabled right now.

struct audio_output* audio_output_find ( const char *  name  )  [read]

Returns the audio output device with the specified name.

Returns NULL if the name does not exist.

struct audio_output* audio_output_get ( unsigned  i  )  [read]

Returns the "i"th audio output device.


Generated on Wed Aug 25 00:21:21 2010 for MPD by  doxygen 1.5.7.1