sox_sink.h

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Roc Streaming authors
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 */
 
//! @file roc_sndio/target_sox/roc_sndio/sox_sink.h
//! @brief SoX sink.
 
#ifndef ROC_SNDIO_SOX_SINK_H_
#define ROC_SNDIO_SOX_SINK_H_
 
#include <sox.h>
 
#include "roc_audio/sample_spec.h"
#include "roc_core/array.h"
#include "roc_core/iarena.h"
#include "roc_core/noncopyable.h"
#include "roc_core/stddefs.h"
#include "roc_packet/units.h"
#include "roc_sndio/config.h"
#include "roc_sndio/driver.h"
#include "roc_sndio/isink.h"
 
namespace roc {
namespace sndio {
 
//! SoX sink.
//! @remarks
//!  Writes samples to output file or device.
//!  Supports multiple drivers for different file types and audio systems.
class SoxSink : public ISink, public core::NonCopyable<> {
public:
    //! Initialize.
    SoxSink(core::IArena& arena, const Config& config, DriverType type);
 
    virtual ~SoxSink();
 
    //! Check if the object was successfully constructed.
    bool is_valid() const;
 
    //! Open output file or device.
    //!
    //! @b Parameters
    //!  - @p driver is output driver name;
    //!  - @p path is output file or device name, "-" for stdout.
    //!
    //! @remarks
    //!  If @p driver or @p path are NULL, defaults are used.
    bool open(const char* driver, const char* path);
 
    //! Cast IDevice to ISink.
    virtual ISink* to_sink();
 
    //! Cast IDevice to ISink.
    virtual ISource* to_source();
 
    //! Get device type.
    virtual DeviceType type() const;
 
    //! Get device state.
    virtual DeviceState state() const;
 
    //! Pause reading.
    virtual void pause();
 
    //! Resume paused reading.
    virtual bool resume();
 
    //! Restart reading from the beginning.
    virtual bool restart();
 
    //! Get sample specification of the sink.
    virtual audio::SampleSpec sample_spec() const;
 
    //! Get latency of the sink.
    virtual core::nanoseconds_t latency() const;
 
    //! Check if the sink supports latency reports.
    virtual bool has_latency() const;
 
    //! Check if the sink has own clock.
    virtual bool has_clock() const;
 
    //! Write audio frame.
    virtual void write(audio::Frame& frame);
 
private:
    bool setup_buffer_();
    bool open_(const char* driver, const char* path);
    void write_(const sox_sample_t* samples, size_t n_samples);
    void close_();
 
    sox_format_t* output_;
    sox_signalinfo_t out_signal_;
 
    core::Array<sox_sample_t> buffer_;
    size_t buffer_size_;
    core::nanoseconds_t frame_length_;
    audio::SampleSpec sample_spec_;
 
    bool is_file_;
    bool valid_;
};
 
} // namespace sndio
} // namespace roc
 
#endif // ROC_SNDIO_SOX_SINK_H_