]> code.delx.au - pulseaudio/blobdiff - src/pulsecore/source-output.h
sink-input, source-output: Assign to volume from only one place
[pulseaudio] / src / pulsecore / source-output.h
index 4bcddbaf499e4f8d95702122ba932a23c80c2816..27d6fd451d8fd7f814ad145a6d96e4fd92d9e0bb 100644 (file)
 typedef struct pa_source_output pa_source_output;
 
 #include <pulse/sample.h>
-#include <pulsecore/source.h>
 #include <pulse/format.h>
 #include <pulsecore/memblockq.h>
 #include <pulsecore/resampler.h>
 #include <pulsecore/module.h>
 #include <pulsecore/client.h>
+#include <pulsecore/source.h>
+#include <pulsecore/core.h>
 #include <pulsecore/sink-input.h>
 
 typedef enum pa_source_output_state {
@@ -42,7 +43,7 @@ typedef enum pa_source_output_state {
     PA_SOURCE_OUTPUT_UNLINKED
 } pa_source_output_state_t;
 
-static inline pa_bool_t PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_state_t x) {
+static inline bool PA_SOURCE_OUTPUT_IS_LINKED(pa_source_output_state_t x) {
     return x == PA_SOURCE_OUTPUT_RUNNING || x == PA_SOURCE_OUTPUT_CORKED;
 }
 
@@ -86,8 +87,6 @@ struct pa_source_output {
     pa_channel_map channel_map;
     pa_format_info *format;
 
-    pa_source_output *sync_prev, *sync_next;
-
     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
     pa_cvolume volume;             /* The volume clients are informed about */
     pa_cvolume reference_ratio;    /* The ratio of the stream's volume to the source's reference volume */
@@ -97,15 +96,15 @@ struct pa_source_output {
 
     pa_cvolume volume_factor_source; /* A second volume factor in format of the source this stream is connected to */
 
-    pa_bool_t volume_writable:1;
+    bool volume_writable:1;
 
-    pa_bool_t muted:1;
+    bool muted:1;
 
-    /* if TRUE then the source we are connected to and/or the volume
+    /* if true then the source we are connected to and/or the volume
      * set is worth remembering, i.e. was explicitly chosen by the
      * user and not automatically. module-stream-restore looks for
      * this.*/
-    pa_bool_t save_source:1, save_volume:1, save_muted:1;
+    bool save_source:1, save_volume:1, save_muted:1;
 
     pa_resample_method_t requested_resample_method, actual_resample_method;
 
@@ -125,11 +124,11 @@ struct pa_source_output {
      * changes. Called from IO context. */
     void (*update_source_requested_latency) (pa_source_output *o); /* may be NULL */
 
-    /* Called whenver the latency range of the source changes. Called
+    /* Called whenever the latency range of the source changes. Called
      * from IO context. */
     void (*update_source_latency_range) (pa_source_output *o); /* may be NULL */
 
-    /* Called whenver the fixed latency of the source changes, if there
+    /* Called whenever the fixed latency of the source changes, if there
      * is one. Called from IO context. */
     void (*update_source_fixed_latency) (pa_source_output *i); /* may be NULL */
 
@@ -146,11 +145,11 @@ struct pa_source_output {
 
     /* If non-NULL called whenever the source this output is attached
      * to suspends or resumes. Called from main context */
-    void (*suspend) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
+    void (*suspend) (pa_source_output *o, bool b);   /* may be NULL */
 
     /* If non-NULL called whenever the source this output is attached
      * to suspends or resumes. Called from IO context */
-    void (*suspend_within_thread) (pa_source_output *o, pa_bool_t b);   /* may be NULL */
+    void (*suspend_within_thread) (pa_source_output *o, bool b);   /* may be NULL */
 
     /* If non-NULL called whenever the source output is moved to a new
      * source. Called from main context after the source output has been
@@ -164,7 +163,7 @@ struct pa_source_output {
      * context. */
     void (*kill)(pa_source_output* o);              /* may NOT be NULL */
 
-    /* Return the current latency (i.e. length of bufferd audio) of
+    /* Return the current latency (i.e. length of buffered audio) of
     this stream. Called from main context. This is added to what the
     PA_SOURCE_OUTPUT_MESSAGE_GET_LATENCY message sent to the IO thread
     returns */
@@ -175,9 +174,9 @@ struct pa_source_output {
     void (*state_change) (pa_source_output *o, pa_source_output_state_t state); /* may be NULL */
 
     /* If non-NULL this function is called before this source output
-     * is moved to a source and if it returns FALSE the move
+     * is moved to a source and if it returns false the move
      * will not be allowed */
-    pa_bool_t (*may_move_to) (pa_source_output *o, pa_source *s); /* may be NULL */
+    bool (*may_move_to) (pa_source_output *o, pa_source *s); /* may be NULL */
 
     /* If non-NULL this function is used to dispatch asynchronous
      * control events. */
@@ -195,9 +194,9 @@ struct pa_source_output {
         pa_source_output_state_t state;
 
         pa_cvolume soft_volume;
-        pa_bool_t muted:1;
+        bool muted:1;
 
-        pa_bool_t attached:1; /* True only between ->attach() and ->detach() calls */
+        bool attached:1; /* True only between ->attach() and ->detach() calls */
 
         pa_sample_spec sample_spec;
 
@@ -207,8 +206,6 @@ struct pa_source_output {
          * don't implement rewind() */
         pa_memblockq *delay_memblockq;
 
-        pa_source_output *sync_prev, *sync_next;
-
         /* The requested latency for the source */
         pa_usec_t requested_source_latency;
 
@@ -253,8 +250,6 @@ typedef struct pa_source_output_new_data {
 
     pa_resample_method_t resample_method;
 
-    pa_source_output *sync_base;
-
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
     pa_format_info *format;
@@ -262,31 +257,31 @@ typedef struct pa_source_output_new_data {
     pa_idxset *nego_formats;
 
     pa_cvolume volume, volume_factor, volume_factor_source;
-    pa_bool_t muted:1;
+    bool muted:1;
 
-    pa_bool_t sample_spec_is_set:1;
-    pa_bool_t channel_map_is_set:1;
+    bool sample_spec_is_set:1;
+    bool channel_map_is_set:1;
 
-    pa_bool_t volume_is_set:1, volume_factor_is_set:1, volume_factor_source_is_set:1;
-    pa_bool_t muted_is_set:1;
+    bool volume_is_set:1, volume_factor_is_set:1, volume_factor_source_is_set:1;
+    bool muted_is_set:1;
 
-    pa_bool_t volume_is_absolute:1;
+    bool volume_is_absolute:1;
 
-    pa_bool_t volume_writable:1;
+    bool volume_writable:1;
 
-    pa_bool_t save_source:1, save_volume:1, save_muted:1;
+    bool save_source:1, save_volume:1, save_muted:1;
 } pa_source_output_new_data;
 
 pa_source_output_new_data* pa_source_output_new_data_init(pa_source_output_new_data *data);
 void pa_source_output_new_data_set_sample_spec(pa_source_output_new_data *data, const pa_sample_spec *spec);
 void pa_source_output_new_data_set_channel_map(pa_source_output_new_data *data, const pa_channel_map *map);
-pa_bool_t pa_source_output_new_data_is_passthrough(pa_source_output_new_data *data);
+bool pa_source_output_new_data_is_passthrough(pa_source_output_new_data *data);
 void pa_source_output_new_data_set_volume(pa_source_output_new_data *data, const pa_cvolume *volume);
 void pa_source_output_new_data_apply_volume_factor(pa_source_output_new_data *data, const pa_cvolume *volume_factor);
 void pa_source_output_new_data_apply_volume_factor_source(pa_source_output_new_data *data, const pa_cvolume *volume_factor);
-void pa_source_output_new_data_set_muted(pa_source_output_new_data *data, pa_bool_t mute);
-pa_bool_t pa_source_output_new_data_set_source(pa_source_output_new_data *data, pa_source *s, pa_bool_t save);
-pa_bool_t pa_source_output_new_data_set_formats(pa_source_output_new_data *data, pa_idxset *formats);
+void pa_source_output_new_data_set_muted(pa_source_output_new_data *data, bool mute);
+bool pa_source_output_new_data_set_source(pa_source_output_new_data *data, pa_source *s, bool save);
+bool pa_source_output_new_data_set_formats(pa_source_output_new_data *data, pa_idxset *formats);
 void pa_source_output_new_data_done(pa_source_output_new_data *data);
 
 /* To be called by the implementing module only */
@@ -303,26 +298,27 @@ void pa_source_output_set_name(pa_source_output *o, const char *name);
 
 pa_usec_t pa_source_output_set_requested_latency(pa_source_output *o, pa_usec_t usec);
 
-void pa_source_output_cork(pa_source_output *o, pa_bool_t b);
+void pa_source_output_cork(pa_source_output *o, bool b);
 
 int pa_source_output_set_rate(pa_source_output *o, uint32_t rate);
+int pa_source_output_update_rate(pa_source_output *o);
 
 size_t pa_source_output_get_max_rewind(pa_source_output *o);
 
 /* Callable by everyone */
 
-/* External code may request disconnection with this funcion */
+/* External code may request disconnection with this function */
 void pa_source_output_kill(pa_source_output*o);
 
 pa_usec_t pa_source_output_get_latency(pa_source_output *o, pa_usec_t *source_latency);
 
-pa_bool_t pa_source_output_is_volume_readable(pa_source_output *o);
-pa_bool_t pa_source_output_is_passthrough(pa_source_output *o);
-void pa_source_output_set_volume(pa_source_output *o, const pa_cvolume *volume, pa_bool_t save, pa_bool_t absolute);
-pa_cvolume *pa_source_output_get_volume(pa_source_output *o, pa_cvolume *volume, pa_bool_t absolute);
+bool pa_source_output_is_volume_readable(pa_source_output *o);
+bool pa_source_output_is_passthrough(pa_source_output *o);
+void pa_source_output_set_volume(pa_source_output *o, const pa_cvolume *volume, bool save, bool absolute);
+pa_cvolume *pa_source_output_get_volume(pa_source_output *o, pa_cvolume *volume, bool absolute);
 
-void pa_source_output_set_mute(pa_source_output *o, pa_bool_t mute, pa_bool_t save);
-pa_bool_t pa_source_output_get_mute(pa_source_output *o);
+void pa_source_output_set_mute(pa_source_output *o, bool mute, bool save);
+bool pa_source_output_get_mute(pa_source_output *o);
 
 void pa_source_output_update_proplist(pa_source_output *o, pa_update_mode_t mode, pa_proplist *p);
 
@@ -330,15 +326,15 @@ pa_resample_method_t pa_source_output_get_resample_method(pa_source_output *o);
 
 void pa_source_output_send_event(pa_source_output *o, const char *name, pa_proplist *data);
 
-pa_bool_t pa_source_output_may_move(pa_source_output *o);
-pa_bool_t pa_source_output_may_move_to(pa_source_output *o, pa_source *dest);
-int pa_source_output_move_to(pa_source_output *o, pa_source *dest, pa_bool_t save);
+bool pa_source_output_may_move(pa_source_output *o);
+bool pa_source_output_may_move_to(pa_source_output *o, pa_source *dest);
+int pa_source_output_move_to(pa_source_output *o, pa_source *dest, bool save);
 
-/* The same as pa_source_output_move_to() but in two seperate steps,
+/* The same as pa_source_output_move_to() but in two separate steps,
  * first the detaching from the old source, then the attaching to the
  * new source */
 int pa_source_output_start_move(pa_source_output *o);
-int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, pa_bool_t save);
+int pa_source_output_finish_move(pa_source_output *o, pa_source *dest, bool save);
 void pa_source_output_fail_move(pa_source_output *o);
 
 #define pa_source_output_get_state(o) ((o)->state)
@@ -357,6 +353,13 @@ int pa_source_output_process_msg(pa_msgobject *mo, int code, void *userdata, int
 
 pa_usec_t pa_source_output_set_requested_latency_within_thread(pa_source_output *o, pa_usec_t usec);
 
+/* Called from the main thread, from source.c only. The normal way to set the
+ * source output volume is to call pa_source_output_set_volume(), but the flat
+ * volume logic in source.c needs also a function that doesn't do all the extra
+ * stuff that pa_source_output_set_volume() does. This function simply sets
+ * o->volume and fires change notifications. */
+void pa_source_output_set_volume_direct(pa_source_output *o, const pa_cvolume *volume);
+
 #define pa_source_output_assert_io_context(s) \
     pa_assert(pa_thread_mq_get() || !PA_SOURCE_OUTPUT_IS_LINKED((s)->state))