changing 'channel' to 'track' to avoid naming overlap

Original commit message from CVS:
changing 'channel' to 'track' to avoid naming overlap

diff --git a/gst-libs/gst/interfaces/mixer.c b/gst-libs/gst/interfaces/mixer.c
index 329c8a3db34218e986c66b0177366e88337efc70..8dbc6ad564b298721adb89bbb8bbafb3770ffc87 100644 (file)
--- a/gst-libs/gst/interfaces/mixer.c
+++ b/gst-libs/gst/interfaces/mixer.c
@@ -59,7 +59,7 @@ static void
 gst_mixer_class_init (GstMixerClass *klass)
 {
   /* default virtual functions */
-  klass->list_channels = NULL;
+  klass->list_tracks = NULL;
   klass->set_volume = NULL;
   klass->get_volume = NULL;
   klass->set_mute = NULL;
@@ -67,67 +67,67 @@ gst_mixer_class_init (GstMixerClass *klass)
 }
 
 const GList *
-gst_mixer_list_channels        (GstMixer *mixer)
+gst_mixer_list_tracks  (GstMixer *mixer)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
-  if (klass->list_channels) {
-    return klass->list_channels (mixer);
+  if (klass->list_tracks) {
+    return klass->list_tracks (mixer);
   }
 
   return NULL;
 }
 
 void
-gst_mixer_set_volume (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gint            *volumes)
+gst_mixer_set_volume (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gint          *volumes)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_volume) {
-    klass->set_volume (mixer, channel, volumes);
+    klass->set_volume (mixer, track, volumes);
   }
 }
 
 void
-gst_mixer_get_volume (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gint            *volumes)
+gst_mixer_get_volume (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gint          *volumes)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->get_volume) {
-    klass->get_volume (mixer, channel, volumes);
+    klass->get_volume (mixer, track, volumes);
   } else {
     gint i;
 
-    for (i = 0; i < channel->num_channels; i++) {
+    for (i = 0; i < track->num_channels; i++) {
       volumes[i] = 0;
     }
   }
 }
 
 void
-gst_mixer_set_mute (GstMixer        *mixer,
-                   GstMixerChannel *channel,
-                   gboolean         mute)
+gst_mixer_set_mute (GstMixer      *mixer,
+                   GstMixerTrack *track,
+                   gboolean       mute)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_mute) {
-    klass->set_mute (mixer, channel, mute);
+    klass->set_mute (mixer, track, mute);
   }
 }
 
 void
-gst_mixer_set_record (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gboolean         record)
+gst_mixer_set_record (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gboolean       record)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_record) {
-    klass->set_record (mixer, channel, record);
+    klass->set_record (mixer, track, record);
   }
 }

diff --git a/gst-libs/gst/interfaces/mixer.h b/gst-libs/gst/interfaces/mixer.h
index 565ba8db7141e2e27c842b3b970cde3e90b94fcf..5639758e4ddfcad346c940a32450492ee085b7a6 100644 (file)
--- a/gst-libs/gst/interfaces/mixer.h
+++ b/gst-libs/gst/interfaces/mixer.h
@@ -39,27 +39,33 @@ G_BEGIN_DECLS
 #define GST_MIXER_GET_CLASS(inst) \
   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_MIXER, GstMixerClass))
 
-/* I fully realise that this naming being used here is confusing.
- * A channel is referred to both as the number of simultaneous
- * sound streams the input can handle as well as the in-/output
- * itself. We need to fix this some day, I just cannot come up
- * with something better.
+/* In this interface, a `track' is a unit of recording or playback, pretty much
+ * equivalent to what comes in or goes out through a GstPad. Each track can have
+ * one or more `channels', which are logical parts of the track. A `stereo
+ * track', then, would be one stream with two channels, while a `mono track'
+ * would be a stream with a single channel. More complex examples are possible
+ * as well ; for example, professional audio hardware might handle audio tracks
+ * with 8 or 16 channels each.
+ *
+ * All these are audio terms. I don't know exactly what this would translate to
+ * for video, but a track might be an entire video stream, and a channel might
+ * be the information for one of the colors in the stream.
  */
 
-#define GST_MIXER_CHANNEL_INPUT  (1<<0)
-#define GST_MIXER_CHANNEL_OUTPUT (1<<1)
-#define GST_MIXER_CHANNEL_MUTE   (1<<2)
-#define GST_MIXER_CHANNEL_RECORD (1<<3)
+#define GST_MIXER_TRACK_INPUT  (1<<0)
+#define GST_MIXER_TRACK_OUTPUT (1<<1)
+#define GST_MIXER_TRACK_MUTE   (1<<2)
+#define GST_MIXER_TRACK_RECORD (1<<3)
 
