lv_songinfo.h

/* Libvisual - The audio visualisation framework.
 *
 * Copyright (C) 2012      Libvisual team
 *               2004-2006 Dennis Smit
 *
 * Authors: Chong Kai Xiong <kaixiong@codeleft.sg>
 *          Dennis Smit <ds@nerds-incorporated.org>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1
 * 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 */

#ifndef _LV_SONGINFO_H
#define _LV_SONGINFO_H

#include <libvisual/lv_types.h>
#include <libvisual/lv_time.h>
#include <libvisual/lv_video.h>

typedef enum {
    VISUAL_SONGINFO_TYPE_NULL,      
    VISUAL_SONGINFO_TYPE_SIMPLE,    
    VISUAL_SONGINFO_TYPE_ADVANCED   
} VisSongInfoType;


#ifdef __cplusplus

#include <string>

namespace LV {

  enum SongInfoType
  {
      SONG_INFO_TYPE_NULL     = ::VISUAL_SONGINFO_TYPE_NULL,
      SONG_INFO_TYPE_SIMPLE   = ::VISUAL_SONGINFO_TYPE_SIMPLE,
      SONG_INFO_TYPE_ADVANCED = ::VISUAL_SONGINFO_TYPE_ADVANCED
  };

  class LV_API SongInfo
  {
  public:

      explicit SongInfo (SongInfoType type);

      ~SongInfo ();

      friend bool operator== (SongInfo const& lhs, SongInfo const& rhs);

      // FIXME: Type should only be set at creation time. Ideally we
      // should be able prevent accidental access to invalid fields.
      void set_type (SongInfoType type);

      SongInfoType get_type () const;

      void set_simple_name (std::string const& name);

      std::string get_simple_name () const;

      void set_length (int length);

      int get_length () const;

      void set_elapsed (int elapsed);

      int get_elapsed () const;

      void set_artist (std::string const& artist);

      std::string get_artist () const;

      void set_album (std::string const& album);

      std::string get_album () const;

      void set_song (std::string const& name);

      std::string get_song () const;

      void set_cover (VideoPtr const& cover);

      VideoPtr get_cover () const;

      void mark ();

      long get_age (); // FIXME: should be const

  private:

      SongInfoType m_type;
      int          m_length;
      int          m_elapsed;
      std::string  m_song_name;
      std::string  m_artist;
      std::string  m_album;
      std::string  m_song;
      Timer        m_timer;
      VideoPtr     m_cover;
  };

} // LV namespace

#endif /* __cplusplus */

#ifdef __cplusplus
typedef ::LV::SongInfo VisSongInfo;
#else
typedef struct _VisSongInfo VisSongInfo;
struct _VisSongInfo;
#endif

LV_BEGIN_DECLS

LV_API VisSongInfo *visual_songinfo_new   (VisSongInfoType type);
LV_API VisSongInfo *visual_songinfo_clone (VisSongInfo *src);
LV_API void         visual_songinfo_free  (VisSongInfo *songinfo);

LV_API void visual_songinfo_copy    (VisSongInfo *dest, VisSongInfo const *src);
LV_API int  visual_songinfo_compare (VisSongInfo const *s1, VisSongInfo const *s2);

LV_API void            visual_songinfo_set_type (VisSongInfo *songinfo, VisSongInfoType type);
LV_API VisSongInfoType visual_songinfo_get_type (VisSongInfo *songinfo);

LV_API void visual_songinfo_set_length (VisSongInfo *songinfo, int length);
LV_API int  visual_songinfo_get_length (VisSongInfo *songinfo);

LV_API void visual_songinfo_set_elapsed (VisSongInfo *songinfo, int elapsed);
LV_API int  visual_songinfo_get_elapsed (VisSongInfo *songinfo);

LV_API void        visual_songinfo_set_simple_name (VisSongInfo *songinfo, const char *name);
LV_API const char *visual_songinfo_get_simple_name (VisSongInfo *songinfo);

LV_API void        visual_songinfo_set_artist (VisSongInfo *songinfo, const char *artist);
LV_API const char *visual_songinfo_get_artist (VisSongInfo *songinfo);

LV_API void        visual_songinfo_set_album (VisSongInfo *songinfo, const char *album);
LV_API const char *visual_songinfo_get_album (VisSongInfo *songinfo);

LV_API void        visual_songinfo_set_song (VisSongInfo *songinfo, const char *song);
LV_API const char *visual_songinfo_get_song (VisSongInfo *songinfo);

LV_API void        visual_songinfo_set_cover (VisSongInfo *songinfo, VisVideo *cover);
LV_API VisVideo   *visual_songinfo_get_cover (VisSongInfo *songinfo);

LV_API void visual_songinfo_mark (VisSongInfo *songinfo);

LV_API long visual_songinfo_get_age (VisSongInfo *songinfo);

LV_END_DECLS

#endif /* _LV_SONGINFO_H */