1 /* GStreamer
2 * Copyright (C) 2016 Iskratel d.o.o.
3 * Author: Okrslar Ales <okrslar@iskratel.si>
4 * Copyright (C) 2016 Sebastian Dröge <sebastian@centricular.com>
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
20 */
21
22 #ifdef HAVE_CONFIG_H
23 #include "config.h"
24 #endif
25
26 #include "gsttonegeneratesrc.h"
27
28 #undef IT_DBG
29
30 GST_DEBUG_CATEGORY_STATIC (tone_generate_src_debug);
31 #define GST_CAT_DEFAULT tone_generate_src_debug
32
33 #define DEFAULT_SAMPLES_PER_BUFFER 1024
34 #define DEFAULT_FREQ 0
35 #define DEFAULT_VOLUME 0
36 #define DEFAULT_ON_TIME 1000
37 #define DEFAULT_OFF_TIME 1000
38 #define DEFAULT_REPEAT FALSE
39
40 enum
41 {
42 PROP_0,
43 PROP_SAMPLES_PER_BUFFER,
44 PROP_FREQ,
45 PROP_VOLUME,
46 PROP_FREQ2,
47 PROP_VOLUME2,
48 PROP_ON_TIME,
49 PROP_OFF_TIME,
50 PROP_ON_TIME2,
51 PROP_OFF_TIME2,
52 PROP_REPEAT,
53 PROP_LAST
54 };
55
56 static GstStaticPadTemplate gst_tone_generate_src_src_template =
57 GST_STATIC_PAD_TEMPLATE ("src",
58 GST_PAD_SRC,
59 GST_PAD_ALWAYS,
60 GST_STATIC_CAPS ("audio/x-raw, "
61 "format = (string) " GST_AUDIO_NE (S16) ", "
62 "layout = (string) interleaved, " "rate = (int) 8000, " "channels = 1")
63 );
64
65 #define gst_tone_generate_src_parent_class parent_class
66 G_DEFINE_TYPE_WITH_CODE (GstToneGenerateSrc, gst_tone_generate_src,
67 GST_TYPE_PUSH_SRC, GST_DEBUG_CATEGORY_INIT (tone_generate_src_debug,
68 "tonegeneratesrc", 0, "Telephony Tone Test Source");
69 );
70
71 GST_ELEMENT_REGISTER_DEFINE (tonegeneratesrc, "tonegeneratesrc", GST_RANK_NONE,
72 GST_TYPE_TONE_GENERATE_SRC);
73 static void gst_tone_generate_src_finalize (GObject * object);
74 static void gst_tone_generate_src_set_property (GObject * object, guint prop_id,
75 const GValue * value, GParamSpec * pspec);
76 static void gst_tone_generate_src_get_property (GObject * object, guint prop_id,
77 GValue * value, GParamSpec * pspec);
78 static gboolean gst_tone_generate_src_start (GstBaseSrc * basesrc);
79 static gboolean gst_tone_generate_src_stop (GstBaseSrc * basesrc);
80 static GstFlowReturn gst_tone_generate_src_fill (GstPushSrc * basesrc,
81 GstBuffer * buffer);
82
83 static void
gst_tone_generate_src_class_init(GstToneGenerateSrcClass * klass)84 gst_tone_generate_src_class_init (GstToneGenerateSrcClass * klass)
85 {
86 GObjectClass *gobject_class;
87 GstElementClass *gstelement_class;
88 GstBaseSrcClass *gstbasesrc_class;
89 GstPushSrcClass *gstpushsrc_class;
90
91 gobject_class = (GObjectClass *) klass;
92 gstelement_class = (GstElementClass *) klass;
93 gstbasesrc_class = (GstBaseSrcClass *) klass;
94 gstpushsrc_class = (GstPushSrcClass *) klass;
95
96 gobject_class->set_property = gst_tone_generate_src_set_property;
97 gobject_class->get_property = gst_tone_generate_src_get_property;
98 gobject_class->finalize = gst_tone_generate_src_finalize;
99
100 g_object_class_install_property (gobject_class, PROP_SAMPLES_PER_BUFFER,
101 g_param_spec_int ("samplesperbuffer", "Samples per buffer",
102 "Number of samples in each outgoing buffer",
103 1, G_MAXINT, DEFAULT_SAMPLES_PER_BUFFER,
104 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
105
106 g_object_class_install_property (gobject_class, PROP_FREQ,
107 g_param_spec_int ("freq", "Frequency", "Frequency of test signal",
108 0, 20000, DEFAULT_FREQ, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
109
110 g_object_class_install_property (gobject_class, PROP_VOLUME,
111 g_param_spec_int ("volume", "Volume",
112 "Volume of first signal",
113 -50, 0, DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
114
115 g_object_class_install_property (gobject_class, PROP_FREQ2,
116 g_param_spec_int ("freq2", "Second Frequency",
117 "Frequency of second telephony tone component",
118 0, 20000, DEFAULT_FREQ, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
119
120 g_object_class_install_property (gobject_class, PROP_VOLUME2,
121 g_param_spec_int ("volume2", "Volume2",
122 "Volume of second tone signal",
123 -50, 0, DEFAULT_VOLUME, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
124
125 g_object_class_install_property (gobject_class, PROP_ON_TIME,
126 g_param_spec_int ("on-time", "Signal ON time first period",
127 "Time of the first period when the tone signal is present", 1,
128 G_MAXINT, DEFAULT_ON_TIME, G_PARAM_READWRITE));
129
130 g_object_class_install_property (gobject_class, PROP_OFF_TIME,
131 g_param_spec_int ("off-time", "Signal OFF time first period ",
132 "Time of the first period when the tone signal is off", 0, G_MAXINT,
133 DEFAULT_OFF_TIME, G_PARAM_READWRITE));
134
135 g_object_class_install_property (gobject_class, PROP_ON_TIME2,
136 g_param_spec_int ("on-time2", "Signal ON time second period",
137 "Time of the second period when the tone signal is present", 1,
138 G_MAXINT, DEFAULT_ON_TIME, G_PARAM_READWRITE));
139
140 g_object_class_install_property (gobject_class, PROP_OFF_TIME2,
141 g_param_spec_int ("off-time2", "Signal OFF time first period ",
142 "Time of the second period when the tone signal is off", 0, G_MAXINT,
143 DEFAULT_ON_TIME, G_PARAM_READWRITE));
144
145 g_object_class_install_property (gobject_class, PROP_REPEAT,
146 g_param_spec_boolean ("repeat", "Repeat the specified tone period ",
147 "Whether to repeat specified tone indefinitely", DEFAULT_REPEAT,
148 G_PARAM_READWRITE));
149
150 gst_element_class_add_static_pad_template (gstelement_class,
151 &gst_tone_generate_src_src_template);
152
153 gst_element_class_set_static_metadata (gstelement_class,
154 "Telephony Tone Generator source", "Source/Audio",
155 "Creates telephony signals of given frequency, volume, cadence",
156 "Iskratel <www.iskratel.com>");
157
158 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_tone_generate_src_start);
159 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_tone_generate_src_stop);
160 gstpushsrc_class->fill = GST_DEBUG_FUNCPTR (gst_tone_generate_src_fill);
161 }
162
163 static void
gst_tone_generate_src_init(GstToneGenerateSrc * src)164 gst_tone_generate_src_init (GstToneGenerateSrc * src)
165 {
166 src->volume = DEFAULT_VOLUME;
167 src->freq = DEFAULT_FREQ;
168 src->on_time = DEFAULT_ON_TIME;
169 src->off_time = DEFAULT_OFF_TIME;
170 src->volume2 = DEFAULT_VOLUME;
171 src->freq2 = DEFAULT_FREQ;
172 src->on_time2 = DEFAULT_ON_TIME;
173 src->off_time2 = DEFAULT_OFF_TIME;
174 src->repeat = DEFAULT_REPEAT;
175
176 gst_base_src_set_format (GST_BASE_SRC (src), GST_FORMAT_TIME);
177
178 src->samples_per_buffer = DEFAULT_SAMPLES_PER_BUFFER;
179 gst_base_src_set_blocksize (GST_BASE_SRC (src), 2 * src->samples_per_buffer);
180 }
181
182 static void
gst_tone_generate_src_finalize(GObject * object)183 gst_tone_generate_src_finalize (GObject * object)
184 {
185 GstToneGenerateSrc *src = GST_TONE_GENERATE_SRC (object);
186
187 if (src->tone_desc) {
188 tone_gen_descriptor_free (src->tone_desc);
189 src->tone_desc = NULL;
190 }
191
192 if (src->tone_state) {
193 tone_gen_free (src->tone_state);
194 src->tone_state = NULL;
195 }
196
197 G_OBJECT_CLASS (parent_class)->finalize (object);
198 }
199
200 static gboolean
gst_tone_generate_src_start(GstBaseSrc * basesrc)201 gst_tone_generate_src_start (GstBaseSrc * basesrc)
202 {
203 GstToneGenerateSrc *src = GST_TONE_GENERATE_SRC (basesrc);
204
205 GST_OBJECT_LOCK (src);
206 src->properties_changed = FALSE;
207 GST_OBJECT_UNLOCK (src);
208
209 src->next_sample = 0;
210 src->next_time = 0;
211
212 return TRUE;
213 }
214
215 static gboolean
gst_tone_generate_src_stop(GstBaseSrc * basesrc)216 gst_tone_generate_src_stop (GstBaseSrc * basesrc)
217 {
218 GstToneGenerateSrc *src = GST_TONE_GENERATE_SRC (basesrc);
219
220 GST_OBJECT_LOCK (src);
221 if (src->tone_desc) {
222 tone_gen_descriptor_free (src->tone_desc);
223 src->tone_desc = NULL;
224 }
225
226 if (src->tone_state) {
227 tone_gen_free (src->tone_state);
228 src->tone_state = NULL;
229 }
230 src->properties_changed = FALSE;
231 GST_OBJECT_UNLOCK (src);
232
233 return TRUE;
234 }
235
236 static GstFlowReturn
gst_tone_generate_src_fill(GstPushSrc * basesrc,GstBuffer * buffer)237 gst_tone_generate_src_fill (GstPushSrc * basesrc, GstBuffer * buffer)
238 {
239 GstToneGenerateSrc *src;
240 GstClockTime next_time;
241 gint64 next_sample;
242 gint bytes, samples;
243 GstMapInfo map;
244 const gint samplerate = 8000, bpf = 2;
245
246 src = GST_TONE_GENERATE_SRC (basesrc);
247
248 bytes = gst_buffer_get_size (buffer);
249 samples = bytes / bpf;
250
251 /* calculate full buffer */
252 next_sample = src->next_sample + samples;
253
254 next_time = gst_util_uint64_scale_int (next_sample, GST_SECOND, samplerate);
255
256 GST_LOG_OBJECT (src, "samplerate %d", samplerate);
257 GST_LOG_OBJECT (src, "next_sample %" G_GINT64_FORMAT ", ts %" GST_TIME_FORMAT,
258 next_sample, GST_TIME_ARGS (next_time));
259
260 GST_BUFFER_OFFSET (buffer) = src->next_sample;
261 GST_BUFFER_OFFSET_END (buffer) = next_sample;
262 GST_BUFFER_TIMESTAMP (buffer) = src->next_time;
263 GST_BUFFER_DURATION (buffer) = next_time - src->next_time;
264
265 gst_object_sync_values (GST_OBJECT (src), GST_BUFFER_TIMESTAMP (buffer));
266
267 src->next_time = next_time;
268 src->next_sample = next_sample;
269
270 GST_LOG_OBJECT (src, "generating %u samples at ts %" GST_TIME_FORMAT,
271 samples, GST_TIME_ARGS (GST_BUFFER_TIMESTAMP (buffer)));
272
273 gst_buffer_map (buffer, &map, GST_MAP_WRITE);
274
275 GST_OBJECT_LOCK (src);
276 if (!src->tone_state || src->properties_changed) {
277 src->tone_desc = tone_gen_descriptor_init (src->tone_desc,
278 src->freq,
279 src->volume,
280 src->freq2,
281 src->volume2,
282 src->on_time,
283 src->off_time, src->on_time2, src->off_time2, src->repeat);
284
285 src->tone_state = tone_gen_init (src->tone_state, src->tone_desc);
286 src->properties_changed = FALSE;
287 }
288
289 tone_gen (src->tone_state, (int16_t *) map.data, samples);
290 GST_OBJECT_UNLOCK (src);
291
292 gst_buffer_unmap (buffer, &map);
293
294 return GST_FLOW_OK;
295 }
296
297 static void
gst_tone_generate_src_set_property(GObject * object,guint prop_id,const GValue * value,GParamSpec * pspec)298 gst_tone_generate_src_set_property (GObject * object, guint prop_id,
299 const GValue * value, GParamSpec * pspec)
300 {
301 GstToneGenerateSrc *src = GST_TONE_GENERATE_SRC (object);
302
303 switch (prop_id) {
304 case PROP_SAMPLES_PER_BUFFER:
305 src->samples_per_buffer = g_value_get_int (value);
306 gst_base_src_set_blocksize (GST_BASE_SRC_CAST (src),
307 2 * src->samples_per_buffer);
308 break;
309 case PROP_FREQ:
310 GST_OBJECT_LOCK (src);
311 src->freq = g_value_get_int (value);
312 src->properties_changed = TRUE;
313 GST_OBJECT_UNLOCK (src);
314 break;
315 case PROP_VOLUME:
316 GST_OBJECT_LOCK (src);
317 src->volume = g_value_get_int (value);
318 src->properties_changed = TRUE;
319 GST_OBJECT_UNLOCK (src);
320 break;
321 case PROP_FREQ2:
322 GST_OBJECT_LOCK (src);
323 src->freq2 = g_value_get_int (value);
324 src->properties_changed = TRUE;
325 GST_OBJECT_UNLOCK (src);
326 break;
327 case PROP_VOLUME2:
328 GST_OBJECT_LOCK (src);
329 src->volume2 = g_value_get_int (value);
330 src->properties_changed = TRUE;
331 GST_OBJECT_UNLOCK (src);
332 break;
333 case PROP_ON_TIME:
334 GST_OBJECT_LOCK (src);
335 src->on_time = g_value_get_int (value);
336 src->properties_changed = TRUE;
337 GST_OBJECT_UNLOCK (src);
338 break;
339 case PROP_ON_TIME2:
340 GST_OBJECT_LOCK (src);
341 src->on_time2 = g_value_get_int (value);
342 src->properties_changed = TRUE;
343 GST_OBJECT_UNLOCK (src);
344 break;
345 case PROP_OFF_TIME:
346 GST_OBJECT_LOCK (src);
347 src->off_time = g_value_get_int (value);
348 src->properties_changed = TRUE;
349 GST_OBJECT_UNLOCK (src);
350 break;
351 case PROP_OFF_TIME2:
352 GST_OBJECT_LOCK (src);
353 src->off_time2 = g_value_get_int (value);
354 src->properties_changed = TRUE;
355 GST_OBJECT_UNLOCK (src);
356 break;
357 case PROP_REPEAT:
358 GST_OBJECT_LOCK (src);
359 src->repeat = g_value_get_boolean (value);
360 src->properties_changed = TRUE;
361 GST_OBJECT_UNLOCK (src);
362 break;
363 default:
364 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
365 break;
366 }
367 }
368
369 static void
gst_tone_generate_src_get_property(GObject * object,guint prop_id,GValue * value,GParamSpec * pspec)370 gst_tone_generate_src_get_property (GObject * object, guint prop_id,
371 GValue * value, GParamSpec * pspec)
372 {
373 GstToneGenerateSrc *src = GST_TONE_GENERATE_SRC (object);
374
375 switch (prop_id) {
376 case PROP_SAMPLES_PER_BUFFER:
377 g_value_set_int (value, src->samples_per_buffer);
378 break;
379 case PROP_FREQ:
380 g_value_set_int (value, src->freq);
381 break;
382 case PROP_VOLUME:
383 g_value_set_int (value, src->volume);
384 break;
385 case PROP_FREQ2:
386 g_value_set_int (value, src->freq2);
387 break;
388 case PROP_VOLUME2:
389 g_value_set_int (value, src->volume2);
390 break;
391 case PROP_ON_TIME:
392 g_value_set_int (value, src->on_time);
393 break;
394 case PROP_OFF_TIME:
395 g_value_set_int (value, src->off_time);
396 break;
397 case PROP_ON_TIME2:
398 g_value_set_int (value, src->on_time2);
399 break;
400 case PROP_OFF_TIME2:
401 g_value_set_int (value, src->off_time2);
402 break;
403 case PROP_REPEAT:
404 g_value_set_boolean (value, src->repeat);
405 break;
406 default:
407 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
408 break;
409 }
410 }
411