ext/alsa/gstalsasink.c: Don't update the time of the clock sync to the clock given...
[platform/upstream/gst-plugins-good.git] / sys / oss / gstosssink.c
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wim.taymans@chello.be>
4  *
5  * gstosssink.c: 
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public
18  * License along with this library; if not, write to the
19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  */
22
23 #ifdef HAVE_CONFIG_H
24 #include "config.h"
25 #endif
26 #include <sys/ioctl.h>
27 #include <sys/soundcard.h>
28 #include <errno.h>
29 #include <unistd.h>
30
31 #include "gstosssink.h"
32
33 /* elementfactory information */
34 static GstElementDetails gst_osssink_details = GST_ELEMENT_DETAILS (
35   "Audio Sink (OSS)",
36   "Sink/Audio",
37   "Output to a sound card via OSS",
38   "Erik Walthinsen <omega@cse.ogi.edu>, "
39   "Wim Taymans <wim.taymans@chello.be>"
40 );
41
42 static void                     gst_osssink_base_init           (gpointer g_class);
43 static void                     gst_osssink_class_init          (GstOssSinkClass *klass);
44 static void                     gst_osssink_init                (GstOssSink *osssink);
45 static void                     gst_osssink_dispose             (GObject *object);
46
47 static GstElementStateReturn    gst_osssink_change_state        (GstElement *element);
48 static void                     gst_osssink_set_clock           (GstElement *element, GstClock *clock);
49 static GstClock*                gst_osssink_get_clock           (GstElement *element);
50 static GstClockTime             gst_osssink_get_time            (GstClock *clock, gpointer data);
51
52 static const GstFormat*         gst_osssink_get_formats         (GstPad *pad);
53 static gboolean                 gst_osssink_convert             (GstPad *pad, GstFormat src_format, gint64 src_value,
54                                                                  GstFormat *dest_format, gint64 *dest_value);
55 static const GstQueryType*      gst_osssink_get_query_types     (GstPad *pad);
56 static gboolean                 gst_osssink_query               (GstElement *element, GstQueryType type, 
57                                                                  GstFormat *format, gint64 *value);
58 static gboolean                 gst_osssink_sink_query          (GstPad *pad, GstQueryType type,
59                                                                  GstFormat *format, gint64 *value);
60
61 static GstCaps *                gst_osssink_sink_fixate         (GstPad *pad, const GstCaps *caps);
62 static GstPadLinkReturn         gst_osssink_sinkconnect         (GstPad *pad, const GstCaps *caps);
63
64 static void                     gst_osssink_set_property        (GObject *object, guint prop_id, const GValue *value, 
65                                                                  GParamSpec *pspec);
66 static void                     gst_osssink_get_property        (GObject *object, guint prop_id, GValue *value, 
67                                                                  GParamSpec *pspec);
68
69 static void                     gst_osssink_chain               (GstPad *pad,GstData *_data);
70
71 /* OssSink signals and args */
72 enum {
73   SIGNAL_HANDOFF,
74   LAST_SIGNAL
75 };
76
77 enum {
78   ARG_0,
79   ARG_MUTE,
80   ARG_FRAGMENT,
81   ARG_BUFFER_SIZE,
82   ARG_SYNC,
83   ARG_CHUNK_SIZE,
84   /* FILL ME */
85 };
86
87 static GstStaticPadTemplate osssink_sink_factory =
88 GST_STATIC_PAD_TEMPLATE (
89   "sink",
90   GST_PAD_SINK,
91   GST_PAD_ALWAYS,
92   GST_STATIC_CAPS ("audio/x-raw-int, "
93       "endianness = (int) BYTE_ORDER, "
94       "signed = (boolean) { TRUE, FALSE }, "
95       "width = (int) { 8, 16 }, "
96       "depth = (int) { 8, 16 }, "
97       "rate = (int) [ 1000, 48000 ], "
98       "channels = (int) [ 1, 2 ]"
99   )
100 );
101
102 static GstElementClass *parent_class = NULL;
103 static guint gst_osssink_signals[LAST_SIGNAL] = { 0 };
104
105 GType
106 gst_osssink_get_type (void) 
107 {
108   static GType osssink_type = 0;
109
110   if (!osssink_type) {
111     static const GTypeInfo osssink_info = {
112       sizeof(GstOssSinkClass),
113       gst_osssink_base_init,
114       NULL,
115       (GClassInitFunc)gst_osssink_class_init,
116       NULL,
117       NULL,
118       sizeof(GstOssSink),
119       0,
120       (GInstanceInitFunc)gst_osssink_init,
121     };
122     osssink_type = g_type_register_static (GST_TYPE_OSSELEMENT, "GstOssSink", &osssink_info, 0);
123   }
124
125   return osssink_type;
126 }
127
128 static void
129 gst_osssink_dispose (GObject *object)
130 {
131   GstOssSink *osssink = (GstOssSink *) object;
132
133   gst_object_unparent (GST_OBJECT (osssink->provided_clock));
134
135   G_OBJECT_CLASS (parent_class)->dispose (object);
136 }
137
138 static void
139 gst_osssink_base_init (gpointer g_class)
140 {
141   GstElementClass *element_class = GST_ELEMENT_CLASS (g_class);
142   
143   gst_element_class_set_details (element_class, &gst_osssink_details);
144   gst_element_class_add_pad_template (element_class, gst_static_pad_template_get (&osssink_sink_factory));
145 }
146 static void
147 gst_osssink_class_init (GstOssSinkClass *klass) 
148 {
149   GObjectClass *gobject_class;
150   GstElementClass *gstelement_class;
151
152   gobject_class = (GObjectClass*)klass;
153   gstelement_class = (GstElementClass*)klass;
154
155   parent_class = g_type_class_ref(GST_TYPE_OSSELEMENT);
156
157   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MUTE,
158     g_param_spec_boolean ("mute", "Mute", "Mute the audio",
159                           FALSE, G_PARAM_READWRITE)); 
160   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_SYNC,
161     g_param_spec_boolean ("sync", "Sync", "If syncing on timestamps should be enabled",
162                           TRUE, G_PARAM_READWRITE)); 
163   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FRAGMENT,
164     g_param_spec_int ("fragment", "Fragment", 
165                       "The fragment as 0xMMMMSSSS (MMMM = total fragments, 2^SSSS = fragment size)",
166                       0, G_MAXINT, 6, G_PARAM_READWRITE));
167   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BUFFER_SIZE,
168     g_param_spec_uint ("buffer_size", "Buffer size", "Size of buffers in osssink's bufferpool (bytes)",
169                        0, G_MAXINT, 4096, G_PARAM_READWRITE));
170   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_CHUNK_SIZE,
171     g_param_spec_uint ("chunk_size", "Chunk size", "Write data in chunk sized buffers",
172                        0, G_MAXUINT, 4096, G_PARAM_READWRITE));
173
174   gst_osssink_signals[SIGNAL_HANDOFF] =
175     g_signal_new ("handoff", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
176                   G_STRUCT_OFFSET (GstOssSinkClass, handoff), NULL, NULL,
177                   g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
178   
179   gobject_class->set_property = gst_osssink_set_property;
180   gobject_class->get_property = gst_osssink_get_property;
181   gobject_class->dispose      = gst_osssink_dispose;
182   
183   gstelement_class->change_state = GST_DEBUG_FUNCPTR (gst_osssink_change_state);
184   gstelement_class->query        = GST_DEBUG_FUNCPTR (gst_osssink_query);
185   gstelement_class->set_clock    = gst_osssink_set_clock;
186   gstelement_class->get_clock    = gst_osssink_get_clock;
187   
188 }
189
190 static void 
191 gst_osssink_init (GstOssSink *osssink) 
192 {
193   osssink->sinkpad = gst_pad_new_from_template (
194                   gst_static_pad_template_get (&osssink_sink_factory), "sink");
195   gst_element_add_pad (GST_ELEMENT (osssink), osssink->sinkpad);
196   gst_pad_set_link_function (osssink->sinkpad, gst_osssink_sinkconnect);
197   gst_pad_set_fixate_function (osssink->sinkpad, gst_osssink_sink_fixate);
198   gst_pad_set_convert_function (osssink->sinkpad, gst_osssink_convert);
199   gst_pad_set_query_function (osssink->sinkpad, gst_osssink_sink_query);
200   gst_pad_set_query_type_function (osssink->sinkpad, gst_osssink_get_query_types);
201   gst_pad_set_formats_function (osssink->sinkpad, gst_osssink_get_formats);
202
203   gst_pad_set_chain_function (osssink->sinkpad, gst_osssink_chain);
204
205   osssink->bufsize = 4096;
206   osssink->chunk_size = 4096;
207   osssink->mute = FALSE;
208   osssink->sync = TRUE;
209   osssink->provided_clock = gst_audio_clock_new ("ossclock", gst_osssink_get_time, osssink);
210   gst_object_set_parent (GST_OBJECT (osssink->provided_clock), GST_OBJECT (osssink));
211   osssink->handled = 0;
212
213   GST_FLAG_SET (osssink, GST_ELEMENT_THREAD_SUGGESTED);
214   GST_FLAG_SET (osssink, GST_ELEMENT_EVENT_AWARE);
215 }
216
217 static GstCaps *
218 gst_osssink_sink_fixate (GstPad *pad, const GstCaps *caps)
219 {
220   GstCaps *newcaps;
221   GstStructure *structure;
222
223   newcaps = gst_caps_new_full (gst_structure_copy(gst_caps_get_structure (caps, 0)), NULL);
224   structure = gst_caps_get_structure (newcaps, 0);
225
226   if (gst_caps_structure_fixate_field_nearest_int (structure, "rate", 44100)) {
227     return newcaps;
228   }
229   if (gst_caps_structure_fixate_field_nearest_int (structure, "depth", 16)) {
230     return newcaps;
231   }
232   if (gst_caps_structure_fixate_field_nearest_int (structure, "width", 16)) {
233     return newcaps;
234   }
235   if (gst_caps_structure_fixate_field_nearest_int (structure, "channels", 2)) {
236     return newcaps;
237   }
238
239   gst_caps_free (newcaps);
240
241   return NULL;
242 }
243
244 static GstPadLinkReturn 
245 gst_osssink_sinkconnect (GstPad *pad, const GstCaps *caps) 
246 {
247   GstOssSink *osssink = GST_OSSSINK (gst_pad_get_parent (pad));
248
249   if (!gst_osselement_parse_caps (GST_OSSELEMENT (osssink), caps))
250     return GST_PAD_LINK_REFUSED;
251
252   if (!gst_osselement_sync_parms (GST_OSSELEMENT (osssink))) {
253     return GST_PAD_LINK_REFUSED;
254   }
255
256   return GST_PAD_LINK_OK;
257 }
258
259 static inline gint64 
260 gst_osssink_get_delay (GstOssSink *osssink) 
261 {
262   gint delay = 0;
263
264   if (GST_OSSELEMENT (osssink)->fd == -1)
265     return 0;
266
267   if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETODELAY, &delay) < 0) {
268     audio_buf_info info;
269     if (ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_GETOSPACE, &info) < 0) {
270       delay = 0;
271     }
272     else {
273       delay = (info.fragstotal * info.fragsize) - info.bytes;     
274     }
275   }
276   return delay;
277 }
278
279 static GstClockTime 
280 gst_osssink_get_time (GstClock *clock, gpointer data) 
281 {
282   GstOssSink *osssink = GST_OSSSINK (data);
283   gint delay;
284   GstClockTime res;
285
286   if (!GST_OSSELEMENT (osssink)->bps)
287     return 0;
288
289   delay = gst_osssink_get_delay (osssink);
290
291   /* sometimes delay is bigger than the number of bytes sent to the device, 
292    * which screws up this calculation, we assume that everything is still 
293    * in the device then */
294   if (((guint64)delay) > osssink->handled) {
295     delay = osssink->handled;
296   }
297   res =  (osssink->handled - delay) * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
298
299   return res;
300 }
301
302 static GstClock*
303 gst_osssink_get_clock (GstElement *element)
304 {
305   GstOssSink *osssink;
306             
307   osssink = GST_OSSSINK (element);
308
309   return GST_CLOCK (osssink->provided_clock);
310 }
311
312 static void
313 gst_osssink_set_clock (GstElement *element, GstClock *clock)
314 {
315   GstOssSink *osssink;
316   
317   osssink = GST_OSSSINK (element);
318
319   osssink->clock = clock;  
320 }
321
322 static void 
323 gst_osssink_chain (GstPad *pad, GstData *_data) 
324 {
325   GstBuffer *buf = GST_BUFFER (_data);
326   GstOssSink *osssink;
327   GstClockTime buftime, elementtime, soundtime;
328   guchar *data;
329   guint to_write;
330
331   /* this has to be an audio buffer */
332   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
333
334   if (GST_IS_EVENT (buf)) {
335     GstEvent *event = GST_EVENT (buf);
336
337     switch (GST_EVENT_TYPE (event)) {
338       case GST_EVENT_EOS:
339         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_SYNC);
340         gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
341         gst_pad_event_default (pad, event);
342         return;
343       default:
344         gst_pad_event_default (pad, event);
345         return;
346     }
347     g_assert_not_reached ();
348   }
349
350   if (!GST_OSSELEMENT (osssink)->bps) {
351     gst_buffer_unref (buf);
352     gst_element_error (GST_ELEMENT (osssink), "capsnego was never performed, unknown data type");
353     return;
354   }
355
356   data = GST_BUFFER_DATA (buf);
357   to_write = GST_BUFFER_SIZE (buf);
358   /* sync audio with buffers timestamp */
359   elementtime = gst_element_get_time (GST_ELEMENT (osssink));
360   soundtime = elementtime + gst_osssink_get_delay (osssink) * GST_SECOND / GST_OSSELEMENT (osssink)->bps;
361   if (GST_BUFFER_TIMESTAMP_IS_VALID (buf)) {
362     buftime = GST_BUFFER_TIMESTAMP (buf);
363   } else {
364     buftime = soundtime;
365   }
366   GST_LOG_OBJECT (osssink, "time: element %"G_GUINT64_FORMAT", real %"G_GUINT64_FORMAT", buffer: %"G_GUINT64_FORMAT,
367       elementtime, soundtime, buftime);
368   if (MAX (buftime, soundtime) - MIN (buftime, soundtime) > GST_SECOND / 10) {
369     /* we need to adjust to the buffers here */
370     GST_INFO_OBJECT (osssink, "need sync: element %"G_GUINT64_FORMAT", real %"G_GUINT64_FORMAT", buffer: %"G_GUINT64_FORMAT, 
371         elementtime, soundtime, buftime);
372     if (soundtime > buftime) {
373       /* full frames */
374       guint throw_away = (soundtime - buftime) * GST_OSSELEMENT (osssink)->bps / GST_SECOND
375           / GST_OSSELEMENT (osssink)->width / GST_OSSELEMENT (osssink)->channels
376           * GST_OSSELEMENT (osssink)->width * GST_OSSELEMENT (osssink)->channels;
377       if (throw_away >= GST_BUFFER_SIZE (buf)) {
378         gst_data_unref (_data);
379         return;
380       }
381       to_write -= throw_away;
382       data += throw_away;
383     } else {
384       guint64 to_handle = (buftime - soundtime) * GST_OSSELEMENT (osssink)->bps / GST_SECOND
385                   / GST_OSSELEMENT (osssink)->width / GST_OSSELEMENT (osssink)->channels
386                   * GST_OSSELEMENT (osssink)->width * GST_OSSELEMENT (osssink)->channels;
387       /* FIXME: we really should output silence here */
388       /* round to full frames */
389       g_usleep (to_handle * G_USEC_PER_SEC / GST_OSSELEMENT (osssink)->bps);
390       osssink->handled += (buftime - soundtime) * GST_OSSELEMENT (osssink)->bps / GST_SECOND 
391           / GST_OSSELEMENT (osssink)->width / GST_OSSELEMENT (osssink)->channels
392           * GST_OSSELEMENT (osssink)->width * GST_OSSELEMENT (osssink)->channels;
393     }
394   }
395
396   if (GST_OSSELEMENT (osssink)->fd >= 0) {
397     if (!osssink->mute) {
398
399       while (to_write > 0) {
400         gint done = write (GST_OSSELEMENT (osssink)->fd, data, 
401                            MIN (to_write, osssink->chunk_size));
402
403         if (done == -1) {
404           if (errno != EINTR)
405             break;
406         }
407         else {
408           to_write -= done;
409           data += done;
410           osssink->handled += done;
411         }
412       }
413     } else {
414       g_warning ("muting osssinks unimplemented wrt clocks!");
415     }
416   }
417
418   gst_audio_clock_update_time ((GstAudioClock*)osssink->provided_clock, gst_osssink_get_time (osssink->provided_clock, osssink));
419
420   gst_buffer_unref (buf);
421 }
422
423 static const GstFormat*
424 gst_osssink_get_formats (GstPad *pad)
425 {
426   static const GstFormat formats[] = {
427     GST_FORMAT_TIME,
428     GST_FORMAT_DEFAULT,
429     GST_FORMAT_BYTES,
430     0
431   };
432   return formats;
433 }
434
435 static gboolean
436 gst_osssink_convert (GstPad *pad, GstFormat src_format, gint64 src_value,
437                      GstFormat *dest_format, gint64 *dest_value)
438 {
439   GstOssSink *osssink;
440
441   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
442   
443   return gst_osselement_convert (GST_OSSELEMENT (osssink),
444                                  src_format, src_value,
445                                  dest_format, dest_value);
446 }
447
448 static const GstQueryType*
449 gst_osssink_get_query_types (GstPad *pad)
450 {
451   static const GstQueryType query_types[] = {
452     GST_QUERY_LATENCY,
453     GST_QUERY_POSITION,
454     0,
455   };
456   return query_types;
457 }
458
459 static gboolean
460 gst_osssink_sink_query (GstPad *pad, GstQueryType type, GstFormat *format, gint64 *value) 
461 {
462   gboolean res = TRUE;
463   GstOssSink *osssink;
464
465   osssink = GST_OSSSINK (gst_pad_get_parent (pad));
466   
467   switch (type) {
468     case GST_QUERY_LATENCY:
469       if (!gst_osssink_convert (pad, 
470                                 GST_FORMAT_BYTES, gst_osssink_get_delay (osssink),
471                                 format, value)) 
472       {
473         res = FALSE;
474       }
475       break;
476     case GST_QUERY_POSITION:
477       if (!gst_osssink_convert (pad, 
478                                 GST_FORMAT_TIME, gst_clock_get_time (osssink->provided_clock),
479                                 format, value)) 
480       {
481         res = FALSE;
482       }
483       break;
484     default:
485       res = gst_pad_query (gst_pad_get_peer (osssink->sinkpad), type, format, value);
486       break;
487   }
488
489   return res;
490 }
491
492 static gboolean
493 gst_osssink_query (GstElement *element, GstQueryType type, GstFormat *format, gint64 *value) 
494 {
495   GstOssSink *osssink = GST_OSSSINK (element);
496
497   return gst_osssink_sink_query (osssink->sinkpad, type, format, value);
498 }
499
500 static void 
501 gst_osssink_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec) 
502 {
503   GstOssSink *osssink;
504
505   osssink = GST_OSSSINK (object);
506
507   switch (prop_id) {
508     case ARG_MUTE:
509       osssink->mute = g_value_get_boolean (value);
510       g_object_notify (G_OBJECT (osssink), "mute");
511       break;
512     case ARG_FRAGMENT:
513       GST_OSSELEMENT (osssink)->fragment = g_value_get_int (value);
514       gst_osselement_sync_parms (GST_OSSELEMENT (osssink));
515       break;
516     case ARG_BUFFER_SIZE:
517       osssink->bufsize = g_value_get_uint (value);
518       g_object_notify (object, "buffer_size");
519       break;
520     case ARG_SYNC:
521       osssink->sync = g_value_get_boolean (value);
522       g_object_notify (G_OBJECT (osssink), "sync");
523       break;
524     case ARG_CHUNK_SIZE:
525       osssink->chunk_size = g_value_get_uint (value);
526       break;
527     default:
528       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
529       break;
530   }
531 }
532
533 static void 
534 gst_osssink_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec) 
535 {
536   GstOssSink *osssink;
537
538   osssink = GST_OSSSINK (object);
539
540   switch (prop_id) {
541     case ARG_MUTE:
542       g_value_set_boolean (value, osssink->mute);
543       break;
544     case ARG_FRAGMENT:
545       g_value_set_int (value, GST_OSSELEMENT (osssink)->fragment);
546       break;
547     case ARG_BUFFER_SIZE:
548       g_value_set_uint (value, osssink->bufsize);
549       break;
550     case ARG_SYNC:
551       g_value_set_boolean (value, osssink->sync);
552       break;
553     case ARG_CHUNK_SIZE:
554       g_value_set_uint (value, osssink->chunk_size);
555       break;
556     default:
557       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
558       break;
559   }
560 }
561
562 static GstElementStateReturn 
563 gst_osssink_change_state (GstElement *element) 
564 {
565   GstOssSink *osssink;
566
567   osssink = GST_OSSSINK (element);
568
569   switch (GST_STATE_TRANSITION (element)) {
570     case GST_STATE_READY_TO_PAUSED:
571       break;
572     case GST_STATE_PAUSED_TO_PLAYING:
573       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), TRUE);
574       break;
575     case GST_STATE_PLAYING_TO_PAUSED:
576       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN)) 
577         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
578       gst_audio_clock_set_active (GST_AUDIO_CLOCK (osssink->provided_clock), FALSE);
579       break;
580     case GST_STATE_PAUSED_TO_READY:
581       if (GST_FLAG_IS_SET (element, GST_OSSSINK_OPEN))
582         ioctl (GST_OSSELEMENT (osssink)->fd, SNDCTL_DSP_RESET, 0);
583       gst_osselement_reset (GST_OSSELEMENT (osssink));
584       break;
585     default:
586       break;
587   }
588       
589   if (GST_ELEMENT_CLASS (parent_class)->change_state)
590     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
591
592   return GST_STATE_SUCCESS;
593 }