annotate foosdk/sdk/foobar2000/helpers/input_helpers.h @ 1:20d02a178406 default tip

*: check in everything else yay
author Paper <paper@tflc.us>
date Mon, 05 Jan 2026 02:15:46 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
1 #pragma once
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
2
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
3 #include <functional>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 #include <list>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 #include <SDK/input.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6 #include <SDK/tracks.h>
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8 class input_helper {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 input_helper();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 typedef std::function<input_decoder::ptr (input_decoder::ptr, const char*, abort_callback&) > shim_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 typedef std::function<void (input_decoder::ptr, const char*, abort_callback&) > infoHook_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 typedef std::function< bool ( file::ptr &, const char *, abort_callback & ) > ioFilter_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16 typedef std::list<ioFilter_t> ioFilters_t;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 struct decodeInfo_t {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 bool m_flush_on_pause;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 bool m_can_seek;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21 bool m_seeking_expensive;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24 struct decodeOpen_t {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 bool m_from_redirect = false;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26 bool m_skip_hints = false;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 unsigned m_flags = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 file::ptr m_hint;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29 unsigned m_setSampleRate = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31 ioFilters_t m_ioFilters;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 event_logger::ptr m_logger;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 infoHook_t m_infoHook;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34 shim_t m_shim;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37 void open(service_ptr_t<file> p_filehint,const playable_location & p_location,unsigned p_flags,abort_callback & p_abort,bool p_from_redirect = false,bool p_skip_hints = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38 void attach(input_decoder::ptr dec, const char * path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 void open(const playable_location & location, abort_callback & abort, decodeOpen_t const & other);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
41
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
42 void open(service_ptr_t<file> p_filehint,trackRef p_location,unsigned p_flags,abort_callback & p_abort,bool p_from_redirect = false,bool p_skip_hints = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 void open(trackRef location, abort_callback & abort, decodeOpen_t const & other);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
45
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
46 //! Multilevel open helpers.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47 //! @returns Diagnostic/helper value: true if the decoder had to be re-opened entirely, false if the instance was reused.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 bool open_path(const char * path, abort_callback & abort, decodeOpen_t const & other);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 //! Multilevel open helpers.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 void open_decoding(t_uint32 subsong, t_uint32 flags, abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
51
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
52 bool need_file_reopen(const char * newPath) const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 decodeInfo_t decode_info();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 void close();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57 bool is_open();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 //! Single decode pass.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 //! @returns True if a chunk was returned, false if EOF (no more audio to return).
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 bool run(audio_chunk & p_chunk,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 //! Single decode pass with raw output for integrity verification. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 //! Throws pfc::exception_not_implemented if this input doesn't support run_raw().
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 //! @returns True if a chunk was returned, false if EOF (no more audio to return).
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 bool run_raw(audio_chunk & p_chunk, mem_block_container & p_raw, abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65 //! Single decode pass with raw output for integrity verification. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 //! If the input doesn't support run_raw(), raw PCM is recreated from audio_chunk.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67 //! @returns True if a chunk was returned, false if EOF (no more audio to return).
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 bool run_raw_v2(audio_chunk& p_chunk, mem_block_container& p_raw, uint32_t knownBPS, abort_callback& p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 void seek(double seconds,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 bool can_seek();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 size_t extended_param( const GUID & type, size_t arg1 = 0, void * arg2 = nullptr, size_t arg2size = 0);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 static ioFilter_t ioFilter_full_buffer(t_filesize val );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 static ioFilter_t ioFilter_block_buffer(size_t val);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 static ioFilter_t ioFilter_remote_read_ahead( size_t val );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75 static ioFilter_t ioFilter_local_read_ahead(size_t val);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 void on_idle(abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 bool get_dynamic_info(file_info & p_out,double & p_timestamp_delta);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 bool get_dynamic_info_track(file_info & p_out,double & p_timestamp_delta);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 void set_logger(event_logger::ptr ptr);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 void set_pause(bool state);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82 bool flush_on_pause();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 //! If this decoder has its own special position reporting, decoder-signaled logical decoding position will be returned. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 //! Otherwise, position calculated from returned audio duration should be assumed. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 //! Very few special-purpose decoders do this.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 bool query_position( double & val );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
88
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
89 //! Retrieves path of currently open file.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90 const char * get_path() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
91
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
92 //! Retrieves info about specific subsong of currently open file.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
93 void get_info(t_uint32 p_subsong,file_info & p_info,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
94
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
95 static void g_get_info(const playable_location & p_location,file_info & p_info,abort_callback & p_abort,bool p_from_redirect = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
96 static void g_set_info(const playable_location & p_location,file_info & p_info,abort_callback & p_abort,bool p_from_redirect = false);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
97
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
98
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
99 #ifdef FOOBAR2000_HAVE_METADB
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
100 static bool g_mark_dead(const pfc::list_base_const_t<metadb_handle_ptr> & p_list,bit_array_var & p_mask,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
101 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
102
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
103 static void fileOpenTools(service_ptr_t<file>& p_file, const char* p_path, ioFilters_t const& filters, abort_callback& p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
104
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
105 bool test_if_lockless(abort_callback&);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
106
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
107 uint32_t get_subsong_count() const { return m_input->get_subsong_count(); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
108 uint32_t get_subsong(uint32_t i) const { return m_input->get_subsong(i); }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
109 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
110 bool m_file_in_memory = false;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
111 service_ptr_t<input_decoder> m_input;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
112 pfc::string8 m_path;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
113 event_logger::ptr m_logger;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
114 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
115
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
116 #ifdef FOOBAR2000_HAVE_METADB
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
117 class NOVTABLE dead_item_filter : public abort_callback {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
118 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
119 virtual void on_progress(t_size p_position,t_size p_total) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
120
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
121 bool run(const pfc::list_base_const_t<metadb_handle_ptr> & p_list,bit_array_var & p_mask);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
122 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
123 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
124
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
125 class input_info_read_helper {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
126 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
127 input_info_read_helper() {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
128 void get_info(const playable_location & p_location,file_info & p_info,t_filestats & p_stats,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
129 #ifdef FOOBAR2000_HAVE_METADB
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
130 void get_info_check(const playable_location & p_location,file_info & p_info,t_filestats & p_stats,bool & p_reloaded,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
131 #endif
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
132 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
133 void open(const char * p_path,abort_callback & p_abort);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
134
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
135 pfc::string8 m_path;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
136 service_ptr_t<input_info_reader> m_input;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
137 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
138
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
139
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
140 //! openAudioData return value, see openAudioData()
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
141 struct openAudioData_t {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
142 file::ptr audioData; // audio data stream
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
143 audio_chunk::spec_t audioSpec; // format description (sample rate, channel layout).
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
144 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
145
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
146 //! Opens the specified location as a stream of audio_samples. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
147 //! Returns a file object that allows you to read the audio data stream as if it was a physical file, together with audio stream format description (sample rate, channel layout). \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
148 //! Please keep in mind that certain features of the returned file object are only as reliable as the underlying file format or decoder implementation allows them to be. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
149 //! Reported exact file size may be either unavailable or unreliable if the file format does not let us known the exact value without decoding the whole file. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
150 //! Seeking may be inaccurate with certain file formats. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
151 //! In general, all file object methods will work as intended on core-supported file formats such as FLAC or WavPack. \n
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
152 //! However, if you want 100% functionality regardless of file format being worked with, mirror the content to a temp file and let go of the file object returned by openAudioData().
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
153 openAudioData_t openAudioData(playable_location const & loc, bool bSeekable, file::ptr fileHint, abort_callback & aborter);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
154 openAudioData_t openAudioData2(playable_location const & loc, input_helper::decodeOpen_t const & openArg, abort_callback & aborter);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
155
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
156
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
157 //! openAudioData3 allows explicit format: float32 or float64, for use cases that need such.
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
158 enum class openAudioDataFormat {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
159 float32,
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
160 float64
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
161 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
162 openAudioData_t openAudioData3(playable_location const& loc, input_helper::decodeOpen_t const& openArg, openAudioDataFormat format, abort_callback& aborter);