gstreamer/ext/metadata/metadata.h
Edgard Lima 9e31b57dc3 Add lot of documentation.
Original commit message from CVS:
Add lot of documentation.
2008-01-25 17:45:28 +00:00

140 lines
4 KiB
C

/*
* GStreamer
* Copyright 2007 Edgard Lima <edgard.lima@indt.org.br>
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
* Alternatively, the contents of this file may be used under the
* GNU Lesser General Public License Version 2.1 (the "LGPL"), in
* which case the following provisions apply instead of the ones
* mentioned above:
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
#ifndef __METADATA_H__
#define __METADATA_H__
/*
* includes
*/
#include <gst/base/gstadapter.h>
#include "metadatatypes.h"
#include "metadataparsejpeg.h"
#include "metadatamuxjpeg.h"
#include "metadataparsepng.h"
#include "metadatamuxpng.h"
G_BEGIN_DECLS
/*
* enum and types
*/
/* *INDENT-OFF* */
typedef enum _tag_MetaOptions
{
META_OPT_EXIF = (1 << 0),
META_OPT_IPTC = (1 << 1),
META_OPT_XMP = (1 << 2),
META_OPT_PARSE_ONLY = (1 << 3), /* only makes sense with META_OPT_DEMUX */
META_OPT_DEMUX = (1 << 4), /* to operates in demuxing mode */
META_OPT_MUX = (1 << 5), /* to operates in muxing mode */
META_OPT_ALL = (1 << 6) - 1
} MetaOptions;
/* *INDENT-ON* */
typedef enum _tag_MetaState
{
STATE_NULL,
STATE_READING,
STATE_DONE
} MetaState;
typedef enum _tag_ImageType
{
IMG_NONE,
IMG_JPEG,
IMG_PNG
} ImageType;
typedef struct _tag_MetaData
{
MetaState state;
ImageType img_type;
guint8 options;
guint32 offset_orig; /* offset since begining of stream */
union
{
JpegParseData jpeg_parse;
JpegMuxData jpeg_mux;
PngParseData png_parse;
PngMuxData png_mux;
} format_data;
GstAdapter * exif_adapter;
GstAdapter * iptc_adapter;
GstAdapter * xmp_adapter;
MetadataChunkArray strip_chunks;
MetadataChunkArray inject_chunks;
} MetaData;
/*
* defines and macros
*/
#define META_DATA_IMG_TYPE(p) (p)->img_type
#define META_DATA_STRIP_CHUNKS(p) (p)->strip_chunks
#define META_DATA_INJECT_CHUNKS(p) (p)->inject_chunks
/*
* external function prototypes
*/
extern void metadata_init (MetaData ** meta_data, const MetaOptions options);
extern void metadata_dispose (MetaData ** meta_data);
extern MetadataParsingReturn
metadata_parse (MetaData * meta_data, const guint8 * buf,
guint32 buf_size, guint32 * next_offset, guint32 * next_size);
extern void metadata_lazy_update (MetaData * meta_data);
G_END_DECLS
#endif /* __METADATA_H__ */