input_raw

Public Member Functions
bool	decode_can_seek ()
bool	decode_get_dynamic_info (file_info &p_out, double &p_timestamp_delta)
bool	decode_get_dynamic_info_track (file_info &p_out, double &p_timestamp_delta)
void	decode_initialize (unsigned p_flags, abort_callback &p_abort)
void	decode_on_idle (abort_callback &p_abort)
bool	decode_run (audio_chunk &p_chunk, abort_callback &p_abort)
void	decode_seek (double p_seconds, abort_callback &p_abort)
t_filestats	get_file_stats (abort_callback &p_abort)
void	get_info (file_info &p_info, abort_callback &p_abort)
void	open (service_ptr_t< file > p_filehint, const char *p_path, t_input_open_reason p_reason, abort_callback &p_abort)
void	retag (const file_info &p_info, abort_callback &p_abort)

Static Public Member Functions
static bool	g_is_our_content_type (const char *p_content_type)
static bool	g_is_our_path (const char *p_path, const char *p_extension)

Data Fields
pfc::array_t< t_uint8 >	m_buffer
service_ptr_t< file >	m_file

Detailed Description

Definition at line 13 of file input_raw.cpp.

Member Function Documentation

bool input_raw::decode_can_seek ( )

inline

Definition at line 65 of file input_raw.cpp.

{return m_file->can_seek();}

bool input_raw::decode_get_dynamic_info ( file_info &  p_out, double &  p_timestamp_delta  )

inline

Definition at line 66 of file input_raw.cpp.

{return false;} // deals with dynamic information such as VBR bitrates

bool input_raw::decode_get_dynamic_info_track ( file_info &  p_out, double &  p_timestamp_delta  )

inline

Definition at line 67 of file input_raw.cpp.

{return false;} // deals with dynamic information such as track changes in live streams

void input_raw::decode_initialize ( unsigned  p_flags, abort_callback &  p_abort  )

inline

Definition at line 38 of file input_raw.cpp.

                                                                      {
        m_file->reopen(p_abort);//equivalent to seek to zero, except it also works on nonseekable streams
    }

void input_raw::decode_on_idle ( abort_callback &  p_abort )

inline

Definition at line 68 of file input_raw.cpp.

{m_file->on_idle(p_abort);}

bool input_raw::decode_run ( audio_chunk &  p_chunk, abort_callback &  p_abort  )

inline

Definition at line 41 of file input_raw.cpp.

                                                                    {
        enum {
            deltaread = 1024,
        };
        m_buffer.set_size(deltaread * raw_total_sample_width);
        t_size deltaread_done = m_file->read(m_buffer.get_ptr(),deltaread * raw_total_sample_width,p_abort) / raw_total_sample_width;
        if (deltaread_done == 0) return false;//EOF

        p_chunk.set_data_fixedpoint(m_buffer.get_ptr(),deltaread_done * raw_total_sample_width,raw_sample_rate,raw_channels,raw_bits_per_sample,audio_chunk::g_guess_channel_config(raw_channels));
        
        //processed successfully, no EOF
        return true;
    }

void input_raw::decode_seek ( double  p_seconds, abort_callback &  p_abort  )

inline

Definition at line 54 of file input_raw.cpp.

                                                                {
        m_file->ensure_seekable();//throw exceptions if someone called decode_seek() despite of our input having reported itself as nonseekable.
        // IMPORTANT: convert time to sample offset with proper rounding! audio_math::time_to_samples does this properly for you.
        t_filesize target = audio_math::time_to_samples(p_seconds,raw_sample_rate) * raw_total_sample_width;
        
        // get_size_ex fails (throws exceptions) if size is not known (where get_size would return filesize_invalid). Should never fail on seekable streams (if it does it's not our problem anymore).
        t_filesize max = m_file->get_size_ex(p_abort);
        if (target > max) target = max;//clip seek-past-eof attempts to legal range (next decode_run() call will just signal EOF).

        m_file->seek(target,p_abort);
    }

static bool input_raw::g_is_our_content_type ( const char *  p_content_type )

inlinestatic

Definition at line 72 of file input_raw.cpp.

{return false;} // match against supported mime types here

static bool input_raw::g_is_our_path ( const char *  p_path, const char *  p_extension  )

inlinestatic

Definition at line 73 of file input_raw.cpp.

{return stricmp_utf8(p_extension,"raw") == 0;}

t_filestats input_raw::get_file_stats ( abort_callback &  p_abort )

inline

Definition at line 36 of file input_raw.cpp.

{return m_file->get_stats(p_abort);}

void input_raw::get_info ( file_info &  p_info, abort_callback &  p_abort  )

inline

Definition at line 21 of file input_raw.cpp.

                                                               {
        t_filesize size = m_file->get_size(p_abort);
        //note that the file size is not always known, for an example, live streams and alike have no defined size and filesize_invalid is returned
        if (size != filesize_invalid) {
            //file size is known, let's set length
            p_info.set_length(audio_math::samples_to_time( size / raw_total_sample_width, raw_sample_rate));
        }
        //note that the values below should be based on contents of the file itself, NOT on user-configurable variables for an example. To report info that changes independently from file contents, use get_dynamic_info/get_dynamic_info_track instead.
        p_info.info_set_int("samplerate",raw_sample_rate);
        p_info.info_set_int("channels",raw_channels);
        p_info.info_set_int("bitspersample",raw_bits_per_sample);
        p_info.info_set("encoding","lossless");
        p_info.info_set_bitrate((raw_bits_per_sample * raw_channels * raw_sample_rate + 500 /* rounding for bps to kbps*/ ) / 1000 /* bps to kbps */);
        
    }

void input_raw::open ( service_ptr_t< file >  p_filehint, const char *  p_path, t_input_open_reason  p_reason, abort_callback &  p_abort  )

inline

Definition at line 15 of file input_raw.cpp.

                                                                                                                        {
        if (p_reason == input_open_info_write) throw exception_io_unsupported_format();//our input does not support retagging.
        m_file = p_filehint;//p_filehint may be null, hence next line
        input_open_file_helper(m_file,p_path,p_reason,p_abort);//if m_file is null, opens file with appropriate privileges for our operation (read/write for writing tags, read-only otherwise).
    }

void input_raw::retag ( const file_info &  p_info, abort_callback &  p_abort  )

inline

Definition at line 70 of file input_raw.cpp.

{throw exception_io_unsupported_format();}

Field Documentation

pfc::array_t<t_uint8> input_raw::m_buffer

Definition at line 76 of file input_raw.cpp.

service_ptr_t<file> input_raw::m_file

Definition at line 75 of file input_raw.cpp.

---

The documentation for this class was generated from the following file:

• foobar2000/foo_sample/input_raw.cpp