svolume: add some comments

[pulseaudio] / src / pulsecore / source.h

diff --git a/src/pulsecore/source.h b/src/pulsecore/source.h
index c880d3c5724ae80a3386dd684701db69281caa2c..7b3e4953561bbdacfc289c4731cdddb979dd74a8 100644 (file)
--- a/src/pulsecore/source.h
+++ b/src/pulsecore/source.h
@@ -1,8 +1,6 @@
 #ifndef foopulsesourcehfoo
 #define foopulsesourcehfoo
 
 #ifndef foopulsesourcehfoo
 #define foopulsesourcehfoo
 

-/* $Id$ */
-

 /***
   This file is part of PulseAudio.
 
 /***
   This file is part of PulseAudio.
 


@@ -11,7 +9,7 @@
 
   PulseAudio is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
 
   PulseAudio is free software; you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published

-  by the Free Software Foundation; either version 2 of the License,
+  by the Free Software Foundation; either version 2.1 of the License,

   or (at your option) any later version.
 
   PulseAudio is distributed in the hope that it will be useful, but
   or (at your option) any later version.
 
   PulseAudio is distributed in the hope that it will be useful, but


@@ -33,7 +31,6 @@ typedef struct pa_source pa_source;
 #include <pulse/channelmap.h>
 #include <pulse/volume.h>
 
 #include <pulse/channelmap.h>
 #include <pulse/volume.h>
 

-#include <pulsecore/core-def.h>

 #include <pulsecore/core.h>
 #include <pulsecore/idxset.h>
 #include <pulsecore/memblock.h>
 #include <pulsecore/core.h>
 #include <pulsecore/idxset.h>
 #include <pulsecore/memblock.h>


@@ -43,22 +40,15 @@ typedef struct pa_source pa_source;
 #include <pulsecore/asyncmsgq.h>
 #include <pulsecore/msgobject.h>
 #include <pulsecore/rtpoll.h>
 #include <pulsecore/asyncmsgq.h>
 #include <pulsecore/msgobject.h>
 #include <pulsecore/rtpoll.h>

+#include <pulsecore/source-output.h>
+#include <pulsecore/card.h>
+#include <pulsecore/queue.h>
+#include <pulsecore/thread-mq.h>

 
 #define PA_MAX_OUTPUTS_PER_SOURCE 32
 
 
 #define PA_MAX_OUTPUTS_PER_SOURCE 32
 

-typedef enum pa_source_state {
-    PA_SOURCE_INIT,
-    PA_SOURCE_RUNNING,
-    PA_SOURCE_SUSPENDED,
-    PA_SOURCE_IDLE,
-    PA_SOURCE_UNLINKED
-} pa_source_state_t;
-
-static inline pa_bool_t PA_SOURCE_OPENED(pa_source_state_t x) {
-    return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE;
-}
-
-static inline pa_bool_t PA_SOURCE_LINKED(pa_source_state_t x) {
+/* Returns true if source is linked: registered and accessible from client side. */
+static inline pa_bool_t PA_SOURCE_IS_LINKED(pa_source_state_t x) {

     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
 }
 
     return x == PA_SOURCE_RUNNING || x == PA_SOURCE_IDLE || x == PA_SOURCE_SUSPENDED;
 }
 


