GNU Radio's SATNOGS Package
ogg_source.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2017, Libre Space Foundation <http://librespacefoundation.org/>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program 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
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATNOGS_OGG_SOURCE_H
22 #define INCLUDED_SATNOGS_OGG_SOURCE_H
23 
24 #include <satnogs/api.h>
25 #include <gnuradio/sync_block.h>
26 
27 namespace gr {
28 namespace satnogs {
29 
30 /*!
31  * \brief OGG source block. Reads a file with an OGG audio and
32  * convert it to float samples
33  *
34  * \ingroup satnogs
35  *
36  */
37 class SATNOGS_API ogg_source : virtual public gr::sync_block {
38 public:
39  typedef boost::shared_ptr<ogg_source> sptr;
40 
41  /*!
42  *
43  * @param filename the OGG audio file path
44  * @param channels number of channels of the OGG stream.
45  * If the actual OGG stream contains a different number of channels
46  * than specified an exception is raised
47  * @param repeat if set to true, when EOF is reached the block
48  * will continue to output samples from the beginning of the OGG file.
49  */
50  static sptr
51  make(const std::string &filename, int channels = 1,
52  bool repeat = false);
53 };
54 
55 } // namespace satnogs
56 } // namespace gr
57 
58 #endif /* INCLUDED_SATNOGS_OGG_SOURCE_H */
59 
OGG source block. Reads a file with an OGG audio and convert it to float samples. ...
Definition: ogg_source.h:37
Definition: amsat_duv_decoder.h:29
boost::shared_ptr< ogg_source > sptr
Definition: ogg_source.h:39
#define SATNOGS_API
Definition: api.h:30