View Issue Details

IDProjectCategoryView StatusLast Update
0001674OpenMPTlibopenmptpublic2023-04-19 18:24
Reportermanx Assigned ToSaga Musix  
PrioritynormalSeverityminorReproducibilityhave not tried
Status resolvedResolutionfixed 
Product VersionOpenMPT 1.31.00.* (old testing) 
Target VersionOpenMPT / libopenmpt 0.7.0 (upgrade first)Fixed in VersionOpenMPT / libopenmpt 0.7.0 (upgrade first) 
Summary0001674: clarify documentation for play.at_end

We should explicitly document the interaction with repeat_count, and we should explicitly explain how to interpret the "or" in "Subsequent reads will continue playing from the song start or loop start.".

TagsNo tags attached.
Has the bug occurred in previous versions?
Tested code revision (in case you know it)


Saga Musix

Saga Musix

2023-04-18 18:05

administrator   ~0005687

First draft

               - play.at_end (text): Chooses the behaviour when the end of song is reached. The song end is considered to be reached after the number of reptitions set by `set_repeat_count` was played, so if the song is set to repeat infinitely, its end is never considered to be reached.
                              - "fadeout": Fades the module out for a short while. Subsequent reads after the fadeout will return 0 rendered frames.
                              - "continue": Returns 0 rendered frames when the song end is reached. Subsequent reads will continue playing from the loop start (if the song is not programmed to loop, playback resumsed from the song start).
                              - "stop": Returns 0 rendered frames when the song end is reached. Subsequent reads will return 0 rendered frames.


2023-04-19 07:35

administrator   ~0005688

Looks good to me.

I fully expect someone to again find something about the documentation that turns out unclear :), but for the last issue, this would hopefully clarify things.

Saga Musix

Saga Musix

2023-04-19 18:24

administrator   ~0005689

Added in r19056 - r19059

Issue History

Date Modified Username Field Change
2023-03-07 17:57 manx New Issue
2023-04-18 18:05 Saga Musix Note Added: 0005687
2023-04-18 19:33 Saga Musix Assigned To => Saga Musix
2023-04-18 19:33 Saga Musix Status new => assigned
2023-04-19 07:35 manx Note Added: 0005688
2023-04-19 18:24 Saga Musix Note Added: 0005689
2023-04-19 18:24 Saga Musix Status assigned => resolved
2023-04-19 18:24 Saga Musix Resolution open => fixed
2023-04-19 18:24 Saga Musix Fixed in Version => OpenMPT / libopenmpt 0.7.0 (upgrade first)