GNU Radio 3.7.0-50 C++ API
file_source.h
Go to the documentation of this file.
1
/* -*- c++ -*- */
2
/*
3
* Copyright 2012 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_BLOCKS_FILE_SOURCE_H
24
#define INCLUDED_BLOCKS_FILE_SOURCE_H
25
26
#include <
gnuradio/blocks/api.h
>
27
#include <
gnuradio/sync_block.h
>
28
29
namespace
gr {
30
namespace
blocks {
31
32
/*!
33
* \brief Read stream from file
34
* \ingroup file_operators_blk
35
*/
36
class
BLOCKS_API
file_source
:
virtual
public
sync_block
37
{
38
public
:
39
40
// gr::blocks::file_source::sptr
41
typedef
boost::shared_ptr<file_source>
sptr
;
42
43
/*!
44
* \brief Create a file source.
45
*
46
* Opens \p filename as a source of items into a flowgraph. The
47
* data is expected to be in binary format, item after item. The
48
* \p itemsize of the block determines the conversion from bits
49
* to items.
50
*
51
* If \p repeat is turned on, the file will repeat the file after
52
* it's reached the end.
53
*
54
* \param itemsize the size of each item in the file, in bytes
55
* \param filename name of the file to source from
56
* \param repeat repeat file from start
57
*/
58
static
sptr
make(
size_t
itemsize
,
const
char
*filename,
bool
repeat
=
false
);
59
60
/*!
61
* \brief seek file to \p seek_point relative to \p whence
62
*
63
* \param seek_point sample offset in file
64
* \param whence one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek)
65
*/
66
virtual
bool
seek(
long
seek_point,
int
whence) = 0;
67
68
/*!
69
* \brief Opens a new file.
70
*
71
* \param filename name of the file to source from
72
* \param repeat repeat file from start
73
*/
74
virtual
void
open(
const
char
*filename,
bool
repeat
) = 0;
75
76
/*!
77
* \brief Close the file handle.
78
*/
79
virtual
void
close() = 0;
80
};
81
82
}
/* namespace blocks */
83
}
/* namespace gr */
84
85
#endif
/* INCLUDED_BLOCKS_FILE_SOURCE_H */
gnuradio
gr-blocks
include
gnuradio
blocks
file_source.h
Generated by
1.8.1.1