/*
- * Copyright (C) 2006 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2007 Andre Noll <maan@systemlinux.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, USA.
+ * Licensed under the GPL v2. For licencing details see COPYING.
*/
/** \file write.h writer-related structures */
void *private_data;
/** send that many bytes in one go */
int chunk_bytes;
+ /** pointer to the group this node belongs to */
struct writer_node_group *wng;
/** the writer-specific configuration of this node */
void *conf;
+ /** how much of the wng's buffer is already written */
+ size_t written;
};
/** describes one supported writer */
* more than once with different values of \a options.
*
*/
- void * (*parse_config)(char *options);
+ void * (*parse_config)(const char *options);
/**
*
* open one instance of this writer
*
* write a chunk of audio data
*
- * This is called from the driving application whenever a data block of \a
- * chunk_bytes is available. It must return the number of bytes consumed from
- * \a data on success, and negative on errors.
- *
+ * This is called from the writer node group task's pre_select(). It
+ * may use the sched pointer to add any file descriptors or to decrease
+ * the select timeout. It must return positive on success and negative
+ * on errors.
*/
- int (*write)(char *data, size_t nbytes, struct writer_node *);
int (*pre_select)(struct sched *s, struct writer_node *wn);
+ /**
+ * Called from the post_select function of the wng task. It must keep
+ * track of the the number of bytes consumed from the wng's buffer via
+ * the wn->written variable (which may be modified by the wng handling
+ * functions). This function must return positive on success and
+ * negative on errors.
+ */
int (*post_select)(struct sched *s, struct writer_node *wn);
/**
* close one instance of the writer
unsigned num_writers;
/** array of pointers to the corresponding writer nodes */
struct writer_node *writer_nodes;
- /** keeps track of how many bytes have been written by each node */
- int *written;
/** the maximum of the chunk_bytes values of the writer nodes in this group */
size_t max_chunk_bytes;
- /** non-zero if end of file was encountered */
+ /** non-zero if end of file was encountered by the feeding task */
int *input_eof;
+ /** non-zero if end of file was encountered */
int eof;
+ /** current output buffer */
char *buf;
+ /** number of bytes loaded in the output buffer */
+ size_t *loaded;
+ /** number of audio channels of the current stream */
unsigned int *channels;
+ /** sample rate of the current stream */
unsigned int *samplerate;
- size_t *loaded;
+ /** the task associated to this group */
struct task task;
};