git.gag.com Git - debian/gnuradio/blob - gnuradio-core/src/lib/io/gr_file_sink.h

   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_SINK_H
  24 #define INCLUDED_GR_FILE_SINK_H
  25
  26 #include <gr_sync_block.h>
  27 #include <omnithread.h>
  28
  29 class gr_file_sink;
  30 typedef boost::shared_ptr<gr_file_sink> gr_file_sink_sptr;
  31
  32 gr_file_sink_sptr gr_make_file_sink(size_t itemsize, const char *filename);
  33
  34 /*!
  35  * \brief Write stream to file.
  36  * \ingroup sink
  37  */
  38
  39 class gr_file_sink : public gr_sync_block
  40 {
  41   friend gr_file_sink_sptr gr_make_file_sink(size_t itemsize, const char *filename);
  42
  43  private:
  44   size_t        d_itemsize;
  45   void         *d_fp;           // current FILE pointer
  46   void         *d_new_fp;       // new FILE pointer
  47   bool          d_updated;      // is there a new FILE pointer?
  48   omni_mutex    d_mutex;
  49
  50  protected:
  51   gr_file_sink(size_t itemsize, const char *filename);
  52
  53  public:
  54   ~gr_file_sink();
  55
  56   /*!
  57    * \brief Open filename and begin output to it.
  58    */
  59   bool open(const char *filename);
  60
  61   /*!
  62    * \brief Close current output file.
  63    *
  64    * Closes current output file and ignores any output until
  65    * open is called to connect to another file.
  66    */
  67   void close();
  68
  69   int work(int noutput_items,
  70            gr_vector_const_void_star &input_items,
  71            gr_vector_void_star &output_items);
  72 };
  73
  74
  75 #endif /* INCLUDED_GR_FILE_SINK_H */