]> code.delx.au - pulseaudio/blobdiff - polyp/sample.h
add username to runtime directory name in /tmp/
[pulseaudio] / polyp / sample.h
index 912cdaa0fc3563d502677d420e9bb39c1bea323f..a02a50feccbc31034b4615cf28e9b64522e7e346 100644 (file)
@@ -42,7 +42,8 @@ enum pa_sample_format {
     PA_SAMPLE_S16BE,           /**< Signed 16 Bit PCM, big endian */
     PA_SAMPLE_FLOAT32LE,       /**< 32 Bit IEEE floating point, little endian, range -1..1 */
     PA_SAMPLE_FLOAT32BE,       /**< 32 Bit IEEE floating point, big endian, range -1..1 */
-    PA_SAMPLE_MAX              /**< Upper limit of valid sample types */
+    PA_SAMPLE_MAX,             /**< Upper limit of valid sample types */
+    PA_SAMPLE_INVALID = -1     /**< An invalid value */
 };
 
 #ifdef WORDS_BIGENDIAN
@@ -67,10 +68,10 @@ struct pa_sample_spec {
     uint8_t channels;              /**< Audio channels. (1 for mono, 2 for stereo, ...) */
 };
 
-/** Type for usec specifications. May be either 32 or 64 bit, depending on the architecture */
+/** Type for usec specifications (unsigned). May be either 32 or 64 bit, depending on the architecture */
 typedef uint64_t pa_usec_t;
 
-/** Return the amount of bytes playback of a second of audio with the speicified sample type takes */
+/** Return the amount of bytes playback of a second of audio with the specified sample type takes */
 size_t pa_bytes_per_second(const struct pa_sample_spec *spec);
 
 /** Return the size of a frame with the specific sample type */
@@ -109,6 +110,12 @@ pa_volume_t pa_volume_from_dB(double f);
 /** Convert volume from linear level to decibel.  \since 0.4 */
 double pa_volume_to_dB(pa_volume_t v);
 
+/** Convert volume to scaled value understandable by the user (between 0 and 1). \since 0.6 */
+double pa_volume_to_user(pa_volume_t v);
+
+/** Convert user volume to polypaudio volume. \since 0.6 */
+pa_volume_t pa_volume_from_user(double v);
+
 #ifdef INFINITY
 #define PA_DECIBEL_MININFTY (-INFINITY)
 #else
@@ -119,6 +126,9 @@ double pa_volume_to_dB(pa_volume_t v);
 /** Pretty print a byte size value. (i.e. "2.5 MB") */
 void pa_bytes_snprint(char *s, size_t l, unsigned v);
 
+/** Parse a sample format text */
+enum pa_sample_format pa_parse_sample_format(const char *format);
+
 PA_C_DECL_END
 
 #endif