Tag.hxx 4.65 KB
Newer Older
Max Kellermann's avatar
Max Kellermann committed
1
/*
Max Kellermann's avatar
Max Kellermann committed
2
 * Copyright (C) 2003-2015 The Music Player Daemon Project
Max Kellermann's avatar
Max Kellermann committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * http://www.musicpd.org
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef MPD_TAG_HXX
#define MPD_TAG_HXX

23 24
#include "TagType.h" // IWYU pragma: export
#include "TagItem.hxx" // IWYU pragma: export
25
#include "Chrono.hxx"
26
#include "Compiler.h"
Max Kellermann's avatar
Max Kellermann committed
27 28

#include <algorithm>
29
#include <iterator>
Max Kellermann's avatar
Max Kellermann committed
30 31 32 33 34 35 36 37 38

#include <stddef.h>

/**
 * The meta information about a song file.  It is a MPD specific
 * subset of tags (e.g. from ID3, vorbis comments, ...).
 */
struct Tag {
	/**
39 40
	 * The duration of the song.  A negative value means that the
	 * length is unknown.
Max Kellermann's avatar
Max Kellermann committed
41
	 */
42
	SignedSongTime duration;
Max Kellermann's avatar
Max Kellermann committed
43 44 45 46 47 48 49

	/**
	 * Does this file have an embedded playlist (e.g. embedded CUE
	 * sheet)?
	 */
	bool has_playlist;

50 51 52
	/** the total number of tag items in the #items array */
	unsigned short num_items;

Max Kellermann's avatar
Max Kellermann committed
53 54 55 56 57 58
	/** an array of tag items */
	TagItem **items;

	/**
	 * Create an empty tag.
	 */
59
	Tag():duration(SignedSongTime::Negative()), has_playlist(false),
60
	      num_items(0), items(nullptr) {}
Max Kellermann's avatar
Max Kellermann committed
61 62 63 64

	Tag(const Tag &other);

	Tag(Tag &&other)
65
		:duration(other.duration), has_playlist(other.has_playlist),
66
		 num_items(other.num_items), items(other.items) {
Max Kellermann's avatar
Max Kellermann committed
67 68 69 70 71 72 73
		other.items = nullptr;
		other.num_items = 0;
	}

	/**
	 * Free the tag object and all its items.
	 */
74 75 76
	~Tag() {
		Clear();
	}
Max Kellermann's avatar
Max Kellermann committed
77 78 79 80

	Tag &operator=(const Tag &other) = delete;

	Tag &operator=(Tag &&other) {
81
		duration = other.duration;
Max Kellermann's avatar
Max Kellermann committed
82 83 84 85 86 87 88
		has_playlist = other.has_playlist;
		std::swap(items, other.items);
		std::swap(num_items, other.num_items);
		return *this;
	}

	/**
89 90
	 * Returns true if the tag contains no items.  This ignores
	 * the "duration" attribute.
Max Kellermann's avatar
Max Kellermann committed
91 92 93 94 95 96 97 98 99
	 */
	bool IsEmpty() const {
		return num_items == 0;
	}

	/**
	 * Returns true if the tag contains any information.
	 */
	bool IsDefined() const {
100
		return !IsEmpty() || !duration.IsNegative();
Max Kellermann's avatar
Max Kellermann committed
101 102
	}

Max Kellermann's avatar
Max Kellermann committed
103 104 105 106 107
	/**
	 * Clear everything, as if this was a new Tag object.
	 */
	void Clear();

Max Kellermann's avatar
Max Kellermann committed
108 109
	/**
	 * Merges the data from two tags.  If both tags share data for the
110
	 * same TagType, only data from "add" is used.
Max Kellermann's avatar
Max Kellermann committed
111 112 113 114 115 116 117
	 *
	 * @return a newly allocated tag
	 */
	gcc_malloc
	static Tag *Merge(const Tag &base, const Tag &add);

	/**
118
	 * Merges the data from two tags.  Any of the two may be nullptr.  Both
Max Kellermann's avatar
Max Kellermann committed
119 120 121 122 123 124 125 126
	 * are freed by this function.
	 *
	 * @return a newly allocated tag
	 */
	gcc_malloc
	static Tag *MergeReplace(Tag *base, Tag *add);

	/**
127 128
	 * Returns the first value of the specified tag type, or
	 * nullptr if none is present in this tag object.
Max Kellermann's avatar
Max Kellermann committed
129 130
	 */
	gcc_pure
131
	const char *GetValue(TagType type) const;
Max Kellermann's avatar
Max Kellermann committed
132 133 134 135 136

	/**
	 * Checks whether the tag contains one or more items with
	 * the specified type.
	 */
137
	gcc_pure
138
	bool HasType(TagType type) const;
139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

	class const_iterator {
		friend struct Tag;
		const TagItem *const*cursor;

		constexpr const_iterator(const TagItem *const*_cursor)
			:cursor(_cursor) {}

	public:
		constexpr const TagItem &operator*() const {
			return **cursor;
		}

		constexpr const TagItem *operator->() const {
			return *cursor;
		}

		const_iterator &operator++() {
			++cursor;
			return *this;
		}

		const_iterator operator++(int) {
			auto result = cursor++;
			return const_iterator{result};
		}

		const_iterator &operator--() {
			--cursor;
			return *this;
		}

		const_iterator operator--(int) {
			auto result = cursor--;
			return const_iterator{result};
		}

		constexpr bool operator==(const_iterator other) const {
			return cursor == other.cursor;
		}

		constexpr bool operator!=(const_iterator other) const {
			return cursor != other.cursor;
		}
	};

	const_iterator begin() const {
		return const_iterator{items};
	}

	const_iterator end() const {
		return const_iterator{items + num_items};
	}
Max Kellermann's avatar
Max Kellermann committed
192 193 194
};

/**
195
 * Parse the string, and convert it into a #TagType.  Returns
Max Kellermann's avatar
Max Kellermann committed
196 197
 * #TAG_NUM_OF_ITEM_TYPES if the string could not be recognized.
 */
198
gcc_pure
199
TagType
Max Kellermann's avatar
Max Kellermann committed
200 201 202
tag_name_parse(const char *name);

/**
203
 * Parse the string, and convert it into a #TagType.  Returns
Max Kellermann's avatar
Max Kellermann committed
204 205 206 207
 * #TAG_NUM_OF_ITEM_TYPES if the string could not be recognized.
 *
 * Case does not matter.
 */
208
gcc_pure
209
TagType
Max Kellermann's avatar
Max Kellermann committed
210 211 212
tag_name_parse_i(const char *name);

#endif