public void CommandHideWindows()
{
var command = new HideWindows(0, new[] { (byte)0xff }, 0);
var bytes = command.GetBytes();
Assert.AreEqual(bytes.Length, 2);
Assert.AreEqual(bytes[0], HideWindows.Id);
Assert.AreEqual(bytes[1], 0xff);
}
public static string Decode(int lineIndex, byte[] bytes, CommandState state, bool flush)
{
var i = 0;
var debugBuilder = new StringBuilder();
var textBuilder = new StringBuilder();
while (i < bytes.Length)
{
var b = bytes[i];
// Commands
if (b == EndOfText.Id)
{
//The EndOfText command is a Null Command which can be used to flush any buffered text to the current window. All commands force a flush of any buffered text to the current window, so this command is only needed when no other command is pending.
if (DebugMode)
{
debugBuilder.Append("{EndOfText}");
}
FlushText(debugBuilder, state);
}
else if (b >= SetCurrentWindow.IdStart && b <= SetCurrentWindow.IdEnd)
{
//SetCurrentWindow tells the caption decoder which window the following commands describe: SetWindowAttributes, SetPenAttributes, SetPenColor, SetPenLocation. If the window specified has not already been created with a DefineWindow command then
//SetCurrentWindow and the window property commands can be safely ignored.
var currentWindow = new SetCurrentWindow(lineIndex, b - 0x80);
state.Commands.Add(currentWindow);
if (DebugMode)
{
debugBuilder.Append("{SetCurrentWindow:" + currentWindow.WindowIndex + "}");
}
}
else if (b == ClearWindows.Id)
{
// ClearWindows clears all the windows specified in the 8 bit window bitmap.
var clearWindows = new ClearWindows(lineIndex, bytes, i + 1);
state.Commands.Add(clearWindows);
if (DebugMode)
{
debugBuilder.Append("{ClearWindows:" + clearWindows.Flags[0] + "," + clearWindows.Flags[1] + "," + clearWindows.Flags[2] + "," + clearWindows.Flags[3] + "," + clearWindows.Flags[4] + "," + clearWindows.Flags[5] + "," + clearWindows.Flags[6] + "," + clearWindows.Flags[7] + "}");
}
i++;
}
else if (b == DisplayWindows.Id)
{
// DisplayWindows displays all the windows specified in the 8 bit window bitmap.
var displayWindows = new DisplayWindows(lineIndex, bytes, i + 1);
state.Commands.Add(displayWindows);
if (DebugMode)
{
debugBuilder.Append("{DisplayWindows:" + displayWindows.Flags[0] + "," + displayWindows.Flags[1] + "," + displayWindows.Flags[2] + "," + displayWindows.Flags[3] + "," + displayWindows.Flags[4] + "," + displayWindows.Flags[5] + "," + displayWindows.Flags[6] + "," + displayWindows.Flags[7] + "}");
}
i++;
}
else if (b == HideWindows.Id)
{
FlushText(textBuilder, state);
// HideWindows hides all the windows specified in the 8 bit window bitmap.
var hideWindows = new HideWindows(lineIndex, bytes, i + 1);
state.Commands.Add(hideWindows);
if (DebugMode)
{
debugBuilder.Append("{HideWindows:" + hideWindows.Flags[0] + "," + hideWindows.Flags[1] + "," + hideWindows.Flags[2] + "," + hideWindows.Flags[3] + "," + hideWindows.Flags[4] + "," + hideWindows.Flags[5] + "," + hideWindows.Flags[6] + "," + hideWindows.Flags[7] + "}");
}
i++;
}
else if (b == ToggleWindows.Id)
{
// ToggleWindows hides all displayed windows, and displays all hidden windows specified in the 8 bit window bitmap.
var toggleWindows = new ToggleWindows(lineIndex, bytes, i + 1);
state.Commands.Add(toggleWindows);
if (DebugMode)
{
debugBuilder.Append("{ToggleWindows:" + toggleWindows.Flags[0] + "," + toggleWindows.Flags[1] + "," + toggleWindows.Flags[2] + "," + toggleWindows.Flags[3] + "," + toggleWindows.Flags[4] + "," + toggleWindows.Flags[5] + "," + toggleWindows.Flags[6] + "," + toggleWindows.Flags[7] + "}");
}
i++;
}
else if (b == DeleteWindows.Id)
{
// DeleteWindows deletes all the windows specified in the 8 bit window bitmap.If the current window, as specified by the last SetCurrentWindow command, is deleted then the current window becomes undefined and the window attribute commands should have no effect until after the next SetCurrentWindow or DefineWindow command.
var deleteWindows = new DeleteWindows(lineIndex, bytes, i + 1);
state.Commands.Add(deleteWindows);
if (DebugMode)
{
debugBuilder.Append("{DeleteWindows:" + deleteWindows.Flags[0] + "," + deleteWindows.Flags[1] + "," + deleteWindows.Flags[2] + "," + deleteWindows.Flags[3] + "," + deleteWindows.Flags[4] + "," + deleteWindows.Flags[5] + "," + deleteWindows.Flags[6] + "," + deleteWindows.Flags[7] + "}");
}
i++;
}
else if (b == Delay.Id)
{
// Delay suspends all processing of the current service, except for DelayCancel and Reset scanning.The period of suspension is set to by the one byte parameter.The parameter specifies the delay in tenths of a second, so the minimum delay is 0.1 seconds, and the maximum delay is 25.5 seconds.A zero second delay can safely be ignored in a decoder, but should not be emitted from an encoder.A delay should be cancelled if the caption decoder's input buffer becomes full, a DelayCancel or Reset is received, or the specified delay time elapses.
var delay = new Delay(lineIndex, bytes, i + 1);
state.Commands.Add(delay);
if (DebugMode)
{
debugBuilder.Append("{Delay:" + delay.Milliseconds + "ms}");
}
i++;
}
else if (b == DelayCancel.Id)
{
// DelayCancel terminates any active delay and resumes normal command processing. DelayCancel should be scanned for during a Delay.
var delayCancel = new DelayCancel(lineIndex);
state.Commands.Add(delayCancel);
if (DebugMode)
{
debugBuilder.Append("{DelayCancel}");
}
}
else if (b == Reset.Id)
{
// Reset deletes all windows, cancels any active delay, and clears the buffer before the Reset command. Reset should be scanned for during a Delay.
var reset = new Reset(lineIndex);
state.Commands.Add(reset);
if (DebugMode)
{
debugBuilder.Append("{Reset}");
}
}
else if (b == SetPenAttributes.Id)
{
//if (bytes.Length - i < 2)
//{
// break;
//}
// The SetPenAttributes command specifies how certain attributes of subsequent characters are to be rendered in the current window, until the next SetPenAttributes command.
var penAttributes = new SetPenAttributes(lineIndex, bytes, i + 1);
state.Commands.Add(penAttributes);
if (DebugMode)
{
//public int { get; set; }
//public int Offset { get; set; }
//public int TextTag { get; set; }
//public int FontTag { get; set; }
//public int EdgeType { get; set; }
//public bool Underline { get; set; }
//public bool Italics { get; set; }
debugBuilder.Append($"{{SetPenAttributes:PenSize={penAttributes.PenSize},Offset={penAttributes.Offset},TextTag={penAttributes.TextTag},FontTag={penAttributes.FontTag},EdgeType={penAttributes.EdgeType},Underline={penAttributes.Underline},Italic={penAttributes.Italics}}}");
}
i += 2;
}
else if (b == SetPenColor.Id)
{
//if (bytes.Length - i < 3)
//{
// break;
//}
// SetPenColor sets the foreground, background, and edge color for the subsequent characters. Color is specified with 6 bits, 2 for each of blue, green and red. The lowest order bits are for blue, the next two for green and the highest order bits represent red. Opacity is represented by two bits, they represent SOLID=0, FLASH=1, TRANSLUCENT=2, and TRANSPARENT=3. The edge color is the color of the outlined edges of the text, but the outline shares its opacity with the foreground, so the highest order bits of the third parameter byte should both be cleared.
var penColor = new SetPenColor(lineIndex, bytes, i + 1);
state.Commands.Add(penColor);
if (DebugMode)
{
debugBuilder.Append($"{{SetPenColor:Foreground=r{penColor.ForegroundColorRed} g{penColor.ForegroundColorGreen} b{penColor.ForegroundColorBlue} op-{penColor.ForegroundOpacity}, Background=r{penColor.BackgroundColorRed} g{penColor.BackgroundColorGreen} b{penColor.BackgroundColorBlue} op-{penColor.BackgroundOpacity}, Edge=r{penColor.EdgeColorRed} g{penColor.EdgeColorGreen} b{penColor.EdgeColorBlue}}}");
}
i += 3;
}
else if (b == SetPenLocation.Id)
{
// SetPenLocation sets the location of for the next bit of appended text in the current window. It has two parameters, row and column. If a window is not locked (see Define Window) and the SMALL font is in effect the location can be outside the otherwise valid addresses.
var penLocation = new SetPenLocation(lineIndex, bytes, i + 1);
state.Commands.Add(penLocation);
if (DebugMode)
{
debugBuilder.Append("{SetPenLocation:" + penLocation.Column + "," + penLocation.Row + "}");
}
i += 2;
}
else if (b == SetWindowAttributes.Id)
{
//if (bytes.Length - i < 4)
//{
// break;
//}
// SetWindowAttributes Sets the window attributes of the current window. Fill Color is specified with 6 bits, 2 for each of blue, green and red. The lowest order bits are for blue, the next two for green and the highest order bits represent red. Fill Opacity is represented by two bits, they represent SOLID=0, FLASH=1, TRANSLUCENT=2, and TRANSPARENT=3. The window's Border Color is specified the same way. However, the Border Type is split into two fields. They should be combined, with border type 01 representing the low order bits, and border type 2 the high order bit. Once combined the Border Type has 6 valid values: NONE=0, RAISED=1, DEPRESSED=2, UNIFORM=3, SHADOW_LEFT=4, and SHADOW_RIGHT=5.
var windowAttributes = new SetWindowAttributes(lineIndex, bytes, i + 1);
state.Commands.Add(windowAttributes);
if (DebugMode)
{
debugBuilder.Append($"{{SetWindowAttributes:Justify={windowAttributes.Justify}, PrintDirection={windowAttributes.PrintDirection}, ScrollDirection={windowAttributes.ScrollDirection}, Wordwrap={windowAttributes.Wordwrap}, DisplayEffect={windowAttributes.DisplayEffect}, EffectDirection={windowAttributes.EffectDirection}, EffectSpeed={windowAttributes.EffectSpeed}, FillColorRed={windowAttributes.FillColorRed}, FillColorGreen={windowAttributes.FillColorGreen}, FillColorBlue={windowAttributes.FillColorBlue}, FillOpacity={windowAttributes.FillOpacity}, BorderType={windowAttributes.BorderType}, BorderColorRed={windowAttributes.BorderColorRed}, BorderColorGreen={windowAttributes.BorderColorGreen}, BorderColorBlue={windowAttributes.BorderColorBlue}}}");
}
i += 4;
}
else if (b >= DefineWindow.IdStart && b <= DefineWindow.IdEnd)
{
//if (bytes.Length - i < 6)
//{
// break;
//}
//DefineWindow0-7 creates one of the eight windows used by a caption decoder. This command should be sent periodically by a caption encoder even for pre-existing windows so that a newly tuned in caption decoder can begin displaying captions. When issued on a pre-existing window the pen style and window style can be left null, this tells the decoder not to change the current styles if they exist, and initialize both to style 1 if the window does not exist in its context
var defineWindow = new DefineWindow(lineIndex, bytes, i);
state.Commands.Add(defineWindow);
if (DebugMode)
{
debugBuilder.Append($"{{DefineWindow:AnchorId={defineWindow.AnchorId}, AnchorV={defineWindow.AnchorVertical}, AnchorH={defineWindow.AnchorHorizontal}, Id={defineWindow.Id:X2}, Columns={defineWindow.ColumnCount}, Rows={defineWindow.RowCount}, RowLock={defineWindow.RowLock}, ColumnLock={defineWindow.ColumnLock}, PenStyleId={defineWindow.PenStyleId}, Priority={defineWindow.Priority}, RelativePositioning={defineWindow.RelativePositioning}, Visible={defineWindow.Visible}, WindowStyleId={defineWindow.WindowStyleId}}}");
}
i += 6;
}
// Lookups
else if (b == 0x10 && i < bytes.Length - 1)
{
// ext 1
var b2 = bytes[i] << 8 + bytes[i + 1];
i++;
if (b2 >= 0x1000 && b2 <= 0x101F)
{
// CL Group: C2: ISO 8859 - Extended Miscellaneous Control Codes
}
else if (b2 >= 0x1020 && b2 <= 0x107F)
{
// GL Group: G2: Extended Control Code Set 1
}
else if (b2 >= 0x1080 && b2 <= 0x109F)
{
// CR Group: C3: Extended Control Code Set 2
}
else if (b2 >= 0x10A0 && b2 <= 0x10FF)
{
// GR Group: G3: Future characters and icons
}
}
else if (b <= 0x1F)
{
// CL Group: C0: Subset of ASCII Control Codes
var text = new SetText(lineIndex, SingleCharLookupTable[b]);
state.Commands.Add(text);
debugBuilder.Append(text.Content);
//TODO: ???
//if (b >= 0x10 && b <= 0x17)
//{
// i++;
//}
//else if (b >= 0x18 && b <= 0x1F)
//{
// i+=2;
//}
}
else if (b >= 0x20 && b <= 0x7F)
{
// Modified version of ANSI X3.4 Printable Character Set(ASCII)
var text = new SetText(lineIndex, SingleCharLookupTable[b]);
state.Commands.Add(text);
debugBuilder.Append(text.Content);
}
else if (b >= 0x80 && b <= 0x9f)
{
// CR Group: C1: Caption Control Codes
var text = new SetText(lineIndex, SingleCharLookupTable[b]);
state.Commands.Add(text);
debugBuilder.Append(text.Content);
}
else if (b >= 0xA0 && b <= 0xFF)
{
// ISO 8859 - 1 Latin 1 Characters
var text = new SetText(lineIndex, SingleCharLookupTable[b]);
state.Commands.Add(text);
debugBuilder.Append(text.Content);
}
i++;
}
if (flush)
{
FlushText(textBuilder, state);
}
return(DebugMode ? debugBuilder.ToString() : textBuilder.ToString());
}
public static string Decode(int lineIndex, byte[] bytes, CommandState state, bool flush)
{
var i = 0;
var sb = new StringBuilder();
while (i < bytes.Length)
{
var b = bytes[i];
// Commands
if (b == 0x03)
{
//The EndOfText command is a Null Command which can be used to flush any buffered text to the current window. All commands force a flush of any buffered text to the current window, so this command is only needed when no other command is pending.
if (DebugMode)
{
sb.Append("{EndOfText}");
}
FlushText(sb, state);
}
else if (b >= 0x80 && b <= 0x87)
{
//SetCurrentWindow tells the caption decoder which window the following commands describe: SetWindowAttributes, SetPenAttributes, SetPenColor, SetPenLocation. If the window specified has not already been created with a DefineWindow command then
//SetCurrentWindow and the window property commands can be safely ignored.
var currentWindow = new CurrentWindow(lineIndex, b - 0x80);
state.Commands.Add(currentWindow);
if (DebugMode)
{
sb.Append("{SetCurrentWindow:" + currentWindow.Index + "}");
}
}
else if (b == 0x88)
{
// ClearWindows clears all the windows specified in the 8 bit window bitmap.
var clearWindows = new ClearWindows(lineIndex, bytes, i + 1);
state.Commands.Add(clearWindows);
if (DebugMode)
{
sb.Append("{ClearWindows}");
}
i++;
}
else if (b == 0x89)
{
// DisplayWindows displays all the windows specified in the 8 bit window bitmap.
var displayWindows = new DisplayWindows(lineIndex, bytes, i + 1);
state.Commands.Add(displayWindows);
if (DebugMode)
{
sb.Append("{DisplayWindows}");
}
i++;
}
else if (b == 0x8A)
{
// HideWindows hides all the windows specified in the 8 bit window bitmap.
var hideWindows = new HideWindows(lineIndex, bytes, i + 1);
state.Commands.Add(hideWindows);
if (DebugMode)
{
sb.Append("{HideWindows}");
}
i++;
}
else if (b == 0x8B)
{
// ToggleWindows hides all displayed windows, and displays all hidden windows specified in the 8 bit window bitmap.
var toggleWindows = new ToggleWindows(lineIndex, bytes, i + 1);
state.Commands.Add(toggleWindows);
if (DebugMode)
{
sb.Append("{ToggleWindows}");
}
i++;
}
else if (b == 0x8C)
{
// DeleteWindows deletes all the windows specified in the 8 bit window bitmap.If the current window, as specified by the last SetCurrentWindow command, is deleted then the current window becomes undefined and the window attribute commands should have no effect until after the next SetCurrentWindow or DefineWindow command.
var deleteWindows = new DeleteWindows(lineIndex, bytes, i + 1);
state.Commands.Add(deleteWindows);
if (DebugMode)
{
sb.Append("{DeleteWindows}");
}
i++;
}
else if (b == 0x8D)
{
// Delay suspends all processing of the current service, except for DelayCancel and Reset scanning.The period of suspension is set to by the one byte parameter.The parameter specifies the delay in tenths of a second, so the minimum delay is 0.1 seconds, and the maximum delay is 25.5 seconds.A zero second delay can safely be ignored in a decoder, but should not be emitted from an encoder.A delay should be cancelled if the caption decoder's input buffer becomes full, a DelayCancel or Reset is received, or the specified delay time elapses.
var delay = new Delay(lineIndex, bytes, i + 1);
state.Commands.Add(delay);
if (DebugMode)
{
sb.Append("{Delay:" + delay.Milliseconds + "ms}");
}
i++;
}
else if (b == 0x8E)
{
// DelayCancel terminates any active delay and resumes normal command processing. DelayCancel should be scanned for during a Delay.
var delayCancel = new DelayCancel(lineIndex);
state.Commands.Add(delayCancel);
if (DebugMode)
{
sb.Append("{DelayCancel}");
}
}
else if (b == 0x8F)
{
// Reset deletes all windows, cancels any active delay, and clears the buffer before the Reset command. Reset should be scanned for during a Delay.
var reset = new Reset(lineIndex);
state.Commands.Add(reset);
if (DebugMode)
{
sb.Append("{Reset}");
}
}
else if (b == 0x90)
{
// The SetPenAttributes command specifies how certain attributes of subsequent characters are to be rendered in the current window, until the next SetPenAttributes command.
var penAttributes = new PenAttributes(lineIndex, bytes, i + 1);
state.Commands.Add(penAttributes);
if (DebugMode)
{
sb.Append("{SetPenAttributes:italic=" + penAttributes.Italics + "}");
}
i += 2;
}
else if (b == 0x91)
{
// SetPenColor sets the foreground, background, and edge color for the subsequent characters. Color is specified with 6 bits, 2 for each of blue, green and red. The lowest order bits are for blue, the next two for green and the highest order bits represent red. Opacity is represented by two bits, they represent SOLID=0, FLASH=1, TRANSLUCENT=2, and TRANSPARENT=3. The edge color is the color of the outlined edges of the text, but the outline shares its opacity with the foreground, so the highest order bits of the third parameter byte should both be cleared.
var penColor = new PenColor(lineIndex, bytes, i + 1);
state.Commands.Add(penColor);
if (DebugMode)
{
sb.Append("{SetPenColor:color=r" + penColor.ForegroundColorRed + " g" + penColor.ForegroundColorGreen + " b" + penColor.ForegroundColorBlue + "}");
}
i += 3;
}
else if (b == 0x92)
{
// SetPenLocation sets the location of for the next bit of appended text in the current window. It has two parameters, row and column. If a window is not locked (see Define Window) and the SMALL font is in effect the location can be outside the otherwise valid addresses.
var penLocation = new PenLocation(lineIndex, bytes, i + 1);
state.Commands.Add(penLocation);
if (DebugMode)
{
sb.Append("{SetPenLocation:" + penLocation.Row + "," + penLocation.Column + "}");
}
i += 2;
}
else if (b == 0x97)
{
// SetWindowAttributes Sets the window attributes of the current window. Fill Color is specified with 6 bits, 2 for each of blue, green and red. The lowest order bits are for blue, the next two for green and the highest order bits represent red. Fill Opacity is represented by two bits, they represent SOLID=0, FLASH=1, TRANSLUCENT=2, and TRANSPARENT=3. The window's Border Color is specified the same way. However, the Border Type is split into two fields. They should be combined, with border type 01 representing the low order bits, and border type 2 the high order bit. Once combined the Border Type has 6 valid values: NONE=0, RAISED=1, DEPRESSED=2, UNIFORM=3, SHADOW_LEFT=4, and SHADOW_RIGHT=5.
var windowAttributes = new WindowAttributes(lineIndex, bytes, i + 1);
state.Commands.Add(windowAttributes);
if (DebugMode)
{
sb.Append("{SetWindowAttributes}");
}
i += 4;
}
else if (b >= 0x98 && b <= 0x9F)
{
//DefineWindow0-7 creates one of the eight windows used by a caption decoder. This command should be sent periodically by a caption encoder even for pre-existing windows so that a newly tuned in caption decoder can begin displaying captions. When issued on a pre-existing window the pen style and window style can be left null, this tells the decoder not to change the current styles if they exist, and initialize both to style 1 if the window does not exist in its context
var window = new Window(lineIndex, bytes, i + 1);
state.Commands.Add(window);
if (DebugMode)
{
sb.Append("{DefineWindow}");
}
i += 6;
}
// Lookups
else if (b == 0x10 && i < bytes.Length - 1)
{
// ext 1
var b2 = bytes[i] << 8 + bytes[i + 1];
i++;
if (b2 >= 0x1000 && b2 <= 0x101F)
{
// CL Group: C2: ISO 8859 - Extended Miscellaneous Control Codes
}
else if (b2 >= 0x1020 && b2 <= 0x107F)
{
// GL Group: G2: Extended Control Code Set 1
}
else if (b2 >= 0x1080 && b2 <= 0x109F)
{
// CR Group: C3: Extended Control Code Set 2
}
else if (b2 >= 0x10A0 && b2 <= 0x10FF)
{
// GR Group: G3: Future characters and icons
}
}
else if (b <= 0x1F)
{
// CL Group: C0: Subset of ASCII Control Codes
sb.Append(SingleCharLookupTable[b]);
//TODO: ???
//if (b >= 0x10 && b <= 0x17)
//{
// i++;
//}
//else if (b >= 0x18 && b <= 0x1F)
//{
// i+=2;
//}
}
else if (b >= 0x20 && b <= 0x7F)
{
// Modified version of ANSI X3.4 Printable Character Set(ASCII)
sb.Append(SingleCharLookupTable[b]);
}
else if (b >= 0x80 && b <= 0x9f)
{
// CR Group: C1: Caption Control Codes
sb.Append(SingleCharLookupTable[b]);
}
else if (b >= 0xA0 && b <= 0xFF)
{
// ISO 8859 - 1 Latin 1 Characters
sb.Append(SingleCharLookupTable[b]);
}
i++;
}
return(sb.ToString());
}