From 4e2c2d57741eade152b30ca0331bea9c23b9a72c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sebastian=20Dr=C3=B6ge?= Date: Tue, 23 Apr 2019 12:05:44 +0300 Subject: [PATCH] Update gir-files to 1.16.0 --- gir-files/Gst-1.0.gir | 904 +++++- gir-files/GstApp-1.0.gir | 6 + gir-files/GstAudio-1.0.gir | 562 +++- gir-files/GstBase-1.0.gir | 966 +++++- gir-files/GstCheck-1.0.gir | 35 +- gir-files/GstGL-1.0.gir | 888 +++++- gir-files/GstMpegts-1.0.gir | 42 + gir-files/GstNet-1.0.gir | 2 +- gir-files/GstPbutils-1.0.gir | 89 +- gir-files/GstPlayer-1.0.gir | 113 +- gir-files/GstRtsp-1.0.gir | 267 +- gir-files/GstRtspServer-1.0.gir | 891 +++++- gir-files/GstSdp-1.0.gir | 67 +- gir-files/GstVideo-1.0.gir | 5181 ++++++++++++------------------- gir-files/GstWebRTC-1.0.gir | 146 + gir-files/fix.sh | 34 +- 16 files changed, 6468 insertions(+), 3725 deletions(-) diff --git a/gir-files/Gst-1.0.gir b/gir-files/Gst-1.0.gir index 82b983de1..0b7b93110 100644 --- a/gir-files/Gst-1.0.gir +++ b/gir-files/Gst-1.0.gir @@ -317,12 +317,12 @@ use an alignment of 7. the implementation of the GstMemoryMapFullFunction. - Will be used instead of @mem_map if present. (Since 1.6) + Will be used instead of @mem_map if present. (Since: 1.6) the implementation of the GstMemoryUnmapFullFunction. - Will be used instead of @mem_unmap if present. (Since 1.6) + Will be used instead of @mem_unmap if present. (Since: 1.6) @@ -1464,7 +1464,7 @@ and (un)set using GST_OBJECT_FLAG_SET () and GST_OBJECT_FLAG_UNSET (). c:identifier="GST_BIN_FLAG_NO_RESYNC" glib:nick="no-resync"> don't resync a state change when elements are - added or linked in the bin (Since 1.0.5) + added or linked in the bin (Since: 1.0.5) glib:nick="streams-aware"> Indicates whether the bin can handle elements that add/remove source pads at any point in time without - first posting a no-more-pads signal (Since 1.10) + first posting a no-more-pads signal (Since: 1.10) +for re-use. (Since: 1.6) the parent structure @@ -1689,6 +1689,24 @@ MT safe. + + Creates a new #GstBuffer that wraps the given @bytes. The data inside +@bytes cannot be %NULL and the resulting buffer will be marked as read only. + +MT safe. + + a new #GstBuffer wrapping @bytes + + + + + a #GBytes to wrap + + + + Allocate a new buffer that wraps the given memory. @data must point to @@ -3075,7 +3093,7 @@ function to specify which items should be copied. c:identifier="GST_BUFFER_COPY_DEEP" glib:nick="deep"> flag indicating that memory should always be - copied instead of reffed (Since 1.2) + copied instead of reffed (Since: 1.2) glib:nick="sync-after"> Elements which write to disk or permanent storage should ensure the data is synced after - writing the contents of this buffer. (Since 1.6) + writing the contents of this buffer. (Since: 1.6) This can be used to mark important buffers, e.g. to flag RTP packets carrying keyframes or codec setup data for RTP Forward Error Correction purposes, or to prevent still video - frames from being dropped by elements due to QoS. (Since 1.14) + frames from being dropped by elements due to QoS. (Since: 1.14) A #GstBus - + A GPollFD to fill @@ -5611,7 +5632,27 @@ be empty - + + Creates a new #GstCaps as a copy of the old @caps. The new caps will have a +refcount of 1, owned by the caller. The structures are copied as well. + +Note that this function is the semantic equivalent of a gst_caps_ref() +followed by a gst_caps_make_writable(). If you only want to hold on to a +reference to the data, you should use gst_caps_ref(). + +When you are finished with the caps, call gst_caps_unref() on it. + + the new #GstCaps + + + + + a #GstCaps. + + + + + Creates a new #GstCaps and appends a copy of the nth structure contained in @caps. @@ -6162,6 +6203,27 @@ contained in @caps. + + Sets the #GstCapsFeatures @features for all the structures of @caps. + + + + + + a #GstCaps + + + + the #GstCapsFeatures to set + + + + @@ -7549,6 +7611,24 @@ MT safe. + + This function returns the underlying clock. + + a #GstClock or %NULL when the + underlying clock has been freed. Unref after usage. + +MT safe. + + + + + a #GstClockID + + + + Get the time of the clock ID @@ -7611,6 +7691,30 @@ MT safe. + + This function returns whether @id uses @clock as the underlying clock. +@clock can be NULL, in which case the return value indicates whether +the underlying clock has been freed. If this is the case, the @id is +no longer usable and should be freed. + + whether the clock @id uses the same underlying #GstClock @clock. + +MT safe. + + + + + a #GstClockID to check + + + + a #GstClock to compare against + + + + Perform a blocking wait on @id. @id should have been created with gst_clock_new_single_shot_id() @@ -8749,7 +8853,7 @@ not be extended or allocated using a custom allocator. c:identifier="GST_CLOCK_FLAG_NEEDS_STARTUP_SYNC" glib:nick="needs-startup-sync"> clock needs to be synced before it can be used - (Since 1.6) + (Since: 1.6) value="2" c:identifier="GST_CLOCK_TYPE_OTHER" glib:nick="other"> - some other time source is used (Since 1.0.5) + some other time source is used (Since: 1.0.5) - + the newly created #GstDateTime @@ -9899,7 +10003,7 @@ If @hour is -1, then the #GstDateTime created will only contain @year and case @minute and @seconds should also be -1. Free-function: gst_date_time_unref - + the newly created #GstDateTime @@ -10029,7 +10133,7 @@ Free-function: gst_date_time_unref Returns the day of the month of this #GstDateTime. -Call gst_date_time_has_day before, to avoid warnings. +Call gst_date_time_has_day() before, to avoid warnings. The day of this #GstDateTime @@ -10044,7 +10148,7 @@ Call gst_date_time_has_day before, to avoid warnings. Retrieves the hour of the day represented by @datetime in the gregorian calendar. The return is in the range of 0 to 23. -Call gst_date_time_has_haur before, to avoid warnings. +Call gst_date_time_has_time() before, to avoid warnings. the hour of the day @@ -10074,7 +10178,7 @@ Call gst_date_time_has_haur before, to avoid warnings. Retrieves the minute of the hour represented by @datetime in the gregorian calendar. -Call gst_date_time_has_minute before, to avoid warnings. +Call gst_date_time_has_time() before, to avoid warnings. the minute of the hour @@ -10088,7 +10192,7 @@ Call gst_date_time_has_minute before, to avoid warnings. Returns the month of this #GstDateTime. January is 1, February is 2, etc.. -Call gst_date_time_has_month before, to avoid warnings. +Call gst_date_time_has_month() before, to avoid warnings. The month of this #GstDateTime @@ -10103,7 +10207,7 @@ Call gst_date_time_has_month before, to avoid warnings. Retrieves the second of the minute represented by @datetime in the gregorian calendar. -Call gst_date_time_has_second before, to avoid warnings. +Call gst_date_time_has_time() before, to avoid warnings. the second represented by @datetime @@ -10134,7 +10238,7 @@ If @datetime represents UTC time, then the offset is zero. Returns the year of this #GstDateTime -Call gst_date_time_has_year before, to avoid warnings. +Call gst_date_time_has_year() before, to avoid warnings. The year of this #GstDateTime @@ -10956,7 +11060,7 @@ device in the PLAYING state. - The parent #GstObject strucuture. + The parent #GstObject structure. @@ -10979,7 +11083,7 @@ device in the PLAYING state. version="1.4"> The class structure for a #GstDevice object. - The parent #GstObjectClass strucuture. + The parent #GstObjectClass structure. @@ -11334,7 +11438,7 @@ will be emitted on the bus when the list of devices changes. glib:get-type="gst_device_provider_get_type" glib:type-struct="DeviceProviderClass"> A #GstDeviceProvider subclass is provided by a plugin that handles devices -if there is a way to programatically list connected devices. It can also +if there is a way to programmatically list connected devices. It can also optionally provide updates to the list of connected devices. Each #GstDeviceProvider subclass is a singleton, a plugin should @@ -11455,6 +11559,31 @@ will be removed (see gst_object_ref_sink()). + + This function is used when @changed_device was modified into its new form +@device. This will post a `DEVICE_CHANGED` message on the bus to let +the application know that the device was modified. #GstDevice is immutable +for MT. safety purposes so this is an "atomic" way of letting the application +know when a device was modified. + + + + + + + + + the new version of @changed_device + + + + the old version of the device that has been udpated + + + + @@ -12192,6 +12321,15 @@ plugin_init (GstPlugin * plugin) c:type="GST_ELEMENT_FACTORY_KLASS_FORMATTER"> + + Elements interacting with hardware devices should specify this classifier in +their metadata. You may need to put the element in "READY" state to test if +the hardware is present in the system. + + @@ -12418,7 +12556,8 @@ for more details and common types. E.g: "Sink/File" + c:type="GST_ERROR_SYSTEM" + introspectable="0"> Builds a string using errno describing the previously failed system call. To be used as the debug argument in #GST_ELEMENT_ERROR. @@ -12980,9 +13119,8 @@ MT safe. Adds a pad (link point) to @element. @pad's parent will be set to @element; see gst_object_set_parent() for refcounting information. -Pads are not automatically activated so elements should perform the needed -steps to activate the pad in case this pad is added in the PAUSED or PLAYING -state. See gst_pad_set_active() for more information about activating pads. +Pads are automatically activated when added in the PAUSED or PLAYING +state. The pad and the element should be unlocked when calling this function. @@ -13448,9 +13586,9 @@ MT safe. Retrieves the factory that was used to create this element. - + the #GstElementFactory used for creating this - element. no refcounting is needed. + element or %NULL if element has not been registered (static element). no refcounting is needed. @@ -14583,6 +14721,10 @@ MT safe. Locks the state of an element, so state changes of the parent don't affect this element anymore. +Note that this is racy if the state lock of the parent bin is not taken. +The parent bin might've just checked the flag in another thread and as the +next step proceed to change the child element's state. + MT safe. %TRUE if the state was changed, %FALSE if bad parameters were given @@ -17136,6 +17278,26 @@ gst_event_new_qos() for more information about the different QoS values. + + Retrieve the trickmode interval that may have been set on a +seek event with gst_event_set_seek_trickmode_interval(). + + + + + + + + + + + + Parses a segment @event and stores the result in the given @segment location. @segment remains valid only until the @event is freed. Don't modify the segment @@ -17305,7 +17467,7 @@ and make a copy if you want to modify it or store it for later use. direction="out" caller-allocates="0" transfer-ownership="full"> - adress of variable to store the stream + address of variable to store the stream @@ -17511,6 +17673,24 @@ MT safe. + + Sets a trickmode interval on a (writable) seek event. Elements +that support TRICKMODE_KEY_UNITS seeks SHOULD use this as the minimal +interval between each frame they may output. + + + + + + + + + + + + Set the sequence number of a event. @@ -17647,7 +17827,7 @@ Specific custom events are distinguished by the name of the structure. value="19230" c:identifier="GST_EVENT_STREAM_COLLECTION" glib:nick="stream-collection"> - A new #GstStreamCollection is available (Since 1.10) + A new #GstStreamCollection is available (Since: 1.10) glib:nick="stream-group-done"> Indicates that there is no more data for the stream group ID in the message. Sent before EOS - in some instances and should be handled mostly the same. (Since 1.10) + in some instances and should be handled mostly the same. (Since: 1.10) value="66561" c:identifier="GST_EVENT_SELECT_STREAMS" glib:nick="select-streams"> - A request to select one or more streams (Since 1.10) + A request to select one or more streams (Since: 1.10) its real value. - + Can be used together with #GST_FOURCC_ARGS to properly output a #guint32 fourcc value in a printf()-style text message. @@ -19833,13 +20016,13 @@ made when this memory needs to be shared between buffers. value="128" c:identifier="GST_MEMORY_FLAG_PHYSICALLY_CONTIGUOUS" glib:nick="physically-contiguous"> - the memory is physically contiguous. (Since 1.2) + the memory is physically contiguous. (Since: 1.2) - the memory can't be mapped via gst_memory_map() without any preconditions. (Since 1.2) + the memory can't be mapped via gst_memory_map() without any preconditions. (Since: 1.2) + + Creates a new device-changed message. The device-changed message is produced +by #GstDeviceProvider or a #GstDeviceMonitor. They announce that a device +properties has changed and @device represent the new modified version of @changed_device. + + a newly allocated #GstMessage + + + + + The #GstObject that created the message + + + + The newly created device representing @replaced_device + with its new configuration. + + + + + + + @@ -20377,8 +20585,11 @@ receiving this message should stop the pipeline. A debugging string. - - (allow-none): A GstStructure with details + + A GstStructure with details @@ -20459,8 +20670,11 @@ MT safe. A debugging string. - - (allow-none): A GstStructure with details + + A GstStructure with details @@ -21177,8 +21391,11 @@ MT safe. A debugging string. - - (allow-none): A GstStructure with details + + A GstStructure with details @@ -21519,6 +21736,43 @@ of monitored devices. + + Parses a device-changed message. The device-changed message is produced by +#GstDeviceProvider or a #GstDeviceMonitor. It announces the +disappearance of monitored devices. * It announce that a device properties has +changed and @device represents the new modified version of @changed_device. + + + + + + a #GstMessage of type %GST_MESSAGE_DEVICE_CHANGED + + + + A location where to store a + pointer to the updated version of the #GstDevice, or %NULL + + + + A location where to store a + pointer to the old version of the #GstDevice, or %NULL + + + + @@ -23087,13 +23341,13 @@ was updated. value="536870912" c:identifier="GST_MESSAGE_NEED_CONTEXT" glib:nick="need-context"> - Message indicating that an element wants a specific context (Since 1.2) + Message indicating that an element wants a specific context (Since: 1.2) - Message indicating that an element created a context (Since 1.2) + Message indicating that an element created a context (Since: 1.2) These extended message IDs can't be used directly with mask-based API like gst_bus_poll() or gst_bus_timed_pop_filtered(), but you can still filter for GST_MESSAGE_EXTENDED and then check the result for the - specific type. (Since 1.4) + specific type. (Since: 1.4) Message indicating a #GstDevice was added to - a #GstDeviceProvider (Since 1.4) + a #GstDeviceProvider (Since: 1.4) Message indicating a #GstDevice was removed - from a #GstDeviceProvider (Since 1.4) + from a #GstDeviceProvider (Since: 1.4) Message indicating a #GObject property has - changed (Since 1.10) + changed (Since: 1.10) Message indicating a new #GstStreamCollection - is available (Since 1.10) + is available (Since: 1.10) Message indicating the active selection of - #GstStreams has changed (Since 1.10) + #GstStreams has changed (Since: 1.10) glib:nick="redirect"> Message indicating to request the application to try to play the given URL(s). Useful if for example a HTTP 302/303 - response is received with a non-HTTP URL inside. (Since 1.10) + response is received with a non-HTTP URL inside. (Since: 1.10) + + + Message indicating a #GstDevice was changed + a #GstDeviceProvider (Since: 1.16) pointer to the #GstMetaInfo + + Meta sequence number compare function. Can be used as #GCompareFunc +or a #GCompareDataFunc. + + a negative number if @meta1 comes before @meta2, 0 if both metas + have an equal sequence number, or a positive integer if @meta1 comes + after @meta2. + + + + + a #GstMeta + + + + a #GstMeta + + + + + + Gets seqnum for this meta. + + + + + + a #GstMeta + + + + @@ -23491,9 +23788,10 @@ function of the miniobject is called. A copy can be made with gst_mini_object_copy(). gst_mini_object_is_writable() will return %TRUE when the refcount of the -object is exactly 1, meaning the current caller has the only reference to the -object. gst_mini_object_make_writable() will return a writable version of the -object, which might be a new copy when the refcount was not 1. +object is exactly 1 and there is no parent or a single parent exists and is +writable itself, meaning the current caller has the only reference to the +object. gst_mini_object_make_writable() will return a writable version of +the object, which might be a new copy when the refcount was not 1. Opaque data can be associated with a #GstMiniObject with gst_mini_object_set_qdata() and gst_mini_object_get_qdata(). The data is @@ -23533,12 +23831,37 @@ and gst_mini_object_weak_unref() respectively. - + - + + + This adds @parent as a parent for @object. Having one ore more parents affects the +writability of @object: if a @parent is not writable, @object is also not +writable, regardless of its refcount. @object is only writable if all +the parents are writable and its own refcount is exactly 1. + +Note: This function does not take ownership of @parent and also does not +take an additional reference. It is the responsibility of the caller to +remove the parent again at a later time. + + + + + + a #GstMiniObject + + + + a parent #GstMiniObject + + + + @@ -23702,6 +24025,25 @@ is a #GstBuffer. + + This removes @parent as a parent for @object. See +gst_mini_object_add_parent(). + + + + + + a #GstMiniObject + + + + a parent #GstMiniObject + + + + This sets an opaque, named pointer on a miniobject. The name is specified through a #GQuark (retrieved e.g. via @@ -23982,7 +24324,7 @@ READONLY mode. Only read locks can be performed on the object. glib:nick="may-be-leaked"> the object is expected to stay alive even after gst_deinit() has been called and so should be ignored by leak -detection tools. (Since 1.10) +detection tools. (Since: 1.10) A default error function that uses g_printerr() to display the error message -and the optional debug sting.. +and the optional debug string.. The default handler will simply print the error string using g_print. @@ -24299,7 +24641,7 @@ unreferenced again after use. c:identifier="gst_object_get_control_rate"> Obtain the control-rate for this @object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call -gst_object_sync_values() inbetween. The length of the processing segment +gst_object_sync_values() in between. The length of the processing segment should be up to @control-rate nanoseconds. If the @object is not under property control, this will return @@ -24651,7 +24993,7 @@ or not. c:identifier="gst_object_set_control_rate"> Change the control-rate for this @object. Audio processing #GstElement objects will use this rate to sub-divide their processing loop and call -gst_object_sync_values() inbetween. The length of the processing segment +gst_object_sync_values() in between. The length of the processing segment should be up to @control-rate nanoseconds. The control-rate should not change if the element is in %GST_STATE_PAUSED or @@ -24906,7 +25248,7 @@ the elements contained in that bin. glib:nick="may-be-leaked"> the object is expected to stay alive even after gst_deinit() has been called and so should be ignored by leak -detection tools. (Since 1.10) +detection tools. (Since: 1.10) system. - + + The protection system value of the unspecified UUID. +In some cases the system protection ID is not present in the contents or in their +metadata, as encrypted WebM. +This define is used to set the value of the "system_id" field in GstProtectionEvent, +with this value, the application will use an external information to choose which +protection system to use. + +Example: The matroskademux uses this value in the case of encrypted WebM, +the application will choose the appropriate protection system based on the information +received through EME API. + + + printf format type used to debug GStreamer types. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() @@ -25043,9 +25404,8 @@ respectively. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - - a new #GstPad, or %NULL in -case of an error. + + a new #GstPad. MT safe. @@ -25070,9 +25430,8 @@ MT safe. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - - a new #GstPad, or %NULL in -case of an error. + + a new #GstPad. @@ -25092,9 +25451,8 @@ case of an error. If name is %NULL, a guaranteed unique name (across all pads) will be assigned. This function makes a copy of the name so you can safely free the name. - - a new #GstPad, or %NULL in -case of an error. + + a new #GstPad. @@ -27100,7 +27458,11 @@ of the peer sink pad, if present. Sets the given unlink function for the pad. It will be called -when the pad is unlinked. +when the pad is unlinked. + +Note that the pad's lock is already held when the unlink +function is called, so most pad functions cannot be called +from within the callback. @@ -27807,7 +28169,7 @@ return it. the default accept-caps handler will use the template pad caps instead of query caps to compare with the accept caps. Use this in combination - with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since 1.6) + with %GST_PAD_FLAG_ACCEPT_INTERSECT. (Since: 1.6) c:identifier="gst_pad_template_new_from_static_pad_template_with_gtype" version="1.14"> Converts a #GstStaticPadTemplate into a #GstPadTemplate with a type. - + a new #GstPadTemplate. @@ -28616,7 +28978,7 @@ and with the given arguments. version="1.14"> Creates a new pad template with a name according to the given template and with the given arguments. - + a new #GstPadTemplate. @@ -28807,7 +29169,10 @@ Unref after usage. - Function signature to handle a unlinking the pad prom its peer. + Function signature to handle a unlinking the pad prom its peer. + +The pad's lock is already held when the unlink function is called, so most +pad functions cannot be called from within the callback. @@ -28842,13 +29207,13 @@ Unref after usage. glib:fundamental="1"> - A GParamSpec derived structure that contains the meta data for fractional -properties. + A GParamSpec derived structure for arrays of values. super class + the #GParamSpec of the type of values in the array @@ -29068,7 +29433,7 @@ of %GST_PARSE_ERROR_NO_SUCH_ELEMENT was returned. glib:nick="place-in-bin"> If more than one toplevel element is described by the pipeline description string, put them in a #GstBin instead of a - #GstPipeline. (Since 1.10) + #GstPipeline. (Since: 1.10) glib:nick="file-name-is-prefix"> interpret filename argument as filter prefix and check all matching files in - the directory. Since 1.8. + the directory. Since: 1.8. + + Control whether the descriptor @fd in @set will be monitored for +exceptional conditions (POLLPRI). + +Not implemented on Windows (will just return %FALSE there). + + %TRUE if the descriptor was successfully updated. + + + + + a file descriptor set. + + + + a file descriptor. + + + + a new status. + + + + Control whether the descriptor @fd in @set will be monitored for readability. @@ -30602,6 +30993,27 @@ writability. + + Check if @fd in @set has an exceptional condition (POLLPRI). + +Not implemented on Windows (will just return %FALSE there). + + %TRUE if the descriptor has an exceptional condition. + + + + + a file descriptor set. + + + + a file descriptor. + + + + Mark @fd as ignored so that the next call to gst_poll_wait() will yield the same result for @fd as last time. This function must be called if no @@ -30891,7 +31303,7 @@ a list of presets individual presets are read and overlaid in 1) system, 2) application and 3) user order. Whenever an earlier entry is newer, the later entries will be updated. Since 1.8 you can also provide extra paths where to find presets through the GST_PRESET_PATH environment variable. -Presets found in those paths will be concidered as "app presets". +Presets found in those paths will be considered as "app presets". Gets the directory for application specific presets if set by the application. @@ -32007,6 +32419,17 @@ Free-function: gst_query_unref() + + Constructs a new query object for querying the bitrate. + +Free-function: gst_query_unref() + + a new #GstQuery + + + Constructs a new query object for querying the buffering status of a stream. @@ -32613,6 +33036,29 @@ gst_query_parse_nth_allocation_pool(). + + Get the results of a bitrate query. See also gst_query_set_bitrate(). + + + + + + a GST_QUERY_BITRATE type #GstQuery + + + + The resulting bitrate in bits per second + + + + Get the percentage of buffered data. This is a value between 0 and 100. @@ -33513,6 +33959,26 @@ they should make all future requests to the original URI. + + Set the results of a bitrate query. The nominal bitrate is the average +bitrate expected over the length of the stream as advertised in file +headers (or similar). + + + + + + a GST_QUERY_BITRATE type #GstQuery + + + + the nominal bitrate in bits per second + + + + Set the percentage of buffered data. This is a value between 0 and 100. @@ -34120,6 +34586,12 @@ to permanent or not. query the pipeline-local context from downstream or upstream (since 1.2) + + the bitrate query (since 1.16) + Gets the #GstQueryTypeFlags associated with @type. @@ -34883,7 +35355,7 @@ both reading and writing, or either (but unspecified which). glib:nick="not-authorized"> used when the resource can't be opened due to missing authorization. - (Since 1.2.4) + (Since: 1.2.4) Constant that defines one GStreamer second. - + printf format type used to debug GStreamer segments. You can use this in combination with GStreamer's debug logging system as well as the functions gst_info_vasprintf(), gst_info_strdup_vprintf() and gst_info_strdup_printf() @@ -34922,7 +35397,8 @@ Can be used as a default value in variables used to store seqnum. + version="1.6" + introspectable="0"> A string that can be used in printf-like format strings to display a signed #GstClockTimeDiff or #gint64 value in h:m:s format. Use GST_TIME_ARGS() to construct the matching arguments. @@ -35058,10 +35534,28 @@ Free-function: gst_sample_unref + + Set the buffer associated with @sample. @sample must be writable. + + + + + + A #GstSample + + + + A #GstBuffer + + + + - Set the buffer list associated with @sample + Set the buffer list associated with @sample. @sample must be writable. @@ -35076,6 +35570,61 @@ Free-function: gst_sample_unref + + Set the caps associated with @sample. @sample must be writable. + + + + + + A #GstSample + + + + A #GstCaps + + + + + + Set the info structure associated with @sample. @sample must be writable, +and @info must not have a parent set already. + + + + + + A #GstSample + + + + A #GstStructure + + + + + + Set the segment associated with @sample. @sample must be writable. + + + + + + A #GstSample + + + + A #GstSegment + + + + glib:nick="trickmode"> when doing fast forward or fast reverse playback, allow elements to skip frames instead of generating all - frames. (Since 1.6) + frames. (Since: 1.6) when doing fast forward or fast reverse playback, request that elements only decode keyframes and skip all other content, for formats that have - keyframes. (Since 1.6) + keyframes. (Since: 1.6) glib:nick="trickmode-no-audio"> when doing fast forward or fast reverse playback, request that audio decoder elements skip - decoding and output only gap events or silence. (Since 1.6) + decoding and output only gap events or silence. (Since: 1.6) value="16" c:identifier="GST_SEGMENT_FLAG_TRICKMODE" glib:nick="trickmode"> - perform skip playback (Since 1.6) + perform skip playback (Since: 1.6) c:identifier="GST_SEGMENT_FLAG_TRICKMODE_KEY_UNITS" glib:nick="trickmode-key-units"> Decode only keyframes, where - possible (Since 1.6) + possible (Since: 1.6) Do not decode any audio, where - possible (Since 1.6) + possible (Since: 1.6) - state change from NULL to NULL. (Since 1.14) + state change from NULL to NULL. (Since: 1.14) state change from READY to READY, This might happen when going to PAUSED asynchronously failed, in that case -elements should make sure they are in a proper, coherent READY state. (Since 1.14) +elements should make sure they are in a proper, coherent READY state. (Since: 1.14) state change from PAUSED to PAUSED. This might happen when elements were in PLAYING state and 'lost state', -they should make sure to go back to real 'PAUSED' state (prerolling for example). (Since 1.14) +they should make sure to go back to real 'PAUSED' state (prerolling for example). (Since: 1.14) - state change from PLAYING to PLAYING. (Since 1.14) + state change from PLAYING to PLAYING. (Since: 1.14) This is useful in language bindings where unknown #GValue types are not -supported. This function will convert the %GST_TYPE_ARRAY and -%GST_TYPE_LIST into a newly allocated #GValueArray and return it through -@array. Be aware that this is slower then getting the #GValue directly. +supported. This function will convert the %GST_TYPE_ARRAY into a newly +allocated #GValueArray and return it through @array. Be aware that this is +slower then getting the #GValue directly. %TRUE if the value could be set correctly. If there was no field -with @fieldname or the existing field did not contain an int, this function -returns %FALSE. +with @fieldname or the existing field did not contain a %GST_TYPE_ARRAY, +this function returns %FALSE. @@ -37919,17 +38468,17 @@ returns %FALSE. - + This is useful in language bindings where unknown #GValue types are not -supported. This function will convert the %GST_TYPE_ARRAY and -%GST_TYPE_LIST into a newly allocated GValueArray and return it through -@array. Be aware that this is slower then getting the #GValue directly. +supported. This function will convert the %GST_TYPE_LIST into a newly +allocated GValueArray and return it through @array. Be aware that this is +slower then getting the #GValue directly. %TRUE if the value could be set correctly. If there was no field -with @fieldname or the existing field did not contain an int, this function -returns %FALSE. - -Since 1.12 +with @fieldname or the existing field did not contain a %GST_TYPE_LIST, this +function returns %FALSE. @@ -38581,13 +39130,13 @@ Variable arguments should be in the form field name, field type - + This is useful in language bindings where unknown GValue types are not supported. This function will convert a @array to %GST_TYPE_ARRAY and set the field specified by @fieldname. Be aware that this is slower then using -%GST_TYPE_ARRAY in a #GValue directly. - -Since 1.12 +%GST_TYPE_ARRAY in a #GValue directly. @@ -38606,13 +39155,13 @@ Since 1.12 - + This is useful in language bindings where unknown GValue types are not -supported. This function will convert a @array to %GST_TYPE_ARRAY and set +supported. This function will convert a @array to %GST_TYPE_LIST and set the field specified by @fieldname. Be aware that this is slower then using -%GST_TYPE_ARRAY in a #GValue directly. - -Since 1.12 +%GST_TYPE_LIST in a #GValue directly. @@ -39541,7 +40090,8 @@ The higher the value, the more the user likes this media + c:type="GST_TIME_FORMAT" + introspectable="0"> A string that can be used in printf-like format strings to display a #GstClockTime value in h:m:s format. Use GST_TIME_ARGS() to construct the matching arguments. @@ -42895,7 +43445,7 @@ logs to understand the values. glib:type-name="GstTracerValueScope" glib:get-type="gst_tracer_value_scope_get_type" c:type="GstTracerValueScope"> - Tracing record will contain fields that contain a meassured value or extra + Tracing record will contain fields that contain a measured value or extra meta-data. One such meta data are values that tell where a measurement was taken. This enumerating declares to which scope such a meta data field relates to. If it is e.g. %GST_TRACER_VALUE_SCOPE_PAD, then each of the log @@ -43169,7 +43719,7 @@ This function is typically called during an element's plugin initialization. - These functions allow querying informations about registered typefind + These functions allow querying information about registered typefind functions. How to create and register these functions is described in the section <link linkend="gstreamer-Writing-typefind-functions"> "Writing typefind functions"</link>. @@ -43628,7 +44178,7 @@ Returns #GST_URI_UNKNOWN if the @handler isn't implemented correctly. glib:get-type="gst_uri_get_type" c:symbol-prefix="uri"> A #GstUri object can be used to parse and split a URI string into its -constituant parts. Two #GstUri objects can be joined to make a new #GstUri +constituent parts. Two #GstUri objects can be joined to make a new #GstUri using the algorithm described in RFC3986. Creates a new #GstUri object with the given URI parts. The path and query @@ -43817,7 +44367,7 @@ If @uri is %NULL then returns %NULL. Get the media fragment table from the URI, as defined by "Media Fragments URI 1.0". Hash table returned by this API is a list of "key-value" pairs, and the each pair is generated by splitting "URI fragment" per "&" sub-delims, then "key" -and "value" are splitted by "=" sub-delims. The "key" returned by this API may +and "value" are split by "=" sub-delims. The "key" returned by this API may be undefined keyword by standard. A value may be %NULL to indicate that the key should appear in the fragment string in the URI, but does not have a value. Free the returned #GHashTable @@ -43845,9 +44395,9 @@ See more about Media Fragments URI 1.0 (W3C) at https://www.w3.org/TR/media-frag Extract the path string from the URI object. - - (nullable): The path from the URI. Once finished - with the string should be g_free()'d. + + The path from the URI. Once finished + with the string should be g_free()'d. @@ -44422,7 +44972,7 @@ unset the fragment string. reference to the new one is used instead. A value if %NULL for @query_table will remove the query string from the URI. - %TRUE if the new table was sucessfully used for the query table. + %TRUE if the new table was successfully used for the query table. @@ -44453,7 +45003,7 @@ will remove the query string from the URI. indicates that the key has no associated value, but will still be present in the query string. - %TRUE if the query table was sucessfully updated. + %TRUE if the query table was successfully updated. @@ -44726,11 +45276,11 @@ determine a order for the two provided values. The major version of GStreamer at compile time: - + The micro version of GStreamer at compile time: - + The minor version of GStreamer at compile time: @@ -45170,6 +45720,78 @@ when there are nested #GstCaps / #GstStructure deeper than one level. + + Clears a reference to a #GstMiniObject. + +@object_ptr must not be %NULL. + +If the reference is %NULL then this function does nothing. +Otherwise, the reference count of the object is decreased using +gst_mini_object_unref() and the pointer is set to %NULL. + +A macro is also included that allows this function to be used without +pointer casts. + + + + + + a pointer to a #GstMiniObject reference + + + + + + Clears a reference to a #GstObject. + +@object_ptr must not be %NULL. + +If the reference is %NULL then this function does nothing. +Otherwise, the reference count of the object is decreased using +gst_object_unref() and the pointer is set to %NULL. + +A macro is also included that allows this function to be used without +pointer casts. + + + + + + a pointer to a #GstObject reference + + + + + + Clears a reference to a #GstStructure. + +@structure_ptr must not be %NULL. + +If the reference is %NULL then this function does nothing. +Otherwise, the structure is free'd using gst_structure_free() and the +pointer is set to %NULL. + +A macro is also included that allows this function to be used without +pointer casts. + + + + + + a pointer to a #GstStructure reference + + + + @@ -45246,6 +45868,7 @@ dot format. + type of #GstDebugGraphDetails to use @@ -45267,6 +45890,7 @@ This file can be processed with graphviz to get an image. + type of #GstDebugGraphDetails to use @@ -45288,6 +45912,7 @@ to the filename, so that it can be used to take multiple snapshots. + type of #GstDebugGraphDetails to use @@ -45553,7 +46178,7 @@ gst_debug_remove_log_function(gst_debug_log_default); - If libunwind or glibc backtrace are present + If libunwind, glibc backtrace or DbgHelp are present a stack trace is printed. @@ -47378,7 +48003,9 @@ It creates a copy of the first value from the list. - + Registers a new tag type for the use with GStreamer's type system. If a type with that name is already registered, that one is used. The old registration may have used a different type however. So don't rely @@ -47427,15 +48054,15 @@ gst_tag_merge_strings_with_comma(). + allow-none="1"> function for merging multiple values of this tag, or %NULL + c:identifier="gst_tag_register_static" + introspectable="0"> Registers a new tag type for the use with GStreamer's type system. Same as gst_tag_register(), but @name, @nick, and @blurb must be @@ -47469,8 +48096,7 @@ even from dynamically loaded plugins.) + allow-none="1"> function for merging multiple values of this tag, or %NULL diff --git a/gir-files/GstApp-1.0.gir b/gir-files/GstApp-1.0.gir index 9913b72d6..775b6d294 100644 --- a/gir-files/GstApp-1.0.gir +++ b/gir-files/GstApp-1.0.gir @@ -1119,6 +1119,9 @@ buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal. +This function does not take ownership of the +sample so the sample needs to be unreffed after calling this function. + When the block property is TRUE, this function can block until free space becomes available in the queue. @@ -1351,6 +1354,9 @@ buffers that the appsrc element will push to its source pad. Any previous caps that were set on appsrc will be replaced by the caps associated with the sample if not equal. +This function does not take ownership of the +sample so the sample needs to be unreffed after calling this function. + When the block property is TRUE, this function can block until free space becomes available in the queue. diff --git a/gir-files/GstAudio-1.0.gir b/gir-files/GstAudio-1.0.gir index 559258394..f6658ec68 100644 --- a/gir-files/GstAudio-1.0.gir +++ b/gir-files/GstAudio-1.0.gir @@ -250,6 +250,7 @@ transition band for the kaiser window. 0.087 is the default. - The parent #GstAggregator @@ -376,7 +376,8 @@ downstream specifies a range or a set of acceptable rates). + glib:is-gtype-struct-for="AudioAggregator" + version="1.14"> @@ -434,6 +435,7 @@ downstream specifies a range or a set of acceptable rates). - - The parent #GstAudioAggregatorPad + @@ -460,7 +461,8 @@ See #GstAudioAggregator for more details. + glib:is-gtype-struct-for="AudioAggregatorConvertPad" + version="1.14"> @@ -478,6 +480,7 @@ See #GstAudioAggregator for more details. - The parent #GstAggregatorPad @@ -532,7 +534,8 @@ See #GstAudioAggregator for more details. + glib:is-gtype-struct-for="AudioAggregatorPad" + version="1.14"> @@ -1326,6 +1329,231 @@ drifts too much. No adjustment is done. + + A structure containing the result of an audio buffer map operation, +which is executed with gst_audio_buffer_map(). For non-interleaved (planar) +buffers, the beginning of each channel in the buffer has its own pointer in +the @planes array. For interleaved buffers, the @planes array only contains +one item, which is the pointer to the beginning of the buffer, and @n_planes +equals 1. + +The different channels in @planes are always in the GStreamer channel order. + + a #GstAudioInfo describing the audio properties of this buffer + + + + the size of the buffer in samples + + + + the number of planes available + + + + an array of @n_planes pointers pointing to the start of each + plane in the mapped buffer + + + + the mapped buffer + + + + + + + + + + + + + + + + + + + + + + Maps an audio @gstbuffer so that it can be read or written and stores the +result of the map operation in @buffer. + +This is especially useful when the @gstbuffer is in non-interleaved (planar) +layout, in which case this function will use the information in the +@gstbuffer's attached #GstAudioMeta in order to map each channel in a +separate "plane" in #GstAudioBuffer. If a #GstAudioMeta is not attached +on the @gstbuffer, then it must be in interleaved layout. + +If a #GstAudioMeta is attached, then the #GstAudioInfo on the meta is checked +against @info. Normally, they should be equal, but in case they are not, +a g_critical will be printed and the #GstAudioInfo from the meta will be +used. + +In non-interleaved buffers, it is possible to have each channel on a separate +#GstMemory. In this case, each memory will be mapped separately to avoid +copying their contents in a larger memory area. Do note though that it is +not supported to have a single channel spanning over two or more different +#GstMemory objects. Although the map operation will likely succeed in this +case, it will be highly sub-optimal and it is recommended to merge all the +memories in the buffer before calling this function. + +Note: The actual #GstBuffer is not ref'ed, but it is required to stay valid +as long as it's mapped. + + %TRUE if the map operation succeeded or %FALSE on failure + + + + + pointer to a #GstAudioBuffer + + + + the audio properties of the buffer + + + + the #GstBuffer to be mapped + + + + the access mode for the memory + + + + + + Unmaps an audio buffer that was previously mapped with +gst_audio_buffer_map(). + + + + + + the #GstAudioBuffer to unmap + + + + + + Clip the buffer to the given %GstSegment. + +After calling this function the caller does not own a reference to +@buffer anymore. + + %NULL if the buffer is completely outside the configured segment, +otherwise the clipped buffer is returned. + +If the buffer has no timestamp, it is assumed to be inside the segment and +is not clipped + + + + + The buffer to clip. + + + + Segment in %GST_FORMAT_TIME or %GST_FORMAT_DEFAULT to which + the buffer should be clipped. + + + + sample rate. + + + + size of one audio frame in bytes. This is the size of one sample * +number of channels. + + + + + + Reorders @buffer from the channel positions @from to the channel +positions @to. @from and @to must contain the same number of +positions and the same positions, only in a different order. +@buffer must be writable. + + %TRUE if the reordering was possible. + + + + + The buffer to reorder. + + + + The %GstAudioFormat of the buffer. + + + + The number of channels. + + + + The channel positions in the buffer. + + + + + + The channel positions to convert to. + + + + + + + + Truncate the buffer to finally have @samples number of samples, removing +the necessary amount of samples from the end and @trim number of samples +from the beginning. + +After calling this function the caller does not own a reference to +@buffer anymore. + + the truncated buffer or %NULL if the arguments + were invalid + + + + + The buffer to truncate. + + + + size of one audio frame in bytes. This is the size of one sample * +number of channels. + + + + the number of samples to remove from the beginning of the buffer + + + + the final number of samples that should exist in this buffer or -1 +to use all the remaining samples if you are only removing samples from the +beginning. + + + + + glib:type-name="GstAudioConverter" glib:get-type="gst_audio_converter_get_type" c:symbol-prefix="audio_converter"> + This object is used to convert audio samples from one format to another. +The object can perform conversion of: + + * audio format with optional dithering and noise shaping + + * audio samplerate + + * audio channels and channel layout Create a new #GstAudioConverter that is able to convert between @in and @out audio formats. -@config contains extra configuration options, see #GST_VIDEO_CONVERTER_OPT_* +@config contains extra configuration options, see #GST_AUDIO_CONVERTER_OPT_* parameters for details about the options and values. a #GstAudioConverter or %NULL if conversion is not possible. @@ -2249,6 +2485,7 @@ gst_audio_converter_get_out_frames(). + a #GstAudioConverter @@ -2383,6 +2620,21 @@ frames are given to @convert. + + Returns whether the audio converter will operate in passthrough mode. +The return value would be typically input to gst_base_transform_set_passthrough() + + %TRUE when no conversion will actually occur. + + + + + + + + Reset @convert to the state it was when it was first created, clearing any history it might currently have. @@ -2608,7 +2860,10 @@ occurs (which would happen always if the tolerance mechanism is disabled). In non-live pipelines, baseclass can also (configurably) arrange for output buffer aggregation which may help to redue large(r) numbers of -small(er) buffers being pushed and processed downstream. +small(er) buffers being pushed and processed downstream. Note that this +feature is only available if the buffer layout is interleaved. For planar +buffers, the decoder implementation is fully responsible for the output +buffer size. On the other hand, it should be noted that baseclass only provides limited seeking support (upon explicit subclass request), as full-fledged support @@ -2893,7 +3148,7 @@ are discarded and considered to have produced no output Otherwise, source pad caps must be set when it is called with valid data in @buf. -Note that a frame received in gst_audio_decoder_handle_frame() may be +Note that a frame received in #GstAudioDecoderClass.handle_frame() may be invalidated by a call to this function. a #GstFlowReturn that should be escalated to caller (of caller) @@ -2914,6 +3169,37 @@ invalidated by a call to this function. + + Collects decoded data and pushes it downstream. This function may be called +multiple times for a given input frame. + +@buf may be NULL in which case it is assumed that the current input frame is +finished. This is equivalent to calling gst_audio_decoder_finish_subframe() +with a NULL buffer and frames=1 after having pushed out all decoded audio +subframes using this function. + +When called with valid data in @buf the source pad caps must have been set +already. + +Note that a frame received in #GstAudioDecoderClass.handle_frame() may be +invalidated by a call to this function. + + a #GstFlowReturn that should be escalated to caller (of caller) + + + + + a #GstAudioDecoder + + + + decoded data + + + + Lets #GstAudioDecoder sub-classes to know the memory @allocator @@ -2945,7 +3231,7 @@ used optional="1" allow-none="1"> the -#GstAllocatorParams of @allocator +#GstAllocationParams of @allocator @@ -3375,6 +3661,28 @@ MT safe. + + Configure output caps on the srcpad of @dec. Similar to +gst_audio_decoder_set_output_format(), but allows subclasses to specify +output caps that can't be expressed via #GstAudioInfo e.g. caps that have +caps features. + + %TRUE on success. + + + + + a #GstAudioDecoder + + + + (fixed) #GstCaps + + + + Configure output info on the srcpad of @dec. @@ -4209,7 +4517,7 @@ If @samples < 0, then best estimate is all samples provided to encoder are considered discarded, e.g. as a result of discontinuous transmission, and a discontinuity is marked. -Note that samples received in gst_audio_encoder_handle_frame() +Note that samples received in #GstAudioEncoderClass.handle_frame() may be invalidated by a call to this function. a #GstFlowReturn that should be escalated to caller (of caller) @@ -4261,7 +4569,7 @@ used optional="1" allow-none="1"> the -#GstAllocatorParams of @allocator +#GstAllocationParams of @allocator @@ -4581,7 +4889,7 @@ MT safe. Requires @frame_samples_min and @frame_samples_max to be the equal. Note: This value will be reset to 0 every time before -GstAudioEncoder::set_format() is called. +#GstAudioEncoderClass.set_format() is called. @@ -4605,7 +4913,7 @@ If an exact number of samples is required, gst_audio_encoder_set_frame_samples_m must be called with the same number. Note: This value will be reset to 0 every time before -GstAudioEncoder::set_format() is called. +#GstAudioEncoderClass.set_format() is called. @@ -4629,7 +4937,7 @@ If an exact number of samples is required, gst_audio_encoder_set_frame_samples_m must be called with the same number. Note: This value will be reset to 0 every time before -GstAudioEncoder::set_format() is called. +#GstAudioEncoderClass.set_format() is called. @@ -4724,7 +5032,7 @@ MT safe. Sets encoder lookahead (in units of input rate samples) Note: This value will be reset to 0 every time before -GstAudioEncoder::set_format() is called. +#GstAudioEncoderClass.set_format() is called. @@ -5710,6 +6018,7 @@ and will be packed into @data. + #GstAudioPackFlags @@ -5745,6 +6054,7 @@ channels * size(unpack_format) bytes. + #GstAudioPackFlags @@ -6000,6 +6310,44 @@ Note: This initializes @info first, no values are preserved. non-interleaved audio + + #GstAudioDownmixMeta defines an audio downmix matrix to be send along with +audio buffers. These functions in this module help to create and attach the +meta as well as extracting it. + + parent #GstMeta + + + + the audio properties of the buffer + + + + the number of valid samples in the buffer + + + + the offsets (in bytes) where each channel plane starts in the + buffer or %NULL if the buffer has interleaved layout; if not %NULL, this + is guaranteed to be an array of @info.channels elements + + + + + + + + + + + + + + + + + + Make a new resampler. - %TRUE on success + The new #GstAudioResampler, or +%NULL on failure. @@ -6365,9 +6714,11 @@ When @options is %NULL, the previously configured options are reused. + the #GstAudioFormat + the number of channels @@ -7512,7 +7863,7 @@ MT safe. size of data in the ringbuffer - + @@ -7921,19 +8272,19 @@ with a flush or stop. value="12" c:identifier="GST_AUDIO_RING_BUFFER_FORMAT_TYPE_MPEG2_AAC_RAW" glib:nick="mpeg2-aac-raw"> - samples in MPEG-2 AAC raw format (Since 1.12) + samples in MPEG-2 AAC raw format (Since: 1.12) - samples in MPEG-4 AAC raw format (Since 1.12) + samples in MPEG-4 AAC raw format (Since: 1.12) - samples in FLAC format (Since 1.12) + samples in FLAC format (Since: 1.12) @@ -8007,7 +8358,7 @@ with a flush or stop. glib:nick="error"> The ringbuffer has encountered an error after it has been started, e.g. because the device was - disconnected (Since 1.2) + disconnected (Since: 1.2) version="1.14"> Allocate a new #GstAudioStreamAlign with the given configuration. All processing happens according to sample rate @rate, until -gst_audio_discont_wait_set_rate() is called with a new @rate. +gst_audio_stream_align_set_rate() is called with a new @rate. A negative rate can be used for reverse playback. @alignment_threshold gives the tolerance in nanoseconds after which a @@ -8552,33 +8903,46 @@ or gst_audio_stream_align_copy(). + c:identifier="gst_audio_stream_align_get_alignment_threshold" + version="1.14"> + Gets the currently configured alignment threshold. + The currently configured alignment threshold + a #GstAudioStreamAlign + c:identifier="gst_audio_stream_align_get_discont_wait" + version="1.14"> + Gets the currently configured discont wait. + The currently configured discont wait + a #GstAudioStreamAlign - + + Gets the currently configured sample rate. + The currently configured sample rate + a #GstAudioStreamAlign @@ -8693,42 +9057,56 @@ of the current one. + c:identifier="gst_audio_stream_align_set_alignment_threshold" + version="1.14"> + Sets @alignment_treshold as new alignment threshold for the following processing. + a #GstAudioStreamAlign + a new alignment threshold + c:identifier="gst_audio_stream_align_set_discont_wait" + version="1.14"> + Sets @alignment_treshold as new discont wait for the following processing. + a #GstAudioStreamAlign + a new discont wait - + + Sets @rate as new sample rate for the following processing. If the sample +rate differs this implicitely marks the next data as discontinuous. + a #GstAudioStreamAlign + a new sample rate @@ -8894,7 +9272,9 @@ cbrt(val) and 20 * log10 (val). - + Clip the buffer to the given %GstSegment. After calling this function the caller does not own a reference to @@ -8929,7 +9309,8 @@ number of channels. + c:identifier="gst_audio_buffer_reorder_channels" + moved-to="AudioBuffer.reorder_channels"> Reorders @buffer from the channel positions @from to the channel positions @to. @from and @to must contain the same number of positions and the same positions, only in a different order. @@ -8971,6 +9352,43 @@ positions and the same positions, only in a different order. + + Truncate the buffer to finally have @samples number of samples, removing +the necessary amount of samples from the end and @trim number of samples +from the beginning. + +After calling this function the caller does not own a reference to +@buffer anymore. + + the truncated buffer or %NULL if the arguments + were invalid + + + + + The buffer to truncate. + + + + size of one audio frame in bytes. This is the size of one sample * +number of channels. + + + + the number of samples to remove from the beginning of the buffer + + + + the final number of samples that should exist in this buffer or -1 +to use all the remaining samples if you are only removing samples from the +beginning. + + + + @@ -9138,14 +9556,13 @@ in the order required by GStreamer. + c:identifier="gst_audio_channel_positions_to_string" + version="1.10"> Converts @position to a human-readable string representation for debugging purposes. a newly allocated string representing -@position - -Since 1.10 +@position @@ -9455,6 +9872,19 @@ otherwise. + + + + + + + + + + c:identifier="gst_audio_reorder_channels"> Reorders @data from the channel positions @from to the channel positions @to. @from and @to must contain the same number of -positions and the same positions, only in a different order. +positions and the same positions, only in a different order. + +Note: this function assumes the audio data is in interleaved layout %TRUE if the reordering was possible. @@ -9552,7 +9984,8 @@ positions and the same positions, only in a different order. moved-to="AudioResampler.new"> Make a new resampler. - %TRUE on success + The new #GstAudioResampler, or +%NULL on failure. @@ -9565,9 +9998,11 @@ positions and the same positions, only in a different order. + the #GstAudioFormat + the number of channels @@ -9693,6 +10128,55 @@ of the results. + + Allocates and attaches a #GstAudioMeta on @buffer, which must be writable +for that purpose. The fields of the #GstAudioMeta are directly populated +from the arguments of this function. + +When @info->layout is %GST_AUDIO_LAYOUT_NON_INTERLEAVED and @offsets is +%NULL, the offsets are calculated with a formula that assumes the planes are +tightly packed and in sequence: +offsets[channel] = channel * @samples * sample_stride + +It is not allowed for channels to overlap in memory, +i.e. for each i in [0, channels), the range +[@offsets[i], @offsets[i] + @samples * sample_stride) must not overlap +with any other such range. This function will assert if the parameters +specified cause this restriction to be violated. + +It is, obviously, also not allowed to specify parameters that would cause +out-of-bounds memory access on @buffer. This is also checked, which means +that you must add enough memory on the @buffer before adding this meta. + + the #GstAudioMeta that was attached on the @buffer + + + + + a #GstBuffer + + + + the audio properties of the buffer + + + + the number of valid samples in the buffer + + + + the offsets (in bytes) where each channel plane starts + in the buffer or %NULL to calculate it (see below); must be %NULL also + when @info->layout is %GST_AUDIO_LAYOUT_INTERLEAVED + + + + Find the #GstAudioDownmixMeta on @buffer for the given destination diff --git a/gir-files/GstBase-1.0.gir b/gir-files/GstBase-1.0.gir index 6c4c8a1d9..38afccf0f 100644 --- a/gir-files/GstBase-1.0.gir +++ b/gir-files/GstBase-1.0.gir @@ -931,6 +931,7 @@ buffer in the list before freeing the list after usage. + + This is a simple #GstAggregator::get_next_time implementation that +just looks at the #GstSegment on the srcpad of the aggregator and bases +the next time on the running time there. + +This is the desired behaviour in most cases where you have a live source +and you have a dead line based aggregator subclass. + + The running time based on the position + + + + + A #GstAggregator + + + + + + Force minimum upstream latency (in nanoseconds). When sources with a +higher latency are expected to be plugged in dynamically after the +aggregator has started playing, this allows overriding the minimum +latency reported by the initial source(s). This is only taken into +account when larger than the actually reported minimum latency. + + @@ -1387,7 +1419,8 @@ can reconfigure its global latency. + glib:is-gtype-struct-for="Aggregator" + version="1.14"> The aggregator base class will handle in a thread-safe way all manners of concurrent flushes, seeks, pad additions and removals, leaving to the subclass the responsibility of clipping buffers, and aggregating buffers in @@ -1701,6 +1734,7 @@ _finish_buffer from inside that function. + This checks if a pad has a buffer available that will be returned by +a call to gst_aggregator_pad_peek_buffer() or +gst_aggregator_pad_pop_buffer(). %TRUE if the pad has a buffer available as the next thing. @@ -1804,6 +1841,13 @@ usage. + + Enables the emission of signals such as #GstAggregatorPad::buffer-consumed + + @@ -1811,18 +1855,29 @@ usage. last segment received. - + - + + + + + + + + + + + + glib:is-gtype-struct-for="AggregatorPad" + version="1.14"> @@ -1923,17 +1978,17 @@ a parser and share a lot of rather complex code. ## Set-up phase - * #GstBaseParse calls @start to inform subclass that data processing is - about to start now. + * #GstBaseParse calls #GstBaseParseClass.start() to inform subclass + that data processing is about to start now. - * #GstBaseParse class calls @set_sink_caps to inform the subclass about - incoming sinkpad caps. Subclass could already set the srcpad caps - accordingly, but this might be delayed until calling - gst_base_parse_finish_frame() with a non-queued frame. + * #GstBaseParse class calls #GstBaseParseClass.set_sink_caps() to + inform the subclass about incoming sinkpad caps. Subclass could + already set the srcpad caps accordingly, but this might be delayed + until calling gst_base_parse_finish_frame() with a non-queued frame. * At least at this point subclass needs to tell the #GstBaseParse class - how big data chunks it wants to receive (min_frame_size). It can do - this with gst_base_parse_set_min_frame_size(). + how big data chunks it wants to receive (minimum frame size ). It can + do this with gst_base_parse_set_min_frame_size(). * #GstBaseParse class sets up appropriate data passing mode (pull/push) and starts to process the data. @@ -1944,24 +1999,27 @@ a parser and share a lot of rather complex code. by pulling it from upstream or collecting buffers in an internal #GstAdapter. - * A buffer of (at least) min_frame_size bytes is passed to subclass with - @handle_frame. Subclass checks the contents and can optionally - return GST_FLOW_OK along with an amount of data to be skipped to find - a valid frame (which will result in a subsequent DISCONT). - If, otherwise, the buffer does not hold a complete frame, - @handle_frame can merely return and will be called again when additional - data is available. In push mode this amounts to an - additional input buffer (thus minimal additional latency), in pull mode - this amounts to some arbitrary reasonable buffer size increase. - Of course, gst_base_parse_set_min_frame_size() could also be used if a - very specific known amount of additional data is required. - If, however, the buffer holds a complete valid frame, it can pass - the size of this frame to gst_base_parse_finish_frame(). - If acting as a converter, it can also merely indicate consumed input data - while simultaneously providing custom output data. - Note that baseclass performs some processing (such as tracking - overall consumed data rate versus duration) for each finished frame, - but other state is only updated upon each call to @handle_frame + * A buffer of (at least) min_frame_size bytes is passed to subclass + with #GstBaseParseClass.handle_frame(). Subclass checks the contents + and can optionally return #GST_FLOW_OK along with an amount of data + to be skipped to find a valid frame (which will result in a + subsequent DISCONT). If, otherwise, the buffer does not hold a + complete frame, #GstBaseParseClass.handle_frame() can merely return + and will be called again when additional data is available. In push + mode this amounts to an additional input buffer (thus minimal + additional latency), in pull mode this amounts to some arbitrary + reasonable buffer size increase. + + Of course, gst_base_parse_set_min_frame_size() could also be used if + a very specific known amount of additional data is required. If, + however, the buffer holds a complete valid frame, it can pass the + size of this frame to gst_base_parse_finish_frame(). + + If acting as a converter, it can also merely indicate consumed input + data while simultaneously providing custom output data. Note that + baseclass performs some processing (such as tracking overall consumed + data rate versus duration) for each finished frame, but other state + is only updated upon each call to #GstBaseParseClass.handle_frame() (such as tracking upstream input timestamp). Subclass is also responsible for setting the buffer metadata @@ -1972,28 +2030,30 @@ a parser and share a lot of rather complex code. duration obtained from configuration (see below), and offset if meaningful (in pull mode). - Note that @check_valid_frame might receive any small - amount of input data when leftover data is being drained (e.g. at EOS). + Note that #GstBaseParseClass.handle_frame() might receive any small + amount of input data when leftover data is being drained (e.g. at + EOS). - * As part of finish frame processing, - just prior to actually pushing the buffer in question, - it is passed to @pre_push_frame which gives subclass yet one - last chance to examine buffer metadata, or to send some custom (tag) + * As part of finish frame processing, just prior to actually pushing + the buffer in question, it is passed to + #GstBaseParseClass.pre_push_frame() which gives subclass yet one last + chance to examine buffer metadata, or to send some custom (tag) events, or to perform custom (segment) filtering. * During the parsing process #GstBaseParseClass will handle both srcpad - and sinkpad events. They will be passed to subclass if @event or - @src_event callbacks have been provided. + and sinkpad events. They will be passed to subclass if + #GstBaseParseClass.event() or #GstBaseParseClass.src_event() + implementations have been provided. ## Shutdown phase -* #GstBaseParse class calls @stop to inform the subclass that data - parsing will be stopped. +* #GstBaseParse class calls #GstBaseParseClass.stop() to inform the + subclass that data parsing will be stopped. -Subclass is responsible for providing pad template caps for -source and sink pads. The pads need to be named "sink" and "src". It also -needs to set the fixed caps on srcpad, when the format is ensured (e.g. -when base class calls subclass' @set_sink_caps function). +Subclass is responsible for providing pad template caps for source and +sink pads. The pads need to be named "sink" and "src". It also needs to +set the fixed caps on srcpad, when the format is ensured (e.g. when +base class calls subclass' #GstBaseParseClass.set_sink_caps() function). This base class uses %GST_FORMAT_DEFAULT as a meaning of frames. So, subclass conversion routine needs to know that conversion from @@ -2012,9 +2072,10 @@ Things that subclass need to take care of: * Fixate the source pad caps when appropriate * Inform base class how big data chunks should be retrieved. This is done with gst_base_parse_set_min_frame_size() function. -* Examine data chunks passed to subclass with @handle_frame and pass - proper frame(s) to gst_base_parse_finish_frame(), and setting src pad - caps and timestamps on frame. +* Examine data chunks passed to subclass with + #GstBaseParseClass.handle_frame() and pass proper frame(s) to + gst_base_parse_finish_frame(), and setting src pad caps and timestamps + on frame. * Provide conversion functions * Update the duration information with gst_base_parse_set_duration() * Optionally passthrough using gst_base_parse_set_passthrough() @@ -2024,13 +2085,14 @@ Things that subclass need to take care of: * In particular, if subclass is unable to determine a duration, but parsing (or specs) yields a frames per seconds rate, then this can be - provided to #GstBaseParse to enable it to cater for - buffer time metadata (which will be taken from upstream as much as + provided to #GstBaseParse to enable it to cater for buffer time + metadata (which will be taken from upstream as much as possible). Internally keeping track of frame durations and respective sizes that have been pushed provides #GstBaseParse with an estimated - bitrate. A default @convert (used if not overridden) will then use these - rates to perform obvious conversions. These rates are also used to - update (estimated) duration at regular frame intervals. + bitrate. A default #GstBaseParseClass.convert() (used if not + overridden) will then use these rates to perform obvious conversions. + These rates are also used to update (estimated) duration at regular + frame intervals. @@ -2228,7 +2290,7 @@ to the new entry, etc. - Default implementation of "convert" vmethod in #GstBaseParse class. + Default implementation of #GstBaseParseClass.convert(). %TRUE if conversion was successful. @@ -2503,7 +2565,7 @@ particular parsing of the format, it typically corresponds to 1 frame duration.< Subclass can use this function to tell the base class that it needs to -give at least #min_size buffers. +be given buffers of at least @min_size bytes. @@ -2513,8 +2575,8 @@ give at least #min_size buffers. - Minimum size of the data that this base class should give to - subclass. + Minimum size in bytes of the data that this base class should + give to subclass. @@ -2524,10 +2586,10 @@ give at least #min_size buffers. Set if the nature of the format or configuration does not allow (much) parsing, and the parser should operate in passthrough mode (which only applies when operating in push mode). That is, incoming buffers are -pushed through unmodified, i.e. no @check_valid_frame or @parse_frame -callbacks will be invoked, but @pre_push_frame will still be invoked, -so subclass can perform as much or as little is appropriate for -passthrough semantics in @pre_push_frame. +pushed through unmodified, i.e. no #GstBaseParseClass.handle_frame() +will be invoked, but #GstBaseParseClass.pre_push_frame() will still be +invoked, so subclass can perform as much or as little is appropriate for +passthrough semantics in #GstBaseParseClass.pre_push_frame(). @@ -2923,21 +2985,26 @@ then use gst_base_parse_frame_init() to initialise it. + Copies a #GstBaseParseFrame. + A copy of @frame + a #GstBaseParseFrame + Frees the provided @frame. + A #GstBaseParseFrame @@ -3473,6 +3540,23 @@ unlimited time. + + Get the processing deadline of @sink. see +gst_base_sink_set_processing_deadline() for more information about +the processing deadline. + + the processing deadline + + + + + a #GstBaseSink + + + + Get the render delay of @sink. see gst_base_sink_set_render_delay() for more @@ -3745,6 +3829,28 @@ an unlimited time. + + Maximum amount of time (in nanoseconds) that the pipeline can take +for processing the buffer. This is added to the latency of live +pipelines. + +This function is usually called by subclasses. + + + + + + a #GstBaseSink + + + + the new processing deadline in nanoseconds. + + + + Configures @sink to send Quality-of-Service events upstream. @@ -3990,6 +4096,15 @@ rendering of the buffers when it would exceed to max-bitrate. + + Maximum amount of time (in nanoseconds) that the pipeline can take +for processing the buffer. This is added to the latency of live +pipelines. + + @@ -4958,7 +5073,13 @@ blocking operation should be unblocked with the unlock vmethod. If @automatic_eos is %TRUE, @src will automatically go EOS if a buffer after the total size is returned. By default this is %TRUE but sources that can't return an authoritative size and only know that they're EOS -when trying to read more should set this to %FALSE. +when trying to read more should set this to %FALSE. + +When @src operates in %GST_FORMAT_TIME, #GstBaseSrc will send an EOS +when a buffer outside of the currently configured segment is pushed if +@automatic_eos is %TRUE. Since 1.16, if @automatic_eos is %FALSE an +EOS will be pushed only when the #GstBaseSrc.create implementation +returns %GST_FLOW_EOS. @@ -6336,8 +6457,8 @@ running_time. version="1.6"> Updates the srcpad caps and send the caps downstream. This function can be used by subclasses when they have already negotiated their caps -but found a change in them (or computed new informations). This way, -they can notify downstream about that change without loosing any +but found a change in them (or computed new information). This way, +they can notify downstream about that change without losing any buffer. %TRUE if the caps could be send downstream %FALSE otherwise @@ -7195,6 +7316,433 @@ Free-function: gst_bit_reader_free + + #GstBitWriter provides a bit writer that can write any number of +bits into a memory buffer. It provides functions for writing any +number of bits into 8, 16, 32 and 64 bit variables. + + Allocated @data for bit writer to write + + + + Size of written @data in bits + + + + + + + + + + + + + + + + + + Write trailing bit to align last byte of @data. @trailing_bit can +only be 1 or 0. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + trailing bits of last byte, 0 or 1 + + + + + + Frees @bitwriter and the allocated data inside. + + + + + + #GstBitWriter instance + + + + + + Frees @bitwriter without destroying the internal data, which is +returned as #GstBuffer. + +Free-function: gst_buffer_unref + + a new allocated #GstBuffer wrapping the + data inside. gst_buffer_unref() after usage. + + + + + #GstBitWriter instance + + + + + + Frees @bitwriter without destroying the internal data, which is +returned. + +Free-function: g_free + + the current data. g_free() after + usage. + + + + + + + #GstBitWriter instance + + + + + + Get written data pointer + + data pointer + + + + + a #GstBitWriter instance + + + + + + + + + + + + + + + + Get size of written @data + + size of bits written in @data + + + + + a #GstBitWriter instance + + + + + + Initializes @bitwriter to an empty instance. + + + + + + #GstBitWriter instance + + + + + + Initializes @bitwriter with the given memory area @data. IF +@initialized is %TRUE it is possible to read @size bits from the +#GstBitWriter from the beginning. + + + + + + #GstBitWriter instance + + + + Memory area for writing + + + + + + Size of @data in bytes + + + + If %TRUE the complete data can be read from the beginning + + + + + + Initializes a #GstBitWriter instance and allocates the given data +@size. + + + + + + #GstBitWriter instance + + + + the size on bytes to allocate for data + + + + If %TRUE the data can't be reallocated + + + + + + Write @nbits bits of @value to #GstBitWriter. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + value of #guint16 to write + + + + number of bits to write + + + + + + Write @nbits bits of @value to #GstBitWriter. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + value of #guint32 to write + + + + number of bits to write + + + + + + Write @nbits bits of @value to #GstBitWriter. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + value of #guint64 to write + + + + number of bits to write + + + + + + Write @nbits bits of @value to #GstBitWriter. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + value of #guint8 to write + + + + number of bits to write + + + + + + Write @nbytes bytes of @data to #GstBitWriter. + + %TRUE if successful, %FALSE otherwise. + + + + + a #GstBitWriter instance + + + + pointer of data to write + + + + number of bytes to write + + + + + + Resets @bitwriter and frees the data if it's owned by @bitwriter. + + + + + + #GstBitWriter instance + + + + + + Resets @bitwriter and returns the current data as #GstBuffer. + +Free-function: gst_buffer_unref + + a new allocated #GstBuffer wrapping the + current data. gst_buffer_unref() after usage. + + + + + a #GstBitWriter instance + + + + + + Resets @bitwriter and returns the current data. + +Free-function: g_free + + the current data. g_free() after + usage. + + + + + + + a #GstBitWriter instance + + + + + + + + + + + + + + + + + + + Creates a new, empty #GstBitWriter instance. + +Free-function: gst_bit_writer_free + + a new, empty #GstByteWriter instance + + + + + Creates a new #GstBitWriter instance with the given memory area. If +@initialized is %TRUE it is possible to read @size bits from the +#GstBitWriter from the beginnig. + +Free-function: gst_bit_writer_free + + a new #GstBitWriter instance + + + + + Memory area for writing + + + + Size of @data in bytes + + + + if %TRUE the complete data can be read from the beginning + + + + + + Creates a #GstBitWriter instance with the given initial data size. + +Free-function: gst_bit_writer_free + + a new #GstBitWriter instance + + + + + Initial size of data in bytes + + + + If %TRUE the data can't be reallocated + + + + + #GstByteReader provides a byte reader that can read different integer and floating point types from a memory buffer. It provides functions for reading @@ -10787,7 +11335,10 @@ MT safe. The #GstDataQueue - + the location to store the result @@ -10861,7 +11412,10 @@ MT safe. a #GstDataQueue. - + pointer to store the returned #GstDataQueueItem. @@ -10884,7 +11438,10 @@ MT safe. a #GstDataQueue. - + pointer to store the returned #GstDataQueueItem. @@ -11199,7 +11756,7 @@ These rules are: * %GST_FLOW_OK: otherwise %GST_FLOW_ERROR or below, GST_FLOW_NOT_NEGOTIATED and GST_FLOW_FLUSHING are -returned immediatelly from the gst_flow_combiner_update_flow() function. +returned immediately from the gst_flow_combiner_update_flow() function. @@ -11508,6 +12065,21 @@ buffers. #GstQueueArray is an object that provides standard queue functionality based on an array instead of linked lists. This reduces the overhead caused by memory management by a large factor. + + Clears queue @array and frees all memory associated to it. + + + + + + a #GstQueueArray object + + + + Finds an element in the queue @array, either by comparing every element with @func or by looking up @data if no compare function @func is provided, -and returning the index of the found element. - -Note that the index is not 0-based, but an internal index number with a -random offset. The index can be used in connection with -gst_queue_array_drop_element(). FIXME: return index 0-based and make -gst_queue_array_drop_element() take a 0-based index. +and returning the index of the found element. Index of the found element or -1 if nothing was found. @@ -11677,6 +12244,42 @@ remove it from the queue. + + Returns the item at @idx in @array, but does not remove it from the queue. + + The item, or %NULL if @idx was out of bounds + + + + + + + + + + + + + Returns the item at @idx in @array, but does not remove it from the queue. + + The item, or %NULL if @idx was out of bounds + + + + + + + + + + + + + Sets a function to clear an element of @array. + +The @clear_func will be called when an element in the array +data segment is removed and when the array is freed and data +segment is deallocated as well. @clear_func will be passed a +pointer to the element to clear, rather than the element itself. + +Note that in contrast with other uses of #GDestroyNotify +functions, @clear_func is expected to clear the contents of +the array element it is given, but not free the element itself. + + + + + + a #GstQueueArray object + + + + a function to clear an element of @array + + + + + + Creates a new, empty #GstBitWriter instance. + +Free-function: gst_bit_writer_free + + a new, empty #GstByteWriter instance + + + + + Creates a new #GstBitWriter instance with the given memory area. If +@initialized is %TRUE it is possible to read @size bits from the +#GstBitWriter from the beginnig. + +Free-function: gst_bit_writer_free + + a new #GstBitWriter instance + + + + + Memory area for writing + + + + Size of @data in bytes + + + + if %TRUE the complete data can be read from the beginning + + + + + + Creates a #GstBitWriter instance with the given initial data size. + +Free-function: gst_bit_writer_free + + a new #GstBitWriter instance + + + + + Initial size of data in bytes + + + + If %TRUE the data can't be reallocated + + + + + + Tries to find what type of data is contained in the given #GstBuffer, the +assumption being that the buffer represents the beginning of the stream or +file. + +All available typefinders will be called on the data in order of rank. If +a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM, +typefinding is stopped immediately and the found caps will be returned +right away. Otherwise, all available typefind functions will the tried, +and the caps with the highest probability will be returned, or %NULL if +the content of the buffer could not be identified. + +When @extension is not %NULL, this function will first try the typefind +functions for the given extension, which might speed up the typefinding +in many cases. + +Free-function: gst_caps_unref + + the #GstCaps corresponding to the data, + or %NULL if no type could be found. The caller should free the caps + returned with gst_caps_unref(). + + + + + object doing the typefinding, or %NULL (used for logging) + + + + a #GstBuffer with data to typefind + + + + extension of the media, or %NULL + + + + location to store the probability of the found + caps, or %NULL + + + + Tries to find what type of data is contained in the given @data, the @@ -12167,6 +12917,69 @@ Free-function: gst_caps_unref + + Tries to find what type of data is contained in the given @data, the +assumption being that the data represents the beginning of the stream or +file. + +All available typefinders will be called on the data in order of rank. If +a typefinding function returns a probability of %GST_TYPE_FIND_MAXIMUM, +typefinding is stopped immediately and the found caps will be returned +right away. Otherwise, all available typefind functions will the tried, +and the caps with the highest probability will be returned, or %NULL if +the content of @data could not be identified. + +When @extension is not %NULL, this function will first try the typefind +functions for the given extension, which might speed up the typefinding +in many cases. + +Free-function: gst_caps_unref + + the #GstCaps corresponding to the data, + or %NULL if no type could be found. The caller should free the caps + returned with gst_caps_unref(). + + + + + object doing the typefinding, or %NULL (used for logging) + + + + * a pointer with data to typefind + + + + + + the size of @data + + + + extension of the media, or %NULL + + + + location to store the probability of the found + caps, or %NULL + + + + Tries to find the best #GstCaps associated with @extension. @@ -12239,8 +13052,11 @@ Free-function: gst_caps_unref The length in bytes - - extension of the media + + extension of the media, or %NULL a @gboolean %TRUE if the waits have been registered, %FALSE if not. -(Could be that it timed out waiting or that more waits then waits was found) +(Could be that it timed out waiting or that more waits than waits was found) @@ -2314,6 +2314,39 @@ MT safe. + + Blocks until at least @count clock notifications have been requested from +@test_clock, or the timeout expires. + +MT safe. + + a @gboolean %TRUE if the waits have been registered, %FALSE if not. +(Could be that it timed out waiting or that more waits than waits was found) + + + + + #GstTestClock for which to await having enough pending clock + + + + the number of pending clock notifications to wait for + + + + the timeout in milliseconds + + + + Address + of a #GList pointer variable to store the list of pending #GstClockIDs + that expired, or %NULL + + + + + + Blocks until at least @count clock notifications have been requested from @test_clock. There is no timeout for this wait, see the main description of diff --git a/gir-files/GstGL-1.0.gir b/gir-files/GstGL-1.0.gir index 51ed9016f..630dc4754 100644 --- a/gir-files/GstGL-1.0.gir +++ b/gir-files/GstGL-1.0.gir @@ -34,26 +34,50 @@ synchronization metadata on buffers from the pool. Name of the caps feature for indicating the use of #GstGLMemory - - + + no API - + Desktop OpenGL up to and including 3.1. The compatibility profile when the OpenGL version is >= 3.2 - + Desktop OpenGL >= 3.2 core profile - + OpenGL ES 1.x - + OpenGL ES 2.x and 3.x - + Any OpenGL API + + + The #GstGLAPI represented by @api_s + + + + + a space seperated string of OpenGL apis + + + + + + + A space seperated string of the OpenGL api's enabled in @api + + + + + a #GstGLAPI to stringify + + + + @@ -514,11 +538,22 @@ is available and current in the calling thread. + + + Whether an OpenGL context could be retrieved or created successfully + + + + + a #GstGLBaseFilter + + + + - parent #GstBaseTransform @@ -547,8 +582,8 @@ is available and current in the calling thread. + The base class for GStreamer GL Filter. - parent class @@ -748,11 +783,6 @@ then this function imply returns TRUE. - - - - - Initializes the GL Base Memory allocator. It is safe to call this function multiple times. This must be called before any other GstGLBaseMemory operation. @@ -927,24 +957,29 @@ function to allocate and OpenGL resources needed for your application - - + + generic faliure - + the implementation is too old and doesn't implement enough features - + a resource could not be found + + + + + - - + + the texture needs downloading to the data pointer - + the data pointer needs uploading to the texture @@ -1027,7 +1062,7 @@ multiple times. This must be called before any other #GstGLBuffer operation. - Opaque #GstGLAllocator struct + Opaque #GstGLBufferAllocator struct @@ -1120,7 +1155,7 @@ The glcolorconvertelement provides a GStreamer element that uses - Provides an implementation of #GstBaseTransformClass::fixate_caps() + Provides an implementation of #GstBaseTransformClass.fixate_caps() the fixated #GstCaps @@ -1145,7 +1180,7 @@ The glcolorconvertelement provides a GStreamer element that uses - Provides an implementation of #GstBaseTransformClass::transform_caps() + Provides an implementation of #GstBaseTransformClass.transform_caps() the converted #GstCaps @@ -1170,7 +1205,7 @@ The glcolorconvertelement provides a GStreamer element that uses - Provides an implementation of #GstBaseTransfromClass::decide_allocation() + Provides an implementation of #GstBaseTransformClass.decide_allocation() whether the allocation parameters were successfully chosen @@ -1342,11 +1377,6 @@ See also: gst_gl_context_get_proc_address() - - - - - See also gst_gl_context_activate(). @@ -1534,7 +1564,7 @@ the #GstGLWindow chosen. Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid -after a call to gst_gl_context_create_context(). +after a call to gst_gl_context_create(). @@ -1802,7 +1832,7 @@ the #GstGLWindow chosen. Get the version of the OpenGL platform (GLX, EGL, etc) used. Only valid -after a call to gst_gl_context_create_context(). +after a call to gst_gl_context_create(). @@ -1969,6 +1999,46 @@ already running. + + + whether @context supports the 'precision' specifier in GLSL shaders + + + + + a #GstGLContext + + + + a #GstGLSLVersion + + + + a #GstGLSLProfile + + + + + + + whether @context supports the 'precision highp' specifier in GLSL shaders + + + + + a #GstGLContext + + + + a #GstGLSLVersion + + + + a #GstGLSLProfile + + + + Swap the front and back buffers on the window attached to @context. This will display the frame on the next refresh cycle. @@ -2212,26 +2282,31 @@ MT-safe - + OpenGL context errors. - + Failed for an unspecified reason - + The configuration requested is not correct - + The OpenGL API requested is not correct - + The OpenGL libraries are too old - + glXCreateContext (or similar) failed - + A resource is not available + + + + + @@ -2624,35 +2699,35 @@ through the provided API - - + + no display type - + X11 display - + Wayland display - + Cocoa display - + Win32 display - + Dispmanx display - + EGL display - + Vivante Framebuffer display - + Mesa3D GBM display - + any display type @@ -2701,7 +2776,7 @@ for details on what is a valid name. - + @@ -2753,7 +2828,7 @@ for details on what is a valid name. - + @@ -2969,7 +3044,6 @@ See also: gst_gl_filter_render_to_target() - parent #GstGLBaseFilter @@ -2993,7 +3067,7 @@ See also: gst_gl_filter_render_to_target() - #GstGLFramebuffer object used for transformations + #GstGLFramebuffer object used for transformations (only for subclass usage) @@ -3034,7 +3108,6 @@ See also: gst_gl_filter_render_to_target() - parent #GstGLBaseFilterClass @@ -3139,7 +3212,7 @@ See also: gst_gl_filter_render_to_target() - the #GstGLFIlter + the #GstGLFilter @@ -3152,55 +3225,138 @@ See also: gst_gl_filter_render_to_target() - - + + Single component replicated across R, G, and B textures components - + Single component stored in the A texture component - + Combination of #GST_GL_LUMINANCE and #GST_GL_ALPHA - + Single component stored in the R texture component - + Single 8-bit component stored in the R texture component - + Two components stored in the R and G texture components - + Two 8-bit components stored in the R and G texture components - + Three components stored in the R, G, and B texture components - + Three 8-bit components stored in the R, G, and B texture components - + Three components of bit depth 5, 6 and 5 stored in the R, G, and B texture components respectively. - + + Three 16-bit components stored in the R, G, and B + texture components + + Four components stored in the R, G, B, and A texture components respectively. - + Four 8-bit components stored in the R, G, B, and A texture components respectively. - + + Four 16-bit components stored in the R, G, B, and A texture + components respectively. + + A single 16-bit component for depth information. - + A 24-bit component for depth information and a 8-bit component for stencil informat. + + + the #GstGLFormat necessary for holding the data in @plane of @vinfo + + + + + a #GstGLContext + + + + a #GstVideoInfo + + + + the plane number in @vinfo + + + + + + + Whether @format is supported by @context based on the OpenGL API, + version, or available OpenGL extension/s. + + + + + a #GstGLContext + + + + the #GstGLFormat to check is supported by @context + + + + + + Get the unsized format and type from @format for usage in glReadPixels, +glTex{Sub}Image*, glTexImage* and similar functions. + + + + + + the sized internal #GstGLFormat + + + + location for the resulting unsized #GstGLFormat + + + + location for the resulting GL type + + + + + + + the number of bytes the specified @format, @type combination takes +per pixel + + + + + the OpenGL format, %GL_RGBA, %GL_LUMINANCE, etc + + + + the OpenGL type, %GL_UNSIGNED_BYTE, %GL_FLOAT, etc + + + + A #GstGLFramebuffer represents and holds an OpenGL framebuffer object with @@ -3384,7 +3540,8 @@ between multiple OpenGL contexts. - + + GstGLMemory is a #GstGLBaseMemory subclass providing support for the mapping of OpenGL textures. @@ -3406,6 +3563,7 @@ Data is uploaded or downloaded from the GPU as is necessary. + the texture type @@ -3857,6 +4015,7 @@ mappings between texture formats. + Opaque #GstGLMemoryPBOAllocator struct @@ -3867,6 +4026,7 @@ mappings between texture formats. + Only contains private data @@ -3931,10 +4091,13 @@ mappings between texture formats. - + + + + - + @@ -3973,29 +4136,53 @@ mappings between texture formats. - - + + no platform - + the EGL platform used primarily with the X11, wayland and android window systems as well as on embedded Linux - + the GLX platform used primarily with the X11 window system - + the WGL platform used primarily on Windows - + the CGL platform used primarily on OS X - + the EAGL platform used primarily on iOS - + any OpenGL platform + + + The #GstGLPlatform represented by @platform_s + + + + + a space seperated string of OpenGL platformss + + + + + + + A space seperated string of the OpenGL platforms enabled in @platform + + + + + a #GstGLPlatform to stringify + + + + A #GstGLQuery represents and holds an OpenGL query object. Various types of @@ -4156,14 +4343,14 @@ GStreamer elements. - - + + no query - + query the time elapsed - + query the current time @@ -4173,8 +4360,7 @@ OpenGL renderbuffers. #GstGLRenderbuffer is created or wrapped through gst_gl_base_memory_alloc() with #GstGLRenderbufferAllocationParams. - - the parent object + @@ -4182,6 +4368,7 @@ with #GstGLRenderbufferAllocationParams. + the texture type @@ -4257,16 +4444,20 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + Allocation parameters + + the #GstGLFormat + the width + the height @@ -4366,35 +4557,64 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + Compilation stage that caused an error - + Compilation error occured - + Link error occured - + General program error occured + + + + + - + GLSL profiles - + no profile supported/available - + OpenGL|ES profile - + OpenGL core profile - + OpenGL compatibility profile - + any OpenGL/OpenGL|ES profile + + + the #GstGLSLProfile of @string or %GST_GLSL_PROFILE_NONE on error + + + + + a GLSL version string + + + + + + + the name for @profile or %NULL on error + + + + + a #GstGLSLProfile + + + + #GstGLSLStage holds and represents a single OpenGL shader stage. @@ -4615,59 +4835,121 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + GLSL version list - + no version - + version 100 (only valid for ES) - + version 110 (only valid for compatibility desktop GL) - + version 120 (only valid for compatibility desktop GL) - + version 130 (only valid for compatibility desktop GL) - + version 140 (only valid for compatibility desktop GL) - + version 150 (valid for compatibility/core desktop GL) - + version 300 (only valid for ES) - + version 310 (only valid for ES) - + version 320 (only valid for ES) - + version 330 (valid for compatibility/core desktop GL) - + version 400 (valid for compatibility/core desktop GL) - + version 410 (valid for compatibility/core desktop GL) - + version 420 (valid for compatibility/core desktop GL) - + version 430 (valid for compatibility/core desktop GL) - + version 440 (valid for compatibility/core desktop GL) - + version 450 (valid for compatibility/core desktop GL) + + + the #GstGLSLVersion of @string or %GST_GLSL_VERSION_NONE on error + + + + + a GLSL version string + + + + + + Note: this function expects either a #version GLSL preprocesser directive +or a valid GLSL version and/or profile. + + TRUE if a valid #version string was found, FALSE otherwise + + + + + a valid GLSL #version string + + + + resulting #GstGLSLVersion + + + + resulting #GstGLSLVersion + + + + + + + the combined GLSL #version string for @version and @profile + + + + + a #GstGLSLVersion + + + + a #GstGLSLVersion + + + + + + + the name of @version or %NULL on error + + + + + a #GstGLSLVersion + + + + @@ -4745,6 +5027,76 @@ Note: must be called in the GL thread + + + a passthrough shader string for copying an input external-oes + texture to the output + + + + + a #GstGLContext + + + + a #GstGLSLVersion + + + + a #GstGLSLProfile + + + + + + + a passthrough shader string for copying an input texture to + the output + + + + + a #GstGLContext + + + + a #GstGLSLVersion + + + + a #GstGLSLProfile + + + + + + Generates a shader string that defines the precision of float types in +GLSL shaders. This is particularly needed for fragment shaders in a +GLSL ES context where there is no default precision specified. + +Practically, this will return the string 'precision mediump float' +or 'precision highp float' depending on if high precision floats are +determined to be supported. + + a shader string defining the precision of float types based on + @context, @version and @profile + + + + + a #GstGLContext + + + + a #GstGLSLVersion + + + + a #GstGLSLProfile + + + + Attaches @stage to @shader. @stage must have been successfully compiled with gst_glsl_stage_compile(). @@ -5675,13 +6027,16 @@ Note: must be called in the GL thread and @shader must have been linked. - + Output anaglyph type to generate when downmixing to mono + Dubois optimised Green-Magenta anaglyph + Dubois optimised Red-Cyan anaglyph + Dubois optimised Amber-Blue anaglyph @@ -5897,19 +6252,82 @@ the sync point are now visible. - - + + no texture target - + 2D texture target - + rectangle texture target - + external oes texture target + + + the #GstGLTextureTarget that's equiavalant to @target or + %GST_GL_TEXTURE_TARGET_NONE + + + + + an OpenGL texture binding target + + + + + + + the #GstGLTextureTarget represented by @str or + %GST_GL_TEXTURE_TARGET_NONE + + + + + a string equivalant to one of the GST_GL_TEXTURE_TARGET_*_STR values + + + + + + + a string representing the @GstBufferPoolOption specified by @target + + + + + a #GstGLTextureTarget + + + + + + + the OpenGL value for binding the @target with glBindTexture() and + similar functions or 0 + + + + + a #GstGLTextureTarget + + + + + + + the stringified version of @target or %NULL + + + + + a #GstGLTextureTarget + + + + #GstGLUpload is an object that uploads data from system memory into GL textures. @@ -6077,19 +6495,21 @@ gst_gl_upload_set_caps() creating a new #GstBuffer in @outbuf_ptr. - - + + No further processing required - + An unspecified error occured - + The configuration is unsupported. - + This element requires a reconfiguration. + + @@ -6417,7 +6837,7 @@ usage only to chain up at the end of a subclass free function. - Provides an implementation of #GstBaseTransformClass::fixate_caps() + Provides an implementation of #GstBaseTransformClass.fixate_caps() the fixated #GstCaps @@ -6547,7 +6967,7 @@ setting the caps with gst_gl_view_convert_set_caps(). - Provides an implementation of #GstBaseTransformClass::transform_caps() + Provides an implementation of #GstBaseTransformClass.transform_caps() the converted #GstCaps @@ -6671,11 +7091,6 @@ either be a user visible window (onscreen) or hidden (offscreen). - - - - - @@ -6686,6 +7101,19 @@ either be a user visible window (onscreen) or hidden (offscreen). + + Checks if @window controls the GL viewport. + + %TRUE if @window controls the GL viewport, otherwise %FALSE + + + + + a #GstGLWindow + + + + Redraw the window contents. Implementations should invoke the draw callback. @@ -6753,11 +7181,13 @@ from the @window. + Queue resizing of @window. + a #GstGLWindow @@ -6912,6 +7342,19 @@ require this to be called with a valid handle before drawing can commence. + + Checks if @window controls the GL viewport. + + %TRUE if @window controls the GL viewport, otherwise %FALSE + + + + + a #GstGLWindow + + + + Redraw the window contents. Implementations should invoke the draw callback. @@ -7000,11 +7443,13 @@ from the @window. + Queue resizing of @window. + a #GstGLWindow @@ -7022,17 +7467,21 @@ from the @window. + Resize @window to the given @width and @height. + a #GstGLWindow + new width + new height @@ -7639,27 +8088,47 @@ require this to be called with a valid handle before drawing can commence. + a #GstGLWindow + + + + + + + + + %TRUE if @window controls the GL viewport, otherwise %FALSE + + + + + a #GstGLWindow - + - - + + failed for a unspecified reason - + the implementation is too old - + no such resource was found + + + + + @@ -7729,7 +8198,7 @@ user-defined purposes. The name of the GL buffer allocator - + The currently supported formats that can be converted @@ -7767,7 +8236,7 @@ user-defined purposes. The name of the GL Memory PBO allocator - + List of video formats that are supported by #GstGLMemory @@ -7891,7 +8360,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with - + The #GstGLAPI represented by @api_s @@ -7903,7 +8372,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with - + A space seperated string of the OpenGL api's enabled in @api @@ -7938,7 +8407,7 @@ you are writing to OpenGL. Conversely, combining #GST_MAP_GL with - + @@ -7973,6 +8442,11 @@ multiple times. This must be called before any other #GstGLBuffer operation. + + + + + @@ -8022,7 +8496,7 @@ The returned #GstGLContext will be shared with a GStreamer created OpenGL contex - + the #GstGLFormat necessary for holding the data in @plane of @vinfo @@ -8042,7 +8516,45 @@ The returned #GstGLContext will be shared with a GStreamer created OpenGL contex - + + + Whether @format is supported by @context based on the OpenGL API, + version, or available OpenGL extension/s. + + + + + a #GstGLContext + + + + the #GstGLFormat to check is supported by @context + + + + + + Get the unsized format and type from @format for usage in glReadPixels, +glTex{Sub}Image*, glTexImage* and similar functions. + + + + + + the sized internal #GstGLFormat + + + + location for the resulting unsized #GstGLFormat + + + + location for the resulting GL type + + + + + the number of bytes the specified @format, @type combination takes per pixel @@ -8130,8 +8642,8 @@ per pixel - Helper function for implementing GstElement::set_context() in OpenGL capable -elements. + Helper function for implementing #GstElementClass.set_context() in +OpenGL capable elements. Retrieve's the #GstGLDisplay or #GstGLContext in @context and places the result in @display or @other_context respectively. @@ -8191,7 +8703,45 @@ multiple times. This must be called before any other GstGLMemory operation. - + + + whether the buffer was correctly setup + + + + + the @GstGLMemoryAllocator to allocate from + + + + a #GstBuffer to setup + + + + the #GstGLVideoAllocationParams to allocate with + + + + + a list of #GstGLFormat's to allocate with. + + + + + + + a list of wrapped data pointers + + + + + + the number of elements in @tex_formats and @wrapped_data + + + + + The #GstGLPlatform represented by @platform_s @@ -8203,7 +8753,7 @@ multiple times. This must be called before any other GstGLMemory operation. - + A space seperated string of the OpenGL platforms enabled in @platform @@ -8284,6 +8834,11 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio + + + + + @@ -8294,7 +8849,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + the #GstGLTextureTarget that's equiavalant to @target or %GST_GL_TEXTURE_TARGET_NONE @@ -8307,7 +8862,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + the #GstGLTextureTarget represented by @str or %GST_GL_TEXTURE_TARGET_NONE @@ -8320,7 +8875,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + a string representing the @GstBufferPoolOption specified by @target @@ -8332,7 +8887,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + the OpenGL value for binding the @target with glBindTexture() and similar functions or 0 @@ -8345,7 +8900,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + the stringified version of @target or %NULL @@ -8424,12 +8979,17 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + - + + + + + + the #GstGLSLProfile of @string or %GST_GLSL_PROFILE_NONE on error @@ -8441,7 +9001,7 @@ multiple times. This must be called before any other GstGLRenderbuffer operatio - + the name for @profile or %NULL on error @@ -8475,7 +9035,7 @@ preprocessor directive and then executes gst_glsl_version_profile_from_string(). - + the #GstGLSLVersion of @string or %GST_GLSL_VERSION_NONE on error @@ -8487,7 +9047,7 @@ preprocessor directive and then executes gst_glsl_version_profile_from_string(). - + Note: this function expects either a #version GLSL preprocesser directive or a valid GLSL version and/or profile. @@ -8509,7 +9069,7 @@ or a valid GLSL version and/or profile. - + the combined GLSL #version string for @version and @profile @@ -8525,7 +9085,7 @@ or a valid GLSL version and/or profile. - + the name of @version or %NULL on error @@ -8597,5 +9157,5 @@ or a valid GLSL version and/or profile. - + diff --git a/gir-files/GstMpegts-1.0.gir b/gir-files/GstMpegts-1.0.gir index 7b3834901..08140a90c 100644 --- a/gir-files/GstMpegts-1.0.gir +++ b/gir-files/GstMpegts-1.0.gir @@ -108,9 +108,11 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_eit"> Event Information Table (ATSC) + The source id + The protocol version @@ -127,15 +129,19 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_eit_event"> An ATSC EIT Event + The event id + The start time + The etm location + The length in seconds @@ -161,9 +167,11 @@ Consult the relevant specifications for more details. + The protocol version + The etm id @@ -180,9 +188,11 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_mgt"> Master Guide Table (A65) + The protocol version + The numbers of subtables @@ -205,12 +215,15 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_mgt_table"> Source from a @GstMpegtsAtscMGT + #GstMpegtsAtscMGTTableType + The packet ID + The version number @@ -247,6 +260,7 @@ Consult the relevant specifications for more details. glib:get-type="gst_mpegts_atsc_mult_string_get_type" c:symbol-prefix="atsc_mult_string"> + The ISO639 language code @@ -264,21 +278,26 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_stt"> System Time Table (A65) + The protocol version + The system time + The GPS to UTC offset + The day of month + The hour @@ -288,6 +307,7 @@ Consult the relevant specifications for more details. + The UTC date and time glib:type-name="GstMpegtsAtscStringSegment" glib:get-type="gst_mpegts_atsc_string_segment_get_type" c:symbol-prefix="atsc_string_segment"> + A string segment + The compression type + The mode + The size of compressed data + The compressed data @@ -344,9 +369,11 @@ Consult the relevant specifications for more details. Terrestrial Virtual Channel Table (A65) Cable Virtual Channel Table (A65) + The transport stream + The protocol version @@ -369,48 +396,63 @@ Consult the relevant specifications for more details. c:symbol-prefix="atsc_vct_source"> Source from a @GstMpegtsAtscVCT, can be used both for TVCT and CVCT tables + The short name of a source + The major channel number + The minor channel number + The modulation mode + The carrier frequency + The transport stream ID + The program number (see #GstMpegtsPatProgram) + The ETM location + is access controlled + is hidden + is path select, CVCT only + is out of band, CVCT only + is hide guide + The service type + The source id diff --git a/gir-files/GstNet-1.0.gir b/gir-files/GstNet-1.0.gir index 5f317c9b1..985c06f9d 100644 --- a/gir-files/GstNet-1.0.gir +++ b/gir-files/GstNet-1.0.gir @@ -791,7 +791,7 @@ parameters if it wasn't called before. version="1.6"> Check if the GStreamer PTP clock subsystem is initialized. - %TRUE if the GStreamer PTP clock subsystem is intialized. + %TRUE if the GStreamer PTP clock subsystem is initialized. diff --git a/gir-files/GstPbutils-1.0.gir b/gir-files/GstPbutils-1.0.gir index 8c47cfc44..652ee9c00 100644 --- a/gir-files/GstPbutils-1.0.gir +++ b/gir-files/GstPbutils-1.0.gir @@ -123,7 +123,7 @@ new frame. - + @@ -433,6 +433,12 @@ If the discovery of a URI times out, the %GST_DISCOVERER_TIMEOUT will be set on the result flags. + + + @@ -1717,12 +1723,12 @@ subtitles), are currently ignored. - + Makes a deep copy of @self - The copy of @self - -Since 1.12 + The copy of @self @@ -1951,10 +1957,9 @@ during the encoding - Set whether the profile should be used or not. - -Since 1.6 + c:identifier="gst_encoding_profile_set_enabled" + version="1.6"> + Set whether the profile should be used or not. @@ -2747,13 +2752,13 @@ in debugging. The micro version of GStreamer's gst-plugins-base libraries at compile time. The minor version of GStreamer's gst-plugins-base libraries at compile time. @@ -2796,12 +2801,11 @@ If mpegversion is 4, the "base-profile" field is also set in @caps. + c:identifier="gst_codec_utils_aac_get_channels" + version="1.10"> Returns the channels of the given AAC stream. - The channels or 0 if the channel could not be determined. - -Since 1.10 + The channels or 0 if the channel could not be determined. @@ -2843,13 +2847,12 @@ Main, LTP, SSR and others, the Main profile is used. The @audio_config parameter follows the following format, starting from the most significant bit of the first byte: - * Bit 0:4 contains the AudioObjectType + * Bit 0:4 contains the AudioObjectType (if this is 0x5, then the + real AudioObjectType is carried after the rate and channel data) * Bit 5:8 contains the sample frequency index (if this is 0xf, then the next 24 bits define the actual sample frequency, and subsequent fields are appropriately shifted). - * Bit 9:12 contains the channel configuration - -> HE-AAC support has not yet been implemented. + * Bit 9:12 contains the channel configuration The level as a const string and %NULL if the level could not be determined. @@ -2873,10 +2876,8 @@ determined. Returns the profile of the given AAC stream as a string. The profile is -determined using the AudioObjectType field which is in the first 5 bits of -@audio_config. - -> HE-AAC support has not yet been implemented. +normally determined using the AudioObjectType field which is in the first +5 bits of @audio_config The profile as a const string and %NULL if the profile could not be determined. @@ -2898,13 +2899,12 @@ determined. + c:identifier="gst_codec_utils_aac_get_sample_rate" + version="1.10"> Translates the sample rate index found in AAC headers to the actual sample rate. - The sample rate if sr_idx is valid, 0 otherwise. - -Since 1.10 + The sample rate if sr_idx is valid, 0 otherwise. @@ -3034,15 +3034,14 @@ byte. + c:identifier="gst_codec_utils_h265_caps_set_level_tier_and_profile" + version="1.4"> Sets the level, tier and profile in @caps if it can be determined from @profile_tier_level. See gst_codec_utils_h265_get_level(), gst_codec_utils_h265_get_tier() and gst_codec_utils_h265_get_profile() for more details on the parameters. - %TRUE if the level, tier, profile could be set, %FALSE otherwise. - -Since 1.4 + %TRUE if the level, tier, profile could be set, %FALSE otherwise. @@ -3064,14 +3063,13 @@ Since 1.4 + c:identifier="gst_codec_utils_h265_get_level" + version="1.4"> Converts the level indication (general_level_idc) in the stream's profile_tier_level structure into a string. The profiel_tier_level is expected to have the same format as for gst_codec_utils_h264_get_profile(). - The level as a const string, or %NULL if there is an error. - -Since 1.4 + The level as a const string, or %NULL if there is an error. @@ -3089,12 +3087,11 @@ Since 1.4 + c:identifier="gst_codec_utils_h265_get_level_idc" + version="1.4"> Transform a level string from the caps into the level_idc - the level_idc or 0 if the level is unknown - -Since 1.4 + the level_idc or 0 if the level is unknown @@ -3105,7 +3102,8 @@ Since 1.4 + c:identifier="gst_codec_utils_h265_get_profile" + version="1.4"> Converts the profile indication (general_profile_idc) in the stream's profile_level_tier structure into a string. The profile_tier_level is expected to have the following format, as defined in the H.265 @@ -3123,9 +3121,7 @@ with bit 0 being the most significant bit of the first byte. * Bit 44:87 - general_reserved_zero_44bits * Bit 88:95 - general_level_idc - The profile as a const string, or %NULL if there is an error. - -Since 1.4 + The profile as a const string, or %NULL if there is an error. @@ -3143,14 +3139,13 @@ Since 1.4 + c:identifier="gst_codec_utils_h265_get_tier" + version="1.4"> Converts the tier indication (general_tier_flag) in the stream's profile_tier_level structure into a string. The profile_tier_level is expected to have the same format as for gst_codec_utils_h264_get_profile(). - The tier as a const string, or %NULL if there is an error. - -Since 1.4 + The tier as a const string, or %NULL if there is an error. diff --git a/gir-files/GstPlayer-1.0.gir b/gir-files/GstPlayer-1.0.gir index c742ab13b..11a17a2ac 100644 --- a/gir-files/GstPlayer-1.0.gir +++ b/gir-files/GstPlayer-1.0.gir @@ -53,11 +53,10 @@ performed. + c:identifier="gst_player_config_get_position_update_interval" + version="1.10"> - current position update interval in milliseconds - -Since 1.10 + current position update interval in milliseconds @@ -68,11 +67,10 @@ Since 1.10 + c:identifier="gst_player_config_get_seek_accurate" + version="1.12"> - %TRUE if accurate seeking is enabled - -Since 1.12 + %TRUE if accurate seeking is enabled @@ -83,12 +81,12 @@ Since 1.12 + c:identifier="gst_player_config_get_user_agent" + version="1.10"> Return the user agent which has been configured using gst_player_config_set_user_agent() if any. - the configured agent, or %NULL -Since 1.10 + the configured agent, or %NULL @@ -99,10 +97,10 @@ Since 1.10 + c:identifier="gst_player_config_set_position_update_interval" + version="1.10"> set interval in milliseconds between two position-updated signals. -pass 0 to stop updating the position. -Since 1.10 +pass 0 to stop updating the position. @@ -144,12 +142,11 @@ Accurate seeking is disabled by default. + c:identifier="gst_player_config_set_user_agent" + version="1.10"> Set the user agent to pass to the server if @player needs to connect to a server during playback. This is typically used when playing HTTP -or RTSP streams. - -Since 1.10 +or RTSP streams. @@ -239,12 +236,11 @@ matching #GstPlayerVideoInfo. + c:identifier="gst_player_get_audio_video_offset" + version="1.10"> Retrieve the current value of audio-video-offset property - The current value of audio-video-offset in nanoseconds - -Since 1.10 + The current value of audio-video-offset in nanoseconds @@ -274,15 +270,15 @@ Since 1.10 - + Get a copy of the current configuration of the player. This configuration can either be modified and used for the gst_player_set_config() call or it must be freed after usage. a copy of the current configuration of @player. Use -gst_structure_free() after usage or gst_player_set_config(). - -Since 1.10 +gst_structure_free() after usage or gst_player_set_config(). @@ -479,6 +475,21 @@ currently-playing stream. + + Retrieve the current value of subtitle-video-offset property + + The current value of subtitle-video-offset in nanoseconds + + + + + #GstPlayer instance + + + + Gets the URI of the currently-playing stream. @@ -494,7 +505,8 @@ currently-playing stream. g_free() after usage. + c:identifier="gst_player_get_video_snapshot" + version="1.12"> Get a snapshot of the currently selected video stream, if any. The format can be selected with @format and optional configuration is possible with @config Currently supported settings are: @@ -502,9 +514,7 @@ Currently supported settings are: - pixel-aspect-ratio of type GST_TYPE_FRACTION Except for GST_PLAYER_THUMBNAIL_RAW_NATIVE format, if no config is set, pixel-aspect-ratio would be 1/1 - Current video snapshot sample or %NULL on failure - -Since 1.12 + Current video snapshot sample or %NULL on failure @@ -631,10 +641,9 @@ Sets the audio track @stream_idex. - Sets audio-video-offset property by value of @offset - -Since 1.10 + c:identifier="gst_player_set_audio_video_offset" + version="1.10"> + Sets audio-video-offset property by value of @offset @@ -672,7 +681,9 @@ value. - + Set the configuration of the player. If the player is already configured, and the configuration haven't change, this function will return %TRUE. If the player is not in the GST_PLAYER_STATE_STOPPED, this method will return %FALSE @@ -683,8 +694,7 @@ the player. This function takes ownership of @config. - %TRUE when the configuration could be set. -Since 1.10 + %TRUE when the configuration could be set. @@ -825,6 +835,24 @@ rendered. + + Sets subtitle-video-offset property by value of @offset + + + + + + #GstPlayer instance + + + + #gint64 in nanoseconds + + + + Sets the next URI to play. @@ -980,6 +1008,11 @@ in the stream. transfer-ownership="none"> + + + @@ -1986,11 +2019,9 @@ of the given @info (ex: "audio", "video", "subtitle") + c:identifier="gst_player_video_overlay_video_renderer_new_with_sink" + version="1.12"> - - -Since 1.12 diff --git a/gir-files/GstRtsp-1.0.gir b/gir-files/GstRtsp-1.0.gir index 30bbf45d8..dda99da82 100644 --- a/gir-files/GstRtsp-1.0.gir +++ b/gir-files/GstRtsp-1.0.gir @@ -8,6 +8,7 @@ and/or use gtk-doc annotations. --> xmlns:glib="http://www.gtk.org/introspection/glib/1.0"> + @@ -21,13 +22,17 @@ and/or use gtk-doc annotations. --> glib:type-name="GstRTSPAuthCredential" glib:get-type="gst_rtsp_auth_credential_get_type" c:symbol-prefix="rtsp_auth_credential"> + RTSP Authentication credentials + a #GstRTSPAuthMethod + A NULL-terminated array of #GstRTSPAuthParam + The authorization for the basic schem @@ -60,10 +65,13 @@ and/or use gtk-doc annotations. --> glib:type-name="GstRTSPAuthParam" glib:get-type="gst_rtsp_auth_param_get_type" c:symbol-prefix="rtsp_auth_param"> + RTSP Authentication parameter + The name of the parameter + The value of the parameter @@ -140,7 +148,8 @@ This function can be cancelled with gst_rtsp_connection_flush(). + c:identifier="gst_rtsp_connection_connect_with_response" + version="1.8"> Attempt to connect to the url of @conn made with gst_rtsp_connection_create(). If @timeout is %NULL this function can block forever. If @timeout contains a valid timeout, this function will return @@ -149,9 +158,7 @@ forever. If @timeout contains a valid timeout, this function will return This function can be cancelled with gst_rtsp_connection_flush(). - #GST_RTSP_OK when a connection could be made. - -Since 1.8 + #GST_RTSP_OK when a connection could be made. @@ -545,6 +552,39 @@ This function can be cancelled with gst_rtsp_connection_flush(). + + Attempt to send @messages to the connected @conn, blocking up to +the specified @timeout. @timeout can be %NULL, in which case this function +might block forever. + +This function can be cancelled with gst_rtsp_connection_flush(). + + #GST_RTSP_OK on success. + + + + + a #GstRTSPConnection + + + + the messages to send + + + + + + the number of messages to send + + + + a timeout value or %NULL + + + + @@ -1290,6 +1330,7 @@ read from @socket which should be used before starting to read new data. + An interface representing RTSP extensions. @@ -1925,8 +1966,18 @@ read from @socket which should be used before starting to read new data. c:identifier="GST_RTSP_HDR_ACCEPT_RANGES" glib:nick="accept-ranges"> - + + + + @@ -2023,8 +2074,11 @@ read from @socket which should be used before starting to read new data. + + + - + @@ -2142,7 +2196,11 @@ for transmission. Get the body of @msg. @data remains valid for as long as @msg is valid and -unchanged. +unchanged. + +If the message body was set as a #GstBuffer before this will cause the data +to be copied and stored in the message. The #GstBuffer will no longer be +kept in the message. #GST_RTSP_OK. @@ -2170,6 +2228,33 @@ unchanged. + + Get the body of @msg. @buffer remains valid for as long as @msg is valid and +unchanged. + +If body data was set from raw memory instead of a #GstBuffer this function +will always return %NULL. The caller can check if there is a body buffer by +calling gst_rtsp_message_has_body_buffer(). + + #GST_RTSP_OK. + + + + + a #GstRTSPMessage + + + + location for the buffer + + + + Get the @indx header value with key @field from @msg. The result in @value stays valid as long as it remains present in @msg. @@ -2245,6 +2330,22 @@ was not found. + + Checks if @msg has a body and the body is stored as #GstBuffer. + + %TRUE if @msg has a body and it's stored as #GstBuffer, %FALSE +otherwise. + + + + + a #GstRTSPMessage + + + + Initialize @msg. This function is mostly used when @msg is allocated on the stack. The reverse operation of this is gst_rtsp_message_unset(). @@ -2515,7 +2616,8 @@ all matching headers will be removed. - Set the body of @msg to a copy of @data. + Set the body of @msg to a copy of @data. Any existing body or body buffer +will be replaced by the new body. #GST_RTSP_OK. @@ -2537,6 +2639,26 @@ all matching headers will be removed. + + Set the body of @msg to @buffer. Any existing body or body buffer +will be replaced by the new body. + + #GST_RTSP_OK. + + + + + a #GstRTSPMessage + + + + a #GstBuffer + + + + Take the body of @msg and store it in @data and @size. After this method, the body and size of @msg will be set to %NULL and 0 respectively. @@ -2567,9 +2689,36 @@ the body and size of @msg will be set to %NULL and 0 respectively. + + Take the body of @msg and store it in @buffer. After this method, +the body and size of @msg will be set to %NULL and 0 respectively. + +If body data was set from raw memory instead of a #GstBuffer this function +will always return %NULL. The caller can check if there is a body buffer by +calling gst_rtsp_message_has_body_buffer(). + + #GST_RTSP_OK. + + + + + a #GstRTSPMessage + + + + location for the buffer + + + + Set the body of @msg to @data and @size. This method takes ownership of -@data. +@data. Any existing body or body buffer will be replaced by the new body. #GST_RTSP_OK. @@ -2591,6 +2740,26 @@ the body and size of @msg will be set to %NULL and 0 respectively. + + Set the body of @msg to @buffer. This method takes ownership of @buffer. +Any existing body or body buffer will be replaced by the new body. + + #GST_RTSP_OK. + + + + + a #GstRTSPMessage + + + + a #GstBuffer + + + + Add a header with key @field and @value to @msg. This function takes ownership of @value. @@ -4011,6 +4180,46 @@ callback. + + Sends @messages using the connection of the @watch. If they cannot be sent +immediately, they will be queued for transmission in @watch. The contents of +@messages will then be serialized and transmitted when the connection of the +@watch becomes writable. In case the @messages are queued, the ID returned in +@id will be non-zero and used as the ID argument in the message_sent +callback once the last message is sent. The callback will only be called +once for the last message. + + #GST_RTSP_OK on success. + + + + + a #GstRTSPWatch + + + + the messages to send + + + + + + the number of messages to send + + + + location for a message ID or %NULL + + + + @@ -4573,6 +4782,46 @@ Currently only supported algorithm "md5". + + Calculates the digest auth response from the values given by the server and +the md5sum. See RFC2069 for details. + +This function is useful when the passwords are not stored in clear text, +but instead in the same format as the .htdigest file. + +Currently only supported algorithm "md5". + + Authentication response or %NULL if unsupported + + + + + Hash algorithm to use, or %NULL for MD5 + + + + Request method, e.g. PLAY + + + + The md5 sum of username:realm:password + + + + Original request URI + + + + Nonce + + + + Check whether @field may appear multiple times in a message. diff --git a/gir-files/GstRtspServer-1.0.gir b/gir-files/GstRtspServer-1.0.gir index 398363ded..28a2c69c6 100644 --- a/gir-files/GstRtspServer-1.0.gir +++ b/gir-files/GstRtspServer-1.0.gir @@ -496,6 +496,19 @@ usage. + + + the @realm of @auth + + + + + + + + @@ -557,6 +570,33 @@ usage. + + Parse the contents of the file at @path and enable the privileges +listed in @token for the users it describes. + +The format of the file is expected to match the format described by +<https://en.wikipedia.org/wiki/Digest_access_authentication#The_.htdigest_file>, +as output by the `htdigest` command. + + %TRUE if the file was successfully parsed, %FALSE otherwise. + + + + + + + + Path to the htdigest file + + + + authorisation token + + + + Removes @basic authentication token. @@ -612,6 +652,22 @@ be used for unauthenticated users. + + Set the @realm of @auth + + + + + + + + + + + + @@ -673,12 +729,11 @@ be accepted when TLS is negotiated. + c:identifier="gst_rtsp_auth_set_tls_database" + version="1.6"> Sets the certificate database that is used to verify peer certificates. If set to %NULL (the default), then peer certificate validation will always -set the %G_TLS_CERTIFICATE_UNKNOWN_CA error. - -Since 1.6 +set the %G_TLS_CERTIFICATE_UNKNOWN_CA error. @@ -1550,7 +1605,10 @@ sent to the client. @user_data is passed to @func and @notify is called when @user_data is no longer in use. By default, the client will send the messages on the #GstRTSPConnection that -was configured with gst_rtsp_client_attach() was called. +was configured with gst_rtsp_client_attach() was called. + +It is only allowed to set either a `send_func` or a `send_messages_func` +but not both at the same time. @@ -1584,6 +1642,52 @@ was configured with gst_rtsp_client_attach() was called. + + Set @func as the callback that will be called when new messages needs to be +sent to the client. @user_data is passed to @func and @notify is called when +@user_data is no longer in use. + +By default, the client will send the messages on the #GstRTSPConnection that +was configured with gst_rtsp_client_attach() was called. + +It is only allowed to set either a `send_func` or a `send_messages_func` +but not both at the same time. + + + + + + a #GstRTSPClient + + + + a #GstRTSPClientSendMessagesFunc + + + + user data passed to @func + + + + called when @user_data is no longer in use + + + + Set @pool as the sessionpool for @client which it will use to find @@ -2511,6 +2615,42 @@ that created the client but can be overridden later. + + This callback is called when @client wants to send @messages. When @close is +%TRUE, the connection should be closed when the message has been sent. + + %TRUE on success. + + + + + a #GstRTSPClient + + + + #GstRTSPMessage + + + + number of messages + + + + close the connection + + + + user data when registering the callback + + + + This function will be called by the gst_rtsp_client_session_filter(). An @@ -2991,7 +3131,8 @@ element of @media, and create #GstRTSPStreams for them. + c:identifier="gst_rtsp_media_complete_pipeline" + version="1.14"> Add a receiver and sender parts to the pipeline based on the transport from SETUP. @@ -3112,6 +3253,19 @@ g_object_unref() after usage. + + + Whether retransmission requests will be sent + + + + + + + + Get the element that was used when constructing @media. @@ -3138,6 +3292,21 @@ g_object_unref() after usage. + + Get the the maximum time-to-live value of outgoing multicast packets. + + the maximum time-to-live value of outgoing multicast packets. + + + + + a #GstRTSPMedia + + + + Get the multicast interface used for @media. @@ -3348,6 +3517,21 @@ will listen on @address and @port for client time requests. + + Check if multicast sockets are configured to be bound to multicast addresses. + + %TRUE if multicast sockets are configured to be bound to multicast addresses. + + + + + a #GstRTSPMedia + + + + Check if the pipeline for @media will send an EOS down the pipeline before @@ -3478,9 +3662,12 @@ gst_rtsp_media_prepare(). - + Seek the pipeline of @media to @range. @media must be prepared with -gst_rtsp_media_prepare(). +gst_rtsp_media_prepare(). In order to perform the seek operation, +the pipeline must contain all needed transport parts (transport sinks). %TRUE on success. @@ -3500,12 +3687,20 @@ gst_rtsp_media_prepare(). - + + Check if the pipeline for @media seek and up to what point in time, +it can seek. + -1 if the stream is not seekable, 0 if seekable only to the beginning +and > 0 to indicate the longest duration between any two random access points. +%G_MAXINT64 means any value is possible. + a #GstRTSPMedia @@ -3530,6 +3725,25 @@ gst_rtsp_media_prepare(). + + Decide whether the multicast socket should be bound to a multicast address or +INADDR_ANY. + + + + + + a #GstRTSPMedia + + + + the new value + + + + Set the kernel UDP buffer size. @@ -3566,6 +3780,22 @@ gst_rtsp_media_prepare(). + + Set whether retransmission requests will be sent + + + + + + + + + + + + Set or unset if an EOS event will be sent to the pipeline for @media before @@ -3600,6 +3830,25 @@ it is unprepared. + + Set the maximum time-to-live value of outgoing multicast packets. + + %TRUE if the requested ttl has been set successfully. + + + + + a #GstRTSPMedia + + + + the new multicast ttl value + + + + configure @multicast_iface to be used for @media. @@ -3943,6 +4192,11 @@ when the media was not in the suspended state. + + + @@ -3961,6 +4215,9 @@ when the media was not in the suspended state. + + + @@ -4607,6 +4864,19 @@ of all medias created from this factory. + + + Whether retransmission requests will be sent for receiving media + + + + + + + + Get the latency that is used for receiving media @@ -4637,6 +4907,21 @@ usage. + + Get the the maximum time-to-live value of outgoing multicast packets. + + the maximum time-to-live value of outgoing multicast packets. + + + + + a #GstRTSPMedia + + + + @@ -4767,6 +5052,21 @@ methods. + + Check if multicast sockets are configured to be bound to multicast addresses. + + %TRUE if multicast sockets are configured to be bound to multicast addresses. + + + + + a #GstRTSPMediaFactory + + + + Get if media created from this factory will have an EOS event sent to the @@ -4826,6 +5126,25 @@ pipeline before shutdown. + + Decide whether the multicast socket should be bound to a multicast address or +INADDR_ANY. + + + + + + a #GstRTSPMediaFactory + + + + the new value + + + + Set the kernel UDP buffer size. @@ -4865,6 +5184,23 @@ of all medias created from this factory. + + Set whether retransmission requests will be sent for +receiving media + + + + + + + + + + + + Configure if media created from this factory will have an EOS sent to the @@ -4925,6 +5261,25 @@ etc.. Each of the payloaders will result in a stream. + + Set the maximum time-to-live value of outgoing multicast packets. + + %TRUE if the requested ttl has been set successfully. + + + + + a #GstRTSPMedia + + + + the new multicast ttl value + + + + @@ -5124,6 +5479,11 @@ when a client disconnects without sending TEARDOWN. + + + @@ -5139,6 +5499,9 @@ when a client disconnects without sending TEARDOWN. + + + @@ -5436,6 +5799,23 @@ when a client disconnects without sending TEARDOWN. media pipeline is in error + + Function registered with gst_rtsp_stream_transport_set_message_sent() +and called when a message has been sent on the transport. + + + + + + user data + + + + + + Function registered with gst_rtsp_stream_transport_set_callbacks() and +called when @buffer_list must be sent on @channel. + + %TRUE on success + + + + + a #GstBufferList + + + + a channel + + + + user data + + + + + c:identifier="gst_rtsp_session_media_get_transports" + version="1.14"> Get a list of all available #GstRTSPStreamTransport in this session. a @@ -7850,6 +8263,39 @@ or a depayloader element @payloader if @pad is a sink pad. + + Add multicast client address to stream. At this point, the sockets that +will stream RTP and RTCP data to @destination are supposed to be +allocated. + + %TRUE if @destination can be addedd and handled by @stream. + + + + + a #GstRTSPStream + + + + a multicast address to add + + + + RTP port + + + + RTCP port + + + + socket family + + + + Add the transport in @trans to @stream. The media of @stream will @@ -7900,7 +8346,8 @@ then also be send to the values configured in @trans. + c:identifier="gst_rtsp_stream_complete_stream" + version="1.14"> Add a receiver and sender part to the pipeline based on the transport from SETUP. @@ -8027,6 +8474,21 @@ use gst_caps_unref() after usage. + + Get the the maximum time-to-live value of outgoing multicast packets. + + the maximum time-to-live value of outgoing multicast packets. + + + + + a #GstRTSPStream + + + + Get the configured MTU in the payloader of @stream. @@ -8062,6 +8524,21 @@ after usage. + + Get all multicast client addresses that RTP data will be sent to + + A comma separated list of host:port pairs with destinations + + + + + a #GstRTSPStream + + + + Get the multicast interface used for @stream. @@ -8161,7 +8638,8 @@ g_free() after usage. + c:identifier="gst_rtsp_stream_get_rtcp_multicast_socket" + version="1.14"> Get the multicast RTCP socket from @stream for a @family. the multicast RTCP socket or %NULL if no @@ -8205,6 +8683,7 @@ socket could be allocated for @family. Unref after usage Get the multicast RTP socket from @stream for a @family. the multicast RTP socket or %NULL if no + socket could be allocated for @family. Unref after usage @@ -8387,6 +8866,62 @@ be called when @stream has been joined. + + + + + + + + + + + + + the amount of redundancy applied when creating ULPFEC +protection packets. + + + + + + + + + + + the payload type used for ULPFEC protection packets + + + + + + + + + + Parse and handle a KeyMgmt header. + + + + + + a #GstRTSPStream + + + + a keymgmt header + + + + Check if @stream has the control string @control. @@ -8407,6 +8942,21 @@ be called when @stream has been joined. + + Check if multicast sockets are configured to be bound to multicast addresses. + + %TRUE if multicast sockets are configured to be bound to multicast addresses. + + + + + a #GstRTSPStream + + + + Check if @stream is blocking on a #GstBuffer. @@ -8434,7 +8984,9 @@ be called when @stream has been joined. - + Checks whether the stream is complete, contains the receiver and the sender parts. As the stream contains sink(s) element(s), it's possible to perform seek operations on it. @@ -8449,7 +9001,9 @@ seek operations on it. - + Checks whether the stream is a receiver. %TRUE if the stream is a receiver and %FALSE otherwise. @@ -8462,7 +9016,9 @@ seek operations on it. - + Checks whether the stream is a sender. %TRUE if the stream is a sender and %FALSE otherwise. @@ -8648,6 +9204,25 @@ not be sent to the values configured in @trans. + + Creating a rtxreceive bin + + a #GstElement. + + + + + a #GstRTSPStream + + + + the session id + + + + @@ -8667,6 +9242,43 @@ not be sent to the values configured in @trans. + + Creating a rtpulpfecdec element + + a #GstElement. + + + + + + + + + + + + + + + + Creating a rtpulpfecenc element + + a #GstElement. + + + + + + + + + + + Reserve @address and @port as the address and port of @stream. The original @@ -8674,7 +9286,8 @@ not be sent to the values configured in @trans. won't release the address from the pool. the #GstRTSPAddress of @stream or %NULL when -the address could be reserved. gst_rtsp_address_free() after usage. +the address could not be reserved. gst_rtsp_address_free() after +usage. @@ -8700,7 +9313,9 @@ the address could be reserved. gst_rtsp_address_free() after usage. - + Checks whether the individual @stream is seekable. %TRUE if @stream is seekable, else %FALSE. @@ -8733,6 +9348,25 @@ the address could be reserved. gst_rtsp_address_free() after usage. + + Decide whether the multicast socket should be bound to a multicast address or +INADDR_ANY. + + + + + + a #GstRTSPStream, + + + + the new value + + + + Blocks or unblocks the dataflow on @stream. @@ -8826,6 +9460,25 @@ an RTSP connection. + + Set the maximum time-to-live value of outgoing multicast packets. + + %TRUE if the requested ttl has been set successfully. + + + + + a #GstRTSPStream + + + + the new multicast ttl value + + + + Configure the mtu in the payloader of @stream to @mtu. @@ -8982,6 +9635,39 @@ an RTSP connection. + + Sets the amount of redundancy to apply when creating ULPFEC +protection packets. + + + + + + + + + + + + + + Set the payload type to be used for ULPFEC protection packets + + + + + + + + + + + + Call @func for each transport managed by @stream. The result value of @func @@ -9069,6 +9755,25 @@ be removed from @stream. + + Check if the requested multicast ttl value is allowed. + + TRUE if the requested ttl value is allowed. + + + + + a #GstRTSPStream + + + + a requested multicast ttl + + + + @@ -9109,6 +9814,16 @@ be removed from @stream. + + + + + + + + + + + + Signal the installed message_sent callback for @trans. + + + + + + a #GstRTSPStreamTransport + + + + Receive @buffer on @channel @trans. @@ -9283,6 +10012,25 @@ It remains valid for as long as @trans is valid. + + Send @buffer_list to the installed RTCP callback for @trans. + + %TRUE on success + + + + + a #GstRTSPStreamTransport + + + + a #GstBuffer + + + + Send @buffer to the installed RTP callback for @trans. @@ -9301,6 +10049,25 @@ It remains valid for as long as @trans is valid. + + Send @buffer_list to the installed RTP callback for @trans. + + %TRUE on success + + + + + a #GstRTSPStreamTransport + + + + a #GstBufferList + + + + Activate or deactivate datatransfer configured in @trans. @@ -9399,6 +10166,86 @@ receiver of @trans. + + Install callbacks that will be called when data for a stream should be sent +to a client. This is usually used when sending RTP/RTCP over TCP. + + + + + + a #GstRTSPStreamTransport + + + + a callback called when RTP should be sent + + + + a callback called when RTCP should be sent + + + + user data passed to callbacks + + + + called with the user_data when no longer needed. + + + + + + Install a callback that will be called when a message has been sent on @trans. + + + + + + a #GstRTSPStreamTransport + + + + a callback called when a message has been sent + + + + user data passed to callback + + + + called with the user_data when no longer needed + + + + Set the timed out state of @trans to @timedout @@ -10251,24 +11098,32 @@ information in the SDP. + c:identifier="gst_rtsp_sdp_make_media" + version="1.14"> + Creates a #GstSDPMedia from the parameters and stores it in @sdp. + %TRUE on success + a #GstRTSPMessage + a #GstSDPInfo + a #GstRTSPStream + a #GstCaps + a #GstRTSPProfile diff --git a/gir-files/GstSdp-1.0.gir b/gir-files/GstSdp-1.0.gir index 2d7f05759..97cd55ce7 100644 --- a/gir-files/GstSdp-1.0.gir +++ b/gir-files/GstSdp-1.0.gir @@ -44,6 +44,11 @@ and/or use gtk-doc annotations. --> c:identifier="GST_MIKEY_ENC_AES_KW_128"> AES Key Wrap using a 128-bit key + + AES-GCM using a 128-bit key (Since: 1.16) + @@ -100,6 +105,7 @@ protocol sessions. + SRTP - the #GstMIKEYCSIDMapType + the #GstMIKEYMapType @@ -1177,6 +1183,7 @@ payload to the KEMAC. + the #GstMIKEYKeyDataType of @key_data @@ -1184,6 +1191,7 @@ payload to the KEMAC. + the key data @@ -1264,7 +1272,7 @@ specific security protocol - array of #GstMIKEYPayloadPSParam + array of #GstMIKEYPayloadSPParam @@ -1353,6 +1361,7 @@ specific security protocol + SRTP @@ -1420,6 +1429,11 @@ specific security protocol c:identifier="GST_MIKEY_SP_SRTP_SRTP_PREFIX_LEN"> SRTP prefix length + + AEAD authentication tag length (Since: 1.16) + Specifies the timestamp type. @@ -3355,11 +3369,11 @@ When -1 is given as @idx, the zone is inserted at the end. - an index -@zone a #GstSDPZone + an index + a #GstSDPZone @@ -3906,6 +3920,28 @@ stack and initialized with gst_sdp_message_init(). + + Parse @text and create a new SDPMessage from these. + + a #GstSDPResult. + + + + + A dynamically allocated string representing the SDP description + + + + pointer to new #GstSDPMessage + + + + Parse the contents of @size bytes pointed to by @data and store the result in @@ -4261,6 +4297,29 @@ a=rtcp-fb:(payload) (param1) [param2]... + + Parse @text and create a new SDPMessage from these. + + a #GstSDPResult. + + + + + A dynamically allocated string representing the SDP description + + + + pointer to new #GstSDPMessage + + + + diff --git a/gir-files/GstVideo-1.0.gir b/gir-files/GstVideo-1.0.gir index 7804149fa..dea5c0caa 100644 --- a/gir-files/GstVideo-1.0.gir +++ b/gir-files/GstVideo-1.0.gir @@ -2,27 +2,16 @@ - + - - + + - + A bufferpool option to enable extra padding. When a bufferpool supports this option, gst_buffer_pool_config_set_video_alignment() can be called. @@ -30,10 +19,7 @@ When this option is enabled on the bufferpool, #GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled. - + An option that can be activated on a bufferpool to request gl texture upload meta on buffers from the pool. @@ -41,39 +27,29 @@ When this option is enabled on the bufferpool, @GST_BUFFER_POOL_OPTION_VIDEO_META should also be enabled. - + An option that can be activated on bufferpool to request video metadata on buffers from the pool. - + + Name of the caps feature indicating that the stream is interlaced. Currently +it is only used for video. - + - + - + - + + + + This interface is implemented by elements which can perform some color balance operation on video frames they process. For example, modifying the brightness, contrast, hue or saturation. @@ -180,8 +156,7 @@ channel object. - + Get the #GstColorBalanceType of this implementation. A the #GstColorBalanceType. @@ -216,8 +191,7 @@ See Also: The #GstColorBalanceChannel.min_value and - + Retrieve a list of the available channels. A @@ -260,8 +234,7 @@ See Also: The #GstColorBalanceChannel.min_value and - + A helper function called by implementations of the GstColorBalance interface. It fires the #GstColorBalance::value-changed signal on the instance, and the #GstColorBalanceChannel::value-changed signal on the @@ -301,13 +274,7 @@ channel object. - + The #GstColorBalanceChannel object represents a parameter for modifying the color balance implemented by an element providing the #GstColorBalance interface. For example, Hue or Saturation. @@ -357,9 +324,7 @@ for modifying the color balance implemented by an element providing the - + Color-balance channel class. the parent class @@ -372,8 +337,7 @@ for modifying the color balance implemented by an element providing the - + @@ -387,9 +351,7 @@ for modifying the color balance implemented by an element providing the - + Color-balance interface. the parent interface @@ -426,8 +388,7 @@ for modifying the color balance implemented by an element providing the A #GstColorBalanceChannel instance - + The new value for the channel. @@ -449,8 +410,7 @@ for modifying the color balance implemented by an element providing the A #GstColorBalanceChannel instance - + @@ -481,8 +441,7 @@ for modifying the color balance implemented by an element providing the A #GstColorBalanceChannel whose value has changed - + The new value of the channel @@ -497,63 +456,37 @@ for modifying the color balance implemented by an element providing the - + An enumeration indicating whether an element implements color balancing operations in software or in dedicated hardware. In general, dedicated hardware implementations (such as those provided by xvimagesink) are preferred. - + Color balance is implemented with dedicated hardware. - + Color balance is implemented via software processing. - + This metadata stays relevant as long as video colorspace is unchanged. - + This metadata stays relevant as long as video orientation is unchanged. - + This metadata stays relevant as long as video size is unchanged. - + This metadata is relevant for video streams. - + The Navigation interface is used for creating and injecting navigation related events such as mouse button presses, cursor motion and key presses. The associated library also provides methods for parsing received events, and for sending and @@ -574,8 +507,7 @@ The main parts of the API are: The GstNavigation message functions provide functions for creating and parsing custom bus messages for signaling GstNavigation changes. - + Inspect a #GstEvent and return the #GstNavigationEventType of the event, or #GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event. @@ -588,8 +520,7 @@ custom bus messages for signaling GstNavigation changes. - + Inspect a #GstNavigation command event and retrieve the enum value of the associated command. @@ -601,20 +532,14 @@ associated command. A #GstEvent to inspect. - + Pointer to GstNavigationCommand to receive the type of the navigation event. - + @@ -623,12 +548,7 @@ associated command. A #GstEvent to inspect. - + A pointer to a location to receive the string identifying the key press. The returned string is owned by the event, and valid only until the event is unreffed. @@ -636,8 +556,7 @@ associated command. - + Retrieve the details of either a #GstNavigation mouse button press event or a mouse button release event. Determine which type the event is using gst_navigation_event_get_type() to retrieve the #GstNavigationEventType. @@ -651,40 +570,24 @@ gst_navigation_event_get_type() to retrieve the #GstNavigationEventType. A #GstEvent to inspect. - + Pointer to a gint that will receive the button number associated with the event. - + Pointer to a gdouble to receive the x coordinate of the mouse button event. - + Pointer to a gdouble to receive the y coordinate of the mouse button event. - + Inspect a #GstNavigation mouse movement event and extract the coordinates of the event. @@ -696,38 +599,26 @@ of the event. A #GstEvent to inspect. - + Pointer to a gdouble to receive the x coordinate of the mouse movement. - + Pointer to a gdouble to receive the y coordinate of the mouse movement. - + Check a bus message to see if it is a #GstNavigation event, and return the #GstNavigationMessageType identifying the type of the message if so. The type of the #GstMessage, or #GST_NAVIGATION_MESSAGE_INVALID if the message is not a #GstNavigation notification. - + @@ -736,8 +627,7 @@ notification. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a @@ -761,8 +651,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED @@ -776,9 +665,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_EVENT. @@ -796,8 +683,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_MOUSE_OVER. @@ -816,8 +702,7 @@ multiangle video has changed. - + Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the @cur_angle and @n_angles parameters. @@ -829,31 +714,19 @@ and extract the @cur_angle and @n_angles parameters. A #GstMessage to inspect. - + A pointer to a #guint to receive the new current angle number, or NULL - + A pointer to a #guint to receive the new angle count, or NULL. - + Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT and extract contained #GstEvent. The caller must unref the @event when done with it. @@ -866,20 +739,14 @@ with it. A #GstMessage to inspect. - + a pointer to a #GstEvent to receive the contained navigation event. - + Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER and extract the active/inactive flag. If the mouse over event is marked active, it indicates that the mouse is over a clickable area. @@ -892,20 +759,14 @@ active, it indicates that the mouse is over a clickable area. A #GstMessage to inspect. - + A pointer to a gboolean to receive the active/inactive state, or NULL. - + Inspect a #GstQuery and return the #GstNavigationQueryType associated with it if it is a #GstNavigation query. @@ -920,8 +781,7 @@ it if it is a #GstNavigation query. - + Create a new #GstNavigation angles query. When executed, it will query the pipeline for the set of currently available angles, which may be greater than one in a multiangle video. @@ -930,8 +790,7 @@ greater than one in a multiangle video. - + Create a new #GstNavigation commands query. When executed, it will query the pipeline for the set of currently available commands. @@ -939,8 +798,7 @@ query the pipeline for the set of currently available commands. - + Parse the current angle number in the #GstNavigation angles @query into the #guint pointed to by the @cur_angle variable, and the number of available angles into the #guint pointed to by the @n_angles variable. @@ -953,30 +811,19 @@ angles into the #guint pointed to by the @n_angles variable. a #GstQuery - + Pointer to a #guint into which to store the currently selected angle value from the query, or NULL - + Pointer to a #guint into which to store the number of angles value from the query, or NULL - + Parse the number of commands in the #GstNavigation commands @query. %TRUE if the query could be successfully parsed. %FALSE if not. @@ -987,19 +834,13 @@ angles into the #guint pointed to by the @n_angles variable. a #GstQuery - + the number of commands in this query. - + Parse the #GstNavigation command query and retrieve the @nth command from it into @cmd. If the list contains less elements than @nth, @cmd will be set to #GST_NAVIGATION_COMMAND_INVALID. @@ -1016,19 +857,13 @@ set to #GST_NAVIGATION_COMMAND_INVALID. the nth command to retrieve. - + a pointer to store the nth command into. - + Set the #GstNavigation angles query result field in @query. @@ -1048,9 +883,7 @@ set to #GST_NAVIGATION_COMMAND_INVALID. - + Set the #GstNavigation command query result fields in @query. The number of commands passed must be equal to @n_commands. @@ -1071,8 +904,7 @@ of commands passed must be equal to @n_commands. - + Set the #GstNavigation command query result fields in @query. The number of commands passed must be equal to @n_commands. @@ -1090,9 +922,7 @@ of commands passed must be equal to @n_commands. An array containing @n_cmds @GstNavigationCommand values. - + @@ -1140,8 +970,7 @@ of commands passed must be equal to @n_commands. - + @@ -1162,8 +991,7 @@ by XKeysymToString. - + Sends a mouse event to the navigation interface. Mouse event coordinates are sent relative to the display space of the related output area. This is usually the size in pixels of the window associated with the element @@ -1197,10 +1025,7 @@ for mouse-move events. - + A set of commands that may be issued to an element providing the #GstNavigation interface. The available commands can be queried via the gst_navigation_query_new_commands() query. @@ -1213,173 +1038,102 @@ For convenience in handling DVD navigation, the MENU commands are aliased as: GST_NAVIGATION_COMMAND_DVD_AUDIO_MENU = @GST_NAVIGATION_COMMAND_MENU5 GST_NAVIGATION_COMMAND_DVD_ANGLE_MENU = @GST_NAVIGATION_COMMAND_MENU6 GST_NAVIGATION_COMMAND_DVD_CHAPTER_MENU = @GST_NAVIGATION_COMMAND_MENU7 - + An invalid command entry - + Execute navigation menu command 1. For DVD, this enters the DVD root menu, or exits back to the title from the menu. - + Execute navigation menu command 2. For DVD, this jumps to the DVD title menu. - + Execute navigation menu command 3. For DVD, this jumps into the DVD root menu. - + Execute navigation menu command 4. For DVD, this jumps to the Subpicture menu. - + Execute navigation menu command 5. For DVD, the jumps to the audio menu. - + Execute navigation menu command 6. For DVD, this jumps to the angles menu. - + Execute navigation menu command 7. For DVD, this jumps to the chapter menu. - + Select the next button to the left in a menu, if such a button exists. - + Select the next button to the right in a menu, if such a button exists. - + Select the button above the current one in a menu, if such a button exists. - + Select the button below the current one in a menu, if such a button exists. - + Activate (click) the currently selected button in a menu, if such a button exists. - + Switch to the previous angle in a multiangle feature. - + Switch to the next angle in a multiangle feature. - + Enum values for the various events that an element implementing the GstNavigation interface might send up the pipeline. - + Returned from gst_navigation_event_get_type() when the passed event is not a navigation event. - + A key press event. Use gst_navigation_event_parse_key_event() to extract the details from the event. - + A key release event. Use gst_navigation_event_parse_key_event() to extract the details from the event. - + A mouse button press event. Use gst_navigation_event_parse_mouse_button_event() to extract the details from the event. - + A mouse button release event. Use gst_navigation_event_parse_mouse_button_event() to extract the details from the event. - + A mouse movement event. Use gst_navigation_event_parse_mouse_move_event() to extract the details from the event. - + A navigation command event. Use gst_navigation_event_parse_command() to extract the details from the event. - + Navigation interface. the parent interface @@ -1401,97 +1155,57 @@ gst_navigation_event_parse_command() to extract the details from the event. - + A set of notifications that may be received on the bus when navigation related status changes. - + Returned from gst_navigation_message_get_type() when the passed message is not a navigation message. - + Sent when the mouse moves over or leaves a clickable region of the output, such as a DVD menu button. - + Sent when the set of available commands changes and should re-queried by interested applications. - + Sent when display angles in a multi-angle feature (such as a multiangle DVD) change - either angles have appeared or disappeared. - + Sent when a navigation event was not handled -by any element in the pipeline (Since 1.6) +by any element in the pipeline (Since: 1.6) - + Tyoes of navigation interface queries. - + invalid query - + command query - + viewing angle query - + - + - + - + - + @@ -1506,9 +1220,7 @@ by any element in the pipeline (Since 1.6) - + @@ -1523,219 +1235,154 @@ by any element in the pipeline (Since 1.6) - + #GST_TYPE_VIDEO_ALPHA_MODE, the alpha mode to use. Default is #GST_VIDEO_ALPHA_MODE_COPY. - + #G_TYPE_DOUBLE, the alpha color value to use. Default to 1.0 - + #G_TYPE_UINT, the border color to use if #GST_VIDEO_CONVERTER_OPT_FILL_BORDER is set to %TRUE. The color is in ARGB format. Default 0xff000000 - + #GST_TYPE_VIDEO_CHROMA_MODE, set the chroma resample mode subsampled formats. Default is #GST_VIDEO_CHROMA_MODE_FULL. - - #GST_TYPE_RESAMPLER_METHOD, The resampler method to use for + + #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for chroma resampling. Other options for the resampler can be used, see -the #GstResampler. Default is #GST_RESAMPLER_METHOD_LINEAR +the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_LINEAR - + #G_TYPE_INT, height in the destination frame, default destination height - + #G_TYPE_INT, width in the destination frame, default destination width - + #G_TYPE_INT, x position in the destination frame, default 0 - + #G_TYPE_INT, y position in the destination frame, default 0 - + #GST_TYPE_VIDEO_DITHER_METHOD, The dither method to use when changing bit depth. Default is #GST_VIDEO_DITHER_BAYER. - + #G_TYPE_UINT, The quantization amount to dither to. Components will be quantized to multiples of this value. Default is 1 - + #G_TYPE_BOOLEAN, if the destination rectangle does not fill the complete destination image, render a border with #GST_VIDEO_CONVERTER_OPT_BORDER_ARGB. Otherwise the unusded pixels in the destination are untouched. Default %TRUE. - + #GST_TYPE_VIDEO_GAMMA_MODE, set the gamma mode. Default is #GST_VIDEO_GAMMA_MODE_NONE. - + #GST_TYPE_VIDEO_MATRIX_MODE, set the color matrix conversion mode for converting between Y'PbPr and non-linear RGB (R'G'B'). Default is #GST_VIDEO_MATRIX_MODE_FULL. - + #GST_TYPE_VIDEO_PRIMARIES_MODE, set the primaries conversion mode. Default is #GST_VIDEO_PRIMARIES_MODE_NONE. - - #GST_TYPE_RESAMPLER_METHOD, The resampler method to use for + + #GST_TYPE_VIDEO_RESAMPLER_METHOD, The resampler method to use for resampling. Other options for the resampler can be used, see -the #GstResampler. Default is #GST_RESAMPLER_METHOD_CUBIC +the #GstVideoResampler. Default is #GST_VIDEO_RESAMPLER_METHOD_CUBIC - + #G_TYPE_UINT, The number of taps for the resampler. Default is 0: let the resampler choose a good value. - + #G_TYPE_INT, source height to convert, default source height - + #G_TYPE_INT, source width to convert, default source width - + #G_TYPE_INT, source x position to start conversion, default 0 - + #G_TYPE_INT, source y position to start conversion, default 0 - + #G_TYPE_UINT, maximum number of threads to use. Default 1, 0 for the number of cores. - + Default maximum number of errors tolerated before signaling error. - + The name of the templates for the sink pad. - + The name of the templates for the source pad. - + The name of the templates for the sink pad. - + The name of the templates for the source pad. - + - + - + - + Video formats supported by gst_video_overlay_composition_blend(), for use in overlay elements' pad template caps. - + G_TYPE_DOUBLE, B parameter of the cubic filter. The B parameter controls the bluriness. Values between 0.0 and 2.0 are accepted. 1/3 is the default. @@ -1753,9 +1400,7 @@ Robidoux Soft 0.6796 0.1602 - + G_TYPE_DOUBLE, C parameter of the cubic filter. The C parameter controls the Keys alpha value. Values between 0.0 and 2.0 are accepted. 1/3 is the default. @@ -1763,87 +1408,63 @@ parameter controls the Keys alpha value. Values between 0.0 and See #GST_VIDEO_RESAMPLER_OPT_CUBIC_B for some more common values - + G_TYPE_DOUBLE, specifies the size of filter envelope for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 1.0 and 5.0. 2.0 is the default. - + G_TYPE_INT, limits the maximum number of taps to use. 16 is the default. - + G_TYPE_DOUBLE, specifies sharpening of the filter for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 0.0 and 1.0. 0.0 is the default. - + G_TYPE_DOUBLE, specifies sharpness of the filter for @GST_VIDEO_RESAMPLER_METHOD_LANCZOS. values are clamped between 0.5 and 1.5. 1.0 is the default. - + #GST_TYPE_VIDEO_DITHER_METHOD, The dither method to use for propagating quatization errors. - + - + - + - + - + - + - + - + Extra buffer metadata for performing an affine transformation using a 4x4 matrix. The transformation matrix can be composed with gst_video_affine_transformation_meta_apply_matrix(). @@ -1864,9 +1485,7 @@ perpendicular to the screen (positive values into the screen). - + Apply a transformation using the given 4x4 transformation matrix. Performs the multiplication, meta->matrix X matrix. @@ -1875,8 +1494,7 @@ Performs the multiplication, meta->matrix X matrix. a #GstVideoAffineTransformationMeta - + a 4x4 transformation matrix to be applied @@ -1884,13 +1502,457 @@ Performs the multiplication, meta->matrix X matrix. - + + + VideoAggregator can accept AYUV, ARGB and BGRA video streams. For each of the requested +sink pads it will compare the incoming geometry and framerate to define the +output parameters. Indeed output video frames will have the geometry of the +biggest incoming video stream and the framerate of the fastest incoming one. + +VideoAggregator will do colorspace conversion. + +Zorder for each input stream can be configured on the +#GstVideoAggregatorPad. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + The #GstVideoInfo representing the currently set +srcpad caps. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + An implementation of GstPad that can be used with #GstVideoAggregator. + +See #GstVideoAggregator for more details. + + + + + + + + + + + + + + + + + + Requests the pad to check and update the converter before the next usage to +update for any changes that have happened. + + + + + + a #GstVideoAggregatorPad + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Returns the currently queued buffer that is going to be used +for the current output frame. + +This must only be called from the aggregate_frames() virtual method, +or from the prepare_frame() virtual method of the aggregator pads. + +The return value is only valid until aggregate_frames() or prepare_frames() +returns. + + The currently queued buffer + + + + + a #GstVideoAggregatorPad + + + + + + Returns the currently prepared video frame that has to be aggregated into +the current output frame. + +This must only be called from the aggregate_frames() virtual method, +or from the prepare_frame() virtual method of the aggregator pads. + +The return value is only valid until aggregate_frames() or prepare_frames() +returns. + + The currently prepared video frame + + + + + a #GstVideoAggregatorPad + + + + + + Checks if the pad currently has a buffer queued that is going to be used +for the current output frame. + +This must only be called from the aggregate_frames() virtual method, +or from the prepare_frame() virtual method of the aggregator pads. + + %TRUE if the pad has currently a buffer queued + + + + + a #GstVideoAggregatorPad + + + + + + Allows selecting that this pad requires an output format with alpha + + + + + + a #GstVideoAggregatorPad + + + + %TRUE if this pad requires alpha output + + + + + + + + + + + + + + + The #GstVideoInfo currently set on the pad + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Extra alignment parameters for the memory of video buffers. This structure is usually used to configure the bufferpool if it supports the @@ -1930,82 +1992,117 @@ structure is usually used to configure the bufferpool if it supports the - + Different alpha modes. - + When input and output have alpha, it will be copied. When the input has no alpha, alpha will be set to #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE - + set all alpha to #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE - + multiply all alpha with #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE. When the input format has no alpha but the output format has, the alpha value will be set to #GST_VIDEO_CONVERTER_OPT_ALPHA_VALUE - + + Video Ancillary data, according to SMPTE-291M specification. + +Note that the contents of the data are always stored as 8bit data (i.e. do not contain +the parity check bits). + + The Data Identifier + + + + The Secondary Data Identifier (if type 2) or the Data + Block Number (if type 1) + + + + The amount of data (in bytes) in @data (max 255 bytes) + + + + The user data content of the Ancillary packet. + Does not contain the ADF, DID, SDID nor CS. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Some know types of Ancillary Data identifiers. + + CEA 708 Ancillary data according to SMPTE 334 + + + CEA 608 Ancillary data according to SMPTE 334 + + + Additional video buffer flags. These flags can potentially be used on any buffers carrying video data - even encoded data. Note that these are only valid for #GstCaps of type: video/... They can conflict with other extended buffer flags. - + If the #GstBuffer is interlaced. In mixed interlace-mode, this flags specifies if the frame is interlaced or progressive. - + If the #GstBuffer is interlaced, then the first field in the video frame is the top field. If unset, the bottom field is first. - + If the #GstBuffer is interlaced, then the first field - (as defined by the %GST_VIDEO_BUFFER_TFF flag setting) + (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF flag setting) is repeated. - + If the #GstBuffer is interlaced, then only the - first field (as defined by the %GST_VIDEO_BUFFER_TFF - flag setting) is to be displayed. + first field (as defined by the %GST_VIDEO_BUFFER_FLAG_TFF + flag setting) is to be displayed (Since: 1.16). - + The #GstBuffer contains one or more specific views, such as left or right eye view. This flags is set on any buffer that contains non-mono content - even for @@ -2013,28 +2110,26 @@ They can conflict with other extended buffer flags. mono / non-mono streams, the absense of the flag marks mono buffers. - + When conveying stereo/multiview content with frame-by-frame methods, this flag marks the first buffer in a bundle of frames that belong together. - + + The video frame has the top field only. This is the + same as GST_VIDEO_BUFFER_FLAG_TFF | + GST_VIDEO_BUFFER_FLAG_ONEFIELD (Since: 1.16). + + + The video frame has the bottom field only. This is + the same as GST_VIDEO_BUFFER_FLAG_ONEFIELD + (GST_VIDEO_BUFFER_FLAG_TFF flag unset) (Since: 1.16). + + Offset to define more flags - + Create a new bufferpool that can allocate video frames. This bufferpool supports all the video bufferpool options. @@ -2047,96 +2142,141 @@ supports all the video bufferpool options. - + - + - + - + + Extra buffer metadata providing Closed Caption. + + parent #GstMeta + + + + The type of Closed Caption contained in the meta. + + + + The Closed Caption data. + + + + + + The size in bytes of @data + + + + + + + + + + The various known types of Closed Caption (CC). + + Unknown type of CC + + + CEA-608 as byte pairs. Note that + this format is not recommended since is does not specify to + which field the caption comes from and therefore assumes + it comes from the first field (and that there is no information + on the second field). Use @GST_VIDEO_CAPTION_TYPE_CEA708_RAW + if you wish to store CEA-608 from two fields and prefix each byte pair + with 0xFC for the first field and 0xFD for the second field. + + + CEA-608 as byte triplets as defined + in SMPTE S334-1 Annex A. The second and third byte of the byte triplet + is the raw CEA608 data, the first byte is a bitfield: The top/7th bit is + 0 for the second field, 1 for the first field, bit 6 and 5 are 0 and + bits 4 to 0 are a 5 bit unsigned integer that represents the line + offset relative to the base-line of the original image format (line 9 + for 525-line field 1, line 272 for 525-line field 2, line 5 for + 625-line field 1 and line 318 for 625-line field 2). + + + CEA-708 as cc_data byte triplets. They + can also contain 608-in-708 and the first byte of each triplet has to + be inspected for detecting the type. + + + CEA-708 (and optionally CEA-608) in + a CDP (Caption Distribution Packet) defined by SMPTE S-334-2. + Contains the whole CDP (starting with 0x9669). + + + Parses fixed Closed Caption #GstCaps and returns the corresponding caption +type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. + + #GstVideoCaptionType. + + + + + Fixed #GstCaps to parse + + + + + + Creates new caps corresponding to @type. + + new #GstCaps + + + + + #GstVideoCaptionType + + + + + + Extra flags that influence the result from gst_video_chroma_resample_new(). - + no flags - + the input is interlaced - + Different subsampling and upsampling methods - + Duplicates the chroma samples when upsampling and drops when subsampling - + Uses linear interpolation to reconstruct missing chroma and averaging to subsample - + Different chroma downsampling and upsampling modes - + do full chroma up and down sampling - + only perform chroma upsampling - + only perform chroma downsampling - + disable chroma resampling - - + + Perform resampling of @width chroma pixels in @lines. @@ -2146,10 +2286,7 @@ supports all the video bufferpool options. a #GstVideoChromaResample - + pixel lines @@ -2171,8 +2308,7 @@ supports all the video bufferpool options. - + The resampler must be fed @n_lines at a time. The first line should be at @offset. @@ -2193,9 +2329,7 @@ at @offset. - + Create a new resampler object for the given parameters. When @h_factor or @v_factor is > 0, upsampling will be used, otherwise subsampling is performed. @@ -2232,71 +2366,37 @@ performed. - + Various Chroma sitings. - + unknown cositing - + no cositing - + chroma is horizontally cosited - + chroma is vertically cosited - + choma samples are sited on alternate lines - + chroma samples cosited with luma samples - + jpeg style cositing, also for mpeg1 and mjpeg - + mpeg2 style cositing - + DV style cositing - + A #GstVideoCodecFrame represents a video frame both in raw and encoded form. @@ -2312,10 +2412,10 @@ encoded form. to the library and get back the frame using gst_video_decoder_get_frame() - + - + @@ -2379,8 +2479,7 @@ encoded form. - + Gets private data set on the frame by the subclass via gst_video_codec_frame_set_user_data() previously. @@ -2407,8 +2506,7 @@ gst_video_codec_frame_set_user_data() previously. - + Sets @user_data on the frame and the #GDestroyNotify that will be called when the frame is freed. Allows to attach private data by the subclass to frames. @@ -2422,17 +2520,11 @@ before the @user_data is replaced. a #GstVideoCodecFrame - + private data - + a #GDestroyNotify @@ -2454,32 +2546,20 @@ will be freed. Flags for #GstVideoCodecFrame - + is the frame only meant to be decoded - + is the frame a synchronization point (keyframe) - + should the output frame be made a keyframe - + should the encoder output stream headers - + Structure representing the state of an incoming or outgoing video stream for encoders and decoders. @@ -2542,57 +2622,31 @@ will be freed. - + The color matrix is used to convert between Y'PbPr and non-linear RGB (R'G'B') - + unknown matrix - + identity matrix - + FCC color matrix - + ITU-R BT.709 color matrix - + ITU-R BT.601 color matrix - + SMPTE 240M color matrix - + ITU-R BT.2020 color matrix. Since: 1.6 - + Get the coefficients used to convert between Y'PbPr and R'G'B' using @matrix. When: @@ -2627,91 +2681,64 @@ and the other way around: a #GstVideoColorMatrix - + result red channel coefficient - + result blue channel coefficient - + The color primaries define the how to transform linear RGB values to and from the CIE XYZ colorspace. - + unknown color primaries - + BT709 primaries - + BT470M primaries - + BT470BG primaries - + SMPTE170M primaries - + SMPTE240M primaries - + Generic film - + BT2020 primaries. Since: 1.6 - + Adobe RGB primaries. Since: 1.8 - + + SMPTE ST 428 primaries. Since: 1.16 + + + SMPTE RP 431 primaries. Since: 1.16 + + + SMPTE EG 432 primaries. Since: 1.16 + + + EBU 3213 primaries. Since: 1.16 + + Get information about the chromaticity coordinates of @primaries. a #GstVideoColorPrimariesInfo for @primaries. - + @@ -2721,9 +2748,7 @@ the CIE XYZ colorspace. - + Structure describing the chromaticity coordinates of an RGB system. These values can be used to construct a matrix to transform RGB to and from the XYZ colorspace. @@ -2764,28 +2789,16 @@ XYZ colorspace. - + Possible color range values. These constants are defined for 8 bit color values and can be scaled for other bit depths. - + unknown range - + [0..255] for 8 bit components - + [16..235] for 8 bit components. Chroma has [16..240] range. @@ -2809,19 +2822,13 @@ the component values in range [0.0 .. 1.0] back to their representation in a #GstVideoFormatInfo - + output offsets - + output scale @@ -2850,8 +2857,7 @@ the component values in range [0.0 .. 1.0] back to their representation in color primaries. used to convert between R'G'B' and CIE XYZ - + Parse the colorimetry string and update @cinfo with the parsed values. @@ -2869,9 +2875,7 @@ values. - + Compare the 2 colorimetry sets for equality %TRUE if @cinfo and @other are equal. @@ -2921,8 +2925,7 @@ information in @info. - + @@ -2933,19 +2936,13 @@ information in @info. - + - + Convert the pixels of @src into @dest using @convert. @@ -2965,9 +2962,7 @@ information in @info. - + Free @convert @@ -2993,9 +2988,7 @@ information in @info. - + Set @config as extra configuraion for @convert. If the parameters in @config can not be set exactly, this function returns @@ -3019,10 +3012,7 @@ option and values. - + Create a new converter object to convert between @in_info and @out_info with @config. @@ -3073,14 +3063,7 @@ with @config. - + This base class is for video decoders turning encoded data into raw video frames. @@ -3434,8 +3417,7 @@ negotiate fails. - + Removes next @n_bytes of input data and adds it to currently parsed frame. @@ -3451,8 +3433,7 @@ negotiate fails. - + Helper function that allocates a buffer to hold a video frame for @decoder's current #GstVideoCodecState. @@ -3470,8 +3451,7 @@ function, if possible at all. - + Helper function that allocates a buffer to hold a video frame for @decoder's current #GstVideoCodecState. Subclass should already have configured video state and set src pad caps. @@ -3493,9 +3473,7 @@ keep references to the frame, not the buffer. - + Same as #gst_video_decoder_allocate_output_frame except it allows passing #GstBufferPoolAcquireParams to the sub call gst_buffer_pool_acquire_buffer. @@ -3513,8 +3491,7 @@ keep references to the frame, not the buffer. a #GstBufferPoolAcquireParams - + @@ -3537,8 +3514,7 @@ In any case, the frame is considered finished and released. - + @frame should have a valid decoded data buffer, whose metadata fields are then appropriately set according to frame data and pushed downstream. If no output data is provided, @frame is considered skipped. @@ -3562,8 +3538,7 @@ of the buffer. - + Lets #GstVideoDecoder sub-classes to know the memory @allocator used by the base class and its @params. @@ -3576,30 +3551,19 @@ Unref the @allocator after use it. a #GstVideoDecoder - + the #GstAllocator used - + the -#GstAllocatorParams of @allocator +#GstAllocationParams of @allocator - + the instance of the #GstBufferPool used by the decoder; free it after use it @@ -3612,8 +3576,7 @@ by the decoder; free it after use it - + currently configured byte to time conversion setting @@ -3668,30 +3631,19 @@ by the decoder; free it after use it a #GstVideoDecoder - + address of variable in which to store the configured minimum latency, or %NULL - + address of variable in which to store the configured mximum latency, or %NULL - + Determines maximum possible decoding time for @frame that will allow it to decode and arrive in time (as determined by QoS events). In particular, a negative result means decoding in time is no longer possible @@ -3711,8 +3663,7 @@ and should therefore occur as soon/skippy as possible. - + currently configured decoder tolerated error count. @@ -3724,9 +3675,7 @@ and should therefore occur as soon/skippy as possible. - + Queries decoder required format handling. %TRUE if required format handling is enabled. @@ -3739,8 +3688,7 @@ and should therefore occur as soon/skippy as possible. - + Get the oldest pending unfinished #GstVideoCodecFrame oldest pending unfinished #GstVideoCodecFrame. @@ -3753,8 +3701,7 @@ and should therefore occur as soon/skippy as possible. - + Get the #GstVideoCodecState currently describing the output stream. #GstVideoCodecState describing format of video data. @@ -3767,8 +3714,7 @@ and should therefore occur as soon/skippy as possible. - + Queries whether input data is considered packetized or not by the base class. @@ -3782,9 +3728,7 @@ base class. - + Returns the number of bytes previously added to the current frame by calling gst_video_decoder_add_to_frame(). @@ -3798,9 +3742,7 @@ by calling gst_video_decoder_add_to_frame(). - + The current QoS proportion. @@ -3844,10 +3786,7 @@ MT safe. a #GstVideoDecoder - + a #GstTagList to merge, or NULL to unset previously-set tags @@ -3873,9 +3812,7 @@ negotiate fails. - + Returns caps that express @caps (or sink template caps if @caps == NULL) restricted to resolution/format/... combinations supported by downstream elements. @@ -3888,25 +3825,17 @@ elements. a #GstVideoDecoder - + initial caps - + filter caps - + Similar to gst_video_decoder_drop_frame(), but simply releases @frame without any processing other than removing it from list of pending frames, after which it is considered finished and released. @@ -3924,8 +3853,7 @@ after which it is considered finished and released. - + Allows baseclass to perform byte to time estimated conversion. @@ -3941,6 +3869,40 @@ after which it is considered finished and released. + + Same as #gst_video_decoder_set_output_state() but also allows you to also set +the interlacing mode. + + the newly configured output state. + + + + + a #GstVideoDecoder + + + + a #GstVideoFormat + + + + A #GstVideoInterlaceMode + + + + The width in pixels + + + + The height in pixels + + + + An optional reference #GstVideoCodecState + + + + Lets #GstVideoDecoder sub-classes tell the baseclass what the decoder latency is. Will also post a LATENCY message on the bus so the pipeline @@ -3963,8 +3925,7 @@ can reconfigure its global latency. - + Sets numbers of tolerated decoder errors, where a tolerated one is then only warned about, but more than tolerated will lead to fatal error. You can set -1 for never returning fatal errors. Default is set to @@ -3985,9 +3946,7 @@ The '-1' option was added in 1.4 - + Configures decoder format needs. If enabled, subclass needs to be negotiated with format caps before it can process any data. It will then never be handed any data before it has been configured. @@ -4008,8 +3967,7 @@ or based on the input data. - + Creates a new #GstVideoCodecState with the specified @fmt, @width and @height as the output state for the decoder. Any previously set output state on @decoder will be replaced by the newly @@ -4045,17 +4003,13 @@ from the next call to #gst_video_decoder_finish_frame(). The height in pixels - + An optional reference #GstVideoCodecState - + Allows baseclass to consider input data as packetized or not. If the input is packetized, then the @parse method will not be called. @@ -4072,9 +4026,7 @@ input is packetized, then the @parse method will not be called. - + Lets #GstVideoDecoder sub-classes decide if they want the sink pad to use the default pad query handler to reply to accept-caps queries. @@ -4122,9 +4074,7 @@ handler with %GST_PAD_SET_ACCEPT_INTERSECT and - + Subclasses can override any of the available virtual methods or not, as needed. At minimum @handle_frame needs to be overridden, and @set_format and likely as well. If non-packetized input is supported or expected, @@ -4425,30 +4375,16 @@ and likely as well. If non-packetized input is supported or expected, - + - + The interface allows unified access to control flipping and rotation operations of video-sources or operators. - + - + #GstVideoDirectionInterface interface. parent interface type. @@ -4482,10 +4418,7 @@ that can be applied to lines of video pixels to quantize and dither them. a #GstVideoDither - + pointer to the pixels of the line @@ -4503,9 +4436,7 @@ that can be applied to lines of video pixels to quantize and dither them. - + Make a new dither object for dithering lines of @format using the algorithm described by @method. @@ -4541,74 +4472,37 @@ performance is achived when @quantizer is a power of 2. - + Extra flags that influence the result from gst_video_chroma_resample_new(). - + no flags - + the input is interlaced - + quantize values in addition to adding dither. - + Different dithering methods to use. - + no dithering - + propagate rounding errors downwards - + Dither with floyd-steinberg error diffusion - + Dither with Sierra Lite error diffusion - + ordered dither using a bayer pattern - + This base class is for video encoders turning raw video into encoded video data. @@ -4902,8 +4796,7 @@ negotiate fails. - + Helper function that allocates a buffer to hold an encoded video frame for @encoder's current #GstVideoCodecState. @@ -4921,8 +4814,7 @@ for @encoder's current #GstVideoCodecState. - + Helper function that allocates a buffer to hold an encoded video frame for @encoder's current #GstVideoCodecState. Subclass should already have configured video state and set src pad caps. @@ -4948,8 +4840,7 @@ keep references to the frame, not the buffer. - + @frame must have a valid encoded data buffer, whose metadata fields are then appropriately set according to frame data or no buffer at all if the frame should be dropped. @@ -4974,8 +4865,7 @@ of the buffer. - + Lets #GstVideoEncoder sub-classes to know the memory @allocator used by the base class and its @params. @@ -4988,24 +4878,14 @@ Unref the @allocator after use it. a #GstVideoEncoder - + the #GstAllocator used - + the -#GstAllocatorParams of @allocator +#GstAllocationParams of @allocator @@ -5018,7 +4898,7 @@ used - a #GstVideoEnccoder + a #GstVideoEncoder @@ -5053,31 +4933,19 @@ used a #GstVideoEncoder - + address of variable in which to store the configured minimum latency, or %NULL - + address of variable in which to store the configured maximum latency, or %NULL - + Determines maximum possible encoding time for @frame that will allow it to encode and arrive in time (as determined by QoS events). In particular, a negative result means encoding in time is no longer possible @@ -5100,8 +4968,7 @@ If no QoS events have been received from downstream, or if - + Get the oldest unfinished pending #GstVideoCodecFrame oldest unfinished pending #GstVideoCodecFrame @@ -5114,8 +4981,7 @@ If no QoS events have been received from downstream, or if - + Get the current #GstVideoCodecState #GstVideoCodecState describing format of video data. @@ -5128,9 +4994,7 @@ If no QoS events have been received from downstream, or if - + Checks if @encoder is currently configured to handle Quality-of-Service events from downstream. @@ -5161,10 +5025,7 @@ MT safe. a #GstVideoEncoder - + a #GstTagList to merge, or NULL to unset previously-set tags @@ -5190,8 +5051,7 @@ negotiate fails. - + Returns caps that express @caps (or sink template caps if @caps == NULL) restricted to resolution/format/... combinations supported by downstream elements (e.g. muxers). @@ -5204,17 +5064,11 @@ elements (e.g. muxers). a #GstVideoEncoder - + initial caps - + filter caps @@ -5258,13 +5112,11 @@ elements (e.g. muxers). - + Request minimal value for PTS passed to handle_frame. For streams with reordered frames this can be used to ensure that there -is enough time to accomodate first DTS, which may be less than first PTS - -Since 1.6 +is enough time to accomodate first DTS, which may be less than first PTS @@ -5279,8 +5131,7 @@ Since 1.6 - + Creates a new #GstVideoCodecState with the specified caps as the output state for the encoder. Any previously set output state on @encoder will be replaced by the newly @@ -5312,18 +5163,13 @@ from the next call to #gst_video_encoder_finish_frame(). the #GstCaps to use for the output - + An optional reference @GstVideoCodecState - + Configures @encoder to handle Quality-of-Service events from downstream. @@ -5369,9 +5215,7 @@ from the next call to #gst_video_encoder_finish_frame(). - + Subclasses can override any of the available virtual methods or not, as needed. At minimum @handle_frame needs to be overridden, and @set_format and @get_caps are likely needed as well. @@ -5653,41 +5497,24 @@ and @get_caps are likely needed as well. - + - + Field order of interlaced content. This is only valid for interlace-mode=interleaved and not interlace-mode=mixed. In the case of mixed or GST_VIDEO_FIELD_ORDER_UNKOWN, the field order is signalled via buffer flags. - + unknown field order for interlaced content. The actual field order is signalled via buffer flags. - + top field is first - + bottom field is first - + Convert @order to a #GstVideoFieldOrder the #GstVideoFieldOrder of @order or @@ -5702,9 +5529,7 @@ buffer flags. - + Convert @order to its string representation. @order as a string or NULL if @order in invalid. @@ -5718,14 +5543,7 @@ buffer flags. - + Provides useful functions and a base class for video filters. The videofilter will by default enable QoS on the parent GstBaseTransform @@ -5799,14 +5617,11 @@ to implement frame dropping. - + The video filter class structure. the parent class structure - + @@ -5871,526 +5686,286 @@ to implement frame dropping. - + Extra video flags - + no flags - + a variable fps is selected, fps_n and fps_d denote the maximum fps of the video - + Each color has been scaled by the alpha value. - - Enum value describing the most common video formats. - + + Enum value describing the most common video formats. + +See the [GStreamer raw video format design document](https://gstreamer.freedesktop.org/documentation/design/mediatype-video-raw.html#formats) +for details about the layout and packing of these formats in memory. + Unknown or unset video format id - + Encoded video format. Only ever use that in caps for special video formats in combination with non-system memory GstCapsFeatures where it does not make sense to specify a real video format. - + planar 4:2:0 YUV - + planar 4:2:0 YVU (like I420 but UV planes swapped) - + packed 4:2:2 YUV (Y0-U0-Y1-V0 Y2-U2-Y3-V2 Y4 ...) - + packed 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) - + packed 4:4:4 YUV with alpha channel (A0-Y0-U0-V0 ...) - + sparse rgb packed into 32 bit, space last - + sparse reverse rgb packed into 32 bit, space last - + sparse rgb packed into 32 bit, space first - + sparse reverse rgb packed into 32 bit, space first - + rgb with alpha channel last - + reverse rgb with alpha channel last - + rgb with alpha channel first - + reverse rgb with alpha channel first - - rgb + + RGB packed into 24 bits without padding (`R-G-B-R-G-B`) - - reverse rgb + + reverse RGB packed into 24 bits without padding (`B-G-R-B-G-R`) - + planar 4:1:1 YUV - + planar 4:2:2 YUV - + packed 4:2:2 YUV (Y0-V0-Y1-U0 Y2-V2-Y3-U2 Y4 ...) - + planar 4:4:4 YUV - + packed 4:2:2 10-bit YUV, complex format - + packed 4:2:2 16-bit YUV, Y0-U0-Y1-V1 order - + planar 4:2:0 YUV with interleaved UV plane - + planar 4:2:0 YUV with interleaved VU plane - + 8-bit grayscale - + 16-bit grayscale, most significant byte first - + 16-bit grayscale, least significant byte first - + packed 4:4:4 YUV (Y-U-V ...) - + rgb 5-6-5 bits per component - + reverse rgb 5-6-5 bits per component - + rgb 5-5-5 bits per component - + reverse rgb 5-5-5 bits per component - + packed 10-bit 4:2:2 YUV (U0-Y0-V0-Y1 U2-Y2-V2-Y3 U4 ...) - + planar 4:4:2:0 AYUV - + 8-bit paletted RGB - + planar 4:1:0 YUV - + planar 4:1:0 YUV (like YUV9 but UV planes swapped) - + packed 4:1:1 YUV (Cb-Y0-Y1-Cr-Y2-Y3 ...) - + rgb with alpha channel first, 16 bits per channel - + packed 4:4:4 YUV with alpha channel, 16 bits per channel (A0-Y0-U0-V0 ...) - + packed 4:4:4 RGB, 10 bits per channel - + planar 4:2:0 YUV, 10 bits per channel - + planar 4:2:0 YUV, 10 bits per channel - + planar 4:2:2 YUV, 10 bits per channel - + planar 4:2:2 YUV, 10 bits per channel - + planar 4:4:4 YUV, 10 bits per channel (Since: 1.2) - + planar 4:4:4 YUV, 10 bits per channel (Since: 1.2) - + planar 4:4:4 RGB, 8 bits per channel (Since: 1.2) - + planar 4:4:4 RGB, 10 bits per channel (Since: 1.2) - + planar 4:4:4 RGB, 10 bits per channel (Since: 1.2) - + planar 4:2:2 YUV with interleaved UV plane (Since: 1.2) - + planar 4:4:4 YUV with interleaved UV plane (Since: 1.2) - + NV12 with 64x32 tiling in zigzag pattern (Since: 1.4) - + planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6) - + planar 4:4:2:0 YUV, 10 bits per channel (Since: 1.6) - + planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6) - + planar 4:4:2:2 YUV, 10 bits per channel (Since: 1.6) - + planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6) - + planar 4:4:4:4 YUV, 10 bits per channel (Since: 1.6) - + planar 4:2:2 YUV with interleaved VU plane (Since: 1.6) - + planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10) - + planar 4:2:0 YUV with interleaved UV plane, 10 bits per channel (Since: 1.10) - - packed 4:4:4 YUV (U-Y-V ...) (Since 1.10) + + packed 4:4:4 YUV (U-Y-V ...) (Since: 1.10) - + packed 4:2:2 YUV (V0-Y0-U0-Y1 V2-Y2-U2-Y3 V4 ...) - + planar 4:4:4:4 ARGB, 8 bits per channel (Since: 1.12) - + planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12) - + planar 4:4:4:4 ARGB, 10 bits per channel (Since: 1.12) - + planar 4:4:4 RGB, 12 bits per channel (Since: 1.12) - + planar 4:4:4 RGB, 12 bits per channel (Since: 1.12) - + planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12) - + planar 4:4:4:4 ARGB, 12 bits per channel (Since: 1.12) - + planar 4:2:0 YUV, 12 bits per channel (Since: 1.12) - + planar 4:2:0 YUV, 12 bits per channel (Since: 1.12) - + planar 4:2:2 YUV, 12 bits per channel (Since: 1.12) - + planar 4:2:2 YUV, 12 bits per channel (Since: 1.12) - + planar 4:4:4 YUV, 12 bits per channel (Since: 1.12) - + planar 4:4:4 YUV, 12 bits per channel (Since: 1.12) - + 10-bit grayscale, packed into 32bit words (2 bits padding) (Since: 1.14) - + 10-bit variant of @GST_VIDEO_FORMAT_NV12, packed into 32bit words (MSB 2 bits padding) (Since: 1.14) - + 10-bit variant of @GST_VIDEO_FORMAT_NV16, packed into 32bit words (MSB 2 bits padding) (Since: 1.14) + + Fully packed variant of NV12_10LE32 (Since: 1.16) + + + packed 4:2:2 YUV, 10 bits per channel (Since: 1.16) + + + packed 4:4:4 YUV, 10 bits per channel(A-V-Y-U...) (Since: 1.16) + + + packed 4:4:4 YUV with alpha channel (V0-U0-Y0-A0...) (Since: 1.16) + + + packed 4:4:4 RGB with alpha channel(B-G-R-A), 10 bits for R/G/B channel and MSB 2 bits for alpha channel (Since: 1.16) + Converts a FOURCC value into the corresponding #GstVideoFormat. If the FOURCC cannot be represented by #GstVideoFormat, @@ -6472,9 +6047,7 @@ string is not a known format. - + Get the default palette of @format. This the palette used in the pack function for paletted formats. @@ -6487,10 +6060,7 @@ function for paletted formats. a #GstVideoFormat - + size of the palette in bytes @@ -6526,71 +6096,41 @@ the #GstVideoFormat if there is one, or NULL otherwise. - + The different video flags that a format info can have. - + The video format is YUV, components are numbered 0=Y, 1=U, 2=V. - + The video format is RGB, components are numbered 0=R, 1=G, 2=B. - + The video is gray, there is one gray component with index 0. - + The video format has an alpha components with the number 3. - + The video format has data stored in little endianness. - + The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane. - + The video format has a complex layout that can't be described with the usual information in the #GstVideoFormatInfo. - + This format can be used in a #GstVideoFormatUnpack and #GstVideoFormatPack function. - + The format is tiled, there is tiling information in the last plane. @@ -6742,10 +6282,7 @@ formats this means that a complete pixel needs to be packed. flags to control the packing - + a source array @@ -6753,10 +6290,7 @@ formats this means that a complete pixel needs to be packed. the source array stride - + pointers to the destination data planes @@ -6804,17 +6338,11 @@ separate step after unpacking. flags to control the unpacking - + a destination array - + pointers to the data planes @@ -7030,129 +6558,86 @@ All video planes of @buffer will be mapped and the pointers will be set in - + Extra video frame flags - + no flags - + The video frame is interlaced. In mixed interlace-mode, this flag specifies if the frame is interlaced or progressive. - + The video frame has the top field first - + The video frame has the repeat flag - + The video frame has one field - + The video contains one or more non-mono views - + The video frame is the first in a set of corresponding views provided as sequential frames. + + The video frame has the top field only. This + is the same as GST_VIDEO_FRAME_FLAG_TFF | GST_VIDEO_FRAME_FLAG_ONEFIELD + (Since: 1.16). + + + The video frame has the bottom field + only. This is the same as GST_VIDEO_FRAME_FLAG_ONEFIELD + (GST_VIDEO_FRAME_FLAG_TFF flag unset) (Since: 1.16). + - + Additional mapping flags for gst_video_frame_map(). - + Don't take another reference of the buffer and store it in the GstVideoFrame. This makes sure that the buffer stays writable while the frame is mapped, but requires that the buffer reference stays valid until the frame is unmapped again. - + Offset to define more flags - + The orientation of the GL texture. - + Top line first in memory, left row first - + Bottom line first in memory, left row first - + Top line first in memory, right row first - + Bottom line first in memory, right row first The GL texture type. - + Luminance texture, GL_LUMINANCE - + Luminance-alpha texture, GL_LUMINANCE_ALPHA - + RGB 565 texture, GL_RGB - + RGB texture, GL_RGB - + RGBA texture, GL_RGBA @@ -7168,16 +6653,14 @@ All video planes of @buffer will be mapped and the pointers will be set in - + - + Extra buffer metadata for uploading a buffer to an OpenGL texture ID. The caller of gst_video_gl_texture_upload_meta_upload() must have OpenGL set up and call this from a thread where it is valid @@ -7188,8 +6671,7 @@ to upload something to an OpenGL texture. Orientation of the textures - + Number of textures that are generated @@ -7197,9 +6679,7 @@ to upload something to an OpenGL texture. Type of each texture - + @@ -7218,8 +6698,7 @@ to upload something to an OpenGL texture. - + Uploads the buffer which owns the meta to a specific texture ID. %TRUE if uploading succeeded, %FALSE otherwise. @@ -7228,8 +6707,7 @@ to upload something to an OpenGL texture. a #GstVideoGLTextureUploadMeta - + the texture IDs to upload to @@ -7237,37 +6715,22 @@ to upload something to an OpenGL texture. - + - - + + disable gamma handling - + convert between input and output gamma Different gamma conversion modes - + Information describing image properties. This information can be filled in from GstCaps with gst_video_info_from_caps(). The information is also used to store the specific video info when mapping a video frame with @@ -7412,10 +6875,7 @@ function can be used to handle pad queries of the type GST_QUERY_CONVERT. #GstFormat of the @dest_value - + pointer to destination value @@ -7523,6 +6983,37 @@ subsampled formats. + + Same as #gst_video_info_set_format but also allowing to set the interlaced +mode. + + %FALSE if the returned video info is invalid, e.g. because the + size of a frame can't be represented as a 32 bit integer. + + + + + a #GstVideoInfo + + + + the format + + + + a #GstVideoInterlaceMode + + + + a width + + + + a height + + + + Convert the values of @info into a #GstCaps. @@ -7537,36 +7028,21 @@ subsampled formats. - + The possible values of the #GstVideoInterlaceMode describing the interlace mode of the stream. - + all frames are progressive - + 2 fields are interleaved in one video frame. Extra buffer flags describe the field order. - + frames contains both interlaced and progressive video, the buffer flags describe the frame and fields. - + 2 fields are stored in one buffer, use the frame ID to get access to the required field. For multiview (the 'views' property > 1) the fields of view N can be found at frame ID @@ -7575,9 +7051,14 @@ mode of the stream. height property. This mode requires multiple GstVideoMeta metadata to describe the fields. - + + 1 field is stored in one buffer, + @GST_VIDEO_BUFFER_FLAG_TF or @GST_VIDEO_BUFFER_FLAG_BF indicates if + the buffer is carrying the top or bottom field, respectively. The top and + bottom buffers are expected to alternate in the pipeline, with this mode + (Since: 1.16). + + Convert @mode to a #GstVideoInterlaceMode the #GstVideoInterlaceMode of @mode or @@ -7592,9 +7073,7 @@ mode of the stream. - + Convert @mode to its string representation. @mode as a string or NULL if @mode in invalid. @@ -7608,36 +7087,20 @@ mode of the stream. - + Different color matrix conversion modes - + do conversion between color matrices - + use the input color matrix to convert to and from R'G'B - + use the output color matrix to convert to and from R'G'B - + disable color matrix conversion. @@ -7754,18 +7217,11 @@ first byte of the plane and the stride of the plane. a #GstMapInfo - + the data of @plane - + the stride of @plane @@ -7813,8 +7269,7 @@ first byte of the plane and the stride of the plane. the output #GstVideoInfo - + Get the #GQuark for the "gst-video-scale" metadata transform operation. a #GQuark @@ -7822,58 +7277,34 @@ first byte of the plane and the stride of the plane. - + GstVideoMultiviewFlags are used to indicate extra properties of a stereo/multiview stream beyond the frame layout and buffer mapping -that is conveyed in the #GstMultiviewMode. - +that is conveyed in the #GstVideoMultiviewMode. + No flags - + For stereo streams, the normal arrangement of left and right views is reversed. - + The left view is vertically mirrored. - + The left view is horizontally mirrored. - + The right view is vertically mirrored. - + The right view is horizontally mirrored. - + For frame-packed multiview modes, indicates that the individual views have been encoded with half the true width or height @@ -7884,27 +7315,16 @@ that is conveyed in the #GstMultiviewMode. pixel width will be doubled. For row interleaved and top-bottom encodings, pixel height will be doubled. - + The video stream contains both mono and multiview portions, signalled on each buffer by the absence or presence of the @GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW buffer flag. - + - + #GstVideoMultiviewFramePacking represents the subset of #GstVideoMultiviewMode values that can be applied to any video frame without needing extra metadata. It can be used by elements that provide a property to override the @@ -7914,185 +7334,111 @@ any markers. This enum is used (for example) on playbin, to re-interpret a played video stream as a stereoscopic video. The individual enum values are equivalent to and have the same value as the matching #GstVideoMultiviewMode. - + A special value indicating no frame packing info. - + All frames are monoscopic. - + All frames represent a left-eye view. - + All frames represent a right-eye view. - + Left and right eye views are provided in the left and right half of the frame respectively. - + Left and right eye views are provided in the left and right half of the frame, but have been sampled using quincunx method, with half-pixel offset between the 2 views. - + Alternating vertical columns of pixels represent the left and right eye view respectively. - + Alternating horizontal rows of pixels represent the left and right eye view respectively. - + The top half of the frame contains the left eye, and the bottom half the right eye. - + Pixels are arranged with alternating pixels representing left and right eye views in a checkerboard fashion. - + All possible stereoscopic 3D and multiview representations. In conjunction with #GstVideoMultiviewFlags, describes how multiview content is being transported in the stream. - + A special value indicating no multiview information. Used in GstVideoInfo and other places to indicate that no specific multiview handling has been requested or provided. This value is never carried on caps. - + All frames are monoscopic. - + All frames represent a left-eye view. - + All frames represent a right-eye view. - + Left and right eye views are provided in the left and right half of the frame respectively. - + Left and right eye views are provided in the left and right half of the frame, but have been sampled using quincunx method, with half-pixel offset between the 2 views. - + Alternating vertical columns of pixels represent the left and right eye view respectively. - + Alternating horizontal rows of pixels represent the left and right eye view respectively. - + The top half of the frame contains the left eye, and the bottom half the right eye. - + Pixels are arranged with alternating pixels representing left and right eye views in a checkerboard fashion. - + Left and right eye views are provided in separate frames alternately. - + Multiple independent views are provided in separate frames in sequence. This method only applies to raw video buffers at the moment. Specific view identification is via the #GstVideoMultiviewMeta and #GstVideoMeta(s) on raw video buffers. - + Multiple views are provided as separate #GstMemory framebuffers attached to each #GstBuffer, described by the #GstVideoMultiviewMeta and #GstVideoMeta(s) - + The #GstVideoMultiviewMode value @@ -8108,9 +7454,7 @@ or #GST_VIDEO_MULTIVIEW_MODE_NONE - + The caps string representation of the mode, or NULL if invalid. @@ -8126,12 +7470,7 @@ for insertion into a caps structure - + The interface allows unified access to control flipping and autocenter operation of video-sources or operators. @@ -8141,15 +7480,11 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8162,15 +7497,11 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8183,15 +7514,11 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8204,15 +7531,11 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8225,8 +7548,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8243,8 +7565,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8261,8 +7582,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8279,8 +7599,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8290,23 +7609,18 @@ operation of video-sources or operators. - + Get the horizontal centering offset from the given object. %TRUE in case the element supports centering - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8319,37 +7633,28 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result - + Get the vertical centering offset from the given object. %TRUE in case the element supports centering - + #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8362,30 +7667,24 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement - + return location for the result - + Set the horizontal centering offset for the given object. %TRUE in case the element supports centering - + #GstVideoOrientation interface of a #GstElement @@ -8402,8 +7701,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8413,16 +7711,14 @@ operation of video-sources or operators. - + Set the vertical centering offset for the given object. %TRUE in case the element supports centering - + #GstVideoOrientation interface of a #GstElement @@ -8439,8 +7735,7 @@ operation of video-sources or operators. - + #GstVideoOrientation interface of a #GstElement @@ -8451,9 +7746,7 @@ operation of video-sources or operators. - + #GstVideoOrientationInterface interface. parent interface type. @@ -8470,10 +7763,7 @@ operation of video-sources or operators. #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8491,10 +7781,7 @@ operation of video-sources or operators. #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8512,10 +7799,7 @@ operation of video-sources or operators. #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8533,10 +7817,7 @@ operation of video-sources or operators. #GstVideoOrientation interface of a #GstElement - + return location for the result @@ -8616,79 +7897,40 @@ operation of video-sources or operators. - + The different video orientation methods. - + Identity (no rotation) - + Rotate clockwise 90 degrees - + Rotate 180 degrees - + Rotate counter-clockwise 90 degrees - + Flip horizontally - + Flip vertically - + Flip across upper left/lower right diagonal - + Flip across upper right/lower left diagonal - + Select flip method based on image-orientation tag - + Current status depends on plugin internal setup - + The #GstVideoOverlay interface is used for 2 main purposes : * To get a grab on the Window where the video sink element is going to render. @@ -8947,14 +8189,11 @@ int main(int argc, char *argv[]) return ret; } ]| - + This helper shall be used by classes implementing the #GstVideoOverlay interface that want the render rectangle to be controllable using properties. This helper will install "render-rectangle" property into the -class. - -Since 1.14 +class. @@ -8969,16 +8208,13 @@ Since 1.14 - + This helper shall be used by classes implementing the #GstVideoOverlay interface that want the render rectangle to be controllable using properties. This helper will parse and set the render rectangle calling gst_video_overlay_set_render_rectangle(). - %TRUE if the @property_id matches the GstVideoOverlay property - -Since 1.14 + %TRUE if the @property_id matches the GstVideoOverlay property @@ -9087,8 +8323,7 @@ in the drawable even if the pipeline is PAUSED. - + This will post a "have-window-handle" element message on the bus. This function should only be used by video overlay plugin developers. @@ -9106,8 +8341,7 @@ This function should only be used by video overlay plugin developers. - + Tell an overlay that it should handle events from the window system. These events are forwarded upstream as navigation events. In some window system, events are not propagated in the window hierarchy if a client is listening @@ -9127,8 +8361,7 @@ from the #GstVideoOverlay. - + This will post a "prepare-window-handle" element message on the bus to give applications an opportunity to call gst_video_overlay_set_window_handle() before a plugin creates its own @@ -9145,8 +8378,7 @@ This function should only be used by video overlay plugin developers. - + Configure a subregion as a video target within the window set by gst_video_overlay_set_window_handle(). If this is not used or not supported the video will fill the area of the window set as the overlay to 100%. @@ -9184,8 +8416,7 @@ do not support subwindows. - + This will call the video overlay's set_window_handle method. You should use this method to tell to an overlay to display video output to a specific window (e.g. an XWindow on X11). Passing 0 as the @handle will @@ -9205,11 +8436,7 @@ tell the overlay to stop using that window and create an internal one. - + Functions to create and handle overlay compositions on video buffers. An overlay composition describes one or more overlay rectangles to be @@ -9228,7 +8455,7 @@ This API serves two main purposes: Together, this allows existing overlay elements to easily handle raw and non-raw video as input in without major changes (once the overlays -have been put into a #GstOverlayComposition object anyway) - for raw +have been put into a #GstVideoOverlayComposition object anyway) - for raw video the overlay can just use the blending function to blend the data on top of the video, and for surface buffers it can just attach them to the buffer and let the sink render the overlays. @@ -9238,20 +8465,17 @@ overlay rectangles. a new #GstVideoOverlayComposition. Unref with gst_video_overlay_composition_unref() when no longer needed. - + a #GstVideoOverlayRectangle to add to the composition - + - + Adds an overlay rectangle to an existing overlay composition object. This must be done right after creating the overlay composition. @@ -9260,14 +8484,12 @@ must be done right after creating the overlay composition. a #GstVideoOverlayComposition - + a #GstVideoOverlayRectangle to add to the composition - + @@ -9284,8 +8506,7 @@ mapped with flag GST_MAP_READWRITE. a #GstVideoOverlayComposition - + a #GstVideoFrame containing raw video data in a @@ -9303,33 +8524,28 @@ copied. a new #GstVideoOverlayComposition equivalent to @comp. - + a #GstVideoOverlayComposition to copy - + - + Returns the @n-th #GstVideoOverlayRectangle contained in @comp. the @n-th rectangle, or NULL if @n is out of bounds. Will not return a new reference, the caller will need to obtain her own reference using gst_video_overlay_rectangle_ref() if needed. - + a #GstVideoOverlayComposition - + number of the rectangle to get @@ -9337,8 +8553,7 @@ copied. - + Returns the sequence number of this composition. Sequence numbers are monotonically increasing and unique for overlay compositions and rectangles (meaning there will never be a rectangle with the same sequence number as @@ -9350,13 +8565,11 @@ a composition). a #GstVideoOverlayComposition - + - + Takes ownership of @comp and returns a version of @comp that is writable (i.e. can be modified). Will either return @comp right away, or create a new writable copy of @comp and unref @comp itself. All the contained @@ -9365,19 +8578,16 @@ contained in the rectangles are not copied. a writable #GstVideoOverlayComposition equivalent to @comp. - + a #GstVideoOverlayComposition to copy - + - + Returns the number of #GstVideoOverlayRectangle<!-- -->s contained in @comp. the number of rectangles @@ -9386,14 +8596,12 @@ contained in the rectangles are not copied. a #GstVideoOverlayComposition - + - + Extra buffer metadata describing image overlay data. parent #GstMeta @@ -9401,38 +8609,27 @@ contained in the rectangles are not copied. the attached #GstVideoOverlayComposition - + - + - + Overlay format flags. - + no flags - + RGB are premultiplied by A/255. - + a global-alpha value != 1 is set. - + #GstVideoOverlay interface parent interface type. @@ -9510,19 +8707,10 @@ contained in the rectangles are not copied. - - - + An opaque video overlay rectangle object. A rectangle contains a single overlay rectangle which can be added to a composition. - + Creates a new video overlay rectangle with ARGB or AYUV pixel data. The layout in case of ARGB of the components in memory is B-G-R-A on little-endian platforms @@ -9537,8 +8725,7 @@ The pixel data buffer must have #GstVideoMeta set. a new #GstVideoOverlayRectangle. Unref with gst_video_overlay_rectangle_unref() when no longer needed. - + @@ -9565,8 +8752,7 @@ The pixel data buffer must have #GstVideoMeta set. flags - + @@ -9578,19 +8764,16 @@ copied. a new #GstVideoOverlayRectangle equivalent to @rectangle. - + a #GstVideoOverlayRectangle to copy - + - + Retrieves the flags associated with a #GstVideoOverlayRectangle. This is useful if the caller can handle both premultiplied alpha and non premultiplied alpha, for example. By knowing whether the rectangle @@ -9598,19 +8781,16 @@ uses premultiplied or not, it can request the pixel data in the format it is stored in, to avoid unnecessary conversion. the #GstVideoOverlayFormatFlags associated with the rectangle. - + a #GstVideoOverlayRectangle - + - + Retrieves the global-alpha value associated with a #GstVideoOverlayRectangle. the global-alpha value associated with the rectangle. @@ -9619,13 +8799,11 @@ it is stored in, to avoid unnecessary conversion. a #GstVideoOverlayRectangle - + - + a #GstBuffer holding the ARGB pixel data with width and height of the render dimensions as per @@ -9637,8 +8815,7 @@ it is stored in, to avoid unnecessary conversion. a #GstVideoOverlayRectangle - + flags @@ -9646,13 +8823,11 @@ it is stored in, to avoid unnecessary conversion. should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + a #GstBuffer holding the AYUV pixel data with width and height of the render dimensions as per @@ -9664,8 +8839,7 @@ it is stored in, to avoid unnecessary conversion. a #GstVideoOverlayRectangle - + flags @@ -9673,13 +8847,11 @@ it is stored in, to avoid unnecessary conversion. should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + a #GstBuffer holding the pixel data with format as originally provided and specified in video meta with @@ -9692,8 +8864,7 @@ it is stored in, to avoid unnecessary conversion. a #GstVideoOverlayRectangle - + flags @@ -9701,13 +8872,11 @@ it is stored in, to avoid unnecessary conversion. should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be retrieved using @@ -9721,8 +8890,7 @@ gst_video_overlay_rectangle_get_render_rectangle(). a #GstVideoOverlayRectangle - + flags. @@ -9730,13 +8898,11 @@ gst_video_overlay_rectangle_get_render_rectangle(). should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be retrieved using @@ -9750,8 +8916,7 @@ gst_video_overlay_rectangle_get_render_rectangle(). a #GstVideoOverlayRectangle - + flags. @@ -9759,13 +8924,11 @@ gst_video_overlay_rectangle_get_render_rectangle(). should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + Retrieves the pixel data as it is. This is useful if the caller can do the scaling itself when handling the overlaying. The rectangle will need to be scaled to the render dimensions, which can be retrieved using @@ -9779,8 +8942,7 @@ gst_video_overlay_rectangle_get_render_rectangle(). a #GstVideoOverlayRectangle - + flags. @@ -9788,13 +8950,11 @@ gst_video_overlay_rectangle_get_render_rectangle(). should set the #GST_VIDEO_OVERLAY_FORMAT_FLAG_GLOBAL_ALPHA flag if he wants to apply global-alpha himself. If the flag is not set global_alpha is applied internally before returning the pixel-data. - + - + Retrieves the render position and render dimension of the overlay rectangle on the video. @@ -9804,49 +8964,27 @@ rectangle on the video. a #GstVideoOverlayRectangle - + - + address where to store the X render offset - + address where to store the Y render offset - + address where to store the render width - + address where to store the render height - + Returns the sequence number of this rectangle. Sequence numbers are monotonically increasing and unique for overlay compositions and rectangles (meaning there will never be a rectangle with the same sequence number as @@ -9868,13 +9006,11 @@ pixel-data. a #GstVideoOverlayRectangle - + - + Sets the global alpha value associated with a #GstVideoOverlayRectangle. Per- pixel alpha values are multiplied with this value. Valid values: 0 <= global_alpha <= 1; 1 to deactivate. @@ -9889,8 +9025,7 @@ gst_video_overlay_composition_copy(). a #GstVideoOverlayRectangle - + Global alpha value (0 to 1.0) @@ -9898,8 +9033,7 @@ gst_video_overlay_composition_copy(). - + Sets the render position and dimensions of the rectangle on the video. This function is mainly for elements that modify the size of the video in some way (e.g. through scaling or cropping) and need to adjust the @@ -9915,8 +9049,7 @@ gst_video_overlay_composition_copy(). a #GstVideoOverlayRectangle - + render X position of rectangle on video @@ -9937,59 +9070,34 @@ gst_video_overlay_composition_copy(). - + The different flags that can be used when packing and unpacking. - + No flag - + When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely sightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated in the least significant bits of the destination. - + The source is interlaced. The unpacked format will be interlaced as well with each line containing - information from alternating fields. (Since 1.2) + information from alternating fields. (Since: 1.2) - + Different primaries conversion modes - + disable conversion between primaries - + do conversion between primaries only when it can be merged with color matrix conversion. - + fast conversion between primaries @@ -10012,8 +9120,7 @@ gst_video_overlay_composition_copy(). - + Extra buffer metadata describing an image region of interest parent #GstMeta @@ -10053,9 +9160,7 @@ gst_video_overlay_composition_copy(). - + Attach element-specific parameters to @meta meant to be used by downstream elements which may handle this ROI. The name of @s is used to identify the element these parameters are meant for. @@ -10071,8 +9176,7 @@ can be supported by cross platform applications). a #GstVideoRegionOfInterestMeta - + a #GstStructure @@ -10080,9 +9184,7 @@ can be supported by cross platform applications). - + Retrieve the parameter for @meta having @name as structure name, or %NULL if there is none. @@ -10094,16 +9196,15 @@ See also: gst_video_region_of_interest_meta_add_param() a #GstVideoRegionOfInterestMeta - + + a name. - + @@ -10149,9 +9250,7 @@ required to perform various kinds of resampling filtering. - + Clear a previously initialized #GstVideoResampler @resampler. @@ -10172,8 +9271,7 @@ required to perform various kinds of resampling filtering. - + @@ -10199,63 +9297,34 @@ required to perform various kinds of resampling filtering. - + Different resampler flags. - + no flags - + when no taps are given, half the number of calculated taps. This can be used when making scalers - for the different fields of an interlaced picture. Since 1.10 + for the different fields of an interlaced picture. Since: 1.10 - + Different subsampling and upsampling methods - + Duplicates the samples when upsampling and drops when downsampling - + Uses linear interpolation to reconstruct missing samples and averaging to downsample - + Uses cubic interpolation - + Uses sinc interpolation - + Uses lanczos interpolation @@ -10287,10 +9356,7 @@ one dimension or do a copy without scaling. a #GstVideoFormat for @srcs and @dest - + source pixels @@ -10298,10 +9364,7 @@ one dimension or do a copy without scaling. source pixels stride - + destination pixels @@ -10327,10 +9390,7 @@ one dimension or do a copy without scaling. - + Combine a scaler for Y and UV into one scaler for the packed @format. a new horizontal videoscaler for @format. @@ -10424,17 +9484,11 @@ for @width samples. a #GstVideoFormat for @src and @dest - + source pixels - + destination pixels @@ -10465,17 +9519,11 @@ gst_video_scaler_get_info(). a #GstVideoFormat for @srcs and @dest - + source pixels lines - + destination pixels @@ -10489,9 +9537,7 @@ gst_video_scaler_get_info(). - + Make a new @method video scaler. @in_size source lines/pixels will be scaled to @out_size destination lines/pixels. @@ -10499,14 +9545,13 @@ be scaled to @out_size destination lines/pixels. pixel. If n_taps is 0, this function chooses a good value automatically based on the @method and @in_size/@out_size. - a #GstVideoResample + a #GstVideoScaler a #GstVideoResamplerMethod - + #GstVideoScalerFlags @@ -10524,41 +9569,23 @@ on the @method and @in_size/@out_size. number of destination elements - + extra options - + Different scale flags. - + no flags - + Set up a scaler for interlaced content - + Provides useful functions and a base class for video sinks. GstVideoSink will configure the default base sink to drop frames that @@ -10603,10 +9630,7 @@ the @dst one and @scaling is set to FALSE. - + Whether to show video frames during preroll. If set to %FALSE, video frames will only be rendered in PLAYING state. @@ -10631,9 +9655,7 @@ frames will only be rendered in PLAYING state. - + The video sink class structure. Derived classes should override the @show_frame virtual function. @@ -10663,47 +9685,27 @@ frames will only be rendered in PLAYING state. - + Enum value describing the available tiling modes. - + Unknown or unset tile mode - + Every four adjacent blocks - two horizontally and two vertically are grouped together and are located in memory in Z or flipped Z order. In case of odd rows, the last row of blocks is arranged in linear order. - + Enum value describing the most common tiling types. - + Tiles are indexed. Use gst_video_tile_get_index () to retrieve the tile at the requested coordinates. - + @field_count must be 0 for progressive video and 1 or 2 for interlaced. A representation of a SMPTE time code. @@ -10736,15 +9738,13 @@ These values are *NOT* automatically normalized. Interlaced video field count - + @field_count is 0 for progressive, 1 or 2 for interlaced. @latest_daiy_jam reference is stolen from caller. a new #GstVideoTimeCode with the given values. The values are not checked for being in a valid range. To see if your -timecode actually has valid content, use #gst_video_time_code_is_valid. +timecode actually has valid content, use gst_video_time_code_is_valid(). @@ -10786,21 +9786,21 @@ timecode actually has valid content, use #gst_video_time_code_is_valid. - + - a new empty #GstVideoTimeCode + a new empty, invalid #GstVideoTimeCode - + The resulting config->latest_daily_jam is set to -midnight, and timecode is set to the given time. +midnight, and timecode is set to the given time. + +This might return a completely invalid timecode, use +gst_video_time_code_new_from_date_time_full() to ensure +that you would get %NULL instead in that case. - the #GVideoTimeCode representation of @dt. + the #GstVideoTimeCode representation of @dt. @@ -10826,11 +9826,41 @@ midnight, and timecode is set to the given time. - + + The resulting config->latest_daily_jam is set to +midnight, and timecode is set to the given time. - a new #GstVideoTimeCode from the given string + the #GstVideoTimeCode representation of @dt, or %NULL if + no valid timecode could be created. + + + + + Numerator of the frame rate + + + + Denominator of the frame rate + + + + #GDateTime to convert + + + + #GstVideoTimeCodeFlags + + + + Interlaced video field count + + + + + + + a new #GstVideoTimeCode from the given string or %NULL + if the string could not be passed. @@ -10840,11 +9870,9 @@ midnight, and timecode is set to the given time. - + Adds or subtracts @frames amount of frames to @tc. tc needs to -contain valid data, as verified by #gst_video_time_code_is_valid. +contain valid data, as verified by gst_video_time_code_is_valid(). @@ -10859,9 +9887,7 @@ contain valid data, as verified by #gst_video_time_code_is_valid. - + This makes a component-wise addition of @tc_inter to @tc. For example, adding ("01:02:03:04", "00:01:00:00") will return "01:03:03:04". When it comes to drop-frame timecodes, @@ -10869,8 +9895,9 @@ adding ("00:00:00;00", "00:01:00:00") will return "00:01:00;02" because of drop-frame oddities. However, adding ("00:09:00;02", "00:01:00:00") will return "00:10:00;00" because this time we can have an exact minute. - - A new #GstVideoTimeCode with @tc_inter added. + + A new #GstVideoTimeCode with @tc_inter added or %NULL + if the interval can't be added. @@ -10884,15 +9911,13 @@ must contain valid timecode values. The interval must contain valid values, except that for drop-frame timecode, it may also contain timecodes which would normally be dropped. These are then corrected to the next reasonable timecode. - + - - Initializes @tc with empty/zero/NULL values. + + Initializes @tc with empty/zero/NULL values and frees any memory +it might currently use. @@ -10903,10 +9928,8 @@ be dropped. These are then corrected to the next reasonable timecode. - - Compares @tc1 and @tc2 . If both have latest daily jam information, it is + + Compares @tc1 and @tc2. If both have latest daily jam information, it is taken into account. Otherwise, it is assumed that the daily jam of both @tc1 and @tc2 was at the same time. Both time codes must be valid. @@ -10915,20 +9938,18 @@ taken into account. Otherwise, it is assumed that the daily jam of both - a #GstVideoTimeCode + a valid #GstVideoTimeCode - another #GstVideoTimeCode + another valid #GstVideoTimeCode - + - a new #GstVideoTimeCode with the same values as @tc . + a new #GstVideoTimeCode with the same values as @tc. @@ -10938,11 +9959,9 @@ taken into account. Otherwise, it is assumed that the daily jam of both - + - how many frames have passed since the daily jam of @tc . + how many frames have passed since the daily jam of @tc. @@ -10952,10 +9971,8 @@ taken into account. Otherwise, it is assumed that the daily jam of both - - Frees @tc . + + Frees @tc. @@ -10966,10 +9983,8 @@ taken into account. Otherwise, it is assumed that the daily jam of both - - Adds one frame to @tc . + + Adds one frame to @tc. @@ -10980,15 +9995,13 @@ taken into account. Otherwise, it is assumed that the daily jam of both - + @field_count is 0 for progressive, 1 or 2 for interlaced. @latest_daiy_jam reference is stolen from caller. Initializes @tc with the given values. The values are not checked for being in a valid range. To see if your -timecode actually has valid content, use #gst_video_time_code_is_valid. +timecode actually has valid content, use gst_video_time_code_is_valid(). @@ -11035,13 +10048,48 @@ timecode actually has valid content, use #gst_video_time_code_is_valid. - + + The resulting config->latest_daily_jam is set to midnight, and timecode is +set to the given time. + +Will assert on invalid parameters, use gst_video_time_code_init_from_date_time_full() +for being able to handle invalid parameters. + + + + + + an uninitialized #GstVideoTimeCode + + + + Numerator of the frame rate + + + + Denominator of the frame rate + + + + #GDateTime to convert + + + + #GstVideoTimeCodeFlags + + + + Interlaced video field count + + + + + The resulting config->latest_daily_jam is set to midnight, and timecode is set to the given time. - + %TRUE if @tc could be correctly initialized to a valid timecode + @@ -11070,9 +10118,7 @@ midnight, and timecode is set to the given time. - + whether @tc is a valid timecode (supported frame rate, hours/minutes/seconds/frames not overflowing) @@ -11085,11 +10131,9 @@ hours/minutes/seconds/frames not overflowing) - + - how many nsec have passed since the daily jam of @tc . + how many nsec have passed since the daily jam of @tc. @@ -11099,12 +10143,11 @@ hours/minutes/seconds/frames not overflowing) - + The @tc.config->latest_daily_jam is required to be non-NULL. - - the #GDateTime representation of @tc. + + the #GDateTime representation of @tc or %NULL if @tc + has no daily jam. @@ -11114,12 +10157,10 @@ hours/minutes/seconds/frames not overflowing) - + the SMPTE ST 2059-1:2015 string representation of @tc. That will -take the form hh:mm:ss:ff . The last separator (between seconds and frames) +take the form hh:mm:ss:ff. The last separator (between seconds and frames) may vary: ';' for drop-frame, non-interlaced content and for drop-frame interlaced @@ -11132,15 +10173,13 @@ interlaced field 2 - #GstVideoTimeCode to convert + A #GstVideoTimeCode to convert - + Supported frame rates: 30000/1001, 60000/1001 (both with and without drop frame), and integer frame rates e.g. 25/1, 30/1, 50/1, 60/1. @@ -11162,33 +10201,20 @@ The configuration of the time code. - + Flags related to the time code information. For drop frame, only 30000/1001 and 60000/1001 frame rates are supported. - + No flags - + Whether we have drop frame rate - + Whether we have interlaced video - + A representation of a difference between two #GstVideoTimeCode instances. Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) @@ -11207,13 +10233,10 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) the frames field of #GstVideoTimeCodeInterval - + a new #GstVideoTimeCodeInterval with the given values. - + @@ -11234,14 +10257,12 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) - + @tc_inter_str must only have ":" as separators. - - a new #GstVideoTimeCodeInterval from the given string - + + a new #GstVideoTimeCodeInterval from the given string + or %NULL if the string could not be passed. + @@ -11250,9 +10271,7 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) - + Initializes @tc with empty/zero/NULL values. @@ -11260,45 +10279,35 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) a #GstVideoTimeCodeInterval - + - + - a new #GstVideoTimeCodeInterval with the same values as @tc . - + a new #GstVideoTimeCodeInterval with the same values as @tc. + a #GstVideoTimeCodeInterval - + - - Frees @tc . + + Frees @tc. a #GstVideoTimeCodeInterval - + - + Initializes @tc with the given values. @@ -11306,8 +10315,7 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) a #GstVideoTimeCodeInterval - + the hours field of #GstVideoTimeCodeInterval @@ -11328,9 +10336,7 @@ Will not necessarily correspond to a real timecode (e.g. 00:00:10;00) - + Extra buffer metadata describing the GstVideoTimeCode of the frame. Each frame is assumed to have its own timecode, i.e. they are not @@ -11343,114 +10349,260 @@ automatically incremented/interpolated. the GstVideoTimeCode to attach - + - + The video transfer function defines the formula for converting between non-linear RGB (R'G'B') and linear RGB - + unknown transfer function - + linear RGB, gamma 1.0 curve - + Gamma 1.8 curve - + Gamma 2.0 curve - + Gamma 2.2 curve - + Gamma 2.2 curve with a linear segment in the lower range - + Gamma 2.2 curve with a linear segment in the lower range - + Gamma 2.4 curve with a linear segment in the lower range - + Gamma 2.8 curve - + Logarithmic transfer characteristic 100:1 range - + Logarithmic transfer characteristic 316.22777:1 range - + Gamma 2.2 curve with a linear segment in the lower range. Used for BT.2020 with 12 bits per component. Since: 1.6 - + Gamma 2.19921875. Since: 1.8 - + + An encoder for writing ancillary data to the +Vertical Blanking Interval lines of component signals. + + Create a new #GstVideoVBIEncoder for the specified @format and @pixel_width. + + The new #GstVideoVBIEncoder or %NULL if the @format and/or @pixel_width +is not supported. + + + + + a #GstVideoFormat + + + + The width in pixel to use + + + + + + Stores Video Ancillary data, according to SMPTE-291M specification. + +Note that the contents of the data are always read as 8bit data (i.e. do not contain +the parity check bits). + + %TRUE if enough space was left in the current line, %FALSE + otherwise. + + + + + a #GstVideoVBIEncoder + + + + %TRUE if composite ADF should be created, component otherwise + + + + The Data Identifier + + + + The Secondary Data Identifier (if type 2) or the Data + Block Number (if type 1) + + + + The user data content of the Ancillary packet. + Does not contain the ADF, DID, SDID nor CS. + + + + + + The amount of data (in bytes) in @data (max 255 bytes) + + + + + + + + + + + + + + + + Frees the @encoder. + + + + + + a #GstVideoVBIEncoder + + + + + + + + + + + + + + + + + + + + A parser for detecting and extracting @GstVideoAncillary data from +Vertical Blanking Interval lines of component signals. + + Create a new #GstVideoVBIParser for the specified @format and @pixel_width. + + The new #GstVideoVBIParser or %NULL if the @format and/or @pixel_width +is not supported. + + + + + a #GstVideoFormat + + + + The width in pixel to use + + + + + + Provide a new line of data to the @parser. Call gst_video_vbi_parser_get_ancillary() +to get the Ancillary data that might be present on that line. + + + + + + a #GstVideoVBIParser + + + + The line of data to parse + + + + + + + + + + + + + + + + + + Frees the @parser. + + + + + + a #GstVideoVBIParser + + + + + + Parse the line provided previously by gst_video_vbi_parser_add_line(). + + %GST_VIDEO_VBI_PARSER_RESULT_OK if ancillary data was found and +@anc was filled. %GST_VIDEO_VBI_PARSER_RESULT_DONE if there wasn't any +data. + + + + + a #GstVideoVBIParser + + + + a #GstVideoAncillary to start the eventual ancillary data + + + + + + + Return values for #GstVideoVBIParser + + No line were provided, or no more Ancillary data was found. + + + A #GstVideoAncillary was found. + + + An error occured + + + Attaches GstVideoAffineTransformationMeta metadata to @buffer with the given parameters. the #GstVideoAffineTransformationMeta on @buffer. - + @@ -11459,14 +10611,40 @@ the given parameters. - + + Attaches #GstVideoCaptionMeta metadata to @buffer with the given +parameters. + + the #GstVideoCaptionMeta on @buffer. + + + + + a #GstBuffer + + + + The type of Closed Caption to add + + + + The Closed Caption data + + + + + + The size of @data in bytes + + + + + Attaches GstVideoGLTextureUploadMeta metadata to @buffer with the given parameters. the #GstVideoGLTextureUploadMeta on @buffer. - + @@ -11475,8 +10653,7 @@ parameters. the #GstVideoGLTextureOrientation - + the number of textures @@ -11486,36 +10663,25 @@ parameters. array of #GstVideoGLTextureType - + the function to upload the buffer to a specific texture ID - + user data for the implementor of @upload - + function to copy @user_data - + function to free @user_data - + Attaches GstVideoMeta metadata to @buffer with the given parameters and the default offsets and strides for @format and @width x @height. @@ -11548,8 +10714,7 @@ gst_buffer_add_video_meta_full() with them. - + Attaches GstVideoMeta metadata to @buffer with the given parameters. the #GstVideoMeta on @buffer. @@ -11594,39 +10759,31 @@ gst_buffer_add_video_meta_full() with them. - + Sets an overlay composition on a buffer. The buffer will obtain its own reference to the composition, meaning this function does not take ownership of @comp. a #GstVideoOverlayCompositionMeta - + a #GstBuffer - + a #GstVideoOverlayComposition - + - + Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given parameters. the #GstVideoRegionOfInterestMeta on @buffer. - + @@ -11655,14 +10812,12 @@ parameters. - + Attaches #GstVideoRegionOfInterestMeta metadata to @buffer with the given parameters. the #GstVideoRegionOfInterestMeta on @buffer. - + @@ -11691,13 +10846,12 @@ parameters. - + Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given parameters. - - the #GstVideoTimeCodeMeta on @buffer. + + the #GstVideoTimeCodeMeta on @buffer, or +(since 1.16) %NULL if the timecode was invalid. @@ -11711,13 +10865,12 @@ parameters. - + Attaches #GstVideoTimeCodeMeta metadata to @buffer with the given parameters. - the #GstVideoTimeCodeMeta on @buffer. + the #GstVideoTimeCodeMeta on @buffer, or +(since 1.16) %NULL if the timecode was invalid. @@ -11763,8 +10916,7 @@ parameters. - + Find the #GstVideoMeta on @buffer with the lowest @id. Buffers can contain multiple #GstVideoMeta metadata items when dealing with @@ -11781,8 +10933,7 @@ is no such metadata on @buffer. - + Find the #GstVideoMeta on @buffer with the given @id. Buffers can contain multiple #GstVideoMeta metadata items when dealing with @@ -11803,8 +10954,7 @@ on @buffer. - + Find the #GstVideoRegionOfInterestMeta on @buffer with the given @id. Buffers can contain multiple #GstVideoRegionOfInterestMeta metadata items if @@ -11812,8 +10962,7 @@ multiple regions of interests are marked on a frame. the #GstVideoRegionOfInterestMeta with @id or %NULL when there is no such metadata on @buffer. - + @@ -11826,8 +10975,7 @@ no such metadata on @buffer. - + Get the video alignment from the bufferpool configuration @config in in @align @@ -11845,8 +10993,7 @@ in @align - + Set the video alignment in @align to the bufferpool configuration @config @@ -11863,8 +11010,7 @@ in @align - + Convenience function to check if the given message is a "prepare-window-handle" message from a #GstVideoOverlay. @@ -11878,9 +11024,7 @@ in @align - + Inspect a #GstEvent and return the #GstNavigationEventType of the event, or #GST_NAVIGATION_EVENT_INVALID if the event is not a #GstNavigation event. @@ -11893,9 +11037,7 @@ in @align - + Inspect a #GstNavigation command event and retrieve the enum value of the associated command. @@ -11907,21 +11049,14 @@ associated command. A #GstEvent to inspect. - + Pointer to GstNavigationCommand to receive the type of the navigation event. - + @@ -11930,12 +11065,7 @@ associated command. A #GstEvent to inspect. - + A pointer to a location to receive the string identifying the key press. The returned string is owned by the event, and valid only until the event is unreffed. @@ -11943,9 +11073,7 @@ associated command. - + Retrieve the details of either a #GstNavigation mouse button press event or a mouse button release event. Determine which type the event is using gst_navigation_event_get_type() to retrieve the #GstNavigationEventType. @@ -11959,41 +11087,24 @@ gst_navigation_event_get_type() to retrieve the #GstNavigationEventType. A #GstEvent to inspect. - + Pointer to a gint that will receive the button number associated with the event. - + Pointer to a gdouble to receive the x coordinate of the mouse button event. - + Pointer to a gdouble to receive the y coordinate of the mouse button event. - + Inspect a #GstNavigation mouse movement event and extract the coordinates of the event. @@ -12005,31 +11116,19 @@ of the event. A #GstEvent to inspect. - + Pointer to a gdouble to receive the x coordinate of the mouse movement. - + Pointer to a gdouble to receive the y coordinate of the mouse movement. - + Check a bus message to see if it is a #GstNavigation event, and return the #GstNavigationMessageType identifying the type of the message if so. @@ -12045,9 +11144,7 @@ notification. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_ANGLES_CHANGED for notifying an application that the current angle, or current number of angles available in a @@ -12071,9 +11168,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_COMMANDS_CHANGED @@ -12087,10 +11182,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_EVENT. @@ -12108,9 +11200,7 @@ multiangle video has changed. - + Creates a new #GstNavigation message with type #GST_NAVIGATION_MESSAGE_MOUSE_OVER. @@ -12129,9 +11219,7 @@ multiangle video has changed. - + Parse a #GstNavigation message of type GST_NAVIGATION_MESSAGE_ANGLES_CHANGED and extract the @cur_angle and @n_angles parameters. @@ -12143,32 +11231,19 @@ and extract the @cur_angle and @n_angles parameters. A #GstMessage to inspect. - + A pointer to a #guint to receive the new current angle number, or NULL - + A pointer to a #guint to receive the new angle count, or NULL. - + Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_EVENT and extract contained #GstEvent. The caller must unref the @event when done with it. @@ -12181,21 +11256,14 @@ with it. A #GstMessage to inspect. - + a pointer to a #GstEvent to receive the contained navigation event. - + Parse a #GstNavigation message of type #GST_NAVIGATION_MESSAGE_MOUSE_OVER and extract the active/inactive flag. If the mouse over event is marked active, it indicates that the mouse is over a clickable area. @@ -12208,21 +11276,14 @@ active, it indicates that the mouse is over a clickable area. A #GstMessage to inspect. - + A pointer to a gboolean to receive the active/inactive state, or NULL. - + Inspect a #GstQuery and return the #GstNavigationQueryType associated with it if it is a #GstNavigation query. @@ -12237,9 +11298,7 @@ it if it is a #GstNavigation query. - + Create a new #GstNavigation angles query. When executed, it will query the pipeline for the set of currently available angles, which may be greater than one in a multiangle video. @@ -12248,9 +11307,7 @@ greater than one in a multiangle video. - + Create a new #GstNavigation commands query. When executed, it will query the pipeline for the set of currently available commands. @@ -12258,9 +11315,7 @@ query the pipeline for the set of currently available commands. - + Parse the current angle number in the #GstNavigation angles @query into the #guint pointed to by the @cur_angle variable, and the number of available angles into the #guint pointed to by the @n_angles variable. @@ -12273,31 +11328,19 @@ angles into the #guint pointed to by the @n_angles variable. a #GstQuery - + Pointer to a #guint into which to store the currently selected angle value from the query, or NULL - + Pointer to a #guint into which to store the number of angles value from the query, or NULL - + Parse the number of commands in the #GstNavigation commands @query. %TRUE if the query could be successfully parsed. %FALSE if not. @@ -12308,20 +11351,13 @@ angles into the #guint pointed to by the @n_angles variable. a #GstQuery - + the number of commands in this query. - + Parse the #GstNavigation command query and retrieve the @nth command from it into @cmd. If the list contains less elements than @nth, @cmd will be set to #GST_NAVIGATION_COMMAND_INVALID. @@ -12338,20 +11374,13 @@ set to #GST_NAVIGATION_COMMAND_INVALID. the nth command to retrieve. - + a pointer to store the nth command into. - + Set the #GstNavigation angles query result field in @query. @@ -12371,9 +11400,7 @@ set to #GST_NAVIGATION_COMMAND_INVALID. - + Set the #GstNavigation command query result fields in @query. The number of commands passed must be equal to @n_commands. @@ -12397,15 +11424,12 @@ of commands passed must be equal to @n_commands. - + - + @@ -12439,8 +11463,7 @@ of commands passed must be equal to @n_commands. - + Scales a buffer containing RGBA (or AYUV) video. This is an internal helper function which is used to scale subtitle overlays, and may be deprecated in the near future. Use #GstVideoScaler to scale video buffers @@ -12465,26 +11488,19 @@ instead. the width in pixels to scale the video data in @src_buffer to - + pointer to a #GstVideoInfo structure that will be filled in with the details for @dest_buffer - + a pointer to a #GstBuffer variable, which will be set to a newly-allocated buffer containing the scaled pixels. - + Given the Pixel Aspect Ratio and size of an input video frame, and the pixel aspect ratio of the intended display device, calculates the actual display ratio the video will be rendered with. @@ -12495,17 +11511,11 @@ The return value is FALSE in the case of integer overflow or other error. - + Numerator of the calculated display_ratio - + Denominator of the calculated display_ratio @@ -12535,8 +11545,44 @@ The return value is FALSE in the case of integer overflow or other error. - + + + + + + + + + + + + Parses fixed Closed Caption #GstCaps and returns the corresponding caption +type, or %GST_VIDEO_CAPTION_TYPE_UNKNOWN. + + #GstVideoCaptionType. + + + + + Fixed #GstCaps to parse + + + + + + Creates new caps corresponding to @type. + + new #GstCaps + + + + + #GstVideoCaptionType + + + + + Convert @s to a #GstVideoChromaSite a #GstVideoChromaSite or %GST_VIDEO_CHROMA_SITE_UNKNOWN when @s does @@ -12550,8 +11596,7 @@ not contain a valid chroma description. - + Perform resampling of @width chroma pixels in @lines. @@ -12561,10 +11606,7 @@ not contain a valid chroma description. a #GstVideoChromaResample - + pixel lines @@ -12574,10 +11616,7 @@ not contain a valid chroma description. - + Create a new resampler object for the given parameters. When @h_factor or @v_factor is > 0, upsampling will be used, otherwise subsampling is performed. @@ -12613,8 +11652,7 @@ performed. - + Converts @site to its string representation. a string describing @site. @@ -12627,10 +11665,7 @@ performed. - + Get the coefficients used to convert between Y'PbPr and R'G'B' using @matrix. When: @@ -12665,31 +11700,21 @@ and the other way around: a #GstVideoColorMatrix - + result red channel coefficient - + result blue channel coefficient - + Get information about the chromaticity coordinates of @primaries. a #GstVideoColorPrimariesInfo for @primaries. - + @@ -12698,9 +11723,7 @@ and the other way around: - + Compute the offset and scale values for each component of @info. For each component, (c[i] - offset[i]) / scale[i] will scale the component c[i] to the range [0.0 .. 1.0]. @@ -12720,19 +11743,13 @@ the component values in range [0.0 .. 1.0] back to their representation in a #GstVideoFormatInfo - + output offsets - + output scale @@ -12740,9 +11757,7 @@ the component values in range [0.0 .. 1.0] back to their representation in - + Convert @val to its gamma decoded value. This is the inverse operation of @gst_video_color_transfer_encode(). @@ -12762,8 +11777,7 @@ encode a linear segment in the lower range. a #GstVideoTransferFunction - + a value @@ -12771,9 +11785,7 @@ encode a linear segment in the lower range. - + Convert @val to its gamma encoded value. For a linear value L in the range [0..1], conversion to the non-linear @@ -12792,8 +11804,7 @@ encode a linear segment in the lower range. a #GstVideoTransferFunction - + a value @@ -12801,9 +11812,7 @@ encode a linear segment in the lower range. - + Converts a raw video buffer into the specified output caps. The output caps can be any raw video formats or any image formats (jpeg, png, ...). @@ -12829,8 +11838,7 @@ will point to the #GError). - + Converts a raw video buffer into the specified output caps. The output caps can be any raw video formats or any image formats (jpeg, png, ...). @@ -12860,35 +11868,21 @@ anymore. the maximum amount of time allowed for the processing. - + %GstVideoConvertSampleCallback that will be called after conversion. - + - + extra data that will be passed to the @callback - + %GDestroyNotify to be called after @user_data is not needed anymore - + Create a new converter object to convert between @in_info and @out_info with @config. @@ -12910,23 +11904,17 @@ with @config. - + - + - + Make a new dither object for dithering lines of @format using the algorithm described by @method. @@ -12961,8 +11949,7 @@ performance is achived when @quantizer is a power of 2. - + Checks if an event is a force key unit event. Returns true for both upstream and downstream force key unit events. @@ -12976,8 +11963,7 @@ and downstream force key unit events. - + Creates a new downstream force key unit event. A downstream force key unit event can be sent down the pipeline to request downstream elements to produce a key unit. A downstream force key unit event must also be sent when handling @@ -13013,8 +11999,7 @@ gst_video_event_parse_downstream_force_key_unit(). - + Creates a new Still Frame event. If @in_still is %TRUE, then the event represents the start of a still frame sequence. If it is %FALSE, then the event ends a still frame sequence. @@ -13032,8 +12017,7 @@ gst_video_event_parse_still_frame(). - + Creates a new upstream force key unit event. An upstream force key unit event can be sent to request upstream elements to produce a key unit. @@ -13062,8 +12046,7 @@ gst_video_event_parse_downstream_force_key_unit(). - + Get timestamp, stream-time, running-time, all-headers and count in the force key unit event. See gst_video_event_new_downstream_force_key_unit() for a full description of the downstream force key unit event. @@ -13078,45 +12061,29 @@ full description of the downstream force key unit event. A #GstEvent to parse - + A pointer to the timestamp in the event - + A pointer to the stream-time in the event - + A pointer to the running-time in the event - + A pointer to the all_headers flag in the event - + A pointer to the count field of the event - + Parse a #GstEvent, identify if it is a Still Frame event, and return the still-frame state from the event if it is. If the event represents the start of a still frame, the in_still @@ -13134,18 +12101,14 @@ Create a still frame event using gst_video_event_new_still_frame() A #GstEvent to parse - + A boolean to receive the still-frame status from the event, or NULL - + Get running-time, all-headers and count in the force key unit event. See gst_video_event_new_upstream_force_key_unit() for a full description of the upstream force key unit event. @@ -13162,33 +12125,21 @@ Create an upstream force key unit event using gst_video_event_new_upstream_forc A #GstEvent to parse - + A pointer to the running_time in the event - + A pointer to the all_headers flag in the event - + A pointer to the count field in the event - + Convert @order to a #GstVideoFieldOrder the #GstVideoFieldOrder of @order or @@ -13203,10 +12154,7 @@ Create an upstream force key unit event using gst_video_event_new_upstream_forc - + Convert @order to its string representation. @order as a string or NULL if @order in invalid. @@ -13219,9 +12167,7 @@ Create an upstream force key unit event using gst_video_event_new_upstream_forc - + Converts a FOURCC value into the corresponding #GstVideoFormat. If the FOURCC cannot be represented by #GstVideoFormat, #GST_VIDEO_FORMAT_UNKNOWN is returned. @@ -13236,9 +12182,7 @@ If the FOURCC cannot be represented by #GstVideoFormat, - + Find the #GstVideoFormat for the given parameters. a #GstVideoFormat or GST_VIDEO_FORMAT_UNKNOWN when the parameters to @@ -13277,9 +12221,7 @@ not specify a known format. - + Convert the @format string to its #GstVideoFormat. the #GstVideoFormat for @format or GST_VIDEO_FORMAT_UNKNOWN when the @@ -13293,9 +12235,7 @@ string is not a known format. - + Get the #GstVideoFormatInfo for @format The #GstVideoFormatInfo for @format. @@ -13308,10 +12248,7 @@ string is not a known format. - + Get the default palette of @format. This the palette used in the pack function for paletted formats. @@ -13324,18 +12261,13 @@ function for paletted formats. a #GstVideoFormat - + size of the palette in bytes - + Converts a #GstVideoFormat value into the corresponding FOURCC. Only a few YUV formats have corresponding FOURCC values. If @format has no corresponding FOURCC value, 0 is returned. @@ -13350,9 +12282,7 @@ no corresponding FOURCC value, 0 is returned. - + Returns a string containing a descriptive name for the #GstVideoFormat if there is one, or NULL otherwise. @@ -13366,22 +12296,17 @@ the #GstVideoFormat if there is one, or NULL otherwise. - + - + - + Given the nominal duration of one video frame, this function will check some standard framerates for a close match (within 0.1%) and return one if possible, @@ -13400,30 +12325,17 @@ recognised, and %FALSE otherwise. Nominal duration of one frame - + Numerator of the calculated framerate - + Denominator of the calculated framerate - + Convert @mode to a #GstVideoInterlaceMode the #GstVideoInterlaceMode of @mode or @@ -13438,10 +12350,7 @@ recognised, and %FALSE otherwise. - + Convert @mode to its string representation. @mode as a string or NULL if @mode in invalid. @@ -13454,31 +12363,24 @@ recognised, and %FALSE otherwise. - + - + - + Get the #GQuark for the "gst-video-scale" metadata transform operation. a #GQuark - + A const #GValue containing a list of stereo video modes @@ -13488,9 +12390,7 @@ caps negotiations. Currently this is top-bottom and row-interleaved. - + A const #GValue containing a list of stereo video modes @@ -13501,9 +12401,7 @@ view for use in caps negotiation. Currently this is just - + A const #GValue containing a list of stereo video modes @@ -13514,9 +12412,7 @@ and column-interleaved. - + A const #GValue containing a list of mono video modes @@ -13525,9 +12421,7 @@ modes (mono/left/right) for use in caps negotiations. - + A const #GValue containing a list of 'unpacked' stereo video modes @@ -13537,12 +12431,10 @@ for use in caps negotiations. - + A boolean indicating whether the - #GST_VIDEO_MULTIVIEW_FLAG_HALF_ASPECT flag should be set. + #GST_VIDEO_MULTIVIEW_FLAGS_HALF_ASPECT flag should be set. Utility function that heuristically guess whether a frame-packed stereoscopic video contains half width/height @@ -13573,10 +12465,7 @@ overall display aspect ratio. - + The #GstVideoMultiviewMode value @@ -13592,10 +12481,7 @@ or #GST_VIDEO_MULTIVIEW_MODE_NONE - + The caps string representation of the mode, or NULL if invalid. @@ -13610,9 +12496,7 @@ for insertion into a caps structure - + Utility function that transforms the width/height/PAR and multiview mode and flags of a #GstVideoInfo into the requested mode. @@ -13634,28 +12518,21 @@ the requested mode. - + - + - + This helper shall be used by classes implementing the #GstVideoOverlay interface that want the render rectangle to be controllable using properties. This helper will install "render-rectangle" property into the -class. - -Since 1.14 +class. @@ -13670,17 +12547,13 @@ Since 1.14 - + This helper shall be used by classes implementing the #GstVideoOverlay interface that want the render rectangle to be controllable using properties. This helper will parse and set the render rectangle calling gst_video_overlay_set_render_rectangle(). - %TRUE if the @property_id matches the GstVideoOverlay property - -Since 1.14 + %TRUE if the @property_id matches the GstVideoOverlay property @@ -13702,23 +12575,17 @@ Since 1.14 - + - + - + Make a new @method video scaler. @in_size source lines/pixels will be scaled to @out_size destination lines/pixels. @@ -13726,7 +12593,7 @@ be scaled to @out_size destination lines/pixels. pixel. If n_taps is 0, this function chooses a good value automatically based on the @method and @in_size/@out_size. - a #GstVideoResample + a #GstVideoScaler @@ -13750,22 +12617,17 @@ on the @method and @in_size/@out_size. number of destination elements - + extra options - + Get the tile index of the tile at coordinates @x and @y in the tiled image of @x_tiles by @y_tiles. -Use this method when @mode is of type %GST_VIDEO_TILE_MODE_INDEXED. +Use this method when @mode is of type %GST_VIDEO_TILE_TYPE_INDEXED. the index of the tile at @x and @y in the tiled image of @x_tiles by @y_tiles. @@ -13794,15 +12656,12 @@ Use this method when @mode is of type %GST_VIDEO_TILE_MODE_INDEXED. - + - + diff --git a/gir-files/GstWebRTC-1.0.gir b/gir-files/GstWebRTC-1.0.gir index 3bf96a9aa..fae95eb28 100644 --- a/gir-files/GstWebRTC-1.0.gir +++ b/gir-files/GstWebRTC-1.0.gir @@ -15,6 +15,37 @@ and/or use gtk-doc annotations. --> shared-library="libgstwebrtc-1.0.so.0" c:identifier-prefixes="Gst" c:symbol-prefixes="gst"> + + GST_WEBRTC_BUNDLE_POLICY_NONE: none +GST_WEBRTC_BUNDLE_POLICY_BALANCED: balanced +GST_WEBRTC_BUNDLE_POLICY_MAX_COMPAT: max-compat +GST_WEBRTC_BUNDLE_POLICY_MAX_BUNDLE: max-bundle +See https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-24#section-4.1.1 +for more information. + + + + + + + + + glib:nick="connected"> + + GST_WEBRTC_DATA_CHANNEL_STATE_NEW: new +GST_WEBRTC_DATA_CHANNEL_STATE_CONNECTING: connection +GST_WEBRTC_DATA_CHANNEL_STATE_OPEN: open +GST_WEBRTC_DATA_CHANNEL_STATE_CLOSING: closing +GST_WEBRTC_DATA_CHANNEL_STATE_CLOSED: closed +See <ulink url="http://w3c.github.io/webrtc-pc/#dom-rtcdatachannelstate">http://w3c.github.io/webrtc-pc/#dom-rtcdatachannelstate</ulink> + + + + + + + + + + + + + GST_WEBRTC_ICE_TRANSPORT_POLICY_ALL: all +GST_WEBRTC_ICE_TRANSPORT_POLICY_RELAY: relay +See https://tools.ietf.org/html/draft-ietf-rtcweb-jsep-24#section-4.1.1 +for more information. + + + + + + + GST_WEBRTC_PRIORITY_TYPE_VERY_LOW: very-low +GST_WEBRTC_PRIORITY_TYPE_LOW: low +GST_WEBRTC_PRIORITY_TYPE_MEDIUM: medium +GST_WEBRTC_PRIORITY_TYPE_HIGH: high +See <ulink url="http://w3c.github.io/webrtc-pc/#dom-rtcprioritytype">http://w3c.github.io/webrtc-pc/#dom-rtcprioritytype</ulink> + + + + + + + + + + + GST_WEBRTC_SCTP_TRANSPORT_STATE_NEW: new +GST_WEBRTC_SCTP_TRANSPORT_STATE_CONNECTING: connecting +GST_WEBRTC_SCTP_TRANSPORT_STATE_CONNECTED: connected +GST_WEBRTC_SCTP_TRANSPORT_STATE_CLOSED: closed +See <ulink url="http://w3c.github.io/webrtc-pc/#dom-rtcsctptransportstate">http://w3c.github.io/webrtc-pc/#dom-rtcsctptransportstate</ulink> + + + + + + + + +