OggKate - Revision history

MarkH: fix broken links

2023-02-21T16:20:46Z

fix broken links

← Older revision		Revision as of 16:20, 21 February 2023
Line 704:		Line 704:
	libkate encodes and decodes Kate streams, and is API and ABI stable.		libkate encodes and decodes Kate streams, and is API and ABI stable.

	The libkate source distribution is available at [~~http~~://~~libkate~~.~~googlecode~~.com/ ~~http~~://~~libkate~~.~~googlecode~~.com/].		The libkate source distribution is available at [https://code.google.com/archive/p/libkate/ https://code.google.com/archive/p/libkate/].

	A public git repository is available at [~~http~~://~~git~~.xiph.org/~~?p=users/oggk~~/kate~~.git;a=summary http~~://~~git~~.xiph.org/~~?p=users/oggk~~/kate~~.git;a=summary~~].		A public git repository is available at [https://gitlab.xiph.org/xiph/kate https://gitlab.xiph.org/xiph/kate].

	libtiger renders Kate streams using Pango and Cairo, and is alpha, with API changes still possible.		libtiger renders Kate streams using Pango and Cairo, and is alpha, with API changes still possible.

	The libtiger source distribution is available at [~~http~~://~~libtiger~~.~~googlecode~~.com/ ~~http:~~//libtiger~~.googlecode.com~~/].		The libtiger source distribution is available at [https://code.google.com/archive/p/libtiger/ https://code.google.com/archive/p/libtiger/].

	~~A public git repository is available at [http~~://~~git~~.~~xiph~~.~~org~~/~~?p=users~~/~~oggk/tiger.git;a=summary http://git.xiph.org/?~~p~~=users~~/~~oggk~~/~~tiger.git;a=summary~~].

	== HOWTOs ==		== HOWTOs ==

MrZeus: /* Frequently Asked Questions */ linkify Pango and Cairo

2017-11-21T09:32:05Z

Frequently Asked Questions: linkify Pango and Cairo

← Older revision		Revision as of 09:32, 21 November 2017
Line 860:		Line 860:
	It has been reported to work on Windows and MacOS X as well as UNIX platforms.		It has been reported to work on Windows and MacOS X as well as UNIX platforms.

	However, libtiger, a rendering library for Kate streams, relies on Pango and Cairo,		However, libtiger, a rendering library for Kate streams, relies on [http://www.pango.org/ Pango] and [https://www.cairographics.org/ Cairo],
	which are not easy to build on Windows, though they can be.		which are not easy to build on Windows, though they can be.
	The Tiger renderer is however completely separate from libkate, and is not needed		The Tiger renderer is however completely separate from libkate, and is not needed

MrZeus: trim trrailing spaces and surplus blank lines

2017-11-21T09:15:06Z

trim trrailing spaces and surplus blank lines

← Older revision		Revision as of 09:15, 21 November 2017
Line 105:		Line 105:
	by comparing the first eight bytes of the first packet with the signature		by comparing the first eight bytes of the first packet with the signature
	string "\200kate\0\0\0".		string "\200kate\0\0\0".


	When embedded in Ogg,the first packet in a Kate stream (always packet type 0x80,		When embedded in Ogg,the first packet in a Kate stream (always packet type 0x80,
Line 136:		Line 135:
	::0x02 repeat		::0x02 repeat
	::0x7f end packet (EOS)		::0x7f end packet (EOS)



	This format described here is for bitstream version 0.x.		This format described here is for bitstream version 0.x.
Line 148:		Line 145:
	This works out to a 64 byte ID header. This is the header that should be		This works out to a 64 byte ID header. This is the header that should be
	used to detect a Kate stream within an Ogg stream.		used to detect a Kate stream within an Ogg stream.



	0 1 2 3 \|		0 1 2 3 \|
Line 187:		Line 182:
	\| category (continued) \| 60-63		\| category (continued) \| 60-63
	+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+		+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+



	The fields cw sh, canvas width, cw sh, and canvas height were introduced		The fields cw sh, canvas width, cw sh, and canvas height were introduced
Line 278:		Line 271:
	Ogg leaves the encoding of granules up to a particular codec, only		Ogg leaves the encoding of granules up to a particular codec, only
	mandating that granules be non decreasing with time.		mandating that granules be non decreasing with time.

	The Kate bitstream format uses a linear mapping between time and		The Kate bitstream format uses a linear mapping between time and
	granule, described here.		granule, described here.

	A Kate granule position is composed of two different parts:		A Kate granule position is composed of two different parts:
	- a base granule, in the high bits		- a base granule, in the high bits
Line 289:		Line 282:
	\| base \| offset \|		\| base \| offset \|
	+----------------+----------------+		+----------------+----------------+

	The number of bits these parts occupy is variable, and each stream		The number of bits these parts occupy is variable, and each stream
	may choose how many bits to dedicate to each. The kate_info structure		may choose how many bits to dedicate to each. The kate_info structure
Line 306:		Line 299:
	be the starting time of the previous event, if the stream contains		be the starting time of the previous event, if the stream contains
	time overlapping events.		time overlapping events.

	The kate_info structure for a stream holds a rational fraction		The kate_info structure for a stream holds a rational fraction
	representing the time span of granule units for both the base and		representing the time span of granule units for both the base and
	the offset parts.		the offset parts.

	The granule rate is defined by the two fields:		The granule rate is defined by the two fields:

	kate_info::gps_numerator		kate_info::gps_numerator
	kate_info::gps_denominator		kate_info::gps_denominator


	The number of bits reserved for the offset is defined by the field:		The number of bits reserved for the offset is defined by the field:
Line 389:		Line 381:
	but it makes life easier, especially when considering the the order in which motions are applied		but it makes life easier, especially when considering the the order in which motions are applied
	does matter (to be defined formally, but the current source code is informative at this point).		does matter (to be defined formally, but the current source code is informative at this point).


	== The Kate file format ==		== The Kate file format ==
Line 571:		Line 562:

	== Possible additions ==		== Possible additions ==

	=== Embedded binary data ===		=== Embedded binary data ===

Line 760:		Line 751:
	This second method can also be used to add subtitles to a video which		This second method can also be used to add subtitles to a video which
	is already encoded to Theora, as it will not transcode the video again.		is already encoded to Theora, as it will not transcode the video again.


	=== DVD subtitles ===		=== DVD subtitles ===
Line 772:		Line 762:
	by Thoggen, and selecting them in the GUI will cause them to be saved as		by Thoggen, and selecting them in the GUI will cause them to be saved as
	Kate tracks along with the movie.		Kate tracks along with the movie.


	=== Song lyrics ===		=== Song lyrics ===
Line 787:		Line 776:
	So called 'enhanced LRC' files (containing extra karaoke timing information)		So called 'enhanced LRC' files (containing extra karaoke timing information)
	are supported, and a simple karaoke color change scheme will be saved		are supported, and a simple karaoke color change scheme will be saved
	out for these files. For more complex karaoke effects (such as more		out for these files. For more complex karaoke effects (such as more
	complex style changes, or sprite animation), kateenc should be used with		complex style changes, or sprite animation), kateenc should be used with
	a Kate description file to create a separate Kate stream, which can then		a Kate description file to create a separate Kate stream, which can then
Line 798:		Line 787:
	This latter method may also be used if you already have an encoded Vorbis song		This latter method may also be used if you already have an encoded Vorbis song
	with no lyrics, and just want to add the lyrics without reencoding.		with no lyrics, and just want to add the lyrics without reencoding.


	=== Metadata ===		=== Metadata ===
Line 848:		Line 836:
	track a person's movements with that region. Or you can tag a bitmap		track a person's movements with that region. Or you can tag a bitmap
	with a copyright and a URL to a larger version of the image.		with a copyright and a URL to a larger version of the image.



	=== Changing a Kate stream embedded in an Ogg stream ===		=== Changing a Kate stream embedded in an Ogg stream ===

MrZeus: /* Karaoke */

2017-11-21T09:11:25Z

Karaoke

← Older revision		Revision as of 09:11, 21 November 2017
Line 429:		Line 429:

	Karaoke effects rely on motions, and there will be predefined higher level ways of specifying		Karaoke effects rely on motions, and there will be predefined higher level ways of specifying
	timings and effects, two of which are already done. As an example, this is a valid Karaoke script:		timings and effects, two of which are already done.

			As an example, this is a valid Karaoke script:

	:kate {		:kate {
Line 445:		Line 447:
	The syllables will change from a style to another as time passes. The definition of the start_style		The syllables will change from a style to another as time passes. The definition of the start_style
	and end_style styles is omitted for brevity.		and end_style styles is omitted for brevity.


	== Problems to solve ==		== Problems to solve ==

MrZeus: /* What is Kate? */

2015-10-26T16:33:06Z

What is Kate?

← Older revision		Revision as of 16:33, 26 October 2015
Line 7:		Line 7:

	Kate is an overlay codec, originally designed for karaoke and text, that can be		Kate is an overlay codec, originally designed for karaoke and text, that can be
	~~multiplixed~~ in Ogg. Text and images can be carried by a Kate stream~~, and animated~~.		multiplexed in Ogg.
	Most of the time, ~~this would~~ be multiplexed with audio/video to carry subtitles,
	song lyrics (with or without karaoke data), etc~~, but doesn't have to be~~.		Text and images can be carried and animated by a Kate stream.
			Most of the time, they will (optionally) be multiplexed with audio/video to carry subtitles,
			song lyrics (with or without karaoke data), etc.

	Series of curves (splines, segments, etc) may be attached to various properties		Series of curves (splines, segments, etc) may be attached to various properties

Martin.leese: Removed Category:Drafts as it seems stable and Xiph is recommending that people use it

2013-07-23T22:12:04Z

Removed Category:Drafts as it seems stable and Xiph is recommending that people use it

← Older revision		Revision as of 22:12, 23 July 2013
Line 885:		Line 885:
	These files use raw text only.		These files use raw text only.



	~~[[Category:Drafts]]~~
	[[Category:Ogg Mappings]]		[[Category:Ogg Mappings]]

J^: Reverted edits by WikiCleaner (talk) to last revision by Ogg.k.ogg.k

2012-06-15T11:24:49Z

Reverted edits by WikiCleaner (talk) to last revision by Ogg.k.ogg.k

← Older revision		Revision as of 11:24, 15 June 2012
Line 17:		Line 17:

	Example uses of Kate streams are movie subtitles for Theora videos, either text based,		Example uses of Kate streams are movie subtitles for Theora videos, either text based,
	as may be created by [http://~~itshumour~~.~~blogspot~~.~~com~~/~~2011~~/~~07/funny-marriage-jokes.html~~ ffmpeg2theora], or image		as may be created by [http://www.v2v.cc/~j/ffmpeg2theora ffmpeg2theora], or image
	based, such as created by [http://thoggen.net Thoggen] (patching needed), and lyrics,		based, such as created by [http://thoggen.net Thoggen] (patching needed), and lyrics,
	as created by oggenc, from vorbis-tools.		as created by oggenc, from vorbis-tools.

WikiCleaner: fixed format change

2012-06-15T10:11:59Z

fixed format change

← Older revision		Revision as of 10:11, 15 June 2012
Line 17:		Line 17:

	Example uses of Kate streams are movie subtitles for Theora videos, either text based,		Example uses of Kate streams are movie subtitles for Theora videos, either text based,
	as may be created by [http://~~www~~.~~v2v~~.cc/~j/~~ffmpeg2theora~~ ffmpeg2theora], or image		as may be created by [http://itshumour.blogspot.com/2011/07/funny-marriage-jokes.html ffmpeg2theora], or image
	based, such as created by [http://thoggen.net Thoggen] (patching needed), and lyrics,		based, such as created by [http://thoggen.net Thoggen] (patching needed), and lyrics,
	as created by oggenc, from vorbis-tools.		as created by oggenc, from vorbis-tools.

Ogg.k.ogg.k: Add something about how to add metadata

2011-09-07T21:38:05Z

Add something about how to add metadata

← Older revision		Revision as of 21:38, 7 September 2011
Line 795:		Line 795:
	This latter method may also be used if you already have an encoded Vorbis song		This latter method may also be used if you already have an encoded Vorbis song
	with no lyrics, and just want to add the lyrics without reencoding.		with no lyrics, and just want to add the lyrics without reencoding.


			=== Metadata ===

			Metadata can be attached to events, or to styles, bitmaps, regions, etc.
			Metadata are free form tag/value pairs, and can be used to enrich their
			attached data with extra information. However, how this information is
			interpreted is up to the application layer.

			It is worth noting that an event may not have attached text, so it is
			possible to create an empty timed event with attached metadata.

			For instance, let's say we have a documentary, with footage from various
			places, as well as short interviews, and we want two things:
			- tag footage with metadata about the location and date that footage was shot
			- subtitle the interviews and tag those subtitles with information about the speaker

			You can then create an empty Kate event for each footage part, synchronized
			with the footage, and attach a new metadata item called GEO_LOCATION, filled
			with latitude and longitude of the place the footage was shot at.
			Similarly, for each subtitle event, a metadata item called SPEAKER can be
			attached.

			An empty event to tag a long 4:20 footage shot in Tokyo on 2011/08/12, and
			inserted at 18:30 in the documentary could look like:

			event {
			00:18:30,000 --> 00:22:50,000
			meta "GEO_LOCATION" = "35.42; 139.42"
			meta "DATE" = "2011-08-12"
			}

			Here's a example for a line spoken by Dr Joe Bloggs at 18:30 into the documentary:

			event {
			00:18:30,000 --> 00:18:32,000
			"Notice how the subtitles for my words have metadata attached to them"
			meta "SPEAKER" = "Dr Joe Bloggs"
			meta "URL" = "http://www.example.com/biography?name=Joe+Bloggs"
			}

			Notice how another metadata item, URL, is also present. The application
			will have to be aware of those metadata in order to do something with it
			though. Since those are free form, it is up to you to think of what
			metadata you want, and make use of it.

			Note that metadata may be attached to other objects, such as regions.
			This way, you can for example create a region tagged with a name, and
			track a person's movements with that region. Or you can tag a bitmap
			with a copyright and a URL to a larger version of the image.

J^: Reverted edits by WikiAdmin (talk) to last revision by Ogg.k.ogg.k

2011-07-03T16:24:34Z

Reverted edits by WikiAdmin (talk) to last revision by Ogg.k.ogg.k

← Older revision		Revision as of 16:24, 3 July 2011
Line 529:		Line 529:
	The category field in the BOS packet is a 16 byte text field (15 really, as it is zero terminated		The category field in the BOS packet is a 16 byte text field (15 really, as it is zero terminated
	in the bitstream itself). Its goal is to provide the reader with a short description of what kind		in the bitstream itself). Its goal is to provide the reader with a short description of what kind
	of ~~[http://www.shindiristudio.com/ web design]~~ information the stream contains, eg subtitles, lyrics, etc. This would be displayed to the user,		of information the stream contains, eg subtitles, lyrics, etc. This would be displayed to the user,
	possibly to allow to choose to turn some streams on and off.		possibly to allow to choose to turn some streams on and off.