/usr/include/alsaplayer/output_plugin.h is in libalsaplayer-dev 0.99.81-1ubuntu3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 | /* output_plugin.h
* Copyright (C) 1999-2002 Andy Lo A Foe <andy@alsaplayer.org>
*
* This file is part of AlsaPlayer.
*
* AlsaPlayer 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 3 of the License, or
* (at your option) any later version.
*
* AlsaPlayer 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, see <http://www.gnu.org/licenses/>.
*
* $Id: output_plugin.h 1344 2010-11-07 20:38:05Z dominique_libre $
*
*/
#ifndef __output_plugin_h__
#define __output_plugin_h__
#define OUTPUT_PLUGIN_BASE_VERSION 0x1000
#define OUTPUT_PLUGIN_VERSION (OUTPUT_PLUGIN_BASE_VERSION + 6)
typedef int output_version_type;
typedef int(*output_init_type)(void);
typedef int(*output_open_type)(const char *path);
typedef void(*output_close_type)(void);
typedef int(*output_write_type)(void *data, int byte_count);
typedef int(*output_start_callbacks_type)(void *data);
typedef int(*output_set_buffer_type)(int *frag_size, int *frag_count, int *channels);
typedef unsigned int(*output_set_sample_rate_type)(unsigned int rate);
typedef int(*output_get_queue_count_type)(void);
typedef int(*output_get_latency_type)(void);
typedef struct _output_plugin
{
/**
* Version of output plugin. Must be OUTPUT_PLUGIN_VERSION
*/
output_version_type version;
/**
* Name of output plugin
*/
const char *name;
/**
* Author of the plugin
*/
const char *author;
/**
* Initialize output plugin. Called before the plugin is
* opened for use
*/
output_init_type init;
/**
* @param path The path or device designation that should be used
*
* Opens the output plugin. A value of 1 should be returned on
* success, 0 on failure.
*/
output_open_type open;
/**
* Close the output plugin
*/
output_close_type close;
/**
* @param data Buffer that contains the data
* @byte_count Number of bytes that should be read from the buffer
*
* Write out data to the output device. This is a byte count and
* will typically be the same size as a fragment. A value of 1 should
* be returned on success, 0 on failure.
*/
output_write_type write;
/**
* @param data pointer to bufs structure in AlsaNode
*
* This function is used for callback based plugins like JACK
*/
output_start_callbacks_type start_callbacks;
/**
* @param frag_size Fragment size to use (in bytes)
* @param frag_count Fragment count to use (in bytes)
* @param channels Number of channels to use
*
* Set up the output device with the given parameters. Some output
* devices do not accept such configurations in which case they
* should just be ignored, but still expect frag_size data chunks
* in the write function. A value of 1 should be returned on success,
* 0 on failure.
*/
output_set_buffer_type set_buffer;
/**
* @param rate Sample rate to use
*
* Set the sample rate of the output device. A value of 1 should be
* returned on success, 0 on failure.
*/
output_set_sample_rate_type set_sample_rate;
/**
* Returns the number of bytes pending in the hardware buffer of
* output device. This function is optional.
*/
output_get_queue_count_type get_queue_count;
/**
* Returns the latency of the output device in bytes. This function
* is optional.
*/
output_get_latency_type get_latency;
} output_plugin;
typedef output_plugin*(*output_plugin_info_type)(void);
#endif
|