2 This file is part of GNUnet.
3 Copyright (C) 2013 GNUnet e.V.
5 GNUnet is free software: you can redistribute it and/or modify it
6 under the terms of the GNU Affero General Public License as published
7 by the Free Software Foundation, either version 3 of the License,
8 or (at your option) any later version.
10 GNUnet is distributed in the hope that it will be useful, but
11 WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Affero General Public License for more details.
15 You should have received a copy of the GNU Affero General Public License
16 along with this program. If not, see <http://www.gnu.org/licenses/>.
18 SPDX-License-Identifier: AGPL3.0-or-later
21 * @file conversation/gnunet-helper-audio-record-gst.c
22 * @brief program to record audio data from the microphone (GStreamer version)
26 #include "gnunet_util_lib.h"
27 #include "gnunet_protocols.h"
28 #include "conversation.h"
29 #include "gnunet_constants.h"
30 #include "gnunet_core_service.h"
33 #include <gst/app/gstappsink.h>
34 #include <gst/audio/gstaudiobasesrc.h>
37 #define DEBUG_RECORD_PURE_OGG 1
41 * Must be one of the following (from libopusenc documentation):
44 #define OPUS_CHANNELS 1
47 * Maximal size of a single opus packet.
49 #define MAX_PAYLOAD_SIZE (1024 / OPUS_CHANNELS)
52 * Size of a single frame fed to the encoder, in ms.
53 * Must be one of the following (from libopus documentation):
54 * 2.5, 5, 10, 20, 40 or 60
56 #define OPUS_FRAME_SIZE 40
59 * Expected packet loss to prepare for, in percents.
61 #define PACKET_LOSS_PERCENTAGE 1
64 * Set to 1 to enable forward error correction.
65 * Set to 0 to disable.
67 #define INBAND_FEC_MODE 1
70 * Max number of microseconds to buffer in audiosource.
73 #define BUFFER_TIME 1000 /* 1ms */
76 * Min number of microseconds to buffer in audiosource.
79 #define LATENCY_TIME 1000 /* 1ms */
82 * Maximum delay in multiplexing streams, in ns.
83 * Setting this to 0 forces page flushing, which
84 * decreases delay, but increases overhead.
86 #define OGG_MAX_DELAY 0
89 * Maximum delay for sending out a page, in ns.
90 * Setting this to 0 forces page flushing, which
91 * decreases delay, but increases overhead.
93 #define OGG_MAX_PAGE_DELAY 0
98 static GstElement *pipeline;
100 #ifdef DEBUG_RECORD_PURE_OGG
101 static int dump_pure_ogg;
107 if (NULL != pipeline)
108 gst_element_set_state (pipeline, GST_STATE_NULL);
113 bus_call (GstBus *bus, GstMessage *msg, gpointer data)
115 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Bus message\n");
116 switch (GST_MESSAGE_TYPE (msg))
118 case GST_MESSAGE_EOS:
119 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "End of stream\n");
123 case GST_MESSAGE_ERROR:
128 gst_message_parse_error (msg, &error, &debug);
131 GNUNET_log (GNUNET_ERROR_TYPE_ERROR, "Error: %s\n", error->message);
132 g_error_free (error);
147 source_child_added (GstChildProxy *child_proxy, GObject *object, gchar *name,
150 if (GST_IS_AUDIO_BASE_SRC (object))
151 g_object_set (object, "buffer-time", (gint64) BUFFER_TIME, "latency-time",
152 (gint64) LATENCY_TIME, NULL);
157 signalhandler (int s)
164 main (int argc, char **argv)
166 GstElement *source, *filter, *encoder, *conv, *resampler, *sink, *oggmux;
170 struct AudioMessage audio_message;
173 typedef void (*SignalHandlerPointer) (int);
175 SignalHandlerPointer inthandler, termhandler;
176 inthandler = signal (SIGINT, signalhandler);
177 termhandler = signal (SIGTERM, signalhandler);
179 #ifdef DEBUG_RECORD_PURE_OGG
180 dump_pure_ogg = getenv ("GNUNET_RECORD_PURE_OGG") ? 1 : 0;
184 gst_init (&argc, &argv);
186 GNUNET_assert (GNUNET_OK ==
187 GNUNET_log_setup ("gnunet-helper-audio-record",
191 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
192 "Audio source starts\n");
194 audio_message.header.type = htons (GNUNET_MESSAGE_TYPE_CONVERSATION_AUDIO);
196 /* Create gstreamer elements */
197 pipeline = gst_pipeline_new ("audio-recorder");
198 source = gst_element_factory_make ("autoaudiosrc", "audiosource");
199 filter = gst_element_factory_make ("capsfilter", "filter");
200 conv = gst_element_factory_make ("audioconvert", "converter");
201 resampler = gst_element_factory_make ("audioresample", "resampler");
202 encoder = gst_element_factory_make ("opusenc", "opus-encoder");
203 oggmux = gst_element_factory_make ("oggmux", "ogg-muxer");
204 sink = gst_element_factory_make ("appsink", "audio-output");
206 if (! pipeline || ! filter || ! source || ! conv || ! resampler ||
207 ! encoder || ! oggmux || ! sink)
209 GNUNET_log (GNUNET_ERROR_TYPE_ERROR,
210 "One element could not be created. Exiting.\n");
214 g_signal_connect (source, "child-added", G_CALLBACK (source_child_added),
217 /* Set up the pipeline */
219 caps = gst_caps_new_simple ("audio/x-raw",
220 "format", G_TYPE_STRING, "S16LE",
221 /* "rate", G_TYPE_INT, SAMPLING_RATE,*/
222 "channels", G_TYPE_INT, OPUS_CHANNELS,
223 /* "layout", G_TYPE_STRING, "interleaved",*/
225 g_object_set (G_OBJECT (filter),
228 gst_caps_unref (caps);
230 g_object_set (G_OBJECT (encoder),
231 /* "bitrate", 64000, */
232 /* "bandwidth", OPUS_BANDWIDTH_FULLBAND, */
233 "inband-fec", INBAND_FEC_MODE,
234 "packet-loss-percentage", PACKET_LOSS_PERCENTAGE,
235 "max-payload-size", MAX_PAYLOAD_SIZE,
236 "audio", FALSE, /* VoIP, not audio */
237 "frame-size", OPUS_FRAME_SIZE,
240 g_object_set (G_OBJECT (oggmux),
241 "max-delay", OGG_MAX_DELAY,
242 "max-page-delay", OGG_MAX_PAGE_DELAY,
245 /* we add a message handler */
246 bus = gst_pipeline_get_bus (GST_PIPELINE (pipeline));
247 bus_watch_id = gst_bus_add_watch (bus, bus_call, pipeline);
248 gst_object_unref (bus);
250 /* we add all elements into the pipeline */
251 /* audiosource | converter | resampler | opus-encoder | audio-output */
252 gst_bin_add_many (GST_BIN (pipeline), source, filter, conv, resampler,
256 /* we link the elements together */
257 gst_element_link_many (source, filter, conv, resampler, encoder, oggmux, sink,
260 /* Set the pipeline to "playing" state*/
261 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Now playing\n");
262 gst_element_set_state (pipeline, GST_STATE_PLAYING);
265 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Running...\n");
272 size_t len, msg_size;
276 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "pulling...\n");
277 s = gst_app_sink_pull_sample (GST_APP_SINK (sink));
280 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "pulled NULL\n");
283 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "...pulled!\n");
285 const GstStructure *si;
289 si = gst_sample_get_info (s);
292 si_str = gst_structure_to_string (si);
295 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got sample %s\n", si_str);
300 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got sample with no info\n");
301 s_caps = gst_sample_get_caps (s);
304 caps_str = gst_caps_to_string (s_caps);
307 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got sample with caps %s\n",
313 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG, "Got sample with no caps\n");
315 b = gst_sample_get_buffer (s);
316 if ((NULL == b) || ! gst_buffer_map (b, &m, GST_MAP_READ))
318 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
319 "got NULL buffer %p or failed to map the buffer\n", b);
320 gst_sample_unref (s);
325 if (len > UINT16_MAX - sizeof(struct AudioMessage))
328 len = UINT16_MAX - sizeof(struct AudioMessage);
330 msg_size = sizeof(struct AudioMessage) + len;
331 audio_message.header.size = htons ((uint16_t) msg_size);
333 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
334 "Sending %u bytes of audio data\n", (unsigned int) msg_size);
335 for (phase = 0; phase < 2; phase++)
342 #ifdef DEBUG_RECORD_PURE_OGG
346 ptr = (const char *) &audio_message;
347 to_send = sizeof(audio_message);
351 ptr = (const char *) m.data;
354 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
355 "Sending %u bytes on phase %d\n", (unsigned int) to_send,
357 for (offset = 0; offset < to_send; offset += ret)
359 ret = write (1, &ptr[offset], to_send - offset);
363 GNUNET_log (GNUNET_ERROR_TYPE_DEBUG,
364 "Failed to write %u bytes at offset %u (total %u) in phase %d: %s\n",
365 (unsigned int) (to_send - offset),
366 (unsigned int) offset,
367 (unsigned int) (to_send + offset),
377 gst_buffer_unmap (b, &m);
378 gst_sample_unref (s);
381 signal (SIGINT, inthandler);
382 signal (SIGINT, termhandler);
384 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Returned, stopping playback\n");
387 GNUNET_log (GNUNET_ERROR_TYPE_INFO, "Deleting pipeline\n");
388 gst_object_unref (GST_OBJECT (pipeline));
390 g_source_remove (bus_watch_id);