okular/core/sound.h

   1 /***************************************************************************
   2  *   Copyright (C) 2006 by Pino Toscano <pino@kde.org>                     *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  ***************************************************************************/
   9
  10 #ifndef _OKULAR_SOUND_H_
  11 #define _OKULAR_SOUND_H_
  12
  13 #include <okular/core/okular_export.h>
  14
  15 #include <QtCore/QByteArray>
  16 #include <QtCore/QString>
  17
  18 namespace Okular {
  19
  20 /**
  21  * @short Contains information about a sound object.
  22  *
  23  * This class encapsulates the information about a sound object
  24  * which is used for links on enter/leave page event.
  25  */
  26 class OKULAR_EXPORT Sound
  27 {
  28     public:
  29         /**
  30          * Describes where the sound is stored.
  31          */
  32         enum SoundType {
  33             External,    ///< Is stored at external resource (e.g. url)
  34             Embedded     ///< Is stored embedded in the document
  35         };
  36
  37         /**
  38          * Describes the encoding of the sound data.
  39          */
  40         enum SoundEncoding {
  41             Raw,         ///< Is not encoded
  42             Signed,      ///< Is encoded with twos-complement values
  43             muLaw,       ///< Is µ-law encoded
  44             ALaw         ///< Is A-law encoded
  45         };
  46
  47         /**
  48          * Creates a new sound object with the given embedded
  49          * sound @p data.
  50          */
  51         explicit Sound( const QByteArray& data );
  52
  53         /**
  54          * Creates a new sound object with the given external @p filename.
  55          */
  56         explicit Sound( const QString& filename );
  57
  58         /**
  59          * Destroys the sound object.
  60          */
  61         ~Sound();
  62
  63         /**
  64          * Returns the type of the sound object.
  65          */
  66         SoundType soundType() const;
  67
  68         /**
  69          * Returns the external storage url of the sound data.
  70          */
  71         QString url() const;
  72
  73         /**
  74          * Returns the embedded sound data.
  75          */
  76         QByteArray data() const;
  77
  78         /**
  79          * Sets the sampling @p rate.
  80          */
  81         void setSamplingRate( double rate );
  82
  83         /**
  84          * Returns the sampling rate.
  85          */
  86         double samplingRate() const;
  87
  88         /**
  89          * Sets the number of @p channels.
  90          */
  91         void setChannels( int channels );
  92
  93         /**
  94          * Returns the number of channels.
  95          */
  96         int channels() const;
  97
  98         /**
  99          * Sets the bits per sample @p rate.
 100          */
 101         void setBitsPerSample( int rate );
 102
 103         /**
 104          * Returns the bits per sample rate.
 105          */
 106         int bitsPerSample() const;
 107
 108         /**
 109          * Sets the type of sound @p encoding.
 110          */
 111         void setSoundEncoding( SoundEncoding encoding );
 112
 113         /**
 114          * Returns the sound encoding.
 115          */
 116         SoundEncoding soundEncoding() const;
 117
 118     private:
 119         class Private;
 120         Private* const d;
 121
 122         Q_DISABLE_COPY( Sound )
 123 };
 124
 125 }
 126
 127 #endif