← Back to branch summary

~ubuntu-branches/ubuntu/wily/kid3/wily-proposed

« back to all changes in this revision

Viewing changes to kid3/taglibext/speex/speexfile.h

  • Committer: Package Import Robot
  • Author(s): Ana Beatriz Guerrero Lopez, Patrick Matthäi, Ana Beatriz Guerrero Lopez
  • Date: 2011-11-13 16:34:13 UTC
  • mfrom: (1.1.13) (2.1.11 sid)
  • Revision ID: package-import@ubuntu.com-20111113163413-5y0anlc4dqf511uh
Tags: 2.0.1-1
* New upstream release.

[ Patrick Matthäi ]
* Adjust build system.
* Add build dependency xsltproc.

[ Ana Beatriz Guerrero Lopez ]
* Some more adjustments to the build system taken from upstream's deb/
* directory.

Show diffs side-by-side

added added

removed removed

Lines of Context:
kid3/taglibext/speex/speexfile.h
1
 
/***************************************************************************
2
 
    copyright            : (C) 2006 by Lukáš Lalinský
3
 
    email                : lalinsky@gmail.com
4
 
 
5
 
    copyright            : (C) 2002 by Scott Wheeler
6
 
    email                : wheeler@kde.org
7
 
                           (original Vorbis implementation)
8
 
 ***************************************************************************/
9
 
 
10
 
/***************************************************************************
11
 
 *   This library is free software; you can redistribute it and/or modify  *
12
 
 *   it  under the terms of the GNU Lesser General Public License version  *
13
 
 *   2.1 as published by the Free Software Foundation.                     *
14
 
 *                                                                         *
15
 
 *   This library is distributed in the hope that it will be useful, but   *
16
 
 *   WITHOUT ANY WARRANTY; without even the implied warranty of            *
17
 
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU     *
18
 
 *   Lesser General Public License for more details.                       *
19
 
 *                                                                         *
20
 
 *   You should have received a copy of the GNU Lesser General Public      *
21
 
 *   License along with this library; if not, write to the Free Software   *
22
 
 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,            *
23
 
 *   MA  02110-1301  USA                                                   *
24
 
 ***************************************************************************/
25
 
 
26
 
#ifndef TAGLIB_SPEEXFILE_H
27
 
#define TAGLIB_SPEEXFILE_H
28
 
 
29
 
#include <oggfile.h>
30
 
#include <xiphcomment.h>
31
 
 
32
 
#include "speexproperties.h"
33
 
 
34
 
namespace TagLib {
35
 
 
36
 
  namespace Ogg {
37
 
 
38
 
    //! A namespace containing classes for Speex metadata
39
 
 
40
 
    namespace Speex {
41
 
 
42
 
      //! An implementation of Ogg::File with Speex specific methods
43
 
 
44
 
      /*!
45
 
       * This is the central class in the Ogg Speex metadata processing collection
46
 
       * of classes.  It's built upon Ogg::File which handles processing of the Ogg
47
 
       * logical bitstream and breaking it down into pages which are handled by
48
 
       * the codec implementations, in this case Speex specifically.
49
 
       */
50
 
 
51
 
      class File : public Ogg::File
52
 
      {
53
 
      public:
54
 
        /*!
55
 
         * Contructs a Speex file from \a file.  If \a readProperties is true the
56
 
         * file's audio properties will also be read using \a propertiesStyle.  If
57
 
         * false, \a propertiesStyle is ignored.
58
 
         */
59
 
        explicit File(const char *file, bool readProperties = true,
60
 
             Properties::ReadStyle propertiesStyle = Properties::Average);
61
 
 
62
 
        /*!
63
 
         * Destroys this instance of the File.
64
 
         */
65
 
        virtual ~File();
66
 
 
67
 
        /*!
68
 
         * Returns the XiphComment for this file.  XiphComment implements the tag
69
 
         * interface, so this serves as the reimplementation of
70
 
         * TagLib::File::tag().
71
 
         */
72
 
        virtual Ogg::XiphComment *tag() const;
73
 
 
74
 
        /*!
75
 
         * Returns the Speex::Properties for this file.  If no audio properties
76
 
         * were read then this will return a null pointer.
77
 
         */
78
 
        virtual Properties *audioProperties() const;
79
 
 
80
 
        virtual bool save();
81
 
 
82
 
      private:
83
 
        File(const File &);
84
 
        File &operator=(const File &);
85
 
 
86
 
        void read(bool readProperties, Properties::ReadStyle propertiesStyle);
87
 
 
88
 
        class FilePrivate;
89
 
        FilePrivate *d;
90
 
      };
91
 
    }
92
 
  }
93
 
}
94
 
 
95
 
#endif