Exiv2
riffvideo.hpp
1 // ***************************************************************** -*- C++ -*-
2 /*
3  * Copyright (C) 2004-2021 Exiv2 authors
4  * This program is part of the Exiv2 distribution.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
19  */
20 #ifndef RIFFVIDEO_HPP
21 #define RIFFVIDEO_HPP
22 
23 // *****************************************************************************
24 #include "exiv2lib_export.h"
25 
26 // included header files
27 #include "exif.hpp"
28 #include "image.hpp"
29 
30 // *****************************************************************************
31 // namespace extensions
32 namespace Exiv2 {
33 
34 // *****************************************************************************
35 // class definitions
36 
37  // Add RIFF to the supported image formats
38  namespace ImageType {
39  const int riff = 20;
40  }
41 
45  class EXIV2LIB_DEPRECATED_EXPORT RiffVideo:public Image
46  {
47  public:
49 
50 
63 
65 
66  void printStructure(std::ostream& out, PrintStructureOption option,int depth);
67  void readMetadata();
68  void writeMetadata();
70 
72 
73  std::string mimeType() const;
74  const char* printAudioEncoding(uint64_t i);
76 
77  protected:
82  void decodeBlock();
91  void tagDecoder(Exiv2::DataBuf& buf, unsigned long size);
97  void junkHandler(long size);
103  void streamHandler(long size);
109  void streamFormatHandler(long size);
115  void aviHeaderTagsHandler(long size);
121  void listHandler(long size);
127  void streamDataTagHandler(long size);
132  void infoTagsHandler();
137  void nikonTagsHandler();
142  void odmlTagsHandler();
144  void skipListData();
151  void dateTimeOriginal(long size, int i = 0);
158  double returnSampleRate(Exiv2::DataBuf& buf, long divisor = 1);
165  void fillAspectRatio(long width = 1,long height = 1);
172  void fillDuration(double frame_rate, long frame_count);
173 
174  private:
176 
177  RiffVideo(const RiffVideo& rhs);
180  RiffVideo& operator=(const RiffVideo& rhs);
181  bool equalsRiffTag(Exiv2::DataBuf& buf ,const char* str);
183 
184  private:
185  const static int RIFF_TAG_SIZE;
186  const static char* RIFF_CHUNK_HEADER_ICCP;
187  const static char* RIFF_CHUNK_HEADER_EXIF;
188  const static char* RIFF_CHUNK_HEADER_XMP;
190  bool continueTraversing_;
192  int streamType_;
193 
194  }; //Class RiffVideo
195 
196 // *****************************************************************************
197 // template, inline and free functions
198 
199  // These could be static private functions on Image subclasses but then
200  // ImageFactory needs to be made a friend.
206  EXIV2LIB_DEPRECATED_EXPORT Image::AutoPtr newRiffInstance(BasicIo::AutoPtr io, bool create);
207 
209  EXIV2LIB_DEPRECATED_EXPORT bool isRiffType(BasicIo& iIo, bool advance);
210 
211 } // namespace Exiv2
212 
213 #endif // RIFFVIDEO_HPP
Exiv2::Internal::TagDetails
Helper structure for lookup tables for translations of numeric tag values to human readable labels.
Definition: tags_int.hpp:225
Exiv2::RiffVideo::odmlTagsHandler
void odmlTagsHandler()
Interpret OpenDML tag information, and save it in the respective XMP container.
Exiv2::DataBuf::pData_
byte * pData_
Pointer to the buffer, 0 if none has been allocated.
Definition: types.hpp:258
Exiv2::Internal::indent
std::string indent(int32_t d)
indent output for kpsRecursive in printStructure() .
Definition: image_int.cpp:106
exif.hpp
Encoding and decoding of Exif data.
Exiv2::RiffVideo
Class to access RIFF video files.
Definition: riffvideo.hpp:45
Exiv2::RiffVideo::tagDecoder
void tagDecoder(Exiv2::DataBuf &buf, unsigned long size)
Interpret tag information, and call the respective function to save it in the respective XMP containe...
Exiv2::RiffVideo::streamHandler
void streamHandler(long size)
Interpret Stream tag information, and save it in the respective XMP container.
Exiv2::IptcData::empty
bool empty() const
Return true if there is no IPTC metadata.
Definition: iptc.hpp:255
Exiv2::RiffVideo::infoTagsHandler
void infoTagsHandler()
Interpret INFO tag information, and save it in the respective XMP container.
Exiv2::RiffVideo::writeMetadata
void writeMetadata()
Write metadata back to the image.
Exiv2::makeSlice
Slice< T > makeSlice(T &cont, size_t begin, size_t end)
Return a new slice with the given bounds.
Definition: slice.hpp:665
Exiv2::RiffVideo::printStructure
void printStructure(std::ostream &out, PrintStructureOption option, int depth)
Print out the structure of image file.
Exiv2::exvGettext
const EXIV2API char * exvGettext(const char *str)
Translate a string using the gettext framework. This wrapper hides all the implementation details fro...
Definition: types.cpp:571
Exiv2::RiffVideo::RiffVideo
RiffVideo(BasicIo::AutoPtr io)
Constructor for a Riff video. Since the constructor can not return a result, callers should check the...
Exiv2::RiffVideo::skipListData
void skipListData()
Skips Particular Blocks of Metadata List.
Exiv2::strError
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:316
Exiv2::Internal::TagVocabulary
Helper structure for lookup tables for translations of controlled vocabulary strings to their descrip...
Definition: tags_int.hpp:246
Exiv2::XmpTextValue
Value type suitable for simple XMP properties and XMP nodes of complex types which are not parsed int...
Definition: value.hpp:715
Exiv2::Image::exifData_
ExifData exifData_
Exif data container.
Definition: image.hpp:485
Exiv2::RiffVideo::junkHandler
void junkHandler(long size)
Interpret Junk tag information, and save it in the respective XMP container.
Exiv2::RiffVideo::decodeBlock
void decodeBlock()
Check for a valid tag and decode the block at the current IO position. Calls tagDecoder() or skips to...
Exiv2::XmpKey
Concrete keys for XMP metadata.
Definition: properties.hpp:230
Exiv2::Internal::binaryToString
binaryToStringHelper< T > binaryToString(const Slice< T > sl)
format binary data for display in Image::printStructure()
Definition: image_int.hpp:118
Exiv2::RiffVideo::dateTimeOriginal
void dateTimeOriginal(long size, int i=0)
Interprets DateTimeOriginal tag or stream name tag information, and save it in the respective XMP con...
Exiv2::newRiffInstance
EXIV2LIB_DEPRECATED_EXPORT Image::AutoPtr newRiffInstance(BasicIo::AutoPtr io, bool create)
Create a new RiffVideo instance and return an auto-pointer to it. Caller owns the returned object and...
Exiv2::Image::clearMetadata
virtual void clearMetadata()
Erase all buffered metadata. Metadata is not removed from the actual image until the writeMetadata() ...
Definition: image.cpp:570
Exiv2::RiffVideo::streamFormatHandler
void streamFormatHandler(long size)
Interpret Stream Format tag information, and save it in the respective XMP container.
Exiv2::Internal::TiffMapping::findDecoder
static DecoderFct findDecoder(const std::string &make, uint32_t extendedTag, IfdId group)
Find the decoder function for a key.
Definition: tiffimage_int.cpp:1640
Exiv2::Internal::stringFormat
std::string stringFormat(const char *format,...)
format a string in the pattern of sprintf .
Definition: image_int.cpp:32
Exiv2::Image::printTiffStructure
void printTiffStructure(BasicIo &io, std::ostream &out, PrintStructureOption option, int depth, size_t offset=0)
Print out the structure of image file.
Definition: image.cpp:552
Exiv2::DataBuf
Utility class containing a character array. All it does is to take care of memory allocation and dele...
Definition: types.hpp:193
Exiv2::DataBuf::size_
long size_
The current size of the buffer.
Definition: types.hpp:260
Exiv2::getLong
EXIV2API int32_t getLong(const byte *buf, ByteOrder byteOrder)
Read a 4 byte signed long value from the data buffer.
Definition: types.cpp:323
Exiv2::Internal::TagDetails::label_
const char * label_
Translation of the tag value.
Definition: tags_int.hpp:227
Exiv2::find
const T * find(T(&src)[N], const K &key)
Find an element that matches key in the array src.
Definition: types.hpp:497
Exiv2::isRiffType
EXIV2LIB_DEPRECATED_EXPORT bool isRiffType(BasicIo &iIo, bool advance)
Check if the file iIo is a Riff Video.
Exiv2
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
Exiv2::XmpData::empty
bool empty() const
Return true if there is no XMP metadata.
Definition: xmp.cpp:528
Exiv2::Image::io
virtual BasicIo & io() const
Return a reference to the BasicIo instance being used for Io.
Definition: image.cpp:752
Exiv2::BasicIo::path
virtual std::string path() const =0
Return the path to the IO resource. Often used to form comprehensive error messages where only a Basi...
Exiv2::RiffVideo::fillAspectRatio
void fillAspectRatio(long width=1, long height=1)
Calculates Aspect Ratio of a video, and stores it in the respective XMP container.
Exiv2::RiffVideo::readMetadata
void readMetadata()
Read all metadata supported by a specific image format from the image. Before this method is called,...
EXV_WARNING
#define EXV_WARNING
Shorthand for a temp warning log message object and return its ostringstream.
Definition: error.hpp:148
Exiv2::getUShort
EXIV2API uint16_t getUShort(const byte *buf, ByteOrder byteOrder)
Read a 2 byte unsigned short value from the data buffer.
Definition: types.cpp:273
Exiv2::Image::io_
BasicIo::AutoPtr io_
Image data IO pointer.
Definition: image.hpp:484
Exiv2::ByteOrder
ByteOrder
Type to express the byte order (little or big endian)
Definition: types.hpp:102
Exiv2::Internal
Contains internal objects which are not published and are not part of the libexiv2 API.
Definition: slice.hpp:31
Exiv2::RiffVideo::aviHeaderTagsHandler
void aviHeaderTagsHandler(long size)
Interpret Riff Header tag information, and save it in the respective XMP container.
Exiv2::Image::AutoPtr
std::auto_ptr< Image > AutoPtr
Image auto_ptr type.
Definition: image.hpp:81
Exiv2::RiffVideo::returnSampleRate
double returnSampleRate(Exiv2::DataBuf &buf, long divisor=1)
Calculates Sample Rate of a particular stream.
Exiv2::RiffVideo::nikonTagsHandler
void nikonTagsHandler()
Interpret Nikon Tags related to Video information, and save it in the respective XMP container.
Exiv2::RiffVideo::streamDataTagHandler
void streamDataTagHandler(long size)
Interpret Riff Stream Data tag information, and save it in the respective XMP container.
Exiv2::ImageType::riff
const int riff
Treating riff as an image type>
Definition: riffvideo.hpp:39
Exiv2::BasicIo::AutoPtr
std::auto_ptr< BasicIo > AutoPtr
BasicIo auto_ptr type.
Definition: basicio.hpp:58
Exiv2::Error
BasicError< char > Error
Error class used for exceptions (std::string based)
Definition: error.hpp:324
Exiv2::RiffVideo::fillDuration
void fillDuration(double frame_rate, long frame_count)
Calculates Duration of a video, and stores it in the respective XMP container.
Exiv2::XmpData::add
int add(const XmpKey &key, const Value *value)
Add an Xmpdatum from the supplied key and value pair. This method copies (clones) the value.
Definition: xmp.cpp:485
Exiv2::Internal::TagVocabulary::label_
const char * label_
Description of the vocabulary string.
Definition: tags_int.hpp:248
Exiv2::PrintStructureOption
PrintStructureOption
Options for printStructure.
Definition: image.hpp:64
Exiv2::meteringMode
EXIV2API ExifData::const_iterator meteringMode(const ExifData &ed)
Return the metering mode setting.
Definition: easyaccess.cpp:426
EXV_ERROR
#define EXV_ERROR
Shorthand for a temp error log message object and return its ostringstream.
Definition: error.hpp:150
Exiv2::toString
std::string toString(const T &arg)
Utility function to convert the argument of any type to a string.
Definition: types.hpp:510
Exiv2::BasicIo
An interface for simple binary IO.
Definition: basicio.hpp:55
Exiv2::Image::xmpData_
XmpData xmpData_
XMP data container.
Definition: image.hpp:487
Exiv2::RiffVideo::mimeType
std::string mimeType() const
Return the MIME type of the image.
Exiv2::Image::xmpData
virtual XmpData & xmpData()
Returns an XmpData instance containing currently buffered XMP data.
Definition: image.cpp:590
Exiv2::Image
Abstract base class defining the interface for an image. This is the top-level interface to the Exiv2...
Definition: image.hpp:78
Exiv2::Internal::TiffParserWorker::decode
static ByteOrder decode(ExifData &exifData, IptcData &iptcData, XmpData &xmpData, const byte *pData, uint32_t size, uint32_t root, FindDecoderFct findDecoderFct, TiffHeaderBase *pHeader=0)
Decode TIFF metadata from a data buffer pData of length size into the provided metadata containers.
Definition: tiffimage_int.cpp:1717
Exiv2::Image::iptcData
virtual IptcData & iptcData()
Returns an IptcData instance containing currently buffered IPTC data.
Definition: image.cpp:585
Exiv2::getULong
EXIV2API uint32_t getULong(const byte *buf, ByteOrder byteOrder)
Read a 4 byte unsigned long value from the data buffer.
Definition: types.cpp:278
error.hpp
Error class for exceptions, log message class.
Exiv2::dateTimeOriginal
EXIV2API ExifData::const_iterator dateTimeOriginal(const ExifData &ed)
Return the date and time when the original image data was generated.
Definition: easyaccess.cpp:186