GNU Radio 3.6.5 C++ API

file_source.h

Go to the documentation of this file.
00001 /* -*- c++ -*- */
00002 /*
00003  * Copyright 2012 Free Software Foundation, Inc.
00004  *
00005  * This file is part of GNU Radio
00006  *
00007  * GNU Radio is free software; you can redistribute it and/or modify
00008  * it under the terms of the GNU General Public License as published by
00009  * the Free Software Foundation; either version 3, or (at your option)
00010  * any later version.
00011  *
00012  * GNU Radio is distributed in the hope that it will be useful,
00013  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00014  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00015  * GNU General Public License for more details.
00016  *
00017  * You should have received a copy of the GNU General Public License
00018  * along with GNU Radio; see the file COPYING.  If not, write to
00019  * the Free Software Foundation, Inc., 51 Franklin Street,
00020  * Boston, MA 02110-1301, USA.
00021  */
00022 
00023 #ifndef INCLUDED_BLOCKS_FILE_SOURCE_H
00024 #define INCLUDED_BLOCKS_FILE_SOURCE_H
00025 
00026 #include <blocks/api.h>
00027 #include <gr_sync_block.h>
00028 
00029 namespace gr {
00030   namespace blocks {
00031 
00032     /*!
00033      * \brief Read stream from file
00034      * \ingroup file_operators_blk
00035      */
00036     class BLOCKS_API file_source : virtual public gr_sync_block
00037     {
00038     public:
00039 
00040       // gr::blocks::file_source::sptr
00041       typedef boost::shared_ptr<file_source> sptr;
00042 
00043       /*!
00044        * \brief Create a file source.
00045        *
00046        * Opens \p filename as a source of items into a flowgraph. The
00047        * data is expected to be in binary format, item after item. The
00048        * \p itemsize of the block determines the conversion from bits
00049        * to items.
00050        *
00051        * If \p repeat is turned on, the file will repeat the file after
00052        * it's reached the end.
00053        *
00054        * \param itemsize        the size of each item in the file, in bytes
00055        * \param filename        name of the file to source from
00056        * \param repeat  repeat file from start
00057        */
00058       static sptr make(size_t itemsize, const char *filename, bool repeat = false);
00059 
00060       /*!
00061        * \brief seek file to \p seek_point relative to \p whence
00062        *
00063        * \param seek_point      sample offset in file
00064        * \param whence  one of SEEK_SET, SEEK_CUR, SEEK_END (man fseek)
00065        */
00066       virtual bool seek(long seek_point, int whence) = 0;
00067 
00068       /*!
00069        * \brief Opens a new file.
00070        *
00071        * \param filename        name of the file to source from
00072        * \param repeat  repeat file from start
00073        */
00074       virtual void open(const char *filename, bool repeat) = 0;
00075 
00076       /*!
00077        * \brief Close the file handle.
00078        */
00079       virtual void close() = 0;
00080     };
00081 
00082   } /* namespace blocks */
00083 } /* namespace gr */
00084 
00085 #endif /* INCLUDED_BLOCKS_FILE_SOURCE_H */