mpd/src/output_all.h
2009-02-10 18:51:59 +01:00

111 lines
2.5 KiB
C

/*
* Copyright (C) 2003-2009 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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/*
* Functions for dealing with all configured (enabled) audion outputs
* at once.
*
*/
#ifndef OUTPUT_ALL_H
#define OUTPUT_ALL_H
#include <stdbool.h>
#include <stddef.h>
struct audio_format;
struct tag;
/**
* Global initialization: load audio outputs from the configuration
* file and initialize them.
*/
void
audio_output_all_init(void);
/**
* Global finalization: free memory occupied by audio outputs. All
*/
void
audio_output_all_finish(void);
/**
* Returns the total number of audio output devices, including those
* who are disabled right now.
*/
unsigned int audio_output_count(void);
/**
* Returns the "i"th audio output device.
*/
struct audio_output *
audio_output_get(unsigned i);
/**
* Returns the audio output device with the specified name. Returns
* NULL if the name does not exist.
*/
struct audio_output *
audio_output_find(const char *name);
/**
* Opens all audio outputs which are not disabled.
*
* @param audio_format the preferred audio format, or NULL to reuse
* the previous format
* @return true on success, false on failure
*/
bool
audio_output_all_open(const struct audio_format *audio_format);
/**
* Closes all audio outputs.
*/
void
audio_output_all_close(void);
/**
* Play a chunk of audio data.
*
* @return true on success, false if no audio output was able to play
* (all closed then)
*/
bool
audio_output_all_play(const char *data, size_t size);
/**
* Send metadata for the next chunk.
*/
void
audio_output_all_tag(const struct tag *tag);
/**
* Puts all audio outputs into pause mode. Most implementations will
* simply close it then.
*/
void
audio_output_all_pause(void);
/**
* Try to cancel data which may still be in the device's buffers.
*/
void
audio_output_all_cancel(void);
#endif