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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301
  19  *  USA.
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <gst/audio/audio.h>
  27
  28 #include "pulseutil.h"
  29
  30 #ifdef HAVE_UNISTD_H
  31 # include <unistd.h>            /* getpid on UNIX */
  32 #endif
  33 #ifdef HAVE_PROCESS_H
  34 # include <process.h>           /* getpid on win32 */
  35 #endif
  36
  37 static const struct
  38 {
  39   GstAudioChannelPosition gst_pos;
  40   pa_channel_position_t pa_pos;
  41 } gst_pa_pos_table[] = {
  42   {
  43   GST_AUDIO_CHANNEL_POSITION_MONO, PA_CHANNEL_POSITION_MONO}, {
  44   GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT, PA_CHANNEL_POSITION_FRONT_LEFT}, {
  45   GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT, PA_CHANNEL_POSITION_FRONT_RIGHT}, {
  46   GST_AUDIO_CHANNEL_POSITION_REAR_CENTER, PA_CHANNEL_POSITION_REAR_CENTER}, {
  47   GST_AUDIO_CHANNEL_POSITION_REAR_LEFT, PA_CHANNEL_POSITION_REAR_LEFT}, {
  48   GST_AUDIO_CHANNEL_POSITION_REAR_RIGHT, PA_CHANNEL_POSITION_REAR_RIGHT}, {
  49   GST_AUDIO_CHANNEL_POSITION_LFE1, PA_CHANNEL_POSITION_LFE}, {
  50   GST_AUDIO_CHANNEL_POSITION_FRONT_CENTER, PA_CHANNEL_POSITION_FRONT_CENTER}, {
  51   GST_AUDIO_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER,
  52         PA_CHANNEL_POSITION_FRONT_LEFT_OF_CENTER}, {
  53   GST_AUDIO_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER,
  54         PA_CHANNEL_POSITION_FRONT_RIGHT_OF_CENTER}, {
  55   GST_AUDIO_CHANNEL_POSITION_SIDE_LEFT, PA_CHANNEL_POSITION_SIDE_LEFT}, {
  56   GST_AUDIO_CHANNEL_POSITION_SIDE_RIGHT, PA_CHANNEL_POSITION_SIDE_RIGHT}, {
  57   GST_AUDIO_CHANNEL_POSITION_TOP_CENTER, PA_CHANNEL_POSITION_TOP_CENTER}, {
  58   GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_LEFT,
  59         PA_CHANNEL_POSITION_TOP_FRONT_LEFT}, {
  60   GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_RIGHT,
  61         PA_CHANNEL_POSITION_TOP_FRONT_RIGHT}, {
  62   GST_AUDIO_CHANNEL_POSITION_TOP_FRONT_CENTER,
  63         PA_CHANNEL_POSITION_TOP_FRONT_CENTER}, {
  64   GST_AUDIO_CHANNEL_POSITION_TOP_REAR_LEFT, PA_CHANNEL_POSITION_TOP_REAR_LEFT}, {
  65   GST_AUDIO_CHANNEL_POSITION_TOP_REAR_RIGHT,
  66         PA_CHANNEL_POSITION_TOP_REAR_RIGHT}, {
  67   GST_AUDIO_CHANNEL_POSITION_TOP_REAR_CENTER,
  68         PA_CHANNEL_POSITION_TOP_REAR_CENTER}, {
  69   GST_AUDIO_CHANNEL_POSITION_NONE, PA_CHANNEL_POSITION_INVALID}
  70 };
  71
  72 static gboolean
  73 gstaudioformat_to_pasampleformat (GstAudioFormat format,
  74     pa_sample_format_t * sf)
  75 {
  76   switch (format) {
  77     case GST_AUDIO_FORMAT_U8:
  78       *sf = PA_SAMPLE_U8;
  79       break;
  80     case GST_AUDIO_FORMAT_S16LE:
  81       *sf = PA_SAMPLE_S16LE;
  82       break;
  83     case GST_AUDIO_FORMAT_S16BE:
  84       *sf = PA_SAMPLE_S16BE;
  85       break;
  86     case GST_AUDIO_FORMAT_F32LE:
  87       *sf = PA_SAMPLE_FLOAT32LE;
  88       break;
  89     case GST_AUDIO_FORMAT_F32BE:
  90       *sf = PA_SAMPLE_FLOAT32BE;
  91       break;
  92     case GST_AUDIO_FORMAT_S32LE:
  93       *sf = PA_SAMPLE_S32LE;
  94       break;
  95     case GST_AUDIO_FORMAT_S32BE:
  96       *sf = PA_SAMPLE_S32BE;
  97       break;
  98     case GST_AUDIO_FORMAT_S24LE:
  99       *sf = PA_SAMPLE_S24LE;
 100       break;
 101     case GST_AUDIO_FORMAT_S24BE:
 102       *sf = PA_SAMPLE_S24BE;
 103       break;
 104     case GST_AUDIO_FORMAT_S24_32LE:
 105       *sf = PA_SAMPLE_S24_32LE;
 106       break;
 107     case GST_AUDIO_FORMAT_S24_32BE:
 108       *sf = PA_SAMPLE_S24_32BE;
 109       break;
 110     default:
 111       return FALSE;
 112   }
 113   return TRUE;
 114 }
 115
 116 gboolean
 117 gst_pulse_fill_sample_spec (GstAudioRingBufferSpec * spec, pa_sample_spec * ss)
 118 {
 119   if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW) {
 120     if (!gstaudioformat_to_pasampleformat (GST_AUDIO_INFO_FORMAT (&spec->info),
 121             &ss->format))
 122       return FALSE;
 123   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MU_LAW) {
 124     ss->format = PA_SAMPLE_ULAW;
 125   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_A_LAW) {
 126     ss->format = PA_SAMPLE_ALAW;
 127   } else
 128     return FALSE;
 129
 130   ss->channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 131   ss->rate = GST_AUDIO_INFO_RATE (&spec->info);
 132
 133   if (!pa_sample_spec_valid (ss))
 134     return FALSE;
 135
 136   return TRUE;
 137 }
 138
 139 gboolean
 140 gst_pulse_fill_format_info (GstAudioRingBufferSpec * spec, pa_format_info ** f,
 141     guint * channels)
 142 {
 143   pa_format_info *format;
 144   pa_sample_format_t sf = PA_SAMPLE_INVALID;
 145   GstAudioInfo *ainfo = &spec->info;
 146
 147   format = pa_format_info_new ();
 148
 149   if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MU_LAW
 150       && GST_AUDIO_INFO_WIDTH (ainfo) == 8) {
 151     format->encoding = PA_ENCODING_PCM;
 152     sf = PA_SAMPLE_ULAW;
 153   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_A_LAW
 154       && GST_AUDIO_INFO_WIDTH (ainfo) == 8) {
 155     format->encoding = PA_ENCODING_PCM;
 156     sf = PA_SAMPLE_ALAW;
 157   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_RAW) {
 158     format->encoding = PA_ENCODING_PCM;
 159     if (!gstaudioformat_to_pasampleformat (GST_AUDIO_INFO_FORMAT (ainfo), &sf))
 160       goto fail;
 161   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_AC3) {
 162     format->encoding = PA_ENCODING_AC3_IEC61937;
 163   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_EAC3) {
 164     format->encoding = PA_ENCODING_EAC3_IEC61937;
 165   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_DTS) {
 166     format->encoding = PA_ENCODING_DTS_IEC61937;
 167   } else if (spec->type == GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG) {
 168     format->encoding = PA_ENCODING_MPEG_IEC61937;
 169   } else {
 170     goto fail;
 171   }
 172
 173   if (format->encoding == PA_ENCODING_PCM) {
 174     pa_format_info_set_sample_format (format, sf);
 175     pa_format_info_set_channels (format, GST_AUDIO_INFO_CHANNELS (ainfo));
 176   }
 177
 178   pa_format_info_set_rate (format, GST_AUDIO_INFO_RATE (ainfo));
 179
 180   if (!pa_format_info_valid (format))
 181     goto fail;
 182
 183   *f = format;
 184   *channels = GST_AUDIO_INFO_CHANNELS (ainfo);
 185
 186   return TRUE;
 187
 188 fail:
 189   if (format)
 190     pa_format_info_free (format);
 191   return FALSE;
 192 }
 193
 194 /* PATH_MAX is not defined everywhere, e.g. on GNU Hurd */
 195 #ifndef PATH_MAX
 196 #define PATH_MAX 4096
 197 #endif
 198
 199 gchar *
 200 gst_pulse_client_name (void)
 201 {
 202   gchar buf[PATH_MAX];
 203
 204   const char *c;
 205
 206   if ((c = g_get_application_name ()))
 207     return g_strdup (c);
 208   else if (pa_get_binary_name (buf, sizeof (buf)))
 209     return g_strdup (buf);
 210   else
 211     return g_strdup_printf ("GStreamer-pid-%lu", (gulong) getpid ());
 212 }
 213
 214 pa_channel_map *
 215 gst_pulse_gst_to_channel_map (pa_channel_map * map,
 216     const GstAudioRingBufferSpec * spec)
 217 {
 218   gint i, j;
 219   gint channels;
 220   const GstAudioChannelPosition *pos;
 221
 222   pa_channel_map_init (map);
 223
 224   channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 225   pos = spec->info.position;
 226
 227   for (j = 0; j < channels; j++) {
 228     for (i = 0; i < G_N_ELEMENTS (gst_pa_pos_table); i++) {
 229       if (pos[j] == gst_pa_pos_table[i].gst_pos) {
 230         map->map[j] = gst_pa_pos_table[i].pa_pos;
 231         break;
 232       }
 233     }
 234     if (i == G_N_ELEMENTS (gst_pa_pos_table))
 235       return NULL;
 236   }
 237
 238   if (j != spec->info.channels) {
 239     return NULL;
 240   }
 241
 242   map->channels = spec->info.channels;
 243
 244   if (!pa_channel_map_valid (map)) {
 245     return NULL;
 246   }
 247
 248   return map;
 249 }
 250
 251 GstAudioRingBufferSpec *
 252 gst_pulse_channel_map_to_gst (const pa_channel_map * map,
 253     GstAudioRingBufferSpec * spec)
 254 {
 255   gint i, j;
 256   gboolean invalid = FALSE;
 257   gint channels;
 258   GstAudioChannelPosition *pos;
 259
 260   channels = GST_AUDIO_INFO_CHANNELS (&spec->info);
 261
 262   g_return_val_if_fail (map->channels == channels, NULL);
 263
 264   pos = spec->info.position;
 265
 266   for (j = 0; j < channels; j++) {
 267     for (i = 0; j < channels && i < G_N_ELEMENTS (gst_pa_pos_table); i++) {
 268       if (map->map[j] == gst_pa_pos_table[i].pa_pos) {
 269         pos[j] = gst_pa_pos_table[i].gst_pos;
 270         break;
 271       }
 272     }
 273     if (i == G_N_ELEMENTS (gst_pa_pos_table))
 274       return NULL;
 275   }
 276
 277   if (!invalid
 278       && !gst_audio_check_valid_channel_positions (pos, channels, FALSE))
 279     invalid = TRUE;
 280
 281   if (invalid) {
 282     for (i = 0; i < channels; i++)
 283       pos[i] = GST_AUDIO_CHANNEL_POSITION_NONE;
 284   } else {
 285     if (pos[0] != GST_AUDIO_CHANNEL_POSITION_NONE)
 286       spec->info.flags &= ~GST_AUDIO_FLAG_UNPOSITIONED;
 287   }
 288
 289   return spec;
 290 }
 291
 292 void
 293 gst_pulse_cvolume_from_linear (pa_cvolume * v, unsigned channels,
 294     gdouble volume)
 295 {
 296   pa_cvolume_set (v, channels, pa_sw_volume_from_linear (volume));
 297 }
 298
 299 static gboolean
 300 make_proplist_item (GQuark field_id, const GValue * value, gpointer user_data)
 301 {
 302   pa_proplist *p = (pa_proplist *) user_data;
 303   gchar *prop_id = (gchar *) g_quark_to_string (field_id);
 304
 305   /* http://0pointer.de/lennart/projects/pulseaudio/doxygen/proplist_8h.html */
 306
 307   /* match prop id */
 308
 309   /* check type */
 310   switch (G_VALUE_TYPE (value)) {
 311     case G_TYPE_STRING:
 312       pa_proplist_sets (p, prop_id, g_value_get_string (value));
 313       break;
 314     default:
 315       GST_WARNING ("unmapped property type %s", G_VALUE_TYPE_NAME (value));
 316       break;
 317   }
 318
 319   return TRUE;
 320 }
 321
 322 pa_proplist *
 323 gst_pulse_make_proplist (const GstStructure * properties)
 324 {
 325   pa_proplist *proplist = pa_proplist_new ();
 326
 327   /* iterate the structure and fill the proplist */
 328   gst_structure_foreach (properties, make_proplist_item, proplist);
 329   return proplist;
 330 }