/* 2004.02.01 first released source code for IOMP */ /* * Copyright (C) 2000-2002 the xine project * * This file is part of xine, a free video player. * * xine 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. * * xine 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 * * $Id: audio_out.h,v 1.2 2003/11/25 04:21:48 georgedon Exp $ */ #ifndef HAVE_AUDIO_OUT_H #define HAVE_AUDIO_OUT_H #ifdef __cplusplus extern "C" { #endif #include #if defined(XINE_COMPILE) #include "metronom.h" #include "configfile.h" #include "xineutils.h" #else #include #include #include #endif #define AUDIO_OUT_IFACE_VERSION 7 /* * ao_driver_s contains the driver every audio output * driver plugin has to implement. */ typedef struct ao_driver_s ao_driver_t; struct ao_driver_s { /* * * find out what output modes + capatilities are supported by * this plugin (constants for the bit vector to return see above) * * See AO_CAP_* bellow. */ uint32_t (*get_capabilities) (ao_driver_t *); /* * open the driver and make it ready to receive audio data * buffers may be flushed(!) * * return value: 0 : failure, >0 : output sample rate */ int (*open)(ao_driver_t *, uint32_t bits, uint32_t rate, int mode); /* return the number of audio channels */ int (*num_channels)(ao_driver_t *self_gen); /* return the number of bytes per frame. * A frame is equivalent to one sample being output on every audio channel. */ int (*bytes_per_frame)(ao_driver_t *self_gen); /* return the delay is frames measured by * looking at pending samples in the audio output device */ int (*delay)(ao_driver_t *self_gen); /* * return gap tolerance (in pts) needed for this driver */ int (*get_gap_tolerance) (ao_driver_t *self_gen); /* * write audio data to output buffer * audio driver must sync sample playback with metronom * return value: * >0 => audio samples were processed ok * 0 => audio samples were not yet processed, * call write_audio_data with the _same_ samples again */ int (*write)(ao_driver_t *, int16_t* audio_data, uint32_t num_samples); /* * this is called when the decoder no longer uses the audio * output driver - the driver should get ready to get opened() again */ void (*close)(ao_driver_t *); /* * shut down this audio output driver plugin and * free all resources allocated */ void (*exit) (ao_driver_t *); /* * Get, Set a property of audio driver. * * get_property() return 1 in success, 0 on failure. * set_property() return value on success, ~value on failure. * * See AO_PROP_* below for available properties. */ int (*get_property) (ao_driver_t *, int property); int (*set_property) (ao_driver_t *, int property, int value); /* * misc control operations on the audio device. * * See AO_CTRL_* below. */ int (*control) (ao_driver_t *, int cmd, /* arg */ ...); void *node; }; /* to access extra_info_t contents one have to include xine_internal.h */ #ifndef EXTRA_INFO #define EXTRA_INFO typedef struct extra_info_s extra_info_t; #endif typedef struct ao_format_s ao_format_t; struct ao_format_s { uint32_t bits; uint32_t rate; int mode; }; typedef struct audio_fifo_s audio_fifo_t; typedef struct audio_buffer_s audio_buffer_t; struct audio_buffer_s { audio_buffer_t *next; int16_t *mem; int mem_size; int num_frames; int64_t vpts; uint32_t frame_header_count; uint32_t first_access_unit; /* extra info coming from input or demuxers */ extra_info_t *extra_info; xine_stream_t *stream; /* stream that send that buffer */ ao_format_t format; /* let each buffer carry it's own format info */ }; /* * xine_audio_port_s contains the port every audio decoder talks to * * Remember that adding new functions to this structure requires * adaption of the post plugin decoration layer. Be sure to look into * src/xine-engine/post.[ch]. */ struct xine_audio_port_s { uint32_t (*get_capabilities) (xine_audio_port_t *); /* for constants see below */ /* * Get/Set audio property * * See AO_PROP_* bellow */ int (*get_property) (xine_audio_port_t *, int property); int (*set_property) (xine_audio_port_t *, int property, int value); /* open audio driver for audio output * return value: 0:failure, >0:output sample rate */ int (*open) (xine_audio_port_t *, xine_stream_t *stream, uint32_t bits, uint32_t rate, int mode); /* * get a piece of memory for audio data */ audio_buffer_t * (*get_buffer) (xine_audio_port_t *); /* * append a buffer filled with audio data to the audio fifo * for output */ void (*put_buffer) (xine_audio_port_t *, audio_buffer_t *buf, xine_stream_t *stream); /* audio driver is no longer used by decoder => close */ void (*close) (xine_audio_port_t *self, xine_stream_t *stream); /* called on xine exit */ void (*exit) (xine_audio_port_t *); /* * misc control operations on the audio device. * * See AO_CTRL_* below. */ int (*control) (xine_audio_port_t *, int cmd, /* arg */ ...); /* * Flush audio_out fifo. */ void (*flush) (xine_audio_port_t *); /* * Check if port is opened for this stream and get parameters. */ int (*status) (xine_audio_port_t *, xine_stream_t *stream, uint32_t *bits, uint32_t *rate, int *mode); }; typedef struct audio_driver_class_s audio_driver_class_t; struct audio_driver_class_s { /* * open a new instance of this plugin class */ ao_driver_t* (*open_plugin) (audio_driver_class_t *, const void *data); /* * return short, human readable identifier for this plugin class */ char* (*get_identifier) (audio_driver_class_t *); /* * return human readable (verbose = 1 line) description for * this plugin class */ char* (*get_description) (audio_driver_class_t *); /* * free all class-related resources */ void (*dispose) (audio_driver_class_t *); }; /* * this initiates the audio_out sync routines * found in ./src/xine-engine/audio_out.c */ xine_audio_port_t *ao_new_port (xine_t *xine, ao_driver_t *driver, int grab_only) ; /* * audio output modes + capabilities */ #define AO_CAP_NOCAP 0x00000000 /* driver has no capabilities */ #define AO_CAP_MODE_A52 0x00000001 /* driver supports A/52 output */ #define AO_CAP_MODE_AC5 0x00000002 /* driver supports AC5 output */ /* 1 sample == 2 bytes (C) */ #define AO_CAP_MODE_MONO 0x00000004 /* driver supports mono output */ /* 1 sample == 4 bytes (L,R) */ #define AO_CAP_MODE_STEREO 0x00000008 /* driver supports stereo output */ /* 1 sample == 8 bytes (L,R,LR,RR) */ #define AO_CAP_MODE_4CHANNEL 0x00000010 /* driver supports 4 channels */ /* * Sound cards generally support, 1,2,4,6 channels, but rarely 5. * So xine will take 4.1, 5 and 6 channel a52 streams and * down or upmix it correctly to fill the 6 output channels. * Are there any requests for 2.1 out there? */ /* 1 sample == 12 bytes (L,R,LR,RR,Null,LFE) */ #define AO_CAP_MODE_4_1CHANNEL 0x00000020 /* driver supports 4.1 channels */ /* 1 sample == 12 bytes (L,R,LR,RR,C, Null) */ #define AO_CAP_MODE_5CHANNEL 0x00000040 /* driver supports 5 channels */ /* 1 sample == 12 bytes (L,R,LR,RR,C,LFE) */ #define AO_CAP_MODE_5_1CHANNEL 0x00000080 /* driver supports 5.1 channels */ #define AO_CAP_MIXER_VOL 0x00000100 /* driver supports mixer control */ #define AO_CAP_PCM_VOL 0x00000200 /* driver supports pcm control */ #define AO_CAP_MUTE_VOL 0x00000400 /* driver can mute volume */ #define AO_CAP_8BITS 0x00000800 /* driver support 8-bit samples */ /* properties supported by get/set_property() */ #define AO_PROP_MIXER_VOL 0 #define AO_PROP_PCM_VOL 1 #define AO_PROP_MUTE_VOL 2 #define AO_PROP_COMPRESSOR 3 #define AO_PROP_DISCARD_BUFFERS 4 #define AO_PROP_PAUSED 5 #define AO_PROP_AMP 6 /* amplifier */ #define AO_PROP_EQ_30HZ 7 /* equalizer */ #define AO_PROP_EQ_60HZ 8 /* equalizer */ #define AO_PROP_EQ_125HZ 9 /* equalizer */ #define AO_PROP_EQ_250HZ 10 /* equalizer */ #define AO_PROP_EQ_500HZ 11 /* equalizer */ #define AO_PROP_EQ_1000HZ 12 /* equalizer */ #define AO_PROP_EQ_2000HZ 13 /* equalizer */ #define AO_PROP_EQ_4000HZ 14 /* equalizer */ #define AO_PROP_EQ_8000HZ 15 /* equalizer */ #define AO_PROP_EQ_16000HZ 16 /* equalizer */ #define AO_PROP_CLOSE_DEVICE 17 /* force closing audio device */ /* audio device control ops */ #define AO_CTRL_PLAY_PAUSE 0 #define AO_CTRL_PLAY_RESUME 1 #define AO_CTRL_FLUSH_BUFFERS 2 /* above that value audio frames are discarded */ #define AO_MAX_GAP 15000 #ifdef __cplusplus } #endif #endif