audiographer/audiographer/broadcast_info.h

Go to the documentation of this file.

/*
 * Copyright (C) 2008 Sakari Bergen <sakari.bergen@beatwaves.net>
 * Copyright (C) 2013-2014 Paul Davis <paul@linuxaudiosystems.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 
#ifndef AUDIOGRAPHER_BROADCAST_INFO_H
#define AUDIOGRAPHER_BROADCAST_INFO_H
 
#include <stdint.h>
 
#include <string>
#include <ctime>
 
#include <sndfile.h>
 
#include "audiographer/visibility.h"
 
namespace AudioGrapher
{
 
class SndfileHandle;
 
class LIBAUDIOGRAPHER_API BroadcastInfo
{
  public:
 
        BroadcastInfo ();
        virtual ~BroadcastInfo ();
 
        std::string get_error () const { return error; }
 
        /* Reading */
 
        bool load_from_file (std::string const & filename);
        bool load_from_file (SNDFILE* sf);
 
        std::string get_description () const;
        int64_t get_time_reference () const;
        struct tm get_origination_time () const;
        std::string get_originator () const;
        std::string get_originator_ref () const;
 
        /* Writing */
 
        bool write_to_file (std::string const & filename);
        bool write_to_file (SNDFILE* sf);
        bool write_to_file (SndfileHandle* sf);
 
        void set_description (std::string const & desc);
        void set_time_reference (int64_t when);
        void set_origination_time (struct tm * now = 0); // if 0, use time generated at construction
        virtual void set_originator (std::string const & str = "");
        void set_originator_ref (std::string const & str = "");
 
        /* State info */
 
        bool has_info () const { return _has_info; }
 
protected:
 
        SF_BROADCAST_INFO * info;
        struct tm _time;
 
        void update_error ();
        std::string error;
 
        bool _has_info;
};
 
} // namespace AudioGrapher
 
#endif /* AUDIOGRAPHER_BROADCAST_INFO_H */