include/OggFLAC++/decoder.h

Go to the documentation of this file.

/* libOggFLAC++ - Free Lossless Audio Codec + Ogg library
 * Copyright (C) 2002,2003  Josh Coalson
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the Xiph.org Foundation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OggFLACPP__DECODER_H
#define OggFLACPP__DECODER_H

#include "export.h"

#include "OggFLAC/stream_decoder.h"
// we only need this for the state abstraction really...
#include "FLAC++/decoder.h"


namespace OggFLAC {
    namespace Decoder {

        // ============================================================
        //
        //  Equivalent: OggFLAC__StreamDecoder
        //
        // ============================================================

        class OggFLACPP_API Stream {
        public:
            class OggFLACPP_API State {
            public:
                inline State(::OggFLAC__StreamDecoderState state): state_(state) { }
                inline operator ::OggFLAC__StreamDecoderState() const { return state_; }
                inline const char *as_cstring() const { return ::OggFLAC__StreamDecoderStateString[state_]; }
            protected:
                ::OggFLAC__StreamDecoderState state_;
            };

            Stream();
            virtual ~Stream();

            bool is_valid() const;
            inline operator bool() const { return is_valid(); }

            bool set_serial_number(long value);
            bool set_metadata_respond(::FLAC__MetadataType type);
            bool set_metadata_respond_application(const FLAC__byte id[4]);
            bool set_metadata_respond_all();
            bool set_metadata_ignore(::FLAC__MetadataType type);
            bool set_metadata_ignore_application(const FLAC__byte id[4]);
            bool set_metadata_ignore_all();

            State get_state() const;
            FLAC::Decoder::Stream::State get_FLAC_stream_decoder_state() const;
            unsigned get_channels() const;
            ::FLAC__ChannelAssignment get_channel_assignment() const;
            unsigned get_bits_per_sample() const;
            unsigned get_sample_rate() const;
            unsigned get_blocksize() const;

            State init();

            void finish();

            bool flush();
            bool reset();

            bool process_single();
            bool process_until_end_of_metadata();
            bool process_until_end_of_stream();
        protected:
            virtual ::FLAC__StreamDecoderReadStatus read_callback(FLAC__byte buffer[], unsigned *bytes) = 0;
            virtual ::FLAC__StreamDecoderWriteStatus write_callback(const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[]) = 0;
            virtual void metadata_callback(const ::FLAC__StreamMetadata *metadata) = 0;
            virtual void error_callback(::FLAC__StreamDecoderErrorStatus status) = 0;

            ::OggFLAC__StreamDecoder *decoder_;
        private:
            static ::FLAC__StreamDecoderReadStatus read_callback_(const ::OggFLAC__StreamDecoder *decoder, FLAC__byte buffer[], unsigned *bytes, void *client_data);
            static ::FLAC__StreamDecoderWriteStatus write_callback_(const ::OggFLAC__StreamDecoder *decoder, const ::FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
            static void metadata_callback_(const ::OggFLAC__StreamDecoder *decoder, const ::FLAC__StreamMetadata *metadata, void *client_data);
            static void error_callback_(const ::OggFLAC__StreamDecoder *decoder, ::FLAC__StreamDecoderErrorStatus status, void *client_data);

            // Private and undefined so you can't use them:
            Stream(const Stream &);
            void operator=(const Stream &);
        };

        /* \} */

    };
};

#endif

---