[SCM] libgroove/upstream: GroovePlaylist: rename `volume` to `gain`

[andrewrk-guest at users.alioth.debian.org]

The following commit has been merged in the upstream branch:
commit 53f36a29d183fdae2e00e140b18ac37ebb10f763
Author: Andrew Kelley <superjoe30 at gmail.com>
Date:   Sun May 11 16:50:25 2014 -0700

    GroovePlaylist: rename `volume` to `gain`

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 52d85fc..637bfc7 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -7,6 +7,9 @@
  * fingerprinter: info struct contains raw fingerprint instead of
    compressed string. closes #61
  * ability to set true peak on playlist items. closes #50
+ * GroovePlaylist: `volume` renamed to `gain`
+   - `groove_playlist_set_gain` renamed to `groove_playlist_set_item_gain`
+   - `groove_playlist_set_volume` renamed to `groove_playlist_set_gain`
 
 ### Version 3.1.1 (2014-04-21)
 
diff --git a/example/playlist.c b/example/playlist.c
index 0399579..e538f70 100644
--- a/example/playlist.c
+++ b/example/playlist.c
@@ -35,7 +35,7 @@ int main(int argc, char * argv[]) {
                 return usage(exe);
             } else if (strcmp(arg, "volume") == 0) {
                 double volume = atof(argv[++i]);
-                groove_playlist_set_volume(playlist, volume);
+                groove_playlist_set_gain(playlist, volume);
             } else {
                 return usage(exe);
             }
diff --git a/groove/groove.h b/groove/groove.h
index d441cf9..15efc2a 100644
--- a/groove/groove.h
+++ b/groove/groove.h
@@ -174,9 +174,10 @@ struct GroovePlaylist {
     struct GroovePlaylistItem *head;
     struct GroovePlaylistItem *tail;
 
-    /* in float format, defaults to 1.0
+    /* volume adjustment in float format which applies to all playlist items
+     * and all sinks. defaults to 1.0.
      */
-    double volume;
+    double gain;
 };
 
 /* a playlist manages keeping an audio buffer full
@@ -234,15 +235,14 @@ void groove_playlist_clear(struct GroovePlaylist *playlist);
 /* return the count of playlist items */
 int groove_playlist_count(struct GroovePlaylist *playlist);
 
-void groove_playlist_set_gain(struct GroovePlaylist *playlist,
+void groove_playlist_set_gain(struct GroovePlaylist *playlist, double gain);
+
+void groove_playlist_set_item_gain(struct GroovePlaylist *playlist,
         struct GroovePlaylistItem *item, double gain);
 
-void groove_playlist_set_peak(struct GroovePlaylist *playlist,
+void groove_playlist_set_item_peak(struct GroovePlaylist *playlist,
         struct GroovePlaylistItem *item, double peak);
 
-/* value is in float format. defaults to 1.0 */
-void groove_playlist_set_volume(struct GroovePlaylist *playlist, double volume);
-
 /************ GrooveBuffer ****************/
 
 #define GROOVE_BUFFER_NO  0
diff --git a/groove/playlist.c b/groove/playlist.c
index caf1025..a34c071 100644
--- a/groove/playlist.c
+++ b/groove/playlist.c
@@ -639,7 +639,7 @@ static int audioq_purge(struct GrooveQueue *queue, void *obj) {
 static void update_playlist_volume(struct GroovePlaylist *playlist) {
     struct GroovePlaylistPrivate *p = (struct GroovePlaylistPrivate *) playlist;
     struct GroovePlaylistItem *item = p->decode_head;
-    p->volume = playlist->volume * item->gain;
+    p->volume = playlist->gain * item->gain;
     p->peak = item->peak;
 }
 
@@ -876,7 +876,7 @@ struct GroovePlaylist * groove_playlist_create(void) {
     struct GroovePlaylist *playlist = &p->externals;
 
     // the one that the playlist can read
-    playlist->volume = 1.0;
+    playlist->gain = 1.0;
     // the other volume multiplied by the playlist item's gain
     p->volume = 1.0;
 
@@ -1102,7 +1102,7 @@ int groove_playlist_count(struct GroovePlaylist *playlist) {
     return count;
 }
 
-void groove_playlist_set_gain(struct GroovePlaylist *playlist, struct GroovePlaylistItem *item,
+void groove_playlist_set_item_gain(struct GroovePlaylist *playlist, struct GroovePlaylistItem *item,
         double gain)
 {
     struct GroovePlaylistPrivate *p = (struct GroovePlaylistPrivate *) playlist;
@@ -1115,7 +1115,7 @@ void groove_playlist_set_gain(struct GroovePlaylist *playlist, struct GroovePlay
     pthread_mutex_unlock(&p->decode_head_mutex);
 }
 
-void groove_playlist_set_peak(struct GroovePlaylist *playlist, struct GroovePlaylistItem *item,
+void groove_playlist_set_item_peak(struct GroovePlaylist *playlist, struct GroovePlaylistItem *item,
         double peak)
 {
     struct GroovePlaylistPrivate *p = (struct GroovePlaylistPrivate *) playlist;
@@ -1145,11 +1145,11 @@ void groove_playlist_position(struct GroovePlaylist *playlist, struct GroovePlay
     pthread_mutex_unlock(&p->decode_head_mutex);
 }
 
-void groove_playlist_set_volume(struct GroovePlaylist *playlist, double volume) {
+void groove_playlist_set_gain(struct GroovePlaylist *playlist, double gain) {
     struct GroovePlaylistPrivate *p = (struct GroovePlaylistPrivate *) playlist;
 
     pthread_mutex_lock(&p->decode_head_mutex);
-    playlist->volume = volume;
+    playlist->gain = gain;
     if (p->decode_head)
         update_playlist_volume(playlist);
     pthread_mutex_unlock(&p->decode_head_mutex);

-- 
libgroove packaging