fix grammar error with possessive its and update sample for audio parameter

Chris Kirmse · Chris Kirmse · commit 650d3ec820b3 · 2019-03-14T09:26:56.000-07:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -6,8 +6,8 @@
 #
 # Copyright (c) 2008-2014 OpenShot Studios, LLC
 # <http://www.openshotstudios.com/>. This file is part of
-# OpenShot Library (libopenshot), an open-source project dedicated to 
-# delivering high quality video editing and animation solutions to the 
+# OpenShot Library (libopenshot), an open-source project dedicated to
+# delivering high quality video editing and animation solutions to the
 # world. For more information visit <http://www.openshot.org/>.
 #
 # OpenShot Library (libopenshot) is free software: you can redistribute it
@@ -41,8 +41,8 @@ MESSAGE("Determining Version Number (from Version.h file)")
 #### Get the lines related to libopenshot version from the Version.h header
 file(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/include/Version.h OPENSHOT_VERSION_LINES
   REGEX "#define[ ]+OPENSHOT_VERSION_.*[0-9]+;.*")
-  
-#### Set each line into it's own variable
+
+#### Set each line into its own variable
 list (GET OPENSHOT_VERSION_LINES 0 LINE_MAJOR)
 list (GET OPENSHOT_VERSION_LINES 1 LINE_MINOR)
 list (GET OPENSHOT_VERSION_LINES 2 LINE_BUILD)
