Merge pull request #199 from ckirmse/develop

fix grammar error with possessive its and update example code

Author: ferdnyc

CMakeLists.txt

@@ -47,7 +47,8 @@ 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)

include/Clip.h

@@ -148,8 +148,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

include/EffectBase.h

@@ -85,7 +85,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

include/FFmpegReader.h

@@ -162,7 +162,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
@@ -210,10 +210,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.
@@ -240,7 +240,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);

include/FFmpegWriter.h

@@ -84,7 +84,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
@@ -111,7 +111,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)

include/Frame.h

@@ -200,7 +200,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

include/ImageReader.h

@@ -83,7 +83,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);

include/ImageWriter.h

@@ -130,7 +130,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);
 

include/QtImageReader.h

@@ -79,7 +79,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);

include/Timeline.h

@@ -104,6 +104,7 @@ namespace openshot {
 	 *            Fraction(25,1), // framerate
 	 *            44100, // sample rate
 	 *            2 // channels
+	 *            ChannelLayout::LAYOUT_STEREO,
 	 *            );
 	 *
 	 * // Create some clips