GNU Radio 3.6.5.1 C++ API
gr_file_source.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * GNU Radio 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, or (at your option)
10  * any later version.
11  *
12  * GNU Radio 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 GNU Radio; see the file COPYING. If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street,
20  * Boston, MA 02110-1301, USA.
21  */
22 
23 #ifndef INCLUDED_GR_FILE_SOURCE_H
24 #define INCLUDED_GR_FILE_SOURCE_H
25 
26 #include <gr_core_api.h>
27 #include <gr_sync_block.h>
28 #include <boost/thread/mutex.hpp>
29 
30 class gr_file_source;
32 
34 gr_make_file_source (size_t itemsize, const char *filename, bool repeat = false);
35 
36 /*!
37  * \brief Read stream from file
38  * \ingroup source_blk
39  */
40 
42 {
43  private:
44  size_t d_itemsize;
45  FILE *d_fp;
46  FILE *d_new_fp;
47  bool d_repeat;
48  bool d_updated;
49 
50  protected:
51  gr_file_source(size_t itemsize, const char *filename, bool repeat);
52 
53  void do_update();
54 
56 
57  public:
58  /*!
59  * \brief Create a file source.
60  *
61  * Opens \p filename as a source of items into a flowgraph. The data
62  * is expected to be in binary format, item after item. The \p
63  * itemsize of the block determines the conversion from bits to
64  * items.
65  *
66  * If \p repeat is turned on, the file will repeat the file after
67  * it's reached the end.
68  *
69  * \param itemsize the size of each item in the file, in bytes
70  * \param filename name of the file to source from
71  * \param repeat repeat file from start
72  */
74  gr_make_file_source(size_t itemsize,
75  const char *filename,
76  bool repeat);
77 
78  ~gr_file_source();
79 
80  int work(int noutput_items,
81  gr_vector_const_void_star &input_items,
82  gr_vector_void_star &output_items);
83 
84  /*!
85  * \brief Seek file to \p seek_point relative to \p whence
86  *
87  * \param seek_point sample offset in file
88  * \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek)
89  */
90  bool seek(long seek_point, int whence);
91 
92  /*!
93  * \brief Opens a new file.
94  *
95  * \param filename name of the file to source from
96  * \param repeat repeat file from start
97  */
98  void open(const char *filename, bool repeat);
99 
100  /*!
101  * \brief Close the file handle.
102  */
103  void close();
104 
105 };
106 
107 #endif /* INCLUDED_GR_FILE_SOURCE_H */