ext/jack/gstjackringbuffer.h

   1 /*
   2  * GStreamer
   3  * Copyright (C) 2006 Wim Taymans <wim@fluendo.com>
   4  * Copyright (C) 2008 Tristan Matthews <tristan@sat.qc.ca>
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included in
  14  * all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  19  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  21  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  22  * DEALINGS IN THE SOFTWARE.
  23  *
  24  * Alternatively, the contents of this file may be used under the
  25  * GNU Lesser General Public License Version 2.1 (the "LGPL"), in
  26  * which case the following provisions apply instead of the ones
  27  * mentioned above:
  28  *
  29  * This library is free software; you can redistribute it and/or
  30  * modify it under the terms of the GNU Library General Public
  31  * License as published by the Free Software Foundation; either
  32  * version 2 of the License, or (at your option) any later version.
  33  *
  34  * This library is distributed in the hope that it will be useful,
  35  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  36  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  37  * Library General Public License for more details.
  38  *
  39  * You should have received a copy of the GNU Library General Public
  40  * License along with this library; if not, write to the
  41  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  42  * Boston, MA 02111-1307, USA.
  43  */
  44
  45 #ifndef __GST_JACK_RING_BUFFER_H__
  46 #define __GST_JACK_RING_BUFFER_H__
  47
  48 #define GST_TYPE_JACK_RING_BUFFER               (gst_jack_ring_buffer_get_type())
  49 #define GST_JACK_RING_BUFFER(obj)               (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_JACK_RING_BUFFER,GstJackRingBuffer))
  50 #define GST_JACK_RING_BUFFER_CLASS(klass)       (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_JACK_RING_BUFFER,GstJackRingBufferClass))
  51 #define GST_JACK_RING_BUFFER_GET_CLASS(obj)     (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_JACK_RING_BUFFER,GstJackRingBufferClass))
  52 #define GST_JACK_RING_BUFFER_CAST(obj)          ((GstJackRingBuffer *)obj)
  53 #define GST_IS_JACK_RING_BUFFER(obj)            (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_JACK_RING_BUFFER))
  54 #define GST_IS_JACK_RING_BUFFER_CLASS(klass)    (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_JACK_RING_BUFFER))
  55
  56 typedef struct _GstJackRingBuffer GstJackRingBuffer;
  57 typedef struct _GstJackRingBufferClass GstJackRingBufferClass;
  58
  59 struct _GstJackRingBuffer
  60 {
  61   GstRingBuffer object;
  62
  63   gint sample_rate;
  64   gint buffer_size;
  65   gint channels;
  66 };
  67
  68 struct _GstJackRingBufferClass
  69 {
  70   GstRingBufferClass parent_class;
  71 };
  72
  73 static void gst_jack_ring_buffer_class_init(GstJackRingBufferClass * klass);
  74 static void gst_jack_ring_buffer_init(GstJackRingBuffer * ringbuffer,
  75     GstJackRingBufferClass * klass);
  76
  77 static GstRingBufferClass *ring_parent_class = NULL;
  78
  79 static gboolean gst_jack_ring_buffer_open_device(GstRingBuffer * buf);
  80 static gboolean gst_jack_ring_buffer_close_device(GstRingBuffer * buf);
  81 static gboolean gst_jack_ring_buffer_acquire(GstRingBuffer * buf,GstRingBufferSpec * spec);
  82 static gboolean gst_jack_ring_buffer_release(GstRingBuffer * buf);
  83 static gboolean gst_jack_ring_buffer_start(GstRingBuffer * buf);
  84 static gboolean gst_jack_ring_buffer_pause(GstRingBuffer * buf);
  85 static gboolean gst_jack_ring_buffer_stop(GstRingBuffer * buf);
  86 static guint gst_jack_ring_buffer_delay(GstRingBuffer * buf);
  87
  88 #endif