Hi, many thanks for the review! On Wed, Apr 15, 2015 at 12:05:53PM +0200, Marc-André Lureau wrote: > Hi > > On Tue, Apr 14, 2015 at 2:18 PM, Victor Toso <victortoso@xxxxxxxxxx> wrote: > > > In case of volume-sync between client and guest, we request volume-info > > from the availables streams and if the stream is not available we rely > > on ext-stream-restore. > > > > By using ext-stream-restore we can get the last stream data of the > > application that is stored by PulseAudio. > > > > Related: https://bugzilla.redhat.com/show_bug.cgi?id=1012868 > > --- > > gtk/spice-pulse.c | 412 > > ++++++++++++++++++++++++++++++++++++++++++++++++++++-- > > 1 file changed, 403 insertions(+), 9 deletions(-) > > > > diff --git a/gtk/spice-pulse.c b/gtk/spice-pulse.c > > index c583032..811449d 100644 > > --- a/gtk/spice-pulse.c > > +++ b/gtk/spice-pulse.c > > @@ -25,18 +25,31 @@ > > > > #include <pulse/glib-mainloop.h> > > #include <pulse/pulseaudio.h> > > +#include <pulse/ext-stream-restore.h> > > > > #define SPICE_PULSE_GET_PRIVATE(obj) \ > > (G_TYPE_INSTANCE_GET_PRIVATE((obj), SPICE_TYPE_PULSE, > > SpicePulsePrivate)) > > > > +struct async_task { > > + SpicePulse *pulse; > > + SpiceMainChannel *main_channel; > > + GSimpleAsyncResult *res; > > + GAsyncReadyCallback callback; > > + gpointer user_data; > > + gboolean is_playback; > > > > You should track and cancel associated pa_operation when cancelling tasks That's true, I'll fix that. > > +}; > > + > > struct stream { > > - pa_sample_spec spec; > > - pa_stream *stream; > > - int state; > > - pa_operation *uncork_op; > > - pa_operation *cork_op; > > - gboolean started; > > - guint num_underflow; > > + pa_sample_spec spec; > > + pa_stream *stream; > > + int state; > > + pa_operation *uncork_op; > > + pa_operation *cork_op; > > + gboolean started; > > + guint num_underflow; > > + gboolean changed; > > > > It took me a while to understand "changed", perhaps rename it > "info_updated" ? info_updated is better indeed. > + gchar *name; > > + pa_ext_stream_restore_info info; > > }; > > > > struct _SpicePulsePrivate { > > @@ -50,6 +63,8 @@ struct _SpicePulsePrivate { > > struct stream record; > > guint last_delay; > > guint target_delay; > > + gboolean restore_stream_info; > > + GList *results; > > }; > > > > G_DEFINE_TYPE(SpicePulse, spice_pulse, SPICE_TYPE_AUDIO) > > @@ -77,6 +92,18 @@ static const char *context_state_names[] = { > > static void stream_stop(SpicePulse *pulse, struct stream *s); > > static gboolean connect_channel(SpiceAudio *audio, SpiceChannel *channel); > > static void channel_weak_notified(gpointer data, GObject > > *where_the_object_was); > > +static void pulse_stream_restore_info_async_complete(SpicePulse *pulse, > > + struct async_task *task, const gchar *err_msg); > > > > I would use split it in 2 functions: > > spice_pulse_complete_async_task > spice_pulse_complete_all_async_tasks I agree with this as well! > > +static void spice_pulse_get_playback_volume_info_async(SpiceAudio *audio, > > GCancellable *cancellable, > > + SpiceMainChannel *main_channel, GAsyncReadyCallback callback, > > gpointer user_data); > > +static gboolean spice_pulse_get_playback_volume_info_finish(SpiceAudio > > *audio, GAsyncResult *res, > > + gboolean *mute, guint8 *nchannels, guint16 **volume, GError > > **error); > > +static void spice_pulse_get_record_volume_info_async(SpiceAudio *audio, > > GCancellable *cancellable, > > + SpiceMainChannel *main_channel, GAsyncReadyCallback callback, > > gpointer user_data); > > +static gboolean spice_pulse_get_record_volume_info_finish(SpiceAudio > > *audio,GAsyncResult *res, > > + gboolean *mute, guint8 *nchannels, guint16 **volume, GError > > **error); > > +static void stream_restore_read_cb(pa_context *context, > > + const pa_ext_stream_restore_info *info, int eol, void *userdata); > > > > static void spice_pulse_finalize(GObject *obj) > > { > > @@ -118,6 +145,15 @@ static void spice_pulse_dispose(GObject *obj) > > pa_operation_unref(p->record.cork_op); > > p->record.cork_op = NULL; > > > > + if (p->results != NULL) > > + pulse_stream_restore_info_async_complete(pulse, NULL, "PulseAudio > > is being dispose"); > > + > > + if (p->playback.name) > > + g_free(p->playback.name); > > + > > + if (p->record.name) > > + g_free(p->record.name); > > + > > if (p->pchannel) > > g_object_weak_unref(G_OBJECT(p->pchannel), channel_weak_notified, > > pulse); > > p->pchannel = NULL; > > @@ -140,6 +176,10 @@ static void spice_pulse_class_init(SpicePulseClass > > *klass) > > SpiceAudioClass *audio_class = SPICE_AUDIO_CLASS(klass); > > > > audio_class->connect_channel = connect_channel; > > + audio_class->get_playback_volume_info_async = > > spice_pulse_get_playback_volume_info_async; > > + audio_class->get_playback_volume_info_finish = > > spice_pulse_get_playback_volume_info_finish; > > + audio_class->get_record_volume_info_async = > > spice_pulse_get_record_volume_info_async; > > + audio_class->get_record_volume_info_finish = > > spice_pulse_get_record_volume_info_finish; > > > > gobject_class->finalize = spice_pulse_finalize; > > gobject_class->dispose = spice_pulse_dispose; > > @@ -812,18 +852,39 @@ static void context_state_callback(pa_context *c, > > void *userdata) > > > > if (!p->playback.stream && p->playback.started) > > create_playback(SPICE_PULSE(userdata)); > > + > > + if (p->restore_stream_info == TRUE) { > > + pa_operation *op = pa_ext_stream_restore_read(p->context, > > + > > stream_restore_read_cb, > > + pulse); > > + if (!op) { > > + pulse_stream_restore_info_async_complete(pulse, NULL, > > + pa_strerror(pa_context_errno(p->context))); > > + } else { > > + pa_operation_unref(op); > > + } > > + } > > break; > > } > > > > case PA_CONTEXT_FAILED: > > g_warning("PulseAudio context failed %s", > > pa_strerror(pa_context_errno(p->context))); > > - break; > > + goto context_fail; > > > > case PA_CONTEXT_TERMINATED: > > default: > > SPICE_DEBUG("PulseAudio context terminated"); > > - break; > > + goto context_fail; > > + } > > + > > + return; > > + > > +context_fail: > > + if (p->restore_stream_info == TRUE) { > > + const gchar *errmsg = pa_strerror(pa_context_errno(p->context)); > > + errmsg = (errmsg != NULL) ? errmsg : "PulseAudio context > > terminated"; > > + pulse_stream_restore_info_async_complete(pulse, NULL, errmsg); > > } > > } > > > > @@ -849,9 +910,342 @@ SpicePulse *spice_pulse_new(SpiceSession *session, > > GMainContext *context, > > goto error; > > } > > > > + p->playback.name = g_strconcat("sink-input-by-application-name:", > > + g_get_application_name(), NULL); > > + p->record.name = g_strconcat("source-output-by-application-name:", > > + g_get_application_name(), NULL); > > return pulse; > > > > error: > > g_object_unref(pulse); > > return NULL; > > } > > + > > +static void free_async_task(struct async_task *task) > > +{ > > + if (task == NULL) > > + return; > > + > > + if (task->pulse) > > + g_object_unref(task->pulse); > > + > > + if (task->res) > > + g_object_unref(task->res); > > + > > + if (task->main_channel) > > + g_object_unref(task->main_channel); > > + > > + g_free(task); > > +} > > + > > +static void complete_task(SpicePulse *pulse, struct async_task *task, > > const gchar *err_msg) > > +{ > > + SpicePulsePrivate *p = pulse->priv; > > + > > + /* If we do have any err_msg, we failed */ > > + if (err_msg != NULL) { > > + g_simple_async_result_set_op_res_gboolean(task->res, FALSE); > > + g_simple_async_result_set_error(task->res, > > + SPICE_CLIENT_ERROR, > > + SPICE_CLIENT_ERROR_FAILED, > > + "restore-info failed due %s", > > + err_msg); > > + /* Volume-info does not change if stream is not found */ > > + } else if ((task->is_playback == TRUE && p->playback.changed == > > FALSE) || > > + (task->is_playback == FALSE && p->record.changed == > > FALSE)) { > > + g_simple_async_result_set_op_res_gboolean(task->res, FALSE); > > + g_simple_async_result_set_error(task->res, > > + SPICE_CLIENT_ERROR, > > + SPICE_CLIENT_ERROR_FAILED, > > + "Stream not found by pulse"); > > + } else { > > + g_simple_async_result_set_op_res_gboolean(task->res, TRUE); > > + } > > + > > + /* As all async calls to PulseAudio are done with glib mainloop, it is > > + * safe to complete the operation synchronously here. */ > > + g_simple_async_result_complete(task->res); > > +} > > + > > +static void pulse_stream_restore_info_async_complete(SpicePulse *pulse, > > + struct async_task > > *task, > > + const gchar *err_msg) > > +{ > > + SpicePulsePrivate *p = pulse->priv; > > + GList *it; > > + > > + /* Only complete this task */ > > + if (task != NULL) { > > + complete_task(pulse, task, err_msg); > > + if (p->results != NULL) { > > + p->results = g_list_remove(p->results, task); > > + SPICE_DEBUG("%s Number of async task is %d", > > + __func__, g_list_length(p->results)); > > + } > > + free_async_task(task); > > + return; > > + } > > + > > + /* Complete all tasks in list */ > > + for(it = p->results; it != NULL; it = it->next) { > > + struct async_task *task = it->data; > > + complete_task(pulse, task, err_msg); > > + free_async_task(task); > > + } > > + g_list_free(p->results); > > + p->results = NULL; > > + p->restore_stream_info = FALSE; > > + SPICE_DEBUG("%s Number of async task is %d", __func__, > > g_list_length(p->results)); > > > > You are using __func__ in many places, I think G_STRFUNC could be better? > SPICE_DEBUG() already has G_STRLOC so perhaps not really needed I left this by mistake. It was useful to me while testing. I'll remove. > > +} > > + > > +static void stream_restore_read_cb(pa_context *context, > > + const pa_ext_stream_restore_info *info, > > + int eol, > > + void *userdata) > > +{ > > + SpicePulsePrivate *p = SPICE_PULSE(userdata)->priv; > > + struct stream *pstream = NULL; > > + > > + if (eol) { > > + pulse_stream_restore_info_async_complete(SPICE_PULSE(userdata), > > NULL, NULL); > > + return; > > + } > > + > > + if (g_strcmp0(info->name, p->playback.name) == 0) { > > + pstream = &p->playback; > > + } else if (g_strcmp0(info->name, p->record.name) == 0) { > > + pstream = &p->record; > > + } else { > > + /* This is not the stream you are looking for. */ > > > > g_warn_if_reached() ? Not really, it is a sink-input or source-output information from other application. Ignoring is fine. > > + return; > > + } > > + > > + if (info->channel_map.channels == 0) { > > + SPICE_DEBUG("%s - Number of channels stored is zero. Ignore. > > (%s)", __func__, info->name); > > + return; > > + > > What if there is already a playing stream, is this going to reset it to > restore value? Sorry, I think I did not understand. This if () is only to avoid issues with restore-info. If the number of channels stored in pulseaudio database is zero, probably we are not interested in the volume-information. I'm not sure when I hit this issue, probably when you have a new database and we start the pulseaudio context but do not have any audio stream. I believe it saved the application information in the database, with default values but I'm not sure. > > } > > + > > + pstream->changed = TRUE; > > + pstream->info.name = pstream->name; > > + pstream->info.mute = info->mute; > > + memcpy(&pstream->info.channel_map, &info->channel_map, > > sizeof(pa_channel_map)); > > > No need for memcpy please: > pstream->info.channel_map = info->channel_map; Okay. > > + memcpy(&pstream->info.volume, &info->volume, sizeof(pa_cvolume)); > > +} > > + > > +static void source_output_info_cb(pa_context *context, > > + const pa_source_output_info *info, > > + int eol, > > + void *userdata) > > +{ > > + struct async_task *task = userdata; > > + SpicePulsePrivate *p = task->pulse->priv; > > + struct stream *pstream = &p->record; > > + > > + if (eol) { > > + pulse_stream_restore_info_async_complete(task->pulse, task, NULL); > > + return; > > + } > > + > > + pstream->changed = TRUE; > > + pstream->info.name = pstream->name; > > + pstream->info.mute = info->mute; > > + memcpy(&pstream->info.channel_map, &info->channel_map, > > sizeof(pa_channel_map)); > > + memcpy(&pstream->info.volume, &info->volume, sizeof(pa_cvolume)); > > +} > > + > > +static void sink_input_info_cb(pa_context *context, > > + const pa_sink_input_info *info, > > + int eol, > > + void *userdata) > > +{ > > + struct async_task *task = userdata; > > + SpicePulsePrivate *p = task->pulse->priv; > > + struct stream *pstream = &p->playback; > > + > > + if (eol) { > > + struct async_task *task = userdata; > > > > already declared above Indeed. > > + pulse_stream_restore_info_async_complete(task->pulse, task, NULL); > > + return; > > + } > > + > > + pstream->changed = TRUE; > > + pstream->info.name = pstream->name; > > + pstream->info.mute = info->mute; > > + memcpy(&pstream->info.channel_map, &info->channel_map, > > sizeof(pa_channel_map)); > > + memcpy(&pstream->info.volume, &info->volume, sizeof(pa_cvolume)); > > +} > > + > > +/* to avoid code duplication */ > > +static void pulse_stream_restore_info_async(gboolean is_playback, > > + SpiceAudio *audio, > > + GCancellable *cancellable, > > + SpiceMainChannel > > *main_channel, > > + GAsyncReadyCallback callback, > > + gpointer user_data) > > +{ > > + SpicePulsePrivate *p = SPICE_PULSE(audio)->priv; > > + GSimpleAsyncResult *simple; > > + struct async_task *task = g_malloc(sizeof(struct async_task)); > > + pa_operation *op = NULL; > > + > > + simple = g_simple_async_result_new(G_OBJECT(audio), > > + callback, > > + user_data, > > + pulse_stream_restore_info_async); > > + g_simple_async_result_set_check_cancellable (simple, cancellable); > > + > > + task->res = simple; > > + task->pulse = g_object_ref(audio); > > + task->callback = callback; > > + task->user_data = user_data; > > + task->is_playback = is_playback; > > + task->main_channel = g_object_ref(main_channel); > > + > > + /* If Playback/Record stream is created we use pulse API to get > > volume-info > > + * from those streams directly. If the stream is not created, > > retrieve last > > + * volume/mute values from Pulse database using the application name; > > */ > > + > > + if (is_playback == TRUE && > > + p->playback.stream != NULL && > > + pa_stream_get_index(p->playback.stream) != PA_INVALID_INDEX) { > > + SPICE_DEBUG("%s - Playback stream is created - > > get-sink-input-info", __func__); > > + p->playback.changed = FALSE; > > + op = pa_context_get_sink_input_info(p->context, > > + > > pa_stream_get_index(p->playback.stream), > > + sink_input_info_cb, > > + task); > > + if (!op) > > + goto fail; > > + pa_operation_unref(op); > > + > > + } else if (is_playback == FALSE && > > + p->record.stream != NULL && > > + pa_stream_get_index(p->record.stream) != PA_INVALID_INDEX) { > > + SPICE_DEBUG("%s - Record stream is created - > > get-source-output-info", __func__); > > + p->record.changed = FALSE; > > + op = pa_context_get_source_output_info(p->context, > > + > > pa_stream_get_index(p->record.stream), > > + source_output_info_cb, > > + task); > > + if (!op) > > + goto fail; > > + pa_operation_unref(op); > > + > > + } else if (p->results == NULL) { > > + SPICE_DEBUG("%s - Streams are not created - ext-stream-restore", > > __func__); > > + p->playback.changed = FALSE; > > + p->record.changed = FALSE; > > + if (p->playback.info.name != NULL || > > + p->record.info.name != NULL || > > + pa_context_get_state(p->context) == PA_CONTEXT_READY) { > > + > > + /* Stream is not created. Restore value from pulse db */ > > + op = pa_ext_stream_restore_read(p->context, > > stream_restore_read_cb, audio); > > + if (!op) > > + goto fail; > > + pa_operation_unref(op); > > + } else { > > + /* It is possible that we want to get volume-info before the > > + * context is in READY state. In this case, we wait for the > > + * context state change to READY. */ > > + p->restore_stream_info = TRUE; > > + } > > + } > > > > else ? adding a useless task? (if there is already a playback info request, > the record will be ignored?) It will not be ignored. Everytime that stream-restore-read is called we update the playback and record streams info (p->playback.changed and p->record.changed = FALSE above) The first task do the request operation to pulse and futher requests go directly to p->results to complete_task when pulse operations finishes. So, adding an else would be only for tasks that are waiting for an ongoing operation to finish. > > + > > + p->results = g_list_append(p->results, task); > > + SPICE_DEBUG ("%s Number of async task is %d", __func__, > > g_list_length(p->results)); > > + return; > > + > > +fail: > > + if (!op) { > > + g_simple_async_report_error_in_idle(G_OBJECT(audio), > > + callback, > > + user_data, > > + SPICE_CLIENT_ERROR, > > + SPICE_CLIENT_ERROR_FAILED, > > + "Volume-Info failed: %s", > > + > > pa_strerror(pa_context_errno(p->context))); > > + free_async_task(task); > > + } > > +} > > + > > +/* to avoid code duplication */ > > +static gboolean pulse_stream_restore_info_finish(gboolean is_playback, > > + SpiceAudio *audio, > > + GAsyncResult *res, > > + gboolean *mute, > > + guint8 *nchannels, > > + guint16 **volume, > > + GError **error) > > +{ > > + SpicePulsePrivate *p = SPICE_PULSE(audio)->priv; > > + struct stream *pstream = (is_playback) ? &p->playback : &p->record; > > + GSimpleAsyncResult *simple = (GSimpleAsyncResult *) res; > > + > > + g_return_val_if_fail(g_simple_async_result_is_valid(res, > > + G_OBJECT(audio), pulse_stream_restore_info_async), FALSE); > > + > > + if (g_simple_async_result_propagate_error(simple, error)) { > > + return FALSE; > > + } > > + > > + if (mute != NULL) { > > + *mute = (pstream->info.mute) ? TRUE : FALSE; > > + } > > + > > + if (nchannels != NULL) { > > + *nchannels = pstream->info.channel_map.channels; > > + } > > + > > + if (volume != NULL) { > > + gint i; > > + *volume = g_new(guint16, pstream->info.channel_map.channels); > > + for (i = 0; i < pstream->info.channel_map.channels; i++) { > > + (*volume)[i] = MIN(pstream->info.volume.values[i], > > G_MAXUINT16); > > + SPICE_DEBUG("%s (%s) volume at channel %d is %u", __func__, > > + (is_playback) ? "playback" : "record", i, > > (*volume)[i]); > > + } > > + } > > + > > + return g_simple_async_result_get_op_res_gboolean(simple); > > +} > > + > > +static void spice_pulse_get_playback_volume_info_async(SpiceAudio *audio, > > + GCancellable > > *cancellable, > > + SpiceMainChannel > > *main_channel, > > + > > GAsyncReadyCallback callback, > > + gpointer user_data) > > +{ > > + pulse_stream_restore_info_async(TRUE, audio, cancellable, > > main_channel, callback, user_data); > > +} > > + > > +static gboolean spice_pulse_get_playback_volume_info_finish(SpiceAudio > > *audio, > > + GAsyncResult > > *res, > > + gboolean > > *mute, > > + guint8 > > *nchannels, > > + guint16 > > **volume, > > + GError > > **error) > > +{ > > + return pulse_stream_restore_info_finish(TRUE, audio, res, mute, > > + nchannels, volume, error); > > +} > > + > > +static void spice_pulse_get_record_volume_info_async(SpiceAudio *audio, > > + GCancellable > > *cancellable, > > + SpiceMainChannel > > *main_channel, > > + GAsyncReadyCallback > > callback, > > + gpointer user_data) > > +{ > > + pulse_stream_restore_info_async(FALSE, audio, cancellable, > > main_channel, callback, user_data); > > +} > > + > > +static gboolean spice_pulse_get_record_volume_info_finish(SpiceAudio > > *audio, > > + GAsyncResult > > *res, > > + gboolean *mute, > > + guint8 > > *nchannels, > > + guint16 > > **volume, > > + GError **error) > > +{ > > + return pulse_stream_restore_info_finish(FALSE, audio, res, mute, > > + nchannels, volume, error); > > +} > > -- > > 2.1.0 > > > > _______________________________________________ > > Spice-devel mailing list > > Spice-devel@xxxxxxxxxxxxxxxxxxxxx > > http://lists.freedesktop.org/mailman/listinfo/spice-devel > > I'll send the v7 of this patch and to the channel-main as well after applying the changes and re-doing a bit of testing :-) Cheers, _______________________________________________ Spice-devel mailing list Spice-devel@xxxxxxxxxxxxxxxxxxxxx http://lists.freedesktop.org/mailman/listinfo/spice-devel