Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
Loading...
Searching...
No Matches
wav_source.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2023 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/wav_source.h
10//! @brief WAV source.
11
12#ifndef ROC_SNDIO_WAV_SOURCE_H_
13#define ROC_SNDIO_WAV_SOURCE_H_
14
15#include <dr_wav.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//! WAV source.
31class WavSource : public ISource, private core::NonCopyable<> {
32public:
33 //! Initialize.
34 WavSource(core::IArena& arena, const Config& config);
35
36 virtual ~WavSource();
37
38 //! Check if the object was successfully constructed.
39 bool is_valid() const;
40
41 //! Open input file or device.
42 //!
43 //! @b Parameters
44 //! - @p path is input file or device name, "-" for stdin.
45 //!
46 //! @remarks
47 //! If @p path is NULL, defaults are used.
48 bool open(const char* path);
49
50 //! Cast IDevice to ISink.
51 virtual ISink* to_sink();
52
53 //! Cast IDevice to ISink.
54 virtual ISource* to_source();
55
56 //! Get device type.
57 virtual DeviceType type() const;
58
59 //! Get device state.
60 virtual DeviceState state() const;
61
62 //! Pause reading.
63 virtual void pause();
64
65 //! Resume paused reading.
66 virtual bool resume();
67
68 //! Restart reading from the beginning.
69 virtual bool restart();
70
71 //! Get sample specification of the source.
73
74 //! Get latency of the source.
76
77 //! Check if the source supports latency reports.
78 virtual bool has_latency() const;
79
80 //! Check if the source has own clock.
81 virtual bool has_clock() const;
82
83 //! Adjust source clock to match consumer clock.
84 virtual void reclock(core::nanoseconds_t timestamp);
85
86 //! Read frame.
87 virtual bool read(audio::Frame& frame);
88
89private:
90 bool open_(const char* path);
91 void close_();
92
93 drwav wav_;
94 bool file_opened_;
95 bool eof_;
96
97 bool valid_;
98};
99
100} // namespace sndio
101} // namespace roc
102
103#endif // ROC_SNDIO_WAV_SOURCE_H_
Dynamic array.
Audio frame.
Definition frame.h:25
Sample specification. Describes sample rate and channels.
Definition sample_spec.h:30
Memory arena interface.
Definition iarena.h:23
Base class for non-copyable objects.
Definition noncopyable.h:23
Sink interface.
Definition isink.h:22
Source interface.
Definition isource.h:23
virtual DeviceState state() const
Get device state.
virtual audio::SampleSpec sample_spec() const
Get sample specification of the source.
virtual void pause()
Pause reading.
virtual core::nanoseconds_t latency() const
Get latency of the source.
virtual bool restart()
Restart reading from the beginning.
virtual bool has_latency() const
Check if the source supports latency reports.
bool is_valid() const
Check if the object was successfully constructed.
virtual DeviceType type() const
Get device type.
WavSource(core::IArena &arena, const Config &config)
Initialize.
virtual bool resume()
Resume paused reading.
virtual ISource * to_source()
Cast IDevice to ISink.
virtual void reclock(core::nanoseconds_t timestamp)
Adjust source clock to match consumer clock.
virtual ISink * to_sink()
Cast IDevice to ISink.
virtual bool read(audio::Frame &frame)
Read frame.
virtual bool has_clock() const
Check if the source has own clock.
bool open(const char *path)
Open input file or device.
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.