Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
sox_source.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2019 Roc Streaming authors
3 *
4 * This Source Code Form is subject to the terms of the Mozilla Public
5 * License, v. 2.0. If a copy of the MPL was not distributed with this
6 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
7 */
8
9//! @file roc_sndio/target_sox/roc_sndio/sox_source.h
10//! @brief SoX source.
11
12#ifndef ROC_SNDIO_SOX_SOURCE_H_
13#define ROC_SNDIO_SOX_SOURCE_H_
14
15#include <sox.h>
16
18#include "roc_core/array.h"
19#include "roc_core/iarena.h"
21#include "roc_core/stddefs.h"
23#include "roc_packet/units.h"
24#include "roc_sndio/config.h"
25#include "roc_sndio/isource.h"
26
27namespace roc {
28namespace sndio {
29
30//! SoX source.
31//! @remarks
32//! Reads samples from input file or device.
33//! Supports multiple drivers for different file types and audio systems.
34class SoxSource : public ISource, private core::NonCopyable<> {
35public:
36 //! Initialize.
37 SoxSource(core::IArena& arena, const Config& config);
38
39 virtual ~SoxSource();
40
41 //! Check if the object was successfully constructed.
42 bool is_valid() const;
43
44 //! Open input file or device.
45 //!
46 //! @b Parameters
47 //! - @p driver is input driver name;
48 //! - @p path is input file or device name, "-" for stdin.
49 //!
50 //! @remarks
51 //! If @p driver or @p path are NULL, defaults are used.
52 bool open(const char* driver, const char* path);
53
54 //! Get device type.
55 virtual DeviceType type() const;
56
57 //! Get device state.
58 virtual DeviceState state() const;
59
60 //! Pause reading.
61 virtual void pause();
62
63 //! Resume paused reading.
64 virtual bool resume();
65
66 //! Restart reading from the beginning.
67 virtual bool restart();
68
69 //! Get sample specification of the source.
71
72 //! Get latency of the source.
74
75 //! Check if the source supports latency reports.
76 virtual bool has_latency() const;
77
78 //! Check if the source has own clock.
79 virtual bool has_clock() const;
80
81 //! Adjust source clock to match consumer clock.
82 virtual void reclock(core::nanoseconds_t timestamp);
83
84 //! Read frame.
85 virtual bool read(audio::Frame&);
86
87private:
88 bool setup_names_(const char* driver, const char* path);
89 bool setup_buffer_();
90
91 bool open_();
92 void close_();
93
94 bool seek_(uint64_t offset);
95
96 core::StringBuffer driver_name_;
97 core::StringBuffer input_name_;
98
100 size_t buffer_size_;
101 core::nanoseconds_t frame_length_;
102 audio::SampleSpec sample_spec_;
103
104 sox_format_t* input_;
105 sox_signalinfo_t in_signal_;
106
107 bool is_file_;
108 bool eof_;
109 bool paused_;
110 bool valid_;
111};
112
113} // namespace sndio
114} // namespace roc
115
116#endif // ROC_SNDIO_SOX_SOURCE_H_
Dynamic array.
Audio frame.
Definition frame.h:25
Sample specification. Describes sample rate and channels.
Definition sample_spec.h:26
Memory arena interface.
Definition iarena.h:23
Base class for non-copyable objects.
Definition noncopyable.h:23
Shared ownership intrusive pointer.
Definition shared_ptr.h:32
Source interface.
Definition isource.h:23
bool open(const char *driver, const char *path)
Open input file or device.
virtual void pause()
Pause reading.
virtual DeviceType type() const
Get device type.
virtual DeviceState state() const
Get device state.
bool is_valid() const
Check if the object was successfully constructed.
virtual bool has_clock() const
Check if the source has own clock.
virtual bool restart()
Restart reading from the beginning.
virtual audio::SampleSpec sample_spec() const
Get sample specification of the source.
virtual core::nanoseconds_t latency() const
Get latency of the source.
virtual bool read(audio::Frame &)
Read frame.
virtual bool has_latency() const
Check if the source supports latency reports.
SoxSource(core::IArena &arena, const Config &config)
Initialize.
virtual void reclock(core::nanoseconds_t timestamp)
Adjust source clock to match consumer clock.
virtual bool resume()
Resume paused reading.
Memory arena interface.
Source interface.
int64_t nanoseconds_t
Nanoseconds.
Definition time.h:58
DeviceType
Device type.
Definition device_type.h:19
DeviceState
Device state.
Root namespace.
Non-copyable object.
Sink and source config.
Sample specifications.
Commonly used types and functions.
String buffer.
Sink and source config.
Definition config.h:29
Various units used in packets.