gstreamer/gst/audiofx/audiopanorama.c
Tim-Philipp Müller d506409af5 docs: get rid of 'Since: 0.10.x' markers
And some gtk-doc markup fixes.
2013-11-18 14:47:35 +00:00

535 lines
16 KiB
C

/*
* GStreamer
* Copyright (C) 2006 Stefan Kost <ensonic@users.sf.net>
* Copyright (C) 2006 Sebastian Dröge <slomo@circular-chaos.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
/**
* SECTION:element-audiopanorama
*
* Stereo panorama effect with controllable pan position. One can choose between the default psychoacoustic panning method,
* which keeps the same perceived loudness, and a simple panning method that just controls the volume on one channel.
*
* <refsect2>
* <title>Example launch line</title>
* |[
* gst-launch-1.0 audiotestsrc wave=saw ! audiopanorama panorama=-1.00 ! alsasink
* gst-launch-1.0 filesrc location="melo1.ogg" ! oggdemux ! vorbisdec ! audioconvert ! audiopanorama panorama=-1.00 ! alsasink
* gst-launch-1.0 audiotestsrc wave=saw ! audioconvert ! audiopanorama panorama=-1.00 ! audioconvert ! alsasink
* gst-launch-1.0 audiotestsrc wave=saw ! audioconvert ! audiopanorama method=simple panorama=-0.50 ! audioconvert ! alsasink
* ]|
* </refsect2>
*/
#ifdef HAVE_CONFIG_H
#include "config.h"
#endif
#include <string.h>
#include <gst/gst.h>
#include <gst/base/gstbasetransform.h>
#ifdef HAVE_ORC
#include <orc/orcfunctions.h>
#else
#define orc_memset memset
#endif
#include "audiopanorama.h"
#include "audiopanoramaorc.h"
#define GST_CAT_DEFAULT gst_audio_panorama_debug
GST_DEBUG_CATEGORY_STATIC (GST_CAT_DEFAULT);
/* Filter signals and args */
enum
{
PROP_0,
PROP_PANORAMA,
PROP_METHOD
};
#define GST_TYPE_AUDIO_PANORAMA_METHOD (gst_audio_panorama_method_get_type ())
static GType
gst_audio_panorama_method_get_type (void)
{
static GType gtype = 0;
if (gtype == 0) {
static const GEnumValue values[] = {
{METHOD_PSYCHOACOUSTIC, "Psychoacoustic Panning (default)",
"psychoacoustic"},
{METHOD_SIMPLE, "Simple Panning", "simple"},
{0, NULL, NULL}
};
gtype = g_enum_register_static ("GstAudioPanoramaMethod", values);
}
return gtype;
}
static GstStaticPadTemplate sink_template = GST_STATIC_PAD_TEMPLATE ("sink",
GST_PAD_SINK,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("audio/x-raw, "
"format = (string) { " GST_AUDIO_NE (F32) ", " GST_AUDIO_NE (S16) "}, "
"rate = (int) [ 1, MAX ], " "channels = (int) [ 1, 2 ], "
"layout = (string) interleaved")
);
static GstStaticPadTemplate src_template = GST_STATIC_PAD_TEMPLATE ("src",
GST_PAD_SRC,
GST_PAD_ALWAYS,
GST_STATIC_CAPS ("audio/x-raw, "
"format = (string) { " GST_AUDIO_NE (F32) ", " GST_AUDIO_NE (S16) "}, "
"rate = (int) [ 1, MAX ], " "channels = (int) 2, "
"layout = (string) interleaved")
);
G_DEFINE_TYPE (GstAudioPanorama, gst_audio_panorama, GST_TYPE_BASE_TRANSFORM);
static void gst_audio_panorama_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec);
static void gst_audio_panorama_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec);
static gboolean gst_audio_panorama_get_unit_size (GstBaseTransform * base,
GstCaps * caps, gsize * size);
static GstCaps *gst_audio_panorama_transform_caps (GstBaseTransform * base,
GstPadDirection direction, GstCaps * caps, GstCaps * filter);
static gboolean gst_audio_panorama_set_caps (GstBaseTransform * base,
GstCaps * incaps, GstCaps * outcaps);
static void gst_audio_panorama_m2s_int (gfloat pan,
gint16 * idata, gint16 * odata, guint num_samples);
static void gst_audio_panorama_s2s_int (gfloat pan,
gint16 * idata, gint16 * odata, guint num_samples);
static void gst_audio_panorama_m2s_float (gfloat pan,
gfloat * idata, gfloat * odata, guint num_samples);
static void gst_audio_panorama_s2s_float (gfloat pan,
gfloat * idata, gfloat * odata, guint num_samples);
static void gst_audio_panorama_m2s_int_simple (gfloat pan,
gint16 * idata, gint16 * odata, guint num_samples);
static void gst_audio_panorama_s2s_int_simple (gfloat pan,
gint16 * idata, gint16 * odata, guint num_samples);
static void gst_audio_panorama_m2s_float_simple (gfloat pan,
gfloat * idata, gfloat * odata, guint num_samples);
static void gst_audio_panorama_s2s_float_simple (gfloat pan,
gfloat * idata, gfloat * odata, guint num_samples);
static GstFlowReturn gst_audio_panorama_transform (GstBaseTransform * base,
GstBuffer * inbuf, GstBuffer * outbuf);
/* Table with processing functions: [channels][format][method] */
static GstAudioPanoramaProcessFunc panorama_process_functions[2][2][2] = {
{
{
(GstAudioPanoramaProcessFunc) gst_audio_panorama_m2s_int,
(GstAudioPanoramaProcessFunc) gst_audio_panorama_m2s_int_simple},
{
(GstAudioPanoramaProcessFunc) gst_audio_panorama_m2s_float,
(GstAudioPanoramaProcessFunc) gst_audio_panorama_m2s_float_simple}
},
{
{
(GstAudioPanoramaProcessFunc) gst_audio_panorama_s2s_int,
(GstAudioPanoramaProcessFunc) gst_audio_panorama_s2s_int_simple},
{
(GstAudioPanoramaProcessFunc) gst_audio_panorama_s2s_float,
(GstAudioPanoramaProcessFunc) gst_audio_panorama_s2s_float_simple}
}
};
/* GObject vmethod implementations */
static void
gst_audio_panorama_class_init (GstAudioPanoramaClass * klass)
{
GObjectClass *gobject_class;
GstElementClass *gstelement_class;
GST_DEBUG_CATEGORY_INIT (gst_audio_panorama_debug, "audiopanorama", 0,
"audiopanorama element");
gobject_class = (GObjectClass *) klass;
gstelement_class = (GstElementClass *) klass;
gobject_class->set_property = gst_audio_panorama_set_property;
gobject_class->get_property = gst_audio_panorama_get_property;
g_object_class_install_property (gobject_class, PROP_PANORAMA,
g_param_spec_float ("panorama", "Panorama",
"Position in stereo panorama (-1.0 left -> 1.0 right)", -1.0, 1.0,
0.0,
G_PARAM_READWRITE | GST_PARAM_CONTROLLABLE | G_PARAM_STATIC_STRINGS));
/**
* GstAudioPanorama:method:
*
* Panning method: psychoacoustic mode keeps the same perceived loudness,
* while simple mode just controls the volume of one channel. It's merely
* a matter of taste which method should be chosen.
*/
g_object_class_install_property (gobject_class, PROP_METHOD,
g_param_spec_enum ("method", "Panning method",
"Psychoacoustic mode keeps same perceived loudness, "
"simple mode just controls volume of one channel.",
GST_TYPE_AUDIO_PANORAMA_METHOD, METHOD_PSYCHOACOUSTIC,
G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
gst_element_class_set_static_metadata (gstelement_class, "Stereo positioning",
"Filter/Effect/Audio",
"Positions audio streams in the stereo panorama",
"Stefan Kost <ensonic@users.sf.net>");
gst_element_class_add_pad_template (gstelement_class,
gst_static_pad_template_get (&src_template));
gst_element_class_add_pad_template (gstelement_class,
gst_static_pad_template_get (&sink_template));
GST_BASE_TRANSFORM_CLASS (klass)->get_unit_size =
GST_DEBUG_FUNCPTR (gst_audio_panorama_get_unit_size);
GST_BASE_TRANSFORM_CLASS (klass)->transform_caps =
GST_DEBUG_FUNCPTR (gst_audio_panorama_transform_caps);
GST_BASE_TRANSFORM_CLASS (klass)->set_caps =
GST_DEBUG_FUNCPTR (gst_audio_panorama_set_caps);
GST_BASE_TRANSFORM_CLASS (klass)->transform =
GST_DEBUG_FUNCPTR (gst_audio_panorama_transform);
}
static void
gst_audio_panorama_init (GstAudioPanorama * filter)
{
filter->panorama = 0;
filter->method = METHOD_PSYCHOACOUSTIC;
gst_audio_info_init (&filter->info);
filter->process = NULL;
gst_base_transform_set_gap_aware (GST_BASE_TRANSFORM (filter), TRUE);
}
static gboolean
gst_audio_panorama_set_process_function (GstAudioPanorama * filter,
GstAudioInfo * info)
{
gint channel_index, format_index, method_index;
const GstAudioFormatInfo *finfo = info->finfo;
/* set processing function */
channel_index = GST_AUDIO_INFO_CHANNELS (info) - 1;
if (channel_index > 1 || channel_index < 0) {
filter->process = NULL;
return FALSE;
}
format_index = GST_AUDIO_FORMAT_INFO_IS_FLOAT (finfo) ? 1 : 0;
method_index = filter->method;
filter->process =
panorama_process_functions[channel_index][format_index][method_index];
return TRUE;
}
static void
gst_audio_panorama_set_property (GObject * object, guint prop_id,
const GValue * value, GParamSpec * pspec)
{
GstAudioPanorama *filter = GST_AUDIO_PANORAMA (object);
switch (prop_id) {
case PROP_PANORAMA:
filter->panorama = g_value_get_float (value);
break;
case PROP_METHOD:
filter->method = g_value_get_enum (value);
gst_audio_panorama_set_process_function (filter, &filter->info);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
gst_audio_panorama_get_property (GObject * object, guint prop_id,
GValue * value, GParamSpec * pspec)
{
GstAudioPanorama *filter = GST_AUDIO_PANORAMA (object);
switch (prop_id) {
case PROP_PANORAMA:
g_value_set_float (value, filter->panorama);
break;
case PROP_METHOD:
g_value_set_enum (value, filter->method);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/* GstBaseTransform vmethod implementations */
static gboolean
gst_audio_panorama_get_unit_size (GstBaseTransform * base, GstCaps * caps,
gsize * size)
{
GstAudioInfo info;
g_assert (size);
if (!gst_audio_info_from_caps (&info, caps))
return FALSE;
*size = GST_AUDIO_INFO_BPF (&info);
return TRUE;
}
static GstCaps *
gst_audio_panorama_transform_caps (GstBaseTransform * base,
GstPadDirection direction, GstCaps * caps, GstCaps * filter)
{
GstCaps *res;
GstStructure *structure;
gint i;
/* replace the channel property with our range. */
res = gst_caps_copy (caps);
for (i = 0; i < gst_caps_get_size (res); i++) {
structure = gst_caps_get_structure (res, i);
if (direction == GST_PAD_SRC) {
GST_INFO_OBJECT (base, "[%d] allow 1-2 channels", i);
gst_structure_set (structure, "channels", GST_TYPE_INT_RANGE, 1, 2, NULL);
} else {
GST_INFO_OBJECT (base, "[%d] allow 2 channels", i);
gst_structure_set (structure, "channels", G_TYPE_INT, 2, NULL);
}
gst_structure_remove_field (structure, "channel-mask");
}
GST_DEBUG_OBJECT (base, "transformed %" GST_PTR_FORMAT, res);
if (filter) {
GstCaps *intersection;
GST_DEBUG_OBJECT (base, "Using filter caps %" GST_PTR_FORMAT, filter);
intersection =
gst_caps_intersect_full (filter, res, GST_CAPS_INTERSECT_FIRST);
gst_caps_unref (res);
res = intersection;
GST_DEBUG_OBJECT (base, "Intersection %" GST_PTR_FORMAT, res);
}
return res;
}
static gboolean
gst_audio_panorama_set_caps (GstBaseTransform * base, GstCaps * incaps,
GstCaps * outcaps)
{
GstAudioPanorama *filter = GST_AUDIO_PANORAMA (base);
GstAudioInfo info;
/*GST_INFO ("incaps are %" GST_PTR_FORMAT, incaps); */
if (!gst_audio_info_from_caps (&info, incaps))
goto no_format;
GST_DEBUG ("try to process %d input with %d channels",
GST_AUDIO_INFO_FORMAT (&info), GST_AUDIO_INFO_CHANNELS (&info));
if (!gst_audio_panorama_set_process_function (filter, &info))
goto no_format;
filter->info = info;
return TRUE;
no_format:
{
GST_DEBUG ("invalid caps");
return FALSE;
}
}
/* psychoacoustic processing functions */
/* mono to stereo panning
* pan: -1.0 0.0 1.0
* l: 1.0 0.5 0.0
* r: 0.0 0.5 1.0
*
* FIXME: we should use -3db (1/sqtr(2)) for 50:50
*/
static void
gst_audio_panorama_m2s_int (gfloat pan, gint16 * idata, gint16 * odata, guint n)
{
gfloat r = (pan + 1.0) / 2.0;
audiopanoramam_orc_process_s16_ch1_psy (odata, idata, 1.0 - r, r, n);
}
static void
gst_audio_panorama_m2s_float (gfloat pan, gfloat * idata,
gfloat * odata, guint n)
{
gfloat r = (pan + 1.0) / 2.0;
audiopanoramam_orc_process_f32_ch1_psy (odata, idata, 1.0 - r, r, n);
}
/* stereo balance
* pan: -1.0 0.0 1.0
* ll: 1.0 1.0 0.0
* lr: 1.0 0.0 0.0
* rr: 0.0 1.0 1.0
* rl: 0.0 0.0 1.0
*/
static void
gst_audio_panorama_s2s_int (gfloat pan, gint16 * idata, gint16 * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_s16_ch2_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat rl = pan;
gfloat ll = 1.0 - rl;
audiopanoramam_orc_process_s16_ch2_psy_right (odata, idata, ll, rl, n);
} else {
gfloat rr = 1.0 + pan;
gfloat lr = 1.0 - rr;
audiopanoramam_orc_process_s16_ch2_psy_left (odata, idata, lr, rr, n);
}
}
static void
gst_audio_panorama_s2s_float (gfloat pan, gfloat * idata,
gfloat * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_f32_ch2_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat rl = pan;
gfloat ll = 1.0 - rl;
audiopanoramam_orc_process_f32_ch2_psy_right (odata, idata, ll, rl, n);
} else {
gfloat rr = 1.0 + pan;
gfloat lr = 1.0 - rr;
audiopanoramam_orc_process_f32_ch2_psy_left (odata, idata, lr, rr, n);
}
}
/* simple processing functions */
static void
gst_audio_panorama_m2s_int_simple (gfloat pan, gint16 * idata,
gint16 * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_s16_ch1_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat lpan = 1.0 - pan;
audiopanoramam_orc_process_s16_ch1_sim_left (odata, idata, lpan, n);
} else {
gfloat rpan = 1.0 + pan;
audiopanoramam_orc_process_s16_ch1_sim_right (odata, idata, rpan, n);
}
}
static void
gst_audio_panorama_s2s_int_simple (gfloat pan, gint16 * idata,
gint16 * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_s16_ch2_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat lpan = 1.0 - pan;
audiopanoramam_orc_process_s16_ch2_sim_left (odata, idata, lpan, n);
} else {
gfloat rpan = 1.0 + pan;
audiopanoramam_orc_process_s16_ch2_sim_right (odata, idata, rpan, n);
}
}
static void
gst_audio_panorama_m2s_float_simple (gfloat pan, gfloat * idata,
gfloat * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_f32_ch1_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat lpan = 1.0 - pan;
audiopanoramam_orc_process_f32_ch1_sim_left (odata, idata, lpan, n);
} else {
gfloat rpan = 1.0 + pan;
audiopanoramam_orc_process_f32_ch1_sim_right (odata, idata, rpan, n);
}
}
static void
gst_audio_panorama_s2s_float_simple (gfloat pan, gfloat * idata,
gfloat * odata, guint n)
{
if (pan == 0.0) {
audiopanoramam_orc_process_f32_ch2_none (odata, idata, n);
} else if (pan > 0.0) {
gfloat lpan = 1.0 - pan;
audiopanoramam_orc_process_f32_ch2_sim_left (odata, idata, lpan, n);
} else {
gfloat rpan = 1.0 + pan;
audiopanoramam_orc_process_f32_ch2_sim_right (odata, idata, rpan, n);
}
}
/* this function does the actual processing
*/
static GstFlowReturn
gst_audio_panorama_transform (GstBaseTransform * base, GstBuffer * inbuf,
GstBuffer * outbuf)
{
GstAudioPanorama *filter = GST_AUDIO_PANORAMA (base);
GstClockTime ts;
GstMapInfo inmap, outmap;
ts = gst_segment_to_stream_time (&base->segment, GST_FORMAT_TIME,
GST_BUFFER_TIMESTAMP (inbuf));
if (GST_CLOCK_TIME_IS_VALID (ts)) {
GST_DEBUG_OBJECT (filter, "sync to %" GST_TIME_FORMAT, GST_TIME_ARGS (ts));
gst_object_sync_values (GST_OBJECT (filter), ts);
}
gst_buffer_map (outbuf, &outmap, GST_MAP_WRITE);
if (G_UNLIKELY (GST_BUFFER_FLAG_IS_SET (inbuf, GST_BUFFER_FLAG_GAP))) {
GST_BUFFER_FLAG_SET (outbuf, GST_BUFFER_FLAG_GAP);
orc_memset (outmap.data, 0, outmap.size);
} else {
/* output is always stereo, input is mono or stereo,
* and info describes input format */
guint num_samples = outmap.size / (2 * GST_AUDIO_INFO_BPS (&filter->info));
gst_buffer_map (inbuf, &inmap, GST_MAP_READ);
filter->process (filter->panorama, inmap.data, outmap.data, num_samples);
gst_buffer_unmap (inbuf, &inmap);
}
gst_buffer_unmap (outbuf, &outmap);
return GST_FLOW_OK;
}