view 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
line wrap: on
line source

#pragma once

#include <functional>
#include <list>
#include <SDK/input.h>
#include <SDK/tracks.h>

class input_helper {
public:
	input_helper();

	typedef std::function<input_decoder::ptr (input_decoder::ptr, const char*, abort_callback&) > shim_t;
    typedef std::function<void (input_decoder::ptr, const char*, abort_callback&) > infoHook_t;

    typedef std::function< bool ( file::ptr &, const char *, abort_callback & ) > ioFilter_t;
	typedef std::list<ioFilter_t> ioFilters_t;

	struct decodeInfo_t {
		bool m_flush_on_pause;
		bool m_can_seek;
		bool m_seeking_expensive;
	};

	struct decodeOpen_t {
		bool m_from_redirect = false;
		bool m_skip_hints = false;
		unsigned m_flags = 0;
		file::ptr m_hint;
		unsigned m_setSampleRate = 0;

		ioFilters_t m_ioFilters;
		event_logger::ptr m_logger;
        infoHook_t m_infoHook;
		shim_t m_shim;
	};

	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);
	void attach(input_decoder::ptr dec, const char * path);

	void open(const playable_location & location, abort_callback & abort, decodeOpen_t const & other);

    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);
    void open(trackRef location, abort_callback & abort, decodeOpen_t const & other);


	//! Multilevel open helpers.
	//! @returns Diagnostic/helper value: true if the decoder had to be re-opened entirely, false if the instance was reused.
	bool open_path(const char * path, abort_callback & abort, decodeOpen_t const & other);
	//! Multilevel open helpers.
	void open_decoding(t_uint32 subsong, t_uint32 flags, abort_callback & p_abort);

	bool need_file_reopen(const char * newPath) const;
	
	decodeInfo_t decode_info();

	void close();
	bool is_open();
	//! Single decode pass. 
	//! @returns True if a chunk was returned, false if EOF (no more audio to return).
	bool run(audio_chunk & p_chunk,abort_callback & p_abort);
	//! Single decode pass with raw output for integrity verification. \n
	//! Throws pfc::exception_not_implemented if this input doesn't support run_raw().
	//! @returns True if a chunk was returned, false if EOF (no more audio to return).
	bool run_raw(audio_chunk & p_chunk, mem_block_container & p_raw, abort_callback & p_abort);
	//! Single decode pass with raw output for integrity verification. \n
	//! If the input doesn't support run_raw(), raw PCM is recreated from audio_chunk.
	//! @returns True if a chunk was returned, false if EOF (no more audio to return).
	bool run_raw_v2(audio_chunk& p_chunk, mem_block_container& p_raw, uint32_t knownBPS, abort_callback& p_abort);
	void seek(double seconds,abort_callback & p_abort);
	bool can_seek();
    size_t extended_param( const GUID & type, size_t arg1 = 0, void * arg2 = nullptr, size_t arg2size = 0);
	static ioFilter_t ioFilter_full_buffer(t_filesize val );
    static ioFilter_t ioFilter_block_buffer(size_t val);
    static ioFilter_t ioFilter_remote_read_ahead( size_t val );
	static ioFilter_t ioFilter_local_read_ahead(size_t val);

	void on_idle(abort_callback & p_abort);
	bool get_dynamic_info(file_info & p_out,double & p_timestamp_delta);
	bool get_dynamic_info_track(file_info & p_out,double & p_timestamp_delta);
	void set_logger(event_logger::ptr ptr);
	void set_pause(bool state);
	bool flush_on_pause();

	//! If this decoder has its own special position reporting, decoder-signaled logical decoding position will be returned. \n
	//! Otherwise, position calculated from returned audio duration should be assumed. \n
	//! Very few special-purpose decoders do this.
	bool query_position( double & val );

	//! Retrieves path of currently open file.
	const char * get_path() const;

	//! Retrieves info about specific subsong of currently open file.
	void get_info(t_uint32 p_subsong,file_info & p_info,abort_callback & p_abort);

	static void g_get_info(const playable_location & p_location,file_info & p_info,abort_callback & p_abort,bool p_from_redirect = false);
	static void g_set_info(const playable_location & p_location,file_info & p_info,abort_callback & p_abort,bool p_from_redirect = false);


#ifdef FOOBAR2000_HAVE_METADB
	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);
#endif
    
	static void fileOpenTools(service_ptr_t<file>& p_file, const char* p_path, ioFilters_t const& filters, abort_callback& p_abort);

	bool test_if_lockless(abort_callback&);

	uint32_t get_subsong_count() const { return m_input->get_subsong_count(); }
	uint32_t get_subsong(uint32_t i) const { return m_input->get_subsong(i); }
private:
	bool m_file_in_memory = false;
	service_ptr_t<input_decoder> m_input;
	pfc::string8 m_path;
	event_logger::ptr m_logger;
};

#ifdef FOOBAR2000_HAVE_METADB
class NOVTABLE dead_item_filter : public abort_callback {
public:
	virtual void on_progress(t_size p_position,t_size p_total) = 0;

	bool run(const pfc::list_base_const_t<metadb_handle_ptr> & p_list,bit_array_var & p_mask);
};
#endif

class input_info_read_helper {
public:
	input_info_read_helper() {}
	void get_info(const playable_location & p_location,file_info & p_info,t_filestats & p_stats,abort_callback & p_abort);
#ifdef FOOBAR2000_HAVE_METADB
	void get_info_check(const playable_location & p_location,file_info & p_info,t_filestats & p_stats,bool & p_reloaded,abort_callback & p_abort);
#endif
private:
	void open(const char * p_path,abort_callback & p_abort);

	pfc::string8 m_path;
	service_ptr_t<input_info_reader> m_input;
};


//! openAudioData return value, see openAudioData()
struct openAudioData_t {
	file::ptr audioData; // audio data stream
	audio_chunk::spec_t audioSpec; // format description (sample rate, channel layout).
};

//! Opens the specified location as a stream of audio_samples. \n
//! 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
//! 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
//! 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
//! Seeking may be inaccurate with certain file formats. \n
//! In general, all file object methods will work as intended on core-supported file formats such as FLAC or WavPack. \n
//! 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().
openAudioData_t openAudioData(playable_location const & loc, bool bSeekable, file::ptr fileHint, abort_callback & aborter);
openAudioData_t openAudioData2(playable_location const & loc, input_helper::decodeOpen_t const & openArg, abort_callback & aborter);


//! openAudioData3 allows explicit format: float32 or float64, for use cases that need such.
enum class openAudioDataFormat {
	float32,
	float64
};
openAudioData_t openAudioData3(playable_location const& loc, input_helper::decodeOpen_t const& openArg, openAudioDataFormat format, abort_callback& aborter);