-typedef struct _GstMixerChannel {
+typedef struct _GstMixerTrack {
   gchar *label;
   gint   num_channels,
          flags,
         min_volume, max_volume;
-} GstMixerChannel;
+} GstMixerTrack;
 
-#define GST_MIXER_CHANNEL_HAS_FLAG(channel, flag) \
-  ((channel)->flags & flag)
+#define GST_MIXER_TRACK_HAS_FLAG(track, flag) \
+  ((track)->flags & flag)
 
 typedef struct _GstMixer GstMixer;
 
@@ -67,21 +73,21 @@ typedef struct _GstMixerClass {
   GTypeInterface klass;
 
   /* virtual functions */
-  const GList *  (* list_channels) (GstMixer        *mixer);
-
-  void           (* set_volume)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gint            *volumes);
-  void           (* get_volume)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gint            *volumes);
-
-  void           (* set_mute)      (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gboolean         mute);
-  void           (* set_record)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gboolean         record);
+  const GList *  (* list_tracks)   (GstMixer      *mixer);
+
+  void           (* set_volume)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gint          *volumes);
+  void           (* get_volume)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gint          *volumes);
+
+  void           (* set_mute)      (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gboolean       mute);
+  void           (* set_record)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gboolean       record);
 
   GST_CLASS_PADDING
 } GstMixerClass;
@@ -89,19 +95,19 @@ typedef struct _GstMixerClass {
 GType          gst_mixer_get_type      (void);
 
 /* virtual class function wrappers */
-const GList *  gst_mixer_list_channels (GstMixer        *mixer);
-void           gst_mixer_set_volume    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gint            *volumes);
-void           gst_mixer_get_volume    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gint            *volumes);
-void           gst_mixer_set_mute      (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gboolean         mute);
-void           gst_mixer_set_record    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gboolean         record);
+const GList *  gst_mixer_list_tracks   (GstMixer      *mixer);
+void           gst_mixer_set_volume    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gint          *volumes);
+void           gst_mixer_get_volume    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gint          *volumes);
+void           gst_mixer_set_mute      (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gboolean       mute);
+void           gst_mixer_set_record    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gboolean       record);
 
 G_END_DECLS
 

diff --git a/gst-libs/gst/mixer/mixer.c b/gst-libs/gst/mixer/mixer.c
index 329c8a3db34218e986c66b0177366e88337efc70..8dbc6ad564b298721adb89bbb8bbafb3770ffc87 100644 (file)
--- a/gst-libs/gst/mixer/mixer.c
+++ b/gst-libs/gst/mixer/mixer.c
@@ -59,7 +59,7 @@ static void
 gst_mixer_class_init (GstMixerClass *klass)
 {
   /* default virtual functions */
-  klass->list_channels = NULL;
+  klass->list_tracks = NULL;
   klass->set_volume = NULL;
   klass->get_volume = NULL;
   klass->set_mute = NULL;
@@ -67,67 +67,67 @@ gst_mixer_class_init (GstMixerClass *klass)
 }
 
 const GList *
-gst_mixer_list_channels        (GstMixer *mixer)
+gst_mixer_list_tracks  (GstMixer *mixer)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
-  if (klass->list_channels) {
-    return klass->list_channels (mixer);
+  if (klass->list_tracks) {
+    return klass->list_tracks (mixer);
   }
 
   return NULL;
 }
 
 void
-gst_mixer_set_volume (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gint            *volumes)
+gst_mixer_set_volume (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gint          *volumes)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_volume) {
-    klass->set_volume (mixer, channel, volumes);
+    klass->set_volume (mixer, track, volumes);
   }
 }
 
 void
-gst_mixer_get_volume (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gint            *volumes)
+gst_mixer_get_volume (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gint          *volumes)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->get_volume) {
-    klass->get_volume (mixer, channel, volumes);
+    klass->get_volume (mixer, track, volumes);
   } else {
     gint i;
 
-    for (i = 0; i < channel->num_channels; i++) {
+    for (i = 0; i < track->num_channels; i++) {
       volumes[i] = 0;
     }
   }
 }
 
 void
-gst_mixer_set_mute (GstMixer        *mixer,
-                   GstMixerChannel *channel,
-                   gboolean         mute)
+gst_mixer_set_mute (GstMixer      *mixer,
+                   GstMixerTrack *track,
+                   gboolean       mute)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_mute) {
-    klass->set_mute (mixer, channel, mute);
+    klass->set_mute (mixer, track, mute);
   }
 }
 
 void
-gst_mixer_set_record (GstMixer        *mixer,
-                     GstMixerChannel *channel,
-                     gboolean         record)
+gst_mixer_set_record (GstMixer      *mixer,
+                     GstMixerTrack *track,
+                     gboolean       record)
 {
   GstMixerClass *klass = GST_MIXER_GET_CLASS (mixer);
 
   if (klass->set_record) {
-    klass->set_record (mixer, channel, record);
+    klass->set_record (mixer, track, record);
   }
 }