@@ -67,14 +57,17 @@ struct pa_source {
 
     uint32_t index;
     pa_core *core;
 
     uint32_t index;
     pa_core *core;

+

     pa_source_state_t state;
     pa_source_flags_t flags;
     pa_source_state_t state;
     pa_source_flags_t flags;

+    pa_suspend_cause_t suspend_cause;

 
     char *name;
     char *driver;                             /* may be NULL */
     pa_proplist *proplist;
 
     pa_module *module;                        /* may be NULL */
 
     char *name;
     char *driver;                             /* may be NULL */
     pa_proplist *proplist;
 
     pa_module *module;                        /* may be NULL */

+    pa_card *card;                            /* may be NULL */

 
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;
 
     pa_sample_spec sample_spec;
     pa_channel_map channel_map;


@@ -83,33 +76,84 @@ struct pa_source {
     unsigned n_corked;
     pa_sink *monitor_of;                     /* may be NULL */
 
     unsigned n_corked;
     pa_sink *monitor_of;                     /* may be NULL */
 

-    pa_cvolume volume;
-    pa_bool_t muted;
-    pa_bool_t refresh_volume;
-    pa_bool_t refresh_muted;
+    pa_volume_t base_volume; /* shall be constant */
+    unsigned n_volume_steps; /* shall be constant */
+
+    pa_cvolume volume, soft_volume;
+    pa_bool_t muted:1;
+
+    pa_bool_t refresh_volume:1;
+    pa_bool_t refresh_muted:1;
+
+    pa_bool_t save_port:1;
+    pa_bool_t save_volume:1;
+    pa_bool_t save_muted:1;

 
     pa_asyncmsgq *asyncmsgq;
 
     pa_asyncmsgq *asyncmsgq;

-    pa_rtpoll *rtpoll;

 
 

+    pa_memchunk silence;
+
+    pa_hashmap *ports;
+    pa_device_port *active_port;
+
+    /* Called when the main loop requests a state change. Called from
+     * main loop context. If returns -1 the state change will be
+     * inhibited */

     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */
     int (*set_state)(pa_source*source, pa_source_state_t state); /* may be NULL */

-    int (*set_volume)(pa_source *s);         /* dito */
-    int (*get_volume)(pa_source *s);         /* dito */
-    int (*set_mute)(pa_source *s);           /* dito */
-    int (*get_mute)(pa_source *s);           /* dito */
-    pa_usec_t (*get_latency)(pa_source *s);  /* dito */
+
+    /* Callled when the volume is queried. Called from main loop
+     * context. If this is NULL a PA_SOURCE_MESSAGE_GET_VOLUME message
+     * will be sent to the IO thread instead. If refresh_volume is
+     * FALSE neither this function is called nor a message is sent. */
+    void (*get_volume)(pa_source *s);         /* dito */
+
+    /* Called when the volume shall be changed. Called from main loop
+     * context. If this is NULL a PA_SOURCE_MESSAGE_SET_VOLUME message
+     * will be sent to the IO thread instead. */
+    void (*set_volume)(pa_source *s);         /* dito */
+
+    /* Called when the mute setting is queried. Called from main loop
+     * context. If this is NULL a PA_SOURCE_MESSAGE_GET_MUTE message
+     * will be sent to the IO thread instead. If refresh_mute is
+     * FALSE neither this function is called nor a message is sent.*/
+    void (*get_mute)(pa_source *s);           /* dito */
+
+    /* Called when the mute setting shall be changed. Called from main
+     * loop context. If this is NULL a PA_SOURCE_MESSAGE_SET_MUTE
+     * message will be sent to the IO thread instead. */
+    void (*set_mute)(pa_source *s);           /* dito */
+
+    /* Called when a the requested latency is changed. Called from IO
+     * thread context. */

     void (*update_requested_latency)(pa_source *s); /* dito */
 
     void (*update_requested_latency)(pa_source *s); /* dito */
 

+    /* Called whenever the port shall be changed. Called from main
+     * thread. */
+    int (*set_port)(pa_source *s, pa_device_port *port); /*dito */
+

     /* Contains copies of the above data so that the real-time worker
      * thread can work without access locking */
     struct {
         pa_source_state_t state;
         pa_hashmap *outputs;
     /* Contains copies of the above data so that the real-time worker
      * thread can work without access locking */
     struct {
         pa_source_state_t state;
         pa_hashmap *outputs;

+
+        pa_rtpoll *rtpoll;
+

         pa_cvolume soft_volume;
         pa_cvolume soft_volume;

-        pa_bool_t soft_muted;
+        pa_bool_t soft_muted:1;
+
+        pa_bool_t requested_latency_valid:1;
+        pa_usec_t requested_latency;
+
+        /* Then number of bytes this source will be rewound for at
+         * max. (Only used on monitor sources) */
+        size_t max_rewind;
+
+        pa_usec_t min_latency; /* we won't go below this latency */
+        pa_usec_t max_latency; /* An upper limit for the latencies */

 
 

-        pa_bool_t requested_latency_valid;
-        size_t requested_latency;
-    } thread_info;
+        pa_usec_t fixed_latency; /* for sources with PA_SOURCE_DYNAMIC_LATENCY this is 0 */
+ } thread_info;

 
     void *userdata;
 };
 
     void *userdata;
 };


