libs/audiographer/audiographer/broadcast_info.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 #ifndef AUDIOGRAPHER_BROADCAST_INFO_H
  22 #define AUDIOGRAPHER_BROADCAST_INFO_H
  23
  24 #include <string>
  25 #include <ctime>
  26
  27 #include <sndfile.h>
  28
  29 #include "audiographer/visibility.h"
  30
  31 namespace AudioGrapher
  32 {
  33
  34 class LIBAUDIOGRAPHER_API SndfileHandle;
  35
  36 class LIBAUDIOGRAPHER_API BroadcastInfo
  37 {
  38   public:
  39
  40         /// Construct empty broadcast info
  41         BroadcastInfo ();
  42         virtual ~BroadcastInfo ();
  43
  44         /// Returns last error sring from libsndfile
  45         std::string get_error () const { return error; }
  46
  47         /* Reading */
  48
  49         bool load_from_file (std::string const & filename);
  50         bool load_from_file (SNDFILE* sf);
  51
  52         std::string get_description () const;
  53         int64_t get_time_reference () const;
  54         struct tm get_origination_time () const;
  55         std::string get_originator () const;
  56         std::string get_originator_ref () const;
  57
  58         /* Writing */
  59
  60         bool write_to_file (std::string const & filename);
  61         bool write_to_file (SNDFILE* sf);
  62         bool write_to_file (SndfileHandle* sf);
  63
  64         void set_description (std::string const & desc);
  65         void set_time_reference (int64_t when);
  66         void set_origination_time (struct tm * now = 0); // if 0, use time generated at construction
  67         virtual void set_originator (std::string const & str = "");
  68         void set_originator_ref (std::string const & str = "");
  69
  70         /* State info */
  71
  72         /// Returns true if a info has been succesfully loaded or anything has been manually set
  73         bool has_info () const { return _has_info; }
  74
  75 protected:
  76
  77         SF_BROADCAST_INFO * info;
  78         struct tm _time;
  79
  80         void update_error ();
  81         std::string error;
  82
  83         bool _has_info;
  84 };
  85
  86 } // namespace AudioGrapher
  87
  88 #endif /* AUDIOGRAPHER_BROADCAST_INFO_H */