diff --git a/gst-libs/gst/mixer/mixer.h b/gst-libs/gst/mixer/mixer.h
index 565ba8db7141e2e27c842b3b970cde3e90b94fcf..5639758e4ddfcad346c940a32450492ee085b7a6 100644 (file)
--- a/gst-libs/gst/mixer/mixer.h
+++ b/gst-libs/gst/mixer/mixer.h
@@ -39,27 +39,33 @@ G_BEGIN_DECLS
 #define GST_MIXER_GET_CLASS(inst) \
   (G_TYPE_INSTANCE_GET_INTERFACE ((inst), GST_TYPE_MIXER, GstMixerClass))
 
-/* I fully realise that this naming being used here is confusing.
- * A channel is referred to both as the number of simultaneous
- * sound streams the input can handle as well as the in-/output
- * itself. We need to fix this some day, I just cannot come up
- * with something better.
+/* In this interface, a `track' is a unit of recording or playback, pretty much
+ * equivalent to what comes in or goes out through a GstPad. Each track can have
+ * one or more `channels', which are logical parts of the track. A `stereo
+ * track', then, would be one stream with two channels, while a `mono track'
+ * would be a stream with a single channel. More complex examples are possible
+ * as well ; for example, professional audio hardware might handle audio tracks
+ * with 8 or 16 channels each.
+ *
+ * All these are audio terms. I don't know exactly what this would translate to
+ * for video, but a track might be an entire video stream, and a channel might
+ * be the information for one of the colors in the stream.
  */
 
-#define GST_MIXER_CHANNEL_INPUT  (1<<0)
-#define GST_MIXER_CHANNEL_OUTPUT (1<<1)
-#define GST_MIXER_CHANNEL_MUTE   (1<<2)
-#define GST_MIXER_CHANNEL_RECORD (1<<3)
+#define GST_MIXER_TRACK_INPUT  (1<<0)
+#define GST_MIXER_TRACK_OUTPUT (1<<1)
+#define GST_MIXER_TRACK_MUTE   (1<<2)
+#define GST_MIXER_TRACK_RECORD (1<<3)
 
-typedef struct _GstMixerChannel {
+typedef struct _GstMixerTrack {
   gchar *label;
   gint   num_channels,
          flags,
         min_volume, max_volume;
-} GstMixerChannel;
+} GstMixerTrack;
 
-#define GST_MIXER_CHANNEL_HAS_FLAG(channel, flag) \
-  ((channel)->flags & flag)
+#define GST_MIXER_TRACK_HAS_FLAG(track, flag) \
+  ((track)->flags & flag)
 
 typedef struct _GstMixer GstMixer;
 
@@ -67,21 +73,21 @@ typedef struct _GstMixerClass {
   GTypeInterface klass;
 
   /* virtual functions */
-  const GList *  (* list_channels) (GstMixer        *mixer);
-
-  void           (* set_volume)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gint            *volumes);
-  void           (* get_volume)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gint            *volumes);
-
-  void           (* set_mute)      (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gboolean         mute);
-  void           (* set_record)    (GstMixer        *mixer,
-                                   GstMixerChannel *channel,
-                                   gboolean         record);
+  const GList *  (* list_tracks)   (GstMixer      *mixer);
+
+  void           (* set_volume)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gint          *volumes);
+  void           (* get_volume)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gint          *volumes);
+
+  void           (* set_mute)      (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gboolean       mute);
+  void           (* set_record)    (GstMixer      *mixer,
+                                   GstMixerTrack *track,
+                                   gboolean       record);
 
   GST_CLASS_PADDING
 } GstMixerClass;
@@ -89,19 +95,19 @@ typedef struct _GstMixerClass {
 GType          gst_mixer_get_type      (void);
 
 /* virtual class function wrappers */
-const GList *  gst_mixer_list_channels (GstMixer        *mixer);
-void           gst_mixer_set_volume    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gint            *volumes);
-void           gst_mixer_get_volume    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gint            *volumes);
-void           gst_mixer_set_mute      (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gboolean         mute);
-void           gst_mixer_set_record    (GstMixer        *mixer,
-                                        GstMixerChannel *channel,
-                                        gboolean         record);
+const GList *  gst_mixer_list_tracks   (GstMixer      *mixer);
+void           gst_mixer_set_volume    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gint          *volumes);
+void           gst_mixer_get_volume    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gint          *volumes);
+void           gst_mixer_set_mute      (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gboolean       mute);
+void           gst_mixer_set_record    (GstMixer      *mixer,
+                                        GstMixerTrack *track,
+                                        gboolean       record);
 
 G_END_DECLS