add FLAC__metadata_get_tags(), FLAC::Metadata::get_tags()
[platform/upstream/flac.git] / src / libFLAC++ / metadata.cpp
1 /* libFLAC++ - Free Lossless Audio Codec library
2  * Copyright (C) 2002,2003,2004  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
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.
30  */
31
32 #include "FLAC++/metadata.h"
33 #include "FLAC/assert.h"
34 #include <stdlib.h> // for malloc(), free()
35 #include <string.h> // for memcpy() etc.
36
37 #ifdef _MSC_VER
38 // warning C4800: 'int' : forcing to bool 'true' or 'false' (performance warning)
39 #pragma warning ( disable : 4800 )
40 #endif
41
42 namespace FLAC {
43         namespace Metadata {
44
45                 // local utility routines
46
47                 namespace local {
48
49                         Prototype *construct_block(::FLAC__StreamMetadata *object)
50                         {
51                                 Prototype *ret = 0;
52                                 switch(object->type) {
53                                         case FLAC__METADATA_TYPE_STREAMINFO:
54                                                 ret = new StreamInfo(object, /*copy=*/false);
55                                                 break;
56                                         case FLAC__METADATA_TYPE_PADDING:
57                                                 ret = new Padding(object, /*copy=*/false);
58                                                 break;
59                                         case FLAC__METADATA_TYPE_APPLICATION:
60                                                 ret = new Application(object, /*copy=*/false);
61                                                 break;
62                                         case FLAC__METADATA_TYPE_SEEKTABLE:
63                                                 ret = new SeekTable(object, /*copy=*/false);
64                                                 break;
65                                         case FLAC__METADATA_TYPE_VORBIS_COMMENT:
66                                                 ret = new VorbisComment(object, /*copy=*/false);
67                                                 break;
68                                         case FLAC__METADATA_TYPE_CUESHEET:
69                                                 ret = new CueSheet(object, /*copy=*/false);
70                                                 break;
71                                         default:
72                                                 ret = new Unknown(object, /*copy=*/false);
73                                                 break;
74                                 }
75                                 return ret;
76                         }
77
78                 };
79
80                 FLACPP_API Prototype *clone(const Prototype *object)
81                 {
82                         FLAC__ASSERT(0 != object);
83
84                         const StreamInfo *streaminfo = dynamic_cast<const StreamInfo *>(object);
85                         const Padding *padding = dynamic_cast<const Padding *>(object);
86                         const Application *application = dynamic_cast<const Application *>(object);
87                         const SeekTable *seektable = dynamic_cast<const SeekTable *>(object);
88                         const VorbisComment *vorbiscomment = dynamic_cast<const VorbisComment *>(object);
89                         const CueSheet *cuesheet = dynamic_cast<const CueSheet *>(object);
90                         const Unknown *unknown = dynamic_cast<const Unknown *>(object);
91
92                         if(0 != streaminfo)
93                                 return new StreamInfo(*streaminfo);
94                         else if(0 != padding)
95                                 return new Padding(*padding);
96                         else if(0 != application)
97                                 return new Application(*application);
98                         else if(0 != seektable)
99                                 return new SeekTable(*seektable);
100                         else if(0 != vorbiscomment)
101                                 return new VorbisComment(*vorbiscomment);
102                         else if(0 != cuesheet)
103                                 return new CueSheet(*cuesheet);
104                         else if(0 != unknown)
105                                 return new Unknown(*unknown);
106                         else {
107                                 FLAC__ASSERT(0);
108                                 return 0;
109                         }
110                 }
111
112                 //
113                 // Prototype
114                 //
115
116                 Prototype::Prototype(const Prototype &object):
117                 object_(::FLAC__metadata_object_clone(object.object_)),
118                 is_reference_(false)
119                 {
120                         FLAC__ASSERT(object.is_valid());
121                 }
122
123                 Prototype::Prototype(const ::FLAC__StreamMetadata &object):
124                 object_(::FLAC__metadata_object_clone(&object)),
125                 is_reference_(false)
126                 {
127                 }
128
129                 Prototype::Prototype(const ::FLAC__StreamMetadata *object):
130                 object_(::FLAC__metadata_object_clone(object)),
131                 is_reference_(false)
132                 {
133                         FLAC__ASSERT(0 != object);
134                 }
135
136                 Prototype::Prototype(::FLAC__StreamMetadata *object, bool copy):
137                 object_(copy? ::FLAC__metadata_object_clone(object) : object),
138                 is_reference_(false)
139                 {
140                         FLAC__ASSERT(0 != object);
141                 }
142
143                 Prototype::~Prototype()
144                 {
145                         clear();
146                 }
147
148                 void Prototype::clear()
149                 {
150                         if(0 != object_ && !is_reference_)
151                                 FLAC__metadata_object_delete(object_);
152                         object_ = 0;
153                 }
154
155                 void Prototype::operator=(const Prototype &object)
156                 {
157                         FLAC__ASSERT(object.is_valid());
158                         clear();
159                         is_reference_ = false;
160                         object_ = ::FLAC__metadata_object_clone(object.object_);
161                 }
162
163                 void Prototype::operator=(const ::FLAC__StreamMetadata &object)
164                 {
165                         clear();
166                         is_reference_ = false;
167                         object_ = ::FLAC__metadata_object_clone(&object);
168                 }
169
170                 void Prototype::operator=(const ::FLAC__StreamMetadata *object)
171                 {
172                         FLAC__ASSERT(0 != object);
173                         clear();
174                         is_reference_ = false;
175                         object_ = ::FLAC__metadata_object_clone(object);
176                 }
177
178                 bool Prototype::get_is_last() const
179                 {
180                         FLAC__ASSERT(is_valid());
181                         return (bool)object_->is_last;
182                 }
183
184                 FLAC__MetadataType Prototype::get_type() const
185                 {
186                         FLAC__ASSERT(is_valid());
187                         return object_->type;
188                 }
189
190                 unsigned Prototype::get_length() const
191                 {
192                         FLAC__ASSERT(is_valid());
193                         return object_->length;
194                 }
195
196                 void Prototype::set_is_last(bool value)
197                 {
198                         FLAC__ASSERT(is_valid());
199                         object_->is_last = value;
200                 }
201
202
203                 //
204                 // StreamInfo
205                 //
206
207                 StreamInfo::StreamInfo():
208                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_STREAMINFO), /*copy=*/false)
209                 { }
210
211                 StreamInfo::~StreamInfo()
212                 { }
213
214                 unsigned StreamInfo::get_min_blocksize() const
215                 {
216                         FLAC__ASSERT(is_valid());
217                         return object_->data.stream_info.min_blocksize;
218                 }
219
220                 unsigned StreamInfo::get_max_blocksize() const
221                 {
222                         FLAC__ASSERT(is_valid());
223                         return object_->data.stream_info.max_blocksize;
224                 }
225
226                 unsigned StreamInfo::get_min_framesize() const
227                 {
228                         FLAC__ASSERT(is_valid());
229                         return object_->data.stream_info.min_framesize;
230                 }
231
232                 unsigned StreamInfo::get_max_framesize() const
233                 {
234                         FLAC__ASSERT(is_valid());
235                         return object_->data.stream_info.max_framesize;
236                 }
237
238                 unsigned StreamInfo::get_sample_rate() const
239                 {
240                         FLAC__ASSERT(is_valid());
241                         return object_->data.stream_info.sample_rate;
242                 }
243
244                 unsigned StreamInfo::get_channels() const
245                 {
246                         FLAC__ASSERT(is_valid());
247                         return object_->data.stream_info.channels;
248                 }
249
250                 unsigned StreamInfo::get_bits_per_sample() const
251                 {
252                         FLAC__ASSERT(is_valid());
253                         return object_->data.stream_info.bits_per_sample;
254                 }
255
256                 FLAC__uint64 StreamInfo::get_total_samples() const
257                 {
258                         FLAC__ASSERT(is_valid());
259                         return object_->data.stream_info.total_samples;
260                 }
261
262                 const FLAC__byte *StreamInfo::get_md5sum() const
263                 {
264                         FLAC__ASSERT(is_valid());
265                         return object_->data.stream_info.md5sum;
266                 }
267
268                 void StreamInfo::set_min_blocksize(unsigned value)
269                 {
270                         FLAC__ASSERT(is_valid());
271                         FLAC__ASSERT(value >= FLAC__MIN_BLOCK_SIZE);
272                         FLAC__ASSERT(value <= FLAC__MAX_BLOCK_SIZE);
273                         object_->data.stream_info.min_blocksize = value;
274                 }
275
276                 void StreamInfo::set_max_blocksize(unsigned value)
277                 {
278                         FLAC__ASSERT(is_valid());
279                         FLAC__ASSERT(value >= FLAC__MIN_BLOCK_SIZE);
280                         FLAC__ASSERT(value <= FLAC__MAX_BLOCK_SIZE);
281                         object_->data.stream_info.max_blocksize = value;
282                 }
283
284                 void StreamInfo::set_min_framesize(unsigned value)
285                 {
286                         FLAC__ASSERT(is_valid());
287                         FLAC__ASSERT(value < (1u < FLAC__STREAM_METADATA_STREAMINFO_MIN_FRAME_SIZE_LEN));
288                         object_->data.stream_info.min_framesize = value;
289                 }
290
291                 void StreamInfo::set_max_framesize(unsigned value)
292                 {
293                         FLAC__ASSERT(is_valid());
294                         FLAC__ASSERT(value < (1u < FLAC__STREAM_METADATA_STREAMINFO_MAX_FRAME_SIZE_LEN));
295                         object_->data.stream_info.max_framesize = value;
296                 }
297
298                 void StreamInfo::set_sample_rate(unsigned value)
299                 {
300                         FLAC__ASSERT(is_valid());
301                         FLAC__ASSERT(FLAC__format_sample_rate_is_valid(value));
302                         object_->data.stream_info.sample_rate = value;
303                 }
304
305                 void StreamInfo::set_channels(unsigned value)
306                 {
307                         FLAC__ASSERT(is_valid());
308                         FLAC__ASSERT(value > 0);
309                         FLAC__ASSERT(value <= FLAC__MAX_CHANNELS);
310                         object_->data.stream_info.channels = value;
311                 }
312
313                 void StreamInfo::set_bits_per_sample(unsigned value)
314                 {
315                         FLAC__ASSERT(is_valid());
316                         FLAC__ASSERT(value >= FLAC__MIN_BITS_PER_SAMPLE);
317                         FLAC__ASSERT(value <= FLAC__MAX_BITS_PER_SAMPLE);
318                         object_->data.stream_info.bits_per_sample = value;
319                 }
320
321                 void StreamInfo::set_total_samples(FLAC__uint64 value)
322                 {
323                         FLAC__ASSERT(is_valid());
324                         FLAC__ASSERT(value < (1u << FLAC__STREAM_METADATA_STREAMINFO_TOTAL_SAMPLES_LEN));
325                         object_->data.stream_info.total_samples = value;
326                 }
327
328                 void StreamInfo::set_md5sum(const FLAC__byte value[16])
329                 {
330                         FLAC__ASSERT(is_valid());
331                         FLAC__ASSERT(0 != value);
332                         memcpy(object_->data.stream_info.md5sum, value, 16);
333                 }
334
335
336                 //
337                 // Padding
338                 //
339
340                 Padding::Padding():
341                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_PADDING), /*copy=*/false)
342                 { }
343
344                 Padding::~Padding()
345                 { }
346
347                 void Padding::set_length(unsigned length)
348                 {
349                         FLAC__ASSERT(is_valid());
350                         object_->length = length;
351                 }
352
353
354                 //
355                 // Application
356                 //
357
358                 Application::Application():
359                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_APPLICATION), /*copy=*/false)
360                 { }
361
362                 Application::~Application()
363                 { }
364
365                 const FLAC__byte *Application::get_id() const
366                 {
367                         FLAC__ASSERT(is_valid());
368                         return object_->data.application.id;
369                 }
370
371                 const FLAC__byte *Application::get_data() const
372                 {
373                         FLAC__ASSERT(is_valid());
374                         return object_->data.application.data;
375                 }
376
377                 void Application::set_id(const FLAC__byte value[4])
378                 {
379                         FLAC__ASSERT(is_valid());
380                         FLAC__ASSERT(0 != value);
381                         memcpy(object_->data.application.id, value, 4);
382                 }
383
384                 bool Application::set_data(const FLAC__byte *data, unsigned length)
385                 {
386                         FLAC__ASSERT(is_valid());
387                         return (bool)::FLAC__metadata_object_application_set_data(object_, (FLAC__byte*)data, length, true);
388                 }
389
390                 bool Application::set_data(FLAC__byte *data, unsigned length, bool copy)
391                 {
392                         FLAC__ASSERT(is_valid());
393                         return (bool)::FLAC__metadata_object_application_set_data(object_, data, length, copy);
394                 }
395
396
397                 //
398                 // SeekTable
399                 //
400
401                 SeekTable::SeekTable():
402                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_SEEKTABLE), /*copy=*/false)
403                 { }
404
405                 SeekTable::~SeekTable()
406                 { }
407
408                 unsigned SeekTable::get_num_points() const
409                 {
410                         FLAC__ASSERT(is_valid());
411                         return object_->data.seek_table.num_points;
412                 }
413
414                 ::FLAC__StreamMetadata_SeekPoint SeekTable::get_point(unsigned index) const
415                 {
416                         FLAC__ASSERT(is_valid());
417                         FLAC__ASSERT(index < object_->data.seek_table.num_points);
418                         return object_->data.seek_table.points[index];
419                 }
420
421                 void SeekTable::set_point(unsigned index, const ::FLAC__StreamMetadata_SeekPoint &point)
422                 {
423                         FLAC__ASSERT(is_valid());
424                         FLAC__ASSERT(index < object_->data.seek_table.num_points);
425                         ::FLAC__metadata_object_seektable_set_point(object_, index, point);
426                 }
427
428                 bool SeekTable::insert_point(unsigned index, const ::FLAC__StreamMetadata_SeekPoint &point)
429                 {
430                         FLAC__ASSERT(is_valid());
431                         FLAC__ASSERT(index <= object_->data.seek_table.num_points);
432                         return (bool)::FLAC__metadata_object_seektable_insert_point(object_, index, point);
433                 }
434
435                 bool SeekTable::delete_point(unsigned index)
436                 {
437                         FLAC__ASSERT(is_valid());
438                         FLAC__ASSERT(index < object_->data.seek_table.num_points);
439                         return (bool)::FLAC__metadata_object_seektable_delete_point(object_, index);
440                 }
441
442                 bool SeekTable::is_legal() const
443                 {
444                         FLAC__ASSERT(is_valid());
445                         return (bool)::FLAC__metadata_object_seektable_is_legal(object_);
446                 }
447
448
449                 //
450                 // VorbisComment::Entry
451                 //
452
453                 VorbisComment::Entry::Entry()
454                 {
455                         zero();
456                 }
457
458                 VorbisComment::Entry::Entry(const char *field, unsigned field_length)
459                 {
460                         zero();
461                         construct(field, field_length);
462                 }
463
464                 VorbisComment::Entry::Entry(const char *field_name, const char *field_value, unsigned field_value_length)
465                 {
466                         zero();
467                         construct(field_name, field_value, field_value_length);
468                 }
469
470                 VorbisComment::Entry::Entry(const Entry &entry)
471                 {
472                         FLAC__ASSERT(entry.is_valid());
473                         zero();
474                         construct((const char *)entry.entry_.entry, entry.entry_.length);
475                 }
476
477                 void VorbisComment::Entry::operator=(const Entry &entry)
478                 {
479                         FLAC__ASSERT(entry.is_valid());
480                         clear();
481                         construct((const char *)entry.entry_.entry, entry.entry_.length);
482                 }
483
484                 VorbisComment::Entry::~Entry()
485                 {
486                         clear();
487                 }
488
489                 bool VorbisComment::Entry::is_valid() const
490                 {
491                         return is_valid_;
492                 }
493
494                 unsigned VorbisComment::Entry::get_field_length() const
495                 {
496                         FLAC__ASSERT(is_valid());
497                         return entry_.length;
498                 }
499
500                 unsigned VorbisComment::Entry::get_field_name_length() const
501                 {
502                         FLAC__ASSERT(is_valid());
503                         return field_name_length_;
504                 }
505
506                 unsigned VorbisComment::Entry::get_field_value_length() const
507                 {
508                         FLAC__ASSERT(is_valid());
509                         return field_value_length_;
510                 }
511
512                 ::FLAC__StreamMetadata_VorbisComment_Entry VorbisComment::Entry::get_entry() const
513                 {
514                         FLAC__ASSERT(is_valid());
515                         return entry_;
516                 }
517
518                 const char *VorbisComment::Entry::get_field() const
519                 {
520                         FLAC__ASSERT(is_valid());
521                         return (const char *)entry_.entry;
522                 }
523
524                 const char *VorbisComment::Entry::get_field_name() const
525                 {
526                         FLAC__ASSERT(is_valid());
527                         return field_name_;
528                 }
529
530                 const char *VorbisComment::Entry::get_field_value() const
531                 {
532                         FLAC__ASSERT(is_valid());
533                         return field_value_;
534                 }
535
536                 bool VorbisComment::Entry::set_field(const char *field, unsigned field_length)
537                 {
538                         FLAC__ASSERT(is_valid());
539                         FLAC__ASSERT(0 != field);
540
541                         clear_entry();
542
543                         if(0 == (entry_.entry = (FLAC__byte*)malloc(field_length))) {
544                                 is_valid_ = false;
545                         }
546                         else {
547                                 entry_.length = field_length;
548                                 memcpy(entry_.entry, field, field_length);
549                                 (void) parse_field();
550                         }
551
552                         return is_valid_;
553                 }
554
555                 bool VorbisComment::Entry::set_field_name(const char *field_name)
556                 {
557                         FLAC__ASSERT(is_valid());
558                         FLAC__ASSERT(0 != field_name);
559
560                         clear_field_name();
561
562                         if(0 == (field_name_ = strdup(field_name))) {
563                                 is_valid_ = false;
564                         }
565                         else {
566                                 field_name_length_ = strlen(field_name_);
567                                 compose_field();
568                         }
569
570                         return is_valid_;
571                 }
572
573                 bool VorbisComment::Entry::set_field_value(const char *field_value, unsigned field_value_length)
574                 {
575                         FLAC__ASSERT(is_valid());
576                         FLAC__ASSERT(0 != field_value);
577
578                         clear_field_value();
579
580                         if(0 == (field_value_ = (char *)malloc(field_value_length))) {
581                                 is_valid_ = false;
582                         }
583                         else {
584                                 field_value_length_ = field_value_length;
585                                 memcpy(field_value_, field_value, field_value_length);
586                                 compose_field();
587                         }
588
589                         return is_valid_;
590                 }
591
592                 void VorbisComment::Entry::zero()
593                 {
594                         is_valid_ = true;
595                         entry_.length = 0;
596                         entry_.entry = 0;
597                         field_name_ = 0;
598                         field_name_length_ = 0;
599                         field_value_ = 0;
600                         field_value_length_ = 0;
601                 }
602
603                 void VorbisComment::Entry::clear()
604                 {
605                         clear_entry();
606                         clear_field_name();
607                         clear_field_value();
608                         is_valid_ = true;
609                 }
610
611                 void VorbisComment::Entry::clear_entry()
612                 {
613                         if(0 != entry_.entry) {
614                                 free(entry_.entry);
615                                 entry_.entry = 0;
616                                 entry_.length = 0;
617                         }
618                 }
619
620                 void VorbisComment::Entry::clear_field_name()
621                 {
622                         if(0 != field_name_) {
623                                 free(field_name_);
624                                 field_name_ = 0;
625                                 field_name_length_ = 0;
626                         }
627                 }
628
629                 void VorbisComment::Entry::clear_field_value()
630                 {
631                         if(0 != field_value_) {
632                                 free(field_value_);
633                                 field_value_ = 0;
634                                 field_value_length_ = 0;
635                         }
636                 }
637
638                 void VorbisComment::Entry::construct(const char *field, unsigned field_length)
639                 {
640                         if(set_field(field, field_length))
641                                 parse_field();
642                 }
643
644                 void VorbisComment::Entry::construct(const char *field_name, const char *field_value, unsigned field_value_length)
645                 {
646                         if(set_field_name(field_name) && set_field_value(field_value, field_value_length))
647                                 compose_field();
648                 }
649
650                 void VorbisComment::Entry::compose_field()
651                 {
652                         clear_entry();
653
654                         if(0 == (entry_.entry = (FLAC__byte*)malloc(field_name_length_ + 1 + field_value_length_))) {
655                                 is_valid_ = false;
656                         }
657                         else {
658                                 memcpy(entry_.entry, field_name_, field_name_length_);
659                                 entry_.length += field_name_length_;
660                                 memcpy(entry_.entry + entry_.length, "=", 1);
661                                 entry_.length += 1;
662                                 memcpy(entry_.entry + entry_.length, field_value_, field_value_length_);
663                                 entry_.length += field_value_length_;
664                                 is_valid_ = true;
665                         }
666                 }
667
668                 void VorbisComment::Entry::parse_field()
669                 {
670                         clear_field_name();
671                         clear_field_value();
672
673                         const char *p = (const char *)memchr(entry_.entry, '=', entry_.length);
674
675                         if(0 == p)
676                                 p = (const char *)entry_.entry + entry_.length;
677
678                         field_name_length_ = p - (const char *)entry_.entry;
679                         if(0 == (field_name_ = (char *)malloc(field_name_length_ + 1))) { // +1 for the trailing \0
680                                 is_valid_ = false;
681                                 return;
682                         }
683                         memcpy(field_name_, entry_.entry, field_name_length_);
684                         field_name_[field_name_length_] = '\0';
685
686                         if(entry_.length - field_name_length_ == 0) {
687                                 field_value_length_ = 0;
688                                 if(0 == (field_value_ = (char *)malloc(0))) {
689                                         is_valid_ = false;
690                                         return;
691                                 }
692                         }
693                         else {
694                                 field_value_length_ = entry_.length - field_name_length_ - 1;
695                                 if(0 == (field_value_ = (char *)malloc(field_value_length_))) {
696                                         is_valid_ = false;
697                                         return;
698                                 }
699                                 memcpy(field_value_, ++p, field_value_length_);
700                         }
701
702                         is_valid_ = true;
703                 }
704
705
706                 //
707                 // VorbisComment
708                 //
709
710                 VorbisComment::VorbisComment():
711                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_VORBIS_COMMENT), /*copy=*/false)
712                 { }
713
714                 VorbisComment::~VorbisComment()
715                 { }
716
717                 unsigned VorbisComment::get_num_comments() const
718                 {
719                         FLAC__ASSERT(is_valid());
720                         return object_->data.vorbis_comment.num_comments;
721                 }
722
723                 VorbisComment::Entry VorbisComment::get_vendor_string() const
724                 {
725                         FLAC__ASSERT(is_valid());
726                         return Entry((const char *)object_->data.vorbis_comment.vendor_string.entry, object_->data.vorbis_comment.vendor_string.length);
727                 }
728
729                 VorbisComment::Entry VorbisComment::get_comment(unsigned index) const
730                 {
731                         FLAC__ASSERT(is_valid());
732                         FLAC__ASSERT(index < object_->data.vorbis_comment.num_comments);
733                         return Entry((const char *)object_->data.vorbis_comment.comments[index].entry, object_->data.vorbis_comment.comments[index].length);
734                 }
735
736                 bool VorbisComment::set_vendor_string(const VorbisComment::Entry &entry)
737                 {
738                         FLAC__ASSERT(is_valid());
739                         // vendor_string is a special kind of entry
740                         ::FLAC__StreamMetadata_VorbisComment_Entry vendor_string;
741                         vendor_string.length = entry.get_field_name_length();
742                         vendor_string.entry = (FLAC__byte*)entry.get_field_name(); // we can cheat on const-ness because we make a copy below:
743                         return (bool)::FLAC__metadata_object_vorbiscomment_set_vendor_string(object_, vendor_string, /*copy=*/true);
744                 }
745
746                 bool VorbisComment::set_comment(unsigned index, const VorbisComment::Entry &entry)
747                 {
748                         FLAC__ASSERT(is_valid());
749                         FLAC__ASSERT(index < object_->data.vorbis_comment.num_comments);
750                         return (bool)::FLAC__metadata_object_vorbiscomment_set_comment(object_, index, entry.get_entry(), /*copy=*/true);
751                 }
752
753                 bool VorbisComment::insert_comment(unsigned index, const VorbisComment::Entry &entry)
754                 {
755                         FLAC__ASSERT(is_valid());
756                         FLAC__ASSERT(index <= object_->data.vorbis_comment.num_comments);
757                         return (bool)::FLAC__metadata_object_vorbiscomment_insert_comment(object_, index, entry.get_entry(), /*copy=*/true);
758                 }
759
760                 bool VorbisComment::delete_comment(unsigned index)
761                 {
762                         FLAC__ASSERT(is_valid());
763                         FLAC__ASSERT(index < object_->data.vorbis_comment.num_comments);
764                         return (bool)::FLAC__metadata_object_vorbiscomment_delete_comment(object_, index);
765                 }
766
767
768                 //
769                 // CueSheet::Track
770                 //
771
772                 CueSheet::Track::Track():
773                 object_(::FLAC__metadata_object_cuesheet_track_new())
774                 { }
775
776                 CueSheet::Track::Track(const ::FLAC__StreamMetadata_CueSheet_Track *track):
777                 object_(::FLAC__metadata_object_cuesheet_track_clone(track))
778                 { }
779
780                 CueSheet::Track::Track(const Track &track):
781                 object_(::FLAC__metadata_object_cuesheet_track_clone(track.object_))
782                 { }
783
784                 void CueSheet::Track::operator=(const Track &track)
785                 {
786                         if(0 != object_)
787                                 ::FLAC__metadata_object_cuesheet_track_delete(object_);
788                         object_ = ::FLAC__metadata_object_cuesheet_track_clone(track.object_);
789                 }
790
791                 CueSheet::Track::~Track()
792                 {
793                         if(0 != object_)
794                                 ::FLAC__metadata_object_cuesheet_track_delete(object_);
795                 }
796
797                 bool CueSheet::Track::is_valid() const
798                 {
799                         return(0 != object_);
800                 }
801
802                 ::FLAC__StreamMetadata_CueSheet_Index CueSheet::Track::get_index(unsigned i) const
803                 {
804                         FLAC__ASSERT(is_valid());
805                         FLAC__ASSERT(i < object_->num_indices);
806                         return object_->indices[i];
807                 }
808
809                 void CueSheet::Track::set_isrc(const char value[12])
810                 {
811                         FLAC__ASSERT(is_valid());
812                         FLAC__ASSERT(0 != value);
813                         memcpy(object_->isrc, value, 12);
814                         object_->isrc[12] = '\0';
815                 }
816
817                 void CueSheet::Track::set_type(unsigned value)
818                 {
819                         FLAC__ASSERT(is_valid());
820                         FLAC__ASSERT(value <= 1);
821                         object_->type = value;
822                 }
823
824                 void CueSheet::Track::set_index(unsigned i, const ::FLAC__StreamMetadata_CueSheet_Index &index)
825                 {
826                         FLAC__ASSERT(is_valid());
827                         FLAC__ASSERT(i < object_->num_indices);
828                         object_->indices[i] = index;
829                 }
830
831
832                 //
833                 // CueSheet
834                 //
835
836                 CueSheet::CueSheet():
837                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_CUESHEET), /*copy=*/false)
838                 { }
839
840                 CueSheet::~CueSheet()
841                 { }
842
843                 const char *CueSheet::get_media_catalog_number() const
844                 {
845                         FLAC__ASSERT(is_valid());
846                         return object_->data.cue_sheet.media_catalog_number;
847                 }
848
849                 FLAC__uint64 CueSheet::get_lead_in() const
850                 {
851                         FLAC__ASSERT(is_valid());
852                         return object_->data.cue_sheet.lead_in;
853                 }
854
855                 bool CueSheet::get_is_cd() const
856                 {
857                         FLAC__ASSERT(is_valid());
858                         return object_->data.cue_sheet.is_cd? true : false;
859                 }
860
861                 unsigned CueSheet::get_num_tracks() const
862                 {
863                         FLAC__ASSERT(is_valid());
864                         return object_->data.cue_sheet.num_tracks;
865                 }
866
867                 CueSheet::Track CueSheet::get_track(unsigned i) const
868                 {
869                         FLAC__ASSERT(is_valid());
870                         FLAC__ASSERT(i < object_->data.cue_sheet.num_tracks);
871                         return Track(object_->data.cue_sheet.tracks + i);
872                 }
873
874                 void CueSheet::set_media_catalog_number(const char value[128])
875                 {
876                         FLAC__ASSERT(is_valid());
877                         FLAC__ASSERT(0 != value);
878                         memcpy(object_->data.cue_sheet.media_catalog_number, value, 128);
879                         object_->data.cue_sheet.media_catalog_number[128] = '\0';
880                 }
881
882                 void CueSheet::set_lead_in(FLAC__uint64 value)
883                 {
884                         FLAC__ASSERT(is_valid());
885                         object_->data.cue_sheet.lead_in = value;
886                 }
887
888                 void CueSheet::set_is_cd(bool value)
889                 {
890                         FLAC__ASSERT(is_valid());
891                         object_->data.cue_sheet.is_cd = value;
892                 }
893
894                 void CueSheet::set_index(unsigned track_num, unsigned index_num, const ::FLAC__StreamMetadata_CueSheet_Index &index)
895                 {
896                         FLAC__ASSERT(is_valid());
897                         FLAC__ASSERT(track_num < object_->data.cue_sheet.num_tracks);
898                         FLAC__ASSERT(index_num < object_->data.cue_sheet.tracks[track_num].num_indices);
899                         object_->data.cue_sheet.tracks[track_num].indices[index_num] = index;
900                 }
901
902                 bool CueSheet::insert_index(unsigned track_num, unsigned index_num, const ::FLAC__StreamMetadata_CueSheet_Index &index)
903                 {
904                         FLAC__ASSERT(is_valid());
905                         FLAC__ASSERT(track_num < object_->data.cue_sheet.num_tracks);
906                         FLAC__ASSERT(index_num <= object_->data.cue_sheet.tracks[track_num].num_indices);
907                         return (bool)::FLAC__metadata_object_cuesheet_track_insert_index(object_, track_num, index_num, index);
908                 }
909
910                 bool CueSheet::delete_index(unsigned track_num, unsigned index_num)
911                 {
912                         FLAC__ASSERT(is_valid());
913                         FLAC__ASSERT(track_num < object_->data.cue_sheet.num_tracks);
914                         FLAC__ASSERT(index_num < object_->data.cue_sheet.tracks[track_num].num_indices);
915                         return (bool)::FLAC__metadata_object_cuesheet_track_delete_index(object_, track_num, index_num);
916                 }
917
918                 bool CueSheet::set_track(unsigned i, const CueSheet::Track &track)
919                 {
920                         FLAC__ASSERT(is_valid());
921                         FLAC__ASSERT(i < object_->data.cue_sheet.num_tracks);
922                         // We can safely const_cast since copy=true
923                         return (bool)::FLAC__metadata_object_cuesheet_set_track(object_, i, const_cast< ::FLAC__StreamMetadata_CueSheet_Track*>(track.get_track()), /*copy=*/true);
924                 }
925
926                 bool CueSheet::insert_track(unsigned i, const CueSheet::Track &track)
927                 {
928                         FLAC__ASSERT(is_valid());
929                         FLAC__ASSERT(i <= object_->data.cue_sheet.num_tracks);
930                         // We can safely const_cast since copy=true
931                         return (bool)::FLAC__metadata_object_cuesheet_insert_track(object_, i, const_cast< ::FLAC__StreamMetadata_CueSheet_Track*>(track.get_track()), /*copy=*/true);
932                 }
933
934                 bool CueSheet::delete_track(unsigned i)
935                 {
936                         FLAC__ASSERT(is_valid());
937                         FLAC__ASSERT(i < object_->data.cue_sheet.num_tracks);
938                         return (bool)::FLAC__metadata_object_cuesheet_delete_track(object_, i);
939                 }
940
941                 bool CueSheet::is_legal(bool check_cd_da_subset, const char **violation) const
942                 {
943                         FLAC__ASSERT(is_valid());
944                         return (bool)::FLAC__metadata_object_cuesheet_is_legal(object_, check_cd_da_subset, violation);
945                 }
946
947
948                 //
949                 // Unknown
950                 //
951
952                 Unknown::Unknown():
953                 Prototype(FLAC__metadata_object_new(FLAC__METADATA_TYPE_APPLICATION), /*copy=*/false)
954                 { }
955
956                 Unknown::~Unknown()
957                 { }
958
959                 const FLAC__byte *Unknown::get_data() const
960                 {
961                         FLAC__ASSERT(is_valid());
962                         return object_->data.application.data;
963                 }
964
965                 bool Unknown::set_data(const FLAC__byte *data, unsigned length)
966                 {
967                         FLAC__ASSERT(is_valid());
968                         return (bool)::FLAC__metadata_object_application_set_data(object_, (FLAC__byte*)data, length, true);
969                 }
970
971                 bool Unknown::set_data(FLAC__byte *data, unsigned length, bool copy)
972                 {
973                         FLAC__ASSERT(is_valid());
974                         return (bool)::FLAC__metadata_object_application_set_data(object_, data, length, copy);
975                 }
976
977
978                 // ============================================================
979                 //
980                 //  Level 0
981                 //
982                 // ============================================================
983
984                 FLACPP_API bool get_streaminfo(const char *filename, StreamInfo &streaminfo)
985                 {
986                         FLAC__ASSERT(0 != filename);
987
988                         ::FLAC__StreamMetadata object;
989
990                         if(::FLAC__metadata_get_streaminfo(filename, &object)) {
991                                 streaminfo = object;
992                                 return true;
993                         }
994                         else
995                                 return false;
996                 }
997
998                 FLACPP_API bool get_tags(const char *filename, VorbisComment *&tags)
999                 {
1000                         FLAC__ASSERT(0 != filename);
1001
1002                         ::FLAC__StreamMetadata *object;
1003
1004                         tags = 0;
1005
1006                         if(::FLAC__metadata_get_tags(filename, &object)) {
1007                                 tags = new VorbisComment(object, /*copy=*/false);
1008                                 return true;
1009                         }
1010                         else
1011                                 return false;
1012                 }
1013
1014
1015                 // ============================================================
1016                 //
1017                 //  Level 1
1018                 //
1019                 // ============================================================
1020
1021                 SimpleIterator::SimpleIterator():
1022                 iterator_(::FLAC__metadata_simple_iterator_new())
1023                 { }
1024
1025                 SimpleIterator::~SimpleIterator()
1026                 {
1027                         clear();
1028                 }
1029
1030                 void SimpleIterator::clear()
1031                 {
1032                         if(0 != iterator_)
1033                                 FLAC__metadata_simple_iterator_delete(iterator_);
1034                         iterator_ = 0;
1035                 }
1036
1037                 bool SimpleIterator::init(const char *filename, bool read_only, bool preserve_file_stats)
1038                 {
1039                         FLAC__ASSERT(0 != filename);
1040                         FLAC__ASSERT(is_valid());
1041                         return (bool)::FLAC__metadata_simple_iterator_init(iterator_, filename, read_only, preserve_file_stats);
1042                 }
1043
1044                 bool SimpleIterator::is_valid() const
1045                 {
1046                         return 0 != iterator_;
1047                 }
1048
1049                 SimpleIterator::Status SimpleIterator::status()
1050                 {
1051                         FLAC__ASSERT(is_valid());
1052                         return Status(::FLAC__metadata_simple_iterator_status(iterator_));
1053                 }
1054
1055                 bool SimpleIterator::is_writable() const
1056                 {
1057                         FLAC__ASSERT(is_valid());
1058                         return (bool)::FLAC__metadata_simple_iterator_is_writable(iterator_);
1059                 }
1060
1061                 bool SimpleIterator::next()
1062                 {
1063                         FLAC__ASSERT(is_valid());
1064                         return (bool)::FLAC__metadata_simple_iterator_next(iterator_);
1065                 }
1066
1067                 bool SimpleIterator::prev()
1068                 {
1069                         FLAC__ASSERT(is_valid());
1070                         return (bool)::FLAC__metadata_simple_iterator_prev(iterator_);
1071                 }
1072
1073                 ::FLAC__MetadataType SimpleIterator::get_block_type() const
1074                 {
1075                         FLAC__ASSERT(is_valid());
1076                         return ::FLAC__metadata_simple_iterator_get_block_type(iterator_);
1077                 }
1078
1079                 Prototype *SimpleIterator::get_block()
1080                 {
1081                         FLAC__ASSERT(is_valid());
1082                         return local::construct_block(::FLAC__metadata_simple_iterator_get_block(iterator_));
1083                 }
1084
1085                 bool SimpleIterator::set_block(Prototype *block, bool use_padding)
1086                 {
1087                         FLAC__ASSERT(0 != block);
1088                         FLAC__ASSERT(is_valid());
1089                         return (bool)::FLAC__metadata_simple_iterator_set_block(iterator_, block->object_, use_padding);
1090                 }
1091
1092                 bool SimpleIterator::insert_block_after(Prototype *block, bool use_padding)
1093                 {
1094                         FLAC__ASSERT(0 != block);
1095                         FLAC__ASSERT(is_valid());
1096                         return (bool)::FLAC__metadata_simple_iterator_insert_block_after(iterator_, block->object_, use_padding);
1097                 }
1098
1099                 bool SimpleIterator::delete_block(bool use_padding)
1100                 {
1101                         FLAC__ASSERT(is_valid());
1102                         return (bool)::FLAC__metadata_simple_iterator_delete_block(iterator_, use_padding);
1103                 }
1104
1105
1106                 // ============================================================
1107                 //
1108                 //  Level 2
1109                 //
1110                 // ============================================================
1111
1112                 Chain::Chain():
1113                 chain_(::FLAC__metadata_chain_new())
1114                 { }
1115
1116                 Chain::~Chain()
1117                 {
1118                         clear();
1119                 }
1120
1121                 void Chain::clear()
1122                 {
1123                         if(0 != chain_)
1124                                 FLAC__metadata_chain_delete(chain_);
1125                         chain_ = 0;
1126                 }
1127
1128                 bool Chain::is_valid() const
1129                 {
1130                         return 0 != chain_;
1131                 }
1132
1133                 Chain::Status Chain::status()
1134                 {
1135                         FLAC__ASSERT(is_valid());
1136                         return Status(::FLAC__metadata_chain_status(chain_));
1137                 }
1138
1139                 bool Chain::read(const char *filename)
1140                 {
1141                         FLAC__ASSERT(0 != filename);
1142                         FLAC__ASSERT(is_valid());
1143                         return (bool)::FLAC__metadata_chain_read(chain_, filename);
1144                 }
1145
1146                 bool Chain::read(FLAC__IOHandle handle, ::FLAC__IOCallbacks callbacks)
1147                 {
1148                         FLAC__ASSERT(is_valid());
1149                         return (bool)::FLAC__metadata_chain_read_with_callbacks(chain_, handle, callbacks);
1150                 }
1151
1152                 bool Chain::check_if_tempfile_needed(bool use_padding)
1153                 {
1154                         FLAC__ASSERT(is_valid());
1155                         return (bool)::FLAC__metadata_chain_check_if_tempfile_needed(chain_, use_padding);
1156                 }
1157
1158                 bool Chain::write(bool use_padding, bool preserve_file_stats)
1159                 {
1160                         FLAC__ASSERT(is_valid());
1161                         return (bool)::FLAC__metadata_chain_write(chain_, use_padding, preserve_file_stats);
1162                 }
1163
1164                 bool Chain::write(bool use_padding, ::FLAC__IOHandle handle, ::FLAC__IOCallbacks callbacks)
1165                 {
1166                         FLAC__ASSERT(is_valid());
1167                         return (bool)::FLAC__metadata_chain_write_with_callbacks(chain_, use_padding, handle, callbacks);
1168                 }
1169
1170                 bool Chain::write(bool use_padding, ::FLAC__IOHandle handle, ::FLAC__IOCallbacks callbacks, ::FLAC__IOHandle temp_handle, ::FLAC__IOCallbacks temp_callbacks)
1171                 {
1172                         FLAC__ASSERT(is_valid());
1173                         return (bool)::FLAC__metadata_chain_write_with_callbacks_and_tempfile(chain_, use_padding, handle, callbacks, temp_handle, temp_callbacks);
1174                 }
1175
1176                 void Chain::merge_padding()
1177                 {
1178                         FLAC__ASSERT(is_valid());
1179                         ::FLAC__metadata_chain_merge_padding(chain_);
1180                 }
1181
1182                 void Chain::sort_padding()
1183                 {
1184                         FLAC__ASSERT(is_valid());
1185                         ::FLAC__metadata_chain_sort_padding(chain_);
1186                 }
1187
1188
1189                 Iterator::Iterator():
1190                 iterator_(::FLAC__metadata_iterator_new())
1191                 { }
1192
1193                 Iterator::~Iterator()
1194                 {
1195                         clear();
1196                 }
1197
1198                 void Iterator::clear()
1199                 {
1200                         if(0 != iterator_)
1201                                 FLAC__metadata_iterator_delete(iterator_);
1202                         iterator_ = 0;
1203                 }
1204
1205                 bool Iterator::is_valid() const
1206                 {
1207                         return 0 != iterator_;
1208                 }
1209
1210                 void Iterator::init(Chain &chain)
1211                 {
1212                         FLAC__ASSERT(is_valid());
1213                         FLAC__ASSERT(chain.is_valid());
1214                         ::FLAC__metadata_iterator_init(iterator_, chain.chain_);
1215                 }
1216
1217                 bool Iterator::next()
1218                 {
1219                         FLAC__ASSERT(is_valid());
1220                         return (bool)::FLAC__metadata_iterator_next(iterator_);
1221                 }
1222
1223                 bool Iterator::prev()
1224                 {
1225                         FLAC__ASSERT(is_valid());
1226                         return (bool)::FLAC__metadata_iterator_prev(iterator_);
1227                 }
1228
1229                 ::FLAC__MetadataType Iterator::get_block_type() const
1230                 {
1231                         FLAC__ASSERT(is_valid());
1232                         return ::FLAC__metadata_iterator_get_block_type(iterator_);
1233                 }
1234
1235                 Prototype *Iterator::get_block()
1236                 {
1237                         FLAC__ASSERT(is_valid());
1238                         Prototype *block = local::construct_block(::FLAC__metadata_iterator_get_block(iterator_));
1239                         if(0 != block)
1240                                 block->set_reference(true);
1241                         return block;
1242                 }
1243
1244                 bool Iterator::set_block(Prototype *block)
1245                 {
1246                         FLAC__ASSERT(0 != block);
1247                         FLAC__ASSERT(is_valid());
1248                         bool ret = (bool)::FLAC__metadata_iterator_set_block(iterator_, block->object_);
1249                         if(ret) {
1250                                 block->set_reference(true);
1251                                 delete block;
1252                         }
1253                         return ret;
1254                 }
1255
1256                 bool Iterator::delete_block(bool replace_with_padding)
1257                 {
1258                         FLAC__ASSERT(is_valid());
1259                         return (bool)::FLAC__metadata_iterator_delete_block(iterator_, replace_with_padding);
1260                 }
1261
1262                 bool Iterator::insert_block_before(Prototype *block)
1263                 {
1264                         FLAC__ASSERT(0 != block);
1265                         FLAC__ASSERT(is_valid());
1266                         bool ret = (bool)::FLAC__metadata_iterator_insert_block_before(iterator_, block->object_);
1267                         if(ret) {
1268                                 block->set_reference(true);
1269                                 delete block;
1270                         }
1271                         return ret;
1272                 }
1273
1274                 bool Iterator::insert_block_after(Prototype *block)
1275                 {
1276                         FLAC__ASSERT(0 != block);
1277                         FLAC__ASSERT(is_valid());
1278                         bool ret = (bool)::FLAC__metadata_iterator_insert_block_after(iterator_, block->object_);
1279                         if(ret) {
1280                                 block->set_reference(true);
1281                                 delete block;
1282                         }
1283                         return ret;
1284                 }
1285
1286         };
1287 };