input.h

Go to the documentation of this file.

PFC_DECLARE_EXCEPTION(exception_tagging_unsupported, exception_io_data, "Tagging of this file format is not supported")

enum {
    input_flag_no_seeking                   = 1 << 0,
    input_flag_no_looping                   = 1 << 1,
    input_flag_playback                     = 1 << 2,
    input_flag_testing_integrity            = 1 << 3,
    input_flag_allow_inaccurate_seeking     = 1 << 4,
    input_flag_no_postproc                  = 1 << 5,

    input_flag_simpledecode = input_flag_no_seeking|input_flag_no_looping,
};


class NOVTABLE input_info_reader : public service_base
{
public:
    virtual t_uint32 get_subsong_count() = 0;
    
    virtual t_uint32 get_subsong(t_uint32 p_index) = 0;
    
    virtual void get_info(t_uint32 p_subsong,file_info & p_info,abort_callback & p_abort) = 0;

    virtual t_filestats get_file_stats(abort_callback & p_abort) = 0;

    FB2K_MAKE_SERVICE_INTERFACE(input_info_reader,service_base);
};


class NOVTABLE input_decoder : public input_info_reader
{
public:
    virtual void initialize(t_uint32 p_subsong,unsigned p_flags,abort_callback & p_abort) = 0;

    virtual bool run(audio_chunk & p_chunk,abort_callback & p_abort) = 0;

    virtual void seek(double p_seconds,abort_callback & p_abort) = 0;
    
    virtual bool can_seek() = 0;

    virtual bool get_dynamic_info(file_info & p_out, double & p_timestamp_delta) = 0;

    virtual bool get_dynamic_info_track(file_info & p_out, double & p_timestamp_delta) = 0;

    virtual void on_idle(abort_callback & p_abort) = 0;


    FB2K_MAKE_SERVICE_INTERFACE(input_decoder,input_info_reader);
};


class NOVTABLE input_decoder_v2 : public input_decoder {
    FB2K_MAKE_SERVICE_INTERFACE(input_decoder_v2, input_decoder)
public:

    virtual bool run_raw(audio_chunk & out, mem_block_container & outRaw, abort_callback & abort) = 0;

    virtual void set_logger(event_logger::ptr ptr) = 0;
};

class NOVTABLE input_decoder_v3 : public input_decoder_v2 {
    FB2K_MAKE_SERVICE_INTERFACE(input_decoder_v3, input_decoder_v2);
public:
    virtual void set_pause(bool paused) = 0;
    virtual bool flush_on_pause() = 0;
};


class NOVTABLE input_info_writer : public input_info_reader
{
public:
    virtual void set_info(t_uint32 p_subsong,const file_info & p_info,abort_callback & p_abort) = 0;
    
    virtual void commit(abort_callback & p_abort) = 0;

    FB2K_MAKE_SERVICE_INTERFACE(input_info_writer,input_info_reader);
};

class NOVTABLE input_info_writer_v2 : public input_info_writer {
public:
    virtual void remove_tags(abort_callback & abort) = 0;

    FB2K_MAKE_SERVICE_INTERFACE(input_info_writer_v2, input_info_writer);
};

class NOVTABLE input_entry : public service_base
{
public:
    virtual bool is_our_content_type(const char * p_type)=0;

    virtual bool is_our_path(const char * p_full_path,const char * p_extension)=0;
    
    virtual void open_for_decoding(service_ptr_t<input_decoder> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort) = 0;

    virtual void open_for_info_read(service_ptr_t<input_info_reader> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort) = 0;

    virtual void open_for_info_write(service_ptr_t<input_info_writer> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort) = 0;

    virtual void get_extended_data(service_ptr_t<file> p_filehint,const playable_location & p_location,const GUID & p_guid,mem_block_container & p_out,abort_callback & p_abort) = 0;

    enum {
        flag_redirect = 1,
        flag_parallel_reads_slow = 2,
    };
    virtual unsigned get_flags() = 0;

    inline bool is_redirect() {return (get_flags() & flag_redirect) != 0;}
    inline bool are_parallel_reads_slow() {return (get_flags() & flag_parallel_reads_slow) != 0;}

    static bool g_find_service_by_path(service_ptr_t<input_entry> & p_out,const char * p_path);
    static bool g_find_service_by_path(service_ptr_t<input_entry> & p_out,const char * p_path, const char * p_ext);
    static bool g_find_service_by_content_type(service_ptr_t<input_entry> & p_out,const char * p_content_type);
    static void g_open_for_decoding(service_ptr_t<input_decoder> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort,bool p_from_redirect = false);
    static void g_open_for_info_read(service_ptr_t<input_info_reader> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort,bool p_from_redirect = false);
    static void g_open_for_info_write(service_ptr_t<input_info_writer> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort,bool p_from_redirect = false);
    static void g_open_for_info_write_timeout(service_ptr_t<input_info_writer> & p_instance,service_ptr_t<file> p_filehint,const char * p_path,abort_callback & p_abort,double p_timeout,bool p_from_redirect = false);
    static bool g_is_supported_path(const char * p_path);


    void open(service_ptr_t<input_decoder> & p_instance,service_ptr_t<file> const & p_filehint,const char * p_path,abort_callback & p_abort) {open_for_decoding(p_instance,p_filehint,p_path,p_abort);}
    void open(service_ptr_t<input_info_reader> & p_instance,service_ptr_t<file> const & p_filehint,const char * p_path,abort_callback & p_abort) {open_for_info_read(p_instance,p_filehint,p_path,p_abort);}
    void open(service_ptr_t<input_info_writer> & p_instance,service_ptr_t<file> const & p_filehint,const char * p_path,abort_callback & p_abort) {open_for_info_write(p_instance,p_filehint,p_path,p_abort);}

    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(input_entry);
};