document all PCM plugin parameters

diff --git a/src/pcm/pcm_adpcm.c b/src/pcm/pcm_adpcm.c
index 1b824a9f38e719cf886b5299eebfaa81575075cf..fa4299729ea44c56b260de3fb0ce4047da739e3b 100644 (file)
--- a/src/pcm/pcm_adpcm.c
+++ b/src/pcm/pcm_adpcm.c
@@ -588,7 +588,7 @@ int snd_pcm_adpcm_open(snd_pcm_t **pcmp, const char *name, snd_pcm_format_t sfor
 
 \section pcm_plugins_adpcm Plugin: Ima-ADPCM
 
-This plugin converts Ima-ADPCM samples to linear or linear to Mu-Law samples
+This plugin converts Ima-ADPCM samples to linear or linear to Ima-ADPCM samples
 from master Ima-ADPCM conversion PCM to given slave PCM. The channel count,
 format and rate must match for both of them.
 
@@ -601,6 +601,7 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                format STR      # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_alaw.c b/src/pcm/pcm_alaw.c
index d3f5a876fc517b4ea48710ed1142448dd1d81ec7..c8c6cc9a56dd32afc76e7b206f8bb280ad966e1a 100644 (file)
--- a/src/pcm/pcm_alaw.c
+++ b/src/pcm/pcm_alaw.c
@@ -473,6 +473,7 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                format STR      # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_dmix.c b/src/pcm/pcm_dmix.c
index 309514e930889ed2a72c5813b35cdb30ba84be0f..15954cdb708351cbfe9b77455c338918423d506d 100644 (file)
--- a/src/pcm/pcm_dmix.c
+++ b/src/pcm/pcm_dmix.c
@@ -991,6 +991,7 @@ pcm.name {
        type dmix               # Direct mix
        ipc_key INT             # unique IPC key
        ipc_key_add_uid BOOL    # add current uid to unique IPC key
+       ipc_perm INT            # IPC permissions (octal, default 0600)
        slave STR
        # or
        slave {                 # Slave definition
@@ -1011,6 +1012,7 @@ pcm.name {
        bindings {              # note: this is client independent!!!
                N INT           # maps slave channel to client channel N
        }
+       slowptr BOOL            # slow but more precise pointer updates
 }
 \endcode
 

diff --git a/src/pcm/pcm_dshare.c b/src/pcm/pcm_dshare.c
index fe729cec60f039096dcf79858b708ab992fd1c7d..4aa3848e00946bf9f144a509c9806efffa167a3c 100644 (file)
--- a/src/pcm/pcm_dshare.c
+++ b/src/pcm/pcm_dshare.c
@@ -727,6 +727,7 @@ pcm.name {
        type dshare             # Direct sharing
        ipc_key INT             # unique IPC key
        ipc_key_add_uid BOOL    # add current uid to unique IPC key
+       ipc_perm INT            # IPC permissions (octal, default 0600)
        slave STR
        # or
        slave {                 # Slave definition
@@ -747,6 +748,7 @@ pcm.name {
        bindings {              # note: this is client independent!!!
                N INT           # maps slave channel to client channel N
        }
+       slowptr BOOL            # slow but more precise pointer updates
 }
 \endcode
 

diff --git a/src/pcm/pcm_dsnoop.c b/src/pcm/pcm_dsnoop.c
index 6e2195588970eeee5239152844c4b94370a9fc2f..6678961288225557a1c46ab44d47d0b2f1fa6ae8 100644 (file)
--- a/src/pcm/pcm_dsnoop.c
+++ b/src/pcm/pcm_dsnoop.c
@@ -677,6 +677,7 @@ pcm.name {
        type dsnoop             # Direct snoop
        ipc_key INT             # unique IPC key
        ipc_key_add_uid BOOL    # add current uid to unique IPC key
+       ipc_perm INT            # IPC permissions (octal, default 0600)
        slave STR
        # or
        slave {                 # Slave definition
@@ -697,6 +698,7 @@ pcm.name {
        bindings {              # note: this is client independent!!!
                N INT           # maps slave channel to client channel N
        }
+       slowptr BOOL            # slow but more precise pointer updates
 }
 \endcode
 

diff --git a/src/pcm/pcm_lfloat.c b/src/pcm/pcm_lfloat.c
index 83ab865edfe14f94c7e84b3455005aceb3cd86a4..218d6c4551d32234fe744924df0b62d14246bee5 100644 (file)
--- a/src/pcm/pcm_lfloat.c
+++ b/src/pcm/pcm_lfloat.c
@@ -432,6 +432,7 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                format STR      # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_linear.c b/src/pcm/pcm_linear.c
index a995d5c9f5f89bdf7fe386c92b2af41437c26263..27b7bfa10850c6ea67534611435b938708d8ca08 100644 (file)
--- a/src/pcm/pcm_linear.c
+++ b/src/pcm/pcm_linear.c
@@ -488,6 +488,7 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                format STR      # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_mulaw.c b/src/pcm/pcm_mulaw.c
index ea2b4fe06d221e5f4287531f51055644f347741b..8d9baf73c6fdb7e3c870d9882183176f0b579265 100644 (file)
--- a/src/pcm/pcm_mulaw.c
+++ b/src/pcm/pcm_mulaw.c
@@ -488,6 +488,7 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                format STR      # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_rate.c b/src/pcm/pcm_rate.c
index 9ba28e25626e32915da23ebad527265b39c2a86b..68025750b35923de1ae9d7e11a441b5eeca74b15 100644 (file)
--- a/src/pcm/pcm_rate.c
+++ b/src/pcm/pcm_rate.c
@@ -1428,6 +1428,8 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                rate INT        # Slave rate
+                [format STR]    # Slave format
         }
 }
 \endcode

diff --git a/src/pcm/pcm_route.c b/src/pcm/pcm_route.c
index 9c6a7b0794148f4165ffcbd44274485fd18f8885..ea37abbe996aeb5c0162813cb5879f76ed99576f 100644 (file)
--- a/src/pcm/pcm_route.c
+++ b/src/pcm/pcm_route.c
@@ -1047,6 +1047,13 @@ pcm.name {
                 pcm STR         # Slave PCM name
                 # or
                 pcm { }         # Slave PCM definition
+                [format STR]    # Slave format
+                [channels INT]  # Slave channels
+        }
+        ttable {                # Transfer table (bi-dimensional compound of cchannels * schannels numbers)
+                CCHANNEL {
+                        SCHANNEL REAL   # route value (0.0 - 1.0)
+                }
         }
 }
 \endcode

diff --git a/src/pcm/pcm_share.c b/src/pcm/pcm_share.c
index 6e1001e816ea824f1053a051261b2cfb71799c82..deecbcbc8fec3dba3775baab9c2a324f3fed8678 100644 (file)
--- a/src/pcm/pcm_share.c
+++ b/src/pcm/pcm_share.c
@@ -1515,6 +1515,11 @@ pcm.name {
         # or
         slave {                 # Slave definition
                 pcm STR         # Slave PCM name
+                [format STR]    # Slave format
+                [channels INT]  # Slave channels
+                [rate INT]      # Slave rate
+                [period_time INT] # Slave period time in us
+                [buffer_time INT] # Slave buffer time in us
         }
        bindings {
                N INT           # Slave channel INT for client channel N