Add all Shaka Packager flags with helpers (#3)

* Add Widevine encryption and decryption flags with associated helper functions

* Add raw key encryption and decryption flags with helper functions

* Add PlayReady encryption and server URL flags with helper functions

* Add ProtectionSystemsFlag and helper function for command line integration

* Add flags for time shift buffer depth, preserved segments, and default languages with helper functions

* Add CryptByteBlock, ProtectionScheme, SkipByteBlock, VP9SubsampleEncryption, and PlayReadyExtraHeaderData flags with helper functions

* Add AdCuesFlag and WithAdCuesFlag for command line integration

* Add HLS flags and helper functions for command line integration

* Add command line flags and helper functions for ClearLead, SegmentDuration, SegmentSapAligned, FragmentDuration, FragmentSapAligned, GenerateSidxInMediaSegments, TempDir, Mp4IncludePsshInStream, TransportStreamTimestampOffsetMs, DefaultTextZeroBiasMs, StartSegmentNumber, and UseDoviSupplementalCodecs

* Add command line flags and helper functions for MPD and Packager configurations

* Remove unused WithDumpStreamInfoFlag function from packager_flags_helpers.go

Author: paulgrammer

pkg/ad_cue_generator_flags.go

@@ -0,0 +1,27 @@
+package packlit
+
+import (
+	"fmt"
+)
+
+var (
+	_ ShakaParser = (*AdCuesFlag)(nil)
+)
+
+// AdCuesFlag represents the list of cuepoint markers.
+type AdCuesFlag string
+
+// Parse returns the string representation of AdCues for use in the command line flags.
+func (a AdCuesFlag) Parse() string {
+	return fmt.Sprintf("--ad_cues=%s", a)
+}
+
+// Validate checks if the value of AdCues is valid.
+// This flag accepts semicolon separated pairs, and components in the pair are separated by a comma.
+// The second component (duration) is optional. For example:
+// --ad_cues {start_time}[,{duration}][;{start_time}[,{duration}]]...
+// The start_time represents the start of the cue marker in seconds relative to the start of the program.
+func (a AdCuesFlag) Validate() error {
+	// Split the input by semicolons to separate cuepoint markers.
+	return nil
+}

pkg/ad_cue_generator_flags_helpers.go

@@ -0,0 +1,8 @@
+package packlit
+
+// WithAdCuesFlag Adds flag '--ad_cues <start_time[,duration]>[;<start_time[,duration]>]...'
+func WithAdCuesFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(AdCuesFlag(val))
+	}
+}

pkg/crypto_flags.go

@@ -0,0 +1,91 @@
+package packlit
+
+import (
+	"fmt"
+)
+
+var (
+	_ ShakaParser = (*CryptByteBlockFlag)(nil)
+	_ ShakaParser = (*ProtectionSchemeFlag)(nil)
+	_ ShakaParser = (*SkipByteBlockFlag)(nil)
+	_ ShakaParser = (*VP9SubsampleEncryptionFlag)(nil)
+	_ ShakaParser = (*PlayReadyExtraHeaderDataFlag)(nil)
+)
+
+// CryptByteBlockFlag represents the encrypted block count in a protection pattern.
+type CryptByteBlockFlag int
+
+// Parse returns the string representation of CryptByteBlock for use in the command line flags.
+func (p CryptByteBlockFlag) Parse() string {
+	return fmt.Sprintf("--crypt_byte_block=%d", p)
+}
+
+// Validate checks if the value of CryptByteBlock is valid.
+// Specify the count of the encrypted blocks in the protection pattern,
+// where block is of size 16-bytes. There are three common
+// patterns (crypt_byte_block:skip_byte_block): 1:9 (default), 5:5, 10:0.
+// Apply to video streams with 'cbcs' and 'cens' protection schemes only;
+// ignored otherwise.
+func (p CryptByteBlockFlag) Validate() error {
+	return nil
+}
+
+// ProtectionSchemeFlag represents the protection scheme flag.
+type ProtectionSchemeFlag string
+
+// Parse returns the string representation of ProtectionScheme for use in the command line flags.
+func (p ProtectionSchemeFlag) Parse() string {
+	return fmt.Sprintf("--protection_scheme=%s", p)
+}
+
+// Validate checks if the ProtectionScheme flag value is valid.
+// Specify a protection scheme, 'cenc' or 'cbc1' or pattern-based protection schemes 'cens' or 'cbcs'.
+func (p ProtectionSchemeFlag) Validate() error {
+	return nil
+}
+
+// SkipByteBlockFlag represents the number of unencrypted blocks in the protection pattern.
+type SkipByteBlockFlag int
+
+// Parse returns the string representation of SkipByteBlock for use in the command line flags.
+func (s SkipByteBlockFlag) Parse() string {
+	return fmt.Sprintf("--skip_byte_block=%v", s)
+}
+
+// Validate checks if the value of SkipByteBlock is valid.
+// Specify the count of the unencrypted blocks in the protection pattern.
+// Apply to video streams with 'cbcs' and 'cens' protection schemes only;
+// ignored otherwise.
+func (s SkipByteBlockFlag) Validate() error {
+	return nil
+}
+
+// VP9SubsampleEncryptionFlag represents the flag to enable VP9 subsample encryption.
+type VP9SubsampleEncryptionFlag struct{}
+
+// Parse returns the string representation of VP9SubsampleEncryption for use in the command line flags.
+func (v VP9SubsampleEncryptionFlag) Parse() string {
+	return "--vp9_subsample_encryption"
+}
+
+// Validate checks if the VP9SubsampleEncryption flag value is valid.
+// Enable VP9 subsample encryption.
+func (v VP9SubsampleEncryptionFlag) Validate() error {
+	// No specific validation needed as the flag is of boolean type.
+	return nil
+}
+
+// PlayReadyExtraHeaderDataFlag represents the extra XML data for PlayReady headers.
+type PlayReadyExtraHeaderDataFlag string
+
+// Parse returns the string representation of PlayReadyExtraHeaderData for use in the command line flags.
+func (p PlayReadyExtraHeaderDataFlag) Parse() string {
+	return fmt.Sprintf("--playready_extra_header_data=%s", p)
+}
+
+// Validate checks if the PlayReadyExtraHeaderData flag value is valid.
+// Extra XML data to add to PlayReady headers.
+func (p PlayReadyExtraHeaderDataFlag) Validate() error {
+	// Check if the string is empty (valid) or if not, it must be valid XML.
+	return nil
+}

