lavd: pulse audio encoder

Signed-off-by: Lukasz Marek <lukasz.m.luki@gmail.com>
Reviewed-by: Stefano Sabatini <stefasab@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>

Changelog

@@ -39,6 +39,7 @@ version <next>
 - native VP9 decoder
 - dpx parser
 - max_error_rate parameter in ffmpeg
+- PulseAudio output device
 
 
 version 2.0:

configure

@@ -2134,6 +2134,7 @@ openal_indev_deps="openal"
 oss_indev_deps_any="soundcard_h sys_soundcard_h"
 oss_outdev_deps_any="soundcard_h sys_soundcard_h"
 pulse_indev_deps="libpulse"
+pulse_outdev_deps="libpulse"
 sdl_outdev_deps="sdl"
 sndio_indev_deps="sndio_h"
 sndio_outdev_deps="sndio_h"

doc/outdevs.texi

@@ -108,6 +108,41 @@ ffmpeg -i INPUT -pix_fmt rgb24 -f caca -list_dither colors -
 
 OSS (Open Sound System) output device.
 
+@section pulse
+
+PulseAudio output device.
+
+To enable this output device you need to configure FFmpeg with @code{--enable-libpulse}.
+
+More information about PulseAudio can be found on @url{http://www.pulseaudio.org}
+
+@subsection Options
+@table @option
+
+@item server
+Connect to a specific PulseAudio server, specified by an IP address.
+Default server is used when not provided.
+
+@item name
+Specify the application name PulseAudio will use when showing active clients,
+by default it is the @code{LIBAVFORMAT_IDENT} string.
+
+@item stream_name
+Specify the stream name PulseAudio will use when showing active streams,
+by default it is set to the specified output name.
+
+@item device
+Specify the device to use. Default device is used when not provided.
+List of output devices can be obtained with command @command{pactl list sinks}.
+
+@end table
+
+@subsection Examples
+Play a file on default device on default server:
+@example
+ffmpeg  -i INPUT -f pulse "stream name"
+@end example
+
 @section sdl
 
 SDL (Simple DirectMedia Layer) output device.

libavdevice/Makefile

@@ -31,6 +31,7 @@ OBJS-$(CONFIG_OPENAL_INDEV)              += openal-dec.o
 OBJS-$(CONFIG_OSS_INDEV)                 += oss_audio.o
 OBJS-$(CONFIG_OSS_OUTDEV)                += oss_audio.o
 OBJS-$(CONFIG_PULSE_INDEV)               += pulse.o
+OBJS-$(CONFIG_PULSE_OUTDEV)              += pulse_audio_enc.o
 OBJS-$(CONFIG_SDL_OUTDEV)                += sdl.o
 OBJS-$(CONFIG_SNDIO_INDEV)               += sndio_common.o sndio_dec.o
 OBJS-$(CONFIG_SNDIO_OUTDEV)              += sndio_common.o sndio_enc.o

libavdevice/alldevices.c

@@ -57,7 +57,7 @@ void avdevice_register_all(void)
     REGISTER_INDEV   (LAVFI,            lavfi);
     REGISTER_INDEV   (OPENAL,           openal);
     REGISTER_INOUTDEV(OSS,              oss);
-    REGISTER_INDEV   (PULSE,            pulse);
+    REGISTER_INOUTDEV(PULSE,            pulse);
     REGISTER_OUTDEV  (SDL,              sdl);
     REGISTER_INOUTDEV(SNDIO,            sndio);
     REGISTER_INOUTDEV(V4L2,             v4l2);

libavdevice/pulse_audio_enc.c

@@ -0,0 +1,171 @@
+/*
+ * Copyright (c) 2013 Lukasz Marek <lukasz.m.luki@gmail.com>
+ *
+ * This file is part of FFmpeg.
+ *
+ * FFmpeg is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * FFmpeg is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with FFmpeg; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ */
+
+#include <pulse/simple.h>
+#include <pulse/error.h>
+#include "libavutil/opt.h"
+#include "libavutil/time.h"
+#include "libavutil/log.h"
+#include "libavformat/avformat.h"
+#include "libavformat/internal.h"
+
+typedef struct PulseData {
+    AVClass *class;
+    const char *server;
+    const char *name;
+    const char *stream_name;
+    const char *device;
+    pa_simple *pa;
+    unsigned int stream_index;
+} PulseData;
+
+static pa_sample_format_t codec_id_to_pulse_format(enum AVCodecID codec_id)
+{
+    switch (codec_id) {
+    case AV_CODEC_ID_PCM_U8:    return PA_SAMPLE_U8;
+    case AV_CODEC_ID_PCM_ALAW:  return PA_SAMPLE_ALAW;
+    case AV_CODEC_ID_PCM_MULAW: return PA_SAMPLE_ULAW;
+    case AV_CODEC_ID_PCM_S16LE: return PA_SAMPLE_S16LE;
+    case AV_CODEC_ID_PCM_S16BE: return PA_SAMPLE_S16BE;
+    case AV_CODEC_ID_PCM_F32LE: return PA_SAMPLE_FLOAT32LE;
+    case AV_CODEC_ID_PCM_F32BE: return PA_SAMPLE_FLOAT32BE;
+    case AV_CODEC_ID_PCM_S32LE: return PA_SAMPLE_S32LE;
+    case AV_CODEC_ID_PCM_S32BE: return PA_SAMPLE_S32BE;
+    case AV_CODEC_ID_PCM_S24LE: return PA_SAMPLE_S24LE;
+    case AV_CODEC_ID_PCM_S24BE: return PA_SAMPLE_S24BE;
+    default:                    return PA_SAMPLE_INVALID;
+    }
+}
+
+static av_cold int pulse_write_header(AVFormatContext *h)
+{
+    PulseData *s = h->priv_data;
+    AVStream *st = NULL;
+    int ret;
+    pa_sample_spec ss;
+    pa_buffer_attr attr = { -1, -1, -1, -1, -1 };
+    const char *stream_name = s->stream_name;
+
+    for (unsigned i = 0; i < h->nb_streams; i++) {
+        if (h->streams[i]->codec->codec_type == AVMEDIA_TYPE_AUDIO) {
+            st = h->streams[i];
+            s->stream_index = i;
+            break;
+        }
+    }
+
+    if (!st) {
+        av_log(s, AV_LOG_ERROR, "No audio stream found.\n");
+        return AVERROR(EINVAL);
+    }
+
+    if (!stream_name)
+        stream_name = h->filename;
+
+    ss.format = codec_id_to_pulse_format(st->codec->codec_id);
+    ss.rate = st->codec->sample_rate;
+    ss.channels = st->codec->channels;
+
+    s->pa = pa_simple_new(s->server,                 // Server
+                          s->name,                   // Application name
+                          PA_STREAM_PLAYBACK,
+                          s->device,                 // Device
+                          stream_name,               // Description of a stream
+                          &ss,                       // Sample format
+                          NULL,                      // Use default channel map
+                          &attr,                     // Buffering attributes
+                          &ret);                     // Result
+
+    if (!s->pa) {
+        av_log(s, AV_LOG_ERROR, "pa_simple_new failed: %s\n", pa_strerror(ret));
+        return AVERROR(EIO);
+    }
+
+    avpriv_set_pts_info(st, 64, 1, 1000000);  /* 64 bits pts in us */
+
+    return 0;
+}
+
+static av_cold int pulse_write_trailer(AVFormatContext *h)
+{
+    PulseData *s = h->priv_data;
+    pa_simple_flush(s->pa, NULL);
+    pa_simple_free(s->pa);
+    s->pa = NULL;
+    return 0;
+}
+
+static int pulse_write_packet(AVFormatContext *h, AVPacket *pkt)
+{
+    PulseData *s = h->priv_data;
+    int size     = pkt->size;
+    uint8_t *buf = pkt->data;
+    int error;
+
+    if (s->stream_index != pkt->stream_index)
+        return 0;
+
+    if ((error = pa_simple_write(s->pa, buf, size, &error))) {
+        av_log(s, AV_LOG_ERROR, "pa_simple_write failed: %s\n", pa_strerror(error));
+        return AVERROR(EIO);
+    }
+
+    return 0;
+}
+
+static void pulse_get_output_timestamp(AVFormatContext *h, int stream, int64_t *dts, int64_t *wall)
+{
+    PulseData *s = h->priv_data;
+    pa_usec_t latency = pa_simple_get_latency(s->pa, NULL);
+    *wall = av_gettime();
+    *dts = h->streams[0]->cur_dts - latency;
+}
+
+#define OFFSET(a) offsetof(PulseData, a)
+#define E AV_OPT_FLAG_ENCODING_PARAM
+
+static const AVOption options[] = {
+    { "server",        "set PulseAudio server",  OFFSET(server),      AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
+    { "name",          "set application name",   OFFSET(name),        AV_OPT_TYPE_STRING, {.str = LIBAVFORMAT_IDENT},  0, 0, E },
+    { "stream_name",   "set stream description", OFFSET(stream_name), AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
+    { "device",        "set device name",        OFFSET(device),      AV_OPT_TYPE_STRING, {.str = NULL}, 0, 0, E },
+    { NULL }
+};
+
+static const AVClass pulse_muxer_class = {
+    .class_name     = "Pulse muxer",
+    .item_name      = av_default_item_name,
+    .option         = options,
+    .version        = LIBAVUTIL_VERSION_INT,
+};
+
+AVOutputFormat ff_pulse_muxer = {
+    .name           = "pulse",
+    .long_name      = NULL_IF_CONFIG_SMALL("Pulse audio output"),
+    .priv_data_size = sizeof(PulseData),
+    .audio_codec    = AV_NE(AV_CODEC_ID_PCM_S16BE, AV_CODEC_ID_PCM_S16LE),
+    .video_codec    = AV_CODEC_ID_NONE,
+    .write_header   = pulse_write_header,
+    .write_packet   = pulse_write_packet,
+    .write_trailer  = pulse_write_trailer,
+    .get_output_timestamp = pulse_get_output_timestamp,
+    .flags          = AVFMT_NOFILE,
+    .priv_class     = &pulse_muxer_class,
+};

libavdevice/version.h

@@ -28,7 +28,7 @@
 #include "libavutil/avutil.h"
 
 #define LIBAVDEVICE_VERSION_MAJOR  55
-#define LIBAVDEVICE_VERSION_MINOR   3
+#define LIBAVDEVICE_VERSION_MINOR   4
 #define LIBAVDEVICE_VERSION_MICRO 100
 
 #define LIBAVDEVICE_VERSION_INT AV_VERSION_INT(LIBAVDEVICE_VERSION_MAJOR, \