TagLib API Documentation
opusfile.h
Go to the documentation of this file.
1/***************************************************************************
2 copyright : (C) 2012 by Lukáš Lalinský
3 email : lalinsky@gmail.com
4
5 copyright : (C) 2002 - 2008 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, MA *
23 * 02110-1301 USA *
24 * *
25 * Alternatively, this file is available under the Mozilla Public *
26 * License Version 1.1. You may obtain a copy of the License at *
27 * http://www.mozilla.org/MPL/ *
28 ***************************************************************************/
29
30#ifndef TAGLIB_OPUSFILE_H
31#define TAGLIB_OPUSFILE_H
32
33#include "oggfile.h"
34#include "xiphcomment.h"
35#include "opusproperties.h"
36
37namespace TagLib {
38
39 namespace Ogg {
40
42
43 namespace Opus {
44
46
55 {
56 public:
63 File(FileName file, bool readProperties = true,
65
75 File(IOStream *stream, bool readProperties = true,
77
81 ~File() override;
82
83 File(const File &) = delete;
84 File &operator=(const File &) = delete;
85
91 Ogg::XiphComment *tag() const override;
92
97 PropertyMap properties() const override;
98
104
109 Properties *audioProperties() const override;
110
116 bool save() override;
117
125 static bool isSupported(IOStream *stream);
126
127 private:
128 void read(bool readProperties);
129
130 class FilePrivate;
132 std::unique_ptr<FilePrivate> d;
133 };
134 } // namespace Opus
135 } // namespace Ogg
136} // namespace TagLib
137
138#endif
ReadStyle
Definition: audioproperties.h:56
@ Average
Read more of the file and make better values guesses.
Definition: audioproperties.h:60
An abstract class that provides operations on a sequence of bytes.
Definition: tiostream.h:65
An implementation of TagLib::File with some helpers for Ogg based formats.
Definition: oggfile.h:51
An implementation of Ogg::File with Opus specific methods.
Definition: opusfile.h:55
bool save() override
PropertyMap properties() const override
Properties * audioProperties() const override
File(const File &)=delete
Ogg::XiphComment * tag() const override
PropertyMap setProperties(const PropertyMap &) override
File(FileName file, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
File & operator=(const File &)=delete
File(IOStream *stream, bool readProperties=true, Properties::ReadStyle propertiesStyle=Properties::Average)
static bool isSupported(IOStream *stream)
An implementation of audio property reading for Ogg Opus.
Definition: opusproperties.h:51
Ogg Vorbis comment implementation.
Definition: xiphcomment.h:71
A map for format-independent <key,values> tag representations.
Definition: tpropertymap.h:123
A namespace for all TagLib related classes and functions.
Definition: apefile.h:41
const char * FileName
Definition: tiostream.h:59
#define TAGLIB_EXPORT
Definition: taglib_export.h:40
#define TAGLIB_MSVC_SUPPRESS_WARNING_NEEDS_TO_HAVE_DLL_INTERFACE
Definition: taglib_export.h:55