//
// SampleSource.h - MrsWatson
// Created by Nik Reiman on 1/2/12.
// Copyright (c) 2012 Teragon Audio. All rights reserved.
//
// 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.
//
// 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 COPYRIGHT HOLDER 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 MrsWatson_SampleSource_h
#define MrsWatson_SampleSource_h

#include "audio/SampleBuffer.h"
#include "base/CharString.h"
#include "base/Types.h"

typedef enum {
    SAMPLE_SOURCE_TYPE_INVALID,
    SAMPLE_SOURCE_TYPE_SILENCE,
    SAMPLE_SOURCE_TYPE_PCM,
    SAMPLE_SOURCE_TYPE_AIFF,
    SAMPLE_SOURCE_TYPE_FLAC,
    SAMPLE_SOURCE_TYPE_MP3,
    SAMPLE_SOURCE_TYPE_OGG,
    SAMPLE_SOURCE_TYPE_WAVE,
    NUM_SAMPLE_SOURCES
} SampleSourceType;

typedef enum {
    SAMPLE_SOURCE_OPEN_NOT_OPENED,
    SAMPLE_SOURCE_OPEN_READ,
    SAMPLE_SOURCE_OPEN_WRITE,
    NUM_SAMPLE_SOURCE_OPEN_AS
} SampleSourceOpenAs;

typedef boolByte (*OpenSampleSourceFunc)(void *, const SampleSourceOpenAs);
typedef boolByte (*ReadSampleBlockFunc)(void *, SampleBuffer);
typedef boolByte (*WriteSampleBlockFunc)(void *, const SampleBuffer);
typedef void (*CloseSampleSourceFunc)(void *);
typedef void (*FreeSampleSourceDataFunc)(void *);

typedef struct {
    SampleSourceType sampleSourceType;
    SampleSourceOpenAs openedAs;
    CharString sourceName;
    unsigned long numSamplesProcessed;

    OpenSampleSourceFunc openSampleSource;
    ReadSampleBlockFunc readSampleBlock;
    WriteSampleBlockFunc writeSampleBlock;
    CloseSampleSourceFunc closeSampleSource;
    FreeSampleSourceDataFunc freeSampleSourceData;

    void *extraData;
} SampleSourceMembers;
typedef SampleSourceMembers *SampleSource;

/**
 * Factory method to create a new sample source
 * @param sampleSourceName Source name. If NULL, then a silent sample source is created.
 * @return Initialized sample source, or NULL if none could be created
 */
SampleSource sampleSourceFactory(const CharString sampleSourceName);

/**
 * Print a list of all supported sample source pipes to the log
 */
void sampleSourcePrintSupportedTypes(void);

/**
 * Release a sample source and associated resources
 * @param self
 */
void freeSampleSource(SampleSource self);

#endif