package/go-gst
1
0
Fork 0
mirror of https://github.com/go-gst/go-gst.git synced 2025-10-05 16:06:55 +08:00
Code Issues Packages Projects Releases Wiki Activity

fix misspellings across codebase

Browse Source
This commit is contained in:
RSWilli
2023-09-01 15:58:38 +02:00
parent fd3d949686
commit ca405841c8
12 changed files with 29 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
gst/base/gst_base_sink.go
View File

@@ -244,7 +244,7 @@ func (g *GstBaseSink) SetQoSEnabled(enabled bool) {
}
// SetRenderDelay sets the render delay in sink to delay. The render delay is the time between actual
// rendering of a buffer and its synchronisation time. Some devices might delay media rendering which
// rendering of a buffer and its synchronization time. Some devices might delay media rendering which
// can be compensated for with this function.
//
// After calling this function, this sink will report additional latency and other sinks will adjust
@@ -291,7 +291,7 @@ func (g *GstBaseSink) Wait(timeout gst.ClockTime) (ret gst.FlowReturn, jitter gs
// WaitClock will block until timeout is reached. It is usually called by subclasses that use their own
// internal synchronization.
//
// If time is not valid, no synchronisation is done and GST_CLOCK_BADTIME is returned. Likewise, if synchronization
// If time is not valid, no synchronization is done and GST_CLOCK_BADTIME is returned. Likewise, if synchronization
// is disabled in the element or there is no clock, no synchronization is done and GST_CLOCK_BADTIME is returned.
//
// This function should only be called with the PREROLL_LOCK held, like when receiving an EOS event in the event()
@@ -307,7 +307,7 @@ func (g *GstBaseSink) WaitClock(timeout gst.ClockTime) (ret gst.ClockReturn, jit
// WaitPreroll will block until the preroll is complete.
//
// If the render() method performs its own synchronisation against the clock it must unblock when going from
// If the render() method performs its own synchronization against the clock it must unblock when going from
// PLAYING to the PAUSED state and call this method before continuing to render the remaining data.
//
// If the render() method can block on something else than the clock, it must also be ready to unblock immediately

2
gst/base/gst_base_sink_impl.go
View File

@@ -84,7 +84,7 @@ type GstBaseSinkImpl interface {
Fixate(self *GstBaseSink, caps *gst.Caps) *gst.Caps
// Called to get sink pad caps from the subclass
GetCaps(self *GstBaseSink, filter *gst.Caps) *gst.Caps
// Called to get the start and end times for synchronising the passed buffer to the clock
// Called to get the start and end times for synchronizing the passed buffer to the clock
GetTimes(self *GstBaseSink, buffer *gst.Buffer) (start, end time.Duration) // should this be a ClockTime?
// Called to prepare the buffer for render and preroll. This function is called before synchronization
// is performed.

6
gst/base/gst_base_src.go
View File

@@ -97,7 +97,7 @@ func (g *GstBaseSrc) QueryLatency() (ok, live bool, minLatency, maxLatency gst.C
return gobool(gok), gobool(glive), gst.ClockTime(gmin), gst.ClockTime(gmax)
}
// SetAsync configures async behaviour in src, no state change will block. The open, close, start, stop, play and
// SetAsync configures async behavior in src, no state change will block. The open, close, start, stop, play and
// pause virtual methods will be executed in a different thread and are thus allowed to perform blocking operations.
// Any blocking operation should be unblocked with the unlock vmethod.
func (g *GstBaseSrc) SetAsync(async bool) { C.gst_base_src_set_async(g.Instance(), gboolean(async)) }
@@ -179,7 +179,7 @@ func (g *GstBaseSrc) StartWait() gst.FlowReturn {
//
// Subclasses that use this function from their create function must return GST_FLOW_OK and no buffer from their create
// virtual method implementation. If a buffer is returned after a buffer list has also been submitted via this function the
// behaviour is undefined.
// behavior is undefined.
//
// Subclasses must only call this function once per create function call and subclasses must only call this function when
// the source operates in push mode.
@@ -190,7 +190,7 @@ func (g *GstBaseSrc) SubmitBufferList(bufferList *gst.BufferList) {
// WaitPlaying will block until a state change to PLAYING happens (in which case this function returns gst.FlowOK) or the
// processing must be stopped due to a state change to READY or a FLUSH event (in which case this function returns GST_FLOW_FLUSHING).
//
// If the Create() method performs its own synchronisation against the clock it must unblock when going from PLAYING to the PAUSED
// If the Create() method performs its own synchronization against the clock it must unblock when going from PLAYING to the PAUSED
// state and call this method before continuing to produce the remaining data.
//
// gst.FlowOK will be returned if the source is PLAYING and processing can continue. Any other return value should be

22
gst/constants.go
View File

@@ -207,7 +207,7 @@ const (
EventTypeQOS EventType = C.GST_EVENT_QOS // (48641) – A quality message. Used to indicate to upstream elements that the downstream elements should adjust their processing rate.
EventTypeSeek EventType = C.GST_EVENT_SEEK // (51201) – A request for a new playback position and rate.
EventTypeNavigation EventType = C.GST_EVENT_NAVIGATION // (53761) – Navigation events are usually used for communicating user requests, such as mouse or keyboard movements, to upstream elements.
EventTypeLatency EventType = C.GST_EVENT_LATENCY // (56321) – Notification of new latency adjustment. Sinks will use the latency information to adjust their synchronisation.
EventTypeLatency EventType = C.GST_EVENT_LATENCY // (56321) – Notification of new latency adjustment. Sinks will use the latency information to adjust their synchronization.
EventTypeStep EventType = C.GST_EVENT_STEP // (58881) – A request for stepping through the media. Sinks will usually execute the step operation.
EventTypeReconfigure EventType = C.GST_EVENT_RECONFIGURE // (61441) – A request for upstream renegotiating caps and reconfiguring.
EventTypeTOCSelect EventType = C.GST_EVENT_TOC_SELECT // (64001) – A request for a new playback position based on TOC entry's UID.
@@ -217,7 +217,7 @@ const (
EventTypeCustomDownstream EventType = C.GST_EVENT_CUSTOM_DOWNSTREAM // (71686) – Downstream custom event that travels in the data flow.
EventTypeCustomOOB EventType = C.GST_EVENT_CUSTOM_DOWNSTREAM_OOB // (74242) – Custom out-of-band downstream event.
EventTypeCustomDownstreamSticky EventType = C.GST_EVENT_CUSTOM_DOWNSTREAM_STICKY // (76830) – Custom sticky downstream event.
EventTypeCustomBoth EventType = C.GST_EVENT_CUSTOM_BOTH // (79367) – Custom upstream or downstream event. In-band when travelling downstream.
EventTypeCustomBoth EventType = C.GST_EVENT_CUSTOM_BOTH // (79367) – Custom upstream or downstream event. In-band when traveling downstream.
EventTypeCustomBothOOB EventType = C.GST_EVENT_CUSTOM_BOTH_OOB // (81923) – Custom upstream or downstream out-of-band event.
)
@@ -457,10 +457,10 @@ type PadProbeReturn int
// Type castings of ProbeReturns
const (
PadProbeDrop PadProbeReturn = C.GST_PAD_PROBE_DROP // (0) – drop data in data probes. For push mode this means that the data item is not sent downstream. For pull mode, it means that the data item is not passed upstream. In both cases, no other probes are called for this item and GST_FLOW_OK or TRUE is returned to the caller.
PadProbeOK PadProbeReturn = C.GST_PAD_PROBE_OK // (1) – normal probe return value. This leaves the probe in place, and defers decisions about dropping or passing data to other probes, if any. If there are no other probes, the default behaviour for the probe type applies ('block' for blocking probes, and 'pass' for non-blocking probes).
PadProbeOK PadProbeReturn = C.GST_PAD_PROBE_OK // (1) – normal probe return value. This leaves the probe in place, and defers decisions about dropping or passing data to other probes, if any. If there are no other probes, the default behavior for the probe type applies ('block' for blocking probes, and 'pass' for non-blocking probes).
PadProbeRemove PadProbeReturn = C.GST_PAD_PROBE_REMOVE // (2) – remove this probe.
PadProbePass PadProbeReturn = C.GST_PAD_PROBE_PASS // (3) – pass the data item in the block probe and block on the next item.
PadProbeUnhandled PadProbeReturn = C.GST_PAD_PROBE_HANDLED // (4) – Data has been handled in the probe and will not be forwarded further. For events and buffers this is the same behaviour as GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer or event yourself). For queries it will also return TRUE to the caller. The probe can also modify the GstFlowReturn value by using the GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. Note that the resulting query must contain valid entries. Since: 1.6
PadProbeUnhandled PadProbeReturn = C.GST_PAD_PROBE_HANDLED // (4) – Data has been handled in the probe and will not be forwarded further. For events and buffers this is the same behavior as GST_PAD_PROBE_DROP (except that in this case you need to unref the buffer or event yourself). For queries it will also return TRUE to the caller. The probe can also modify the GstFlowReturn value by using the GST_PAD_PROBE_INFO_FLOW_RETURN() accessor. Note that the resulting query must contain valid entries. Since: 1.6
)
// PadProbeType casts GstPadProbeType
@@ -709,11 +709,11 @@ type ProgressType int
// Type castings of ProgressTypes
const (
ProgressTypeStart ProgressType = C.GST_PROGRESS_TYPE_START // (0) – A new task started.
ProgressTypeContinue ProgressType = C.GST_PROGRESS_TYPE_CONTINUE // (1) – A task completed and a new one continues.
ProgressTypeComplete ProgressType = C.GST_PROGRESS_TYPE_COMPLETE // (2) – A task completed.
ProgressTypeCancelled ProgressType = C.GST_PROGRESS_TYPE_CANCELED // (3) – A task was canceled.
ProgressTypeError ProgressType = C.GST_PROGRESS_TYPE_ERROR // (4) – A task caused an error. An error message is also posted on the bus.
ProgressTypeStart ProgressType = C.GST_PROGRESS_TYPE_START // (0) – A new task started.
ProgressTypeContinue ProgressType = C.GST_PROGRESS_TYPE_CONTINUE // (1) – A task completed and a new one continues.
ProgressTypeComplete ProgressType = C.GST_PROGRESS_TYPE_COMPLETE // (2) – A task completed.
ProgressTypeCanceled ProgressType = C.GST_PROGRESS_TYPE_CANCELED // (3) – A task was canceled.
ProgressTypeError ProgressType = C.GST_PROGRESS_TYPE_ERROR // (4) – A task caused an error. An error message is also posted on the bus.
)
// String implements a stringer on ProgressTypes
@@ -725,8 +725,8 @@ func (p ProgressType) String() string {
return "continuing"
case ProgressTypeComplete:
return "completed"
case ProgressTypeCancelled:
return "cancelled"
case ProgressTypeCanceled:
return "canceled"
case ProgressTypeError:
return "error"
}

4
gst/gst_bus.go
View File

@@ -168,7 +168,7 @@ func (b *Bus) RemoveSignalWatch() { C.gst_bus_remove_signal_watch(b.Instance())
// See EnableSyncMessageEmission for more information.
//
// In the event that multiple pieces of code have called EnableSyncMessageEmission, the sync-message emissions
// will only be stopped after all calls to EnableSyncMessageEmission were "cancelled" by calling this function.
// will only be stopped after all calls to EnableSyncMessageEmission were "canceled" by calling this function.
// In this way the semantics are exactly the same as Ref that which calls enable should also call disable.
func (b *Bus) DisableSyncMessageEmission() { C.gst_bus_disable_sync_message_emission(b.Instance()) }
@@ -181,7 +181,7 @@ func (b *Bus) DisableSyncMessageEmission() { C.gst_bus_disable_sync_message_emis
//
// While this function looks similar to AddSignalWatch, it is not exactly the same -- this function enables *synchronous*
// emission of signals when messages arrive; AddSignalWatch adds an idle callback to pop messages off the bus asynchronously.
// The sync-message signal comes from the thread of whatever object posted the message; the "message" signal is marshalled
// The sync-message signal comes from the thread of whatever object posted the message; the "message" signal is marshaled
// to the main thread via the main loop.
func (b *Bus) EnableSyncMessageEmission() { C.gst_bus_enable_sync_message_emission(b.Instance()) }

2
gst/gst_debug.go
View File

@@ -94,7 +94,7 @@ type DebugLevel int
const (
LevelNone DebugLevel = C.GST_LEVEL_NONE // (0) – No debugging level specified or desired. Used to deactivate debugging output.
LevelError DebugLevel = C.GST_LEVEL_ERROR // (1) – Error messages are to be used only when an error occurred that stops the application from keeping working correctly. An examples is gst_element_error, which outputs a message with this priority. It does not mean that the application is terminating as with g_error.
LevelWarning DebugLevel = C.GST_LEVEL_WARNING // (2) – Warning messages are to inform about abnormal behaviour that could lead to problems or weird behaviour later on. An example of this would be clocking issues ("your computer is pretty slow") or broken input data ("Can't synchronize to stream.")
LevelWarning DebugLevel = C.GST_LEVEL_WARNING // (2) – Warning messages are to inform about abnormal behavior that could lead to problems or weird behavior later on. An example of this would be clocking issues ("your computer is pretty slow") or broken input data ("Can't synchronize to stream.")
LevelFixMe DebugLevel = C.GST_LEVEL_FIXME // (3) – Fixme messages are messages that indicate that something in the executed code path is not fully implemented or handled yet. Note that this does not replace proper error handling in any way, the purpose of this message is to make it easier to spot incomplete/unfinished pieces of code when reading the debug log.
LevelInfo DebugLevel = C.GST_LEVEL_INFO // (4) – Informational messages should be used to keep the developer updated about what is happening. Examples where this should be used are when a typefind function has successfully determined the type of the stream or when an mp3 plugin detects the format to be used. ("This file has mono sound.")
LevelDebug DebugLevel = C.GST_LEVEL_DEBUG // (5) – Debugging messages should be used when something common happens that is not the expected default behavior, or something that's useful to know but doesn't happen all the time (ie. per loop iteration or buffer processed or event handled). An example would be notifications about state changes or receiving/sending of events.

2
gst/gst_event_constructors.go
View File

@@ -101,7 +101,7 @@ func NewGapEvent(timestamp, duration ClockTime) *Event {
// }
// NewLatencyEvent creates a new latency event. The event is sent upstream from the sinks and notifies elements that they should add an additional latency to the
// running time before synchronising against the clock.
// running time before synchronizing against the clock.
//
// The latency is mostly used in live sinks and is always expressed in the time format.
func NewLatencyEvent(latency ClockTime) *Event {

2
gst/gst_message_constructors.go
View File

@@ -309,7 +309,7 @@ func NewPropertyNotifyMessage(src interface{}, propName string, val interface{})
// NewQoSMessage creates a message that is posted on the bus whenever an element decides to drop a buffer because of
// QoS reasons or whenever it changes its processing strategy because of QoS reasons (quality adjustments such as processing at lower accuracy).
//
// This message can be posted by an element that performs synchronisation against the clock (live) or it could be dropped by an element that performs
// This message can be posted by an element that performs synchronization against the clock (live) or it could be dropped by an element that performs
// QoS because of QOS events received from a downstream element (!live).
//
// running_time, stream_time, timestamp, duration should be set to the respective running-time, stream-time, timestamp and duration of the (dropped) buffer

2
gst/gst_pipeline.go
View File

@@ -98,7 +98,7 @@ circular references.
This means that applications that update state using (async) bus messages (e.g. do
certain things when a pipeline goes from PAUSED to READY) might not get to see
messages when the pipeline is shut down, because they might be flushed before they
can be dispatched in the main thread. This behaviour can be disabled using this function.
can be dispatched in the main thread. This behavior can be disabled using this function.
It is important that all messages on the bus are handled when the automatic flushing
is disabled else memory leaks will be introduced.

2
gst/gstnet/gst_ntp_clock.go
View File

@@ -11,7 +11,7 @@ import (
"github.com/go-gst/go-gst/gst"
)
// NTP timestamps are realtive to 1. Jan 1900, so we need an offset for 70 Years to be Unix TS compatible
// NTP timestamps are relative to 1. Jan 1900, so we need an offset for 70 Years to be Unix TS compatible
const NTPTimeToUnixEpoch = gst.ClockTime(2208988800 * time.Second)
// NTPClock wraps GstClock

2
gst/video/gst_video_color.go
View File

@@ -29,7 +29,7 @@ const (
ColorPrimariesBT470BG ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_BT470BG // (3) – BT470BG primaries, also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
ColorPrimariesSMPTE170M ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_SMPTE170M // (4) – SMPTE170M primaries, also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
ColorPrimariesSMPTE240M ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_SMPTE240M // (5) – SMPTE240M primaries
ColorPrimariesFilm ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_FILM // (6) – Generic film (colour filters using Illuminant C)
ColorPrimariesFilm ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_FILM // (6) – Generic film (color filters using Illuminant C)
ColorPrimariesBT2020 ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_BT2020 // (7) – ITU-R BT2020 primaries. Since: 1.6
ColorPrimariesAdobeRGB ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_ADOBERGB // (8) – Adobe RGB primaries. Since: 1.8
ColorPrimariesSMPTEST428 ColorPrimaries = C.GST_VIDEO_COLOR_PRIMARIES_SMPTEST428 // (9) – SMPTE ST 428 primaries (CIE 1931 XYZ). Since: 1.16

6
gst/video/gst_video_info.go
View File

@@ -52,13 +52,13 @@ import (
const CapsFeatureFormatInterlaced string = C.GST_CAPS_FEATURE_FORMAT_INTERLACED
// FieldOrder is the field order of interlaced content. This is only valid for interlace-mode=interleaved
// and not interlace-mode=mixed. In the case of mixed or FieldOrderrUnknown, the field order is signalled
// and not interlace-mode=mixed. In the case of mixed or FieldOrderrUnknown, the field order is signaled
// via buffer flags.
type FieldOrder int
// Type castings
const (
FieldOrderUnknown FieldOrder = C.GST_VIDEO_FIELD_ORDER_UNKNOWN // (0) – unknown field order for interlaced content. The actual field order is signalled via buffer flags.
FieldOrderUnknown FieldOrder = C.GST_VIDEO_FIELD_ORDER_UNKNOWN // (0) – unknown field order for interlaced content. The actual field order is signaled via buffer flags.
FieldOrderTopFieldFirst FieldOrder = C.GST_VIDEO_FIELD_ORDER_TOP_FIELD_FIRST // (1) – top field is first
FieldOrderBottomFieldFirst FieldOrder = C.GST_VIDEO_FIELD_ORDER_BOTTOM_FIELD_FIRST // (2) – bottom field is first
)
@@ -109,7 +109,7 @@ const (
MultiviewFlagsRightFlipped MultiviewFlags = C.GST_VIDEO_MULTIVIEW_FLAGS_RIGHT_FLIPPED // (8) – The right view is vertically mirrored.
MultiviewFlagsRightFlopped MultiviewFlags = C.GST_VIDEO_MULTIVIEW_FLAGS_RIGHT_FLOPPED // (16) – The right view is horizontally mirrored.
MultiviewFlagsHalfAspect MultiviewFlags = C.GST_VIDEO_MULTIVIEW_FLAGS_HALF_ASPECT // (16384) – For frame-packed multiview modes, indicates that the individual views have been encoded with half the true width or height and should be scaled back up for display. This flag is used for overriding input layout interpretation by adjusting pixel-aspect-ratio. For side-by-side, column interleaved or checkerboard packings, the pixel width will be doubled. For row interleaved and top-bottom encodings, pixel height will be doubled.
MultiviewFlagsMixedMono MultiviewFlags = C.GST_VIDEO_MULTIVIEW_FLAGS_MIXED_MONO // (32768) – 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.
MultiviewFlagsMixedMono MultiviewFlags = C.GST_VIDEO_MULTIVIEW_FLAGS_MIXED_MONO // (32768) – The video stream contains both mono and multiview portions, signaled on each buffer by the absence or presence of the GST_VIDEO_BUFFER_FLAG_MULTIPLE_VIEW buffer flag.
)
// MultiviewFramePacking represents the subset of MultiviewMode values that can be applied to any video frame