@@ -125,30 +169,45 @@ typedef enum pa_source_message {
     PA_SOURCE_MESSAGE_GET_MUTE,
     PA_SOURCE_MESSAGE_SET_MUTE,
     PA_SOURCE_MESSAGE_GET_LATENCY,
     PA_SOURCE_MESSAGE_GET_MUTE,
     PA_SOURCE_MESSAGE_SET_MUTE,
     PA_SOURCE_MESSAGE_GET_LATENCY,

+    PA_SOURCE_MESSAGE_GET_REQUESTED_LATENCY,

     PA_SOURCE_MESSAGE_SET_STATE,
     PA_SOURCE_MESSAGE_SET_STATE,

-    PA_SOURCE_MESSAGE_PING,

     PA_SOURCE_MESSAGE_ATTACH,
     PA_SOURCE_MESSAGE_DETACH,
     PA_SOURCE_MESSAGE_ATTACH,
     PA_SOURCE_MESSAGE_DETACH,

+    PA_SOURCE_MESSAGE_SET_LATENCY_RANGE,
+    PA_SOURCE_MESSAGE_GET_LATENCY_RANGE,
+    PA_SOURCE_MESSAGE_SET_FIXED_LATENCY,
+    PA_SOURCE_MESSAGE_GET_FIXED_LATENCY,
+    PA_SOURCE_MESSAGE_GET_MAX_REWIND,
+    PA_SOURCE_MESSAGE_SET_MAX_REWIND,

     PA_SOURCE_MESSAGE_MAX
 } pa_source_message_t;
 
 typedef struct pa_source_new_data {
     char *name;
     PA_SOURCE_MESSAGE_MAX
 } pa_source_message_t;
 
 typedef struct pa_source_new_data {
     char *name;

-    pa_bool_t namereg_fail;

     pa_proplist *proplist;
 
     const char *driver;
     pa_module *module;
     pa_proplist *proplist;
 
     const char *driver;
     pa_module *module;

+    pa_card *card;
+
+    pa_hashmap *ports;
+    char *active_port;

 
     pa_sample_spec sample_spec;
 
     pa_sample_spec sample_spec;

-    pa_bool_t sample_spec_is_set;

     pa_channel_map channel_map;
     pa_channel_map channel_map;

-    pa_bool_t channel_map_is_set;
-

     pa_cvolume volume;
     pa_cvolume volume;

-    pa_bool_t volume_is_set;
-    pa_bool_t muted;
-    pa_bool_t muted_is_set;
+    pa_bool_t muted:1;
+
+    pa_bool_t volume_is_set:1;
+    pa_bool_t muted_is_set:1;
+    pa_bool_t sample_spec_is_set:1;
+    pa_bool_t channel_map_is_set:1;
+
+    pa_bool_t namereg_fail:1;
+
+    pa_bool_t save_port:1;
+    pa_bool_t save_volume:1;
+    pa_bool_t save_muted:1;

 } pa_source_new_data;
 
 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);
 } pa_source_new_data;
 
 pa_source_new_data* pa_source_new_data_init(pa_source_new_data *data);


@@ -157,9 +216,10 @@ void pa_source_new_data_set_sample_spec(pa_source_new_data *data, const pa_sampl
 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);
 void pa_source_new_data_set_channel_map(pa_source_new_data *data, const pa_channel_map *map);
 void pa_source_new_data_set_volume(pa_source_new_data *data, const pa_cvolume *volume);
 void pa_source_new_data_set_muted(pa_source_new_data *data, pa_bool_t mute);

+void pa_source_new_data_set_port(pa_source_new_data *data, const char *port);

 void pa_source_new_data_done(pa_source_new_data *data);
 
 void pa_source_new_data_done(pa_source_new_data *data);
 

