mpd/src/output_control.h

/* the Music Player Daemon (MPD)
 * Copyright (C) 2003-2007 by Warren Dukes (warren.dukes@gmail.com)
 * This project's homepage is: 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
 */

#ifndef MPD_OUTPUT_CONTROL_H
#define MPD_OUTPUT_CONTROL_H

#include <glib.h>

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

struct audio_output;
struct audio_format;
struct tag;
struct config_param;

static inline GQuark
audio_output_quark(void)
{
	return g_quark_from_static_string("audio_output");
}

bool
audio_output_init(struct audio_output *ao, const struct config_param *param,
		  GError **error);

/**
 * Opens or closes the device, depending on the "enabled" flag.
 *
 * @return true if the device is open
 */
bool
audio_output_update(struct audio_output *ao,
		    const struct audio_format *audio_format);

/**
 * Wakes up the audio output thread.  This is part of a workaround for
 * a deadlock bug, and should be removed as soon as the real cause is
 * fixed.  XXX
 */
void
audio_output_signal(struct audio_output *ao);

void
audio_output_play(struct audio_output *ao, const void *chunk, size_t size);

void audio_output_pause(struct audio_output *ao);

void audio_output_cancel(struct audio_output *ao);
void audio_output_close(struct audio_output *ao);
void audio_output_finish(struct audio_output *ao);
void
audio_output_send_tag(struct audio_output *ao, const struct tag *tag);

#endif