<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>AlsaPlayer: _input_object struct Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.3.3 -->
<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div>
<h1>_input_object Struct Reference</h1><code>#include <<a class="el" href="input__plugin_8h-source.html">input_plugin.h</a>></code>
<p>
<table border=0 cellpadding=0 cellspacing=0>
<tr><td></td></tr>
<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o0">ready</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o1">flags</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o2">nr_frames</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o3">nr_tracks</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o4">nr_channels</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o5">frame_size</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>void * </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o6">local_data</a></td></tr>
<tr><td class="memItemLeft" nowrap align=right valign=top>pthread_mutex_t </td><td class="memItemRight" valign=bottom><a class="el" href="struct__input__object.html#o7">object_mutex</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a structure that keeps frequently used parameters of an input instance. It also contains a pointer to any local_data that might be allocated by the plugin itself.
<p>
<hr><h2>Field Documentation</h2>
<a name="o1" doxytag="_input_object::flags"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o1">_input_object::flags</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Stream specific flags that should be set in the open() call. Read the description of the P_* definitions for details. </td>
</tr>
</table>
<a name="o5" doxytag="_input_object::frame_size"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o5">_input_object::frame_size</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The frame size in bytes. play_frame() will be called with this value. </td>
</tr>
</table>
<a name="o6" doxytag="_input_object::local_data"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> void* <a class="el" href="struct__input__object.html#o6">_input_object::local_data</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
If your plugin needs extra space for its own variables assign the allocated data structure to this pointer </td>
</tr>
</table>
<a name="o4" doxytag="_input_object::nr_channels"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o4">_input_object::nr_channels</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The number of PCM channels in the stream. Should always be 2 at this time. </td>
</tr>
</table>
<a name="o2" doxytag="_input_object::nr_frames"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o2">_input_object::nr_frames</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The total number of frames in the stream. Should be set in the open() call. </td>
</tr>
</table>
<a name="o3" doxytag="_input_object::nr_tracks"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o3">_input_object::nr_tracks</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The number of tracks, if any, in the stream. Should be set in the open() call. </td>
</tr>
</table>
<a name="o7" doxytag="_input_object::object_mutex"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> pthread_mutex_t <a class="el" href="struct__input__object.html#o7">_input_object::object_mutex</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The object mutex. Used to lock and unlock the data structures. Initialized and called from the HOST. </td>
</tr>
</table>
<a name="o0" doxytag="_input_object::ready"></a><p>
<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> int <a class="el" href="struct__input__object.html#o0">_input_object::ready</a>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Flag that should be set to 1 if your plugin is ready to accept play_frame() callback </td>
</tr>
</table>
<hr>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="input__plugin_8h-source.html">input_plugin.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Dec 9 10:09:56 2003 for AlsaPlayer by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
</a>1.3.3 </small></address>
</body>
</html>