pkg/crypto_flags_helpers.go

@@ -0,0 +1,36 @@
+package packlit
+
+// WithCryptByteBlockFlag Adds flag '--crypt_byte_block <value>'
+func WithCryptByteBlockFlag(val int) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(CryptByteBlockFlag(val))
+	}
+}
+
+// WithProtectionSchemeFlag Adds flag '--protection_scheme <cenc|cbc1|cens|cbcs>'
+func WithProtectionSchemeFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(ProtectionSchemeFlag(val))
+	}
+}
+
+// WithSkipByteBlockFlag Adds flag '--skip_byte_block <value>'
+func WithSkipByteBlockFlag(val int) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(SkipByteBlockFlag(val))
+	}
+}
+
+// WithVP9SubsampleEncryptionFlag Adds flag '--vp9_subsample_encryption'
+func WithVP9SubsampleEncryptionFlag() ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(VP9SubsampleEncryptionFlag{})
+	}
+}
+
+// WithPlayReadyExtraHeaderDataFlag Adds flag '--playready_extra_header_data <XML>'
+func WithPlayReadyExtraHeaderDataFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(PlayReadyExtraHeaderDataFlag(val))
+	}
+}

pkg/hls_flags.go

@@ -0,0 +1,118 @@
+package packlit
+
+import (
+	"fmt"
+)
+
+var (
+	_ ShakaParser = (*HLSMasterPlaylistOutputFlag)(nil)
+	_ ShakaParser = (*HLSBaseURLFlag)(nil)
+	_ ShakaParser = (*HLSKeyURIFlag)(nil)
+	_ ShakaParser = (*HLSPlaylistTypeFlag)(nil)
+	_ ShakaParser = (*HLSMediaSequenceNumberFlag)(nil)
+	_ ShakaParser = (*HLSStartTimeOffsetFlag)(nil)
+	_ ShakaParser = (*HLSCreateSessionKeysFlag)(nil)
+)
+
+// HLSMasterPlaylistOutputFlag represents the output path for the master playlist for HLS.
+type HLSMasterPlaylistOutputFlag string
+
+// Parse returns the string representation of HLSMasterPlaylistOutput for use in the command line flags.
+func (h HLSMasterPlaylistOutputFlag) Parse() string {
+	return fmt.Sprintf("--hls_master_playlist_output=%s", h)
+}
+
+// Validate checks if the value of HLSMasterPlaylistOutput is valid.
+// This flag must be used to output HLS.
+func (h HLSMasterPlaylistOutputFlag) Validate() error {
+	if len(h) == 0 {
+		return fmt.Errorf("hls_master_playlist_output is required")
+	}
+	return nil
+}
+
+// HLSBaseURLFlag represents the base URL for the Media Playlists and media files listed in the playlists.
+type HLSBaseURLFlag string
+
+// Parse returns the string representation of HLSBaseURL for use in the command line flags.
+func (h HLSBaseURLFlag) Parse() string {
+	return fmt.Sprintf("--hls_base_url=%s", h)
+}
+
+// Validate checks if the value of HLSBaseURL is valid.
+// The base URL is the prefix for the media files.
+func (h HLSBaseURLFlag) Validate() error {
+	if len(h) == 0 {
+		return fmt.Errorf("hls_base_url is required")
+	}
+	return nil
+}
+
+// HLSKeyURIFlag represents the key URI for the 'identity' and 'com.apple.streamingkeydelivery' key formats.
+type HLSKeyURIFlag string
+
+// Parse returns the string representation of HLSKeyURI for use in the command line flags.
+func (h HLSKeyURIFlag) Parse() string {
+	return fmt.Sprintf("--hls_key_uri=%s", h)
+}
+
+// Validate checks if the value of HLSKeyURI is valid.
+// The key URI is required if the playlist is encrypted and uses the specified key formats.
+func (h HLSKeyURIFlag) Validate() error {
+	if len(h) == 0 {
+		return fmt.Errorf("hls_key_uri is required for encrypted playlists with 'identity' and 'com.apple.streamingkeydelivery' formats")
+	}
+	return nil
+}
+
+// HLSPlaylistTypeFlag represents the type of the playlist: VOD, EVENT, or LIVE.
+type HLSPlaylistTypeFlag string
+
+// Parse returns the string representation of HLSPlaylistType for use in the command line flags.
+func (h HLSPlaylistTypeFlag) Parse() string {
+	return fmt.Sprintf("--hls_playlist_type=%s", h)
+}
+
+// Validate checks if the value of HLSPlaylistType is valid.
+func (h HLSPlaylistTypeFlag) Validate() error {
+	return nil
+}
+
+// HLSMediaSequenceNumberFlag represents the initial EXT-X-MEDIA-SEQUENCE value.
+type HLSMediaSequenceNumberFlag int
+
+// Parse returns the string representation of HLSMediaSequenceNumber for use in the command line flags.
+func (h HLSMediaSequenceNumberFlag) Parse() string {
+	return fmt.Sprintf("--hls_media_sequence_number=%d", h)
+}
+
+// Validate checks if the value of HLSMediaSequenceNumber is valid.
+func (h HLSMediaSequenceNumberFlag) Validate() error {
+	return nil
+}
+
+// HLSStartTimeOffsetFlag represents the floating-point number for EXT-X-START time offset.
+type HLSStartTimeOffsetFlag float32
+
+// Parse returns the string representation of HLSStartTimeOffset for use in the command line flags.
+func (h HLSStartTimeOffsetFlag) Parse() string {
+	return fmt.Sprintf("--hls_start_time_offset=%v", h)
+}
+
+// Validate checks if the value of HLSStartTimeOffset is valid.
+func (h HLSStartTimeOffsetFlag) Validate() error {
+	return nil
+}
+
+// HLSCreateSessionKeysFlag represents the flag to enable creation of session keys for Offline HLS playback.
+type HLSCreateSessionKeysFlag struct{}
+
+// Parse returns the string representation of HLSCreateSessionKeys for use in the command line flags.
+func (h HLSCreateSessionKeysFlag) Parse() string {
+	return "--create_session_keys"
+}
+
+// Validate checks if the value of HLSCreateSessionKeys is valid.
+func (h HLSCreateSessionKeysFlag) Validate() error {
+	return nil // No specific validation logic for this flag
+}

