Merge remote-tracking branch 'remotes/origin/upstream/1.6' into tizen
[platform/upstream/gst-plugins-good.git] / ext / jack / gstjack.h
1 /* GStreamer
2  * Copyright (C) 2006 Wim Taymans <wim@fluendo.com>
3  *
4  * gstjack.h:
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 #ifndef _GST_JACK_H_
23 #define _GST_JACK_H_
24
25 #include <jack/jack.h>
26 #include <gst/audio/audio.h>
27
28 /**
29  * GstJackConnect:
30  * @GST_JACK_CONNECT_NONE: Don't automatically connect to physical ports.
31  *     In this mode, the element will accept any number of input channels and will
32  *     create (but not connect) an output port for each channel.
33  * @GST_JACK_CONNECT_AUTO: In this mode, the element will try to connect each
34  *     output port to a random physical jack input pin. The sink will
35  *     expose the number of physical channels on its pad caps.
36  * @GST_JACK_CONNECT_AUTO_FORCED: In this mode, the element will try to connect each
37  *     output port to a random physical jack input pin. The  element will accept any number
38  *     of input channels.
39  *
40  * Specify how the output ports will be connected.
41  */
42 typedef enum {
43   GST_JACK_CONNECT_NONE,
44   GST_JACK_CONNECT_AUTO,
45   GST_JACK_CONNECT_AUTO_FORCED
46 } GstJackConnect;
47
48 /**
49  * GstJackTransport:
50  * @GST_JACK_TRANSPORT_AUTONOMOUS: no transport support
51  * @GST_JACK_TRANSPORT_MASTER: start and stop transport with state-changes
52  * @GST_JACK_TRANSPORT_SLAVE: follow transport state changes
53  *
54  * The jack transport state allow to sync multiple clients. This enum defines a
55  * client behaviour regarding to the transport mechanism.
56  */
57 typedef enum {
58   GST_JACK_TRANSPORT_AUTONOMOUS = 0,
59   GST_JACK_TRANSPORT_MASTER = (1 << 0),
60   GST_JACK_TRANSPORT_SLAVE = (1 << 1),
61 } GstJackTransport;
62
63 typedef jack_default_audio_sample_t sample_t;
64
65 #define GST_TYPE_JACK_CONNECT   (gst_jack_connect_get_type ())
66 #define GST_TYPE_JACK_TRANSPORT (gst_jack_transport_get_type ())
67 #define GST_TYPE_JACK_CLIENT    (gst_jack_client_get_type ())
68
69 #if G_BYTE_ORDER == G_LITTLE_ENDIAN
70 #define GST_JACK_FORMAT_STR "F32LE"
71 #else
72 #define GST_JACK_FORMAT_STR "F32BE"
73 #endif
74
75 GType gst_jack_client_get_type(void);
76 GType gst_jack_connect_get_type(void);
77 GType gst_jack_transport_get_type(void);
78
79 #endif  // _GST_JACK_H_