Changeset 33 for pa_proposals/trunk

Timestamp:

10/17/02 20:01:30 (6 years ago)

Author:

rossbencina

Message:

updated v19-devel status references
minor naming corrections
minor formatting edits

Files:

• pa_proposals/trunk/008-HostAPISpecificOpenStreamParameters.html (modified) (12 diffs)

pa_proposals/trunk/008-HostAPISpecificOpenStreamParameters.html

@@ -18 +18 @@
 <P><A href="index.html">Enhancement Proposals Index</A>,
 <A href="http://www.portaudio.com/">PortAudio Home Page</A></P>
-<P>Updated: July 31, 2002 </P>
+<P>Updated: October 18, 2002 </P>
 
 
@@ -24 +24 @@
 
 <P>
-This proposal is sufficiently well defined to be implemented. It has been partially implemented
-in v19-devel, however the current proposal no longer utilises the PaHostApiSpecificStreamInfo
-structure currently used in v19-devel.
+This proposal is sufficiently well defined to be implemented. It has been implemented
+in v19-devel.
 </P>
 <H4>Dependencies</H4>
@@ -33 +32 @@
 If the PaHostApiSpecificStreamInfo structure defined in this proposal includes a PaHostApiTypeId host API identifier, then this proposal depends on the 
 <A HREF="007-MultipleHostAPIsInASingleBuild.html">007 - Support for Multiple Host APIs in a Single PortAudio Build</A>
-
 proposal to define the form of the identifier.
 </P>
@@ -40 +38 @@
 
 <P>
-Pa_OpenStream has always had inputDriverInfo and outputDriverInfo parameters, which were defined to support passing host API specific information to PortAudio implementations. Currently these parameters are defined as void* and are not used by any implementation. Two uses of inputDriverInfo and outputDriverInfo are planned for the near future: passing device names to OSS drivers, and passing additional device ids for opening multichannel soundcards under MME.
+Pa_OpenStream has always had inputDriverInfo and outputDriverInfo parameters, which were defined to support passing host API specific information to PortAudio implementations. Currently (V18) these parameters are defined as void* and are not used by any implementation. Two uses of inputDriverInfo and outputDriverInfo are planned for the near future: passing device names to OSS drivers, and passing additional device ids for addressing multichannel soundcards under MME.
 </P>
 
@@ -46 +44 @@
 
 <P>
-The inputDriverInfo and outputDriverInfo to Pa_OpenStream() will be renamed inputStreamInfo and outputStreamInfo.
+The inputDriverInfo and outputDriverInfo fields to Pa_OpenStream() will be moved to the PaStreamParameters structure described in <A HREF="016-UseStructsForOpenStreamParameters.html">016 - Use Structs for Pa_OpenStream() Parameters</A>. The equivalent field in this structure will be a void* field named hostApiSpecificStreamInfo.
 </P>
 
@@ -55 +53 @@
 
 <PRE>
-#define paNullStreamInfo ((void*)0)
-</P>
+#define paNullHostApiSpecificStreamInfo ((void*)0)
+</PRE>
 
 <P>
@@ -65 +63 @@
 
 <PRE>
-unsigned long size;    /* size of whole structure including this header */
+unsigned long size;          /* size of whole structure including this header */
 PaHostApiTypeId hostApiType; /* host API for which this data is intended */
-unsigned long version; /* structure version */
+unsigned long version;       /* structure version */
 </PRE>
 
@@ -84 +82 @@
 <PRE>
 struct{
-    unsigned long size;    /* size of whole structure including this header */
-        PaHostApiTypeId hostApiType; /* host API for which this data is intended */
-        unsigned long version; /* structure version */
+    unsigned long size;          /* size of whole structure including this header */
+    PaHostApiTypeId hostApiType; /* host API for which this data is intended */
+    unsigned long version;       /* structure version */
 
     char *deviceName;
-}PaOSSSpecificStreamInfo;
+}PaOssSpecificStreamInfo;
 </PRE>
 
@@ -128 +126 @@
 
 typedef struct PaWinMmeStreamInfo{
-    unsigned long size;    /* size of whole structure including this header */
-        PaHostApiTypeId hostApiType; /* host API for which this data is intended */
-        unsigned long version; /* structure version */
+    unsigned long size;          /* size of whole structure including this header */
+    PaHostApiTypeId hostApiType; /* host API for which this data is intended */
+    unsigned long version;       /* structure version */
 
     unsigned long flags;
@@ -169 +167 @@
 <PRE>
 struct{
-    unsigned long size;    /* size of whole structure including this header */
+    unsigned long size;          /* size of whole structure including this header */
     PaHostApiTypeId hostApiType; /* host API for which this data is intended */
-    unsigned long version; /* structure version */
+    unsigned long version;       /* structure version */
 }PaHostApiSpecificStreamInfo;
 </PRE>
@@ -183 +181 @@
 <P>
 When PaHostApiSpecificStreamInfo was still declared, we intended to change the type of the
-streamInfor parameters from void* to PaHostApiSpecificStreamInfo*. Some objections were raised 
-to this, as it may have required clients to explicitly cast to PaHostAPISpecificInfo* when passing NULL. However the added semantic and type safety advantages were considered more valuable. The current
-proposal leaves these parameters as NULL.
+streamInfo parameters from void* to PaHostApiSpecificStreamInfo*. Some objections were raised 
+to this, as it may have required clients to explicitly cast to PaHostAPISpecificInfo* when passing NULL. However the added semantic and type safety advantages were considered more valuable. The current proposal leaves these parameters as void*.
 </P>
 
@@ -196 +193 @@
 
 <P>
-This proposal provides access to new platform-specific extensions. No existing client code will be modified. Only implementations that implement the extensions will be effected. Depending on the compiler used, clients passing NULL for inputStreamInfo and outputStreamInfo may need to explicitly cast to (PaHostAPISpecificInfo*).
+This proposal provides access to new platform-specific extensions. No existing client code will be modified. Only implementations that implement the extensions will be effected.
 </P>