1*2661106aSZhong Yang /*************************************************************************** 2*2661106aSZhong Yang copyright : (C) 2002 - 2008 by Scott Wheeler 3*2661106aSZhong Yang email : [email protected] 4*2661106aSZhong Yang ***************************************************************************/ 5*2661106aSZhong Yang 6*2661106aSZhong Yang /*************************************************************************** 7*2661106aSZhong Yang * This library is free software; you can redistribute it and/or modify * 8*2661106aSZhong Yang * it under the terms of the GNU Lesser General Public License version * 9*2661106aSZhong Yang * 2.1 as published by the Free Software Foundation. * 10*2661106aSZhong Yang * * 11*2661106aSZhong Yang * This library is distributed in the hope that it will be useful, but * 12*2661106aSZhong Yang * WITHOUT ANY WARRANTY; without even the implied warranty of * 13*2661106aSZhong Yang * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * 14*2661106aSZhong Yang * Lesser General Public License for more details. * 15*2661106aSZhong Yang * * 16*2661106aSZhong Yang * You should have received a copy of the GNU Lesser General Public * 17*2661106aSZhong Yang * License along with this library; if not, write to the Free Software * 18*2661106aSZhong Yang * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA * 19*2661106aSZhong Yang * 02110-1301 USA * 20*2661106aSZhong Yang * * 21*2661106aSZhong Yang * Alternatively, this file is available under the Mozilla Public * 22*2661106aSZhong Yang * License Version 1.1. You may obtain a copy of the License at * 23*2661106aSZhong Yang * http://www.mozilla.org/MPL/ * 24*2661106aSZhong Yang ***************************************************************************/ 25*2661106aSZhong Yang 26*2661106aSZhong Yang #ifndef TAGLIB_UNIQUEFILEIDENTIFIERFRAME 27*2661106aSZhong Yang #define TAGLIB_UNIQUEFILEIDENTIFIERFRAME 28*2661106aSZhong Yang 29*2661106aSZhong Yang #include "id3v2frame.h" 30*2661106aSZhong Yang 31*2661106aSZhong Yang namespace TagLib { 32*2661106aSZhong Yang 33*2661106aSZhong Yang namespace ID3v2 { 34*2661106aSZhong Yang 35*2661106aSZhong Yang /*! 36*2661106aSZhong Yang * This is an implementation of ID3v2 unique file identifier frames. This 37*2661106aSZhong Yang * frame is used to identify the file in an arbitrary database identified 38*2661106aSZhong Yang * by the owner field. 39*2661106aSZhong Yang */ 40*2661106aSZhong Yang 41*2661106aSZhong Yang //! An implementation of ID3v2 unique identifier frames 42*2661106aSZhong Yang 43*2661106aSZhong Yang class TAGLIB_EXPORT UniqueFileIdentifierFrame : public ID3v2::Frame 44*2661106aSZhong Yang { 45*2661106aSZhong Yang friend class FrameFactory; 46*2661106aSZhong Yang 47*2661106aSZhong Yang public: 48*2661106aSZhong Yang /*! 49*2661106aSZhong Yang * Creates a unique file identifier frame based on \a data. 50*2661106aSZhong Yang */ 51*2661106aSZhong Yang UniqueFileIdentifierFrame(const ByteVector &data); 52*2661106aSZhong Yang 53*2661106aSZhong Yang /*! 54*2661106aSZhong Yang * Creates a unique file identifier frame with the owner \a owner and 55*2661106aSZhong Yang * the identification \a id. 56*2661106aSZhong Yang */ 57*2661106aSZhong Yang UniqueFileIdentifierFrame(const String &owner, const ByteVector &id); 58*2661106aSZhong Yang 59*2661106aSZhong Yang /*! 60*2661106aSZhong Yang * Destroys the frame. 61*2661106aSZhong Yang */ 62*2661106aSZhong Yang ~UniqueFileIdentifierFrame(); 63*2661106aSZhong Yang 64*2661106aSZhong Yang /*! 65*2661106aSZhong Yang * Returns the owner for the frame; essentially this is the key for 66*2661106aSZhong Yang * determining which identification scheme this key belongs to. This 67*2661106aSZhong Yang * will usually either be an email address or URL for the person or tool 68*2661106aSZhong Yang * used to create the unique identifier. 69*2661106aSZhong Yang * 70*2661106aSZhong Yang * \see setOwner() 71*2661106aSZhong Yang */ 72*2661106aSZhong Yang String owner() const; 73*2661106aSZhong Yang 74*2661106aSZhong Yang /*! 75*2661106aSZhong Yang * Returns the unique identifier. Though sometimes this is a text string 76*2661106aSZhong Yang * it also may be binary data and as much should be assumed when handling 77*2661106aSZhong Yang * it. 78*2661106aSZhong Yang */ 79*2661106aSZhong Yang ByteVector identifier() const; 80*2661106aSZhong Yang 81*2661106aSZhong Yang /*! 82*2661106aSZhong Yang * Sets the owner of the identification scheme to \a s. 83*2661106aSZhong Yang * 84*2661106aSZhong Yang * \see owner() 85*2661106aSZhong Yang */ 86*2661106aSZhong Yang void setOwner(const String &s); 87*2661106aSZhong Yang 88*2661106aSZhong Yang /*! 89*2661106aSZhong Yang * Sets the unique file identifier to \a v. 90*2661106aSZhong Yang * 91*2661106aSZhong Yang * \see identifier() 92*2661106aSZhong Yang */ 93*2661106aSZhong Yang void setIdentifier(const ByteVector &v); 94*2661106aSZhong Yang 95*2661106aSZhong Yang virtual String toString() const; 96*2661106aSZhong Yang 97*2661106aSZhong Yang PropertyMap asProperties() const; 98*2661106aSZhong Yang 99*2661106aSZhong Yang /*! 100*2661106aSZhong Yang * UFID frames each have a unique owner. This searches for a UFID 101*2661106aSZhong Yang * frame with the owner \a o and returns a pointer to it. 102*2661106aSZhong Yang * 103*2661106aSZhong Yang * \see owner() 104*2661106aSZhong Yang */ 105*2661106aSZhong Yang static UniqueFileIdentifierFrame *findByOwner(const Tag *tag, const String &o); 106*2661106aSZhong Yang 107*2661106aSZhong Yang protected: 108*2661106aSZhong Yang virtual void parseFields(const ByteVector &data); 109*2661106aSZhong Yang virtual ByteVector renderFields() const; 110*2661106aSZhong Yang 111*2661106aSZhong Yang private: 112*2661106aSZhong Yang UniqueFileIdentifierFrame(const UniqueFileIdentifierFrame &); 113*2661106aSZhong Yang UniqueFileIdentifierFrame &operator=(const UniqueFileIdentifierFrame &); 114*2661106aSZhong Yang 115*2661106aSZhong Yang UniqueFileIdentifierFrame(const ByteVector &data, Header *h); 116*2661106aSZhong Yang 117*2661106aSZhong Yang class UniqueFileIdentifierFramePrivate; 118*2661106aSZhong Yang UniqueFileIdentifierFramePrivate *d; 119*2661106aSZhong Yang }; 120*2661106aSZhong Yang } 121*2661106aSZhong Yang } 122*2661106aSZhong Yang 123*2661106aSZhong Yang #endif 124