-/* To be called exclusively by the source driver, from main context */
+/*** To be called exclusively by the source driver, from main context */

 
 pa_source* pa_source_new(
         pa_core *core,
 
 pa_source* pa_source_new(
         pa_core *core,


@@ -173,41 +233,79 @@ void pa_source_set_description(pa_source *s, const char *description);
 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 
 void pa_source_set_asyncmsgq(pa_source *s, pa_asyncmsgq *q);
 void pa_source_set_rtpoll(pa_source *s, pa_rtpoll *p);
 

+void pa_source_set_max_rewind(pa_source *s, size_t max_rewind);
+void pa_source_set_latency_range(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
+void pa_source_set_fixed_latency(pa_source *s, pa_usec_t latency);
+

 void pa_source_detach(pa_source *s);
 void pa_source_attach(pa_source *s);
 
 void pa_source_detach(pa_source *s);
 void pa_source_attach(pa_source *s);
 

-/* May be called by everyone, from main context */
+void pa_source_set_soft_volume(pa_source *s, const pa_cvolume *volume);
+void pa_source_volume_changed(pa_source *s, const pa_cvolume *new_volume);
+void pa_source_mute_changed(pa_source *s, pa_bool_t new_muted);
+
+int pa_source_sync_suspend(pa_source *s);
+
+void pa_source_update_flags(pa_source *s, pa_source_flags_t mask, pa_source_flags_t value);
+
+/*** May be called by everyone, from main context */

 
 

+/* The returned value is supposed to be in the time domain of the sound card! */

 pa_usec_t pa_source_get_latency(pa_source *s);
 pa_usec_t pa_source_get_latency(pa_source *s);

+pa_usec_t pa_source_get_requested_latency(pa_source *s);
+void pa_source_get_latency_range(pa_source *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
+pa_usec_t pa_source_get_fixed_latency(pa_source *s);
+
+size_t pa_source_get_max_rewind(pa_source *s);

 
 int pa_source_update_status(pa_source*s);
 
 int pa_source_update_status(pa_source*s);

-int pa_source_suspend(pa_source *s, pa_bool_t suspend);
-int pa_source_suspend_all(pa_core *c, pa_bool_t suspend);
+int pa_source_suspend(pa_source *s, pa_bool_t suspend, pa_suspend_cause_t cause);
+int pa_source_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
+
+void pa_source_set_volume(pa_source *source, const pa_cvolume *volume, pa_bool_t save);
+const pa_cvolume *pa_source_get_volume(pa_source *source, pa_bool_t force_refresh);

 
 

-void pa_source_ping(pa_source *s);
+void pa_source_set_mute(pa_source *source, pa_bool_t mute, pa_bool_t save);
+pa_bool_t pa_source_get_mute(pa_source *source, pa_bool_t force_refresh);

 
 

-void pa_source_set_volume(pa_source *source, const pa_cvolume *volume);
-const pa_cvolume *pa_source_get_volume(pa_source *source);
-void pa_source_set_mute(pa_source *source, pa_bool_t mute);
-pa_bool_t pa_source_get_mute(pa_source *source);
+pa_bool_t pa_source_update_proplist(pa_source *s, pa_update_mode_t mode, pa_proplist *p);
+
+int pa_source_set_port(pa_source *s, const char *name, pa_bool_t save);

 
 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */
 
 unsigned pa_source_linked_by(pa_source *s); /* Number of connected streams */
 unsigned pa_source_used_by(pa_source *s); /* Number of connected streams that are not corked */

+unsigned pa_source_check_suspend(pa_source *s); /* Returns how many streams are active that don't allow suspensions */

 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 
 #define pa_source_get_state(s) ((pa_source_state_t) (s)->state)
 

-/* To be called exclusively by the source driver, from IO context */
+/* Moves all inputs away, and stores them in pa_queue */
+pa_queue *pa_source_move_all_start(pa_source *s, pa_queue *q);
+void pa_source_move_all_finish(pa_source *s, pa_queue *q, pa_bool_t save);
+void pa_source_move_all_fail(pa_queue *q);
+
+/*** To be called exclusively by the source driver, from IO context */

 
 

-void pa_source_post(pa_source*s, const pa_memchunk *b);
+void pa_source_post(pa_source*s, const pa_memchunk *chunk);
+void pa_source_post_direct(pa_source*s, pa_source_output *o, const pa_memchunk *chunk);
+void pa_source_process_rewind(pa_source *s, size_t nbytes);

 
 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 
 void pa_source_attach_within_thread(pa_source *s);
 void pa_source_detach_within_thread(pa_source *s);
 
 
 int pa_source_process_msg(pa_msgobject *o, int code, void *userdata, int64_t, pa_memchunk *chunk);
 
 void pa_source_attach_within_thread(pa_source *s);
 void pa_source_detach_within_thread(pa_source *s);
 

-pa_usec_t pa_source_get_requested_latency(pa_source *s);
+pa_usec_t pa_source_get_requested_latency_within_thread(pa_source *s);
+
+void pa_source_set_max_rewind_within_thread(pa_source *s, size_t max_rewind);
+
+void pa_source_set_latency_range_within_thread(pa_source *s, pa_usec_t min_latency, pa_usec_t max_latency);
+void pa_source_set_fixed_latency_within_thread(pa_source *s, pa_usec_t latency);
+
+/*** To be called exclusively by source output drivers, from IO context */

 
 

-/* To be called exclusively by source output drivers, from IO context */
+void pa_source_invalidate_requested_latency(pa_source *s, pa_bool_t dynamic);
+pa_usec_t pa_source_get_latency_within_thread(pa_source *s);

 
 

-void pa_source_invalidate_requested_latency(pa_source *s);
+#define pa_source_assert_io_context(s) \
+    pa_assert(pa_thread_mq_get() || !PA_SOURCE_IS_LINKED((s)->state))

 
 #endif
 
 #endif