aboutsummaryrefslogtreecommitdiff
path: root/src/volume-warning-pulse.vala
blob: 8531c6879488a02461a3af454f43e7d9877da4f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
 * -*- Mode:Vala; indent-tabs-mode:t; tab-width:4; encoding:utf8 -*-
 *
 * Copyright 2015 Canonical Ltd.
 * Copyright 2021 Robert Tari
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; version 3.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * Authors:
 *      Charles Kerr <charles.kerr@canonical.com>
 *      Robert Tari <robert@tari.in>
 */

using PulseAudio;

/**
 * A VolumeWarning that uses PulseAudio to
 * (a) implement sound_system_set_multimedia_volume() and
 * (b) keep the multimedia_active and multimedia_volume properties up-to-date
 */
public class VolumeWarningPulse : VolumeWarning
{
    public VolumeWarningPulse (IndicatorSound.Options options,
                               PulseAudio.GLibMainLoop pgloop) {
        base (options);

        _pgloop = pgloop;
        pulse_reconnect ();
    }

    ~VolumeWarningPulse () {
        clear_timer (ref _pulse_reconnect_timer);
        clear_timer (ref _pending_sink_inputs_timer);
        pulse_disconnect ();
    }

        protected override void preshow () {
        /* showing the dialog can change the sink input index (bug #1484589)
         * so cache it here for later use in sound_system_set_multimedia_volume() */
                _target_sink_input_index = _multimedia_sink_input_index;
        }

    protected override void sound_system_set_multimedia_volume (PulseAudio.Volume volume) {
        var index = _target_sink_input_index;

        return_if_fail (_pulse_context != null);
        return_if_fail (index != PulseAudio.INVALID_INDEX);
        return_if_fail (volume != PulseAudio.Volume.INVALID);

        unowned CVolume cvol = CVolume ();
        cvol.set (1, volume);
        debug ("setting multimedia (sink_input index %d) volume to %s", (int)index, cvol.to_string ());
        _pulse_context.set_sink_input_volume (index, cvol);
    }

    private unowned PulseAudio.GLibMainLoop _pgloop = null;
    private PulseAudio.Context _pulse_context = null;
    private uint _pulse_reconnect_timer = 0;
    private uint _pending_sink_inputs_timer = 0;
        private GenericSet<uint32> _pending_sink_inputs = new GenericSet<uint32>(direct_hash, direct_equal);

    private uint soon_interval_msec = 500;

    private uint32 _target_sink_input_index     = PulseAudio.INVALID_INDEX;
    private uint32 _multimedia_sink_input_index = PulseAudio.INVALID_INDEX;

    /***/

    private bool is_active_multimedia (SinkInputInfo i) {
        return (i.corked == 0) &&
               (i.proplist.gets(PulseAudio.Proplist.PROP_MEDIA_ROLE) == "multimedia");

    }

    private void clear_multimedia () {
        _multimedia_sink_input_index = PulseAudio.INVALID_INDEX;
        multimedia_volume = PulseAudio.Volume.INVALID;
        multimedia_active = false;
    }

    private void on_sink_input_info (Context c, SinkInputInfo? i, int eol) {

        if (i == null)
            return;

        if (is_active_multimedia (i)) {
            GLib.debug ("on_sink_input_info() setting multimedia sink input index to %d, sink index to %d", (int)i.index, (int)i.sink);
            _multimedia_sink_input_index = i.index;
            multimedia_volume = i.volume.max ();
            multimedia_active = true;
        }
        else if (i.index == _multimedia_sink_input_index) {
            clear_multimedia ();
        }
    }

    private void update_all_sink_inputs () {
        _pulse_context.get_sink_input_info_list (on_sink_input_info);
    }
    private void update_sink_input (uint32 index) {
        _pulse_context.get_sink_input_info (index, on_sink_input_info);
    }

    private void update_sink_input_soon (uint32 index) {

        _pending_sink_inputs.add (index);

        if (_pending_sink_inputs_timer == 0) {
            _pending_sink_inputs_timer = Timeout.add (soon_interval_msec, () => {
                _pending_sink_inputs_timer = 0;
                _pending_sink_inputs.foreach ((i) => update_sink_input (i));
                _pending_sink_inputs.remove_all ();
                return Source.REMOVE;
            });
        }
    }

        private void context_events_cb (Context c, Context.SubscriptionEventType t, uint32 index) {
        switch (t & Context.SubscriptionEventType.FACILITY_MASK)
        {
            case Context.SubscriptionEventType.SINK_INPUT:
                switch (t & Context.SubscriptionEventType.TYPE_MASK)
                {
                    // if a SinkInput changed, get its updated info
                    // to keep our multimedia indices up-to-date
                    case Context.SubscriptionEventType.NEW:
                    case Context.SubscriptionEventType.CHANGE:
                        update_sink_input_soon (index);
                        break;

                    // if the multimedia sink input was removed,
                    // reset our mm fields and look for a new mm sink input
                    case Context.SubscriptionEventType.REMOVE:
                        if (index == _multimedia_sink_input_index) {
                            clear_multimedia ();
                            update_all_sink_inputs ();
                        }
                        break;

                    default:
                        GLib.debug ("Sink input event not known.");
                        break;
                }
                                break;

            default:
                break;
        }
    }

    private void pulse_context_state_callback (Context c) {
        switch (c.get_state ()) {
            case Context.State.READY:
                c.set_subscribe_callback (context_events_cb);
                c.subscribe (PulseAudio.Context.SubscriptionMask.SINK |
                             PulseAudio.Context.SubscriptionMask.SINK_INPUT);
                update_all_sink_inputs ();
                break;

            case Context.State.FAILED:
            case Context.State.TERMINATED:
                pulse_reconnect_soon ();
                break;

            default:
                break;
        }
    }

    private void pulse_disconnect () {
        if (_pulse_context != null) {
            _pulse_context.disconnect ();
            _pulse_context = null;
        }
    }

    private void pulse_reconnect_soon () {
        if (_pulse_reconnect_timer == 0) {
            _pulse_reconnect_timer = Timeout.add_seconds (2, () => {
                _pulse_reconnect_timer = 0;
                pulse_reconnect ();
                return Source.REMOVE;
            });
        }
    }

    void pulse_reconnect () {
        pulse_disconnect ();

        /* Unity Settings Daemon specifics */
        var props = new Proplist ();

        if (AyatanaCommon.utils_is_unity())
        {
            props.sets (Proplist.PROP_APPLICATION_NAME, "Ubuntu Audio Settings");
            props.sets (Proplist.PROP_APPLICATION_ID, "com.canonical.settings.sound");
            props.sets (Proplist.PROP_APPLICATION_ICON_NAME, "multimedia-volume-control");
            props.sets (Proplist.PROP_APPLICATION_VERSION, "0.1");
        }

        _pulse_context = new PulseAudio.Context (_pgloop.get_api(), null, props);
        _pulse_context.set_state_callback (pulse_context_state_callback);

        unowned string server_string = Environment.get_variable ("PULSE_SERVER");
        if (_pulse_context.connect (server_string, Context.Flags.NOFAIL, null) < 0)
            GLib.warning ("pa_context_connect() failed: %s\n", PulseAudio.strerror(_pulse_context.errno()));
    }
}