usound.hh

Go to the documentation of this file.

/*
 * Copyright (C) 2007-2011, Gostai S.A.S.
 *
 * This software is provided "as is" without warranty of any kind,
 * either expressed or implied, including but not limited to the
 * implied warranties of fitness for a particular purpose.
 *
 * See the LICENSE file for more information.
 */

#ifndef URBI_USOUND_HH
# define URBI_USOUND_HH

# include <iosfwd>

# include <urbi/export.hh>

namespace urbi
{

  /*---------------.
  | USoundFormat.  |
  `---------------*/
  enum USoundFormat
  {
    SOUND_RAW = 0,
    SOUND_WAV = 1,
    SOUND_MP3 = 2,
    SOUND_OGG = 3,
    SOUND_UNKNOWN = 4,
  };

  URBI_SDK_API USoundFormat parse_sound_format(const std::string&);

  URBI_SDK_API const char* format_string(USoundFormat f);


  /*---------------------.
  | USoundSampleFormat.  |
  `---------------------*/
  enum USoundSampleFormat
  {
    SAMPLE_SIGNED = 1,
    SAMPLE_UNSIGNED = 2,
    SAMPLE_FLOAT = 3,
  };

  std::istream& operator>> (std::istream& is, USoundSampleFormat& f);


  /*---------.
  | USound.  |
  `---------*/

  class URBI_SDK_API USound
  {
  public:
    static USound make();

    void init();

    const char* format_string() const;

    bool operator==(const USound &b) const;

    // For debugging.
    std::ostream& dump(std::ostream& o) const;

    char* data;
    size_t size;
    size_t channels;
    size_t rate;
    size_t sampleSize;

    USoundFormat soundFormat;

    USoundSampleFormat sampleFormat;

  private:
    friend class UBinary;
    // The UBinary headers.
    std::string headers_() const;
  };

  // Bounce to USound::dump.
  std::ostream& operator<< (std::ostream& o, const USound& s);


} // end namespace urbi

#endif // ! URBI_USOUND_HH