1 /* GStreamer Tuner 2 * Copyright (C) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net> 3 * 4 * tunerchannel.h: tuner channel object design 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_TUNER_CHANNEL_H__ 23 #define __GST_TUNER_CHANNEL_H__ 24 25 #include <gst/gst.h> 26 27 G_BEGIN_DECLS 28 29 #define GST_TYPE_TUNER_CHANNEL \ 30 (gst_tuner_channel_get_type ()) 31 #define GST_TUNER_CHANNEL(obj) \ 32 (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_TUNER_CHANNEL, \ 33 GstTunerChannel)) 34 #define GST_TUNER_CHANNEL_CLASS(klass) \ 35 (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_TUNER_CHANNEL, \ 36 GstTunerChannelClass)) 37 #define GST_IS_TUNER_CHANNEL(obj) \ 38 (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_TUNER_CHANNEL)) 39 #define GST_IS_TUNER_CHANNEL_CLASS(klass) \ 40 (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_TUNER_CHANNEL)) 41 42 typedef struct _GstTunerChannel GstTunerChannel; 43 typedef struct _GstTunerChannelClass GstTunerChannelClass; 44 45 /** 46 * GstTunerChannelFlags: 47 * @GST_TUNER_CHANNEL_INPUT: The channel is for input 48 * @GST_TUNER_CHANNEL_OUTPUT: The channel is for output 49 * @GST_TUNER_CHANNEL_FREQUENCY: The channel has a frequency setting 50 * and signal strength. 51 * @GST_TUNER_CHANNEL_AUDIO: The channel carries audio. 52 * 53 * An enumeration for flags indicating the available capabilities 54 * of a #GstTunerChannel. 55 */ 56 typedef enum { 57 GST_TUNER_CHANNEL_INPUT = (1<<0), 58 GST_TUNER_CHANNEL_OUTPUT = (1<<1), 59 GST_TUNER_CHANNEL_FREQUENCY = (1<<2), 60 GST_TUNER_CHANNEL_AUDIO = (1<<3) 61 } GstTunerChannelFlags; 62 63 /** 64 * GST_TUNER_CHANNEL_HAS_FLAG: 65 * @channel: A #GstTunerChannel 66 * @flag: The flag to check for 67 * 68 * Macro to check if the given flag is set on a channel 69 */ 70 #define GST_TUNER_CHANNEL_HAS_FLAG(channel, flag) \ 71 ((channel)->flags & flag) 72 73 /** 74 * GstTunerChannel: 75 * @label: A string containing a descriptive name for this channel 76 * @flags: A set of #GstTunerChannelFlags for this channel 77 * @freq_multiplicator: The step size (in Hz) for the frequency setting. 78 * @min_frequency: Minimum valid frequency setting (in Hz). 79 * @max_frequency: Maximum valid frequency setting (in Hz). 80 * @min_signal: Minimum reported signal strength value. 81 * @max_signal: Maximum reported signal strength value. 82 */ 83 struct _GstTunerChannel { 84 GObject parent; 85 86 /*< public >*/ 87 gchar *label; 88 GstTunerChannelFlags flags; 89 gfloat freq_multiplicator; 90 gulong min_frequency; 91 gulong max_frequency; 92 gint min_signal; 93 gint max_signal; 94 95 /*< private >*/ 96 gpointer _gst_reserved[GST_PADDING]; 97 }; 98 99 struct _GstTunerChannelClass { 100 GObjectClass parent; 101 102 /*< private >*/ 103 /* signals */ 104 void (*frequency_changed) (GstTunerChannel *channel, 105 gulong frequency); 106 void (*signal_changed) (GstTunerChannel *channel, 107 gint signal); 108 109 gpointer _gst_reserved[GST_PADDING]; 110 }; 111 112 GType gst_tuner_channel_get_type (void); 113 114 G_END_DECLS 115 116 #endif /* __GST_TUNER_CHANNEL_H__ */ 117