annotate foosdk/sdk/foobar2000/SDK/playable_location.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 //playable_location stores location of a playable resource, currently implemented as file path and integer for indicating multiple playable "subsongs" per file
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
4 //also see: file_info.h
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
5 //for getting more info about resource referenced by a playable_location, see metadb.h
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
6
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
7 //char* strings are all UTF-8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
8
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
9 class NOVTABLE playable_location//interface (for passing around between DLLs)
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
10 {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
11 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
12 virtual const char * get_path() const = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
13 virtual void set_path(const char*) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
14 virtual t_uint32 get_subsong() const = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
15 virtual void set_subsong(t_uint32) = 0;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
16
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
17 void copy(const playable_location & p_other) {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
18 set_path(p_other.get_path());
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
19 set_subsong(p_other.get_subsong());
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
20 }
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
21
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
22 static int g_compare(const playable_location & p_item1,const playable_location & p_item2);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
23 static bool g_equals( const playable_location & p_item1, const playable_location & p_item2);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
24
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
25 const playable_location & operator=(const playable_location & src) {copy(src);return *this;}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
26
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
27 bool operator==(const playable_location & p_other) const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
28 bool operator!=(const playable_location & p_other) const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
29
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
30 void reset();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
31
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
32 inline t_uint32 get_subsong_index() const {return get_subsong();}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
33 inline void set_subsong_index(t_uint32 v) {set_subsong(v);}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
34
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
35 bool is_empty() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
36 bool is_valid() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
37
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
38
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
39 enum {case_sensitive = true};
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
40 typedef pfc::comparator_strcmp path_comparator;
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 class comparator {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
43 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
44 static int compare(const playable_location & v1, const playable_location & v2) {return g_compare(v1,v2);}
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 static int path_compare( const char * p1, const char * p2 );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
47
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
48 protected:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
49 playable_location() {}
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
50 ~playable_location() {}
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
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
53 typedef playable_location * pplayable_location;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
54 typedef playable_location const * pcplayable_location;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
55 typedef playable_location & rplayable_location;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
56 typedef playable_location const & rcplayable_location;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
57
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
58 class playable_location_impl : public playable_location//implementation
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
59 {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
60 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
61 virtual const char * get_path() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
62 virtual void set_path(const char* p_path);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
63 virtual t_uint32 get_subsong() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
64 virtual void set_subsong(t_uint32 p_subsong);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
65
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
66 const playable_location_impl & operator=(const playable_location & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
67
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
68 playable_location_impl();
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
69 playable_location_impl(const char * p_path,t_uint32 p_subsong);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
70 playable_location_impl(const playable_location & src);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
71 private:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
72 pfc::string_simple m_path;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
73 t_uint32 m_subsong;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
74 };
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
75
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
76 // usage: somefunction( make_playable_location("file://c:\blah.ogg",0) );
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
77 // only for use as a parameter to a function taking const playable_location &
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
78 class make_playable_location : public playable_location
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
79 {
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
80 const char * path;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
81 t_uint32 num;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
82
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
83 virtual void set_path(const char*);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
84 virtual void set_subsong(t_uint32);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
85 public:
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
86 virtual const char * get_path() const;
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
87 virtual t_uint32 get_subsong() const;
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 make_playable_location(const char * p_path,t_uint32 p_num);
20d02a178406 *: check in everything else
Paper <paper@tflc.us>
parents:
diff changeset
90 };
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 pfc::string_base & operator<<(pfc::string_base & p_fmt,const playable_location & p_location);