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_NONE] = PA_CHANNEL_POSITION_INVALID
  53 };
  54
  55 /* All index are increased by one because PA_CHANNEL_POSITION_INVALID == -1 */
  56 static const GstAudioChannelPosition
  57     pa_to_gst_pos[GST_AUDIO_CHANNEL_POSITION_NUM]
  58     = {
  59   [PA_CHANNEL_POSITION_MONO + 1] = GST_AUDIO_CHANNEL_POSITION_FRONT_MONO,
  60   [PA_CHANNEL_POSITION_FRONT_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT,
  61   [PA_CHANNEL_POSITION_FRONT_RIGHT + 1] =
  62       GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT,
  63   [PA_CHANNEL_POSITION_REAR_CENTER + 1] =
  64       GST_AUDIO_CHANNEL_POSITION_REAR_CENTER,
  65   [PA_CHANNEL_POSITION_REAR_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_REAR_LEFT,
  66   [PA_CHANNEL_POSITION_REAR_RIGHT + 1] = GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT,
  67   [PA_CHANNEL_POSITION_LFE + 1] = GST_AUDIO_CHANNEL_POSITION_LFE,
  68   [PA_CHANNEL_POSITION_FRONT_CENTER + 1] =
  69       GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER,
  70   [PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER + 1] =
  71       GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
  72   [PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER + 1] =
  73       GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
  74   [PA_CHANNEL_POSITION_SIDE_LEFT + 1] = GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT,
  75   [PA_CHANNEL_POSITION_SIDE_RIGHT + 1] = GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT,
  76   [PA_CHANNEL_POSITION_INVALID + 1] = GST_AUDIO_CHANNEL_POSITION_NONE,
  77 };
  78
  79 gboolean
  80 gst_pulse_fill_sample_spec (GstRingBufferSpec * spec, pa_sample_spec * ss)
  81 {
  82
  83   if (spec->type == GST_BUFTYPE_RAW) {
  84     switch (GST_AUDIO_INFO_FORMAT (&spec->info)) {
  85       case GST_AUDIO_FORMAT_U8:
  86         ss->format = PA_SAMPLE_U8;
  87         break;
  88       case GST_AUDIO_FORMAT_S16_LE:
  89         ss->format = PA_SAMPLE_S16LE;
  90         break;
  91       case GST_AUDIO_FORMAT_S16_BE:
  92         ss->format = PA_SAMPLE_S16BE;
  93         break;
  94       case GST_AUDIO_FORMAT_F32_LE:
  95         ss->format = PA_SAMPLE_FLOAT32LE;
  96         break;
  97       case GST_AUDIO_FORMAT_F32_BE:
  98         ss->format = PA_SAMPLE_FLOAT32BE;
  99         break;
 100       case GST_AUDIO_FORMAT_S32_LE:
 101         ss->format = PA_SAMPLE_S32LE;
 102         break;
 103       case GST_AUDIO_FORMAT_S32_BE:
 104         ss->format = PA_SAMPLE_S32BE;
 105         break;
 106       case GST_AUDIO_FORMAT_S24_3LE:
 107         ss->format = PA_SAMPLE_S24LE;
 108         break;
 109       case GST_AUDIO_FORMAT_S24_3BE:
 110         ss->format = PA_SAMPLE_S24BE;
 111         break;
 112       case GST_AUDIO_FORMAT_S24_LE:
 113         ss->format = PA_SAMPLE_S24_32LE;
 114         break;
 115       case GST_AUDIO_FORMAT_S24_BE:
 116         ss->format = PA_SAMPLE_S24_32BE;
 117         break;
 118       default:
 119         return FALSE;
 120     }
 121   } else if (spec->type == GST_BUFTYPE_MU_LAW) {
 122     ss->format = PA_SAMPLE_ULAW;
 123   } else if (spec->type == GST_BUFTYPE_A_LAW) {
 124     ss->format = PA_SAMPLE_ALAW;
 125   } else
 126     return FALSE;
 127
 128   ss->channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 129   ss->rate = GST_AUDIO_INFO_RATE (&spec->info);
 130
 131   if (!pa_sample_spec_valid (ss))
 132     return FALSE;
 133
 134   return TRUE;
 135 }
 136
 137 #ifdef HAVE_PULSE_1_0
 138 gboolean
 139 gst_pulse_fill_format_info (GstRingBufferSpec * spec, pa_format_info ** f,
 140     guint * channels)
 141 {
 142   pa_format_info *format;
 143   pa_sample_format_t sf = PA_SAMPLE_INVALID;
 144
 145   format = pa_format_info_new ();
 146
 147   if (spec->format == GST_MU_LAW && spec->width == 8) {
 148     format->encoding = PA_ENCODING_PCM;
 149     sf = PA_SAMPLE_ULAW;
 150   } else if (spec->format == GST_A_LAW && spec->width == 8) {
 151     format->encoding = PA_ENCODING_PCM;
 152     sf = PA_SAMPLE_ALAW;
 153   } else if (spec->format == GST_U8 && spec->width == 8) {
 154     format->encoding = PA_ENCODING_PCM;
 155     sf = PA_SAMPLE_U8;
 156   } else if (spec->format == GST_S16_LE && spec->width == 16) {
 157     format->encoding = PA_ENCODING_PCM;
 158     sf = PA_SAMPLE_S16LE;
 159   } else if (spec->format == GST_S16_BE && spec->width == 16) {
 160     format->encoding = PA_ENCODING_PCM;
 161     sf = PA_SAMPLE_S16BE;
 162   } else if (spec->format == GST_FLOAT32_LE && spec->width == 32) {
 163     format->encoding = PA_ENCODING_PCM;
 164     sf = PA_SAMPLE_FLOAT32LE;
 165   } else if (spec->format == GST_FLOAT32_BE && spec->width == 32) {
 166     format->encoding = PA_ENCODING_PCM;
 167     sf = PA_SAMPLE_FLOAT32BE;
 168   } else if (spec->format == GST_S32_LE && spec->width == 32) {
 169     format->encoding = PA_ENCODING_PCM;
 170     sf = PA_SAMPLE_S32LE;
 171   } else if (spec->format == GST_S32_BE && spec->width == 32) {
 172     format->encoding = PA_ENCODING_PCM;
 173     sf = PA_SAMPLE_S32BE;
 174   } else if (spec->format == GST_S24_3LE && spec->width == 24) {
 175     format->encoding = PA_ENCODING_PCM;
 176     sf = PA_SAMPLE_S24LE;
 177   } else if (spec->format == GST_S24_3BE && spec->width == 24) {
 178     format->encoding = PA_ENCODING_PCM;
 179     sf = PA_SAMPLE_S24BE;
 180   } else if (spec->format == GST_S24_LE && spec->width == 32) {
 181     format->encoding = PA_ENCODING_PCM;
 182     sf = PA_SAMPLE_S24_32LE;
 183   } else if (spec->format == GST_S24_BE && spec->width == 32) {
 184     format->encoding = PA_ENCODING_PCM;
 185     sf = PA_SAMPLE_S24_32BE;
 186   } else if (spec->format == GST_AC3) {
 187     format->encoding = PA_ENCODING_AC3_IEC61937;
 188   } else if (spec->format == GST_EAC3) {
 189     format->encoding = PA_ENCODING_EAC3_IEC61937;
 190   } else if (spec->format == GST_DTS) {
 191     format->encoding = PA_ENCODING_DTS_IEC61937;
 192   } else if (spec->format == GST_MPEG) {
 193     format->encoding = PA_ENCODING_MPEG_IEC61937;
 194   } else {
 195     goto fail;
 196   }
 197
 198   if (format->encoding == PA_ENCODING_PCM) {
 199     pa_format_info_set_sample_format (format, sf);
 200     pa_format_info_set_channels (format, spec->channels);
 201   }
 202
 203   pa_format_info_set_rate (format, spec->rate);
 204
 205   if (!pa_format_info_valid (format))
 206     goto fail;
 207
 208   *f = format;
 209   *channels = spec->channels;
 210
 211   return TRUE;
 212
 213 fail:
 214   if (format)
 215     pa_format_info_free (format);
 216   return FALSE;
 217 }
 218 #endif
 219
 220 /* PATH_MAX is not defined everywhere, e.g. on GNU Hurd */
 221 #ifndef PATH_MAX
 222 #define PATH_MAX 4096
 223 #endif
 224
 225 gchar *
 226 gst_pulse_client_name (void)
 227 {
 228   gchar buf[PATH_MAX];
 229
 230   const char *c;
 231
 232   if ((c = g_get_application_name ()))
 233     return g_strdup (c);
 234   else if (pa_get_binary_name (buf, sizeof (buf)))
 235     return g_strdup (buf);
 236   else
 237     return g_strdup_printf ("GStreamer-pid-%lu", (gulong) getpid ());
 238 }
 239
 240 pa_channel_map *
 241 gst_pulse_gst_to_channel_map (pa_channel_map * map,
 242     const GstRingBufferSpec * spec)
 243 {
 244   int i;
 245   GstAudioChannelPosition *pos;
 246
 247   pa_channel_map_init (map);
 248
 249   if (!(pos =
 250           gst_audio_get_channel_positions (gst_caps_get_structure (spec->caps,
 251                   0)))) {
 252     return NULL;
 253   }
 254
 255   for (i = 0; i < spec->info.channels; i++) {
 256     if (pos[i] == GST_AUDIO_CHANNEL_POSITION_NONE) {
 257       /* no valid mappings for these channels */
 258       g_free (pos);
 259       return NULL;
 260     } else if (pos[i] < GST_AUDIO_CHANNEL_POSITION_NUM)
 261       map->map[i] = gst_pos_to_pa[pos[i]];
 262     else
 263       map->map[i] = PA_CHANNEL_POSITION_INVALID;
 264   }
 265
 266   g_free (pos);
 267   map->channels = spec->info.channels;
 268
 269   if (!pa_channel_map_valid (map)) {
 270     return NULL;
 271   }
 272
 273   return map;
 274 }
 275
 276 GstRingBufferSpec *
 277 gst_pulse_channel_map_to_gst (const pa_channel_map * map,
 278     GstRingBufferSpec * spec)
 279 {
 280   int i;
 281   GstAudioChannelPosition *pos;
 282   gboolean invalid = FALSE;
 283   gint channels;
 284
 285   channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 286
 287   g_return_val_if_fail (map->channels == channels, NULL);
 288
 289   pos = g_new0 (GstAudioChannelPosition, channels + 1);
 290
 291   for (i = 0; i < channels; i++) {
 292     if (map->map[i] == PA_CHANNEL_POSITION_INVALID) {
 293       invalid = TRUE;
 294       break;
 295     } else if ((int) map->map[i] < (int) GST_AUDIO_CHANNEL_POSITION_NUM) {
 296       pos[i] = pa_to_gst_pos[map->map[i] + 1];
 297     } else {
 298       invalid = TRUE;
 299       break;
 300     }
 301   }
 302
 303   if (!invalid && !gst_audio_check_channel_positions (pos, channels))
 304     invalid = TRUE;
 305
 306   if (invalid) {
 307     for (i = 0; i < channels; i++)
 308       pos[i] = GST_AUDIO_CHANNEL_POSITION_NONE;
 309   }
 310
 311   gst_audio_set_channel_positions (gst_caps_get_structure (spec->caps, 0), pos);
 312
 313   g_free (pos);
 314
 315   return spec;
 316 }
 317
 318 void
 319 gst_pulse_cvolume_from_linear (pa_cvolume * v, unsigned channels,
 320     gdouble volume)
 321 {
 322   pa_cvolume_set (v, channels, pa_sw_volume_from_linear (volume));
 323 }
 324
 325 static gboolean
 326 make_proplist_item (GQuark field_id, const GValue * value, gpointer user_data)
 327 {
 328   pa_proplist *p = (pa_proplist *) user_data;
 329   gchar *prop_id = (gchar *) g_quark_to_string (field_id);
 330
 331   /* http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html */
 332
 333   /* match prop id */
 334
 335   /* check type */
 336   switch (G_VALUE_TYPE (value)) {
 337     case G_TYPE_STRING:
 338       pa_proplist_sets (p, prop_id, g_value_get_string (value));
 339       break;
 340     default:
 341       GST_WARNING ("unmapped property type %s", G_VALUE_TYPE_NAME (value));
 342       break;
 343   }
 344
 345   return TRUE;
 346 }
 347
 348 pa_proplist *
 349 gst_pulse_make_proplist (const GstStructure * properties)
 350 {
 351   pa_proplist *proplist = pa_proplist_new ();
 352
 353   /* iterate the structure and fill the proplist */
 354   gst_structure_foreach (properties, make_proplist_item, proplist);
 355   return proplist;
 356 }