Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 1 | /* libFLAC++ - Free Lossless Audio Codec library |
Josh Coalson | 9564390 | 2004-01-17 04:14:43 +0000 | [diff] [blame] | 2 | * Copyright (C) 2002,2003,2004 Josh Coalson |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 3 | * |
Josh Coalson | afd8107 | 2003-01-31 23:34:56 +0000 | [diff] [blame] | 4 | * Redistribution and use in source and binary forms, with or without |
| 5 | * modification, are permitted provided that the following conditions |
| 6 | * are met: |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 7 | * |
Josh Coalson | afd8107 | 2003-01-31 23:34:56 +0000 | [diff] [blame] | 8 | * - Redistributions of source code must retain the above copyright |
| 9 | * notice, this list of conditions and the following disclaimer. |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 10 | * |
Josh Coalson | afd8107 | 2003-01-31 23:34:56 +0000 | [diff] [blame] | 11 | * - Redistributions in binary form must reproduce the above copyright |
| 12 | * notice, this list of conditions and the following disclaimer in the |
| 13 | * documentation and/or other materials provided with the distribution. |
| 14 | * |
| 15 | * - Neither the name of the Xiph.org Foundation nor the names of its |
| 16 | * contributors may be used to endorse or promote products derived from |
| 17 | * this software without specific prior written permission. |
| 18 | * |
| 19 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 20 | * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 21 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 22 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR |
| 23 | * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, |
| 24 | * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, |
| 25 | * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR |
| 26 | * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF |
| 27 | * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING |
| 28 | * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS |
| 29 | * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 30 | */ |
| 31 | |
| 32 | #ifndef FLACPP__METADATA_H |
| 33 | #define FLACPP__METADATA_H |
| 34 | |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 35 | #include "export.h" |
| 36 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 37 | #include "FLAC/metadata.h" |
| 38 | |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 39 | // =============================================================== |
| 40 | // |
| 41 | // Full documentation for the metadata interface can be found |
| 42 | // in the C layer in include/FLAC/metadata.h |
| 43 | // |
| 44 | // =============================================================== |
| 45 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 46 | /** \file include/FLAC++/metadata.h |
| 47 | * |
| 48 | * \brief |
| 49 | * This module provides classes for creating and manipulating FLAC |
| 50 | * metadata blocks in memory, and three progressively more powerful |
| 51 | * interfaces for traversing and editing metadata in FLAC files. |
| 52 | * |
| 53 | * See the detailed documentation for each interface in the |
| 54 | * \link flacpp_metadata metadata \endlink module. |
| 55 | */ |
| 56 | |
| 57 | /** \defgroup flacpp_metadata FLAC++/metadata.h: metadata interfaces |
| 58 | * \ingroup flacpp |
| 59 | * |
| 60 | * \brief |
| 61 | * This module provides classes for creating and manipulating FLAC |
| 62 | * metadata blocks in memory, and three progressively more powerful |
| 63 | * interfaces for traversing and editing metadata in FLAC files. |
| 64 | * |
| 65 | * The behavior closely mimics the C layer interface; be sure to read |
| 66 | * the detailed description of the |
| 67 | * \link flac_metadata C metadata module \endlink. |
| 68 | */ |
| 69 | |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 70 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 71 | namespace FLAC { |
| 72 | namespace Metadata { |
| 73 | |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 74 | // ============================================================ |
| 75 | // |
| 76 | // Metadata objects |
| 77 | // |
| 78 | // ============================================================ |
| 79 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 80 | /** \defgroup flacpp_metadata_object FLAC++/metadata.h: metadata object classes |
| 81 | * \ingroup flacpp_metadata |
| 82 | * |
| 83 | * This module contains classes representing FLAC metadata |
| 84 | * blocks in memory. |
| 85 | * |
| 86 | * The behavior closely mimics the C layer interface; be |
| 87 | * sure to read the detailed description of the |
| 88 | * \link flac_metadata_object C metadata object module \endlink. |
| 89 | * |
| 90 | * Any time a metadata object is constructed or assigned, you |
| 91 | * should check is_valid() to make sure the underlying |
| 92 | * ::FLAC__StreamMetadata object was able to be created. |
| 93 | * |
| 94 | * \warning |
| 95 | * When the get_*() methods of any metadata object method |
| 96 | * return you a const pointer, DO NOT disobey and write into it. |
| 97 | * Always use the set_*() methods. |
| 98 | * |
| 99 | * \{ |
| 100 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 101 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 102 | /** Base class for all metadata block types. |
| 103 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 104 | class FLACPP_API Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 105 | protected: |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 106 | //@{ |
| 107 | /** Constructs a copy of the given object. This form |
| 108 | * always performs a deep copy. |
| 109 | */ |
| 110 | Prototype(const Prototype &); |
| 111 | Prototype(const ::FLAC__StreamMetadata &); |
| 112 | Prototype(const ::FLAC__StreamMetadata *); |
| 113 | //@} |
Josh Coalson | 8396175 | 2002-07-09 06:12:59 +0000 | [diff] [blame] | 114 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 115 | /** Constructs an object with copy control. When \a copy |
| 116 | * is \c true, behaves identically to |
| 117 | * FLAC::Metadata::Prototype::Prototype(const ::FLAC__StreamMetadata *object). |
| 118 | * When \a copy is \c false, the instance takes ownership of |
| 119 | * the pointer and the ::FLAC__StreamMetadata object will |
| 120 | * be freed by the destructor. |
| 121 | * |
| 122 | * \assert |
| 123 | * \code object != NULL \endcode |
| 124 | */ |
Josh Coalson | 8396175 | 2002-07-09 06:12:59 +0000 | [diff] [blame] | 125 | Prototype(::FLAC__StreamMetadata *object, bool copy); |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 126 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 127 | //@{ |
| 128 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 129 | void operator=(const Prototype &); |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 130 | void operator=(const ::FLAC__StreamMetadata &); |
| 131 | void operator=(const ::FLAC__StreamMetadata *); |
| 132 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 133 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 134 | /** Deletes the underlying ::FLAC__StreamMetadata object. |
| 135 | */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 136 | virtual void clear(); |
| 137 | |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 138 | ::FLAC__StreamMetadata *object_; |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 139 | public: |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 140 | /** Deletes the underlying ::FLAC__StreamMetadata object. |
| 141 | */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 142 | virtual ~Prototype(); |
| 143 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 144 | //@{ |
| 145 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 146 | inline bool operator==(const Prototype &) const; |
| 147 | inline bool operator==(const ::FLAC__StreamMetadata &) const; |
| 148 | inline bool operator==(const ::FLAC__StreamMetadata *) const; |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 149 | //@} |
| 150 | |
| 151 | //@{ |
| 152 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 153 | inline bool operator!=(const Prototype &) const; |
| 154 | inline bool operator!=(const ::FLAC__StreamMetadata &) const; |
| 155 | inline bool operator!=(const ::FLAC__StreamMetadata *) const; |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 156 | //@} |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 157 | |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 158 | friend class SimpleIterator; |
| 159 | friend class Iterator; |
| 160 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 161 | /** Returns \c true if the object was correctly constructed |
| 162 | * (i.e. the underlying ::FLAC__StreamMetadata object was |
| 163 | * properly allocated), else \c false. |
| 164 | */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 165 | inline bool is_valid() const; |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 166 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 167 | /** Returns \c true if this block is the last block in a |
| 168 | * stream, else \c false. |
| 169 | * |
| 170 | * \assert |
| 171 | * \code is_valid() \endcode |
| 172 | */ |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 173 | bool get_is_last() const; |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 174 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 175 | /** Returns the type of the block. |
| 176 | * |
| 177 | * \assert |
| 178 | * \code is_valid() \endcode |
| 179 | */ |
| 180 | ::FLAC__MetadataType get_type() const; |
| 181 | |
| 182 | /** Returns the stream length of the metadata block. |
| 183 | * |
| 184 | * \note |
| 185 | * The length does not include the metadata block header, |
| 186 | * per spec. |
| 187 | * |
| 188 | * \assert |
| 189 | * \code is_valid() \endcode |
| 190 | */ |
| 191 | unsigned get_length() const; |
| 192 | |
| 193 | /** Sets the "is_last" flag for the block. When using the iterators |
| 194 | * it is not necessary to set this flag; they will do it for you. |
| 195 | * |
| 196 | * \assert |
| 197 | * \code is_valid() \endcode |
| 198 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 199 | void set_is_last(bool); |
Josh Coalson | d113ca3 | 2004-07-22 01:03:43 +0000 | [diff] [blame^] | 200 | |
| 201 | /** Returns a pointer to the underlying ::FLAC__StreamMetadata |
| 202 | * object. This can be useful for plugging any holes between |
| 203 | * the C++ and C interfaces. |
| 204 | * |
| 205 | * \assert |
| 206 | * \code is_valid() \endcode |
| 207 | */ |
| 208 | inline operator const ::FLAC__StreamMetadata *() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 209 | private: |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 210 | /** Private and undefined so you can't use it. */ |
| 211 | Prototype(); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 212 | |
| 213 | // These are used only by Iterator |
| 214 | bool is_reference_; |
| 215 | inline void set_reference(bool x) { is_reference_ = x; } |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 216 | }; |
| 217 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 218 | inline bool Prototype::operator==(const Prototype &object) const |
Josh Coalson | d57c8d3 | 2002-06-11 06:15:28 +0000 | [diff] [blame] | 219 | { return (bool)::FLAC__metadata_object_is_equal(object_, object.object_); } |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 220 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 221 | inline bool Prototype::operator==(const ::FLAC__StreamMetadata &object) const |
Josh Coalson | d57c8d3 | 2002-06-11 06:15:28 +0000 | [diff] [blame] | 222 | { return (bool)::FLAC__metadata_object_is_equal(object_, &object); } |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 223 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 224 | inline bool Prototype::operator==(const ::FLAC__StreamMetadata *object) const |
Josh Coalson | d57c8d3 | 2002-06-11 06:15:28 +0000 | [diff] [blame] | 225 | { return (bool)::FLAC__metadata_object_is_equal(object_, object); } |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 226 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 227 | inline bool Prototype::operator!=(const Prototype &object) const |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 228 | { return !operator==(object); } |
| 229 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 230 | inline bool Prototype::operator!=(const ::FLAC__StreamMetadata &object) const |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 231 | { return !operator==(object); } |
| 232 | |
Josh Coalson | 765ff50 | 2002-08-27 05:46:11 +0000 | [diff] [blame] | 233 | inline bool Prototype::operator!=(const ::FLAC__StreamMetadata *object) const |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 234 | { return !operator==(object); } |
| 235 | |
| 236 | inline bool Prototype::is_valid() const |
| 237 | { return 0 != object_; } |
| 238 | |
Josh Coalson | d113ca3 | 2004-07-22 01:03:43 +0000 | [diff] [blame^] | 239 | inline Prototype::operator const ::FLAC__StreamMetadata *() const |
| 240 | { return object_; } |
| 241 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 242 | /** Create a deep copy of an object and return it. */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 243 | FLACPP_API Prototype *clone(const Prototype *); |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 244 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 245 | |
| 246 | /** STREAMINFO metadata block. |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 247 | * See <A HREF="../format.html#metadata_block_streaminfo">format specification</A>. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 248 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 249 | class FLACPP_API StreamInfo : public Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 250 | public: |
| 251 | StreamInfo(); |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 252 | |
| 253 | //@{ |
| 254 | /** Constructs a copy of the given object. This form |
| 255 | * always performs a deep copy. |
| 256 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 257 | inline StreamInfo(const StreamInfo &object): Prototype(object) { } |
| 258 | inline StreamInfo(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 259 | inline StreamInfo(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 260 | //@} |
| 261 | |
| 262 | /** Constructs an object with copy control. See |
| 263 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 264 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 265 | inline StreamInfo(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 266 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 267 | ~StreamInfo(); |
| 268 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 269 | //@{ |
| 270 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 271 | inline void operator=(const StreamInfo &object) { Prototype::operator=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 272 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 273 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 274 | //@} |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 275 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 276 | //@{ |
| 277 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 278 | inline bool operator==(const StreamInfo &object) const { return Prototype::operator==(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 279 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 280 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 281 | //@} |
| 282 | |
| 283 | //@{ |
| 284 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 285 | inline bool operator!=(const StreamInfo &object) const { return Prototype::operator!=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 286 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 287 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 288 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 289 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 290 | //@{ |
| 291 | /** See <A HREF="../format.html#metadata_block_streaminfo">format specification</A>. */ |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 292 | unsigned get_min_blocksize() const; |
| 293 | unsigned get_max_blocksize() const; |
| 294 | unsigned get_min_framesize() const; |
| 295 | unsigned get_max_framesize() const; |
| 296 | unsigned get_sample_rate() const; |
| 297 | unsigned get_channels() const; |
| 298 | unsigned get_bits_per_sample() const; |
| 299 | FLAC__uint64 get_total_samples() const; |
| 300 | const FLAC__byte *get_md5sum() const; |
| 301 | |
| 302 | void set_min_blocksize(unsigned value); |
| 303 | void set_max_blocksize(unsigned value); |
| 304 | void set_min_framesize(unsigned value); |
| 305 | void set_max_framesize(unsigned value); |
| 306 | void set_sample_rate(unsigned value); |
| 307 | void set_channels(unsigned value); |
| 308 | void set_bits_per_sample(unsigned value); |
| 309 | void set_total_samples(FLAC__uint64 value); |
| 310 | void set_md5sum(const FLAC__byte value[16]); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 311 | //@} |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 312 | }; |
| 313 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 314 | /** PADDING metadata block. |
| 315 | * See <A HREF="../format.html#metadata_block_padding">format specification</A>. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 316 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 317 | class FLACPP_API Padding : public Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 318 | public: |
| 319 | Padding(); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 320 | |
| 321 | //@{ |
| 322 | /** Constructs a copy of the given object. This form |
| 323 | * always performs a deep copy. |
| 324 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 325 | inline Padding(const Padding &object): Prototype(object) { } |
| 326 | inline Padding(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 327 | inline Padding(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 328 | //@} |
| 329 | |
| 330 | /** Constructs an object with copy control. See |
| 331 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 332 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 333 | inline Padding(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 334 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 335 | ~Padding(); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 336 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 337 | //@{ |
| 338 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 339 | inline void operator=(const Padding &object) { Prototype::operator=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 340 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 341 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 342 | //@} |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 343 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 344 | //@{ |
| 345 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 346 | inline bool operator==(const Padding &object) const { return Prototype::operator==(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 347 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 348 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 349 | //@} |
| 350 | |
| 351 | //@{ |
| 352 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 353 | inline bool operator!=(const Padding &object) const { return Prototype::operator!=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 354 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 355 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 356 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 357 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 358 | void set_length(unsigned length); |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 359 | }; |
| 360 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 361 | /** APPLICATION metadata block. |
| 362 | * See <A HREF="../format.html#metadata_block_application">format specification</A>. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 363 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 364 | class FLACPP_API Application : public Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 365 | public: |
| 366 | Application(); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 367 | // |
| 368 | //@{ |
| 369 | /** Constructs a copy of the given object. This form |
| 370 | * always performs a deep copy. |
| 371 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 372 | inline Application(const Application &object): Prototype(object) { } |
| 373 | inline Application(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 374 | inline Application(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 375 | //@} |
| 376 | |
| 377 | /** Constructs an object with copy control. See |
| 378 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 379 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 380 | inline Application(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 381 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 382 | ~Application(); |
| 383 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 384 | //@{ |
| 385 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 386 | inline void operator=(const Application &object) { Prototype::operator=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 387 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 388 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 389 | //@} |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 390 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 391 | //@{ |
| 392 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 393 | inline bool operator==(const Application &object) const { return Prototype::operator==(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 394 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 395 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 396 | //@} |
| 397 | |
| 398 | //@{ |
| 399 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 400 | inline bool operator!=(const Application &object) const { return Prototype::operator!=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 401 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 402 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 403 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 404 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 405 | const FLAC__byte *get_id() const; |
| 406 | const FLAC__byte *get_data() const; |
| 407 | |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 408 | void set_id(const FLAC__byte value[4]); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 409 | //! This form always copies \a data |
| 410 | bool set_data(const FLAC__byte *data, unsigned length); |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 411 | bool set_data(FLAC__byte *data, unsigned length, bool copy); |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 412 | }; |
| 413 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 414 | /** SEEKTABLE metadata block. |
| 415 | * See <A HREF="../format.html#metadata_block_seektable">format specification</A>. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 416 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 417 | class FLACPP_API SeekTable : public Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 418 | public: |
| 419 | SeekTable(); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 420 | |
| 421 | //@{ |
| 422 | /** Constructs a copy of the given object. This form |
| 423 | * always performs a deep copy. |
| 424 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 425 | inline SeekTable(const SeekTable &object): Prototype(object) { } |
| 426 | inline SeekTable(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 427 | inline SeekTable(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 428 | //@} |
| 429 | |
| 430 | /** Constructs an object with copy control. See |
| 431 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 432 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 433 | inline SeekTable(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 434 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 435 | ~SeekTable(); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 436 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 437 | //@{ |
| 438 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 439 | inline void operator=(const SeekTable &object) { Prototype::operator=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 440 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 441 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 442 | //@} |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 443 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 444 | //@{ |
| 445 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 446 | inline bool operator==(const SeekTable &object) const { return Prototype::operator==(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 447 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 448 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 449 | //@} |
| 450 | |
| 451 | //@{ |
| 452 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 453 | inline bool operator!=(const SeekTable &object) const { return Prototype::operator!=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 454 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 455 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 456 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 457 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 458 | unsigned get_num_points() const; |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 459 | ::FLAC__StreamMetadata_SeekPoint get_point(unsigned index) const; |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 460 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 461 | //! See FLAC__metadata_object_seektable_set_point() |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 462 | void set_point(unsigned index, const ::FLAC__StreamMetadata_SeekPoint &point); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 463 | |
| 464 | //! See FLAC__metadata_object_seektable_insert_point() |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 465 | bool insert_point(unsigned index, const ::FLAC__StreamMetadata_SeekPoint &point); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 466 | |
| 467 | //! See FLAC__metadata_object_seektable_delete_point() |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 468 | bool delete_point(unsigned index); |
Josh Coalson | 28e08d8 | 2002-06-05 05:56:41 +0000 | [diff] [blame] | 469 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 470 | //! See FLAC__metadata_object_seektable_is_legal() |
Josh Coalson | 28e08d8 | 2002-06-05 05:56:41 +0000 | [diff] [blame] | 471 | bool is_legal() const; |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 472 | }; |
| 473 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 474 | /** VORBIS_COMMENT metadata block. |
| 475 | * See <A HREF="../format.html#metadata_block_vorbis_comment">format specification</A>. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 476 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 477 | class FLACPP_API VorbisComment : public Prototype { |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 478 | public: |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 479 | /** Convenience class for encapsulating Vorbis comment |
| 480 | * entries. An entry is a vendor string or a comment |
| 481 | * field. In the case of a vendor string, the field |
| 482 | * name is undefined; only the field value is relevant. |
| 483 | * |
| 484 | * A \a field as used in the methods refers to an |
| 485 | * entire 'NAME=VALUE' string; the string is not null- |
| 486 | * terminated and a length field is required since the |
| 487 | * string may contain embedded nulls. |
| 488 | * |
| 489 | * A \a field_name is what is on the left side of the |
| 490 | * first '=' in the \a field. By definition it is ASCII |
| 491 | * and so is null-terminated and does not require a |
| 492 | * length to describe it. \a field_name is undefined |
| 493 | * for a vendor string entry. |
| 494 | * |
| 495 | * A \a field_value is what is on the right side of the |
| 496 | * first '=' in the \a field. By definition, this may |
| 497 | * contain embedded nulls and so a \a field_value_length |
| 498 | * is requires to describe it. |
| 499 | * |
| 500 | * Always check is_valid() after the constructor or operator= |
| 501 | * to make sure memory was properly allocated. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 502 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 503 | class FLACPP_API Entry { |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 504 | public: |
| 505 | Entry(); |
| 506 | Entry(const char *field, unsigned field_length); |
| 507 | Entry(const char *field_name, const char *field_value, unsigned field_value_length); |
| 508 | Entry(const Entry &entry); |
| 509 | void operator=(const Entry &entry); |
| 510 | |
| 511 | virtual ~Entry(); |
| 512 | |
| 513 | virtual bool is_valid() const; |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 514 | |
| 515 | unsigned get_field_length() const; |
| 516 | unsigned get_field_name_length() const; |
| 517 | unsigned get_field_value_length() const; |
| 518 | |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 519 | ::FLAC__StreamMetadata_VorbisComment_Entry get_entry() const; |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 520 | const char *get_field() const; |
| 521 | const char *get_field_name() const; |
| 522 | const char *get_field_value() const; |
| 523 | |
| 524 | bool set_field(const char *field, unsigned field_length); |
| 525 | bool set_field_name(const char *field_name); |
| 526 | bool set_field_value(const char *field_value, unsigned field_value_length); |
| 527 | protected: |
| 528 | bool is_valid_; |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 529 | ::FLAC__StreamMetadata_VorbisComment_Entry entry_; |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 530 | char *field_name_; |
| 531 | unsigned field_name_length_; |
| 532 | char *field_value_; |
| 533 | unsigned field_value_length_; |
| 534 | private: |
| 535 | void zero(); |
| 536 | void clear(); |
| 537 | void clear_entry(); |
| 538 | void clear_field_name(); |
| 539 | void clear_field_value(); |
| 540 | void construct(const char *field, unsigned field_length); |
| 541 | void construct(const char *field_name, const char *field_value, unsigned field_value_length); |
| 542 | void compose_field(); |
| 543 | void parse_field(); |
| 544 | }; |
| 545 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 546 | VorbisComment(); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 547 | |
| 548 | //@{ |
| 549 | /** Constructs a copy of the given object. This form |
| 550 | * always performs a deep copy. |
| 551 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 552 | inline VorbisComment(const VorbisComment &object): Prototype(object) { } |
| 553 | inline VorbisComment(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 554 | inline VorbisComment(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 555 | //@} |
| 556 | |
| 557 | /** Constructs an object with copy control. See |
| 558 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 559 | */ |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 560 | inline VorbisComment(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 561 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 562 | ~VorbisComment(); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 563 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 564 | //@{ |
| 565 | /** Assign from another object. Always performs a deep copy. */ |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 566 | inline void operator=(const VorbisComment &object) { Prototype::operator=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 567 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 568 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 569 | //@} |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 570 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 571 | //@{ |
| 572 | /** Check for equality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 573 | inline bool operator==(const VorbisComment &object) const { return Prototype::operator==(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 574 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 575 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 576 | //@} |
| 577 | |
| 578 | //@{ |
| 579 | /** Check for inequality, performing a deep compare by following pointers. */ |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 580 | inline bool operator!=(const VorbisComment &object) const { return Prototype::operator!=(object); } |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 581 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 582 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 583 | //@} |
Josh Coalson | 57ba6f4 | 2002-06-07 05:27:37 +0000 | [diff] [blame] | 584 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 585 | unsigned get_num_comments() const; |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 586 | Entry get_vendor_string() const; // only the Entry's field name should be used |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 587 | Entry get_comment(unsigned index) const; |
| 588 | |
Josh Coalson | 87977ba | 2002-08-20 07:09:33 +0000 | [diff] [blame] | 589 | //! See FLAC__metadata_object_vorbiscomment_set_vendor_string() |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 590 | //! \note Only the Entry's field name will be used. |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 591 | bool set_vendor_string(const Entry &entry); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 592 | |
Josh Coalson | 87977ba | 2002-08-20 07:09:33 +0000 | [diff] [blame] | 593 | //! See FLAC__metadata_object_vorbiscomment_set_comment() |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 594 | bool set_comment(unsigned index, const Entry &entry); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 595 | |
Josh Coalson | 87977ba | 2002-08-20 07:09:33 +0000 | [diff] [blame] | 596 | //! See FLAC__metadata_object_vorbiscomment_insert_comment() |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 597 | bool insert_comment(unsigned index, const Entry &entry); |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 598 | |
Josh Coalson | 87977ba | 2002-08-20 07:09:33 +0000 | [diff] [blame] | 599 | //! See FLAC__metadata_object_vorbiscomment_delete_comment() |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 600 | bool delete_comment(unsigned index); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 601 | }; |
| 602 | |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 603 | /** CUESHEET metadata block. |
| 604 | * See <A HREF="../format.html#metadata_block_cuesheet">format specification</A>. |
| 605 | */ |
| 606 | class FLACPP_API CueSheet : public Prototype { |
| 607 | public: |
| 608 | /** Convenience class for encapsulating a cue sheet |
| 609 | * track. |
| 610 | * |
| 611 | * Always check is_valid() after the constructor or operator= |
| 612 | * to make sure memory was properly allocated. |
| 613 | */ |
| 614 | class FLACPP_API Track { |
| 615 | protected: |
| 616 | ::FLAC__StreamMetadata_CueSheet_Track *object_; |
| 617 | public: |
| 618 | Track(); |
| 619 | Track(const ::FLAC__StreamMetadata_CueSheet_Track *track); |
| 620 | Track(const Track &track); |
| 621 | void operator=(const Track &track); |
| 622 | |
| 623 | virtual ~Track(); |
| 624 | |
| 625 | virtual bool is_valid() const; |
| 626 | |
| 627 | inline FLAC__uint64 get_offset() const { return object_->offset; } |
| 628 | inline FLAC__byte get_number() const { return object_->number; } |
| 629 | inline const char *get_isrc() const { return object_->isrc; } |
| 630 | inline unsigned get_type() const { return object_->type; } |
| 631 | inline bool get_pre_emphasis() const { return object_->pre_emphasis; } |
| 632 | |
Josh Coalson | a7038a9 | 2003-01-22 20:16:20 +0000 | [diff] [blame] | 633 | inline FLAC__byte get_num_indices() const { return object_->num_indices; } |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 634 | ::FLAC__StreamMetadata_CueSheet_Index get_index(unsigned i) const; |
| 635 | |
| 636 | inline const ::FLAC__StreamMetadata_CueSheet_Track *get_track() const { return object_; } |
| 637 | |
| 638 | inline void set_offset(FLAC__uint64 value) { object_->offset = value; } |
| 639 | inline void set_number(FLAC__byte value) { object_->number = value; } |
Josh Coalson | 1621979 | 2002-11-19 06:19:29 +0000 | [diff] [blame] | 640 | void set_isrc(const char value[12]); |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 641 | void set_type(unsigned value); |
| 642 | inline void set_pre_emphasis(bool value) { object_->pre_emphasis = value? 1 : 0; } |
| 643 | |
Josh Coalson | 1621979 | 2002-11-19 06:19:29 +0000 | [diff] [blame] | 644 | void set_index(unsigned i, const ::FLAC__StreamMetadata_CueSheet_Index &index); |
Josh Coalson | b3538c8 | 2003-01-12 08:42:23 +0000 | [diff] [blame] | 645 | //@@@ It's awkward but to insert/delete index points |
| 646 | //@@@ you must use the routines in the CueSheet class. |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 647 | }; |
| 648 | |
| 649 | CueSheet(); |
| 650 | |
| 651 | //@{ |
| 652 | /** Constructs a copy of the given object. This form |
| 653 | * always performs a deep copy. |
| 654 | */ |
| 655 | inline CueSheet(const CueSheet &object): Prototype(object) { } |
| 656 | inline CueSheet(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 657 | inline CueSheet(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
| 658 | //@} |
| 659 | |
| 660 | /** Constructs an object with copy control. See |
| 661 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 662 | */ |
| 663 | inline CueSheet(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
| 664 | |
| 665 | ~CueSheet(); |
| 666 | |
| 667 | //@{ |
| 668 | /** Assign from another object. Always performs a deep copy. */ |
| 669 | inline void operator=(const CueSheet &object) { Prototype::operator=(object); } |
| 670 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 671 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
| 672 | //@} |
| 673 | |
| 674 | //@{ |
| 675 | /** Check for equality, performing a deep compare by following pointers. */ |
| 676 | inline bool operator==(const CueSheet &object) const { return Prototype::operator==(object); } |
| 677 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 678 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
| 679 | //@} |
| 680 | |
| 681 | //@{ |
| 682 | /** Check for inequality, performing a deep compare by following pointers. */ |
| 683 | inline bool operator!=(const CueSheet &object) const { return Prototype::operator!=(object); } |
| 684 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 685 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
| 686 | //@} |
| 687 | |
| 688 | const char *get_media_catalog_number() const; |
| 689 | FLAC__uint64 get_lead_in() const; |
Josh Coalson | 8f0c71b | 2002-12-05 06:37:46 +0000 | [diff] [blame] | 690 | bool get_is_cd() const; |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 691 | |
| 692 | unsigned get_num_tracks() const; |
| 693 | Track get_track(unsigned i) const; |
| 694 | |
Josh Coalson | 1621979 | 2002-11-19 06:19:29 +0000 | [diff] [blame] | 695 | void set_media_catalog_number(const char value[128]); |
| 696 | void set_lead_in(FLAC__uint64 value); |
Josh Coalson | 8f0c71b | 2002-12-05 06:37:46 +0000 | [diff] [blame] | 697 | void set_is_cd(bool value); |
Josh Coalson | 1621979 | 2002-11-19 06:19:29 +0000 | [diff] [blame] | 698 | |
| 699 | void set_index(unsigned track_num, unsigned index_num, const ::FLAC__StreamMetadata_CueSheet_Index &index); |
Josh Coalson | 863dbf3 | 2002-11-16 06:30:30 +0000 | [diff] [blame] | 700 | |
| 701 | //! See FLAC__metadata_object_cuesheet_track_insert_index() |
| 702 | bool insert_index(unsigned track_num, unsigned index_num, const ::FLAC__StreamMetadata_CueSheet_Index &index); |
| 703 | |
| 704 | //! See FLAC__metadata_object_cuesheet_track_delete_index() |
| 705 | bool delete_index(unsigned track_num, unsigned index_num); |
| 706 | |
| 707 | //! See FLAC__metadata_object_cuesheet_set_track() |
| 708 | bool set_track(unsigned i, const Track &track); |
| 709 | |
| 710 | //! See FLAC__metadata_object_cuesheet_insert_track() |
| 711 | bool insert_track(unsigned i, const Track &track); |
| 712 | |
| 713 | //! See FLAC__metadata_object_cuesheet_delete_track() |
| 714 | bool delete_track(unsigned i); |
| 715 | |
| 716 | //! See FLAC__metadata_object_cuesheet_is_legal() |
| 717 | bool is_legal(bool check_cd_da_subset = false, const char **violation = 0) const; |
| 718 | }; |
| 719 | |
Josh Coalson | 0eea34a | 2003-01-10 05:29:17 +0000 | [diff] [blame] | 720 | /** Opaque metadata block for storing unknown types. |
| 721 | * This should not be used unless you know what you are doing; |
| 722 | * it is currently used only internally to support forward |
| 723 | * compatibility of metadata blocks. |
| 724 | */ |
| 725 | class FLACPP_API Unknown : public Prototype { |
| 726 | public: |
| 727 | Unknown(); |
| 728 | // |
| 729 | //@{ |
| 730 | /** Constructs a copy of the given object. This form |
| 731 | * always performs a deep copy. |
| 732 | */ |
| 733 | inline Unknown(const Unknown &object): Prototype(object) { } |
| 734 | inline Unknown(const ::FLAC__StreamMetadata &object): Prototype(object) { } |
| 735 | inline Unknown(const ::FLAC__StreamMetadata *object): Prototype(object) { } |
| 736 | //@} |
| 737 | |
| 738 | /** Constructs an object with copy control. See |
| 739 | * Prototype(::FLAC__StreamMetadata *object, bool copy). |
| 740 | */ |
| 741 | inline Unknown(::FLAC__StreamMetadata *object, bool copy): Prototype(object, copy) { } |
| 742 | |
| 743 | ~Unknown(); |
| 744 | |
| 745 | //@{ |
| 746 | /** Assign from another object. Always performs a deep copy. */ |
| 747 | inline void operator=(const Unknown &object) { Prototype::operator=(object); } |
| 748 | inline void operator=(const ::FLAC__StreamMetadata &object) { Prototype::operator=(object); } |
| 749 | inline void operator=(const ::FLAC__StreamMetadata *object) { Prototype::operator=(object); } |
| 750 | //@} |
| 751 | |
| 752 | //@{ |
| 753 | /** Check for equality, performing a deep compare by following pointers. */ |
| 754 | inline bool operator==(const Unknown &object) const { return Prototype::operator==(object); } |
| 755 | inline bool operator==(const ::FLAC__StreamMetadata &object) const { return Prototype::operator==(object); } |
| 756 | inline bool operator==(const ::FLAC__StreamMetadata *object) const { return Prototype::operator==(object); } |
| 757 | //@} |
| 758 | |
| 759 | //@{ |
| 760 | /** Check for inequality, performing a deep compare by following pointers. */ |
| 761 | inline bool operator!=(const Unknown &object) const { return Prototype::operator!=(object); } |
| 762 | inline bool operator!=(const ::FLAC__StreamMetadata &object) const { return Prototype::operator!=(object); } |
| 763 | inline bool operator!=(const ::FLAC__StreamMetadata *object) const { return Prototype::operator!=(object); } |
| 764 | //@} |
| 765 | |
| 766 | const FLAC__byte *get_data() const; |
| 767 | |
| 768 | //! This form always copies \a data |
| 769 | bool set_data(const FLAC__byte *data, unsigned length); |
| 770 | bool set_data(FLAC__byte *data, unsigned length, bool copy); |
| 771 | }; |
| 772 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 773 | /* \} */ |
| 774 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 775 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 776 | /** \defgroup flacpp_metadata_level0 FLAC++/metadata.h: metadata level 0 interface |
| 777 | * \ingroup flacpp_metadata |
| 778 | * |
| 779 | * \brief |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 780 | * Level 0 metadata iterator. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 781 | * |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 782 | * See the \link flac_metadata_level0 C layer equivalent \endlink |
| 783 | * for more. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 784 | * |
| 785 | * \{ |
| 786 | */ |
| 787 | |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 788 | //! See FLAC__metadata_get_streaminfo(). |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 789 | FLACPP_API bool get_streaminfo(const char *filename, StreamInfo &streaminfo); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 790 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 791 | /* \} */ |
| 792 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 793 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 794 | /** \defgroup flacpp_metadata_level1 FLAC++/metadata.h: metadata level 1 interface |
| 795 | * \ingroup flacpp_metadata |
| 796 | * |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 797 | * \brief |
| 798 | * Level 1 metadata iterator. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 799 | * |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 800 | * The flow through the iterator in the C++ layer is similar |
| 801 | * to the C layer: |
| 802 | * - Create a SimpleIterator instance |
| 803 | * - Check SimpleIterator::is_valid() |
| 804 | * - Call SimpleIterator::init() and check the return |
| 805 | * - Traverse and/or edit. Edits are written to file |
| 806 | * immediately. |
| 807 | * - Destroy the SimpleIterator instance |
| 808 | * |
| 809 | * The ownership of pointers in the C++ layer follows that in |
| 810 | * the C layer, i.e. |
| 811 | * - The objects returned by get_block() are yours to |
| 812 | * modify, but changes are not reflected in the FLAC file |
| 813 | * until you call set_block(). The objects are also |
| 814 | * yours to delete; they are not automatically deleted |
| 815 | * when passed to set_block() or insert_block_after(). |
| 816 | * |
| 817 | * See the \link flac_metadata_level1 C layer equivalent \endlink |
| 818 | * for more. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 819 | * |
| 820 | * \{ |
| 821 | */ |
| 822 | |
Josh Coalson | 402da70 | 2002-08-21 03:40:11 +0000 | [diff] [blame] | 823 | /** This class is a wrapper around the FLAC__metadata_simple_iterator |
| 824 | * structures and methods; see ::FLAC__Metadata_SimpleIterator. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 825 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 826 | class FLACPP_API SimpleIterator { |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 827 | public: |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 828 | class FLACPP_API Status { |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 829 | public: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 830 | inline Status(::FLAC__Metadata_SimpleIteratorStatus status): status_(status) { } |
| 831 | inline operator ::FLAC__Metadata_SimpleIteratorStatus() const { return status_; } |
| 832 | inline const char *as_cstring() const { return ::FLAC__Metadata_SimpleIteratorStatusString[status_]; } |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 833 | protected: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 834 | ::FLAC__Metadata_SimpleIteratorStatus status_; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 835 | }; |
| 836 | |
| 837 | SimpleIterator(); |
| 838 | virtual ~SimpleIterator(); |
| 839 | |
Josh Coalson | 3ac6693 | 2002-08-30 05:41:31 +0000 | [diff] [blame] | 840 | bool init(const char *filename, bool read_only, bool preserve_file_stats); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 841 | |
| 842 | bool is_valid() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 843 | Status status(); |
| 844 | bool is_writable() const; |
| 845 | |
| 846 | bool next(); |
| 847 | bool prev(); |
| 848 | |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 849 | ::FLAC__MetadataType get_block_type() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 850 | Prototype *get_block(); |
| 851 | bool set_block(Prototype *block, bool use_padding = true); |
| 852 | bool insert_block_after(Prototype *block, bool use_padding = true); |
| 853 | bool delete_block(bool use_padding = true); |
| 854 | |
| 855 | protected: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 856 | ::FLAC__Metadata_SimpleIterator *iterator_; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 857 | void clear(); |
| 858 | }; |
| 859 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 860 | /* \} */ |
| 861 | |
Josh Coalson | b2b5358 | 2002-05-31 06:20:50 +0000 | [diff] [blame] | 862 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 863 | /** \defgroup flacpp_metadata_level2 FLAC++/metadata.h: metadata level 2 interface |
| 864 | * \ingroup flacpp_metadata |
| 865 | * |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 866 | * \brief |
| 867 | * Level 2 metadata iterator. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 868 | * |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 869 | * The flow through the iterator in the C++ layer is similar |
| 870 | * to the C layer: |
| 871 | * - Create a Chain instance |
| 872 | * - Check Chain::is_valid() |
| 873 | * - Call Chain::read() and check the return |
| 874 | * - Traverse and/or edit with an Iterator or with |
| 875 | * Chain::merge_padding() or Chain::sort_padding() |
| 876 | * - Write changes back to FLAC file with Chain::write() |
| 877 | * - Destroy the Chain instance |
| 878 | * |
Josh Coalson | 8b9a477 | 2002-12-28 07:03:26 +0000 | [diff] [blame] | 879 | * The ownership of pointers in the C++ layer is slightly |
| 880 | * different than in the C layer, i.e. |
| 881 | * - The objects returned by Iterator::get_block() are NOT |
| 882 | * owned by the iterator and should be deleted by the |
| 883 | * caller when finished, BUT, when you modify the block, |
| 884 | * it will directly edit what's in the chain and you do |
| 885 | * not need to call Iterator::set_block(). However the |
| 886 | * changes will not be reflected in the FLAC file until |
| 887 | * the chain is written with Chain::write(). |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 888 | * - When you pass an object to Iterator::set_block(), |
| 889 | * Iterator::insert_block_before(), or |
| 890 | * Iterator::insert_block_after(), the iterator takes |
Josh Coalson | 8b9a477 | 2002-12-28 07:03:26 +0000 | [diff] [blame] | 891 | * ownership of the block and it will be deleted by the |
Josh Coalson | 4dc3507 | 2002-08-20 03:56:52 +0000 | [diff] [blame] | 892 | * chain. |
| 893 | * |
| 894 | * See the \link flac_metadata_level2 C layer equivalent \endlink |
| 895 | * for more. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 896 | * |
| 897 | * \{ |
| 898 | */ |
| 899 | |
Josh Coalson | 402da70 | 2002-08-21 03:40:11 +0000 | [diff] [blame] | 900 | /** This class is a wrapper around the FLAC__metadata_chain |
| 901 | * structures and methods; see ::FLAC__Metadata_Chain. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 902 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 903 | class FLACPP_API Chain { |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 904 | public: |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 905 | class FLACPP_API Status { |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 906 | public: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 907 | inline Status(::FLAC__Metadata_ChainStatus status): status_(status) { } |
| 908 | inline operator ::FLAC__Metadata_ChainStatus() const { return status_; } |
| 909 | inline const char *as_cstring() const { return ::FLAC__Metadata_ChainStatusString[status_]; } |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 910 | protected: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 911 | ::FLAC__Metadata_ChainStatus status_; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 912 | }; |
| 913 | |
| 914 | Chain(); |
| 915 | virtual ~Chain(); |
| 916 | |
| 917 | friend class Iterator; |
| 918 | |
| 919 | bool is_valid() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 920 | Status status(); |
| 921 | |
| 922 | bool read(const char *filename); |
Josh Coalson | deab462 | 2004-07-15 16:22:43 +0000 | [diff] [blame] | 923 | bool read(FLAC__IOHandle handle, FLAC__IOCallbacks callbacks); |
| 924 | |
| 925 | bool check_if_tempfile_needed(bool use_padding); |
| 926 | |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 927 | bool write(bool use_padding = true, bool preserve_file_stats = false); |
Josh Coalson | deab462 | 2004-07-15 16:22:43 +0000 | [diff] [blame] | 928 | bool write(bool use_padding, ::FLAC__IOHandle handle, ::FLAC__IOCallbacks callbacks); |
| 929 | bool write(bool use_padding, ::FLAC__IOHandle handle, ::FLAC__IOCallbacks callbacks, ::FLAC__IOHandle temp_handle, ::FLAC__IOCallbacks temp_callbacks); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 930 | |
| 931 | void merge_padding(); |
| 932 | void sort_padding(); |
| 933 | |
| 934 | protected: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 935 | ::FLAC__Metadata_Chain *chain_; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 936 | virtual void clear(); |
| 937 | }; |
| 938 | |
Josh Coalson | 402da70 | 2002-08-21 03:40:11 +0000 | [diff] [blame] | 939 | /** This class is a wrapper around the FLAC__metadata_iterator |
| 940 | * structures and methods; see ::FLAC__Metadata_Iterator. |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 941 | */ |
Josh Coalson | 55bc587 | 2002-10-16 22:18:32 +0000 | [diff] [blame] | 942 | class FLACPP_API Iterator { |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 943 | public: |
| 944 | Iterator(); |
| 945 | virtual ~Iterator(); |
| 946 | |
| 947 | bool is_valid() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 948 | |
Josh Coalson | 999be3b | 2002-06-10 04:42:35 +0000 | [diff] [blame] | 949 | void init(Chain &chain); |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 950 | |
| 951 | bool next(); |
| 952 | bool prev(); |
| 953 | |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 954 | ::FLAC__MetadataType get_block_type() const; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 955 | Prototype *get_block(); |
| 956 | bool set_block(Prototype *block); |
| 957 | bool delete_block(bool replace_with_padding); |
| 958 | bool insert_block_before(Prototype *block); |
| 959 | bool insert_block_after(Prototype *block); |
| 960 | |
| 961 | protected: |
Josh Coalson | cc68251 | 2002-06-08 04:53:42 +0000 | [diff] [blame] | 962 | ::FLAC__Metadata_Iterator *iterator_; |
Josh Coalson | fb74f10 | 2002-05-22 05:33:29 +0000 | [diff] [blame] | 963 | virtual void clear(); |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 964 | }; |
| 965 | |
Josh Coalson | f6efd9c | 2002-07-27 04:59:54 +0000 | [diff] [blame] | 966 | /* \} */ |
| 967 | |
Josh Coalson | fda98fb | 2002-05-17 06:33:39 +0000 | [diff] [blame] | 968 | }; |
| 969 | }; |
| 970 | |
| 971 | #endif |