File: input_portaudio.c

package info (click to toggle)
libvisual-plugins 1%3A0.4.2%2Bdfsg-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,976 kB
  • sloc: ansic: 9,959; sh: 4,942; cpp: 871; makefile: 227; sed: 16
file content (217 lines) | stat: -rw-r--r-- 7,019 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
/* Libvisual-plugins - Standard plugins for libvisual
 *
 * Copyright (C) 2023 Sebastian Pipping <sebastian@pipping.org>
 *
 * Authors: Sebastian Pipping <sebastian@pipping.org>
 *
 * This program 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.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#include <stdlib.h>  // malloc

#include <libvisual/libvisual.h>
#include "gettext.h"
#include <portaudio.h>

VISUAL_PLUGIN_API_VERSION_VALIDATOR

#define SAMPLE_RATE 44100
#define SAMPLE_RATE_TYPE_LV VISUAL_AUDIO_SAMPLE_RATE_44100
#define SAMPLE_FORMAT_BITS 16
#define SAMPLE_FORMAT_PA paInt16
#define SAMPLE_FORMAT_LV VISUAL_AUDIO_SAMPLE_FORMAT_S16

#define FRAMES 1024

typedef struct {
	PaStream *stream;
	unsigned int channel_count;  // 0 (unknown), 1 (mono) or 2 (stereo)
	void * buffer;
} PortAudioPrivate;

static int inp_portaudio_init (VisPluginData *plugin);
static int inp_portaudio_cleanup (VisPluginData *plugin);
static int inp_portaudio_upload (VisPluginData *plugin, VisAudio *audio);

const VisPluginInfo *get_plugin_info (int *count)
{
	static VisInputPlugin input[] = {{
		.upload = inp_portaudio_upload
	}};

	static VisPluginInfo info[] = {{
		.type = VISUAL_PLUGIN_TYPE_INPUT,

		.plugname = "portaudio",
		.name = "portaudio",
		.author = "Sebastian Pipping <sebastian@pipping.org>",
		.version = "1.0",
		.about = N_("PortAudio capture plugin"),
		.help = N_("Use this plugin to capture PCM data from the PortAudio record device"),
		.license = VISUAL_PLUGIN_LICENSE_LGPL,

		.init = inp_portaudio_init,
		.cleanup = inp_portaudio_cleanup,

		.plugin = VISUAL_OBJECT (&input[0])
	}};

	*count = sizeof (info) / sizeof (*info);

	return info;
}

int inp_portaudio_init (VisPluginData *plugin)
{
#if ENABLE_NLS
	bindtextdomain (GETTEXT_PACKAGE, LOCALEDIR);
#endif

	PortAudioPrivate * const priv = visual_mem_new0 (PortAudioPrivate, 1);
	visual_log_return_val_if_fail(priv != NULL, -1);
	visual_object_set_private (VISUAL_OBJECT (plugin), priv);

	// Init PortAudio
	const PaError init_error = Pa_Initialize();
	visual_log_return_val_if_fail (init_error == paNoError, -2);

	// Select input device
	const PaDeviceIndex input_device = Pa_GetDefaultInputDevice ();
	visual_log_return_val_if_fail (input_device != paNoDevice, -3);

	// Open stream
	// Try stereo first, fall back to mono as needed
	priv->channel_count = 2;  // i.e. stereo
	const double latency_seconds = 1.0 / SAMPLE_RATE * FRAMES;
	PaStreamParameters input_parameters = {
			.device = input_device,
			.channelCount = priv->channel_count,
			.sampleFormat = SAMPLE_FORMAT_PA,
			.suggestedLatency = latency_seconds,
			.hostApiSpecificStreamInfo = NULL};
	const PaError stereo_open_error =
			Pa_OpenStream (&priv->stream, &input_parameters, NULL,
						   SAMPLE_RATE, FRAMES, paClipOff, NULL, NULL);
	if (stereo_open_error != paNoError) {
		if (stereo_open_error != paInvalidChannelCount) {
			visual_log (VISUAL_LOG_CRITICAL,
					"PortAudio: Could not open stereo input stream, error %d \"%s\".",
					stereo_open_error, Pa_GetErrorText (stereo_open_error));
			return -3;
		}

		// Try again with mono
		assert(stereo_open_error == paInvalidChannelCount);
		visual_log (VISUAL_LOG_INFO, "PortAudio: Could not open stereo input stream, trying again with mono.");
		priv->channel_count = 1;  // i.e. mono
		input_parameters.channelCount = priv->channel_count;

		const PaError mono_open_error =
				Pa_OpenStream (&priv->stream, &input_parameters, NULL,
							SAMPLE_RATE, FRAMES, paClipOff, NULL, NULL);
		if (mono_open_error != paNoError) {
			visual_log (VISUAL_LOG_CRITICAL,
					"PortAudio: Could not open mono input stream, error %d \"%s\".",
					mono_open_error, Pa_GetErrorText (mono_open_error));
			return -3;
		}
	}
	visual_log (VISUAL_LOG_INFO, "PortAudio: Input stream opened with %d channel(s).", priv->channel_count);

	// Allocate buffer
	const visual_size_t buffer_size_bytes = FRAMES * priv->channel_count * (SAMPLE_FORMAT_BITS / 8);
	priv->buffer = malloc (buffer_size_bytes);
	visual_log_return_val_if_fail (priv->buffer != NULL, -4);

	// Start stream
	const PaError input_start_error = Pa_StartStream (priv->stream);
	visual_log_return_val_if_fail (input_start_error == paNoError, -5);

	return 0;
}

int inp_portaudio_cleanup (VisPluginData *plugin)
{
	visual_log_return_val_if_fail (plugin != NULL, -1);

	PortAudioPrivate * const priv = visual_object_get_private (VISUAL_OBJECT (plugin));
	visual_log_return_val_if_fail (priv != NULL, -2);

	free (priv->buffer);
	priv->buffer = NULL;

	Pa_StopStream (priv->stream);
	Pa_CloseStream (priv->stream);
	priv->stream = NULL;

	Pa_Terminate ();

	visual_mem_free (priv);

	return 0;
}

int inp_portaudio_upload (VisPluginData *plugin, VisAudio *audio)
{
	visual_log_return_val_if_fail (plugin != NULL, -1);
	visual_log_return_val_if_fail (audio != NULL, -2);

	PortAudioPrivate * const priv = visual_object_get_private (VISUAL_OBJECT (plugin));
	visual_log_return_val_if_fail (priv != NULL, -3);
	visual_log_return_val_if_fail (priv->stream != NULL, -4);

	for (;;) {
		long frames_to_read = Pa_GetStreamReadAvailable (priv->stream);
		if (frames_to_read < 1) {
			return 0;
		}
		if (frames_to_read > FRAMES) {
			frames_to_read = FRAMES;  // because that's all that priv->buffer has space for
		}

		const PaError read_error = Pa_ReadStream(priv->stream, priv->buffer, frames_to_read);
		if (read_error != paNoError) {
			return 0;
		}

		const visual_size_t bytes_to_write = frames_to_read * priv->channel_count * (SAMPLE_FORMAT_BITS / 8);

		VisBuffer buffer;
		visual_buffer_init(&buffer, priv->buffer, bytes_to_write, NULL);

		if (priv->channel_count == 2) {
		    visual_audio_samplepool_input(audio->samplepool, &buffer, SAMPLE_RATE_TYPE_LV,
					SAMPLE_FORMAT_LV, VISUAL_AUDIO_SAMPLE_CHANNEL_STEREO);
		} else {
			assert(priv->channel_count == 1);

			// Let's feed the same mono input to both the left and right channel.
			// This helps actors plugins that call
			// "visual_audio_get_sample ([..], [..], VISUAL_AUDIO_CHANNEL_RIGHT)"
			// explicitly without checking return values.
			const char * const channels[] = {
				VISUAL_AUDIO_CHANNEL_LEFT,
				VISUAL_AUDIO_CHANNEL_RIGHT
			};

			for (size_t i = 0; i < sizeof(channels) / sizeof(channels[0]); i++) {
				visual_audio_samplepool_input_channel(audio->samplepool, &buffer, SAMPLE_RATE_TYPE_LV,
						SAMPLE_FORMAT_LV, channels[i]);
			}
		}
	}

	// we never get here
}