libtorchaudio.stream_reader.rst 2.98 KB
Newer Older
moto's avatar
moto committed
1
2
3
4
.. warning::
   TorchAudio's C++ API is a prototype feature.
   API/ABI backward compatibility is not guaranteed.

moto-meta's avatar
moto-meta committed
5
6
torio::io::StreamReader
=======================
moto's avatar
moto committed
7

8
9
10
11
``StreamReader`` is the implementation used by Python equivalent and provides similar interface.
When working with custom I/O, such as in-memory data, ``StreamReaderCustomIO`` class can be used.

Both classes have the same methods defined, so their usages are the same.
moto's avatar
moto committed
12
13
14
15

Constructors
------------

16
17
18
StreamReader
^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
19
.. doxygenclass:: torio::io::StreamReader
20

moto-meta's avatar
moto-meta committed
21
.. doxygenfunction:: torio::io::StreamReader::StreamReader(const std::string &src, const c10::optional<std::string> &format = {}, const c10::optional<OptionDict> &option = {})
moto's avatar
moto committed
22

23
24
25
StreamReaderCustomIO
^^^^^^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
26
.. doxygenclass:: torio::io::StreamReaderCustomIO
27

moto-meta's avatar
moto-meta committed
28
.. doxygenfunction:: torio::io::StreamReaderCustomIO::StreamReaderCustomIO
29

moto's avatar
moto committed
30
31
32
33
34
Query Methods
-------------

find_best_audio_stream
^^^^^^^^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
35
.. doxygenfunction:: torio::io::StreamReader::find_best_audio_stream
moto's avatar
moto committed
36
37
38

find_best_video_stream
^^^^^^^^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
39
.. doxygenfunction:: torio::io::StreamReader::find_best_video_stream
moto's avatar
moto committed
40
41
42

get_metadata
^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
43
.. doxygenfunction:: torio::io::StreamReader::get_metadata
moto's avatar
moto committed
44
45
46

num_src_streams
^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
47
.. doxygenfunction:: torio::io::StreamReader::num_src_streams
moto's avatar
moto committed
48
49
50
51

get_src_stream_info
^^^^^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
52
.. doxygenfunction:: torio::io::StreamReader::get_src_stream_info
moto's avatar
moto committed
53
54
55
56

num_out_streams
^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
57
.. doxygenfunction:: torio::io::StreamReader::num_out_streams
moto's avatar
moto committed
58
59
60
61

get_out_stream_info
^^^^^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
62
.. doxygenfunction:: torio::io::StreamReader::get_out_stream_info
moto's avatar
moto committed
63
64
65
66

is_buffer_ready
^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
67
.. doxygenfunction:: torio::io::StreamReader::is_buffer_ready
moto's avatar
moto committed
68
69
70
71
72
73
74

Configure Methods
-----------------

add_audio_stream
^^^^^^^^^^^^^^^^

moto-meta's avatar
moto-meta committed
75
.. doxygenfunction:: torio::io::StreamReader::add_audio_stream
moto's avatar
moto committed
76
77
78

add_video_stream
^^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
79
.. doxygenfunction:: torio::io::StreamReader::add_video_stream
moto's avatar
moto committed
80
81
82

remove_stream
^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
83
.. doxygenfunction:: torio::io::StreamReader::remove_stream
moto's avatar
moto committed
84
85
86
87
88
89

Stream Methods
^^^^^^^^^^^^^^

seek
^^^^
moto-meta's avatar
moto-meta committed
90
.. doxygenfunction:: torio::io::StreamReader::seek
moto's avatar
moto committed
91
92
93

process_packet
^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
94
.. doxygenfunction:: torio::io::StreamReader::process_packet()
moto's avatar
moto committed
95
96
97

process_packet_block
^^^^^^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
98
.. doxygenfunction:: torio::io::StreamReader::process_packet_block
moto's avatar
moto committed
99

100
101
process_all_packets
^^^^^^^^^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
102
.. doxygenfunction:: torio::io::StreamReader::process_all_packets
103
104
105

fill_buffer
^^^^^^^^^^^
moto-meta's avatar
moto-meta committed
106
.. doxygenfunction:: torio::io::StreamReader::fill_buffer
107

moto's avatar
moto committed
108
109
110
111
112
113
Retrieval Methods
-----------------

pop_chunks
^^^^^^^^^^

moto-meta's avatar
moto-meta committed
114
.. doxygenfunction:: torio::io::StreamReader::pop_chunks
moto's avatar
moto committed
115
116
117
118
119
120
121
122
123
124


Support Structures
------------------

Chunk
^^^^^

.. container:: py attribute

moto-meta's avatar
moto-meta committed
125
   .. doxygenstruct:: torio::io::Chunk
moto's avatar
moto committed
126
127
128
129
130
131
132
      :members:

SrcStreaminfo
^^^^^^^^^^^^^

.. container:: py attribute

moto-meta's avatar
moto-meta committed
133
   .. doxygenstruct:: torio::io::SrcStreamInfo
moto's avatar
moto committed
134
135
136
137
138
139
140
      :members:

OutputStreaminfo
^^^^^^^^^^^^^^^^

.. container:: py attribute

moto-meta's avatar
moto-meta committed
141
   .. doxygenstruct:: torio::io::OutputStreamInfo
moto's avatar
moto committed
142
      :members: