/usr/include/gstreamermm-1.0/gstreamermm/format.h is in libgstreamermm-1.0-dev 1.4.3+dfsg-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 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 192 193 194 195 196 197 198 199 200 201 | // -*- c++ -*-
// Generated by gmmproc 2.42.0 -- DO NOT MODIFY!
#ifndef _GSTREAMERMM_FORMAT_H
#define _GSTREAMERMM_FORMAT_H
#include <glibmm/ustring.h>
#include <sigc++/sigc++.h>
/* gstreamermm - a C++ wrapper for gstreamer
*
* Copyright 2008 The gstreamermm Development Team
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gst/gst.h>
#include <glibmm/arrayhandle.h>
namespace Gst
{
//Gst::IteratorBasic<> forward declaration.
template <class CppType>
class IteratorBasic;
/** @addtogroup gstreamermmEnums gstreamermm Enums and Flags */
/**
* @var Format FORMAT_UNDEFINED
* Undefined format.
*
* @var Format FORMAT_DEFAULT
* The default format of the pad/element. This can be samples for raw audio, frames/fields for raw video (some, but not all, elements support this; use @a GST_FORMAT_TIME if you don't have a good reason to query for samples/frames).
*
* @var Format FORMAT_BYTES
* Bytes.
*
* @var Format FORMAT_TIME
* Time in nanoseconds.
*
* @var Format FORMAT_BUFFERS
* Buffers (few, if any, elements implement this as of May 2009).
*
* @var Format FORMAT_PERCENT
* Percentage of stream (few, if any, elements implement this as of May 2009).
*
* @enum Format
*
* Standard predefined formats
* @ingroup gstreamermmEnums
*/
enum Format
{
FORMAT_UNDEFINED,
FORMAT_DEFAULT,
FORMAT_BYTES,
FORMAT_TIME,
FORMAT_BUFFERS,
FORMAT_PERCENT
};
} // namespace Gst
#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{
template <>
class Value<Gst::Format> : public Glib::Value_Enum<Gst::Format>
{
public:
static GType value_type() G_GNUC_CONST;
};
} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
namespace Gst
{
/** A class to store the details of a Gst::Format retrieved by
* Gst::get_format_details().
*/
class FormatDefinition
{
public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef FormatDefinition CppObjectType;
typedef GstFormatDefinition BaseObjectType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */
private:
public:
/// Default constructor.
FormatDefinition();
/** Constructs a Gst::FormatDefinition from a C GstFormatDefinition type.
* The @a castitem is left unaffected; its contents are simply copied.
* @param castitem The GstFormatDefinition to copy contents from.
*/
explicit FormatDefinition(const GstFormatDefinition* castitem);
/// The unique id of this format.
Gst::Format value;
/// A short nick of the format.
Glib::ustring nick;
/// A longer description of the format.
Glib::ustring description;
/// A quark for the nick.
Glib::QueryQuark quark;
};
namespace Enums
{
/** Gets a printable name for the given format. Do not modify or free.
*
* @param format A Gst::Format.
* @return The name of the format or an empty string if the format is unknown.
*/
Glib::ustring get_name(Format format);
/** Gets the unique quark for the given format.
*
* @param format A Gst::Format.
* @return The quark associated with the format or 0 if the format is unknown.
*/
Glib::QueryQuark get_quark(Format format);
} //namespace Enums
/** Creates a new Gst::Format based on the nick or return an already
* registered format with that nick.
*
* @param nick The nick of the new format.
* @param description The description of the new format.
* @return A new Gst::Format or an already registered format with the same
* nick. MT safe.
*/
Format register_format(const Glib::ustring& nick, const Glib::ustring&
description);
/** Returns the format registered with the given nick.
*
* @param nick The nick of the format.
* @return The format with nick or Gst::FORMAT_UNDEFINED if the format was not
* registered.
*/
Format get_format(const Glib::ustring& nick);
/** Sees if the given format is inside the array of formats.
*
* @param formats The array of formats to search.
* @param format The format to find.
* @return true If the format is found inside the array.
*/
bool formats_contain(const Glib::ArrayHandle<Format>& formats, Format format);
/** Gets details about the given format.
*
* @param format The format to get details of.
* @param def The Gst::FormatDefinition in which to store the details of
* the format.
* @return true if successful, false otherwise. MT safe.
*/
bool get_format_details(Format format, FormatDefinition& def);
/** Iterates all the registered formats. The format definitions are read
* only.
* @return a Gst::IteratorBasic of Gst::FormatDefinition.
*/
IteratorBasic<const FormatDefinition> iterate_format_definitions();
} //namespace Gst
#endif /* _GSTREAMERMM_FORMAT_H */
|