ext/pulse/pulseutil.c

   1 /*
   2  *  GStreamer pulseaudio plugin
   3  *
   4  *  Copyright (c) 2004-2008 Lennart Poettering
   5  *
   6  *  gst-pulse is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU Lesser General Public License as
   8  *  published by the Free Software Foundation; either version 2.1 of the
   9  *  License, or (at your option) any later version.
  10  *
  11  *  gst-pulse is distributed in the hope that it will be useful, but
  12  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  14  *  Lesser General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU Lesser General Public
  17  *  License along with gst-pulse; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  19  *  USA.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include "pulseutil.h"
  27 #include <gst/audio/multichannel.h>
  28
  29 #ifdef HAVE_UNISTD_H
  30 # include <unistd.h>            /* getpid on UNIX */
  31 #endif
  32 #ifdef HAVE_PROCESS_H
  33 # include <process.h>           /* getpid on win32 */
  34 #endif
  35
  36 static const pa_channel_position_t gst_pos_to_pa[GST_AUDIO_CHANNEL_POSITION_NUM]
  37     = {
  38   [GST_AUDIO_CHANNEL_POSITION_FRONT_MONO] = PA_CHANNEL_POSITION_MONO,
  39   [GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT] = PA_CHANNEL_POSITION_FRONT_LEFT,
  40   [GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT] = PA_CHANNEL_POSITION_FRONT_RIGHT,
  41   [GST_AUDIO_CHANNEL_POSITION_REAR_CENTER] = PA_CHANNEL_POSITION_REAR_CENTER,
  42   [GST_AUDIO_CHANNEL_POSITION_REAR_LEFT] = PA_CHANNEL_POSITION_REAR_LEFT,
  43   [GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT] = PA_CHANNEL_POSITION_REAR_RIGHT,
  44   [GST_AUDIO_CHANNEL_POSITION_LFE] = PA_CHANNEL_POSITION_LFE,
  45   [GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER] = PA_CHANNEL_POSITION_FRONT_CENTER,
  46   [GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER] =
  47       PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
  48   [GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER] =
  49       PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
  50   [GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT] = PA_CHANNEL_POSITION_SIDE_LEFT,
  51   [GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT] = PA_CHANNEL_POSITION_SIDE_RIGHT,
  52   [GST_AUDIO_CHANNEL_POSITION_TOP_CENTER] = PA_CHANNEL_POSITION_TOP_CENTER,
  53   [GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_LEFT] =
  54       PA_CHANNEL_POSITION_TOP_FRONT_LEFT,
  55   [GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_RIGHT] =
  56       PA_CHANNEL_POSITION_TOP_FRONT_RIGHT,
  57   [GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_CENTER] =
  58       PA_CHANNEL_POSITION_TOP_FRONT_CENTER,
  59   [GST_AUDIO_CHANNEL_POSITION_TOP_REAR_LEFT] =
  60       PA_CHANNEL_POSITION_TOP_REAR_LEFT,
  61   [GST_AUDIO_CHANNEL_POSITION_TOP_REAR_RIGHT] =
  62       PA_CHANNEL_POSITION_TOP_REAR_RIGHT,
  63   [GST_AUDIO_CHANNEL_POSITION_TOP_REAR_CENTER] =
  64       PA_CHANNEL_POSITION_TOP_REAR_CENTER,
  65   [GST_AUDIO_CHANNEL_POSITION_NONE] = PA_CHANNEL_POSITION_INVALID
  66 };
  67
  68 /* All index are increased by one because PA_CHANNEL_POSITION_INVALID == -1 */
  69 static const GstAudioChannelPosition
  70     pa_to_gst_pos[GST_AUDIO_CHANNEL_POSITION_NUM]
  71     = {
  72   [PA_CHANNEL_POSITION_MONO + 1] = GST_AUDIO_CHANNEL_POSITION_FRONT_MONO,
  73   [PA_CHANNEL_POSITION_FRONT_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT,
  74   [PA_CHANNEL_POSITION_FRONT_RIGHT + 1] =
  75       GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT,
  76   [PA_CHANNEL_POSITION_REAR_CENTER + 1] =
  77       GST_AUDIO_CHANNEL_POSITION_REAR_CENTER,
  78   [PA_CHANNEL_POSITION_REAR_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_REAR_LEFT,
  79   [PA_CHANNEL_POSITION_REAR_RIGHT + 1] = GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT,
  80   [PA_CHANNEL_POSITION_LFE + 1] = GST_AUDIO_CHANNEL_POSITION_LFE,
  81   [PA_CHANNEL_POSITION_FRONT_CENTER + 1] =
  82       GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER,
  83   [PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER + 1] =
  84       GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
  85   [PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER + 1] =
  86       GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
  87   [PA_CHANNEL_POSITION_SIDE_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT,
  88   [PA_CHANNEL_POSITION_SIDE_RIGHT + 1] = GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT,
  89   [PA_CHANNEL_POSITION_INVALID + 1] = GST_AUDIO_CHANNEL_POSITION_NONE,
  90 };
  91
  92 static gboolean
  93 gstaudioformat_to_pasampleformat (GstAudioFormat format,
  94     pa_sample_format_t * sf)
  95 {
  96   switch (format) {
  97     case GST_AUDIO_FORMAT_U8:
  98       *sf = PA_SAMPLE_U8;
  99       break;
 100     case GST_AUDIO_FORMAT_S16LE:
 101       *sf = PA_SAMPLE_S16LE;
 102       break;
 103     case GST_AUDIO_FORMAT_S16BE:
 104       *sf = PA_SAMPLE_S16BE;
 105       break;
 106     case GST_AUDIO_FORMAT_F32LE:
 107       *sf = PA_SAMPLE_FLOAT32LE;
 108       break;
 109     case GST_AUDIO_FORMAT_F32BE:
 110       *sf = PA_SAMPLE_FLOAT32BE;
 111       break;
 112     case GST_AUDIO_FORMAT_S32LE:
 113       *sf = PA_SAMPLE_S32LE;
 114       break;
 115     case GST_AUDIO_FORMAT_S32BE:
 116       *sf = PA_SAMPLE_S32BE;
 117       break;
 118     case GST_AUDIO_FORMAT_S24LE:
 119       *sf = PA_SAMPLE_S24LE;
 120       break;
 121     case GST_AUDIO_FORMAT_S24BE:
 122       *sf = PA_SAMPLE_S24BE;
 123       break;
 124     case GST_AUDIO_FORMAT_S24_32LE:
 125       *sf = PA_SAMPLE_S24_32LE;
 126       break;
 127     case GST_AUDIO_FORMAT_S24_32BE:
 128       *sf = PA_SAMPLE_S24_32BE;
 129       break;
 130     default:
 131       return FALSE;
 132   }
 133   return TRUE;
 134 }
 135
 136 gboolean
 137 gst_pulse_fill_sample_spec (GstAudioRingBufferSpec * spec, pa_sample_spec * ss)
 138 {
 139   if (spec->type == GST_BUFTYPE_RAW) {
 140     if (!gstaudioformat_to_pasampleformat (GST_AUDIO_INFO_FORMAT (&spec->info),
 141             &ss->format))
 142       return FALSE;
 143   } else if (spec->type == GST_BUFTYPE_MU_LAW) {
 144     ss->format = PA_SAMPLE_ULAW;
 145   } else if (spec->type == GST_BUFTYPE_A_LAW) {
 146     ss->format = PA_SAMPLE_ALAW;
 147   } else
 148     return FALSE;
 149
 150   ss->channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 151   ss->rate = GST_AUDIO_INFO_RATE (&spec->info);
 152
 153   if (!pa_sample_spec_valid (ss))
 154     return FALSE;
 155
 156   return TRUE;
 157 }
 158
 159 gboolean
 160 gst_pulse_fill_format_info (GstAudioRingBufferSpec * spec, pa_format_info ** f,
 161     guint * channels)
 162 {
 163   pa_format_info *format;
 164   pa_sample_format_t sf = PA_SAMPLE_INVALID;
 165   GstAudioInfo *ainfo = &spec->info;
 166
 167   format = pa_format_info_new ();
 168
 169   if (spec->type == GST_BUFTYPE_MU_LAW && GST_AUDIO_INFO_WIDTH (ainfo) == 8) {
 170     format->encoding = PA_ENCODING_PCM;
 171     sf = PA_SAMPLE_ULAW;
 172   } else if (spec->type == GST_BUFTYPE_A_LAW
 173       && GST_AUDIO_INFO_WIDTH (ainfo) == 8) {
 174     format->encoding = PA_ENCODING_PCM;
 175     sf = PA_SAMPLE_ALAW;
 176   } else if (spec->type == GST_BUFTYPE_RAW) {
 177     format->encoding = PA_ENCODING_PCM;
 178     if (!gstaudioformat_to_pasampleformat (GST_AUDIO_INFO_FORMAT (ainfo), &sf))
 179       goto fail;
 180   } else if (spec->type == GST_BUFTYPE_AC3) {
 181     format->encoding = PA_ENCODING_AC3_IEC61937;
 182   } else if (spec->type == GST_BUFTYPE_EAC3) {
 183     format->encoding = PA_ENCODING_EAC3_IEC61937;
 184   } else if (spec->type == GST_BUFTYPE_DTS) {
 185     format->encoding = PA_ENCODING_DTS_IEC61937;
 186   } else if (spec->type == GST_BUFTYPE_MPEG) {
 187     format->encoding = PA_ENCODING_MPEG_IEC61937;
 188   } else {
 189     goto fail;
 190   }
 191
 192   if (format->encoding == PA_ENCODING_PCM) {
 193     pa_format_info_set_sample_format (format, sf);
 194     pa_format_info_set_channels (format, GST_AUDIO_INFO_CHANNELS (ainfo));
 195   }
 196
 197   pa_format_info_set_rate (format, GST_AUDIO_INFO_RATE (ainfo));
 198
 199   if (!pa_format_info_valid (format))
 200     goto fail;
 201
 202   *f = format;
 203   *channels = GST_AUDIO_INFO_CHANNELS (ainfo);
 204
 205   return TRUE;
 206
 207 fail:
 208   if (format)
 209     pa_format_info_free (format);
 210   return FALSE;
 211 }
 212
 213 /* PATH_MAX is not defined everywhere, e.g. on GNU Hurd */
 214 #ifndef PATH_MAX
 215 #define PATH_MAX 4096
 216 #endif
 217
 218 gchar *
 219 gst_pulse_client_name (void)
 220 {
 221   gchar buf[PATH_MAX];
 222
 223   const char *c;
 224
 225   if ((c = g_get_application_name ()))
 226     return g_strdup (c);
 227   else if (pa_get_binary_name (buf, sizeof (buf)))
 228     return g_strdup (buf);
 229   else
 230     return g_strdup_printf ("GStreamer-pid-%lu", (gulong) getpid ());
 231 }
 232
 233 pa_channel_map *
 234 gst_pulse_gst_to_channel_map (pa_channel_map * map,
 235     const GstAudioRingBufferSpec * spec)
 236 {
 237   int i;
 238   GstAudioChannelPosition *pos;
 239
 240   pa_channel_map_init (map);
 241
 242   if (!(pos =
 243           gst_audio_get_channel_positions (gst_caps_get_structure (spec->caps,
 244                   0)))) {
 245     return NULL;
 246   }
 247
 248   for (i = 0; i < spec->info.channels; i++) {
 249     if (pos[i] == GST_AUDIO_CHANNEL_POSITION_NONE) {
 250       /* no valid mappings for these channels */
 251       g_free (pos);
 252       return NULL;
 253     } else if (pos[i] < GST_AUDIO_CHANNEL_POSITION_NUM)
 254       map->map[i] = gst_pos_to_pa[pos[i]];
 255     else
 256       map->map[i] = PA_CHANNEL_POSITION_INVALID;
 257   }
 258
 259   g_free (pos);
 260   map->channels = spec->info.channels;
 261
 262   if (!pa_channel_map_valid (map)) {
 263     return NULL;
 264   }
 265
 266   return map;
 267 }
 268
 269 GstAudioRingBufferSpec *
 270 gst_pulse_channel_map_to_gst (const pa_channel_map * map,
 271     GstAudioRingBufferSpec * spec)
 272 {
 273   int i;
 274   GstAudioChannelPosition *pos;
 275   gboolean invalid = FALSE;
 276   gint channels;
 277
 278   channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 279
 280   g_return_val_if_fail (map->channels == channels, NULL);
 281
 282   pos = g_new0 (GstAudioChannelPosition, channels + 1);
 283
 284   for (i = 0; i < channels; i++) {
 285     if (map->map[i] == PA_CHANNEL_POSITION_INVALID) {
 286       invalid = TRUE;
 287       break;
 288     } else if ((int) map->map[i] < (int) GST_AUDIO_CHANNEL_POSITION_NUM) {
 289       pos[i] = pa_to_gst_pos[map->map[i] + 1];
 290     } else {
 291       invalid = TRUE;
 292       break;
 293     }
 294   }
 295
 296   if (!invalid && !gst_audio_check_channel_positions (pos, channels))
 297     invalid = TRUE;
 298
 299   if (invalid) {
 300     for (i = 0; i < channels; i++)
 301       pos[i] = GST_AUDIO_CHANNEL_POSITION_NONE;
 302   }
 303
 304   gst_audio_set_channel_positions (gst_caps_get_structure (spec->caps, 0), pos);
 305
 306   g_free (pos);
 307
 308   return spec;
 309 }
 310
 311 void
 312 gst_pulse_cvolume_from_linear (pa_cvolume * v, unsigned channels,
 313     gdouble volume)
 314 {
 315   pa_cvolume_set (v, channels, pa_sw_volume_from_linear (volume));
 316 }
 317
 318 static gboolean
 319 make_proplist_item (GQuark field_id, const GValue * value, gpointer user_data)
 320 {
 321   pa_proplist *p = (pa_proplist *) user_data;
 322   gchar *prop_id = (gchar *) g_quark_to_string (field_id);
 323
 324   /* http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html */
 325
 326   /* match prop id */
 327
 328   /* check type */
 329   switch (G_VALUE_TYPE (value)) {
 330     case G_TYPE_STRING:
 331       pa_proplist_sets (p, prop_id, g_value_get_string (value));
 332       break;
 333     default:
 334       GST_WARNING ("unmapped property type %s", G_VALUE_TYPE_NAME (value));
 335       break;
 336   }
 337
 338   return TRUE;
 339 }
 340
 341 pa_proplist *
 342 gst_pulse_make_proplist (const GstStructure * properties)
 343 {
 344   pa_proplist *proplist = pa_proplist_new ();
 345
 346   /* iterate the structure and fill the proplist */
 347   gst_structure_foreach (properties, make_proplist_item, proplist);
 348   return proplist;
 349 }