pkg/hls_flags_helpers.go

@@ -0,0 +1,50 @@
+package packlit
+
+// WithHLSMasterPlaylistOutputFlag Adds flag '--hls_master_playlist_output <path>'
+func WithHLSMasterPlaylistOutputFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSMasterPlaylistOutputFlag(val))
+	}
+}
+
+// WithHLSBaseURLFlag Adds flag '--hls_base_url <url>'
+func WithHLSBaseURLFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSBaseURLFlag(val))
+	}
+}
+
+// WithHLSKeyURIFlag Adds flag '--hls_key_uri <uri>'
+func WithHLSKeyURIFlag(val string) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSKeyURIFlag(val))
+	}
+}
+
+// WithHLSPlaylistTypeFlag Adds flag '--hls_playlist_type <VOD|EVENT|LIVE>'
+func WithHLSPlaylistTypeFlag(val HLSPlaylistTypeFlag) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(val)
+	}
+}
+
+// WithHLSMediaSequenceNumberFlag Adds flag '--hls_media_sequence_number <number>'
+func WithHLSMediaSequenceNumberFlag(val int) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSMediaSequenceNumberFlag(val))
+	}
+}
+
+// WithHLSStartTimeOffsetFlag Adds flag '--hls_start_time_offset <offset>'
+func WithHLSStartTimeOffsetFlag(val float32) ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSStartTimeOffsetFlag(val))
+	}
+}
+
+// WithHLSCreateSessionKeysFlag Adds flag '--create_session_keys'
+func WithHLSCreateSessionKeysFlag() ShakaFlagFn {
+	return func(so *ShakaFlags) {
+		so.Add(HLSCreateSessionKeysFlag{})
+	}
+}

pkg/http_file_flags.go

@@ -2,6 +2,17 @@ package packlit
 
 import "fmt"
 
+var (
+	_ ShakaParser = (*UserAgentFlag)(nil)
+	_ ShakaParser = (*CaFileFlag)(nil)
+	_ ShakaParser = (*ClientCertFileFlag)(nil)
+	_ ShakaParser = (*ClientCertPrivateKeyFileFlag)(nil)
+	_ ShakaParser = (*ClientCertPrivateKeyPasswordFlag)(nil)
+	_ ShakaParser = (*DisablePeerVerificationFlag)(nil)
+	_ ShakaParser = (*IgnoreHttpOutputFailuresFlag)(nil)
+	_ ShakaParser = (*IoCacheSizeFlag)(nil)
+)
+
 // UserAgentFlag represents the flag for setting a custom User-Agent string for HTTP requests.
 type UserAgentFlag string