diff --git a/include/Clip.h b/include/Clip.h
@@ -142,8 +142,8 @@ namespace openshot {
 		void reverse_buffer(juce::AudioSampleBuffer* buffer);
 
 	public:
-		GravityType gravity; ///< The gravity of a clip determines where it snaps to it's parent
-		ScaleType scale; ///< The scale determines how a clip should be resized to fit it's parent
+		GravityType gravity; ///< The gravity of a clip determines where it snaps to its parent
+		ScaleType scale; ///< The scale determines how a clip should be resized to fit its parent
 		AnchorType anchor; ///< The anchor determines what parent a clip should snap to
         FrameDisplayType display; ///< The format to display the frame number (if any)
 		VolumeMixType mixing; ///< What strategy should be followed when mixing audio with other clips
diff --git a/include/EffectBase.h b/include/EffectBase.h
@@ -82,7 +82,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/FFmpegReader.h b/include/FFmpegReader.h
@@ -150,7 +150,7 @@ namespace openshot
 		/// Check the current seek position and determine if we need to seek again
 		bool CheckSeek(bool is_video);
 
-		/// Check if a frame is missing and attempt to replace it's frame image (and
+		/// Check if a frame is missing and attempt to replace its frame image (and
 		bool CheckMissingFrame(int64_t requested_frame);
 
 		/// Check the working queue, and move finished frames to the finished queue
@@ -198,10 +198,10 @@ namespace openshot
 		/// Read the stream until we find the requested Frame
 		std::shared_ptr<Frame> ReadStream(int64_t requested_frame);
 
-		/// Remove AVFrame from cache (and deallocate it's memory)
+		/// Remove AVFrame from cache (and deallocate its memory)
 		void RemoveAVFrame(AVFrame*);
 
-		/// Remove AVPacket from cache (and deallocate it's memory)
+		/// Remove AVPacket from cache (and deallocate its memory)
 		void RemoveAVPacket(AVPacket*);
 
 		/// Seek to a specific Frame.  This is not always frame accurate, it's more of an estimation on many codecs.
@@ -228,7 +228,7 @@ namespace openshot
 		/// frame 1, or it throws one of the following exceptions.
 		FFmpegReader(string path);
 
-		/// Constructor for FFmpegReader.  This only opens the media file to inspect it's properties
+		/// Constructor for FFmpegReader.  This only opens the media file to inspect its properties
 		/// if inspect_reader=true. When not inspecting the media file, it's much faster, and useful
 		/// when you are inflating the object using JSON after instantiating it.
 		FFmpegReader(string path, bool inspect_reader);
diff --git a/include/FFmpegWriter.h b/include/FFmpegWriter.h
@@ -83,7 +83,7 @@ namespace openshot
 	 * FFmpegWriter w("/home/jonathan/NewVideo.webm");
 	 *
 	 * // Set options
-	 * w.SetAudioOptions(true, "libvorbis", 44100, 2, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000
+	 * w.SetAudioOptions(true, "libvorbis", 44100, 2, ChannelLayout::LAYOUT_STEREO, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000
 	 * w.SetVideoOptions(true, "libvpx", openshot::Fraction(24,1), 720, 480, openshot::Fraction(1,1), false, false, 300000); // FPS: 24, Size: 720x480, Pixel Ratio: 1/1, Bitrate: 300000
 	 *
 	 * // Open the writer
@@ -110,7 +110,7 @@ namespace openshot
 	 * FFmpegWriter w("/home/jonathan/NewVideo.webm");
 	 *
 	 * // Set options
-	 * w.SetAudioOptions(true, "libvorbis", 44100, 2, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000
+	 * w.SetAudioOptions(true, "libvorbis", 44100, 2, ChannelLayout::LAYOUT_STEREO, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000
 	 * w.SetVideoOptions(true, "libvpx", openshot::Fraction(24,1), 720, 480, openshot::Fraction(1,1), false, false, 300000); // FPS: 24, Size: 720x480, Pixel Ratio: 1/1, Bitrate: 300000
 	 *
 	 * // Prepare Streams (Optional method that must be called before any SetOption calls)
diff --git a/include/Frame.h b/include/Frame.h
@@ -197,7 +197,7 @@ namespace openshot
 		/// Clean up buffer after QImage is deleted
 		static void cleanUpBuffer(void *info);
 
-		/// Clear the waveform image (and deallocate it's memory)
+		/// Clear the waveform image (and deallocate its memory)
 		void ClearWaveform();
 
 		/// Copy data and pointers from another Frame instance
diff --git a/include/ImageReader.h b/include/ImageReader.h
@@ -77,7 +77,7 @@ namespace openshot
 		/// frame 1, or it throws one of the following exceptions.
 		ImageReader(string path);
 
-		/// Constructor for ImageReader.  This only opens the media file to inspect it's properties
+		/// Constructor for ImageReader.  This only opens the media file to inspect its properties
 		/// if inspect_reader=true. When not inspecting the media file, it's much faster, and useful
 		/// when you are inflating the object using JSON after instantiating it.
 		ImageReader(string path, bool inspect_reader);
diff --git a/include/ImageWriter.h b/include/ImageWriter.h
@@ -127,7 +127,7 @@ namespace openshot
 		/// @param height Height in pixels of image
 		/// @param quality Quality of image (0 to 100, 70 is default)
 		/// @param loops Number of times to repeat the image (used on certain multi-frame image formats, such as GIF)
-		/// @param combine Combine frames into a single image (if possible), or save each frame as it's own image
+		/// @param combine Combine frames into a single image (if possible), or save each frame as its own image
 		void SetVideoOptions(string format, Fraction fps, int width, int height,
 				int quality, int loops, bool combine);
 
diff --git a/include/QtImageReader.h b/include/QtImageReader.h
@@ -75,7 +75,7 @@ namespace openshot
 		/// frame 1, or it throws one of the following exceptions.
 		QtImageReader(string path);
 
-		/// Constructor for QtImageReader.  This only opens the media file to inspect it's properties
+		/// Constructor for QtImageReader.  This only opens the media file to inspect its properties
 		/// if inspect_reader=true. When not inspecting the media file, it's much faster, and useful
 		/// when you are inflating the object using JSON after instantiating it.
 		QtImageReader(string path, bool inspect_reader);
diff --git a/include/Timeline.h b/include/Timeline.h
@@ -100,6 +100,7 @@ namespace openshot {
 	 *            Fraction(25,1), // framerate
 	 *            44100, // sample rate
 	 *            2 // channels
+     *            ChannelLayout::LAYOUT_STEREO,
 	 *            );
 	 *
 	 * // Create some clips
diff --git a/include/effects/Bars.h b/include/effects/Bars.h
@@ -80,7 +80,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Blur.h b/include/effects/Blur.h
@@ -93,7 +93,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Brightness.h b/include/effects/Brightness.h
@@ -80,7 +80,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/ChromaKey.h b/include/effects/ChromaKey.h
@@ -77,7 +77,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/ColorShift.h b/include/effects/ColorShift.h
@@ -84,7 +84,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Crop.h b/include/effects/Crop.h
@@ -80,7 +80,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Deinterlace.h b/include/effects/Deinterlace.h
@@ -73,7 +73,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Hue.h b/include/effects/Hue.h
@@ -70,7 +70,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Mask.h b/include/effects/Mask.h
@@ -91,7 +91,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Negate.h b/include/effects/Negate.h
@@ -61,7 +61,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Pixelate.h b/include/effects/Pixelate.h
@@ -79,7 +79,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Saturation.h b/include/effects/Saturation.h
@@ -77,7 +77,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Shift.h b/include/effects/Shift.h
@@ -73,7 +73,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/include/effects/Wave.h b/include/effects/Wave.h
@@ -79,7 +79,7 @@ namespace openshot
 		/// modified openshot::Frame object
 		///
 		/// The frame object is passed into this method, and a frame_number is passed in which
-		/// tells the effect which settings to use from it's keyframes (starting at 1).
+		/// tells the effect which settings to use from its keyframes (starting at 1).
 		///
 		/// @returns The modified openshot::Frame object
 		/// @param frame The frame object that needs the effect applied to it
diff --git a/src/ChunkReader.cpp b/src/ChunkReader.cpp
@@ -42,7 +42,7 @@ ChunkReader::ChunkReader(string path, ChunkVersion chunk_version)
 	previous_location.number = 0;
 	previous_location.frame = 0;
 
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	Open();
 	Close();
 }
diff --git a/src/Clip.cpp b/src/Clip.cpp
@@ -272,7 +272,7 @@ void Clip::Close()
 // Get end position of clip (trim end of video), which can be affected by the time curve.
 float Clip::End()
 {
-	// if a time curve is present, use it's length
+	// if a time curve is present, use its length
 	if (time.Points.size() > 1)
 	{
 		// Determine the FPS fo this clip
diff --git a/src/DummyReader.cpp b/src/DummyReader.cpp
@@ -66,7 +66,7 @@ DummyReader::DummyReader(Fraction fps, int width, int height, int sample_rate, i
 	info.display_ratio.num = size.num;
 	info.display_ratio.den = size.den;
 
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	Open();
 	Close();
 }
diff --git a/src/FFmpegReader.cpp b/src/FFmpegReader.cpp
@@ -49,7 +49,7 @@ FFmpegReader::FFmpegReader(string path)
 	missing_frames.SetMaxBytesFromInfo(OPEN_MP_NUM_PROCESSORS * 2, info.width, info.height, info.sample_rate, info.channels);
 	final_cache.SetMaxBytesFromInfo(OPEN_MP_NUM_PROCESSORS * 2, info.width, info.height, info.sample_rate, info.channels);
 
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	Open();
 	Close();
 }
@@ -71,7 +71,7 @@ FFmpegReader::FFmpegReader(string path, bool inspect_reader)
 	missing_frames.SetMaxBytesFromInfo(OPEN_MP_NUM_PROCESSORS * 2, info.width, info.height, info.sample_rate, info.channels);
 	final_cache.SetMaxBytesFromInfo(OPEN_MP_NUM_PROCESSORS * 2, info.width, info.height, info.sample_rate, info.channels);
 
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	if (inspect_reader) {
 		Open();
 		Close();
@@ -1698,7 +1698,7 @@ bool FFmpegReader::IsPartialFrame(int64_t requested_frame) {
 	return seek_trash;
 }
 
-// Check if a frame is missing and attempt to replace it's frame image (and
+// Check if a frame is missing and attempt to replace its frame image (and
 bool FFmpegReader::CheckMissingFrame(int64_t requested_frame)
 {
 	// Lock
@@ -2025,7 +2025,7 @@ void FFmpegReader::CheckFPS()
 	}
 }
 
-// Remove AVFrame from cache (and deallocate it's memory)
+// Remove AVFrame from cache (and deallocate its memory)
 void FFmpegReader::RemoveAVFrame(AVFrame* remove_frame)
 {
     // Remove pFrame (if exists)
@@ -2042,7 +2042,7 @@ void FFmpegReader::RemoveAVFrame(AVFrame* remove_frame)
 	}
 }
 
-// Remove AVPacket from cache (and deallocate it's memory)
+// Remove AVPacket from cache (and deallocate its memory)
 void FFmpegReader::RemoveAVPacket(AVPacket* remove_packet)
 {
 	// deallocate memory for packet
diff --git a/src/Frame.cpp b/src/Frame.cpp
@@ -263,7 +263,7 @@ std::shared_ptr<QImage> Frame::GetWaveform(int width, int height, int Red, int G
 	return wave_image;
 }
 
-// Clear the waveform image (and deallocate it's memory)
+// Clear the waveform image (and deallocate its memory)
 void Frame::ClearWaveform()
 {
 	if (wave_image)
diff --git a/src/ImageReader.cpp b/src/ImageReader.cpp
@@ -31,14 +31,14 @@ using namespace openshot;
 
 ImageReader::ImageReader(string path) : path(path), is_open(false)
 {
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	Open();
 	Close();
 }
 
 ImageReader::ImageReader(string path, bool inspect_reader) : path(path), is_open(false)
 {
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	if (inspect_reader) {
 		Open();
 		Close();
@@ -106,7 +106,7 @@ void ImageReader::Close()
 	{
 		// Mark as "closed"
 		is_open = false;
-		
+
 		// Delete the image
 		image.reset();
 	}
diff --git a/src/QtImageReader.cpp b/src/QtImageReader.cpp
@@ -43,14 +43,14 @@ using namespace openshot;
 
 QtImageReader::QtImageReader(string path) : path(path), is_open(false)
 {
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	Open();
 	Close();
 }
 
 QtImageReader::QtImageReader(string path, bool inspect_reader) : path(path), is_open(false)
 {
-	// Open and Close the reader, to populate it's attributes (such as height, width, etc...)
+	// Open and Close the reader, to populate its attributes (such as height, width, etc...)
 	if (inspect_reader) {
 		Open();
 		Close();
@@ -143,7 +143,7 @@ void QtImageReader::Close()
 	{
 		// Mark as "closed"
 		is_open = false;
-		
+
 		// Delete the image
 		image.reset();
 
diff --git a/src/TextReader.cpp b/src/TextReader.cpp

Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@ namespace openshot`
`83`	`83`	`* FFmpegWriter w("/home/jonathan/NewVideo.webm");`
`84`	`84`	`*`
`85`	`85`	`* // Set options`
`86`		`- * w.SetAudioOptions(true, "libvorbis", 44100, 2, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000`
	`86`	`+ * w.SetAudioOptions(true, "libvorbis", 44100, 2, ChannelLayout::LAYOUT_STEREO, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000`
`87`	`87`	`* w.SetVideoOptions(true, "libvpx", openshot::Fraction(24,1), 720, 480, openshot::Fraction(1,1), false, false, 300000); // FPS: 24, Size: 720x480, Pixel Ratio: 1/1, Bitrate: 300000`
`88`	`88`	`*`
`89`	`89`	`* // Open the writer`
`@@ -110,7 +110,7 @@ namespace openshot`
`110`	`110`	`* FFmpegWriter w("/home/jonathan/NewVideo.webm");`
`111`	`111`	`*`
`112`	`112`	`* // Set options`
`113`		`- * w.SetAudioOptions(true, "libvorbis", 44100, 2, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000`
	`113`	`+ * w.SetAudioOptions(true, "libvorbis", 44100, 2, ChannelLayout::LAYOUT_STEREO, 128000); // Sample Rate: 44100, Channels: 2, Bitrate: 128000`
`114`	`114`	`* w.SetVideoOptions(true, "libvpx", openshot::Fraction(24,1), 720, 480, openshot::Fraction(1,1), false, false, 300000); // FPS: 24, Size: 720x480, Pixel Ratio: 1/1, Bitrate: 300000`
`115`	`115`	`*`
`116`	`116`	`* // Prepare Streams (Optional method that must be called before any SetOption calls)`
Original file line number	Diff line number	Diff line change
`@@ -100,6 +100,7 @@ namespace openshot {`
`100`	`100`	`* Fraction(25,1), // framerate`
`101`	`101`	`* 44100, // sample rate`
`102`	`102`	`* 2 // channels`
	`103`	`+ * ChannelLayout::LAYOUT_STEREO,`
`103`	`104`	`* );`
`104`	`105`	`*`
`105`	`106`	`* // Create some clips`