LCOV - code coverage report
Current view: top level - pulsecore - sink.h (source / functions) Hit Total Coverage
Test: lcov.out Lines: 0 2 0.0 %
Date: 2012-07-17 Functions: 0 4 0.0 %
Legend: Lines: hit not hit | Branches: + taken - not taken # not executed Branches: 0 10 0.0 %

           Branch data     Line data    Source code
       1                 :            : #ifndef foopulsesinkhfoo
       2                 :            : #define foopulsesinkhfoo
       3                 :            : 
       4                 :            : /***
       5                 :            :   This file is part of PulseAudio.
       6                 :            : 
       7                 :            :   Copyright 2004-2006 Lennart Poettering
       8                 :            :   Copyright 2006 Pierre Ossman <ossman@cendio.se> for Cendio AB
       9                 :            : 
      10                 :            :   PulseAudio is free software; you can redistribute it and/or modify
      11                 :            :   it under the terms of the GNU Lesser General Public License as published
      12                 :            :   by the Free Software Foundation; either version 2.1 of the License,
      13                 :            :   or (at your option) any later version.
      14                 :            : 
      15                 :            :   PulseAudio is distributed in the hope that it will be useful, but
      16                 :            :   WITHOUT ANY WARRANTY; without even the implied warranty of
      17                 :            :   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
      18                 :            :   General Public License for more details.
      19                 :            : 
      20                 :            :   You should have received a copy of the GNU Lesser General Public License
      21                 :            :   along with PulseAudio; if not, write to the Free Software
      22                 :            :   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
      23                 :            :   USA.
      24                 :            : ***/
      25                 :            : 
      26                 :            : typedef struct pa_sink pa_sink;
      27                 :            : typedef struct pa_sink_volume_change pa_sink_volume_change;
      28                 :            : 
      29                 :            : #include <inttypes.h>
      30                 :            : 
      31                 :            : #include <pulse/def.h>
      32                 :            : #include <pulse/format.h>
      33                 :            : #include <pulse/sample.h>
      34                 :            : #include <pulse/channelmap.h>
      35                 :            : #include <pulse/volume.h>
      36                 :            : 
      37                 :            : #include <pulsecore/core.h>
      38                 :            : #include <pulsecore/idxset.h>
      39                 :            : #include <pulsecore/memchunk.h>
      40                 :            : #include <pulsecore/source.h>
      41                 :            : #include <pulsecore/module.h>
      42                 :            : #include <pulsecore/asyncmsgq.h>
      43                 :            : #include <pulsecore/msgobject.h>
      44                 :            : #include <pulsecore/rtpoll.h>
      45                 :            : #include <pulsecore/device-port.h>
      46                 :            : #include <pulsecore/card.h>
      47                 :            : #include <pulsecore/queue.h>
      48                 :            : #include <pulsecore/thread-mq.h>
      49                 :            : #include <pulsecore/sink-input.h>
      50                 :            : 
      51                 :            : #define PA_MAX_INPUTS_PER_SINK 32
      52                 :            : 
      53                 :            : /* Returns true if sink is linked: registered and accessible from client side. */
      54                 :            : static inline pa_bool_t PA_SINK_IS_LINKED(pa_sink_state_t x) {
      55                 :          0 :     return x == PA_SINK_RUNNING || x == PA_SINK_IDLE || x == PA_SINK_SUSPENDED;
      56                 :            : }
      57                 :            : 
      58                 :            : /* A generic definition for void callback functions */
      59                 :            : typedef void(*pa_sink_cb_t)(pa_sink *s);
      60                 :            : 
      61                 :            : struct pa_sink {
      62                 :            :     pa_msgobject parent;
      63                 :            : 
      64                 :            :     uint32_t index;
      65                 :            :     pa_core *core;
      66                 :            : 
      67                 :            :     pa_sink_state_t state;
      68                 :            :     pa_sink_flags_t flags;
      69                 :            :     pa_suspend_cause_t suspend_cause;
      70                 :            : 
      71                 :            :     char *name;
      72                 :            :     char *driver;                           /* may be NULL */
      73                 :            :     pa_proplist *proplist;
      74                 :            : 
      75                 :            :     pa_module *module;                      /* may be NULL */
      76                 :            :     pa_card *card;                          /* may be NULL */
      77                 :            : 
      78                 :            :     pa_sample_spec sample_spec;
      79                 :            :     pa_channel_map channel_map;
      80                 :            :     uint32_t default_sample_rate;
      81                 :            :     uint32_t alternate_sample_rate;
      82                 :            : 
      83                 :            :     pa_idxset *inputs;
      84                 :            :     unsigned n_corked;
      85                 :            :     pa_source *monitor_source;
      86                 :            :     pa_sink_input *input_to_master;         /* non-NULL only for filter sinks */
      87                 :            : 
      88                 :            :     pa_volume_t base_volume; /* shall be constant */
      89                 :            :     unsigned n_volume_steps; /* shall be constant */
      90                 :            : 
      91                 :            :     /* Also see http://pulseaudio.org/wiki/InternalVolumes */
      92                 :            :     pa_cvolume reference_volume; /* The volume exported and taken as reference base for relative sink input volumes */
      93                 :            :     pa_cvolume real_volume;      /* The volume that the hardware is configured to  */
      94                 :            :     pa_cvolume soft_volume;      /* The internal software volume we apply to all PCM data while it passes through */
      95                 :            : 
      96                 :            :     pa_bool_t muted:1;
      97                 :            : 
      98                 :            :     pa_bool_t refresh_volume:1;
      99                 :            :     pa_bool_t refresh_muted:1;
     100                 :            :     pa_bool_t save_port:1;
     101                 :            :     pa_bool_t save_volume:1;
     102                 :            :     pa_bool_t save_muted:1;
     103                 :            : 
     104                 :            :     /* Saved volume state while we're in passthrough mode */
     105                 :            :     pa_cvolume saved_volume;
     106                 :            :     pa_bool_t saved_save_volume:1;
     107                 :            : 
     108                 :            :     pa_asyncmsgq *asyncmsgq;
     109                 :            : 
     110                 :            :     pa_memchunk silence;
     111                 :            : 
     112                 :            :     pa_hashmap *ports;
     113                 :            :     pa_device_port *active_port;
     114                 :            :     pa_atomic_t mixer_dirty;
     115                 :            : 
     116                 :            :     /* The latency offset is inherited from the currently active port */
     117                 :            :     int64_t latency_offset;
     118                 :            : 
     119                 :            :     unsigned priority;
     120                 :            : 
     121                 :            :     /* Called when the main loop requests a state change. Called from
     122                 :            :      * main loop context. If returns -1 the state change will be
     123                 :            :      * inhibited */
     124                 :            :     int (*set_state)(pa_sink *s, pa_sink_state_t state); /* may be NULL */
     125                 :            : 
     126                 :            :     /* Sink drivers that support hardware volume may set this
     127                 :            :      * callback. This is called when the current volume needs to be
     128                 :            :      * re-read from the hardware.
     129                 :            :      *
     130                 :            :      * There are two ways for drivers to implement hardware volume
     131                 :            :      * query: either set this callback or handle
     132                 :            :      * PA_SINK_MESSAGE_GET_VOLUME. The callback implementation or the
     133                 :            :      * message handler must update s->real_volume and s->soft_volume
     134                 :            :      * (using pa_sink_set_soft_volume()) to match the current hardware
     135                 :            :      * volume.
     136                 :            :      *
     137                 :            :      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
     138                 :            :      * main thread before sending PA_SINK_MESSAGE_GET_VOLUME, so in
     139                 :            :      * this case the driver can choose whether to read the volume from
     140                 :            :      * the hardware in the main thread or in the IO thread.
     141                 :            :      *
     142                 :            :      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
     143                 :            :      * thread within the default handler for
     144                 :            :      * PA_SINK_MESSAGE_GET_VOLUME (the main thread is waiting while
     145                 :            :      * the message is being processed), so there's no choice of where
     146                 :            :      * to do the volume reading - it has to be done in the IO thread
     147                 :            :      * always.
     148                 :            :      *
     149                 :            :      * You must use the function pa_sink_set_get_volume_callback() to
     150                 :            :      * set this callback. */
     151                 :            :     pa_sink_cb_t get_volume; /* may be NULL */
     152                 :            : 
     153                 :            :     /* Sink drivers that support hardware volume must set this
     154                 :            :      * callback. This is called when the hardware volume needs to be
     155                 :            :      * updated.
     156                 :            :      *
     157                 :            :      * If PA_SINK_DEFERRED_VOLUME is not set, then this is called from the
     158                 :            :      * main thread. The callback implementation must set the hardware
     159                 :            :      * volume according to s->real_volume. If the driver can't set the
     160                 :            :      * hardware volume to the exact requested value, it has to update
     161                 :            :      * s->real_volume and/or s->soft_volume so that they together
     162                 :            :      * match the actual hardware volume that was set.
     163                 :            :      *
     164                 :            :      * If PA_SINK_DEFERRED_VOLUME is set, then this is called from the IO
     165                 :            :      * thread. The callback implementation must not actually set the
     166                 :            :      * hardware volume yet, but it must check how close to the
     167                 :            :      * requested volume the hardware volume can be set, and update
     168                 :            :      * s->real_volume and/or s->soft_volume so that they together
     169                 :            :      * match the actual hardware volume that will be set later in the
     170                 :            :      * write_volume callback.
     171                 :            :      *
     172                 :            :      * You must use the function pa_sink_set_set_volume_callback() to
     173                 :            :      * set this callback. */
     174                 :            :     pa_sink_cb_t set_volume; /* may be NULL */
     175                 :            : 
     176                 :            :     /* Sink drivers that set PA_SINK_DEFERRED_VOLUME must provide this
     177                 :            :      * callback. This callback is not used with sinks that do not set
     178                 :            :      * PA_SINK_DEFERRED_VOLUME. This is called from the IO thread when a
     179                 :            :      * pending hardware volume change has to be written to the
     180                 :            :      * hardware. The requested volume is passed to the callback
     181                 :            :      * implementation in s->thread_info.current_hw_volume.
     182                 :            :      *
     183                 :            :      * The call is done inside pa_sink_volume_change_apply(), which is
     184                 :            :      * not called automatically - it is the driver's responsibility to
     185                 :            :      * schedule that function to be called at the right times in the
     186                 :            :      * IO thread.
     187                 :            :      *
     188                 :            :      * You must use the function pa_sink_set_write_volume_callback() to
     189                 :            :      * set this callback. */
     190                 :            :     pa_sink_cb_t write_volume; /* may be NULL */
     191                 :            : 
     192                 :            :     /* Called when the mute setting is queried. A PA_SINK_MESSAGE_GET_MUTE
     193                 :            :      * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
     194                 :            :      * flag is set otherwise from main loop context. If refresh_mute is FALSE
     195                 :            :      * neither this function is called nor a message is sent.
     196                 :            :      *
     197                 :            :      * You must use the function pa_sink_set_get_mute_callback() to
     198                 :            :      * set this callback. */
     199                 :            :     pa_sink_cb_t get_mute; /* may be NULL */
     200                 :            : 
     201                 :            :     /* Called when the mute setting shall be changed. A PA_SINK_MESSAGE_SET_MUTE
     202                 :            :      * message will also be sent. Called from IO thread if PA_SINK_DEFERRED_VOLUME
     203                 :            :      * flag is set otherwise from main loop context.
     204                 :            :      *
     205                 :            :      * You must use the function pa_sink_set_set_mute_callback() to
     206                 :            :      * set this callback. */
     207                 :            :     pa_sink_cb_t set_mute; /* may be NULL */
     208                 :            : 
     209                 :            :     /* Called when a rewind request is issued. Called from IO thread
     210                 :            :      * context. */
     211                 :            :     pa_sink_cb_t request_rewind; /* may be NULL */
     212                 :            : 
     213                 :            :     /* Called when a the requested latency is changed. Called from IO
     214                 :            :      * thread context. */
     215                 :            :     pa_sink_cb_t update_requested_latency; /* may be NULL */
     216                 :            : 
     217                 :            :     /* Called whenever the port shall be changed. Called from IO
     218                 :            :      * thread if deferred volumes are enabled, and main thread otherwise. */
     219                 :            :     int (*set_port)(pa_sink *s, pa_device_port *port); /* may be NULL */
     220                 :            : 
     221                 :            :     /* Called to get the list of formats supported by the sink, sorted
     222                 :            :      * in descending order of preference. */
     223                 :            :     pa_idxset* (*get_formats)(pa_sink *s); /* may be NULL */
     224                 :            : 
     225                 :            :     /* Called to set the list of formats supported by the sink. Can be
     226                 :            :      * NULL if the sink does not support this. Returns TRUE on success,
     227                 :            :      * FALSE otherwise (for example when an unsupportable format is
     228                 :            :      * set). Makes a copy of the formats passed in. */
     229                 :            :     pa_bool_t (*set_formats)(pa_sink *s, pa_idxset *formats); /* may be NULL */
     230                 :            : 
     231                 :            :     /* Called whenever the sampling frequency shall be changed. Called from
     232                 :            :      * main thread. */
     233                 :            :     pa_bool_t (*update_rate)(pa_sink *s, uint32_t rate);
     234                 :            : 
     235                 :            :     /* Contains copies of the above data so that the real-time worker
     236                 :            :      * thread can work without access locking */
     237                 :            :     struct {
     238                 :            :         pa_sink_state_t state;
     239                 :            :         pa_hashmap *inputs;
     240                 :            : 
     241                 :            :         pa_rtpoll *rtpoll;
     242                 :            : 
     243                 :            :         pa_cvolume soft_volume;
     244                 :            :         pa_bool_t soft_muted:1;
     245                 :            : 
     246                 :            :         /* The requested latency is used for dynamic latency
     247                 :            :          * sinks. For fixed latency sinks it is always identical to
     248                 :            :          * the fixed_latency. See below. */
     249                 :            :         pa_bool_t requested_latency_valid:1;
     250                 :            :         pa_usec_t requested_latency;
     251                 :            : 
     252                 :            :         /* The number of bytes streams need to keep around as history to
     253                 :            :          * be able to satisfy every DMA buffer rewrite */
     254                 :            :         size_t max_rewind;
     255                 :            : 
     256                 :            :         /* The number of bytes streams need to keep around to satisfy
     257                 :            :          * every DMA write request */
     258                 :            :         size_t max_request;
     259                 :            : 
     260                 :            :         /* Maximum of what clients requested to rewind in this cycle */
     261                 :            :         size_t rewind_nbytes;
     262                 :            :         pa_bool_t rewind_requested;
     263                 :            : 
     264                 :            :         /* Both dynamic and fixed latencies will be clamped to this
     265                 :            :          * range. */
     266                 :            :         pa_usec_t min_latency; /* we won't go below this latency */
     267                 :            :         pa_usec_t max_latency; /* An upper limit for the latencies */
     268                 :            : 
     269                 :            :         /* 'Fixed' simply means that the latency is exclusively
     270                 :            :          * decided on by the sink, and the clients have no influence
     271                 :            :          * in changing it */
     272                 :            :         pa_usec_t fixed_latency; /* for sinks with PA_SINK_DYNAMIC_LATENCY this is 0 */
     273                 :            : 
     274                 :            :         /* This latency offset is a direct copy from s->latency_offset */
     275                 :            :         int64_t latency_offset;
     276                 :            : 
     277                 :            :         /* Delayed volume change events are queued here. The events
     278                 :            :          * are stored in expiration order. The one expiring next is in
     279                 :            :          * the head of the list. */
     280                 :            :         PA_LLIST_HEAD(pa_sink_volume_change, volume_changes);
     281                 :            :         pa_sink_volume_change *volume_changes_tail;
     282                 :            :         /* This value is updated in pa_sink_volume_change_apply() and
     283                 :            :          * used only by sinks with PA_SINK_DEFERRED_VOLUME. */
     284                 :            :         pa_cvolume current_hw_volume;
     285                 :            : 
     286                 :            :         /* The amount of usec volume up events are delayed and volume
     287                 :            :          * down events are made earlier. */
     288                 :            :         uint32_t volume_change_safety_margin;
     289                 :            :         /* Usec delay added to all volume change events, may be negative. */
     290                 :            :         int32_t volume_change_extra_delay;
     291                 :            :     } thread_info;
     292                 :            : 
     293                 :            :     void *userdata;
     294                 :            : };
     295                 :            : 
     296 [ #  # ][ #  # ]:          0 : PA_DECLARE_PUBLIC_CLASS(pa_sink);
         [ #  # ][ #  # ]
                 [ #  # ]
     297                 :            : #define PA_SINK(s) (pa_sink_cast(s))
     298                 :            : 
     299                 :            : typedef enum pa_sink_message {
     300                 :            :     PA_SINK_MESSAGE_ADD_INPUT,
     301                 :            :     PA_SINK_MESSAGE_REMOVE_INPUT,
     302                 :            :     PA_SINK_MESSAGE_GET_VOLUME,
     303                 :            :     PA_SINK_MESSAGE_SET_SHARED_VOLUME,
     304                 :            :     PA_SINK_MESSAGE_SET_VOLUME_SYNCED,
     305                 :            :     PA_SINK_MESSAGE_SET_VOLUME,
     306                 :            :     PA_SINK_MESSAGE_SYNC_VOLUMES,
     307                 :            :     PA_SINK_MESSAGE_GET_MUTE,
     308                 :            :     PA_SINK_MESSAGE_SET_MUTE,
     309                 :            :     PA_SINK_MESSAGE_GET_LATENCY,
     310                 :            :     PA_SINK_MESSAGE_GET_REQUESTED_LATENCY,
     311                 :            :     PA_SINK_MESSAGE_SET_STATE,
     312                 :            :     PA_SINK_MESSAGE_START_MOVE,
     313                 :            :     PA_SINK_MESSAGE_FINISH_MOVE,
     314                 :            :     PA_SINK_MESSAGE_ATTACH,
     315                 :            :     PA_SINK_MESSAGE_DETACH,
     316                 :            :     PA_SINK_MESSAGE_SET_LATENCY_RANGE,
     317                 :            :     PA_SINK_MESSAGE_GET_LATENCY_RANGE,
     318                 :            :     PA_SINK_MESSAGE_SET_FIXED_LATENCY,
     319                 :            :     PA_SINK_MESSAGE_GET_FIXED_LATENCY,
     320                 :            :     PA_SINK_MESSAGE_GET_MAX_REWIND,
     321                 :            :     PA_SINK_MESSAGE_GET_MAX_REQUEST,
     322                 :            :     PA_SINK_MESSAGE_SET_MAX_REWIND,
     323                 :            :     PA_SINK_MESSAGE_SET_MAX_REQUEST,
     324                 :            :     PA_SINK_MESSAGE_SET_PORT,
     325                 :            :     PA_SINK_MESSAGE_UPDATE_VOLUME_AND_MUTE,
     326                 :            :     PA_SINK_MESSAGE_SET_LATENCY_OFFSET,
     327                 :            :     PA_SINK_MESSAGE_MAX
     328                 :            : } pa_sink_message_t;
     329                 :            : 
     330                 :            : typedef struct pa_sink_new_data {
     331                 :            :     char *name;
     332                 :            :     pa_proplist *proplist;
     333                 :            : 
     334                 :            :     const char *driver;
     335                 :            :     pa_module *module;
     336                 :            :     pa_card *card;
     337                 :            : 
     338                 :            :     pa_hashmap *ports;
     339                 :            :     char *active_port;
     340                 :            : 
     341                 :            :     pa_sample_spec sample_spec;
     342                 :            :     pa_channel_map channel_map;
     343                 :            :     uint32_t alternate_sample_rate;
     344                 :            :     pa_cvolume volume;
     345                 :            :     pa_bool_t muted :1;
     346                 :            : 
     347                 :            :     pa_bool_t sample_spec_is_set:1;
     348                 :            :     pa_bool_t channel_map_is_set:1;
     349                 :            :     pa_bool_t alternate_sample_rate_is_set:1;
     350                 :            :     pa_bool_t volume_is_set:1;
     351                 :            :     pa_bool_t muted_is_set:1;
     352                 :            : 
     353                 :            :     pa_bool_t namereg_fail:1;
     354                 :            : 
     355                 :            :     pa_bool_t save_port:1;
     356                 :            :     pa_bool_t save_volume:1;
     357                 :            :     pa_bool_t save_muted:1;
     358                 :            : } pa_sink_new_data;
     359                 :            : 
     360                 :            : pa_sink_new_data* pa_sink_new_data_init(pa_sink_new_data *data);
     361                 :            : void pa_sink_new_data_set_name(pa_sink_new_data *data, const char *name);
     362                 :            : void pa_sink_new_data_set_sample_spec(pa_sink_new_data *data, const pa_sample_spec *spec);
     363                 :            : void pa_sink_new_data_set_channel_map(pa_sink_new_data *data, const pa_channel_map *map);
     364                 :            : void pa_sink_new_data_set_alternate_sample_rate(pa_sink_new_data *data, const uint32_t alternate_sample_rate);
     365                 :            : void pa_sink_new_data_set_volume(pa_sink_new_data *data, const pa_cvolume *volume);
     366                 :            : void pa_sink_new_data_set_muted(pa_sink_new_data *data, pa_bool_t mute);
     367                 :            : void pa_sink_new_data_set_port(pa_sink_new_data *data, const char *port);
     368                 :            : void pa_sink_new_data_done(pa_sink_new_data *data);
     369                 :            : 
     370                 :            : /*** To be called exclusively by the sink driver, from main context */
     371                 :            : 
     372                 :            : pa_sink* pa_sink_new(
     373                 :            :         pa_core *core,
     374                 :            :         pa_sink_new_data *data,
     375                 :            :         pa_sink_flags_t flags);
     376                 :            : 
     377                 :            : void pa_sink_set_get_volume_callback(pa_sink *s, pa_sink_cb_t cb);
     378                 :            : void pa_sink_set_set_volume_callback(pa_sink *s, pa_sink_cb_t cb);
     379                 :            : void pa_sink_set_write_volume_callback(pa_sink *s, pa_sink_cb_t cb);
     380                 :            : void pa_sink_set_get_mute_callback(pa_sink *s, pa_sink_cb_t cb);
     381                 :            : void pa_sink_set_set_mute_callback(pa_sink *s, pa_sink_cb_t cb);
     382                 :            : void pa_sink_enable_decibel_volume(pa_sink *s, pa_bool_t enable);
     383                 :            : 
     384                 :            : void pa_sink_put(pa_sink *s);
     385                 :            : void pa_sink_unlink(pa_sink* s);
     386                 :            : 
     387                 :            : void pa_sink_set_description(pa_sink *s, const char *description);
     388                 :            : void pa_sink_set_asyncmsgq(pa_sink *s, pa_asyncmsgq *q);
     389                 :            : void pa_sink_set_rtpoll(pa_sink *s, pa_rtpoll *p);
     390                 :            : 
     391                 :            : void pa_sink_set_max_rewind(pa_sink *s, size_t max_rewind);
     392                 :            : void pa_sink_set_max_request(pa_sink *s, size_t max_request);
     393                 :            : void pa_sink_set_latency_range(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
     394                 :            : void pa_sink_set_fixed_latency(pa_sink *s, pa_usec_t latency);
     395                 :            : 
     396                 :            : void pa_sink_detach(pa_sink *s);
     397                 :            : void pa_sink_attach(pa_sink *s);
     398                 :            : 
     399                 :            : void pa_sink_set_soft_volume(pa_sink *s, const pa_cvolume *volume);
     400                 :            : void pa_sink_volume_changed(pa_sink *s, const pa_cvolume *new_volume);
     401                 :            : void pa_sink_mute_changed(pa_sink *s, pa_bool_t new_muted);
     402                 :            : 
     403                 :            : void pa_sink_update_flags(pa_sink *s, pa_sink_flags_t mask, pa_sink_flags_t value);
     404                 :            : 
     405                 :            : pa_bool_t pa_device_init_description(pa_proplist *p);
     406                 :            : pa_bool_t pa_device_init_icon(pa_proplist *p, pa_bool_t is_sink);
     407                 :            : pa_bool_t pa_device_init_intended_roles(pa_proplist *p);
     408                 :            : unsigned pa_device_init_priority(pa_proplist *p);
     409                 :            : 
     410                 :            : /**** May be called by everyone, from main context */
     411                 :            : 
     412                 :            : pa_bool_t pa_sink_update_rate(pa_sink *s, uint32_t rate, pa_bool_t passthrough);
     413                 :            : void pa_sink_set_latency_offset(pa_sink *s, int64_t offset);
     414                 :            : 
     415                 :            : /* The returned value is supposed to be in the time domain of the sound card! */
     416                 :            : pa_usec_t pa_sink_get_latency(pa_sink *s);
     417                 :            : pa_usec_t pa_sink_get_requested_latency(pa_sink *s);
     418                 :            : void pa_sink_get_latency_range(pa_sink *s, pa_usec_t *min_latency, pa_usec_t *max_latency);
     419                 :            : pa_usec_t pa_sink_get_fixed_latency(pa_sink *s);
     420                 :            : 
     421                 :            : size_t pa_sink_get_max_rewind(pa_sink *s);
     422                 :            : size_t pa_sink_get_max_request(pa_sink *s);
     423                 :            : 
     424                 :            : int pa_sink_update_status(pa_sink*s);
     425                 :            : int pa_sink_suspend(pa_sink *s, pa_bool_t suspend, pa_suspend_cause_t cause);
     426                 :            : int pa_sink_suspend_all(pa_core *c, pa_bool_t suspend, pa_suspend_cause_t cause);
     427                 :            : 
     428                 :            : /* Use this instead of checking s->flags & PA_SINK_FLAT_VOLUME directly. */
     429                 :            : pa_bool_t pa_sink_flat_volume_enabled(pa_sink *s);
     430                 :            : 
     431                 :            : /* Get the master sink when sharing volumes */
     432                 :            : pa_sink *pa_sink_get_master(pa_sink *s);
     433                 :            : 
     434                 :            : /* Is the sink in passthrough mode? (that is, is there a passthrough sink input
     435                 :            :  * connected to this sink? */
     436                 :            : pa_bool_t pa_sink_is_passthrough(pa_sink *s);
     437                 :            : /* These should be called when a sink enters/leaves passthrough mode */
     438                 :            : void pa_sink_enter_passthrough(pa_sink *s);
     439                 :            : void pa_sink_leave_passthrough(pa_sink *s);
     440                 :            : 
     441                 :            : void pa_sink_set_volume(pa_sink *sink, const pa_cvolume *volume, pa_bool_t sendmsg, pa_bool_t save);
     442                 :            : const pa_cvolume *pa_sink_get_volume(pa_sink *sink, pa_bool_t force_refresh);
     443                 :            : 
     444                 :            : void pa_sink_set_mute(pa_sink *sink, pa_bool_t mute, pa_bool_t save);
     445                 :            : pa_bool_t pa_sink_get_mute(pa_sink *sink, pa_bool_t force_refresh);
     446                 :            : 
     447                 :            : pa_bool_t pa_sink_update_proplist(pa_sink *s, pa_update_mode_t mode, pa_proplist *p);
     448                 :            : 
     449                 :            : int pa_sink_set_port(pa_sink *s, const char *name, pa_bool_t save);
     450                 :            : void pa_sink_set_mixer_dirty(pa_sink *s, pa_bool_t is_dirty);
     451                 :            : 
     452                 :            : unsigned pa_sink_linked_by(pa_sink *s); /* Number of connected streams */
     453                 :            : unsigned pa_sink_used_by(pa_sink *s); /* Number of connected streams which are not corked */
     454                 :            : unsigned pa_sink_check_suspend(pa_sink *s); /* Returns how many streams are active that don't allow suspensions */
     455                 :            : #define pa_sink_get_state(s) ((s)->state)
     456                 :            : 
     457                 :            : /* Moves all inputs away, and stores them in pa_queue */
     458                 :            : pa_queue *pa_sink_move_all_start(pa_sink *s, pa_queue *q);
     459                 :            : void pa_sink_move_all_finish(pa_sink *s, pa_queue *q, pa_bool_t save);
     460                 :            : void pa_sink_move_all_fail(pa_queue *q);
     461                 :            : 
     462                 :            : pa_idxset* pa_sink_get_formats(pa_sink *s);
     463                 :            : pa_bool_t pa_sink_set_formats(pa_sink *s, pa_idxset *formats);
     464                 :            : pa_bool_t pa_sink_check_format(pa_sink *s, pa_format_info *f);
     465                 :            : pa_idxset* pa_sink_check_formats(pa_sink *s, pa_idxset *in_formats);
     466                 :            : 
     467                 :            : /*** To be called exclusively by the sink driver, from IO context */
     468                 :            : 
     469                 :            : void pa_sink_render(pa_sink*s, size_t length, pa_memchunk *result);
     470                 :            : void pa_sink_render_full(pa_sink *s, size_t length, pa_memchunk *result);
     471                 :            : void pa_sink_render_into(pa_sink*s, pa_memchunk *target);
     472                 :            : void pa_sink_render_into_full(pa_sink *s, pa_memchunk *target);
     473                 :            : 
     474                 :            : void pa_sink_process_rewind(pa_sink *s, size_t nbytes);
     475                 :            : 
     476                 :            : int pa_sink_process_msg(pa_msgobject *o, int code, void *userdata, int64_t offset, pa_memchunk *chunk);
     477                 :            : 
     478                 :            : void pa_sink_attach_within_thread(pa_sink *s);
     479                 :            : void pa_sink_detach_within_thread(pa_sink *s);
     480                 :            : 
     481                 :            : pa_usec_t pa_sink_get_requested_latency_within_thread(pa_sink *s);
     482                 :            : 
     483                 :            : void pa_sink_set_max_rewind_within_thread(pa_sink *s, size_t max_rewind);
     484                 :            : void pa_sink_set_max_request_within_thread(pa_sink *s, size_t max_request);
     485                 :            : 
     486                 :            : void pa_sink_set_latency_range_within_thread(pa_sink *s, pa_usec_t min_latency, pa_usec_t max_latency);
     487                 :            : void pa_sink_set_fixed_latency_within_thread(pa_sink *s, pa_usec_t latency);
     488                 :            : 
     489                 :            : void pa_sink_update_volume_and_mute(pa_sink *s);
     490                 :            : 
     491                 :            : pa_bool_t pa_sink_volume_change_apply(pa_sink *s, pa_usec_t *usec_to_next);
     492                 :            : 
     493                 :            : /*** To be called exclusively by sink input drivers, from IO context */
     494                 :            : 
     495                 :            : void pa_sink_request_rewind(pa_sink*s, size_t nbytes);
     496                 :            : 
     497                 :            : void pa_sink_invalidate_requested_latency(pa_sink *s, pa_bool_t dynamic);
     498                 :            : 
     499                 :            : pa_usec_t pa_sink_get_latency_within_thread(pa_sink *s);
     500                 :            : 
     501                 :            : /* Verify that we called in IO context (aka 'thread context), or that
     502                 :            :  * the sink is not yet set up, i.e. the thread not set up yet. See
     503                 :            :  * pa_assert_io_context() in thread-mq.h for more information. */
     504                 :            : #define pa_sink_assert_io_context(s) \
     505                 :            :     pa_assert(pa_thread_mq_get() || !PA_SINK_IS_LINKED((s)->state))
     506                 :            : 
     507                 :            : #endif

Generated by: LCOV version 1.9