Credit Andrew - improve in-tree documentation
[goodguy/cinelerra.git] / cinelerra / channel.h
1
2 /*
3  * CINELERRA
4  * Copyright (C) 2008 Adam Williams <broadcast at earthling dot net>
5  *
6  * This program is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21
22 #ifndef CHANNEL_H
23 #define CHANNEL_H
24
25 #include "bcwindowbase.inc"
26 #include "bchash.inc"
27 #include "filexml.inc"
28
29 // Used by both GUI to change channels and devices to map channels to
30 // device parameters.
31
32 class Channel
33 {
34 public:
35         Channel();
36         Channel(Channel *channel);
37         ~Channel();
38
39         void reset();
40         void dump();
41         Channel& operator=(Channel &channel);
42         bool operator==(Channel &channel);
43         bool operator!=(Channel &channel);
44 // Copy channel location only
45         void copy_settings(Channel *channel);
46 // Copy what parameters the tuner device supports only
47         void copy_usage(Channel *channel);
48         int load(FileXML *file);
49         void save(FileXML *file);
50 // Store the location of the channels to scan.
51 // Only used for channel scanning
52         void load_defaults(BC_Hash *defaults);
53         void save_defaults(BC_Hash *defaults);
54         int cstrcmp(const char *name);
55
56
57 // Flags for GUI settings the device uses
58         int use_frequency;
59         int use_fine;
60         int use_norm;
61         int use_input;
62 // Device supports scanning
63         int has_scanning;
64         int has_subchan;
65
66
67
68 // User supplied name
69         char title[BCTEXTLEN];
70 // Name given by device for the channel
71         char device_name[BCTEXTLEN];
72
73
74
75
76 // Number of the table entry in the appropriate freqtable
77 // or channel number.
78         int entry;
79         int element;
80 // Table to use
81         int freqtable;
82 // Fine tuning offset
83         int fine_tune;
84 // Input source
85         int input;
86         int norm;
87 // Index used by the device
88         int device_index;
89 // Tuner number used by the device
90         int tuner;
91 // stream to capture for digital TV
92         int audio_stream;
93         int video_stream;
94 // PID's to capture for digital TV
95         int audio_pid;
96         int video_pid;
97 };
98
99
100 #endif