src/KLV.h

   1 /*
   2 Copyright (c) 2005-2009, John Hurst
   3 All rights reserved.
   4
   5 Redistribution and use in source and binary forms, with or without
   6 modification, are permitted provided that the following conditions
   7 are met:
   8 1. Redistributions of source code must retain the above copyright
   9    notice, this list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright
  11    notice, this list of conditions and the following disclaimer in the
  12    documentation and/or other materials provided with the distribution.
  13 3. The name of the author may not be used to endorse or promote products
  14    derived from this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27 /*! \file    KLV.h
  28   \version $Id$
  29   \brief   KLV objects
  30 */
  31
  32 #ifndef _KLV_H_
  33 #define _KLV_H_
  34
  35 #include <KM_fileio.h>
  36 #include <KM_memio.h>
  37 #include "AS_DCP.h"
  38 #include "MDD.h"
  39 #include <map>
  40
  41
  42 namespace ASDCP
  43 {
  44   const ui32_t MXF_BER_LENGTH = 4;
  45   const ui32_t MXF_TAG_LENGTH = 2;
  46   const ui32_t SMPTE_UL_LENGTH = 16;
  47   const ui32_t SMPTE_UMID_LENGTH = 32;
  48   const byte_t SMPTE_UL_START[4] = { 0x06, 0x0e, 0x2b, 0x34 };
  49
  50 #ifndef MAX_KLV_PACKET_LENGTH
  51   const ui32_t MAX_KLV_PACKET_LENGTH = 1024*1024*64;
  52 #endif
  53
  54   const ui32_t IdentBufferLen = 128;
  55   const ui32_t IntBufferLen = 64;
  56
  57 inline const char* i64sz(i64_t i, char* buf)
  58 {
  59   assert(buf);
  60 #ifdef WIN32
  61   snprintf(buf, IntBufferLen, "%I64d", i);
  62 #else
  63   snprintf(buf, IntBufferLen, "%lld", i);
  64 #endif
  65   return buf;
  66 }
  67
  68 inline const char* ui64sz(ui64_t i, char* buf)
  69 {
  70   assert(buf);
  71 #ifdef WIN32
  72   snprintf(buf, IntBufferLen, "%I64u", i);
  73 #else
  74   snprintf(buf, IntBufferLen, "%llu", i);
  75 #endif
  76   return buf;
  77 }
  78
  79   struct TagValue
  80   {
  81     byte_t a;
  82     byte_t b;
  83
  84     inline bool operator<(const TagValue& rhs) const {
  85       if ( a < rhs.a ) return true;
  86       if ( a == rhs.a && b < rhs.b ) return true;
  87       return false;
  88     }
  89
  90     inline bool operator==(const TagValue& rhs) const {
  91       if ( a != rhs.a ) return false;
  92       if ( b != rhs.b ) return false;
  93       return true;
  94     }
  95   };
  96
  97   using Kumu::UUID;
  98
  99   // Universal Label
 100   class UL : public Kumu::Identifier<SMPTE_UL_LENGTH>
 101     {
 102     public:
 103       UL() {}
 104       UL(const UL& rhs) : Kumu::Identifier<SMPTE_UL_LENGTH>(rhs) {}
 105       UL(const byte_t* value) : Kumu::Identifier<SMPTE_UL_LENGTH>(value) {}
 106       virtual ~UL() {}
 107
 108       const char* EncodeString(char* str_buf, ui32_t buf_len) const;
 109     };
 110
 111   // UMID
 112   class UMID : public Kumu::Identifier<SMPTE_UMID_LENGTH>
 113     {
 114     public:
 115       UMID() {}
 116       UMID(const UMID& rhs) : Kumu::Identifier<SMPTE_UMID_LENGTH>(rhs) {}
 117       UMID(const byte_t* value) : Kumu::Identifier<SMPTE_UMID_LENGTH>(value) {}
 118       virtual ~UMID() {}
 119
 120       void MakeUMID(int Type);
 121       void MakeUMID(int Type, const UUID& ID);
 122       const char* EncodeString(char* str_buf, ui32_t buf_len) const;
 123     };
 124
 125   const byte_t nil_UMID[SMPTE_UMID_LENGTH] = {0};
 126   const UMID NilUMID(nil_UMID);
 127
 128   //
 129   struct MDDEntry
 130   {
 131     byte_t        ul[SMPTE_UL_LENGTH];
 132     TagValue      tag;
 133     bool          optional;
 134     const char*   name;
 135   };
 136
 137   //
 138   class Dictionary
 139     {
 140       std::map<ASDCP::UL, ui32_t> m_md_lookup;
 141       std::map<ui32_t, ASDCP::UL> m_md_rev_lookup;
 142       MDDEntry m_MDD_Table[ASDCP::MDD_Table_size];
 143
 144       ASDCP_NO_COPY_CONSTRUCT(Dictionary);
 145
 146     public:
 147       Dictionary();
 148       ~Dictionary();
 149
 150       bool operator==(const Dictionary& rhs) const { return this == &rhs; }
 151
 152       void Init();
 153       bool AddEntry(const MDDEntry& Entry, ui32_t index);
 154       bool DeleteEntry(ui32_t index);
 155
 156       const MDDEntry* FindUL(const byte_t*) const;
 157       const MDDEntry& Type(MDD_t type_id) const;
 158
 159       inline const byte_t* ul(MDD_t type_id) const {
 160         return Type(type_id).ul;
 161       }
 162
 163       void Dump(FILE* = 0) const;
 164     };
 165
 166
 167   const Dictionary& DefaultSMPTEDict();
 168   const Dictionary& DefaultInteropDict();
 169   const Dictionary& DefaultCompositeDict();
 170
 171
 172   //
 173   class IPrimerLookup
 174     {
 175     public:
 176       virtual ~IPrimerLookup() {}
 177       virtual void     ClearTagList() = 0;
 178       virtual Result_t InsertTag(const MDDEntry& Entry, ASDCP::TagValue& Tag) = 0;
 179       virtual Result_t TagForKey(const ASDCP::UL& Key, ASDCP::TagValue& Tag) = 0;
 180     };
 181
 182   //
 183   class KLVPacket
 184     {
 185       ASDCP_NO_COPY_CONSTRUCT(KLVPacket);
 186
 187     protected:
 188       const byte_t* m_KeyStart;
 189       ui32_t        m_KLLength;
 190       const byte_t* m_ValueStart;
 191       ui32_t        m_ValueLength;
 192
 193     public:
 194       KLVPacket() : m_KeyStart(0), m_KLLength(0), m_ValueStart(0), m_ValueLength(0) {}
 195       virtual ~KLVPacket() {}
 196
 197       ui32_t  PacketLength() {
 198         return m_KLLength + m_ValueLength;
 199       }
 200
 201       virtual bool     HasUL(const byte_t*);
 202       virtual Result_t InitFromBuffer(const byte_t*, ui32_t);
 203       virtual Result_t InitFromBuffer(const byte_t*, ui32_t, const UL& label);
 204       virtual Result_t WriteKLToBuffer(ASDCP::FrameBuffer&, const UL& label, ui32_t length);
 205       virtual void     Dump(FILE*, const Dictionary& Dict, bool show_value);
 206     };
 207
 208   //
 209   class KLVFilePacket : public KLVPacket
 210     {
 211       ASDCP_NO_COPY_CONSTRUCT(KLVFilePacket);
 212
 213     protected:
 214       ASDCP::FrameBuffer m_Buffer;
 215
 216     public:
 217       KLVFilePacket() {}
 218       virtual ~KLVFilePacket() {}
 219
 220       virtual Result_t InitFromFile(const Kumu::FileReader&);
 221       virtual Result_t InitFromFile(const Kumu::FileReader&, const UL& label);
 222       virtual Result_t WriteKLToFile(Kumu::FileWriter& Writer, const UL& label, ui32_t length);
 223     };
 224
 225 } // namespace ASDCP
 226
 227 #endif // _KLV_H_
 228
 229
 230 //
 231 // end KLV.h
 232 //