playback_control.h

Go to the documentation of this file.

class NOVTABLE playback_control : public service_base {
    FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT(playback_control);
public:

    // Playback stop reason enum.
    enum t_stop_reason {
        stop_reason_user = 0,
        stop_reason_eof,
        stop_reason_starting_another,
        stop_reason_shutting_down,
    };

    // Playback start mode enum.
    enum t_track_command {
        track_command_default = 0,
        track_command_play,
        track_command_next,
        track_command_prev,
        track_command_settrack,
        track_command_rand,

        track_command_resume,
    };

    virtual bool get_now_playing(metadb_handle_ptr & p_out) = 0;
    virtual void start(t_track_command p_command = track_command_play,bool p_paused = false) = 0;
    virtual void stop() = 0;
    virtual bool is_playing() = 0;
    virtual bool is_paused() = 0;
    virtual void pause(bool p_state) = 0;

    virtual bool get_stop_after_current() = 0;
    virtual void set_stop_after_current(bool p_state) = 0;
    
    virtual void set_volume(float p_value) = 0;
    virtual float get_volume() = 0;
    virtual void volume_up() = 0;
    virtual void volume_down() = 0;
    virtual void volume_mute_toggle() = 0;
    virtual void playback_seek(double p_time) = 0;
    virtual void playback_seek_delta(double p_delta) = 0;
    virtual bool playback_can_seek() = 0;
    virtual double playback_get_position() = 0;

    enum t_display_level {
        display_level_none,
        display_level_basic,
        display_level_titles,
        display_level_all,
    };

    virtual bool playback_format_title(titleformat_hook * p_hook,pfc::string_base & p_out,const service_ptr_t<class titleformat_object> & p_script,titleformat_text_filter * p_filter,t_display_level p_level) = 0;
    


    bool playback_format_title_ex(metadb_handle_ptr p_item,titleformat_hook * p_hook,pfc::string_base & p_out,const service_ptr_t<class titleformat_object> & p_script,titleformat_text_filter * p_filter,t_display_level p_level) {
        if (p_item.is_empty()) return playback_format_title(p_hook,p_out,p_script,p_filter,p_level);
        metadb_handle_ptr temp;
        if (get_now_playing(temp)) {
            if (temp == p_item) {
                return playback_format_title(p_hook,p_out,p_script,p_filter,p_level);
            }
        }
        p_item->format_title(p_hook,p_out,p_script,p_filter);
        return true;
    }
    
    double playback_get_length();
    // Extended version: queries dynamic track info for the rare cases where that is different from static info.
    double playback_get_length_ex();

    void toggle_stop_after_current() {set_stop_after_current(!get_stop_after_current());}
    void toggle_pause() {pause(!is_paused());}

    void play_or_pause() {if (is_playing()) toggle_pause(); else start();}
    void play_or_unpause() { if (is_playing()) pause(false); else start();}

    void previous() { start(track_command_prev); }
    void next() { start(track_command_next); }
    
    //deprecated
    inline void play_start(t_track_command p_command = track_command_play,bool p_paused = false) {start(p_command,p_paused);}
    //deprecated
    inline void play_stop() {stop();}

    bool is_muted() {return get_volume() == volume_mute;}

    static const int volume_mute = -100;
};

class playback_control_v2 : public playback_control {
    FB2K_MAKE_SERVICE_INTERFACE(playback_control_v2,playback_control);
public:
    virtual float get_volume_step() = 0;
};

class playback_control_v3 : public playback_control_v2 {
    FB2K_MAKE_SERVICE_INTERFACE(playback_control_v3, playback_control_v2);
public:
    virtual bool custom_volume_is_active() = 0;
    virtual int custom_volume_get() = 0;    
    virtual void custom_volume_set(int val) = 0;
    virtual int custom_volume_min() = 0;
    virtual int custom_volume_max() = 0;

    virtual void restart() = 0;
};

//for compatibility with old code
typedef playback_control play_control;